Get Pool With Entitled User Count

Get Pool With Entitled User Count
Request
URI
GET
https://{api_host}/dt-rest/v100/pool/manager/{poolId}/withentitledusercount
COPY
Path Parameters
string
poolId
Required

poolId

Responses
200

successful operation

Returns DtPool of type(s) */* 
{
    "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"
                }
            ]
        },
        "customFields": {
            "customFields": "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"
        }
    ]
}
string
preferredClientType
Optional

preferredClientType

Possible values are : BROWSER, HORIZON_CLIENT,
string
vmRootName
Optional

vmRootName

string
poolModeMessage
Optional

poolModeMessage

object
repristineSchedule
Optional

repristineSchedule

boolean
encrypted
Optional

encrypted

string
nsxNetwork
Optional

nsxNetwork

string
vmOsLicenseType
Optional

vmOsLicenseType

array of object
DtFarmPowerManagementSchedules
Optional

List of farm power management schedules

array of object
DtResourceTags
Optional

Resource Tags

object
osDiskConfiguration
Optional

osDiskConfiguration

DtGoldPattern
DtGoldPattern
Required

DtGoldPattern

string
domainName
Optional

domainName

object
DtDesktopModel
Optional

DtDesktopModel

object
DtDesktopSize
Optional

DtDesktopSize

array of string
supportedPoolProtocols
Optional

supportedPoolProtocols

Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,
object
dataDiskConfiguration
Optional

dataDiskConfiguration

object
faultToleranceConfiguration
Optional

faultToleranceConfiguration

boolean
hotplugEnabled
Optional

hotplugEnabled

string As date-time As date-time
lastUpdated
Optional

lastUpdated

object
DtOrganization
Required

DtOrganization

array of object
virtualMachines
Optional

virtualMachines

string
poolSizeType
Optional

poolSizeType

Possible values are : Fixed, Elastic, Test,
object
DtPoolPolicy
Required

DtPoolPolicy

string
patternType
Optional

patternType

Possible values are : G, D, S, U, A,
string
provisioningState
Optional

provisioningState

boolean
sessionBased
Optional

sessionBased

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

array of object
groupsOfPool
Optional

groupsOfPool

array of DtUser
usersOfPool
Optional

usersOfPool

array of DtUser
usersAssignedByAdmin
Optional

usersAssignedByAdmin

string
poolSessionType
Optional

poolSessionType

Possible values are : desktop, application, both,
boolean
vmrefreshRequired
Optional

vmrefreshRequired

boolean
internal
Optional

internal

integer As int32 As int32
entitledUserCount
Optional

entitledUserCount

string As date-time As date-time
dateCreated
Optional

dateCreated

string
name
Optional

name

string
id
Optional

id

array of object
links
Optional

links


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/dt-rest/v100/pool/manager/{poolId}/withentitledusercount
On This Page
Dt Pool Manager Operations
POST
Set Agent Update Cache Path
GET
Find Applications
PUT
Assign User To Static Desktop Pattern
POST
Schedule Check Agent Updates Job
POST
Clear Machine Id For VM
POST
Convert To Gold Pattern
Deprecated
POST
Convert VM To Gold Pattern
Deprecated
POST
Convert Vm To Gold Pattern
POST
Create Application Session Pool
POST
Create Application Session Pool
POST
Create Desktop Pool
POST
Create Desktop Pool
POST
Create Session Pool
POST
Create Session Pool
POST
Create User Defined App
GET
Create Pattern Filter
GET
Create Pool Filter
GET
Create Virtual Machine Filter
POST
Delete User Defined App
GET
Get Gold Patterns
Deprecated
GET
Get Gold Patterns For Desktop Model
GET
Get Gold Patterns By Attrs
POST
Get Entitled User Count For Pools
POST
Find Desktop Patterns
POST
Find Virtual Machines
POST
Find Pools
GET
Get Gold Patterns For Pool Type
GET
Is GP Sync Enabled
GET
Last GP Conversion Error
GET
List Vms With Older Agents
GET
Get Desktop Pools Of Groups
GET
Get Default Mapping Of Users
GET
Get Patterns Of Users
GET
Get Desktop Pool Of Users
POST
Migrate Desktop Patterns
Deprecated
POST
Migrate Patterns
POST
Migrate Pool Vms
PUT
Modify User Defined App
Deprecated
GET
Get Occupancy For Pools
GET
Get Patterns
GET
Get Agent Update Config
POST
Get Available Agent Updates On Pools
POST
Update Agents On Pool By Filter
POST
Get Update Agent Status On Pools
GET
Get Pool
POST
Get Available Agent Update Details
POST
Get Available Agent Update Details
GET
Get Available Agent Update On Pool
Deprecated
POST
Update Agents On Pool
Deprecated
POST
Get Update Agent Status On Pool
Deprecated
GET
Create Agent Update Filter
POST
Refresh Dynamic Pool
POST
Resync Pool
GET
Get Pools
GET
Get Pools With Entitled User Counts
POST
Push Machine Id To VM
GET
Get RDP
POST
Rectify Migrated Pool Vms
POST
Purge Recycle Pool
POST
Reserve Desktop Pattern
POST
Reset Agent Pairing State For Patterns
POST
Reset Agent Pairing State For Pool V Ms
POST
Reset Pairing State For VM
Deprecated
POST
Unreserve Pattern
PUT
Upload User Defined App Icon
GET
Get Virtual Machine
POST
Target Pools For Vm Migration
GET
Get Virtual Machines
GET
Get Desktop Manager Id For Pool Id
POST
Rebuild Dynamic Pool V Ms API
POST
Perform Pool Batch Power Operation
GET
Get Pool With Entitled User Count