GlobalApplicationEntitlementSummaryV2

GlobalApplicationEntitlementSummaryV2
GlobalApplicationEntitlementSummaryV2

Summary Information about Global Application Entitlement.
Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports.

JSON Example
{
    "allow_users_to_choose_protocol": true,
    "backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "category_folder_name": "dir1\\dir2\\dir3\\dir4",
    "cs_restriction_tags": [
        "Internal",
        "External"
    ],
    "default_display_protocol": "string",
    "description": "global application entitlement description",
    "display_name": "global-application-entitlement",
    "enable_client_restrictions": false,
    "enable_pre_launch": true,
    "enabled": true,
    "federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "multi_session_mode": "ENABLED_ENFORCED",
    "multiple_session_auto_clean": false,
    "name": "global-application-entitlement",
    "primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "require_home_site": false,
    "scope": "ALL_SITES",
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "supported_display_protocols": [
        "PCOIP",
        "BLAST"
    ],
    "use_home_site": false
}
boolean
allow_users_to_choose_protocol
Optional

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

string
backup_gae_id
Optional

Indicates the Global Application Entitlement that can be used as backup for this Global Application 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.

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
Optional

The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.

  • BLAST: BLAST protocol.
  • PCOIP: PCoIP protocol.
Possible values are : BLAST, PCOIP,
string
description
Optional

Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. 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 Application 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 Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.

boolean
enable_pre_launch
Optional

Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.

boolean
enabled
Optional

Indicates if this Global Application 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 application entitlement.
Supported Filters: 'Equals'.

string
id
Optional

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

string
multi_session_mode
Optional

Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled. Supported Filters: 'Equals'. This property can be used for sorting.

  • DISABLED: Multi-session is not supported for this application.
  • ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.
  • ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.
  • ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.
Possible values are : DISABLED, ENABLED_DEFAULT_OFF, ENABLED_DEFAULT_ON, ENABLED_ENFORCED,
boolean
multiple_session_auto_clean
Optional

Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application 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 Application 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_gae_id
Optional

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

boolean
require_home_site
Optional

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

string
scope
Optional

Scope for this global application 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,
array of string
shortcut_locations_v2
Optional

Locations of the category folder in the user's OS containing a shortcut to the application.

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

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

Possible values are : BLAST, PCOIP,
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.