Create Global Desktop Entitlement
Note: CPA must be initialized for the pod for invoking this API. All the listed privileges are required -
| Privileges | Description |
|---|---|
| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, on the root federation access group to manage the global desktop entitlement. |
Global Desktop Entitlement object to be created.
{
"allow_multiple_sessions_per_user": true,
"allow_users_to_choose_protocol": true,
"allow_users_to_reset_machines": true,
"category_folder_name": "dir1\\dir2\\dir3\\dir4",
"cloud_managed": false,
"cs_restriction_tags": [
"Internal",
"External"
],
"dedicated": true,
"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,
"multiple_session_auto_clean": false,
"name": "global-desktop-entitlement",
"require_home_site": false,
"scope": "ALL_SITES",
"session_collaboration_enabled": false,
"shortcut_locations": [
"desktop"
],
"use_home_site": false
}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.
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.
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.
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.
Indicates whether this global desktop entitlement is managed from cloud.
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.
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.
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).This property has a default value of "PCOIP".
- RDP: Microsoft Remote Desktop Protocol.
- PCOIP: PCoIP protocol.
- BLAST: BLAST protocol.
Description of Global Desktop Entitlement. This property has a maximum length of 1024 characters.
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.
Indicates whether users should see the alias of the machine assigned to them instead of displayName when they connect using Horizon Client. This is applicable for dedicated Global Desktop Entitlements only.
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.
Indicates whether client restrictions to be applied to Global Desktop Entitlement. Currently it is valid for RDSH pools.
Indicates if this Global Desktop Entitlement is enabled.
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.
Unique name used to identify the Global Desktop Entitlement. This property has a maximum length of 64 characters.
Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement.
Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. This property has a default value of "ALL_SITES".
- 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.
- 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.
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.
Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if categoryFolderName is provided.
Indicates whether a pod in the user's home site is used to start the search or the current site is used.
Created
Bad Request
User is not authenticated
Access to the resource is forbidden
Conflict | CPA not initialized for the pod