DesktopPoolDisplayProtocolSettingsCreateSpec
Applicable To: Automated and Manual desktop pool.
Display protocol settings for Automated and Manual desktop pool.
{
"allow_users_to_choose_protocol": true,
"default_display_protocol": "PCOIP",
"grid_vgpus_enabled": false,
"max_number_of_monitors": 2,
"max_resolution_of_any_one_monitor": "WUXGA",
"renderer3d": "DISABLED",
"session_collaboration_enabled": false,
"vram_size_mb": 64
}Indicates whether the users can choose the protocol. Default value is true.
The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP and for unmanaged desktop pool, this will default to RDP.
- BLAST: BLAST protocol.
- PCOIP: PCoIP protocol.
- RDP: Microsoft Remote Desktop Protocol.
When 3D rendering is managed by the vSphere Client, this enables support for NVIDIA GRID vGPUs. This will be false if 3D rendering is not managed by the vSphere Client. If this is true, the host or cluster associated with the desktop pool must support NVIDIA GRID and vGPU types required by the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot. If this is false, the desktop pool's VirtualMachines, VmTemplate or BaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthrough devices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled. Default value is false.
When render3D is disabled, the max_number_of_monitors and max_resolution_of_any_one_monitor settings determine the amount of vRAM assigned to machines in this desktop. The greater these values are, the more memory will be consume on the associated ESX hosts. Existing virtual machines must be powered off and subsequently powered on for the change to take effect. A restart will not cause the changes to take effect. If 3D is enabled and managed by View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM. This property has a default value of 2.
This property is required if renderer3D is set to AUTOMATIC, SOFTWARE, HARDWARE or DISABLED.
If 3D rendering is enabled and managed by View, 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 assigned to machines in this desktop. 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 powered on 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.
3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version 8 or later. The default_display_protocol must set to PCOIP and allow_users_to_choose_protocol must be set to false to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT. Default value is DISABLED.
- 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.
Applicable To: Automated and Manual pools with default value of false.
Enable session collaboration feature. Session collaboration allows a user to share their remote session with other users. BLAST must be configured as a supported protocol in supported_display_protocols.
vRAM size for View 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 has a default value of 96.
This property is required if renderer3d is set to AUTOMATIC, SOFTWARE or HARDWARE.