You can use the lmvutil command with the --createGlobalEntitlement to create a global entitlement. A global entitlement links together users and desktops, regardless of where the desktops are located in the pod federation. Global entitlements also include policies that determine how the Cloud Pod Architecture feature allocates desktops to those users.

Syntax

lmvutil --createGlobalEntitlement -entitlementName name --scope scope 
{--isDedicated | --isFloating} [--description text] [--disabled] 
[--fromHome] [--multipleSessionAutoClean] [--requireHomeSite] [--defaultProtocol value]
[--preventProtocolOverride] [--allowReset]

Usage Notes

You can use this command on any View Connection Server instance in a pod federation. View stores new data in the Global Data Layer and replicates that data in all pods in the pod federation.

This command returns an error message if the global entitlement already exists, the scope is invalid, the Cloud Pod Architecture feature is not initialized, or the command cannot create the global entitlement.

Options

You can specify these options when you create a global entitlement.

Table 1. Options for Creating Global Entitlements

Option

Description

--entitlementName

Specifies the name of the global entitlement. The name can contain between 1 and 64 characters. The global entitlement name appears in the list of available entitlements for the user in Horizon Client.

--scope

Specifies the scope of the global entitlement. Valid values are as follows:

  • ANY - View looks for desktops on any pod in the pod federation.

  • SITE - View looks for desktops only on pods within the same site as the pod to which the user is connected.

  • LOCAL - View looks for desktops only in the pod to which the user is connected.

--isDedicated

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

--isFloating

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

--disabled

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

--description

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

--fromHome

(Optional) If the user has a home site, causes View to look for desktops on the user's home site. If the user does not have a home site, View begins searching for desktops on the site to which the user is currently connected.

--multipleSessionAutoClean

(Optional) Logs off extra user sessions for the same entitlement. Multiple floating desktop 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 a default display protocol for desktops in the global entitlement. Valid values are RDP and PCOIP.

--preventProtocolOverride

(Optional) When this option is specified, users cannot override the default display protocol for desktops in the global entitlement. If you do not specify this option, users can override the default display protocol.

--allowReset

(Optional) When this option is specified, users can reset desktops in the global entitlement. If you do not specify this option, users cannot reset desktops.

Example

lmvutil --authAs adminEast --authDomain domainEast --authPassword "*" --createGlobalEntitlement -entitlementName "Agent Sales" --scope LOCAL 
--isDedicated