Create Session Farm
Request
URI
POST
https://{api_host}/dt-rest/v100/farm/manager/farms/session
COPY
Request Body
DtSessionFarmImpl of type(s) application/json
Optional
{
"id": "string",
"tenantDesktopManagerId": "string",
"serverDensity": 0,
"serverCount": 0,
"activeSessionCount": 0,
"farmOccupancy": "number",
"sessionFarmServers": [
{
"farmId": 0,
"occupancy": "number",
"activeSessions": 0,
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"allSessionFarmServers": [
{
"farmId": 0,
"occupancy": "number",
"activeSessions": 0,
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"allSessionFarmServersWithJMSCapable": [
{
"farmId": 0,
"occupancy": "number",
"activeSessions": 0,
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"autoDiscoveredRemoteAppsForFarm": [
{
"version": "string",
"appFilePath": "string",
"tenantDesktopManagerId": "string",
"dataCenterId": "string",
"displayName": "string",
"appName": "string",
"commandline": "string",
"farmId": 0,
"verifyApp": false,
"icons": [
{
"height": 0,
"width": 0,
"md5Sum": "string",
"iconData": [
"string"
]
}
],
"installStatus": "string",
"fileTypes": [
{
"value": "string",
"type": "string",
"displayName": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"publisher": "string",
"startDirectory": "string",
"dateCreated": "string",
"dateUpdated": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"description": "string",
"preferredProtocol": "string",
"preferredClientType": "string",
"emptySessionTimeoutMinutes": 0,
"disconnectLimitMinutes": 0,
"emptySessionDoLogoff": false,
"repristineSessionLimit": 0,
"minServers": 0,
"maxServers": 0,
"vmRootName": "string",
"maxSessionLifetimeMinutes": 0,
"allocatorSessionTimeOut": 0,
"occupancyPresetMode": "string",
"farmOnline": false,
"farmModeMessage": "string",
"numServerInQuiescingState": 0,
"repristineAction": "string",
"firstServerEmptyDuration": 0,
"repristineType": "string",
"runOnceScript": "string",
"organizationalUnit": "string",
"encrypted": false,
"nsxNetwork": "string",
"vmOsLicenseType": "string",
"domainName": "string",
"farmType": "string",
"dataCenterId": "string",
"allowedToJoinDomain": false,
"assignedNetworks": [
"string"
],
"supportedPoolProtocols": [
"string"
],
"nonPersistent": false,
"hotplugEnabled": false,
"name": "string",
"patternId": "string",
"location": "string",
"DtFarmPowerManagementSchedule": [
{
"timeZone": "string",
"startTime": "string",
"powerState": "string",
"minServers": 0,
"capabilities": 0,
"allDay": false,
"occursOnDayOfWeek": [
false
],
"endTime": "string",
"name": "string"
}
],
"DtDesktopSize": {
"memoryInMB": 0,
"gpu": false,
"numberOfCores": 0,
"osDiskSizeInMB": 0,
"name": "string"
},
"DtFarmRepristineSchedule": {
"dayOfWeek": 0,
"farmId": "string",
"frequency": "string",
"hourOfDay": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"DtResourceTags": [
{
"name": "string",
"value": "string"
}
],
"OsDiskConfiguration": {
"sku": "string",
"sizeMb": 0
},
"DtGoldPattern": {
"version": 0,
"enabled": false,
"inventoryPath": "string",
"vmOsLicenseType": "string",
"username": "string",
"md5sum": "string",
"parentId": "string",
"domain": "string",
"osType": "string",
"ngvc": false,
"backupCount": {
"maxCount": 0,
"messageType": "string",
"currentCount": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"availableAgentUpdateOnPattern": [
{
"poolId": 0,
"agentUpdateStatus": {
"stateDescription": "string",
"state": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"dateCreated": "string",
"updateAvailableTime": "string",
"updateState": "string",
"adminActionTime": "string",
"discoveredAgent": {
"version": "string",
"dateCreated": "string",
"dateUpdated": "string",
"isHotpatch": false,
"takesInstallerArgs": false,
"isValid": false,
"installMetadata": "string",
"dateReleased": "string",
"name": "string",
"displayName": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"installMode": "string",
"agentInstallTime": "string",
"isValid": false,
"cmdLineArgs": "string",
"eulaAccepted": false,
"dateEulaAccepted": "string",
"dateUpated": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"rdshroleEnabled": false,
"modified": false,
"hostManagerId": "string",
"vmUuid": "string",
"notes": "string",
"companyName": "string",
"timeZoneId": "string",
"avAgentVersion": "string",
"pools": [
"DtPool Object"
],
"applications": [
"DtApplication Object"
],
"virtualMachine": {
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"backupInfo": [
{
"date": "string",
"id": "string",
"note": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"key": "string",
"templateId": "string",
"desktopManagerName": "string",
"lastUpdated": "string",
"deleted": false,
"dataCenterName": "string",
"dependantPoolIds": [
"string"
],
"dataCenters": [
{
"defaultDomain": "string",
"vmgrId": "string",
"description": "string",
"friendlyName": "string",
"frontNetworkId": "string",
"frontNetworkType": "string",
"ipAddressBlock": "string",
"subnetMask": "string",
"gateway": "string",
"vmgrUIDs": [
"string"
],
"assignedOrganizationIds": [
0
],
"lastUpdate": "string",
"ntpServers": [
"string"
],
"backBoneNetworkId": "string",
"backBoneNetworkType": "string",
"dnsServer": "string",
"cimuserPassword": "string",
"creationDate": "string",
"appliancePassword": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"desktopManagerId": "string",
"basedOn": "string",
"diskSize": 0,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"DtDesktopModel": {
"enabled": false,
"type": "string",
"refId": "string",
"lastUpdated": "string",
"displayName": "string",
"numberOfCpus": 0,
"gpuFrameBuffer": "string",
"desktopMemoryInMBs": 0,
"diskSpaceInGBs": 0,
"currentDesktopCount": 0,
"desktopQuota": 0,
"licenseEntitlements": [
{
"version": "number",
"organizationId": "string",
"lastUpdated": "string",
"desktopModelId": "string",
"deleted": false,
"dateCreated": "string",
"entitlement": "string",
"fileLocation": "string",
"entitlementContentType": "string",
"entitlementFileName": "string",
"tenantUpdate": false,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"sessionBased": false,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"DtTenantDesktopManager": {
"state": "string",
"vmgrId": "string",
"dataCenterId": "string",
"cpuCapacity": 0,
"ramCapacity": 0,
"organizationId": 0,
"monitoringHost": "string",
"lastMonitorTime": "string",
"provisioningEnabled": false,
"lastUpdated": "string",
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"DataDiskConfiguration": {
"sku": "string",
"sizeMb": 0
},
"DtFaultToleranceConfiguration": {
"enabled": false,
"numFaultDomains": 0,
"numUpdateDomains": 0
},
"DtLink": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}string
id
Optional
id
string
tenantDesktopManagerId
Optional
tenantDesktopManagerId
integer As int64 As int64
serverDensity
Optional
serverDensity
integer As int64 As int64
serverCount
Optional
serverCount
integer As int64 As int64
activeSessionCount
Optional
activeSessionCount
number As double As double
farmOccupancy
Optional
farmOccupancy
array of DtSessionFarmServer
allSessionFarmServersWithJMSCapable
Optional
allSessionFarmServersWithJMSCapable
array of DtRemoteApplicationDefinition
autoDiscoveredRemoteAppsForFarm
Optional
autoDiscoveredRemoteAppsForFarm
string
description
Optional
description
string
preferredProtocol
Optional
preferredProtocol
Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
string
preferredClientType
Optional
preferredClientType
Possible values are : BROWSER, HORIZON_CLIENT,
integer As int64 As int64
emptySessionTimeoutMinutes
Optional
emptySessionTimeoutMinutes
integer As int64 As int64
disconnectLimitMinutes
Optional
disconnectLimitMinutes
boolean
emptySessionDoLogoff
Optional
emptySessionDoLogoff
integer As int64 As int64
repristineSessionLimit
Optional
repristineSessionLimit
integer As int64 As int64
minServers
Optional
minServers
integer As int64 As int64
maxServers
Optional
maxServers
string
vmRootName
Optional
vmRootName
integer As int64 As int64
maxSessionLifetimeMinutes
Optional
maxSessionLifetimeMinutes
integer As int64 As int64
allocatorSessionTimeOut
Optional
allocatorSessionTimeOut
string
occupancyPresetMode
Optional
occupancyPresetMode
boolean
farmOnline
Optional
farmOnline
string
farmModeMessage
Optional
farmModeMessage
integer As int32 As int32
numServerInQuiescingState
Optional
numServerInQuiescingState
string
repristineAction
Optional
repristineAction
integer As int32 As int32
firstServerEmptyDuration
Optional
firstServerEmptyDuration
string
repristineType
Optional
repristineType
string
runOnceScript
Optional
runOnceScript
string
organizationalUnit
Optional
organizationalUnit
boolean
encrypted
Optional
encrypted
string
nsxNetwork
Optional
nsxNetwork
string
vmOsLicenseType
Optional
vmOsLicenseType
string
domainName
Optional
domainName
string
farmType
Optional
farmType
Possible values are : APP, SESSION,
string
dataCenterId
Optional
dataCenterId
boolean
allowedToJoinDomain
Optional
allowedToJoinDomain
array of string
assignedNetworks
Optional
assignedNetworks
array of string
supportedPoolProtocols
Optional
supportedPoolProtocols
Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
boolean
nonPersistent
Optional
nonPersistent
boolean
hotplugEnabled
Optional
hotplugEnabled
string
name
Optional
name
string
patternId
Optional
patternId
string
location
Optional
location
array of DtFarmPowerManagementSchedule
DtFarmPowerManagementSchedule
Optional
DtFarmPowerManagementSchedule
Responses
200
successful operation
Returns DtSessionFarm of type(s) */*
{
"serverDensity": 0,
"sessionFarmServers": [
{
"farmId": 0,
"occupancy": "number",
"activeSessions": 0,
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"allSessionFarmServers": [
{
"farmId": 0,
"occupancy": "number",
"activeSessions": 0,
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"allSessionFarmServersWithJMSCapable": [
{
"farmId": 0,
"occupancy": "number",
"activeSessions": 0,
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"autoDiscoveredRemoteAppsForFarm": [
{
"version": "string",
"appFilePath": "string",
"tenantDesktopManagerId": "string",
"dataCenterId": "string",
"displayName": "string",
"appName": "string",
"commandline": "string",
"farmId": 0,
"verifyApp": false,
"icons": [
{
"height": 0,
"width": 0,
"md5Sum": "string",
"iconData": [
"string"
]
}
],
"installStatus": "string",
"fileTypes": [
{
"value": "string",
"type": "string",
"displayName": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"publisher": "string",
"startDirectory": "string",
"dateCreated": "string",
"dateUpdated": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"description": "string",
"tenantDesktopManagerId": "string",
"preferredProtocol": "string",
"preferredClientType": "string",
"emptySessionTimeoutMinutes": 0,
"disconnectLimitMinutes": 0,
"emptySessionDoLogoff": false,
"repristineSessionLimit": 0,
"minServers": 0,
"maxServers": 0,
"vmRootName": "string",
"maxSessionLifetimeMinutes": 0,
"allocatorSessionTimeOut": 0,
"occupancyPresetMode": "string",
"farmOnline": false,
"farmModeMessage": "string",
"numServerInQuiescingState": 0,
"repristineAction": "string",
"firstServerEmptyDuration": 0,
"repristineType": "string",
"DtFarmRepristineSchedule": {
"dayOfWeek": 0,
"farmId": "string",
"frequency": "string",
"hourOfDay": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"runOnceScript": "string",
"organizationalUnit": "string",
"encrypted": false,
"nsxNetwork": "string",
"vmOsLicenseType": "string",
"farmPowerManagementSchedules": [
{
"timeZone": "string",
"startTime": "string",
"powerState": "string",
"minServers": 0,
"capabilities": 0,
"allDay": false,
"occursOnDayOfWeek": [
false
],
"endTime": "string",
"name": "string"
}
],
"DtResourceTags": [
{
"name": "string",
"value": "string"
}
],
"osDiskConfiguration": {
"sku": "string",
"sizeMb": 0
},
"goldPattern": {
"version": 0,
"enabled": false,
"inventoryPath": "string",
"vmOsLicenseType": "string",
"username": "string",
"md5sum": "string",
"parentId": "string",
"domain": "string",
"osType": "string",
"ngvc": false,
"backupCount": {
"maxCount": 0,
"messageType": "string",
"currentCount": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"availableAgentUpdateOnPattern": [
{
"poolId": 0,
"agentUpdateStatus": {
"stateDescription": "string",
"state": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"dateCreated": "string",
"updateAvailableTime": "string",
"updateState": "string",
"adminActionTime": "string",
"discoveredAgent": {
"version": "string",
"dateCreated": "string",
"dateUpdated": "string",
"isHotpatch": false,
"takesInstallerArgs": false,
"isValid": false,
"installMetadata": "string",
"dateReleased": "string",
"name": "string",
"displayName": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"installMode": "string",
"agentInstallTime": "string",
"isValid": false,
"cmdLineArgs": "string",
"eulaAccepted": false,
"dateEulaAccepted": "string",
"dateUpated": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"rdshroleEnabled": false,
"modified": false,
"hostManagerId": "string",
"vmUuid": "string",
"notes": "string",
"companyName": "string",
"timeZoneId": "string",
"avAgentVersion": "string",
"pools": [
"DtPool Object"
],
"applications": [
"DtApplication Object"
],
"virtualMachine": {
"DtVirtualMachineState": "string",
"type": "string",
"description": "string",
"vmId": "string",
"numCPUs": 0,
"patternId": "string",
"templateId": "string",
"vmPath": "string",
"inventoryPath": "string",
"ipAddress": "string",
"externalIpAddress": "string",
"refId": "string",
"vmpowerState": "string",
"vmlifeState": "string",
"vmlifeStateDate": "string",
"threeDEnabled": false,
"hotplugEnabled": false,
"vmhardwareVersion": "string",
"networkId": "string",
"daaSAgentVersion": "string",
"daaSAgentState": "string",
"vmwareToolsState": "string",
"guestOS": "string",
"computePoolId": "string",
"memorySizeMB": 0,
"goldPatternVersion": 0,
"powerOnDate": "string",
"sealDate": "string",
"poolName": "string",
"macAddress": "string",
"desktopManagerName": "string",
"viewAgentVersion": "string",
"dnsName": "string",
"viewAgentPaired": false,
"agentPairingAcknowledged": false,
"allocateState": "string",
"resyncState": "string",
"customizationState": "string",
"agentErrorCode": "string",
"sessionAllocationState": "string",
"rectify": false,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"backupInfo": [
{
"date": "string",
"id": "string",
"note": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"key": "string",
"templateId": "string",
"desktopManagerName": "string",
"lastUpdated": "string",
"deleted": false,
"dataCenterName": "string",
"dependantPoolIds": [
"string"
],
"dataCenters": [
{
"defaultDomain": "string",
"vmgrId": "string",
"description": "string",
"friendlyName": "string",
"frontNetworkId": "string",
"frontNetworkType": "string",
"ipAddressBlock": "string",
"subnetMask": "string",
"gateway": "string",
"vmgrUIDs": [
"string"
],
"assignedOrganizationIds": [
0
],
"lastUpdate": "string",
"ntpServers": [
"string"
],
"backBoneNetworkId": "string",
"backBoneNetworkType": "string",
"dnsServer": "string",
"cimuserPassword": "string",
"creationDate": "string",
"appliancePassword": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"desktopManagerId": "string",
"basedOn": "string",
"diskSize": 0,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"domainName": "string",
"farmType": "string",
"dataCenterId": "string",
"allowedToJoinDomain": false,
"assignedNetworks": [
"string"
],
"desktopModel": {
"enabled": false,
"type": "string",
"refId": "string",
"lastUpdated": "string",
"displayName": "string",
"numberOfCpus": 0,
"gpuFrameBuffer": "string",
"desktopMemoryInMBs": 0,
"diskSpaceInGBs": 0,
"currentDesktopCount": 0,
"desktopQuota": 0,
"licenseEntitlements": [
{
"version": "number",
"organizationId": "string",
"lastUpdated": "string",
"desktopModelId": "string",
"deleted": false,
"dateCreated": "string",
"entitlement": "string",
"fileLocation": "string",
"entitlementContentType": "string",
"entitlementFileName": "string",
"tenantUpdate": false,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"sessionBased": false,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"desktopSize": {
"memoryInMB": 0,
"gpu": false,
"numberOfCores": 0,
"osDiskSizeInMB": 0,
"name": "string"
},
"supportedPoolProtocols": [
"string"
],
"tenantDesktopManager": {
"state": "string",
"vmgrId": "string",
"dataCenterId": "string",
"cpuCapacity": 0,
"ramCapacity": 0,
"organizationId": 0,
"monitoringHost": "string",
"lastMonitorTime": "string",
"provisioningEnabled": false,
"lastUpdated": "string",
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"dataDiskConfiguration": {
"sku": "string",
"sizeMb": 0
},
"faultToleranceConfiguration": {
"enabled": false,
"numFaultDomains": 0,
"numUpdateDomains": 0
},
"nonPersistent": false,
"hotplugEnabled": false,
"activeSessionCount": 0,
"farmOccupancy": "number",
"serverCount": 0,
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}integer As int64 As int64
serverDensity
Optional
serverDensity
array of DtSessionFarmServer
allSessionFarmServersWithJMSCapable
Optional
allSessionFarmServersWithJMSCapable
array of DtRemoteApplicationDefinition
autoDiscoveredRemoteAppsForFarm
Optional
autoDiscoveredRemoteAppsForFarm
string
description
Optional
description
string
tenantDesktopManagerId
Optional
tenantDesktopManagerId
string
preferredProtocol
Optional
preferredProtocol
Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
string
preferredClientType
Optional
preferredClientType
Possible values are : BROWSER, HORIZON_CLIENT,
integer As int64 As int64
emptySessionTimeoutMinutes
Optional
emptySessionTimeoutMinutes
integer As int64 As int64
disconnectLimitMinutes
Optional
disconnectLimitMinutes
boolean
emptySessionDoLogoff
Optional
emptySessionDoLogoff
integer As int64 As int64
repristineSessionLimit
Optional
repristineSessionLimit
integer As int64 As int64
minServers
Optional
minServers
integer As int64 As int64
maxServers
Optional
maxServers
string
vmRootName
Optional
vmRootName
integer As int64 As int64
maxSessionLifetimeMinutes
Optional
maxSessionLifetimeMinutes
integer As int64 As int64
allocatorSessionTimeOut
Optional
allocatorSessionTimeOut
string
occupancyPresetMode
Optional
occupancyPresetMode
boolean
farmOnline
Optional
farmOnline
string
farmModeMessage
Optional
farmModeMessage
integer As int32 As int32
numServerInQuiescingState
Optional
numServerInQuiescingState
string
repristineAction
Optional
repristineAction
integer As int32 As int32
firstServerEmptyDuration
Optional
firstServerEmptyDuration
string
repristineType
Optional
repristineType
string
runOnceScript
Optional
runOnceScript
string
organizationalUnit
Optional
organizationalUnit
boolean
encrypted
Optional
encrypted
string
nsxNetwork
Optional
nsxNetwork
string
vmOsLicenseType
Optional
vmOsLicenseType
array of DtFarmPowerManagementSchedule
farmPowerManagementSchedules
Optional
farmPowerManagementSchedules
string
domainName
Optional
domainName
string
farmType
Optional
farmType
Possible values are : APP, SESSION,
string
dataCenterId
Optional
dataCenterId
boolean
allowedToJoinDomain
Optional
allowedToJoinDomain
array of string
assignedNetworks
Optional
assignedNetworks
array of string
supportedPoolProtocols
Optional
supportedPoolProtocols
Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
boolean
nonPersistent
Optional
nonPersistent
boolean
hotplugEnabled
Optional
hotplugEnabled
integer As int64 As int64
activeSessionCount
Optional
activeSessionCount
number As double As double
farmOccupancy
Optional
farmOccupancy
integer As int64 As int64
serverCount
Optional
serverCount
string
name
Optional
name
string
id
Optional
id