DtSessionPoolImpl
DtSessionPoolImpl
JSON Example
{
"id": "string",
"name": "string",
"entitledUserCount": 0,
"serverDensity": 0,
"serverCount": 0,
"requestedSize": 0,
"sessionBased": false,
"preferredClientType": "string",
"vmRootName": "string",
"poolModeMessage": "string",
"encrypted": false,
"nsxNetwork": "string",
"vmOsLicenseType": "string",
"domainName": "string",
"supportedPoolProtocols": [
"string"
],
"hotplugEnabled": false,
"lastUpdated": "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",
"patternType": "string",
"provisioningState": "string",
"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": [
{
"desktopPatterns": [
{
"desktopPoolId": "string",
"previousDesktopPoolId": "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"
}
]
}
],
"allEntitlements": [
{
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"defaultMapping": {
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"roleOfUser": {
"lastUpdate": "string",
"creationDate": "string",
"name": "string",
"permissions": [
"string"
],
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"loginName": "string",
"fromNetBiosDomain": "string",
"userDn": "string",
"userRdpSettings": [
{
"clientType": "string",
"fullScreen": false,
"screenResolution": "string",
"colorDepth": "string",
"disableCursorShadow": false,
"disableCursorBlink": false,
"disableFullWindowDrag": false,
"disableMenuAnimation": false,
"disableThemes": false,
"disableWallpaper": false,
"spanMultipleMonitors": false,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"domainName": "string",
"lastUpdated": "string",
"pools": [
"DtPool Object"
],
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"usersAssignedByAdmin": [
{
"desktopPatterns": [
{
"desktopPoolId": "string",
"previousDesktopPoolId": "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"
}
]
}
],
"allEntitlements": [
{
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"defaultMapping": {
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"roleOfUser": {
"lastUpdate": "string",
"creationDate": "string",
"name": "string",
"permissions": [
"string"
],
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
},
"loginName": "string",
"fromNetBiosDomain": "string",
"userDn": "string",
"userRdpSettings": [
{
"clientType": "string",
"fullScreen": false,
"screenResolution": "string",
"colorDepth": "string",
"disableCursorShadow": false,
"disableCursorBlink": false,
"disableFullWindowDrag": false,
"disableMenuAnimation": false,
"disableThemes": false,
"disableWallpaper": false,
"spanMultipleMonitors": false,
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"domainName": "string",
"lastUpdated": "string",
"pools": [
"DtPool Object"
],
"dateCreated": "string",
"name": "string",
"id": "string",
"links": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}
],
"poolSessionType": "string",
"internal": false,
"dateCreated": "string",
"patternId": "string",
"location": "string",
"DtFarmPowerManagementSchedules": [
{
"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"
}
]
},
"DataDiskConfiguration": {
"sku": "string",
"sizeMb": 0
},
"DtFaultToleranceConfiguration": {
"enabled": false,
"numFaultDomains": 0,
"numUpdateDomains": 0
},
"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"
}
]
},
"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"
},
"DtLink": [
{
"href": "string",
"rel": "string",
"deprecated": false,
"name": "string",
"method": "string"
}
]
}string
id
Optional
id
string
name
Optional
name
integer As int32 As int32
entitledUserCount
Optional
entitledUserCount
integer As int64 As int64
serverDensity
Optional
serverDensity
integer As int64 As int64
serverCount
Optional
serverCount
integer As int64 As int64
requestedSize
Optional
requestedSize
boolean
sessionBased
Optional
sessionBased
string
preferredClientType
Optional
preferredClientType
Possible values are : BROWSER, HORIZON_CLIENT,
string
vmRootName
Optional
vmRootName
string
poolModeMessage
Optional
poolModeMessage
boolean
encrypted
Optional
encrypted
string
nsxNetwork
Optional
nsxNetwork
string
vmOsLicenseType
Optional
vmOsLicenseType
string
domainName
Optional
domainName
array of string
supportedPoolProtocols
Optional
supportedPoolProtocols
Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
boolean
hotplugEnabled
Optional
hotplugEnabled
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string
poolSizeType
Optional
poolSizeType
Possible values are : Fixed, Elastic, Test,
string
patternType
Optional
patternType
Possible values are : G, D, S, U, A,
string
provisioningState
Optional
provisioningState
integer As int64 As int64
minimumAvailable
Optional
minimumAvailable
integer As int64 As int64
actualSize
Optional
actualSize
boolean
highlyAvailable
Optional
highlyAvailable
boolean
poolOnline
Optional
poolOnline
string
defaultPoolProtocol
Optional
defaultPoolProtocol
Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
array of string
usedByDataCenterIds
Optional
usedByDataCenterIds
string
customerId
Optional
customerId
string
poolSessionType
Optional
poolSessionType
Possible values are : desktop, application, both,
boolean
internal
Optional
internal
string As date-time As date-time
dateCreated
Optional
dateCreated
string
patternId
Optional
patternId
string
location
Optional
location
array of DtFarmPowerManagementSchedule
DtFarmPowerManagementSchedules
Optional
List of farm power management schedules