GlobalDesktopEntitlementUpdateSpecV2

GlobalDesktopEntitlementUpdateSpecV2
GlobalDesktopEntitlementUpdateSpecV2

Global Desktop Entitlement object to be updated.

JSON Example 
{
    "allow_multiple_sessions_per_user": true,
    "backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "category_folder_name": "dir1\\dir2\\dir3\\dir4",
    "cloud_managed": false,
    "cs_restriction_tags": [
        "Internal",
        "External"
    ],
    "default_display_protocol": "PCOIP",
    "description": "global desktop entitlement description",
    "display_assigned_machine_name": false,
    "display_machine_alias": false,
    "display_name": "global-desktop-entitlement",
    "enable_client_restrictions": false,
    "enabled": true,
    "federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
    "multiple_session_auto_clean": false,
    "name": "global-desktop-entitlement",
    "require_home_site": false,
    "scope": "ALL_SITES",
    "session_collaboration_enabled": false,
    "session_distribution_policy": "NONE",
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "use_home_site": false
}
boolean
allow_multiple_sessions_per_user
Required

Indicates whether users can have multiple sessions when accessed from different client devices, this is also called Class room mode and applicable only to floating user assignment. If value is set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to have multiple sessions.

string
backup_gde_id
Optional

Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement.

string As ^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\].*|PRN[\\].*|AUX[\\].*|NUL[\\].*|COM[1-9][\\].*|LPT[1-9][\\].*)$)(?!(?:.*[\\]CON|.*[\\]PRN|.*[\\]AUX|.*[\\]NUL|.*[\\]COM[1-9]|.*[\\]LPT[1-9])$)(?!(?:.*[\\]CON[\\].*|.*[\\]PRN[\\].*|.*[\\]AUX[\\].*|.*[\\]NUL[\\].*|.*[\\]COM[1-9][\\].*|.*[\\]LPT[1-9][\\].*)$))([^\"#$%&'()*+,.\\\/:;<=>?@^`{|}~]{1,64}\\){0,3}([^\"#$%&'()*+,.\\\/:;<=>?@^`{|}~]{1,64})$|^/$
category_folder_name
Optional

Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.

boolean
cloud_managed
Required

Indicates whether this global desktop entitlement is managed from cloud.

array of string
cs_restriction_tags
Optional

Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.

string
default_display_protocol
Required

The default display protocol for the Global Desktop Entitlement. Clients connecting through this Global Desktop Entitlement that do not specify a protocol will use this value, not the value specified directly on the desktop pool to which they connect (if different).

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

Description of Global Desktop Entitlement.

boolean
display_assigned_machine_name
Required

Indicates whether users should see the hostname of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only. If no machine is assigned to the user then "display_name (No machine assigned)" will be displayed in the client.

boolean
display_machine_alias
Required

Indicates whether users should see the alias of the machine assigned to them instead of display_name when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only.

string
display_name
Required

Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Desktop Entitlement display name value will be same as name.

boolean
enable_client_restrictions
Required

Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.

boolean
enabled
Required

Indicates if this Global Desktop Entitlement is enabled.

string
federated_access_group_id
Required

ID of the federated access group with which the global desktop entitlement is to be associated. They can also be used for delegated administration.

boolean
multiple_session_auto_clean
Required

Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Desktop Entitlement is associated with a Desktop pool that has dedicated user assignment.

string
name
Required

Unique name used to identify the Global Desktop Entitlement.

boolean
require_home_site
Required

Indicates whether it should fail if a home site isn't defined for this Global Desktop Entitlement.

string
scope
Required

Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value.

  • ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
  • WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
  • WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.
Possible values are : ALL_SITES, WITHIN_POD, WITHIN_SITE,
boolean
session_collaboration_enabled
Required

Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration.

string
session_distribution_policy
Required

Session distribution policy to be used for this global desktop entitlement

  • LOAD: Load index based load distribution.
  • NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
  • SESSION: Session count based load distribution.
Possible values are : LOAD, NONE, SESSION,
array of string
shortcut_locations_v2
Optional

Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category_folder_name is provided.

Possible values are : START_MENU, DESKTOP,
boolean
use_home_site
Required

Indicates whether a pod in the user's home site is used to start the search or the current site is used.

Parameter To