Session Farms
Request
URI
GET
https://{api_host}/dt-rest/v100/infrastructure/pattern/gold/{id}/sessionfarms
COPY
Path Parameters
string
id
Required
id
Responses
200
successful operation
[
{
"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"
}
]
}
]
Dt Gold Pattern Operations
POST
Convert To Desktop
POST
Copy From Gold Pattern
GET
Create Agent Update Filter
POST
Delete
POST
Delete Backup
GET
Get
GET
Get Applications
GET
Get Available Agent Update Details
POST
Get Available Agent Update Details
GET
Get Available Agent Update On Pattern
GET
Get Backup Count
GET
Get Backup Info
GET
Get Data Centers
GET
Get Desktop Manager Id
GET
Get Pools
POST
Get Update Agent Status On Pattern
GET
Get Virtual Machine
POST
Perform Backup
POST
Perform Rollback
PUT
Rename
PUT
Rename Pattern
GET
Session Farms
PUT
Update
POST
Update Agents On Gold Pattern
GET
Validate For Gold Pattern
GET
Validate Gold Pattern For Element