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

Batch Patch

Description

Patch a batch of templates

Request

Request

URL

URL


patch
https://cloud.vmwarehorizon.com/admin/v2/batch/templates
Copy

Query Parameters

Query Parameters

boolean
ignore_warnings Optional

If true, errors classified as warnings will be ignored


string
org_id Optional

Organization ID: non-super users can only access their own organization


Request Body

Request Body

TemplateBatchPatchRequestTOV1 of mimetype application/json Required

batchPatchV1

{
	"patch": {
		"agentCustomization": {
			"demSettingId": "string",
			"disconnectSessionTimeoutMins": 0,
			"dtemplateName": "string",
			"emptySessionLogoffType": "DISCONNECT",
			"emptySessionTimeoutMins": 0,
			"esUrl": "string",
			"proxyInfo": {
				"bypass": "10.12.100.10;10.120.100.10;100.12.*.100",
				"server": "http://<<ipaddress or cname>>:<<port>>"
			},
			"runOnceCommand": "string",
			"sessionLoadBalancingSettings": {
				"LBCHANGETHRESHOLD": 1,
				"LBCPUTHRESHOLD": 50,
				"LBDISKQUEUELENTHRESHOLD": 50,
				"LBDISKREADLATENCYTHRESHOLD": 50,
				"LBDISKWRITELATENCYTHRESHOLD": 50,
				"LBINCLUDESESSIONCOUNT": true,
				"LBMEMTHRESHOLD": 50,
				"LBUSECUSTOMSCRIPT": false,
				"loadIndexThresholdPercent": 0,
				"modelVersion": 0
			},
			"sessionsPerVm": 1,
			"skipDomainJoin": false
		},
		"applicationProperties": {
			"key": "string"
		},
		"computerAccountOU": "CN=Computers",
		"description": "My floating desktop template",
		"diskEncryption": {
			"enabled": false,
			"modelVersion": 0
		},
		"diskSizeInGB": 0,
		"imageReference": {
			"markerId": "string",
			"modelVersion": 0,
			"streamId": "string",
			"versionId": "string"
		},
		"infrastructure": {
			"key": {
				"data": {},
				"id": "string",
				"infrastructureLinks": {},
				"kind": "string"
			}
		},
		"maxQuiescingServers": 10,
		"name": "My floating desktop template",
		"networks": [
			{
				"data": {},
				"id": "string",
				"infrastructureLinks": {},
				"kind": "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"
				}
			]
		},
		"protocols": [
			"BLAST"
		],
		"resourceTags": {
			"key": "string"
		},
		"sessionsPerVm": 0,
		"sparePolicy": {
			"increment": 200,
			"limit": 10,
			"max": 4,
			"min": 2,
			"modelVersion": 0
		},
		"templateConnectivityStatus": "OFFLINE",
		"vmLicenseType": "NONE"
	},
	"query": {
		"ids": [
			"string"
		],
		"orgId": "string",
		"search": "string"
	}
}
patch Optional

Patch model for updating template.


query Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns TemplateBatchResponseTO of type */*
{
    "errors": "templateId, ErrorDetail",
    "results": "templateId, TemplateTOV2"
}
map of ErrorDetail
errors Optional

Templates where action was unsuccessful


map of TemplateTOV2
results Optional

Templates where action was successful


202 Accepted Response Body>

Response Body

202 Accepted

Returns TemplateBatchResponseTO of type */*

Accepted the request to patch the templates without any issues. Response holds the templates with modified status.

{
    "errors": "templateId, ErrorDetail",
    "results": "templateId, TemplateTOV2"
}
map of ErrorDetail
errors Optional

Templates where action was unsuccessful


map of TemplateTOV2
results Optional

Templates where action was successful


204 No Content

No Content


207 Response Body>

Response Body

207

Returns TemplateBatchResponseTO of type */*

Mixed results. Response holds successful templates as well as failed templates.

{
    "errors": "templateId, ErrorDetail",
    "results": "templateId, TemplateTOV2"
}
map of ErrorDetail
errors Optional

Templates where action was unsuccessful


map of TemplateTOV2
results Optional

Templates where action was successful

Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"patch":{"agentCustomization":{"demSettingId":"string","disconnectSessionTimeoutMins":0,"dtemplateName":"string","emptySessionLogoffType":"DISCONNECT","emptySessionTimeoutMins":0,"esUrl":"string","proxyInfo":{"bypass":"10.12.100.10;10.120.100.10;100.12.*.100","server":"http://<<ipaddress or cname>>:<<port>>"},"runOnceCommand":"string","sessionLoadBalancingSettings":{"LBCHANGETHRESHOLD":1,"LBCPUTHRESHOLD":50,"LBDISKQUEUELENTHRESHOLD":50,"LBDISKREADLATENCYTHRESHOLD":50,"LBDISKWRITELATENCYTHRESHOLD":50,"LBINCLUDESESSIONCOUNT":true,"LBMEMTHRESHOLD":50,"LBUSECUSTOMSCRIPT":false,"loadIndexThresholdPercent":0,"modelVersion":0},"sessionsPerVm":1,"skipDomainJoin":false},"applicationProperties":{"key":"string"},"computerAccountOU":"CN=Computers","description":"My floating desktop template","diskEncryption":{"enabled":false,"modelVersion":0},"diskSizeInGB":0,"imageReference":{"markerId":"string","modelVersion":0,"streamId":"string","versionId":"string"},"infrastructure":{"key":{"data":{},"id":"string","infrastructureLinks":{},"kind":"string"}},"maxQuiescingServers":10,"name":"My floating desktop template","networks":[{"data":{},"id":"string","infrastructureLinks":{},"kind":"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"}]},"protocols":["BLAST"],"resourceTags":{"key":"string"},"sessionsPerVm":0,"sparePolicy":{"increment":200,"limit":10,"max":4,"min":2,"modelVersion":0},"templateConnectivityStatus":"OFFLINE","vmLicenseType":"NONE"},"query":{"ids":["string"],"orgId":"string","search":"string"}}' https://cloud.vmwarehorizon.com/admin/v2/batch/templates
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?