View API


Data Object - GlobalApplicationEntitlementBase

Class
VMware.Hv.GlobalApplicationEntitlementBase
Property of
GlobalApplicationEntitlementInfo
Parameter to
GlobalApplicationEntitlement_Create
Since
Horizon View 6.2

Data Object Description

Parameters to create a Global Application Entitlement.

Data Object Properties

Properties

Name Type Description
displayNamexsd:string

Display Name of Global Application Entitlement.
  • This property has a maximum length of 64 characters.
descriptionxsd:string

Description of Global Application Entitlement.
  • This property need not be set.
  • This property has a maximum length of 1024 characters.
scopexsd:string

Scope for this global application entitlement. Visibility and Placement policies are defined by this value.
  • This property has a default value of "ANY".
  • This property need not be set.
  • This property will be one of:
    Value Description
    "LOCAL"Local 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.
    "SITE"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.
    "ANY"Any 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.
fromHomexsd:boolean

This value defines the starting location for resource placement and search. When true, a pod in the user's home site is used to start the search. When false, the current site is used.
requireHomeSitexsd:boolean

This value determines whether we fail if a home site isn't defined for this Global Application Entitlement.
multipleSessionAutoCleanxsd:boolean

This value is used to determine if automatic session clean up is enabled.
enabledxsd:boolean

If this Global Application Entitlement is enabled.
supportedDisplayProtocolsxsd:string[]

The set of supported display protocols for the Global Application Entitlement. Farms support PCOIP, RDP and BLAST. This setting must be a subset of the farm settings. Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.
  • This property has a default value of ["PCOIP", "BLAST"].
  • This property is an unordered array of unique values.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "PCOIP"PC over IP.
    "BLAST"BLAST.
defaultDisplayProtocolxsd:string

The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list.
  • This property has a default value of "PCOIP".
  • This property will be one of:
    Value Description
    "PCOIP"PC over IP.
    "BLAST"BLAST.
allowUsersToChooseProtocolxsd:boolean

Whether the users can choose the protocol to be used. If this Application's Farm's allowDisplayProtocolOverride is set to false, then defaultDisplayProtocol must match that defaultDisplayProtocol.
  • This property has a default value of true.
  • This property cannot be updated.
enableHTMLAccessxsd:boolean

HTML Access, enabled by VMware Blast technology, allows users to connect to View machines from Web browsers. View Client software does not have to be installed on the client devices. To enable HTML Access, you must install the HTML Machine Access feature pack. If set to true, the farms of applications that are associated with this Global Application Entitlement must also have HTML Access enabled with enableHTMLAccess Also, Blast must be configured as a supported protocol in supportedDisplayProtocols.
  • This property has a default value of false.
connectionServerRestrictionsxsd:string[]

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.

Since Horizon 7.1
  • This property need not be set.
enablePreLaunchxsd:boolean

This global application entitlement can be pre-launched if value is true.

Since Horizon 7.2
  • This property has a default value of false.
  • This property need not be set.
categoryFolderNamexsd:string

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.

Since Horizon 7.3
  • This property need not be set.
  • This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels. The subdirectories can be specified using a backslash, e.g. (dir1\dir2\dir3\dir4). Folder names can't start or end with a backslash nor can there be 2 or more backslashes together. Combinations such as (\dir1, dir1\dir2\, dir1\\dir2, dir1\\\dir2) are invalid. The windows reserved keywords (CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.
clientRestrictionsxsd:boolean

Client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools.

Since Horizon 7.3
  • This property has a default value of false.
  • This property need not be set.
shortcutLocationsxsd:string[]

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.

Since Horizon 7.5
  • This property need not be set.
multiSessionModexsd:string

Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. enablePreLaunch can be set to true only if multiSessionMode is disabled.

Since Horizon 7.7
  • This property has a default value of "DISABLED".
  • This property need not be set.
  • This property will be one of:
    Value Description
    "DISABLED"Multi-session is not supported for this entitlement.
    "ENABLED_DEFAULT_OFF"Multi-session is supported for this entitlement 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 session launch.
    "ENABLED_DEFAULT_ON"Multi-session mode is supported for this entitlement 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 session launch.
    "ENABLED_ENFORCED"Multi-session is supported for this entitlement and it is enforced. The client can not select to launch this entitlement in single-session mode.