DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec

DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec
DesktopPoolVirtualMachinePatternNamingSettingsUpdateSpec

Applicable To: Automated desktop pool.
Naming pattern settings for Automated desktop pool.

JSON Example
{
    "max_number_of_machines": 100,
    "min_number_of_machines": 10,
    "naming_pattern": "vm-{n}-sales",
    "number_of_spare_machines": 10,
    "provisioning_time": "ON_DEMAND"
}
integer As int32 As int32
max_number_of_machines
Required

Maximum number of machines in the desktop pool.

integer As int32 As int32
min_number_of_machines
Optional

The minimum number of machines to have provisioned if on demand provisioning is selected. This property is required if provisioning_time is set to "ON_DEMAND" .

string
naming_pattern
Required

Virtual machines will be named according to the specified naming pattern. Horizon appends a unique number to the specified pattern to provide a unique name for each virtual machine. To place this unique number elsewhere in the pattern, use '{n}'. (For example: vm-{n}-sales.) The unique number can also be made a fixed length. (For example: vm-{n:fixed=3}-sales will name VMs from vm-001-sales to vm-999-sales). Machine names are constrained to a maximum size of 15 characters including the unique number. Therefore, care must be taken when choosing a pattern. If the maximum desktop pool size is 9 machines, the pattern must be at most 14 characters. For 99 machines, 13 characters, for 999 machines, 12 characters. For 9999 machines, 11 characters. If using a fixed size token, use a maximum of 14 characters for "n=1", 13 characters for "n=2", 12 characters for "n=3", and 11 characters for "n=4".If {n} is specified with no size, a size of 2 is automatically used and if no {} is specified, {n=2} is automatically appended to the end of the pattern. This property must contain only alphanumerics and dashes. It must contain at least one alpha character. It may also optionally contain a numeric placement token {n} or {n:fixed=#}. If the pattern does not specify the numeric placement token, the maximum length is 14 characters.

integer As int32 As int32
number_of_spare_machines
Required

Number of spare powered on machines.

string
provisioning_time
Required

Determines when the machines are provisioned.

  • ON_DEMAND: Provision machines on demand.
  • UP_FRONT: Provision all machines up-front.
Possible values are : ON_DEMAND, UP_FRONT,