FirstTimeSetupGlobalSettingsModel
Global settings configured as part of first-time setup.
Properties
Name | Description | Additional information |
---|---|---|
SharedResourceDomain | The primary domain that hosts resources for multiple tenants. This is the primary and default resource domain. All configuration servers must reside in this domain, and any operation where domain is requested but not provided will assume this domain. Required. |
Type: CreateDomainModel |
RootOU | The root Organizational Unit in Active Directory. App Orchestration manages computers and OU structure within this root OU. If not specified, 'CitrixAppOrchestration' is assumed. |
Type: String |
DefaultUserDomain | The default domain to use for tenants' users, when a different domain is not given. If not specified, the SharedResourceDomain is used. |
Type: CreateDomainModel |
DefaultPrimaryDataCenter | The primary and default datacenter. All configuration servers must reside in this datacenter, and any operation where datacenter is requested but not provided will assume this datacenter. Required. |
Type: CreateDataCenterModel |
IsNetworkIsolationEnabled | If true, App Orchestration will enforce network isolation boundaries for all machines under its control. If not specified, this is enabled by default. |
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. The default is 'Shared Controller 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. The default is 'Shared Delivery Group Management Network'. Note: This value is only used if IsNetworkIsolationEnabled is true. |
Type: String |
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 |
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 |
ProductDepot | Network file share containing installation software for your deployment. App Orchestration uses this location when installing software on remote machines. Required. |
Type: String |
ProductDepotUserName | Account used to access the product depot network shared from remote machines. Configure with read-only permissions to the product depot. |
Type: String |
ProductDepotPasswordBase64 | Account password for the ProductDepotUserName. Must be Base64 encoded. |
Type: String |
Tags |
Type: Array of String |
|
CustomProperties |
Type: Array of CustomPropertyModel |
Sample
application/json
{ "SharedResourceDomain": { "Name": "domain1.local", "Type": "Both", "IsPasswordProtected": true, "DomainPasswordBase64": "cGFzc3dvcmQ=", "OrchestrationServiceUserName": "DOMAIN\\orch", "OrchestrationServicePasswordBase64": "cGFzc3dvcmQ=", "ProductInstallUserName": "DOMAIN\\install", "ProductInstallPasswordBase64": "cGFzc3dvcmQ=", "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ] }, "RootOU": "CitrixAppOrchestration", "DefaultPrimaryDataCenter": { "Name": "datacenter1", "ShortName": "datacenter1", "Description": "my datacenter", "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ], "LicenseServerAddress": "ctxlicense.csp.com", "LicenseServerAddressPort": 27000, "NetScalerGatewayAddress": "https://ag.datacenter1.csp.com" }, "IsNetworkIsolationEnabled": true, "SharedControllerManagementNetwork": "Shared Controller Management Network", "SharedDeliveryGroupManagementNetwork": "Shared Delivery Group Management Network", "IsNetScalerGatewayEnabled": true, "ExternalDnsSuffix": "csp.com", "ProductDepot": "\\\\server\\share\\ProductDepot", "ProductDepotUserName": "DOMAIN\\user", "ProductDepotPasswordBase64": "cGFzc3dvcmQ=", "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ] }