DeliverySiteModel

Details of a delivery site.

Properties

NameDescription Additional information
Href

See Hypermedia.

Type: String

RelatedActions

See Hypermedia.

Type: Array of RelationModel

Id

ID of the delivery site.

Type: String

ChangeId

See Optimistic Concurrency.

Type: String

Name

Name.

Type: String

Description

Description.

Type: String

Tags

See Tags and Custom Properties.

Type: Array of String

CustomProperties

See Tags and Custom Properties.

Type: Array of CustomPropertyModel

DeleteState

See Deleting Objects.

Type: ObjectDeleteState

IsShared

True if the delivery site is capable of being shared between multiple tenants. Note that even if a delivery site has only a single tenant, if this property is true then another tenant may begin sharing the delivery site at any time.

Type: Boolean

ProductType

Type of Citrix brokering product powering session connections in the site..

Type: ProductType

DeliveryControllerArchitecture

Architecture of the delivery controllers in the delivery site.

Type: DeliveryControllerArchitectureType

Tenant

If the delivery site is allocated to a single tenant, this is a link to that tenant.

Type: ReferenceModel

AllocationStatus

Allocation status.

Type: DeliverySiteAllocationStatus

DataCenter

Datacenter containing the delivery site.

Type: ReferenceModel

HealthSummary

Summary of health messages related to the delivery site.

Type: HealthSummaryModel

Domain

Domain containing the delivery site controllers.

Type: ReferenceModel

NetworkName

Management network which the delivery site controllers must be connected to.

Type: String

NumSessionMachines

Number of session machines currently in the delivery site.

Type: Number

MaxSessionMachines

Maximum number of session machines in the delivery site.

Type: Number

AdministratorUserName

SAM name of the administrator with privileges to control configuration in the delivery site (i.e. "DOMAIN\user").

Type: String

AdministratorGroup

User group containing the user referred to by AdministratorUserName. All members of this group have privileges to control configuration in the delivery site.

Type: String

DeliverySiteUsageType

How App Orchestration uses the delivery site.

Type: DeliverySiteUsageType

DBServerName

Name of the database server containing the delivery site database.

Type: String

DBName

Name of the delivery site database.

Type: String

Sample

application/json

Sample:
{
  "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
  "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996",
  "ChangeId": "11",
  "Name": "site1",
  "Description": "my delivery site",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "DeleteState": "NotDeleted",
  "IsShared": false,
  "ProductType": "XenDesktop71",
  "DeliveryControllerArchitecture": "FMA",
  "Tenant": {
    "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
    "Name": "Tenant 1",
    "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
  },
  "AllocationStatus": "Allocated",
  "DataCenter": {
    "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
    "Name": "datacenter1",
    "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
  },
  "HealthSummary": {
    "InfoCount": 1,
    "Messages": [
      {
        "Text": "Attempting to reach desired capacity",
        "IsActive": true,
        "Type": "Allocation"
      }
    ]
  },
  "Domain": {
    "Href": "[api:Domains(241b45cc-261d-47d0-81d7-a0a41c54c760)]",
    "Name": "domain1.local",
    "Id": "241b45cc-261d-47d0-81d7-a0a41c54c760"
  },
  "NetworkName": "Shared Controller Management Network",
  "NumSessionMachines": 10,
  "MaxSessionMachines": 10000,
  "AdministratorUserName": "DOMAIN\\ctxadmin",
  "AdministratorGroup": "DOMAIN\\CitrixAdmins",
  "DeliverySiteUsageType": "Managed",
  "DBServerName": "sqlserver.csp.local",
  "DBName": "site1"
}