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

TemplateCreateTOV2

Properties

string
activeDirectoryId Optional

ID of the Active Directory configuration that will be used when creating VMs in this template. This defines the domain to which VMs will be joined, and the account used to do so.


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.


array of string
desktopAdminPassword Optional

The initial admin password for all new VMs created from this template.


string
desktopAdminUsername Optional

The initial admin username for all new VMs created from this template.


diskEncryption Optional

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.


boolean
licenseProvided Optional

Represents if the Windows License Type was acknowledged and provided by the user


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.


string
orgId Optional

Org ID that owns this template.


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


string
providerInstanceId Optional

ID of the provider instance to used when creating VMs for this template. This will define, for example, the subscription and region of the VMs for Azure templates.


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, noVM lifecycle operations will be performed for this template, and no client connections will be allowed.

Possible values are: OFFLINEONLINE


string
templateType Optional

Template type. ‘DEDICATED’ creates single-session Windows 10 VMs that are assigned to and owned by specific users. ‘FLOATING’ creates single-session Windows 10 VMs that are shared. ‘MULTI_SESSION’ creates multi-session Windows Server VMs and multi-session Windows 10 VMs

Possible values are: DEDICATEDFLOATINGMULTI_SESSIONRDSHSTUDIOWVD


string
uagDeploymentId Optional

ID of the ‘uagDeployment’ for the template. This will define which UAG cluster will be used to connect clients to desktops


string
vmLicenseType Optional

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

Possible values are: NONEWINDOWS_CLIENTWINDOWS_SERVER


string
vmNamePattern Optional

Pattern used as prefix for VMs created for this template.

JSON Example

{
	"activeDirectoryId": "string",
	"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",
	"desktopAdminPassword": [
		"string"
	],
	"desktopAdminUsername": "string",
	"diskEncryption": {
		"enabled": false,
		"modelVersion": 0
	},
	"imageReference": {
		"modelVersion": 0,
		"streamId": "string",
		"versionId": "string"
	},
	"infrastructure": {
		"key": {
			"data": {},
			"id": "string",
			"infrastructureLinks": {},
			"kind": "string"
		}
	},
	"licenseProvided": false,
	"maxQuiescingServers": 10,
	"name": "My floating desktop template",
	"networks": [
		{
			"data": {},
			"id": "string",
			"infrastructureLinks": {},
			"kind": "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"
			}
		]
	},
	"protocols": [
		"BLAST"
	],
	"providerInstanceId": "string",
	"resourceTags": {
		"key": "string"
	},
	"sessionsPerVm": 0,
	"sparePolicy": {
		"increment": 200,
		"limit": 10,
		"max": 4,
		"min": 2,
		"modelVersion": 0
	},
	"templateConnectivityStatus": "OFFLINE",
	"templateType": "DEDICATED",
	"uagDeploymentId": "string",
	"vmLicenseType": "NONE",
	"vmNamePattern": "string"
}
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Parameter To

Create

Feedback

Was this page helpful?