POST GlobalSettings

Create the initial, first-time-use global settings.

Request Information

Request body type

Request body formats

application/json, text/json

Sample:

{
  "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"
    }
  ]
}

Response Information

Global settings.

Response type

GlobalSettingsModel

Response body formats

application/json, text/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:12:30.6801822-05:00",
  "ProductDepot": "\\\\server\\share\\ProductDepot",
  "ProductDepotUserName": "DOMAIN\\user",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}