GlobalDesktopEntitlementInfoV4

GlobalDesktopEntitlementInfoV4
GlobalDesktopEntitlementInfoV4

Information about Global Desktop Entitlement.

JSON Example
{
    "allow_multiple_sessions_per_user": true,
    "allow_users_to_choose_machines": false,
    "allow_users_to_choose_protocol": true,
    "allow_users_to_reset_machines": true,
    "backup_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "category_folder_name": "dir1\\dir2\\dir3\\dir4",
    "cloud_managed": false,
    "cs_restriction_tags": [
        "Internal",
        "External"
    ],
    "dedicated": true,
    "default_display_protocol": "string",
    "description": "global desktop entitlement description",
    "display_assigned_machine_name": false,
    "display_machine_alias": true,
    "display_name": "global-desktop-entitlement",
    "enable_client_restrictions": false,
    "enabled": true,
    "federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "group_count": 5,
    "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "local_desktop_pools_count": 2,
    "member_pods": [
        "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "9238c-102b-4ed3-953f-3d23esan0fe"
    ],
    "multiple_session_auto_clean": false,
    "name": "global-desktop-entitlement",
    "primary_gde_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "remote_desktop_pools_count": 10,
    "require_home_site": false,
    "scope": "ALL_SITES",
    "session_collaboration_enabled": false,
    "session_distribution_policy": "NONE",
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "supported_display_protocols": [
        "PCOIP",
        "BLAST",
        "RDP"
    ],
    "use_home_site": false,
    "user_count": 5,
    "user_or_group_site_override_count": 2
}
boolean
allow_multiple_sessions_per_user
Optional

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 with allowMultipleSessionsPerUser Supported Filters: 'Equals'. This property can be used for sorting.

boolean
allow_users_to_choose_machines
Optional

Indicates whether the users can specify the machine for session launch. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose machines with allow_users_to_choose_machines set to true. This property will not be set for dedicated user assignment.

boolean
allow_users_to_choose_protocol
Optional

Indicates whether the users can choose the protocol used. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.

boolean
allow_users_to_reset_machines
Optional

Indicates whether users are allowed to reset/restart their machines. If set to true, the desktop pools that are associated with this Global Desktop Entitlement must also allow users to reset/restart machines with allowUsersToResetMachines. Supported Filters: 'Equals'. This property can be used for sorting.

string
backup_gde_id
Optional

Indicates the Global Desktop Entitlement that can be used as backup for this Global Desktop Entitlement. Supported Filters: 'Equals'.

string
category_folder_name
Optional

Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.

boolean
cloud_managed
Optional

Indicates whether this global desktop entitlement is managed from cloud. Supported Filters: 'Equals'. This property can be used for sorting.

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.

boolean
dedicated
Optional

Indicates whether global desktop entitlement is dedicated. If so, only dedicated desktop pools can be associated with this Global Desktop Entitlement. Otherwise, only floating desktop pools, can be associated with it. Can only be set at time of creation. Supported Filters: 'Equals'. This property can be used for sorting.

string
default_display_protocol
Optional

The default display protocol for the Global Desktop Entitlement. Must be a protocol in the supportedDisplayProtocols list. 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). Supported Filters: 'Equals'. This property can be used for sorting.

  • 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. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

boolean
display_assigned_machine_name
Optional

Indicates whether users should see the hostname of the machine assigned to them instead of displayName 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. Supported Filters: 'Equals'. This property can be used for sorting.

boolean
display_machine_alias
Optional

Decides the visibility of the machine alias to the user. This property can be used for sorting.

string
display_name
Optional

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. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

boolean
enable_client_restrictions
Optional

Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.

boolean
enabled
Optional

Indicates if this Global Desktop Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.

string
federated_access_group_id
Optional

This represents id of the federated access group associated with the global desktop entitlement.

integer As int32 As int32
group_count
Optional

Count of groups that are associated with this Global Desktop Entitlement.

string
id
Optional

Unique ID representing this Global Desktop Entitlement. Supported Filters: 'Equals'.

integer As int32 As int32
local_desktop_pools_count
Optional

Count of desktop pools local to this pod that are associated with this Global Desktop Entitlement.

array of string
member_pods
Optional

Pods that have desktop pools associated with this Global Desktop Entitlement.

boolean
multiple_session_auto_clean
Optional

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. Supported Filters: 'Equals'. This property can be used for sorting.

string
name
Optional

Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string
primary_gde_id
Optional

Indicates the Global Desktop Entitlement for which this Global Desktop Entitlement acts as backup.

integer As int32 As int32
remote_desktop_pools_count
Optional

Count of desktop pools on remote pods that are associated with this Global Desktop Entitlement.

boolean
require_home_site
Optional

Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.

string
scope
Optional

Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.

  • 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
Optional

Session collaboration allows a user to share their remote session with other users. Blast must be configured as a supported protocol in supportedDisplayProtocols. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Supported Filters: 'Equals'. This property can be used for sorting.

string
session_distribution_policy
Optional

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.

Possible values are : START_MENU, DESKTOP,
array of string
supported_display_protocols
Optional

The set of supported display protocols for the Global Desktop Entitlement. All the desktop pools associated with this Global Desktop Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Desktop Entitlement that are allowed to select their protocol will see these display protocol options.

Possible values are : BLAST, PCOIP, RDP,
boolean
use_home_site
Optional

Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.

integer As int32 As int32
user_count
Optional

Count of users that are associated with this Global Desktop Entitlement.

integer As int32 As int32
user_or_group_site_override_count
Optional

Count of all User Home Site overrides associated with this Global Desktop Entitlement (for either users or groups).