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 [--aliasName name | --disableAliasName]
[--description text] [--disabled] [--enabled] [--fromHome] [--disableFromHome]
[--multipleSessionAutoClean] [--disableMultipleSessionAutoClean] [--multipleSessionsPerUser]
[--disableMultipleSessionsPerUser] [--requireHomeSite] [--disableRequireHomeSite]
[--defaultProtocol value] [--scope scope] [--tags tags] [--notags] [--categoryFolder foldername]
[--disableCategoryFolder] [--clientRestrictions] [--disableClientRestrictions] [--collaboration]
[--disableCollaboration] [--shortcutLocations {desktop | launcher | desktop,launcher}]
[--backupEntitlementName name] [--disableBackupEntitlement] [--displayAssignedHostName]
[--disableDisplayAssignedHostName]
lmvutil --updateGlobalApplicationEntitlement --entitlementName name [--aliasName name | --disableAliasName]
[--description text] [--disabled] [--enabled] [--fromHome] [--disableFromHome] [--multipleSessionAutoClean]
[--disableMultipleSessionAutoClean] [--requireHomeSite] [--disableRequireHomeSite] [--defaultProtocol value] [--scope scope]
[--appVersion value] [--appPublisher value] [--appPath value] [--tags tags] [--notags] [--preLaunch] [--disablePreLaunch]
[--categoryFolder foldername] [--disableCategoryFolder] [--clientRestrictions] [--disableClientRestrictions]
[--shortcutLocations {desktop | launcher | desktop,launcher}] [--multiSessionMode value] [--backupEntitlementName name]
[--disableBackupEntitlement]
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.
| Option | Description |
|---|---|
| --entitlementName | Unique name of the global entitlement to modify. |
| --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:
|
| --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. |
| --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 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. |
| --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. |
| --collaboration | (Optional) Enables 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. |
| --disableCollaboration | (Optional) Disables the Session Collaboration policy for the global desktop entitlement. |
| --shortcutLocations | (Optional) Use this option to modify or create a shortcut on the client device. Valid values are desktop, which creates the shortcut on the 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 desktop and Windows Start menu shortcuts. If you are modifying a shortcut (that is, the category folder has already been created), you do not need to specify the --categoryFolder option, unless you also want to change the category folder name. If the category folder has not yet been created, you must specify the --categoryFolder option together with the --shortcutLocations option.
Note: Do not use this option with the
--disableCategoryFolder option.
|
| --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 Enabling Multi-Session Mode for Global Application Entitlements. |
| --backupEntitlementName | (Optional) Specifies the name of a backup global entitlement. A backup global entitlement delivers remote desktops or published applications when the primary global entitlement cannot start a session. For global desktop entitlements, the user assignment type must be Floating. For more information, see Implementing Backup Global Entitlements. |
| --disableBackupEntitlement | (Optional) Disables the backup global entitlement. |
| --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. |
| --disableDisplayAssignedHostName | (Optional) Specifies that the assigned machine host name does not appear in Horizon Client. Applies only to dedicated desktop entitlements. |
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
