CreateDeliverySiteModel
Details for creating a delivery site.
Properties
Name | Description | Additional information |
---|---|---|
Name | Name of the delivery site. Required. |
Type: String |
DataCenterId | ID of the datacenter containing all of the delivery controllers and session machines for the delivery site. Default is the primary default datacenter. |
Type: String |
DomainId | ID of the domain containing all of the delivery controllers for the delivery site. |
Type: String |
Servers | A list of server names (host names or FQDNs). IP addresses cannot be used. Required. XenApp 6.5 delivery sites: you must specify either 2 or 3 servers.
XenDesktop delivery sites: you must specify 2 or more servers. The XML preference will be configured in the order that the servers are specified. |
Type: Array of String |
AdministratorUserName | The delivery site administrator user name. Must be in SAM format (DOMAIN\user). Must be a member of AdministratorGroup. Required. |
Type: String |
AdministratorPasswordBase64 | The delivery site administrator password. Must be Base64 encoded. |
Type: String |
AdministratorGroup | User group containing the user referred to by AdministratorUserName. All members of this group will be given privileges to control configuration in the delivery site, so ensure that this group does not contain unauthorized users. |
Type: String |
NetworkName | The name of the management network to which the delivery controllers are connected. This can be any value; however, if the name does not match either the shared controller management network name, or the private network name of one or more tenants, the delivery site will never be allocated. If not specified, the shared controller management network name is assumed. |
Type: String |
ProductType | The type of the brokering product used to connect users to session machines. If not specified, the highest supported version of XenDesktop is assumed. |
Type: ProductType |
LicensingModel | Licensing model to use for user connection license enforcement. If not specified, UserDevice is assumed. |
Type: LicensingModel |
SiteDatabaseServerInstanceName | Name or IP of the SQL server instance to use for the delivery site database. Required. |
Type: String |
SiteDatabaseName | Name of the database to use for the delivery site. If not specified, the name is chosen based on the delivery Site Name. |
Type: String |
DatabaseUserName | Name of a user with administrative privileges on the delivery site database SQL server. Must be in SAM format ("DOMAIN\user"). Required. |
Type: String |
DatabasePasswordBase64 | Password of a user with administrative privileges to the delivery site database SQL server. Must be Base64 encoded. Required. |
Type: String |
ConfigLoggingDatabaseName | Name of the database to use for configuration logging within the delivery site. If not specified, the name is chosen based on the delivery Site Name. |
Type: String |
ConfigLoggingDatabaseServerInstanceName | Name or IP of the SQL server instance to use for the configuration logging database. If not specified, SiteDatabaseServerInstanceName is used. |
Type: String |
MonitorDatabaseName | Name of the database to use for monitoring data collection within the delivery site. If not specified, the name is chosen based on the delivery Site Name. |
Type: String |
MonitorDatabaseServerInstanceName | Name or IP of the SQL server instance to use for the monitoring database. If not specified, SiteDatabaseServerInstanceName is used. |
Type: String |
Description | Description. |
Type: String |
Tags |
Type: Array of String |
|
CustomProperties |
Type: Array of CustomPropertyModel |
Sample
application/json
{ "Name": "delivery site 1", "DataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a", "DomainId": "241b45cc-261d-47d0-81d7-a0a41c54c760", "Servers": [ "controller1", "controller2" ], "AdministratorUserName": "DOMAIN\\user", "AdministratorPasswordBase64": "cGFzc3dvcmQ=", "AdministratorGroup": "DOMAIN\\delivery site 1 admins", "NetworkName": "Shared Controller Management Network", "ProductType": "XenDesktop71", "LicensingModel": "UserDevice", "SiteDatabaseServerInstanceName": "sql1.csp.com", "SiteDatabaseName": "ds1_site", "DatabaseUserName": "DOMAIN\\sqladmin", "DatabasePasswordBase64": "cGFzc3dvcmQ=", "ConfigLoggingDatabaseName": "ds1_configlog", "ConfigLoggingDatabaseServerInstanceName": "sql1.csp.com\\configlog", "MonitorDatabaseName": "ds1_monitoring", "MonitorDatabaseServerInstanceName": "sql2.csp.com\\ds1monitor", "Description": "my delivery site", "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ] }