To create a global desktop entitlement, use the lmvutil command with the --createGlobalEntitlement option. To create a global application entitlement, use the lmvutil command with the --createGlobalApplicationEntitlement option.

Global entitlements provide the link between users and their desktops and applications, regardless of where those desktops and applications reside in the pod federation. Global entitlements also include policies that determine how the Cloud Pod Architecture feature allocates desktops and applications to entitled users.

Syntax

lmvutil --createGlobalEntitlement --entitlementName name [--aliasName name | --disableAliasName]  
--scope scope {--isDedicated | --isFloating} [--description text] [--disabled] 
[--fromHome] [--multipleSessionAutoClean] [--requireHomeSite] [--defaultProtocol value] 
[--preventProtocolOverride] [--allowReset] [--multipleSessionsPerUser] [--tags tags] 
[--categoryFolder foldername] [--clientRestrictions] [--collaboration]
[--shortcutLocations {desktop | launcher | desktop,launcher}] [--displayAssignedHostName] [--displayMachineAlias]
[--federationAccessGroup name] [--sessionDistributionPolicy {LOAD | SESSION | NONE}]
lmvutil --createGlobalApplicationEntitlement --entitlementName name [--aliasName name | --disableAliasName]
--scope scope [--description text] [--disabled] [--fromHome] [--multipleSessionAutoClean] 
[--requireHomeSite] [--defaultProtocol value] [--preventProtocolOverride] [--preLaunch] [--tags tags] 
[--categoryFolder foldername] [--clientRestrictions] [--shortcutLocations {desktop | launcher | desktop,launcher}] 
[--multiSessionMode value] [--federationAccessGroup name] [--sessionDistributionPolicy {LOAD | SESSION | NONE}]

Usage Notes

You can use these commands on any Connection Server instance in a pod federation. The Cloud Pod Architecture feature stores new data in the Global Data Layer and replicates that data in all pods in the pod federation.

These commands return an error message if the global entitlement already exists, the scope is invalid, the Cloud Pod Architecture feature is not initialized, or the commands cannot create the global entitlement.

Options

You can specify these options when you create a global entitlement. Some options apply only to global desktop entitlements.

Table 1. Options for Creating Global Entitlements
Option Description
--entitlementName

Unique name that identifies the global entitlement in Horizon Console. The name can contain between 1 and 64 characters.

--aliasName

(Optional) Display name of the global entitlement. The display name appears to users in the list of available desktops and applications in Horizon Client. The display name does not need to be unique. Multiple global entitlements can have the same display name. If you do not specify a display name, the unique name appears to users in Horizon Client. The display name can contain between 1 and 64 characters.
--disableAliasName

(Optional) Sets the display name of the global entitlement (--aliasName option) to the default value. The unique name of the global entitlement (--entitlementName option) appears to users in Horizon Client by default. You can specify either --aliasName or --disableAliasName, but not both.
--scope
Scope of the global entitlement. Valid values are as follows:
  • ANY. Horizon 8 looks for resources on any pod in the pod federation.
  • SITE. Horizon 8 looks for resources only on pods in the same site as the pod to which the user is connected.
  • LOCAL. Horizon 8 looks for resources only in the pod to which the user is connected.
--isDedicated

Creates a dedicated desktop entitlement. A dedicated desktop entitlement can contain only dedicated desktop pools. To create a floating desktop entitlement, use the --isFloating option. A global desktop entitlement can be either dedicated or floating. You cannot specify the --isDedicated option with the --multipleSessionAutoClean option.

Applies only to global desktop entitlements.

--isFloating

Creates a floating desktop entitlement. A floating desktop entitlement can contain only floating desktop pools. To create a dedicated desktop entitlement, specify the --isDedicated option. A global desktop entitlement can be either floating or dedicated.

Applies only to global desktop entitlements.

--disabled (Optional) Creates the global entitlement in the disabled state.
--description

(Optional) Description of the global entitlement. The description can contain between 1 and 1024 characters.

--fromHome

(Optional) If the user has a home site, causes Horizon 8 to begin searching for resources on the user's home site. If the user does not have a home site, Horizon 8 begins searching for resources on the site to which the user is currently connected.

--multipleSessionAutoClean

(Optional) Logs off extra user sessions for the same entitlement. Multiple sessions can occur when a pod that contains a session goes offline, the user logs in again and starts another session, and the problem pod comes back online with the original session.

When multiple sessions occur, Horizon Client prompts the user to select a session. This option determines what happens to sessions that the user does not select.

If you do not specify this option, users must manually end their own extra sessions, either by logging off in Horizon Client or by launching the sessions and logging them off.

--requireHomeSite

(Optional) Causes the global entitlement to be available only if the user has a home site. This option is applicable only when the --fromHome option is also specified.

--defaultProtocol

(Optional) Specifies the default display protocol for desktops or applications in the global entitlement. Valid values are RDP, PCOIP, and BLAST for global desktop entitlements and PCOIP and BLAST for global application entitlements.

--preventProtocolOverride

(Optional) Prevents users from overriding the default display protocol.

--allowReset

(Optional) Allows users to reset desktops. Applies only to global desktop entitlements.

--multipleSessionsPerUser

(Optional) Activates the multiple sessions per user policy, which allows users to initiate separate desktop sessions from different client devices. Users that connect to the global desktop entitlement from different client devices receive different desktop sessions. To reconnect to an existing desktop session, users must use the same device from which that session was initiated. If you do not activate this policy, users are always reconnected to their existing desktop sessions, regardless of the client device that they use. Applies only to floating desktop entitlements.

--preLaunch

(Optional) Activates the pre-launch policy, which launches the application session before a user opens the global application entitlement in Horizon Client. When you activate the pre-launch policy, users can launch the global application entitlement more quickly. All the application pools in the global application entitlement must support the session pre-launch feature, and the pre-launch session timeout must be the same for all farms.

--tags

(Optional) Specifies one or more tags that restrict access to the global entitlement from Connection Server instances. To specify multiple tags, type a quoted list of tag names separated by a comma or semicolon. For more information, see How to Specify Connection Server Restrictions for Global Entitlements in Horizon 8.

--categoryFolder

(Optional) Specifies the name of the category folder that contains a shortcut for the global entitlement on client devices. You can configure up to four folder levels. A folder name can be up to 64 characters long. To specify a subfolder, enter a backslash (\) character, for example, dir1\dir2\dir3\dir4. You can enter up to four folder levels. You cannot begin or end a folder name with a backslash, and you cannot combine two or more backslashes. For example, \dir1, dir1\dir2\, dir1\\dir2, and dir1\\\dir2 are invalid. You cannot enter Windows reserved keywords. You must also specify the --shortcutLocations option to indicate the location of the shortcut on a Windows client device. For more information, see Configuring Shortcuts for Global Entitlements in Horizon 8.

--clientRestrictions

(Optional) Activates the client restrictions policy, which restricts access to the global entitlement to specific client computers. For more information, see Implementing Client Restrictions for Global Entitlements in Horizon 8.

--collaboration

(Optional) Activates the Session Collaboration policy, which allows users of remote desktop sessions to invite other users to join their sessions. All the desktop pools in the global desktop entitlement must support the Session Collaboration feature. Applies only to global desktop entitlements.

--shortcutLocations

(Optional) Use this option with the --categoryFolder option to specify the location of the shortcut on the client device. Valid values are desktop, which creates the shortcut on the Windows desktop, and launcher, which creates the shortcut in the Windows Start menu. You can also specify both desktop and launcher, separated by a comma, to create both Windows desktop and Windows Start menu shortcuts.

--multiSessionMode

(Optional) Configures the multi-session mode feature for the global application entitlement. Specify one of the following values: DISABLED, ENABLED_DEFAULT_OFF, ENABLED_DEFAULT_ON, or ENABLED_ENFORCED. For more information, see Activating Multi-Session Mode for Global Application Entitlements in Horizon 8.

--displayAssignedHostName (Optional) In Horizon Client, displays the host name of the machine assigned to the user instead of the global entitlement name. Applies only to dedicated desktop entitlements.
--displayMachineAlias (Optional) In Horizon Client, displays the alias name of the machine assigned to the user instead of the global entitlement name. Applies only to dedicated desktop entitlements.
--federationAccessGroup (Optional) Specifies the federation access group that is used to organize global entitlements for delegated administration. For more information, see Setting Up Federation Access Groups.
--sessionDistributionPolicy (Optional) Select from:
  • LOAD - Distributes new sessions evenly across available resources within the global application entitlement or global desktop entitlement based on their current load, with sessions being directed to the least loaded resources.
  • SESSION - Distributes new sessions evenly across available resources within the global application entitlement or global desktop entitlement based on their current utilization. The farm or host's max-session-count is used to calculate the capacity utilization. Pods with high session capacity receive more session requests.
  • NONE (default) - Distributes new sessions randomly across the available resources.

Examples

lmvutil --authAs adminEast --authDomain domainEast --authPassword "*" --createGlobalEntitlement --entitlementName "Windows 8 Desktop" --scope LOCAL --isDedicated
lmvutil --authAs adminEast --authDomain domainEast --authPassword "*" --createGlobalApplicationEntitlement --entitlementName "Microsoft Office PowerPoint" --scope LOCAL