Get Pools
Request
URI
GET
https://{api_host}/dt-rest/v100/security/domain/{domainId}/user/{id}/pools
COPY
Path Parameters
string
domainId
Required
domainId
string
id
Required
id
Responses
200
successful operation
[
{
"preferredClientType": "string",
"vmRootName": "string",
"poolModeMessage": "string",
"repristineSchedule": {
"dayOfWeek": 0,
"farmId": "string",
"frequency": "string",
"hourOfDay": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"encrypted": false,
"nsxNetwork": "string",
"vmOsLicenseType": "string",
"DtFarmPowerManagementSchedules": [
{
"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
},
"DtGoldPattern": "DtGoldPattern Object",
"domainName": "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"
}
]
},
"DtDesktopSize": {
"memoryInMB": 0,
"gpu": false,
"numberOfCores": 0,
"osDiskSizeInMB": 0,
"name": "string"
},
"supportedPoolProtocols": [
"string"
],
"dataDiskConfiguration": {
"sku": "string",
"sizeMb": 0
},
"faultToleranceConfiguration": {
"enabled": false,
"numFaultDomains": 0,
"numUpdateDomains": 0
},
"hotplugEnabled": false,
"lastUpdated": "string",
"DtOrganization": {
"disabled": false,
"allAppliances": [
{
"state": "string",
"version": "string",
"lifeState": "string",
"computePoolId": "string",
"organizationId": "string",
"monitoringHost": "string",
"lastMonitorTime": "string",
"displayName": "string",
"datacenterId": "string",
"capabilities": 0,
"hypervisorHostId": "string",
"lastHeartbeat": "string",
"numMissedHeartbeats": 0,
"resourceManagerId": "string",
"hapairApplianceId": "string",
"publicIp": "string",
"backboneIp": "string",
"floatingIp": "string",
"virtualMachineId": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"superTenant": false,
"userWritableVolumeEnabled": false,
"desktopModelQuotas": [
{
"dataCenterId": "string",
"organizationId": "string",
"lastUpdated": "string",
"vmCount": 0,
"desktopModelId": "string",
"desktopManagerId": "string",
"cpuAvailable": 0,
"cpuUsed": 0,
"ramAvailableGB": "number",
"ramUsedGB": "number",
"dateCreated": "string",
"quota": 0,
"remainingVMCount": 0,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"sslCertificate": "string",
"caCertificate": "string",
"sslCertificateKey": "string",
"enableAppVolumesStatus": "string",
"helpDesk": {
"email": "string",
"phone": "string",
"cellPhone": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"support": {
"email": "string",
"phone": "string",
"cellPhone": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"diskQuota": 0,
"vmQuota": 0,
"psqlPassword": "string",
"brandedCSSURL": "string",
"licenseFileURL": "string",
"supportURL": "string",
"crmURL": "string",
"businessUrl": "string",
"adminContact": {
"email": "string",
"phone": "string",
"cellPhone": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"technicalContact": {
"email": "string",
"phone": "string",
"cellPhone": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"dateCreated": "string",
"dateUpdated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"virtualMachines": [
{
"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"
}
]
}
],
"poolSizeType": "string",
"DtPoolPolicy": {
"numCPU": 0,
"memory": 0,
"smartCardRedirect": false,
"allowFullDesktop": false,
"clipBoardRedirect": false,
"comPortRedirect": false,
"drivesRedirect": false,
"printerRedirect": false,
"maxPoweredOnVMs": 0,
"minPoweredOnVMs": 0,
"assignedGroupNames": [
"string"
],
"video3DEnabled": false,
"numDesktopInQuiescingState": 0,
"defaultPowerState": "string",
"disconnectLimitMinutes": 0,
"repristineSessionLimit": 0,
"minServers": 0,
"maxServers": 0,
"maxSessionLifetimeMinutes": 0,
"allocatorSessionTimeOut": 0,
"occupancyPresetMode": "string",
"repristineAction": "string",
"firstServerEmptyDuration": 0,
"repristineType": "string",
"runOnceScript": "string",
"organizationalUnit": "string",
"allowedToJoinDomain": false,
"assignedNetworks": [
"string"
],
"nonPersistent": false,
"licenseKey": "string",
"timezone": {
"dstsavings": 0,
"rawOffset": 0,
"id": "string",
"displayName": "string"
},
"assignedGroups": [
{
"role": {
"lastUpdate": "string",
"creationDate": "string",
"name": "string",
"permissions": [
"string"
],
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"domainName": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"registeredTo": "string"
},
"patternType": "string",
"provisioningState": "string",
"sessionBased": false,
"minimumAvailable": 0,
"actualSize": 0,
"highlyAvailable": false,
"poolOnline": false,
"defaultPoolProtocol": "string",
"usedByDataCenterIds": [
"string"
],
"customerId": "string",
"groupsOfPool": [
{
"role": {
"lastUpdate": "string",
"creationDate": "string",
"name": "string",
"permissions": [
"string"
],
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"domainName": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"usersOfPool": [
"DtUser Object"
],
"usersAssignedByAdmin": [
"DtUser Object"
],
"poolSessionType": "string",
"vmrefreshRequired": false,
"internal": false,
"entitledUserCount": 0,
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
]
Dt User Operations
PUT
Assign Pool
PUT
Assign Static Desktop
GET
Get
GET
Get All Entitlements
GET
Get Default Mapping
GET
Get Desktop Patterns
GET
Get Display Protocol
GET
Get Pools
GET
Get Role Of User
PUT
Remove Pool
PUT
Remove Static Desktop
PUT
Set Default Mapping
PUT
Set Display Protocol
PUT
Update Static Desktop Assignment