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

Patch Pool

Description

Update an existing pool record by adding and/or removing users and/or user groups

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

id


Query Parameters

Query Parameters

boolean
delete Optional

delete


string
disassociateAction Optional

disassociateAction


string
org_id Optional

org_id


Request Body

Request Body

PatchPoolReq of mimetype application/json Required

patchPool

{
    "displayName": "NewPool",
    "templatesToAdd": [
        {
            "dataCenterId": "datacenter-1",
            "edgeDeploymentId": "string",
            "id": "template-3",
            "location": "string",
            "name": "string",
            "orgId": "string",
            "powerPolicy": {
                "base": "TOTAL",
                "enabled": false,
                "min": 2,
                "minUnit": "PERCENTAGE",
                "occupancyPresetMode": "BALANCED",
                "powerOffProtectTimeMins": 30,
                "powerSchedules": [
                    {
                        "allDay": false,
                        "endTime": "17:00",
                        "min": 5,
                        "name": "VmwareWeekdaySchedule",
                        "occursOn": 31,
                        "startTime": "08:00",
                        "timeZone": "Asia/Tokyo"
                    }
                ]
            },
            "templateType": "DEDICATED"
        }
    ],
    "templatesToRemove": [
        "template-1",
        "template-2"
    ],
    "transientLoadThresholdSecs": 10
}
agentCustomization Optional

array of ApplicationItem
applicationsToAdd Optional

List of applications to be added to the pool


array of ApplicationItem
applicationsToRemove Optional

List of applications to be removed from the pool


string
displayName Optional

Pool’s display name


boolean
enableSSO Optional

Enable SSO on this pool.


powerPolicy Optional

Power policy Spec


array of Template
templatesToAdd Optional

List of templates to be added to the pool


array of string
templatesToRemove Optional

List of templates to be removed from the pool


integer as int32
transientLoadThresholdSecs Optional

Time spacing (in seconds) between consecutive session placement on a MULTI-SESSIONtemplate VM. This property will be used to load balance session slots among theMULTI-SESSION template VMs. This value should be between 0 to 300

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Pool of type */*

Pool patched

{
    "connectionAffinity": "NEAREST_SITE",
    "description": "Pool description",
    "displayName": "NewPool",
    "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",
    "transientLoadThresholdSecs": 10,
    "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: APP_CAPTURE_STUDIODEDICATEDFLOATINGMULTI_SESSIONRDSHWVD


array of Protocol
protocols Required

List of supported desktop protocols


agentCustomization Optional

boolean
disabled Optional

If disabled, pool will not recieve any launch request.


string
displayName Optional

Pool’s display name


boolean
enableSSO Optional

Enable SSO on this pool.


map of string
homesiteMappings Optional

Map to store UsersId or GroupId with their preferred homesite Id


string
id Optional

Pool ID


string
location Optional

Location that is mapped with Org Id


string
description Optional

Pool description


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


string as date-time
createdAt Optional

Time when the pool was created


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
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the pool

Possible values are: HOME_SITENEAREST_SITE


array of ApplicationItem
applications Optional

List of applications


integer as int32
transientLoadThresholdSecs Optional

Time spacing (in seconds) between consecutive session placement on a MULTI-SESSIONtemplate VM. This property will be used to load balance session slots among theMULTI-SESSION template VMs. This value should be between 0 to 300


string
transientLoadThresholdSecsStatus Optional

transient load threshold update status

Possible values are: ACTIVEPARTIAL_SUCCESSPENDING_ACTIVE


string
agentCustomizationStatus Optional

Agent Customization Status

Possible values are: ACTIVEPARTIAL_SUCCESSPENDING_ACTIVE


string as date-time
updatedAt Optional

Time when the pool was updated

Errors

Errors

ErrorResponse
400

Bad Request


ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


ErrorResponse
404

Not found


ErrorResponse
412

Precondition Failed

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"displayName":"NewPool","templatesToAdd":[{"dataCenterId":"datacenter-1","edgeDeploymentId":"string","id":"template-3","location":"string","name":"string","orgId":"string","powerPolicy":{"base":"TOTAL","enabled":false,"min":2,"minUnit":"PERCENTAGE","occupancyPresetMode":"BALANCED","powerOffProtectTimeMins":30,"powerSchedules":[{"allDay":false,"endTime":"17:00","min":5,"name":"VmwareWeekdaySchedule","occursOn":31,"startTime":"08:00","timeZone":"Asia/Tokyo"}]},"templateType":"DEDICATED"}],"templatesToRemove":["template-1","template-2"],"transientLoadThresholdSecs":10}' https://cloud.vmwarehorizon.com/portal/v2/pools/{id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: patchPool


Feedback

Was this page helpful?