[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get Pool

Description

Get pool record by id

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/portal/v2/pools/{id}
Copy

Path Parameters

Path Parameters

string
id Required

id


Query Parameters

Query Parameters

string
org_id Optional

org_id


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Pool of type */*

Successfully retrieved the pool.

{
    "connectionAffinity": "NEAREST_SITE",
    "description": "Pool description",
    "homesiteMappings": {
        "group-id-1": "site-id-2",
        "user-id-1": "site-id-1"
    },
    "id": "ent-id-12345",
    "location": "US",
    "name": "pg-123",
    "orgId": "0123456789",
    "preferredClientType": "HORIZON_CLIENT",
    "requireHomesite": true,
    "scope": "ALL_SITES",
    "templateType": "MULTI_SESSION",
    "type": "DESKTOP"
}
string as ^[a-zA-Z][a-zA-Z0-9\- ]+$
name Required

Pool name


string
type Required

Pool type

Possible values are: APPLICATIONDESKTOPDESKTOP_APPLICATION


array of Template
templates Required

List of templates


string
templateType Required

Template type - templates added to the poolType must match this value

Possible values are: DEDICATEDFLOATINGMULTI_SESSIONRDSHWVD


array of Protocol
protocols Required

List of supported desktop protocols


array of ApplicationItem
applications Optional

List of applications


string
id Optional

Pool ID


string
location Optional

Location that is mapped with Org Id


map of string
homesiteMappings Optional

Map to store UsersId or GroupId with their preferred homesite Id


string
orgId Optional

Org ID that owns this poolType


powerPolicy Optional

Power policy Spec


string
preferredClientType Optional

Preferred Client Type

Possible values are: BROWSERHORIZON_CLIENT


boolean
enableSSO Optional

Enable SSO on this pool.


reportedCapacity Optional

boolean
requireHomesite Optional

Flag to specify home site restriction is enabled or not


string
scope Optional

Scope - use first preferred homesite or all preferred home sites

Possible values are: ALL_SITESWITHIN_SITE


string
description Optional

Pool description


string as date-time
createdAt Optional

Time when the pool was created


string
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the pool

Possible values are: HOME_SITENEAREST_SITE


string as date-time
updatedAt Optional

Time when the pool was updated

Errors

Errors

401

Unauthorized


403

Forbidden


404

Not found

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v2/pools/{id}


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?