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

TemplatePatchTO

Patch model for updating template.


Properties

agentCustomization Optional

map of string
applicationProperties Optional

Application properties to be added when template is created.


string
computerAccountOU Optional

The VMs of this template will be part of this Organization Unit in the AD


string
description Optional

An arbitrary description for this template.


imageReference Optional

infrastructure Optional

All other provider resources that should be used when creating VMs for this template. The keys in this map and the interpretation of the values depend on the provider type.


integer as int32
maxQuiescingServers Optional

Max number of desktops which can quiesced when the template is undergoing normal maintenance.


string
name Optional

Template name.


networks Optional

List of network resources that will be used when creating VMs for this template. The meaning of ‘network resource’ will depend on the provider type. For example, in Azure, this will be a list of subnets.


powerPolicy Optional

Power policy Spec


array of string
protocols Optional

List of protocols to be allowed for client connections to desktops in this template. Allowable values are ‘BLAST’, ‘PCOIP’ and ‘RDP’.

Possible values are: BLASTPCOIPRDP


map of string
resourceTags Optional

Tags to be added to resources when they are created as part of this template.


integer as int32
sessionsPerVm Optional

Max number of desktops sessions allowed per VM. For Windows desktop VMs, this value must be 1. For MULTI_SESSION, it can be any value greater than 0.


sparePolicy Optional

Spare capacity policy


string
templateConnectivityStatus Optional

Defines whether this template is ‘offline’ or ‘online’. When offline, no VM lifecycle operations will be performed for this template, and no client connections will be allowed.

Possible values are: OFFLINEONLINE


string
vmLicenseType Optional

The type of Windows licenses that the creating organization posesses and wishes to use for all VMs created as part of this template.

Possible values are: NONEWINDOWS_CLIENTWINDOWS_SERVER

JSON Example

{
	"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",
	"imageReference": {
		"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"
}
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Property Of

TemplateBulkPatchRequestTO
Parameter To

Patch By ID

Feedback

Was this page helpful?