Create Global Desktop Entitlement V2

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 associated federated access group to manage the global desktop entitlement.

Request

URI

POST

https://{api_host}/rest/inventory/v2/global-desktop-entitlements

COPY

Request Body

GlobalDesktopEntitlementCreateSpecV2 of type(s) application/json

Required

{
    "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,
    "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,
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "use_home_site": false
}

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. Default value is false.

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. Default value is true.

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. Default value is false.

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. Unset if the entitlement does not belong to a category.

boolean

cloud_managed

Optional

Indicates whether this global desktop entitlement is managed from cloud. Default value is false.

array of string

cs_restriction_tags

Optional

List of connection server restriction tags to which the access to the global desktop entitlement is restricted. Empty or null list means that 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. Default value is false.

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).This property has a default value of "PCOIP".

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

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. Default value is false.

boolean

display_machine_alias

Optional

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. Default value is false.

string

display_name

Optional

Name that users will see when they connect using Horizon Client. If display_name is left blank, it defaults to name.

boolean

enable_client_restrictions

Optional

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

boolean

enabled

Optional

Indicates if this Global Desktop Entitlement is enabled.Default value is true.

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

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. Default value is false.

string

name

Required

Unique name used to identify the Global Desktop Entitlement.

boolean

require_home_site

Optional

Indicates whether we fail if a home site isn't defined for this Global Desktop Entitlement. Default value is false.

string

scope

Required

Scope for this global desktop entitlement. Visibility and Placement policies are defined by this value. This property has a default value of "ALL_SITES".

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. Indicates if the desktop pools that are associated with this Global Desktop Entitlement must also have session collaboration enabled with enableCollaboration. Default value is false.

array of string

shortcut_locations_v2

Optional

Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.

Possible values are : START_MENU, DESKTOP,

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. Default value is false.

Authentication

This operation uses the following authentication methods.

Bearer