FarmDisplayProtocolSettingsInfo

FarmDisplayProtocolSettingsInfo
FarmDisplayProtocolSettingsInfo

Display protocol settings for the farm.

JSON Example 
{
    "allow_users_to_choose_protocol": true,
    "default_display_protocol": "PCOIP",
    "grid_vgpus_enabled": false,
    "session_collaboration_enabled": false,
    "vgpu_grid_profile": "instant-profile"
}
boolean
allow_users_to_choose_protocol
Optional

Indicates whether the users can choose the protocol.

string
default_display_protocol
Optional

Indicates default server display protocol, when user is not allowed to choose protocol.Farms support PCOIP, RDP and BLAST.

  • RDP: Microsoft Remote Desktop Protocol.
  • PCOIP: PCoIP protocol.
  • BLAST: BLAST protocol.
Possible values are : RDP, PCOIP, BLAST,
boolean
grid_vgpus_enabled
Optional

Indicates whether RDSH instant clone farm must not support NVIDIA GRID vGPUs. If this is true, the host or cluster associated with the farm must support NVIDIA GRID and vGPU types required by the RDSH desktop pool virtualMachines, VmTemplate, or BaseImageSnapshot. If this is false, RDSH instant clone farm must not support NVIDIA GRID vGPUs.

boolean
session_collaboration_enabled
Optional

Indicates whether session collaboration feature is enabled. Session collaboration allows a user to share their remote session with other users.

string
vgpu_grid_profile
Optional

NVIDIA GRID vGPUs have multiple profiles and any one of the available profiles can be applied to newly created instant clone RDSH desktop pool. The profile specified in this field will be used in the newly created instant clone RDSH server. This is set when grid_vgpus_enabled is true.

Property Of