To modify a global desktop entitlement, use the lmvutil command with the --updateGlobalEntitlement option. To modify a global application entitlement, use the lmvutil command with the --updateGlobalApplicationEntitlement option.

Syntax

lmvutil --updateGlobalEntitlement --entitlementName name [--description text] 
[--disabled] [--enabled] [--fromHome] [--disableFromHome] [--multipleSessionAutoClean] 
[--disableMultipleSessionAutoClean] [--multipleSessionsPerUser] 
[--disableMultipleSessionsPerUser] [--requireHomeSite] [--disableRequireHomeSite] 
[--defaultProtocol value] [--scope scope] [--htmlAccess] [--disableHtmlAccess] 
[--tags tags] [--notags] [--categoryFolder foldername] [--disableCategoryFolder]
[--clientRestrictions] [--disableClientRestrictions]
lmvutil --updateGlobalApplicationEntitlement --entitlementName name [--description text] 
[--disabled] [--enabled] [--fromHome] [--disableFromHome] [--multipleSessionAutoClean] 
[--disableMultipleSessionAutoClean] [--requireHomeSite] [--disableRequireHomeSite] 
[--defaultProtocol value] [--scope scope] [--htmlAccess] [--disableHtmlAccess] 
[--appVersion value] [--appPublisher value] [--appPath value] [--tags tags] [--notags] 
[--preLaunch] [--disablePreLaunch] [--categoryFolder foldername] [--disableCategoryFolder]
[--clientRestrictions] [--disableClientRestrictions]

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 among all pods in the pod federation.

These commands return an error message if the global entitlement does not exist, the scope is invalid, the Cloud Pod Architecture feature is not initialized, or the commands cannot update the global entitlement.

Options

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

Table 1. Options for Modifying Global Entitlements

Option

Description

--entitlementName

Name of the global entitlement to modify.

--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.

--description

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

--disabled

(Optional) Disables a previously enabled global entitlement.

--enabled

(Optional) Enables a previously disabled global entitlement.

--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.

--disableFromHome

(Optional) Disables the --fromHome function for the global entitlement.

--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.

--disableMultipleSessionAutoClean

(Optional) Disables the --multipleSessionAutoClean function for the global entitlement.

--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.

--disableMultipleSessionsPerUser

(Optional) Disables the multiple sessions per user policy for the global desktop entitlement.

--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.

--disableRequireHomeSite

(Optional) Disables the --requireHomeSite function for the global entitlement.

--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.

--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.

--disableHtmlAccess

(Optional) Disables the HTML Access policy for the global entitlement.

--appVersion

(Optional) Version of the application.

Applies only to global application entitlements.

--appPublisher

(Optional) Publisher of the application.

Applies only to global application entitlements.

--appPath

(Optional) Full pathname of the application, for example, C:\Program Files\app1.exe.

Applies only to global application entitlements.

--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.

--notags

(Optional) Removes tags from the global entitlement.

--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.

--disablePreLaunch

(Optional) Disables the pre-launch policy for the global application entitlement.

--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.

--disableCategoryFolder

(Optional) Removes the category folder for the global entitlement.

--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.

--disableClientRestrictions

(Optional) Disables the client restrictions policy for the global entitlement.

Examples

lmvutil --authAs adminEast --authDomain domainEast --authPassword "*" --updateGlobalEntitlement --entitlementName "Windows 8 Desktop" --scope ANY --isDedicated
lmvutil --authAs adminEast --authDomain domainEast --authPassword "*" 
--updateGlobalApplicationEntitlement --entitlementName "Microsoft Office PowerPoint" --scope ANY