/// <summary>
/// Initializes a new instance of the <see cref="FarmDisplayProtocolSettings" /> class.
/// </summary>
/// <param name="allowDisplayProtocolOverride">Indicates whether the display protocol settings could be overridden.If set to false, then default_display_protocol is used.Default value is true. (required).</param>
/// <param name="defaultDisplayProtocol">The default server display protocol. Default value is PCOIP. * RDP: Microsoft Remote Desktop Protocol. * PCOIP: PCoIP protocol. * BLAST: BLAST protocol. (required).</param>
/// <param name="gridVgpusEnabled">If this is true, the host or cluster associated with the farm must support NVIDIA GRID andvGPU types required by the RDSH desktop virtualMachines, VmTemplate, or BaseImageSnapshot.If this is false, RDSH instant clone farm must not support NVIDIA GRID vGPUs.Default value is false..</param>
/// <param name="htmlAccessEnabled">This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by VMware Blast technology, allows users to connect to Horizon machines from Web browsers. Horizon Client software does not have to be installed on the client devices. To enable HTML Access, you must install the HTML Machine Access feature pack. (required).</param>
/// <param name="sessionCollaborationEnabled">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.Default value is false. (required).</param>
/// <param name="vgpuGridProfile">NVIDIA GRID vGPUs might have multiple profiles and any one of the available profiles can beapplied to newly created instant clone RDSH server. The profile specified in this field will beused in the newly created instant clone RDSH server. Will be set if enable_grid_vgpus set to true..</param>
public FarmDisplayProtocolSettings(bool?allowDisplayProtocolOverride = default(bool?), DefaultDisplayProtocolEnum defaultDisplayProtocol = default(DefaultDisplayProtocolEnum), bool?gridVgpusEnabled = default(bool?), bool?htmlAccessEnabled = default(bool?), bool?sessionCollaborationEnabled = default(bool?), string vgpuGridProfile = default(string))
{
// to ensure "allowDisplayProtocolOverride" is required (not null)
if (allowDisplayProtocolOverride == null)
{
throw new InvalidDataException("allowDisplayProtocolOverride is a required property for FarmDisplayProtocolSettings and cannot be null");
}
else
{
this.AllowDisplayProtocolOverride = allowDisplayProtocolOverride;
}
// to ensure "defaultDisplayProtocol" is required (not null)
if (defaultDisplayProtocol == null)
{
throw new InvalidDataException("defaultDisplayProtocol is a required property for FarmDisplayProtocolSettings and cannot be null");
}
else
{
this.DefaultDisplayProtocol = defaultDisplayProtocol;
}
// to ensure "htmlAccessEnabled" is required (not null)
if (htmlAccessEnabled == null)
{
throw new InvalidDataException("htmlAccessEnabled is a required property for FarmDisplayProtocolSettings and cannot be null");
}
else
{
this.HtmlAccessEnabled = htmlAccessEnabled;
}
// to ensure "sessionCollaborationEnabled" is required (not null)
if (sessionCollaborationEnabled == null)
{
throw new InvalidDataException("sessionCollaborationEnabled is a required property for FarmDisplayProtocolSettings and cannot be null");
}
else
{
this.SessionCollaborationEnabled = sessionCollaborationEnabled;
}
this.GridVgpusEnabled = gridVgpusEnabled;
this.VgpuGridProfile = vgpuGridProfile;
}
/// <summary>
/// Initializes a new instance of the <see cref="DesktopPoolDisplayProtocolSettings" /> class.
/// </summary>
/// <param name="allowUsersToChooseProtocol">Indicates whether the users can choose the protocol. Default value is true. (required).</param>
/// <param name="defaultDisplayProtocol">The default display protocol for the desktop pool. For a managed desktop pool, this will default to PCOIP.For an unmanaged desktop pool, this will default to RDP. * RDP: Microsoft Remote Desktop Protocol. * PCOIP: PCoIP protocol. * BLAST: BLAST protocol. (required).</param>
/// <param name="displayProtocols">List of supported display protocols for this desktop pool.Default value is [PCOIP, RDP, BLAST]. (required).</param>
/// <param name="gridVgpusEnabled">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, orBaseImageSnapshot must not support NVIDIA GRID vGPUs. Since suspending VMs with passthroughdevices such as vGPUs is not possible, power_policy cannot be set to SUSPEND if this is enabled.Default value is false..</param>
/// <param name="htmlAccessEnabled">This property is no longer in use for Horizon Components. It is always set to true. HTML Access, enabled by VMware Blast technology, allows users to connect to machines from Web browsers. Horizon Client software does not have to be installed on the client devices. To enable HTML Access, you must install the HTML Machine Access feature pack. Also, Blast must be configured as a supported protocol in displayProtocols. (required).</param>
/// <param name="maxNumberOfMonitors">When 3D 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. 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 View, the maximum number of monitors must be 1 or 2. For Instant Clones, this value is inherited from snapshot of Master VM..</param>
/// <param name="maxResolutionOfAnyOneMonitor">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 assignedto 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 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. * WSXGA_PLUS: 1680x1050 resolution. * WUXGA: 1920x1200 resolution. * WQXGA: 2560x1600 resolution. * UHD: 3840x2160 resolution..</param>
/// <param name="renderer3d">3D rendering is supported on Windows 7 or later guests running on VMs with virtual hardware version8 or later. The default protocol must be PCoIP and users must not be allowed to choose their ownprotocol to enable 3D rendering. For instant clone source desktop 3D rendering always mapped to MANAGE_BY_VSPHERE_CLIENT.Default value is DISABLED. * MANAGE_BY_VSPHERE_CLIENT: 3D rendering managed by vSphere Client. * AUTOMATIC: 3D rendering is automatic. * SOFTWARE: 3D rendering is software dependent. The software renderer is supported (at minimum) on virtual hardware version 8 in a vSphere 5.0 environment. * 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. * DISABLED: 3D rendering is disabled. (required).</param>
/// <param name="sessionCollaborationEnabled">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.Default value is false. (required).</param>
/// <param name="vgpuGridProfile">NVIDIA GRID vGPUs might have multiple profiles and any one of the available profiles can beapplied to newly created instant clone desktop. The profile specified in this field will beused in the newly created instant clone desktop. Will be set if enable_grid_vgpus set to true..</param>
/// <param name="vramSizeMb">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.1and 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 has a default value of 96. (required).</param>
public DesktopPoolDisplayProtocolSettings(bool?allowUsersToChooseProtocol = default(bool?), DefaultDisplayProtocolEnum defaultDisplayProtocol = default(DefaultDisplayProtocolEnum), List <DisplayProtocolsEnum> displayProtocols = default(List <DisplayProtocolsEnum>), bool?gridVgpusEnabled = default(bool?), bool?htmlAccessEnabled = default(bool?), int?maxNumberOfMonitors = default(int?), MaxResolutionOfAnyOneMonitorEnum?maxResolutionOfAnyOneMonitor = default(MaxResolutionOfAnyOneMonitorEnum?), Renderer3dEnum renderer3d = default(Renderer3dEnum), bool?sessionCollaborationEnabled = default(bool?), string vgpuGridProfile = default(string), int?vramSizeMb = default(int?))
{
// to ensure "allowUsersToChooseProtocol" is required (not null)
if (allowUsersToChooseProtocol == null)
{
throw new InvalidDataException("allowUsersToChooseProtocol is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.AllowUsersToChooseProtocol = allowUsersToChooseProtocol;
}
// to ensure "defaultDisplayProtocol" is required (not null)
if (defaultDisplayProtocol == null)
{
throw new InvalidDataException("defaultDisplayProtocol is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.DefaultDisplayProtocol = defaultDisplayProtocol;
}
// to ensure "displayProtocols" is required (not null)
if (displayProtocols == null)
{
throw new InvalidDataException("displayProtocols is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.DisplayProtocols = displayProtocols;
}
// to ensure "htmlAccessEnabled" is required (not null)
if (htmlAccessEnabled == null)
{
throw new InvalidDataException("htmlAccessEnabled is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.HtmlAccessEnabled = htmlAccessEnabled;
}
// to ensure "renderer3d" is required (not null)
if (renderer3d == null)
{
throw new InvalidDataException("renderer3d is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.Renderer3d = renderer3d;
}
// to ensure "sessionCollaborationEnabled" is required (not null)
if (sessionCollaborationEnabled == null)
{
throw new InvalidDataException("sessionCollaborationEnabled is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.SessionCollaborationEnabled = sessionCollaborationEnabled;
}
// to ensure "vramSizeMb" is required (not null)
if (vramSizeMb == null)
{
throw new InvalidDataException("vramSizeMb is a required property for DesktopPoolDisplayProtocolSettings and cannot be null");
}
else
{
this.VramSizeMb = vramSizeMb;
}
this.GridVgpusEnabled = gridVgpusEnabled;
this.MaxNumberOfMonitors = maxNumberOfMonitors;
this.MaxResolutionOfAnyOneMonitor = maxResolutionOfAnyOneMonitor;
this.VgpuGridProfile = vgpuGridProfile;
}
