DesktopPoolDisplayProtocolSettingsUpdateSpec

Applicable To: Automated and Manual desktop pool.
Display protocol setting for Automated and Manual desktop pool.

JSON Example

{
    "allow_users_to_choose_protocol": true,
    "default_display_protocol": "PCOIP",
    "max_number_of_monitors": 2,
    "max_resolution_of_any_one_monitor": "WUXGA",
    "renderer3d": "DISABLED",
    "session_collaboration_enabled": false,
    "vram_size_mb": 64
}

boolean

allow_users_to_choose_protocol

Required

Indicates whether the users can choose the protocol.

string

default_display_protocol

Required

The default display protocol for the desktop pool.

BLAST: BLAST protocol.
PCOIP: PCoIP protocol.
RDP: Microsoft Remote Desktop Protocol.

Possible values are : BLAST, PCOIP, RDP,

integer As int32 As int32

max_number_of_monitors

Optional

When renderer3d is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor' settings determine the amount ofvRAM assigned to machines in this desktop pool. The greater these values are, the more memory will be consumeon the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered onfor the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled and managedby Horizon, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE, or DISABLED.

string

max_resolution_of_any_one_monitor

Optional

If 3D rendering is enabled and managed by Horizon, this must be set to the default value. When 3D rendering is disabled,the max_number_of_monitors and max_resolution_of_any_one_monitor' settings determine the amount of vRAM assignedto machines in this desktop pool. The greater these values are, the more memory will be consumed on the associated ESX hosts.This setting is only relevant on managed machines. Existing virtual machines must be powered off and subsequently poweredon for the change to take effect. A restart will not cause the changes to take effect. For Instant Clones,this value is inherited from snapshot of Master VM. This property has a default value of WUXGA.
This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.

UHD: 3840x2160 resolution.
UHD_5K: 5120x2880 resolution.
UHD_8K: 7680x4320 resolution.
WQXGA: 2560x1600 resolution.
WSXGA_PLUS: 1680x1050 resolution.
WUXGA: 1920x1200 resolution.

Possible values are : UHD, UHD_5K, UHD_8K, WQXGA, WSXGA_PLUS, WUXGA,

string

renderer3d

Optional

3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version8 or later. The default_display_protocol must set to PCOIP or BLAST and allow_users_to_choose_protocol must be set to false to enable 3D rendering protocol to enable 3D rendering. For instant clone source desktop pool 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT.

AUTOMATIC: 3D rendering is automatic.
DISABLED: 3D rendering is disabled.
HARDWARE: 3D rendering is hardware dependent. The hardware-based renderer is supported (at minimum) on virtual hardware version 9 in a vSphere 5.1 environment.
MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client.
SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment.

Possible values are : AUTOMATIC, DISABLED, HARDWARE, MANAGE_BY_VSPHERE_CLIENT, SOFTWARE,

boolean

session_collaboration_enabled

Optional

Applicable To: Automated and Manual pools.
Enable session collaboration feature. Session collaborationallows a user to share their remote session with other users.BLAST must be configured as a supported protocol in supported_display_protocols.

integer As int32 As int32

vram_size_mb

Optional

vRAM size for Horizon managed 3D rendering. More VRAM can improve 3D performance. Size is in MB. On ESXi 5.0 hosts, the renderer allows a maximum VRAM size of 128MB. On ESXi 5.1 and later hosts, the maximum VRAM size is 512MB. For Instant Clones, this value is inherited from snapshot of Master VM.This property is applicable when 3D renderer is not disabled. This property is required if renderer3d is set to AUTOMATIC, SOFTWARE, or HARDWARE.

Property Of

DesktopPoolUpdateSpec

DesktopPoolUpdateSpecV2