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 --scope scope 
{--isDedicated | --isFloating} [--description text] [--disabled] 
[--fromHome] [--multipleSessionAutoClean] [--requireHomeSite] [--defaultProtocol value] 
[--preventProtocolOverride] [--allowReset] [--htmlAccess] [--multipleSessionsPerUser] 
[--tags tags] [--categoryFolder foldername] [--clientRestrictions]
lmvutil --createGlobalApplicationEntitlement --entitlementName name --scope scope 
[--description text] [--disabled] [--fromHome] [--multipleSessionAutoClean] 
[--requireHomeSite] [--defaultProtocol value] [--preventProtocolOverride] [--htmlAccess]
[--preLaunch] [--tags tags] [--categoryFolder foldername]
[--clientRestrictions]

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

Name of the global entitlement. The name can contain between 1 and 64 characters. The global entitlement name appears in the desktops and applications list in Horizon Client for entitled users.

--scope

Scope of the global entitlement. Valid values are as follows:

  • ANY. Horizon looks for resources on any pod in the pod federation.

  • SITE. Horizon looks for resources only on pods in the same site as the pod to which the user is connected.

  • LOCAL. Horizon 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 to begin searching for resources on the user's home site. If the user does not have a home site, Horizon 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.

--htmlAccess

(Optional) Enables the HTML Access policy, which allows users to use the HTML Access feature to access resources in the global entitlement. With HTML Access, end users can use a Web browser to access remote resources and are not required to install any client software on their local systems.

--multipleSessionsPerUser

(Optional) Enables 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 enable 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) Enables the pre-launch policy, which launches the application session before a user opens the global application entitlement in Horizon Client. When you enable 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 Implementing Connection Server Restrictions for Global Entitlements.

--categoryFolder

(Optional) Specifies the name of the category folder that contains a Start menu shortcut for the global entitlement on Windows client devices. For more information, see Configuring Windows Start Menu Shortcuts for Global Entitlements.

--clientRestrictions

(Optional) Enables 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.

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