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

Update Pool

Description

Update an existing pool record with new values. The new data must be complete and valid as if it were a new record

Request

Request

URL

URL


put
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


Request Body

Request Body

Pool of mimetype application/json Required

pool

{
	"name": "pg-123",
	"protocols": [
		{
			"defaultProtocol": false,
			"name": "BLAST"
		}
	],
	"templateType": "MULTI_SESSION",
	"templates": [
		{
			"id": "template-1"
		}
	],
	"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

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns Pool of type */*

Pool updated

{
	"applications": [
		{
			"displayName": "Google Chrome",
			"icons": {
				"key": {
					"height": 0,
					"iconHash": "string",
					"icondata": "string",
					"path": "string",
					"width": 0
				}
			},
			"id": "string",
			"name": "Chrome",
			"orgId": "0123456789",
			"os": "Windows",
			"path": "c:\\app\\chrome.exe",
			"publisher": "VMware Inc",
			"registeredExtensions": {
				"extensions": [
					{
						"friendlyName": "string",
						"value": "string"
					}
				],
				"otherFileType": [
					{
						"friendlyName": "string",
						"type": "string",
						"value": "string"
					}
				]
			},
			"streamId": "string",
			"templateIds": [
				"string"
			],
			"version": "1.0.0",
			"versionId": "string"
		}
	],
	"connectionAffinity": "NEAREST_SITE",
	"createdAt": "string",
	"description": "Pool description",
	"enableSSO": false,
	"homesiteMappings": {
		"key": "site-id-1 | site-id-2"
	},
	"id": "ent-id-12345",
	"location": "US",
	"name": "pg-123",
	"orgId": "0123456789",
	"powerPolicy": {
		"enabled": false,
		"min": 2,
		"minUnit": "PERCENTAGE",
		"modelVersion": 0,
		"occupancyPresetMode": "BALANCED",
		"powerOffProtectTimeMins": 30,
		"powerSchedules": [
			{
				"allDay": false,
				"endTime": "17:00",
				"min": 5,
				"modelVersion": 0,
				"name": "VmwareWeekdaySchedule",
				"occursOn": 31,
				"startTime": "08:00",
				"timeZone": "Asia/Tokyo"
			}
		]
	},
	"preferredClientType": "HORIZON_CLIENT",
	"protocols": [
		{
			"defaultProtocol": false,
			"name": "BLAST"
		}
	],
	"reportedCapacity": {
		"consumedVMs": 0,
		"freeSessions": 0,
		"maxVMs": 0,
		"provisionedSessions": 0,
		"provisionedVMs": 0,
		"usedSessions": 0
	},
	"requireHomesite": true,
	"scope": "ALL_SITES",
	"templateType": "MULTI_SESSION",
	"templates": [
		{
			"activeDirectoryId": "string",
			"avAgentInstalled": false,
			"clientAccessLicenseApplicable": false,
			"dataCenterId": "datacenter-1",
			"delete": false,
			"disabled": false,
			"disassociateAction": "FORCEFUL",
			"edgeDeploymentId": "string",
			"id": "template-1",
			"imageReference": {
				"modelVersion": 0,
				"streamId": "string",
				"versionId": "string"
			},
			"location": "string",
			"name": "string",
			"orgId": "string",
			"powerPolicy": {
				"enabled": false,
				"min": 2,
				"minUnit": "PERCENTAGE",
				"modelVersion": 0,
				"occupancyPresetMode": "BALANCED",
				"powerOffProtectTimeMins": 30,
				"powerSchedules": [
					{
						"allDay": false,
						"endTime": "17:00",
						"min": 5,
						"modelVersion": 0,
						"name": "VmwareWeekdaySchedule",
						"occursOn": 31,
						"startTime": "08:00",
						"timeZone": "Asia/Tokyo"
					}
				]
			},
			"providerInstance": {
				"id": "0123456789"
			},
			"templateType": "DEDICATED"
		}
	],
	"type": "DESKTOP",
	"updatedAt": "string"
}
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

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not found


412

Precondition Failed

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"applications":[{"displayName":"Google Chrome","icons":{"key":{"height":0,"iconHash":"string","icondata":"string","path":"string","width":0}},"id":"string","name":"Chrome","orgId":"0123456789","os":"Windows","path":"c:\\app\\chrome.exe","publisher":"VMware Inc","registeredExtensions":{"extensions":[{"friendlyName":"string","value":"string"}],"otherFileType":[{"friendlyName":"string","type":"string","value":"string"}]},"streamId":"string","templateIds":["string"],"version":"1.0.0","versionId":"string"}],"connectionAffinity":"NEAREST_SITE","createdAt":"string","description":"Pool description","enableSSO":false,"homesiteMappings":{"key":"site-id-1 | site-id-2"},"id":"ent-id-12345","location":"US","name":"pg-123","orgId":"0123456789","powerPolicy":{"enabled":false,"min":2,"minUnit":"PERCENTAGE","modelVersion":0,"occupancyPresetMode":"BALANCED","powerOffProtectTimeMins":30,"powerSchedules":[{"allDay":false,"endTime":"17:00","min":5,"modelVersion":0,"name":"VmwareWeekdaySchedule","occursOn":31,"startTime":"08:00","timeZone":"Asia/Tokyo"}]},"preferredClientType":"HORIZON_CLIENT","protocols":[{"defaultProtocol":false,"name":"BLAST"}],"reportedCapacity":{"consumedVMs":0,"freeSessions":0,"maxVMs":0,"provisionedSessions":0,"provisionedVMs":0,"usedSessions":0},"requireHomesite":true,"scope":"ALL_SITES","templateType":"MULTI_SESSION","templates":[{"activeDirectoryId":"string","avAgentInstalled":false,"clientAccessLicenseApplicable":false,"dataCenterId":"datacenter-1","delete":false,"disabled":false,"disassociateAction":"FORCEFUL","edgeDeploymentId":"string","id":"template-1","imageReference":{"modelVersion":0,"streamId":"string","versionId":"string"},"location":"string","name":"string","orgId":"string","powerPolicy":{"enabled":false,"min":2,"minUnit":"PERCENTAGE","modelVersion":0,"occupancyPresetMode":"BALANCED","powerOffProtectTimeMins":30,"powerSchedules":[{"allDay":false,"endTime":"17:00","min":5,"modelVersion":0,"name":"VmwareWeekdaySchedule","occursOn":31,"startTime":"08:00","timeZone":"Asia/Tokyo"}]},"providerInstance":{"id":"0123456789"},"templateType":"DEDICATED"}],"type":"DESKTOP","updatedAt":"string"}' 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: pool


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

Was this page helpful?