Patch Pool
DescriptionUpdate an existing pool record by adding and/or removing users and/or user groups
Request
URLURL
Path Parameters
Path Parameters
id
Query Parameters
Query Parameters
delete
disassociateAction
Possible values are: FORCEFUL , GRACEFUL
org_id
Request Body
{
"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
}
List of applications to be removed from the pool
Pool’s display name
Enable SSO on this pool.
List of templates to be removed from the pool
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
Response
Response BodyResponse Body
200 OK
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"
}
Pool name
Pool type
Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION
Template type - templates added to the poolType must match this value
Possible values are: APP_CAPTURE_STUDIO , DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD
If disabled, pool will not recieve any launch request.
Pool’s display name
Enable SSO on this pool.
Map to store UsersId or GroupId with their preferred homesite Id
Pool ID
Location that is mapped with Org Id
Pool description
Org ID that owns this poolType
Preferred Client Type
Possible values are: BROWSER , HORIZON_CLIENT
Time when the pool was created
Flag to specify home site restriction is enabled or not
Scope - use first preferred homesite or all preferred home sites
Possible values are: ALL_SITES , WITHIN_SITE
Connection Affinity - rule to be used while brokering the pool
Possible values are: HOME_SITE , NEAREST_SITE
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
transient load threshold update status
Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE
Agent Customization Status
Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE
Time when the pool was updated
Errors
Bad Request
Unauthorized
Forbidden
Not found
Precondition Failed
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: patchPool