Help Page Home

# GlobalSettingsModel

Global settings for the App Orchestration deployment.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | See Hypermedia. | Type: String
RelatedActions | See Hypermedia. | Type: Array of RelationModel
GuidedSetupState | Tracks the state of dashboard guided setup. | Type: GuidedSetupState
SharedResourceDomain | Contains machines that host resources for multiple tenants. This is the primary and default resource domain. | Type: ReferenceModel
DefaultUserDomain | Contains users and groups for multiple tenants. This is the global default user domain. | Type: ReferenceModel
DefaultPrimaryDataCenter | The default datacenter sets location preference for importing machines and configuring tenant location user groups. If a datacenter is not specified, this datacenter is used as the default. | Type: ReferenceModel
SharedResourceDomainOrchestrationServiceGroup | Members of this group are configured with super-user permission to manage App Orchestration. | Type: String
RootOU | The root Organizational Unit in Active Directory. App Orchestration manages computers and OU structure within this root OU. | Type: String
AacFarmName | Farm name used for Advanced Access Control, for tenants using a shared NetScaler Gateway. | Type: String
ExternalDnsSuffix | DNS suffix used to configure NetScaler Gateway addresses for cross-datacenter routing of user connections. This suffix is appended to default NetScaler Gateway addresses; for example: https://ag.[datacenter].[ExternalDnsSuffix] | Type: String
IsIntegratedProvisioningEnabled | Reports if integrated provisioning enabled at a global level. A compute resource must be added to enable integrated provisioning. | Type: Boolean
IsNetworkIsolationEnabled | Reports if network isolation is enabled at a global level. | Type: Boolean
IsNetScalerGatewayEnabled | Enables tenants to access a shared NetScaler Gateway in each data center. Each datacenter must contain a NetScaler Gateway when this feature is enabled. | Type: Boolean
IsAacEnabled | Enables Advanced Access Control on the shared NetScaler Gateway in each datacenter. | Type: Boolean
DefaultSecureIcaRequired | Default value for the SecureIcaRequired property when creating a new SessionMachineCatalog. | Type: Boolean
SharedControllerManagementNetwork | Delivery controller machines in all shared delivery sites, and StoreFront servers in all shared StoreFront server groups, must be connected to this management network. Note: This value is only used if IsNetworkIsolationEnabled is true. | Type: String
SharedDeliveryGroupManagementNetwork | All shared session machines must be connected to this management network. Note: This value is only used if IsNetworkIsolationEnabled is true. | Type: String
OtherSharedDeliveryGroupNetworks | Additional networks which are attached to all shared session machines that are automatically created using integrated provisioning. | Type: Array of String
TaskHistoryLimitDays | Number of days to store task history. A value of zero means no limit. | Type: Number
TaskHistoryLastClearedDate | The date and time when the task history was last cleared. | Type: String (ISO 8601 standard date)
ProductDepot | Network file share containing installation software for your deployment. App Orchestration uses this location when installing software on remote machines. | Type: String
ProductDepotUserName | Account used to access the product depot from remote machines. Configure with read-only permissions to the product depot. | Type: String
Tags | See Tags and Custom Properties. | Type: Array of String
CustomProperties | See Tags and Custom Properties. | Type: Array of CustomPropertyModel

### Sample

#### application/json

Sample:

    {
      "Href": "[api:GlobalSettings]",
      "GuidedSetupState": "GuidedSetupComplete",
      "SharedResourceDomain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "DefaultUserDomain": {
        "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
        "Name": "domain1.local",
        "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
      },
      "DefaultPrimaryDataCenter": {
        "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
        "Name": "datacenter1",
        "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
      },
      "SharedResourceDomainOrchestrationServiceGroup": "DOMAIN\\OrchestrationAdmins",
      "RootOU": "CitrixAppOrchestration",
      "AacFarmName": "Shared",
      "ExternalDnsSuffix": "csp.com",
      "IsIntegratedProvisioningEnabled": true,
      "IsNetworkIsolationEnabled": true,
      "IsNetScalerGatewayEnabled": true,
      "IsAacEnabled": true,
      "DefaultSecureIcaRequired": true,
      "SharedControllerManagementNetwork": "Shared Controller Management Network",
      "SharedDeliveryGroupManagementNetwork": "Shared Delivery Group Management Network",
      "OtherSharedDeliveryGroupNetworks": [
        "other network"
      ],
      "TaskHistoryLimitDays": 1,
      "TaskHistoryLastClearedDate": "2013-12-05T16:13:27.8626246-05:00",
      "ProductDepot": "\\\\server\\share\\ProductDepot",
      "ProductDepotUserName": "DOMAIN\\user",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ]
    }