3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2 VMware, Inc.
Page 3
Contents
Administering Cloud Pod Architecture in Horizon 75
Introduction to Cloud Pod Architecture7
1
Understanding Cloud Pod Architecture 7
Conguring and Managing a Cloud Pod Architecture Environment 8
Cloud Pod Architecture Limitations 8
Designing a Cloud Pod Architecture Topology9
2
Creating Cloud Pod Architecture Sites 9
Entitling Users and Groups in the Pod Federation 10
Finding and Allocating Desktops and Applications in the Pod Federation 10
Considerations for Unauthenticated Users 12
Global Entitlement Example 13
Restricting Access to Global Entitlements 13
Considerations for Workspace ONE Mode 15
Cloud Pod Architecture Topology Limits 16
Cloud Pod Architecture Port Requirements 16
Security Considerations for Cloud Pod Architecture Topologies 16
Seing Up a Cloud Pod Architecture Environment17
3
Initialize the Cloud Pod Architecture Feature 17
Join a Pod to the Pod Federation 18
Assign a Tag to a Connection Server Instance 19
Create and Congure a Global Entitlement 20
Add a Pool to a Global Entitlement 22
Create and Congure a Site 23
Assign a Home Site to a User or Group 24
Create a Home Site Override 25
Test a Cloud Pod Architecture Conguration 25
Example: Seing Up a Basic Cloud Pod Architecture Conguration 26
VMware, Inc.
Managing a Cloud Pod Architecture Environment31
4
View a Cloud Pod Architecture Conguration 31
View Pod Federation Health in Horizon Administrator 32
View Desktop and Application Sessions in the Pod Federation 33
Add a Pod to a Site 33
Modifying Global Entitlements 34
Managing Home Site Assignments 37
Remove a Pod From the Pod Federation 39
Uninitialize the Cloud Pod Architecture Feature 39
3
Page 4
Administering Cloud Pod Architecture in Horizon 7
lmvutil Command Reference41
5
lmvutil Command Use 41
Initializing the Cloud Pod Architecture Feature 44
Disabling the Cloud Pod Architecture Feature 45
Managing Pod Federations 45
Managing Sites 47
Managing Global Entitlements 50
Managing Home Sites 58
Viewing a Cloud Pod Architecture Conguration 60
Managing SSL Certicates 65
Index67
4 VMware, Inc.
Page 5
Administering Cloud Pod Architecture in Horizon
7
Administering Cloud Pod Architecture in Horizon 7 describes how to congure and administer a Cloud Pod
Architecture environment in VMware Horizon® 7, including how to plan a Cloud Pod Architecture
topology and set up, monitor, and maintain a Cloud Pod Architecture conguration.
Intended Audience
This information is intended for anyone who wants to set up and maintain a Cloud Pod Architecture
environment. The information is wrien for experienced Windows or Linux system administrators who are
familiar with virtual machine technology and data center operations.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For denitions
of terms as they are used in VMware technical documentation, go to
hp://www.vmware.com/support/pubs.
VMware, Inc.
5
Page 6
Administering Cloud Pod Architecture in Horizon 7
6 VMware, Inc.
Page 7
Introduction to Cloud Pod
Security
Server
User
View
Connection
Server
View
Connection
Server
Security
Server
View
Connection
Server
View
Connection
Server
Security
Server
Security
Server
London Pod
London Datacenter
Interpod
communication
Remote
desktop or
application
New York Pod
New York Datacenter
Global Data Layer
Architecture1
The Cloud Pod Architecture feature uses standard Horizon components to provide cross-datacenter
administration, global and exible user-to-desktop mapping, high availability desktops, and disaster
recovery capabilities.
This chapter includes the following topics:
“Understanding Cloud Pod Architecture,” on page 7
n
“Conguring and Managing a Cloud Pod Architecture Environment,” on page 8
n
“Cloud Pod Architecture Limitations,” on page 8
n
Understanding Cloud Pod Architecture
With the Cloud Pod Architecture feature, you can link together multiple pods to provide a single large
desktop and application brokering and management environment.
A pod consists of a set of Connection Server instances, shared storage, a database server, and the vSphere
and network infrastructures required to host desktop and application pools. In a traditional Horizon
implementation, you manage each pod independently. With the Cloud Pod Architecture feature, you can
join together multiple pods to form a single Horizon implementation called a pod federation.
A pod federation can span multiple sites and datacenters and simultaneously simplify the administration
eort required to manage a large-scale Horizon deployment.
The following diagram is an example of a basic Cloud Pod Architecture topology.
Figure 1‑1. Basic Cloud Pod Architecture Topology
VMware, Inc.
7
Page 8
Administering Cloud Pod Architecture in Horizon 7
In the example topology, two previously standalone pods in dierent datacenters are joined together to form
a single pod federation. An end user in this environment can connect to a Connection Server instance in the
New York datacenter and receive a desktop or application in the London data center.
Sharing Key Data in the Global Data Layer
Connection Server instances in a pod federation use the Global Data Layer to share key data. Shared data
includes information about the pod federation topology, user and group entitlements, policies, and other
Cloud Pod Architecture conguration information.
In a Cloud Pod Architecture environment, shared data is replicated on every Connection Server instance in a
pod federation. Entitlement and topology conguration information stored in the Global Data Layer
determines where and how desktops are allocated across the pod federation.
Horizon sets up the Global Data Layer on each Connection Server instance in a pod federation when you
initialize the Cloud Pod Architecture feature.
Sending Messages Between Pods
Connection Server instances communicate in a Cloud Pod Architecture environment by using an interpod
communication protocol called the View InterPod API (VIPA).
Connection Server instances use the VIPA communication channel to launch new desktops, nd existing
desktops, and share health status data and other information. Horizon congures the VIPA communication
channel when you initialize the Cloud Pod Architecture feature.
Configuring and Managing a Cloud Pod Architecture Environment
You use Horizon Administrator and the lmvutil command-line interface to congure and manage a Cloud
Pod Architecture environment. lmvutil is installed as part of the Horizon installation. You can also use
Horizon Administrator to view pod health and session information.
Cloud Pod Architecture Limitations
The Cloud Pod Architecture feature has certain limitations.
The Cloud Pod Architecture feature is not supported in an IPv6 environment.
n
Kiosk mode clients are not supported in a Cloud Pod Architecture implementation unless you
n
implement a workaround. For instructions, see VMware Knowledge Base (KB) article 2148888.
8 VMware, Inc.
Page 9
Designing a Cloud Pod Architecture
Topology2
Before you begin to congure the Cloud Pod Architecture feature, you must make decisions about your
Cloud Pod Architecture topology. Cloud Pod Architecture topologies can vary, depending on your goals, the
needs of your users, and your existing Horizon implementation. If you are joining existing Horizon pods to
a pod federation, your Cloud Pod Architecture topology is typically based on your existing network
topology.
This chapter includes the following topics:
“Creating Cloud Pod Architecture Sites,” on page 9
n
“Entitling Users and Groups in the Pod Federation,” on page 10
n
“Finding and Allocating Desktops and Applications in the Pod Federation,” on page 10
n
“Considerations for Unauthenticated Users,” on page 12
n
“Global Entitlement Example,” on page 13
n
“Restricting Access to Global Entitlements,” on page 13
n
“Considerations for Workspace ONE Mode,” on page 15
n
“Cloud Pod Architecture Topology Limits,” on page 16
n
“Cloud Pod Architecture Port Requirements,” on page 16
n
“Security Considerations for Cloud Pod Architecture Topologies,” on page 16
n
Creating Cloud Pod Architecture Sites
In a Cloud Pod Architecture environment, a site is a collection of well-connected pods in the same physical
location, typically in a single datacenter. The Cloud Pod Architecture feature treats pods in the same site
equally.
When you initialize the Cloud Pod Architecture feature, it places all pods into a default site called Default
First Site. If you have a large implementation, you might want to create additional sites and add pods to
those sites.
The Cloud Pod Architecture feature assumes that pods in the same site are on the same LAN, and that pods
in dierent sites are on dierent LANs. Because WAN-connected pods have slower network performance,
the Cloud Pod Architecture feature gives preference to desktops and applications that are in the local pod or
site when it allocates desktops and applications to users.
Sites can be a useful part of a disaster recovery solution. For example, you can assign pods in dierent
datacenters to dierent sites and entitle users and groups to pools that span those sites. If a datacenter in
one site becomes unavailable, you can use desktops and applications from the available site to satisfy user
requests.
VMware, Inc.
9
Page 10
Administering Cloud Pod Architecture in Horizon 7
Entitling Users and Groups in the Pod Federation
In a traditional Horizon environment, you use Horizon Administrator to create local entitlements. These
local entitlements entitle users and groups to a specic desktop or application pool on a Connection Server
instance.
In a Cloud Pod Architecture environment, you create global entitlements to entitle users or groups to
multiple desktops and applications across multiple pods in the pod federation. When you use global
entitlements, you do not need to congure and manage local entitlements. Global entitlements simplify
administration, even in a pod federation that contains a single pod.
Global entitlements are stored in the Global Data Layer. Because global entitlements are shared data, global
entitlement information is available on all Connection Server instances in the pod federation.
You entitle users and groups to desktops by creating global desktop entitlements. Each global desktop
entitlement contains a list of member users or groups, a list of the desktop pools that can provide desktops
for entitled users, and a scope policy. The desktop pools in a global entitlement can be either oating or
dedicated pools. You specify whether a global entitlement is oating or dedicated during global entitlement
creation.
You entitle users and groups to applications by creating global application entitlements. Each global
application entitlement contains a list of the member users or groups, a list of the application pools that can
provide applications for entitled users, and a scope policy.
A global entitlement's scope policy species where Horizon looks for desktops or applications when it
allocates desktops or applications to users in the global entitlement. It also determines whether Horizon
looks for desktops or applications in any pod in the pod federation, in pods that reside in the same site, or
only in the pod to which the user is connected.
As a best practice, you should not congure local and global entitlements for the same desktop pool. For
example, if you create both local and global entitlements for the same desktop pool, the same desktop might
appear as a local and a global entitlement in the list of desktops and applications that Horizon Client shows
to an entitled user. Similarly, you should not congure both local and global entitlements for application
pools created from the same farm.
Finding and Allocating Desktops and Applications in the Pod
Federation
Connection Server instances in a Cloud Pod Architecture environment use shared global entitlement and
topology conguration information from the Global Data Layer to determine where to search for and how to
allocate desktops and applications across the pod federation.
When a user requests a desktop or application from a global entitlement, Horizon searches for an available
desktop or application in the pools that are associated with that global entitlement. By default, Horizon
gives preference to the local pod, the local site, and pods in other sites, in that order.
For global desktop entitlements that contain dedicated desktop pools, Horizon uses the default search
behavior only the rst time a user requests a desktop. After Horizon allocates a dedicated desktop, it returns
the user directly to the same desktop.
You can modify the search and allocation behavior for individual global entitlements by seing the scope
policy and conguring home sites.
10 VMware, Inc.
Page 11
Chapter 2 Designing a Cloud Pod Architecture Topology
Understanding the Scope Policy
When you create a global desktop entitlement or global application entitlement, you must specify its scope
policy. The scope policy determines the scope of the search when Horizon looks for desktops or applications
to satisfy a request from the global entitlement.
You can set the scope policy so that Horizon searches only on the pod to which the user is connected, only
on pods within the same site as the user's pod, or across all pods in the pod federation.
For global desktop entitlements that contain dedicated pools, the scope policy aects where Horizon looks
for desktops the rst time a user requests a dedicated desktop. After Horizon allocates a dedicated desktop,
it returns the user directly to the same desktop.
Understanding the Multiple Sessions Per User Policy
When you create a global desktop entitlement, you can specify whether users can initiate separate desktop
sessions from dierent client devices. The multiple sessions per user policy applies only to global desktop
entitlements that contain oating desktop pools.
When you enable the multiple sessions per user policy, users that connect to the global entitlement from
dierent client devices receive dierent 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.
If you enable the multiple sessions per user policy for a global entitlement, all of the desktop pools
associated with the global entitlement must also support multiple users per session.
Using Home Sites
A home site is a relationship between a user or group and a Cloud Pod Architecture site. With home sites,
Horizon begins searching for desktops and applications from a specic site rather than searching for
desktops and applications based on the user's current location.
If the home site is unavailable or does not have resources to satisfy the user's request, Horizon continues
searching other sites according to the scope policy set for the global entitlement.
For global desktop entitlements that contain dedicated pools, the home site aects where Horizon looks for
desktops the rst time a user requests a dedicated desktop. After Horizon allocates a dedicated desktop, it
returns the user directly to the same desktop.
The Cloud Pod Architecture feature includes the following types of home site assignments.
Global home site
A home site that is assigned to a user or group.
If a user who has a home site belongs to a group that is associated with a
dierent home site, the home site associated with the user takes precedence
over the group home site assignment.
VMware, Inc. 11
Page 12
Administering Cloud Pod Architecture in Horizon 7
Global homes sites are useful for controlling where roaming users receive
desktops and applications. For example, if a user has a home site in New
York but is visiting London, Horizon begins looking in the New York site to
satisfy the user's desktop request rather than allocating a desktop closer to
the user. Global home site assignments apply for all global entitlements.
I Global entitlements do not recognize home sites by default. To
make a global entitlement use home sites, you must select the Use home site
option when you create or modify the global entitlement.
Per-global-entitlement
home site (home site
override)
A home site that is associated with a global entitlement.
Per-global-entitlement home sites override global home site assignments. For
this reason, per-global-entitlement home sites are also referred to as home
site overrides.
For example, if a user who has a home site in New York accesses a global
entitlement that associates that user with the London home site, Horizon
begins looking in the London site to satisfy the user's application request
rather than allocating an application from the New York site.
Conguring home sites is optional. If a user does not have a home site, Horizon searches for and allocates
desktops and applications as described in “Finding and Allocating Desktops and Applications in the Pod
Federation,” on page 10.
Considerations for Unauthenticated Users
A Horizon administrator can create users for unauthenticated access to published applications on a
Connection Server instance. In a Cloud Pod Architecture environment, you can entitle these unauthenticated
users to applications across the pod federation by adding them to global application entitlements.
Following are considerations for unauthenticated users in a Cloud Pod Architecture environment.
Unauthenticated users can have only global application entitlements. If an unauthenticated user is
n
included in a global desktop entitlement, a warning icon appears next to the name on the Users and
Groups tab for the global desktop entitlement in Horizon Administrator.
When you join a pod to the pod federation, unauthenticated user data is migrated to the Global Data
n
Layer. If you unjoin or eject a pod that contains unauthenticated users from the pod federation,
unauthenticated user data for that pod is removed from the Global Data Layer.
You can have only one unauthenticated user for each Active Directory user. If the same user alias is
n
mapped to more than one Active Directory user, Horizon Administrator displays an error message on
the Unauthenticated Access tab on the Users and Groups pane.
You can assign home sites to unauthenticated users.
n
Unauthenticated users can have multiple sessions.
n
For information about seing up unauthenticated users, see the View Administration document.
12 VMware, Inc.
Page 13
Global Entitlement Example
New York Datacenter
Pod Federation
Global Entitlement
“My Global Pool”
Members:
NYUser1
NYUser2
Pools:
pool1
pool2
pool3
Scope: Any
pool1pool2
NY Pod
London Datacenter
pool3pool4
LDN Pod
NYUser1
In this example, NYUser1 is a member of the global desktop entitlement called My Global Pool. My Global
Pool provides an entitlement to three oating desktop pools, called pool1, pool2, and pool3. pool1 and pool2
are in a pod called NY Pod in the New York datacenter and pool3 and pool4 are in a pod called LDN Pod in
the London datacenter.
Figure 2‑1. Global Entitlement Example
Chapter 2 Designing a Cloud Pod Architecture Topology
Because My Global Pool has a scope policy of ANY, the Cloud Pod Architecture feature looks for desktops
across both NY Pod and LDN Pod when NYUser1 requests a desktop. The Cloud Pod Architecture feature
does not try to allocate a desktop from pool4 because pool4 is not part of My Global Pool.
If NYUser1 logs into NY Pod, the Cloud Pod Architecture feature allocates a desktop from pool1 or pool2, if
a desktop is available. If a desktop is not available in either pool1 or pool2, the Cloud Pod Architecture
feature allocates a desktop from pool3.
For an example of restricted global entitlements, see “Restricted Global Entitlement Example,” on page 14.
Restricting Access to Global Entitlements
You can congure the restricted global entitlements feature to restrict access to global entitlements based on
the Connection Server instance that users initially connect to when they select global entitlements.
With restricted global entitlements, you assign one or more tags to a Connection Server instance. Then,
when you congure a global entitlement, you specify the tags of the Connection Server instances that you
want to have access to the global entitlement.
You can add tags to global desktop entitlements and global application entitlements.
Tag Matching
The restricted global entitlements feature uses tag matching to determine whether a Connection Server
instance can access a particular global entitlement.
At the most basic level, tag matching determines that a Connection Server instance that has a specic tag can
access a global entitlement that has the same tag.
The absence of tag assignments can also aect whether users that connect to a Connection Server instance
can access a global entitlement. For example, Connection Server instances that do not have any tags can only
access global entitlements that also do not have any tags.
VMware, Inc. 13
Page 14
Administering Cloud Pod Architecture in Horizon 7
Table 2-1 shows how tag matching determines when a Connection Server instance can access a global
One or more tagsOne or more tagsOnly when tags match
The restricted global entitlements feature only enforces tag matching. You must design your network
topology to force certain clients to connect through a particular Connection Server instance.
Considerations and Limitations for Restricted Global Entitlements
Before implementing restricted global entitlements, you must be aware of certain considerations and
limitations.
A single Connection Server instance or global entitlement can have multiple tags.
n
Multiple Connection Server instances and global entitlements can have the same tag.
n
Any Connection Server instance can access a global entitlement that does not have any tags.
n
Connection Server instances that do not have any tags can access only global entitlements that also do
n
not have any tags.
If you use a security server, you must congure restricted entitlements on the Connection Server
n
instance with which the security server is paired. You cannot congure restricted entitlements on a
security server.
Restricted global entitlements take precedence over other entitlements or assignments. For example,
n
even if a user is assigned to a particular machine, the user cannot access that machine if the tag assigned
to the global entitlement does not match the tag assigned to the Connection Server instance to which the
user is connected.
If you intend to provide access to your global entitlements through VMware Identity Manager and you
n
congure Connection Server restrictions, the VMware Identity Manager app might display global
entitlements to users when the global entitlements are actually restricted. When a
VMware Identity Manager user aempts to connect to a global entitlement, the desktop or application
does not start if the tag assigned to the global entitlement does not match the tag assigned to the
Connection Server instance to which the user is connected.
Restricted Global Entitlement Example
This example shows a Cloud Pod Architecture environment that includes two pods. Both pods contain two
Connection Server instances. The rst Connection Server instance supports internal users and the second
Connection Server instance is paired with a security server and supports external users.
To prevent external users from accessing certain desktop and application pools, you could assign tags as
follows:
Assign the tag "Internal" to the Connection Server instance that support your internal users.
n
Assign the tag "External" to the Connection Server instances that support your external users.
n
Assign the "Internal" tag to the global entitlements that should be accessible only to internal users.
n
Assign the "External" tag to the global entitlements that should be accessible only to external users.
n
14 VMware, Inc.
Page 15
CS1
Tag:
Internal
CS2
Tag:
External
User1
Pool:
public1
Pool:
secret1
Global Entitlement 1
Tags: Internal
Pools: secret1, secret2
Members: all users
Global Entitlement 2
Tags: External
Pools: public1, public2
Members: all users
Pod 1
Pod Federation
CS3
Tag:
Internal
CS4
Tag:
External
Pool:
public2
Pool:
secret2
Pod 2
Chapter 2 Designing a Cloud Pod Architecture Topology
External users cannot see the global entitlements that are tagged as Internal because they log in through the
Connection Server instances that are tagged as External. Internal users cannot see the global entitlements
that are tagged as External because they log in through the Connection Server instances that are tagged as
Internal.
In the following diagram, User1 connects to the Connection Server instance called CS1. Because CS1 is
tagged Internal and Global Entitlement 1 is also tagged internal, User1 can only see Global Entitlement 1.
Because Global Entitlement 1 contains pools secret1 and secret2, User1 can only receive desktops or
applications from the secret1 and secret2 pools.
Figure 2‑2. Restricted Global Entitlement Example
Considerations for Workspace ONE Mode
If a Horizon administrator enables Workspace ONE mode for a Connection Server instance, Horizon Client
users can be redirected to a Workspace ONE server to launch their entitlements.
During Workspace ONE mode conguration, a Horizon administrator species the host name of the
Workspace ONE server. In a Cloud Pod Architecture environment, every pod in the pod federation must be
congured to point to the same Workspace ONE server.
For information about conguring Workspace ONE mode, see "Congure Workspace ONE Access Policies
in Horizon Administrator" in the View Administration document.
VMware, Inc. 15
Page 16
Administering Cloud Pod Architecture in Horizon 7
Cloud Pod Architecture Topology Limits
A typical Cloud Pod Architecture topology consists of two or more pods, which are linked together in a pod
federation. Pod federations are subject to certain limits.
Table 2‑2. Pod Federation Limits
ObjectLimit
Total sessions120,000
Pods25
Sessions per pod10,000
Sites5
Connection Server instances175
Cloud Pod Architecture Port Requirements
Certain network ports must be opened on the Windows rewall for the Cloud Pod Architecture feature to
work. When you install Connection Server, the installation program can optionally congure the required
rewall rules for you. These rules open the ports that are used by default. If you change the default ports
after installation, or if your network has other rewalls, you must manually congure the Windows rewall.
Table 2‑3. Ports Opened During Connection Server Installation
TCP
Protocol
HTTP22389Used for Global Data Layer LDAP replication. Shared data is replicated on every Connection
HTTPS22636Used for secure Global Data Layer LDAP replication.
HTTPS8472Used for View Interpod API (VIPA) communication. Connection Server instances use the VIPA
PortDescription
Server instance in a pod federation. Each Connection Server instance in a pod federation runs a
second LDAP instance to store shared data.
communication channel to launch new desktops and applications, nd existing desktops, and
share health status data and other information.
Security Considerations for Cloud Pod Architecture Topologies
To use Horizon Administrator or the lmvutil command to congure and manage a Cloud Pod Architecture
environment, you must have the Administrators role. Users who have the Administrators role on the root
access group are super users.
When a Connection Server instance is part of a replicated group of Connection Server instances, the rights of
super users are extended to other Connection Server instances in the pod. Similarly, when a pod is joined to
a pod federation, the rights of super users are extended to all of the Connection Server instances in all of the
pods in the pod federation. These rights are necessary to modify global entitlements and perform other
operations on the Global Data Layer.
If you do not want certain super users to be able to perform operations on the Global Data Layer, you can
remove the Administrators role assignment and assign the Local Administrators role instead. Users who
have the Local Administrators role have super user rights only on their local Connection Server instance and
on any instances in a replicated group.
For information about assigning roles in Horizon Administrator, see the View Administration document.
16 VMware, Inc.
Page 17
Setting Up a Cloud Pod Architecture
Environment3
Seing up a Cloud Pod Architecture environment involves initializing the Cloud Pod Architecture feature,
joining pods to the pod federation, and creating global entitlements.
You must create and congure at least one global entitlement to use the Cloud Pod Architecture feature. You
can optionally create sites and assign home sites.
This chapter includes the following topics:
“Initialize the Cloud Pod Architecture Feature,” on page 17
n
“Join a Pod to the Pod Federation,” on page 18
n
“Assign a Tag to a Connection Server Instance,” on page 19
n
“Create and Congure a Global Entitlement,” on page 20
n
“Add a Pool to a Global Entitlement,” on page 22
n
“Create and Congure a Site,” on page 23
n
“Assign a Home Site to a User or Group,” on page 24
n
“Create a Home Site Override,” on page 25
n
“Test a Cloud Pod Architecture Conguration,” on page 25
n
“Example: Seing Up a Basic Cloud Pod Architecture Conguration,” on page 26
n
Initialize the Cloud Pod Architecture Feature
Before you congure a Cloud Pod Architecture environment, you must initialize the Cloud Pod Architecture
feature.
You need to initialize the Cloud Pod Architecture feature only once, on the rst pod in a pod federation. To
add pods to the pod federation, you join the new pods to the initialized pod.
During the initialization process, Horizon sets up the Global Data Layer on each Connection Server instance
in the pod, congures the VIPA communication channel, and establishes a replication agreement between
each Connection Server instance.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod.
You can initialize the Cloud Pod Architecture feature from any Connection Server instance in a pod.
2In Horizon Administrator, select View > Cloud Pod Architecture and click Initialize the
Cloud Pod Architecture feature.
VMware, Inc.
17
Page 18
Administering Cloud Pod Architecture in Horizon 7
3When the Initialize dialog box appears, click OK to begin the initialization process.
Horizon Administrator shows the progress of the initialization process. The initialization process can
take several minutes.
After the Cloud Pod Architecture feature is initialized, the pod federation contains the initialized pod
and a single site. The default pod federation name is Horizon Cloud Pod Federation. The default pod
name is based on the host name of the Connection Server instance. For example, if the host name is CS1,
the pod name is Cluster-CS1. The default site name is Default First Site.
4When Horizon Administrator prompts you to reload the client, click OK.
After the Horizon Administrator user interface is refreshed, Global Entitlements appears under
Catalog and Sites appears under View in the Horizon Administrator Inventory panel.
5(Optional) To change the default name of the pod federation, select View > Cloud Pod
Architecture, click Edit, type the new name in the Name text box, and click OK.
6(Optional) To change the default name of the pod, select View > Sites, select the pod,
click Edit, type the new name in the Name text box, and click OK.
7(Optional) To change the default name of the site, select View > Sites, select the site, click
Edit, type the new name in the Name text box, and click OK.
What to do next
To add more pods to the pod federation, see “Join a Pod to the Pod Federation,” on page 18.
Join a Pod to the Pod Federation
During the Cloud Pod Architecture initialization process, the Cloud Pod Architecture feature creates a pod
federation that contains a single pod. You can use Horizon Administrator to join additional pods to the pod
federation. Joining additional pods is optional.
I Do not stop or start a Connection Server instance while you are joining it to a pod federation.
The Connection Server service might not restart correctly. You can stop and start the Connection Server after
it is successfully joined to the pod federation.
Prerequisites
Make sure the Connection Server instances that you want to join have dierent host names. You cannot
n
join servers that have the same name, even if they are in dierent domains.
Initialize the Cloud Pod Architecture feature. See “Initialize the Cloud Pod Architecture Feature,” on
n
page 17.
Procedure
1Log in to the Horizon Administrator user interface for a Connection Server instance in the pod that you
are joining to the pod federation.
2In Horizon Administrator, select View > Cloud Pod Architecture and click Join the pod
federation.
3In the Connection Server text box, type the host name or IP address of any Connection Server instance
in any pod that has been initialized or is already joined to the pod federation.
4In the User name text box, type the name of a Horizon administrator user on the already initialized
pod.
Use the format domain\username.
5In the Password text box, type the password for the Horizon administrator user.
18 VMware, Inc.
Page 19
Chapter 3 Setting Up a Cloud Pod Architecture Environment
6Click OK to join the pod to the pod federation.
Horizon Administrator shows the progress of the join operation. The default pod name is based on the
host name of the Connection Server instance. For example, if the host name is CS1, the pod name is
Cluster-CS1.
7When Horizon Administrator prompts you to reload the client, click OK.
After the Horizon Administrator user interface is refreshed, Global Entitlements appears under
Catalog and Sites appears under View in the Horizon Administrator Inventory panel.
8(Optional) To change the default name of the pod, select View > Sites, select the pod,
click Edit, type the new name in the Name text box, and click OK.
After the pod is joined to the pod federation, it begins to share health data. You can view this health data on
the dashboard in Horizon Administrator. See “View Pod Federation Health in Horizon Administrator,” on
page 32.
N A short delay might occur before health data is available in Horizon Administrator.
What to do next
You can repeat these steps to join additional pods to the pod federation.
Assign a Tag to a Connection Server Instance
If you plan to restrict access to a global entitlement based on the Connection Server instance that users
initially connect to when they select the global entitlement, you must rst assign one or more tags to the
Connection Server instance.
Prerequisites
Become familiar with the restricted global entitlements feature. See “Restricting Access to Global
Entitlements,” on page 13.
Procedure
1Log in to Horizon Administrator for the Connection Server instance.
2Select View > Servers.
3Click the Connection Servers tab, select the Connection Server instance, and click Edit.
4Type one or more tags in the Tags text box.
Separate multiple tags with a comma or semicolon.
5Click OK to save your changes.
6Repeat these steps for each Connection Server instance to which you want to assign tags.
What to do next
When you create or edit a global entitlement, select the tags that are associated with the Connection Server
instances that you want to access the global entitlement. See “Create and Congure a Global Entitlement,”
on page 20, or “Modify Aributes or Policies for a Global Entitlement,” on page 35.
VMware, Inc. 19
Page 20
Administering Cloud Pod Architecture in Horizon 7
Create and Configure a Global Entitlement
You use global entitlements to entitle users and groups to desktops and applications in a Cloud Pod
Architecture environment. Global entitlements provide the link between users and their desktops and
applications, regardless of where those desktops and applications reside in the pod federation.
A global entitlement contains a list of member users or groups, a set of policies, and a list of the pools that
can provide desktops or applications for entitled users. You can add both users and groups, only users, or
only groups, to a global entitlement.
Prerequisites
Initialize the Cloud Pod Architecture feature. See “Initialize the Cloud Pod Architecture Feature,” on
n
page 17.
Decide which type of global desktop entitlement to create, the users and groups to include in the global
n
entitlement, and the scope of the global entitlement. See “Entitling Users and Groups in the Pod
Federation,” on page 10.
Decide whether to restrict access to the global entitlement based on the Connection Server instance that
n
users initially connect to when they select the global entitlement. See “Restricting Access to Global
Entitlements,” on page 13.
If you plan to restrict access to the global entitlement, assign one or more tags to the Connection Server
n
instance. See “Assign a Tag to a Connection Server Instance,” on page 19.
Decide whether the global entitlement uses home sites. See “Using Home Sites,” on page 11.
n
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements and click Add.
3Select the type of global entitlement to add and click Next.
OptionDescription
Desktop Entitlement
Application Entitlement
Adds a global desktop entitlement.
Adds a global application entitlement.
4Congure the global entitlement.
aType a name for the global entitlement in the Name text box.
The name can contain between 1 and 64 characters. This name appears in the list of available
desktops and applications in Horizon Client for an entitled user.
b(Optional) Type a description of the global entitlement in the Description text box.
The description can contain between 1 and 1024 characters.
c(Optional) To restrict access to the global entitlement, click Browse, select Restricted to these tags,
select the tags to associate with the global entitlement, and click OK.
Only the Connection Server instances that have the selected tags can access the global entitlement.
N You can only select tags assigned to Connection Server instances in the local pod. To select
tags assigned to Connection Server instances in another pod, you must log in to Horizon
Administrator for a Connection Server instance in the other pod and modify the global entitlement.
20 VMware, Inc.
Page 21
Chapter 3 Setting Up a Cloud Pod Architecture Environment
dIf you are conguring a global desktop entitlement, select a user assignment policy.
The user assignment policy species the type of desktop pool that a global desktop entitlement can
contain. You can select only one user assignment policy.
OptionDescription
Floating
Dedicated
Creates a oating desktop entitlement. A oating desktop entitlement
can contain only oating desktop pools.
Creates a dedicated desktop entitlement. A dedicated desktop
entitlement can contain only dedicated desktop pools.
eSelect a scope policy for the global entitlement.
The scope policy species where to look for desktops or applications to satisfy a request from the
global entitlement. You can select only one scope policy.
OptionDescription
All sites
Within site
Within pod
Look for desktops or applications on any pod in the pod federation.
Look for desktops or applications only on pods in the same site as the
pod to which the user is connected.
Look for desktops or applications only in the pod to which the user is
connected.
f(Optional) If users have home sites, congure a home site policy for the global entitlement.
OptionDescription
Use home site
Entitled user must have home site
Begin searching for desktops or applications in the user's home site. If
the user does not have a home site and the Entitled user must havehome site option is not selected, the site to which the user is connected
is assumed to be the home site.
Make the global entitlement available only if the user has a home site.
This option is available only when the Use home site option is selected.
g(Optional) Use the Automatically clean up redundant sessions option to specify whether to clean
up redundant sessions.
N This option is available only for oating desktop entitlements and global application
entitlements.
Multiple sessions can occur when a pod that contains a session goes oine, 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 select this option, users must
manually end their own extra sessions, either by logging o in Horizon Client or by launching the
sessions and logging them o.
hSelect the default display protocol for desktops or applications in the global entitlement and specify
whether to allow users to override the default display protocol.
i(Global desktop entitlement only) Select whether to allow users to reset desktops in the global
desktop entitlement.
jSelect whether to allow users to use the HTML Access feature to access desktops or applications in
the global entitlement.
When you enable the HTML Access policy, end users can use a Web browser to connect to remote
desktops and applications and are not required to install any client software on their local systems.
VMware, Inc. 21
Page 22
Administering Cloud Pod Architecture in Horizon 7
k(Global desktop entitlement only) Select whether to allow users to initiate separate desktop
sessions from dierent client devices.
When you enable the multiple sessions per user policy, users that connect to the global entitlement
from dierent client devices receive dierent 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. You can enable this policy only for oating desktop entitlements.
N If you enable this policy, all the desktop pools in the global entitlement must also support
multiple sessions per user.
l(Global application entitlement only) Select whether to launch 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.
N If you enable this policy, all the application pools in the global application entitlement must
also support the session pre-launch feature, and the pre-launch session timeout must be the same
for all farms.
5Click Next and add users or groups to the global entitlement.
aClick Add, select one or more search criteria, and click Find to lter users or groups based on your
search criteria.
You can select the Unauthenticated Users check box to nd and add unauthenticated access users
to global application entitlements. You cannot add unauthenticated access users to global desktop
entitlements. If you aempt to add an unauthenticated access user to a global desktop entitlement,
Horizon Administrator returns an error message.
bSelect the user or group to add to the global entitlement and click OK.
You can press the Ctrl and Shift keys to select multiple users and groups.
6Click Next, review the global entitlement conguration, and click Finish to create the global
entitlement.
The global entitlement appears on the Global Entitlements page.
The Cloud Pod Architecture feature stores the global entitlement in the Global Data Layer, which replicates
the global entitlement on every pod in the pod federation.
What to do next
Select the pools that can provide desktops or applications for the users in the global entitlement that you
created. See “Add a Pool to a Global Entitlement,” on page 22.
Add a Pool to a Global Entitlement
You can use Horizon Administrator to add a desktop pool to an existing global desktop entitlement, or add
an application pool to an existing global application entitlement.
You can add multiple pools to a global entitlement, but you can add a particular pool to only one global
entitlement.
22 VMware, Inc.
Page 23
Chapter 3 Setting Up a Cloud Pod Architecture Environment
If you add multiple application pools to a global application entitlement, you must add the same
application. For example, do not add Calculator and Microsoft Oce PowerPoint to the same global
application entitlement. If you add dierent applications to the same global application entitlement, entitled
users might receive dierent applications at dierent times.
N If a Horizon administrator changes the pool-level display protocol or protocol override policy after a
desktop pool is associated with a global desktop entitlement, users can receive a desktop launch error when
they select the global desktop entitlement. If a Horizon administrator changes the pool-level virtual machine
reset policy after a desktop pool is associated with the global desktop entitlement, users can receive an error
if they try to reset the desktop.
Prerequisites
Create and congure the global entitlement. See “Create and Congure a Global Entitlement,” on
n
page 20.
Create the desktop or application pool to add to the global entitlement. See the Seing Up Virtual
n
Desktops in Horizon 7 or Seing Up Published Desktops and Applications in Horizon 7 document.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod that
contains the pool to add to the global entitlement.
2In Horizon Administrator, select Catalog > Global Entitlements.
3Double-click the global entitlement.
4On the Local Pools tab, click Add, select the desktop or application pool to add, and click Add.
You can press the Ctrl and Shift keys to select multiple pools.
N Pools that are already associated with a global entitlement or that do not meet the criteria for the
global entitlement policies you selected are not displayed. For example, if you enabled the
HTML Access policy, you cannot select pools that do not allow HTML Access.
5Repeat these steps on a Connection Server instance in each pod that contains a pool to add to the global
entitlement.
When an entitled user uses Horizon Client to connect to a Connection Server instance in the pod federation,
the global entitlement name appears in the list of available desktops and applications.
Create and Configure a Site
If your Cloud Pod Architecture topology contains multiple pods, you might want to group those pods into
dierent sites. The Cloud Pod Architecture feature treats pods in the same site equally.
Prerequisites
Decide whether your Cloud Pod Architecture topology should include sites. See “Creating Cloud Pod
n
Architecture Sites,” on page 9.
Initialize the Cloud Pod Architecture feature. See “Initialize the Cloud Pod Architecture Feature,” on
n
page 17.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
VMware, Inc. 23
Page 24
Administering Cloud Pod Architecture in Horizon 7
2Create the site.
aIn Horizon Administrator, select View > Sites and click Add.
bType a name for the site in the Name text box.
The site name can contain between 1 and 64 characters.
c(Optional) Type a description of the site in the Description text box.
The site name can contain between 1 and 1024 characters.
dClick OK to create the site.
3Add a pod to the site.
Repeat this step for each pod to add to the site.
aIn Horizon Administrator, select View > Sites and select the site that currently
contains the pod to add to the site.
The names of the pods in the site appear in the lower pane.
bSelect the pod to add to the site and click Edit.
cSelect the site from the Site drop-down menu and click OK.
Assign a Home Site to a User or Group
A home site is the relationship between a user or group and a Cloud Pod Architecture site. With home sites,
Horizon begins searching for desktops and applications from a specic site rather than searching for
desktops and applications based on the user's current location. Assigning home sites is optional.
You can associate a global entitlement with a home site so that the global entitlement's home site overrides a
user's own home site when a user selects the global entitlement. For more information, see “Create a Home
Site Override,” on page 25.
Prerequisites
Decide whether to assign home sites to users or groups in your Cloud Pod Architecture environment.
n
See “Using Home Sites,” on page 11.
Group the pods in your pod federation into sites. See “Create and Congure a Site,” on page 23.
n
Global entitlements do not use home sites by default. When creating a global entitlement, you must
n
select the Use home site option to cause Horizon to use a user's home site when allocating desktops
from that global entitlement. See “Create and Congure a Global Entitlement,” on page 20.
Initialize the Cloud Pod Architecture feature. See “Initialize the Cloud Pod Architecture Feature,” on
n
page 17.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Users and Groups and click the Home Site tab.
3On the Home Site tab, click Add.
4Select one or more search criteria and click Find to lter the users or groups based on your search
criteria.
You can select the Unauthenticated Users check box to nd unauthenticated access users in the pod
federation.
5Select a user or group and click Next.
24 VMware, Inc.
Page 25
6Select the home site to assign to the user or group from the Home Site drop-down menu and click
Finish.
Create a Home Site Override
You can associate a global entitlement with a home site so that the global entitlement's home site overrides a
user's own home site when the user selects the global entitlement.
To create a home site override, you associate a home site with a global entitlement and a particular user or
group. When the user (or a user in the selected group) accesses the global entitlement, the global
entitlement's home site overrides the user's own home site.
For example, if a user who has a home site in New York accesses a global entitlement that associates that
user with the London home site, Horizon looks in the London site to satisfy the user's application request
rather than allocating an application from the New York site.
Prerequisites
Verify that the global entitlement has the Use home site policy enabled. For more information, see
n
“Modify Aributes or Policies for a Global Entitlement,” on page 35.
Verify that the user or group is included in the global entitlement. For more information, see “Add a
n
User or Group to a Global Entitlement,” on page 34.
Chapter 3 Setting Up a Cloud Pod Architecture Environment
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements.
3Double-click the global entitlement to associate with a home site.
4On the Home Site Override tab, click Add.
N The Addbuon is not available if the Use home site policy is not enabled for the global
entitlement.
5Select one or more search criteria and click Find to lter Active Directory users and groups based on
your search criteria.
6Select the Active Directory user or group that has a home site you want to override.
The user or group must already be included in the global entitlement you selected.
7Select the home site to associate with the global entitlement from the Home Site drop-down menu.
8Click Finish to create the home site override.
Test a Cloud Pod Architecture Configuration
After you initialize and congure a Cloud Pod Architecture environment, perform certain steps to verify
that your environment is set up properly.
Prerequisites
Install the latest version of Horizon Client on a supported computer or mobile device.
n
Verify that you have credentials for a user in one of your newly created global entitlements.
n
Procedure
1Start Horizon Client.
VMware, Inc. 25
Page 26
Administering Cloud Pod Architecture in Horizon 7
2Connect to any Connection Server instance in the pod federation by using the credentials of a user in
one of your new global entitlements.
After you connect to the Connection Server instance, the global entitlement name appears in the list of
available desktops and applications.
3Select the global entitlement and connect to a desktop or application.
The desktop or application starts successfully. Which desktop or application starts depends on the
individual conguration of the global entitlement, pods, and desktop and application pools. The Cloud Pod
Architecture feature aempts to allocate a desktop or application from the pod to which you are connected.
What to do next
If the global entitlement does not appear when you connect to the Connection Server instance, use Horizon
Administrator to verify that the entitlement is congured correctly. If the global entitlement appears but a
desktop or application does not start, all desktop or application pools might be fully assigned to other users.
Example: Setting Up a Basic Cloud Pod Architecture Configuration
This example demonstrates how you can use the Cloud Pod Architecture feature to complete a Cloud Pod
Architecture conguration.
In this example, a health insurance company has a mobile sales force that operates across two regions, the
Central region and the Eastern region. Sales agents use mobile devices to present insurance policy quotes to
customers and customers view and sign digital documents.
Rather than store customer data on their mobile devices, sales agents use standardized oating desktops.
Access to customer data is kept secure in the health insurance company's datacenters.
The health insurance company has a data center in each region. Occasional capacity problems cause sales
agents to look for available desktops in a non-local data center, and WAN latency problems sometimes
occur. If sales agents disconnect from desktops but leave their sessions logged in, they must remember
which datacenter hosted their sessions to reconnect to their desktops.
To solve these problems, the health insurance company designs a Cloud Pod Architecture topology,
initializes the Cloud Pod Architecture feature, joins its existing pods to the pod federation, creates sites for
each of its data centers, entitles its sales agents to all of its desktop pools, and implements a single URL.
1Designing the Example Topology on page 27
The insurance company designs a Cloud Pod Architecture topology that includes a site for each
region.
2Initializing the Example Conguration on page 27
To initialize the Cloud Pod Architecture feature, the Horizon administrator logs in to the Horizon
Administrator user interface for a Connection Server instance in East Pod 1, selects View > Cloud Pod Architecture, and clicks Initialize the Cloud Pod Architecture feature.
3Joining Pods in the Example Conguration on page 28
The Horizon administrator uses Horizon Administrator to join Central Pod 1 and Central Pod 2 to the
pod federation.
4Creating Sites in the Example Conguration on page 28
The Horizon administrator uses Horizon Administrator to create a site for the Eastern and Central
datacenters and adds pods to those sites.
5Creating Global Desktop Entitlements in the Example Conguration on page 28
The Horizon administrator uses Horizon Administrator to create a single global desktop entitlement
that entitles all sales agents to all desktops in the sales agent desktop pools across all pods in the pod
federation.
26 VMware, Inc.
Page 27
east1.example
East Pod 1
Eastern Region
east2.exampleeast3.example
east4.exampleeast5.example
central1.example
Central Pod 1
Central Region
central2.examplecentral3.example
central4.examplecentral5.example
central6.example
Central Pod 2
central7.examplecentral8.example
central9.examplecentral10.example
Sales ASales B
Sales A
Sales B
Sales A
Sales B
Chapter 3 Setting Up a Cloud Pod Architecture Environment
6Creating a URL for the Example Conguration on page 29
The insurance company uses a single URL and employs a DNS service to resolve sales.example to the
nearest pod in the nearest data center. With this arrangement, sales agents do not need to remember
dierent URLs for each pod and are always directed to the nearest data center, regardless of where
they are located.
Designing the Example Topology
The insurance company designs a Cloud Pod Architecture topology that includes a site for each region.
Figure 3‑1. Example Cloud Pod Architecture Topology
In this topology, the Eastern region site contains a single pod, East Pod 1, that consists of ve Connection
Server instances called east1.example through east5.example.
The Central region site contains two pods, Central Pod 1 and Central Pod 2. Each pod contains ve
Connection Server instances. The Connection Servers in the rst pod are called central1.example through
central5.example. The Connection Server instances in the second pod are called central6.example through
central10.example.
Each pod in the topology contains two desktop pools of sales agent desktops, called Sales A and Sales B.
Initializing the Example Configuration
To initialize the Cloud Pod Architecture feature, the Horizon administrator logs in to the Horizon
VMware, Inc. 27
Administrator user interface for a Connection Server instance in East Pod 1, selects View >
Cloud Pod Architecture, and clicks Initialize the Cloud Pod Architecture feature.
Because the Horizon administrator uses the Horizon Administrator user interface for a Connection Server
instance in East Pod 1, the pod federation initially contains East Pod 1. The pod federation also contains a
single site, called Default First Site, which contains East Pod 1.
Page 28
Administering Cloud Pod Architecture in Horizon 7
Joining Pods in the Example Configuration
The Horizon administrator uses Horizon Administrator to join Central Pod 1 and Central Pod 2 to the pod
federation.
1To join Central Pod 1, the Horizon administrator logs in to the Horizon Administrator user interface for
a Connection Server instance in Central Pod 1, selects View > Cloud Pod Architecture,
clicks Join the pod federation, and provides the host name or IP address of a Connection Server
instance in East Pod 1.
Central Pod 1 is now joined to the pod federation.
2To join Central Pod 2, the Horizon administrator logs in to the Horizon Administrator user interface for
a Connection Server instance in Central Pod 2, selects View > Cloud Pod Architecture,
clicks Join the pod federation, and provides the host name or IP address of a Connection Server
instance in East Pod 1 or Central Pod 1.
Central Pod 2 is now joined to the pod federation.
After Central Pod 1 and Central Pod 2 are joined to the pod federation, all 10 Connection Server instances
across both pods in the Central region are part of the pod federation.
Creating Sites in the Example Configuration
The Horizon administrator uses Horizon Administrator to create a site for the Eastern and Central
datacenters and adds pods to those sites.
1The Horizon administrator logs in to the Horizon Administrator user interface for any Connection
Server instance in the pod federation.
2To create a site for the Eastern datacenter, the Horizon administrator selects View > Sites
and clicks Add.
3To create a site for the Central datacenter, the Horizon administrator selects View > Sites
and clicks Add.
4To move East Pod 1 to the site for the Eastern datacenter, the Horizon administrator selects View
> Sites, selects the site that currently contains East Pod 1, selects East Pod 1, clicks Edit,
and selects the Eastern datacenter site from the Site drop-down menu.
5To move Central Pod 1 to the site for the Central datacenter, the Horizon administrator selects View
> Sites, selects the site that currently contains Central Pod 1, selects Central Pod 1, clicks
Edit, and selects the Central datacenter site from the Site drop-down menu.
6To move Central Pod 2 to the site for the Central datacenter, the Horizon administrator selects View
> Sites, selects the site that currently contains Central Pod 2, selects Central Pod 2, clicks
Edit, and selects the Central datacenter site from the Site drop-down menu.
The pod federation site topology now reects the geographic distribution of pods in the insurance
company's network.
Creating Global Desktop Entitlements in the Example Configuration
The Horizon administrator uses Horizon Administrator to create a single global desktop entitlement that
entitles all sales agents to all desktops in the sales agent desktop pools across all pods in the pod federation.
1To create and add users to the global desktop entitlement, the Horizon administrator logs in to the
Horizon Administrator user interface for a Connection Server in the pod federation, selects Catalog >Global Entitlements, clicks Add, and selects Desktop Entitlement.
28 VMware, Inc.
Page 29
Chapter 3 Setting Up a Cloud Pod Architecture Environment
The Horizon administrator adds the Sales Agents group to the global desktop entitlement. The Sales
Agent group is dened in Active Directory and contains all sales agent users. Adding the Sales Agent
group to the Agent Sales global desktop entitlement enables sales agents to access the Sales A and Sales
B desktop pools on the pods in the Eastern and Central regions.
2To add the desktop pools in East Pod 1 to the global desktop entitlement, the Horizon administrator
logs in to the Horizon Administrator user interface for a Connection Server instance in East Pod 1,
selects Catalog > Global Entitlements, double-clicks the global desktop entitlement, clicks Add on the
Local Pools tab, selects the desktop pools to add, and clicks Add.
3To add the desktop pools in Central Pod 1 to the global desktop entitlement, the Horizon administrator
logs in to the Horizon Administrator user interface for a Connection Server instance in Central Pod 1,
selects Catalog > Global Entitlements, double-clicks the global desktop entitlement, clicks Add on the
Local Pools tab, selects the desktop pools to add, and clicks Add.
4To add the desktop pools in Central Pod 2 to the global desktop entitlement, the Horizon administrator
logs in to the Horizon Administrator user interface for a Connection Server instance in Central Pod 2,
selects Catalog > Global Entitlements, double-clicks the global desktop entitlement, clicks Add on the
Local Pools tab, selects the desktop pools to add, and clicks Add.
Creating a URL for the Example Configuration
The insurance company uses a single URL and employs a DNS service to resolve sales.example to the
nearest pod in the nearest data center. With this arrangement, sales agents do not need to remember
dierent URLs for each pod and are always directed to the nearest data center, regardless of where they are
located.
When a sales agent connects to the URL in Horizon Client, the Agent Sales global entitlement appears on the
list of available desktop pools. When a sales agent selects the global desktop entitlement, the Cloud Pod
Architecture feature delivers the nearest available desktop in the pod federation. If all of the desktops in the
local data center are in use, the Cloud Pod Architecture feature selects a desktop from the other data center.
If a sales agent leaves a desktop session logged in, the Cloud Pod Architecture feature returns the sales
agent to that desktop, even if the sales agent has since traveled to a dierent region.
VMware, Inc. 29
Page 30
Administering Cloud Pod Architecture in Horizon 7
30 VMware, Inc.
Page 31
Managing a Cloud Pod Architecture
Environment4
You use Horizon Administrator and the lmvutil command to view, modify, and maintain your Cloud Pod
Architecture environment. You can also use Horizon Administrator to monitor the health of pods in the pod
federation.
This chapter includes the following topics:
“View a Cloud Pod Architecture Conguration,” on page 31
n
“View Pod Federation Health in Horizon Administrator,” on page 32
n
“View Desktop and Application Sessions in the Pod Federation,” on page 33
n
“Add a Pod to a Site,” on page 33
n
“Modifying Global Entitlements,” on page 34
n
“Managing Home Site Assignments,” on page 37
n
“Remove a Pod From the Pod Federation,” on page 39
n
“Uninitialize the Cloud Pod Architecture Feature,” on page 39
n
View a Cloud Pod Architecture Configuration
You can use Horizon Administrator or the lmvutil command to view information about global entitlements,
pods, sites, and home sites.
This procedure shows how to use Horizon Administrator to view information about global entitlements,
pods, sites, and home sites. To use the lmvutil command to view this information, see Chapter 5, “lmvutil
Command Reference,” on page 41.
This procedure also shows how to use the lmvutil command to list the tags associated with a global
entitlement. Horizon Administrator does not show the tags associated with a global entitlement.
Procedure
To list all of the global entitlements in your conguration, in Horizon Administrator, select Catalog >
n
Global Entitlements.
You can use the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
To list the desktop or application pools in a global entitlement, in Horizon Administrator, select Catalog
n
> Global Entitlements, double-click the global entitlement name, and click the Local Pools tab.
Only the pools in the local pod appear on the Local Pools tab. If a global entitlement includes desktop
or application pools in a remote pod, you must log in to the Horizon Administrator user interface for a
Connection Server instance in the remote pod to see those pools.
VMware, Inc.
31
Page 32
Administering Cloud Pod Architecture in Horizon 7
To list the users or groups associated with a global entitlement, in Horizon Administrator, select
n
Catalog > Global Entitlements, double-click the global entitlement, and click the Users and Groups
tab.
You can use the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
To see the global entitlements that are assigned to a specic user, use the Horizon Help Desk Tool. The
n
Horizon Help Desk Tool is a Web application that you can use to get the status of Horizon 7 user
sessions and to perform troubleshooting and maintenance operations.
For more information, see the View Administration document.
To list the pods in the pod federation, in Horizon Administrator, select View > Cloud
n
Pod Architecture.
You can use the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
To list the sites in the pod federation, in Horizon Administrator, select View > Sites.
n
You can use the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
To list the home sites for a user by global entitlement, perform these steps in Horizon Administrator.
n
aSelect Users and Groups, click the Home Site tab, and select Resolution.
bClick inside the Click here to the user text box.
cSelect one or more search criteria and click Find to lter the Active Directory users based on your
search criteria.
dSelect the Active Directory user and click OK.
eClick Look Up to display the home sites for the user.
The global entitlement name appears in the Entitlement column and the eective home site for the
global entitlement appears in the Home Site Resolution column. The origin of a home site assignment
appears in parentheses after the home site name. If a user has multiple home sites, a folder icon appears
next to the global entitlement name. You can expand this folder to list the home site assignments that
are not in eect for the global entitlement.
To list the tags that are associated with a global entitlement, select Catalog > Global Entitlements,
n
double-click the global entitlement, and click the Summary tab.
The tags that are associated with the global entitlement appear in the Connection Server restrictions
eld.
View Pod Federation Health in Horizon Administrator
Horizon constantly monitors the health of the pod federation by checking the health of each pod and
Connection Server instances in those pods. You can view the health of a pod federation in Horizon
Administrator.
You can also view the health of a pod federation from the command line by using the vdmadmin command
with the -H option. For information about vdmadmin syntax, see the View Administration document.
I Horizon event databases are not shared across pods in a pod federation.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
32 VMware, Inc.
Page 33
Chapter 4 Managing a Cloud Pod Architecture Environment
The Remote Pods section in the System Health pane lists all pods, their member Connection Server
instances, and the known health status for each Connection Server instance.
A green health icon indicates that the Connection Server instance is online and available for the Cloud Pod
Architecture feature. A red health icon indicates that the Connection Server instance is oine or the Cloud
Pod Architecture feature cannot connect to the Connection Server instance to conrm its availability.
View Desktop and Application Sessions in the Pod Federation
You can use Horizon Administrator to search for and view desktop and application sessions across the pod
federation.
You can search for desktop and application sessions by user, pod, or brokering pod. The user is the end user
who is connected to the desktop or application, the pod is the pod on which the desktop or application is
hosted, and the brokering pod is the pod to which the user was connected when the desktop or application
was rst allocated.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
The search results include the user, type of session (desktop or application), machine, pool or farm, pod,
brokering pod ID, site, and global entitlements associated with each session. The session start time,
duration, and state also appear in the search results.
N The brokering pod ID is not immediately populated for new sessions in the search results. This ID
usually appears in Horizon Administrator between two and three minutes after a session begins.
Add a Pod to a Site
aSelect User from the drop-down menu.
b Click in the text box.
cSelect search criteria in the Find User dialog box and click OK.
d Click Search to begin the search.
aSelect Pod from the drop-down menu and select a pod from the list of
pods that appears.
b Click Search to begin the search.
aSelect Brokering Pod from the drop-down menu and select a pod from
the list of pods that appears.
b Click Search to begin the search.
You can use Horizon Administrator to add a pod to an existing site.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
3Select the site that currently contains the pod to add to the site.
The names of the pods in the site appear in the lower pane.
4Select the pod to add to the site and click Edit.
5Select the site from the Site drop-down menu and click OK.
Modifying Global Entitlements
You can add and remove pools, users, and groups from global entitlements. You can also delete global
entitlements and modify global entitlement aributes and policies.
For information about adding a pool to a global entitlement, see “Add a Pool to a Global Entitlement,” on
page 22.
Remove a Pool from a Global Entitlement
You can use Horizon Administrator to remove a pool from a global entitlement.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod that
contains the pool to remove.
2In Horizon Administrator, select Catalog > Global Entitlements.
3On the Local Pools tab, select the pool to remove from the global entitlement and click Delete.
Add a User or Group to a Global Entitlement
You can use Horizon Administrator to add a user or group to an existing global entitlement.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements and double-click the global
entitlement.
3On the Users and Groups tab, click Add.
4Click Add, select one or more search criteria, and click Find to lter Active Directory users or groups
based on your search criteria.
You can select the Unauthenticated Users check box to nd and add unauthenticated access users to
global application entitlements. You cannot add unauthenticated access users to global desktop
entitlements. If you aempt to add an unauthenticated access user to a global desktop entitlement,
Horizon Administrator returns an error message.
5Select the Active Directory user or group to add to the global entitlement and click OK.
You can press the Ctrl and Shift keys to select multiple users and groups.
Remove a User or Group From a Global Entitlement
You can use Horizon Administrator to remove a user or group from a global entitlement.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
34 VMware, Inc.
Page 35
Chapter 4 Managing a Cloud Pod Architecture Environment
2In Horizon Administrator, select Catalog > Global Entitlements and double-click the global
entitlement.
3On the Users and Groups tab, select the user or group to delete and click Delete.
You can press Ctrl or Shift to select multiple users and groups.
4Click OK in the conrmation dialog box.
Modify Attributes or Policies for a Global Entitlement
You can use Horizon Administrator to modify the name, description, aributes, tags, scope, and other
policies of a global entitlement.
You cannot modify the type of desktop pool that a global desktop entitlement can contain.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements.
3Select the global entitlement and click Edit.
4To modify the name or description of the global entitlement, type a new name or description in the
Name or Description text box in the General pane.
The name can contain between 1 and 64 characters. The description can contain between 1 and 1024
characters.
5To remove or modify the tags that are associated with the global entitlement, click Browse.
You can select No restrictions to remove all of the existing tags, or you can select Restricted to thesetags to associate the global entitlement with dierent tags. Only the Connection Server instances that
have the selected tags can access the global entitlement.
N You can only select tags assigned to Connection Server instances in the local pod. To select tags
assigned to Connection Server instances in another pod, you must log in to Horizon Administrator for a
Connection Server instance in the other pod and modify the global entitlement again.
6To modify a global entitlement policy, select or deselect the policy in the Policy pane.
PolicyDescription
Scope
Use home site
Entitled user must have home site
Species where to look for desktops or applications that satisfy a desktop
or application request from the global entitlement. You can select only one
scope policy.
All sites - look for desktops or applications on any pod in the pod
n
federation.
Within site - look for desktops or applications only on pods in the
n
same site as the pod to which the user is connected.
Within pod - look for desktops or applications only in the pod to
n
which the user is connected.
Determines whether to begin searching for desktops or applications in the
user's home site. If the user does not have a home site and the Entitleduser must have home site option is not selected, the site to which the user
is currently connected is assumed to be the home site.
Makes the global entitlement available only if the user has a home site.
This option is available only when the Use home site option is selected.
VMware, Inc. 35
Page 36
Administering Cloud Pod Architecture in Horizon 7
PolicyDescription
Automatically clean up redundant
sessions
Default display protocol
HTML Access
Allow user to initiate separate
sessions from different client
devices
Pre-launch
7To modify the application path, version, and publisher information for a global application entitlement,
type values in the application text boxes.
Logs o extra user sessions for the same entitlement.. This option is
available only for oating desktop entitlements and application
entitlements.
Multiple sessions can occur when a pod that contains a session goes
oine, 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 select this option, users must manually end their own extra
sessions, either by logging o in Horizon Client or by launching the
sessions and logging them o.
Species the default display protocol for desktops or applications in the
global entitlement.
Determines whether to allow users to use the HTML Access feature to
access desktops or applications in the global entitlement. When you enable
the HTML Access policy, end users can use a Web browser to connect to
remote desktops and are not required to install any client software on their
local systems.
Determines whether to allow users to initiate separate desktop sessions
from dierent client devices. When you enable the multiple sessions per
user policy, users that connect to the global entitlement from dierent
client devices receive dierent 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. You can enable this policy only for oating desktop
entitlements.
N If you enable this policy, all the desktop pools in the global
entitlement must also support multiple sessions per user.
Determines whether to launch 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.
N If you enable this policy, all the application pools in the global
application entitlement must also support the session pre-launch feature,
and the pre-launch session timeout must be the same for all farms.
N If you add an application pool to the global application entitlement after you modify these
values, the values are overwrien with values from the application pool.
8Click OK to save your changes.
Delete a Global Entitlement
You can use Horizon Administrator to permanently delete a global entitlement. When you delete a global
entitlement, all of the users who are dependent on that global entitlement for desktops cannot access their
desktops. Existing desktop sessions remain connected.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements.
3Click the global entitlement to delete and click Delete.
36 VMware, Inc.
Page 37
4Click OK in the conrmation dialog box.
Managing Home Site Assignments
You can modify and delete home site assignments. You can also display the eective home site for each
global entitlement to which a user belongs.
Modify a Home Site Assignment
You can change an existing home site assignment for a specic user or group.
To modify the association between a global entitlement and a home site for a specic user or group, see
“Modify a Home Site Override,” on page 38.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Users and Groups, click the Home Site tab, and select Assignment.
3Select the home site assignment to modify and click Edit.
4Select a dierent home site from the Home Site drop-down menu.
Chapter 4 Managing a Cloud Pod Architecture Environment
5Click OK to save the new home site assignment.
Remove a Home Site Assignment
You can remove the association between a user or group and a home site.
To remove the association between a home site and a global entitlement for a specic user or group, see
“Remove a Home Site Override,” on page 38.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Users and Groups, click the Home Site tab, and select Assignment.
3Select the home site assignment to remove and click Delete.
4Click OK to remove the home site assignment.
Determine the Effective Home Site for a User
Because you can assign home sites to both users and groups, a single user can have multiple home sites. In
addition, home sites associated with global entitlements can override a user's own home site. You can use
Horizon Administrator to determine a user's eective home site.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Users and Groups, click the Home Site tab, and select Resolution.
3Click inside the Click here to the user text box.
4Select one or more search criteria and click Find to lter the Active Directory users based on your
search criteria.
5Select the Active Directory user whose eective home site you want to display and click OK.
VMware, Inc. 37
Page 38
Administering Cloud Pod Architecture in Horizon 7
6Click Look Up.
Horizon Administrator displays the eective home site for each global entitlement to which the user
belongs. Only global entitlements that have the Use home site policy enabled are displayed.
The home site that is in eect appears in the Home Site Resolution column. If a user has multiple home sites,
a folder icon appears next to the global entitlement name in the Entitlement column. You can expand this
folder to list the home site assignments that are not in eect for the global entitlement. Horizon
Administrator uses strikethrough text to indicate a home site is not in eect.
Horizon Administrator displays the origin of a home site assignment in parentheses after the home site
name in the Home Site Resolution column. If the home site originated from a group in which the user
belongs, Horizon Administrator displays the name of the group, for example, (via Domain Users). If the
home site originated from the user's own home site assignment, Horizon Administrator displays (Default).
If the home site originated from the global entitlement (a home site override), Horizon Administrator
displays (Direct).
If a user does not have a home site, Horizon Administrator displays No home site in the Home Site
Resolution column.
Modify a Home Site Override
You can change the association between a global entitlement and a home for site for a specic user or group.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements.
3Double-click the global entitlement.
4On the Home Site Override tab, select the user or group and click Edit.
5Select a dierent home site from the Home Site drop-down menu.
6Click OK to save your changes.
Remove a Home Site Override
You can remove the association between a global entitlement and a home site for a specic user or group.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod
federation.
2In Horizon Administrator, select Catalog > Global Entitlements.
3Double-click the global entitlement.
4On the Home Site Overrides tab, select the user or group and click Remove.
5Click OK to remove the home site override.
38 VMware, Inc.
Page 39
Remove a Pod From the Pod Federation
You can use Horizon Administrator to remove a pod that was previously joined to the pod federation. You
might want to remove a pod from the pod federation if it is being recommissioned for another purpose or if
it was wrongly congured.
To remove the last pod in the pod federation, you uninitialize the Cloud Pod Architecture feature. See
“Uninitialize the Cloud Pod Architecture Feature,” on page 39.
I Do not stop or start a Connection Server instance while it is being removed from a pod
federation. The Connection Server service might not restart correctly.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod that
you want to remove from the pod federation.
2In Horizon Administrator, select Cloud Pod Architecture and click Unjoin in the Pod Federation pane.
3Click OK to begin the unjoin operation.
Horizon Administrator shows the progress of the unjoin operation.
4When Horizon Administrator prompts you to reload the client, click OK.
Chapter 4 Managing a Cloud Pod Architecture Environment
After the Horizon Administrator user interface is refreshed, Global Entitlements no longer appears
under Catalog and Sites no longer appears under View in the Horizon Administrator
Inventory panel.
Uninitialize the Cloud Pod Architecture Feature
You can use Horizon Administrator to uninitialize the Cloud Pod Architecture feature.
Prerequisites
You need to uninitialize the Cloud Pod Architecture feature on only one pod in the pod federation. If the
pod federation contains multiple pods, you must unjoin the other pods before you begin the uninitialization
process. See “Remove a Pod From the Pod Federation,” on page 39.
Procedure
1Log in to the Horizon Administrator user interface for any Connection Server instance in the pod.
2In Horizon Administrator, select View > Cloud Pod Architecture.
3In the Pod Federation pane, click Uninitialize.
4Click OK to begin the uninitialization process.
After the uninitialization process is nished, your entire Cloud Pod Architecture conguration,
including sites, home sites, and global entitlements, is deleted.
5When Horizon Administrator prompts you to reload the client, click OK.
After the Horizon Administrator user interface is refreshed, Global Entitlements no longer appears
under Catalog and Sites no longer appears under View in the Horizon Administrator
Inventory panel.
VMware, Inc. 39
Page 40
Administering Cloud Pod Architecture in Horizon 7
40 VMware, Inc.
Page 41
lmvutil Command Reference5
You use the lmvutil command-line interface to congure and manage a Cloud Pod Architecture
implementation.
N You can use the vdmutil command-line interface to perform the same operations as lmvutil.
This chapter includes the following topics:
“lmvutil Command Use,” on page 41
n
“Initializing the Cloud Pod Architecture Feature,” on page 44
n
“Disabling the Cloud Pod Architecture Feature,” on page 45
n
“Managing Pod Federations,” on page 45
n
“Managing Sites,” on page 47
n
“Managing Global Entitlements,” on page 50
n
“Managing Home Sites,” on page 58
n
“Viewing a Cloud Pod Architecture Conguration,” on page 60
n
“Managing SSL Certicates,” on page 65
n
lmvutil Command Use
The syntax of the lmvutil command controls its operation.
Use the following form of the lmvutil command from a Windows command prompt.
Alternatively, you can use the vdmutil command to perform the same operations as the lmvutil command.
Use the following form of the vdmutil command from a Windows command prompt.
The additional options that you can use depend on the command option.
By default, the path to the lmvutil and vdmutil command executable les is C:\Program
Files\VMware\VMware View\Server\tools\bin. To avoid entering the path on the command line, add the
path to your PATH environment variable.
VMware, Inc.
41
Page 42
Administering Cloud Pod Architecture in Horizon 7
lmvutil Command Authentication
To use the lmvutil command to congure and manage a Cloud Pod Architecture environment, you must
run the command as a user who has the Administrators role.
You can use Horizon Administrator to assign the Administrators role to a user. See the View Administration
document.
The lmvutil command includes options to specify the user name, domain, and password to use for
authentication.
Table 5‑1. lmvutil Command Authentication Options
OptionDescription
--authAs
--authDomain
--authPasswordPassword for the Horizon administrator user specied in the --authAs option.
Name of a Horizon administrator user. Do not use domain\username or user principal
name (UPN) format.
Fully qualied domain name for the Horizon administrator user specied in the
--authAs option.
Entering "*" instead of a password causes the lmvutil command to prompt for the
password and does not leave sensitive passwords in the command history on the
command line.
For example, the following lmvutil command logs in the user domainEast\adminEast and initializes the
Cloud Pod Architecture feature.
You must use the authentication options with all lmvutil command options except for --help and
--verbose.
lmvutil Command Output
The lmvutil command returns 0 when an operation succeeds and a failure-specic non-zero code when an
operation fails.
The lmvutil command writes error messages to standard error. When an operation produces output, or
when verbose logging is enabled by using the --verbose option, the lmvutil command writes output to
standard output.
The lmvutil command produces only US English output.
lmvutil Command Options
You use the command options of the lmvutil command to specify the operation to perform. All options are
preceded by two hyphens (--).
For lmvutil command authentication options, see “lmvutil Command Authentication,” on page 42.
Table 5‑2. lmvutil Command Options
OptionDescription
--activatePendingCertificate
--addGroupEntitlement
Activates a pending SSL certicate. See “Activating a
Pending Certicate,” on page 65.
Associates a user group with a global entitlement. See
“Adding a User or Group to a Global Entitlement,” on
page 57.
42 VMware, Inc.
Page 43
Chapter 5 lmvutil Command Reference
Table 5‑2. lmvutil Command Options (Continued)
OptionDescription
--addPoolAssociation
--addUserEntitlement
--assignPodToSite
--createGlobalApplicationEntitlement
--createGlobalEntitlement
--createSite
--createGroupHomeSite
--createPendingCertificate
--createUserHomeSite
--deleteGlobalApplicationEntitlement
--deleteGlobalEntitlement
--deleteSite
--deleteGroupHomeSite
--deleteUserHomeSite
--editSite
--ejectPod
--helpLists the lmvutil command options.
--initialize
--join
--listAssociatedPools
--listEntitlements
--listGlobalApplicationEntitlements
--listGlobalEntitlements
Associates a desktop pool with a global desktop
entitlement or an application pool with a global application
entitlement. See “Adding a Pool to a Global Entitlement,”
on page 55.
Associates a user with a global entitlement. See “Adding a
User or Group to a Global Entitlement,” on page 57
Assigns a pod to a site. See “Assigning a Pod to a Site,” on
page 48.
Creates a global application entitlement. See “Creating a
Global Entitlement,” on page 50.
Creates a global desktop entitlement. See “Creating a
Global Entitlement,” on page 50.
Creates a site. See “Creating a Site,” on page 48.
Associates a user group with a home site. See “Conguring
a Home Site,” on page 59.
Creates a pending SSL certicate. See “Creating a Pending
Certicate,” on page 65.
Associates a user with a home site. See “Conguring a
Home Site,” on page 59.
Deletes a global application entitlement. See “Deleting a
Global Entitlement,” on page 55.
Deletes a global deskop entitlement. See “Deleting a Global
Entitlement,” on page 55.
Deletes a site. See “Deleting a Site,” on page 49.
Removes the association between a user group and a home
site. See “Deleting a Home Site,” on page 60.
Removes the association between a user and a home site.
See “Deleting a Home Site,” on page 60.
Modies the name or description of a site. See “Changing a
Site Name or Description,” on page 49.
Removes an unavailable pod from a pod federation. See
“Removing a Pod From a Pod Federation,” on page 46.
Initializes the Cloud Pod Architecture feature. See
“Initializing the Cloud Pod Architecture Feature,” on
page 44.
Joins a pod to a pod federation. See “Joining a Pod to the
Pod Federation,” on page 46.
Lists the desktop pools that are associated with a global
desktop entitlement or the application pools that are
associated with a global application entitlement. See
“Listing the Pools in a Global Entitlement,” on page 61.
Lists associations between users or user groups and global
entitlements. “Listing the Users or Groups in a Global
Entitlement,” on page 62.
Lists all global application entitlements. See “Listing Global
Entitlements,” on page 61.
Lists all global desktop entitlements. See “Listing Global
Entitlements,” on page 61.
VMware, Inc. 43
Page 44
Administering Cloud Pod Architecture in Horizon 7
Table 5‑2. lmvutil Command Options (Continued)
OptionDescription
--listPods
--listSites
--listUserAssignments
--removePoolAssociation
--resolveUserHomeSite
--removeGroupEntitlement
--removeUserEntitlement
--showGroupHomeSites
--showUserHomeSites
--uninitialize
--unjoin
--updateGlobalApplicationEntitlement
--updateGlobalEntitlement
--updatePod
--verbose
Lists the pods in a Cloud Pod Architecture topology. See
“Listing the Pods or Sites in a Cloud Pod Architecture
Topology,” on page 64.
Lists the sites in a Cloud Pod Architecture topology. See
“Listing the Pods or Sites in a Cloud Pod Architecture
Topology,” on page 64.
Lists the dedicated desktop pod assignments for a user and
global entitlement combination. See “Listing Dedicated
Desktop Pool Assignments,” on page 64.
Removes the association between a desktop pool and a
global entitlement. See “Removing a Pool from a Global
Entitlement,” on page 56.
Shows the eective home site for a user. See “Listing the
Eective Home Site for a User,” on page 63.
Removes a user group from a global entitlement. See
“Removing a User or Group From a Global Entitlement,”
on page 58.
Removes a user from a global entitlement. See “Removing
a User or Group From a Global Entitlement,” on page 58.
Shows all of the home sites for a group. See “Listing the
Home Sites for a User or Group,” on page 62.
Shows all of the home sites for a user. See “Listing the
Home Sites for a User or Group,” on page 62.
Disables the Cloud Pod Architecture feature. See
“Disabling the Cloud Pod Architecture Feature,” on
page 45.
Removes an available pod from a pod federation. See
“Removing a Pod From a Pod Federation,” on page 46.
Modifes a global application entitlement. See “Modifying a
Global Entitlement,” on page 53.
Modies a global desktop entitlement. See “Modifying a
Global Entitlement,” on page 53.
Modies the name or description of a pod. See “Changing
a Pod Name or Description,” on page 47.
Enables verbose logging. You can add this option to any
other option to obtain detailed command output. The
lmvutil command writes to standard output.
Initializing the Cloud Pod Architecture Feature
Use the lmvutil command with the --initialize option to initialize the Cloud Pod Architecture feature.
When you initialize the Cloud Pod Architecture feature, Horizon sets up the Global Data Layer on each
Connection Server instance in the pod and congures the VIPA communication channel.
Syntax
lmvutil --initialize
44 VMware, Inc.
Page 45
Usage Notes
Run this command only once, on one Connection Server instance in the pod. You can run the command on
any Connection Server instance in the pod. You do not need to run this command for additional pods. All
other pods join the initialized pod.
This command returns an error message if the Cloud Pod Architecture feature is already initialized or if the
command cannot complete the operation.
Use the lmvutil command with the --uninitialize option to disable the Cloud Pod Architecture feature.
Syntax
lmvutil --uninitialize
Chapter 5 lmvutil Command Reference
Usage Notes
Before you run this command, use the lmvutil command with the --unjoin option to remove any other
pods in the pod federation.
Run this command on only one Connection Server instance in a pod. You can run the command on any
Connection Server instance in the pod. If your pod federation contains multiple pods, you need to run this
command for only one pod.
This command returns an error message if the Cloud Pod Architecture feature is not initialized, if the
command cannot nd the pod, or if the pod federation contains other pods.
You must run this command on each pod that you want to join to the pod federation. You can run the
command on any Connection Server instance in a pod.
This command returns an error message if you provide invalid credentials, the specied Connection Server
instance does not exist, a pod federation does not exist on the specied server, or the command cannot
complete the operation.
Options
You must specify several options when you join a pod to a pod federation.
Table 5‑3. Options for Joining a Pod to a Pod Federation
OptionDescription
--joinServer
--userName
--passwordPassword of the user specied in the --userName option.
DNS name or IP address of any Connection Server instance in any pod that has been
initialized or is already part of the pod federation.
Name of a Horizon administrator user on the already initialized pod. Use the format
domain\username.
Use the lmvutil command with the --unjoin or --ejectPod option to remove a pod from a pod
federation.
Syntax
lmvutil --unjoin
lmvutil --ejectPod --pod pod
Usage Notes
To remove a pod from a pod federation, use the --unjoin option. You can run the command on any
Connection Server instance in the pod.
To remove a pod that is not available from a pod federation, use the --ejectPod option. For example, a pod
might become unavailable if a hardware failure occurs. You can perform this operation on any pod in the
pod federation.
I In most circumstances, you should use the --unjoin option to remove a pod from a pod
federation.
46 VMware, Inc.
Page 47
Chapter 5 lmvutil Command Reference
These commands return an error message if the Cloud Pod Architecture feature is not initialized, the pod is
not joined to a pod federation, or if the commands cannot perform specied operations.
Options
When you use the --ejectPod option, you use the --pod option to identify the pod to remove from the pod
federation.
This command returns an error message if the Cloud Pod Architecture feature is not initialized, the specied
site already exists, or the command cannot create the site.
Options
You can specify these options when you create a site.
Table 5‑5. Options for Creating a Site
OptionDescription
--siteName
--description
Name of the new site. The site name can contain between 1 and 64 characters.
(Optional) Description of the site. The description can contain between 1 and 1024
characters.
Before you can assign a pod to a site, you must create the site. See “Creating a Site,” on page 48.
This command returns an error message if the Cloud Pod Architecture feature is not initialized, the
command cannot nd the specied pod or site, or if the command cannot assign the pod to the site.
Options
You must specify these options when you assign a pod to a site.
48 VMware, Inc.
Page 49
Chapter 5 lmvutil Command Reference
Table 5‑6. Options for Assigning a Pod to a Site
OptionDescription
--podName
--siteName
Name of the pod to assign to the site.
Name of the site.
You can use the lmvutil command with the --listPods option to list the names of the pods in a Cloud Pod
Architecture topology. See “Listing the Pods or Sites in a Cloud Pod Architecture Topology,” on page 64.
You can use lmvutil command options to create, modify, and list global desktop entitlements and global
application entitlements in a Cloud Pod Architecture environment.
Creating a Global Entitlement on page 50
n
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.
Modifying a Global Entitlement on page 53
n
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.
Deleting a Global Entitlement on page 55
n
To delete a global desktop entitlement, use the lmvutil command with the
--deleteGlobalEntitlement option. To delete a global application entitlement, use the lmvutil
command with the --deleteGlobalApplicationEntitlement option.
Adding a Pool to a Global Entitlement on page 55
n
Use the lmvutil command with the --addPoolAssociation option to add a desktop pool to a global
desktop entitlement or an application pool to a global application entitlement.
Removing a Pool from a Global Entitlement on page 56
n
Use the lmvutil command with the --removePoolAssociation option to remove a desktop pool
from a global desktop entitlement or an application pool from a global application entitlement.
Adding a User or Group to a Global Entitlement on page 57
n
To add a user to a global entitlement, use the lmvutil command with the --addUserEntitlement
option. To add a group to a global entitlement, use the lmvutil command with the
--addGroupEntitlement option.
Removing a User or Group From a Global Entitlement on page 58
n
To remove a user from a global entitlement, use the lmvutil command with the
--removeUserEntitlement option. To remove a group from a global entitlement, use the lmvutil
command with the --removeGroupEntitlement option.
Creating a Global Entitlement
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.
50 VMware, Inc.
Page 51
Chapter 5 lmvutil Command Reference
Syntax
lmvutil --createGlobalEntitlement --entitlementName name --scope scope
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 5‑8. Options for Creating Global Entitlements
OptionDescription
--entitlementName
--scope
--isDedicated
--isFloating
--disabled
--description
--fromHome
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 of the global entitlement. Valid values are as follows:
ANY. Horizon looks for resources on any pod in the pod federation.
n
SITE. Horizon looks for resources only on pods in the same site as the
n
pod to which the user is connected.
LOCAL. Horizon looks for resources only in the pod to which the
n
user is connected.
Creates a dedicated desktop entitlement. A dedicated desktop entitlement
can contain only dedicated desktop pools. To create a oating desktop
entitlement, use the --isFloating option. A global desktop entitlement
can be either dedicated or oating. You cannot specify the
--isDedicated option with the --multipleSessionAutoClean option.
Applies only to global desktop entitlements.
Creates a oating desktop entitlement. A oating desktop entitlement can
contain only oating desktop pools. To create a dedicated desktop
entitlement, specify the --isDedicated option. A global desktop
entitlement can be either oating or dedicated.
Applies only to global desktop entitlements.
(Optional) Creates the global entitlement in the disabled state.
(Optional) Description of the global entitlement. The description can
contain between 1 and 1024 characters.
(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.
VMware, Inc. 51
Page 52
Administering Cloud Pod Architecture in Horizon 7
Table 5‑8. Options for Creating Global Entitlements (Continued)
OptionDescription
--multipleSessionAutoClean
--requireHomeSite
--defaultProtocol
--preventProtocolOverride
--allowReset
--htmlAccess
--multipleSessionsPerUser
--preLaunch
--tags
(Optional) Logs o extra user sessions for the same entitlement. Multiple
sessions can occur when a pod that contains a session goes oine, 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 o in Horizon Client or by launching the
sessions and logging them o.
(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 specied.
(Optional) Species 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.
(Optional) Prevents users from overriding the default display protocol.
(Optional) Allows users to reset desktops. Applies only to global desktop
entitlements.
(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.
(Optional) Enables the multiple sessions per user policy, which allows
users to initiate separate desktop sessions from dierent client devices.
Users that connect to the global desktop entitlement from dierent client
devices receive dierent 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 oating desktop entitlements.
(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.
(Optional) Species 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 “Restricting Access to Global Entitlements,” on
page 13.
createGlobalApplicationEntitlement --entitlementName "Microsoft Office PowerPoint" --scope LOCAL
52 VMware, Inc.
Page 53
Chapter 5 lmvutil Command Reference
Modifying a Global Entitlement
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]
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 5‑9. Options for Modifying Global Entitlements
OptionDescription
--entitlementName
--scope
--description
--disabled
--enabled
--fromHome
--disableFromHome(Optional) Disables the --fromHome function for the global entitlement.
Name of the global entitlement to modify.
Scope of the global entitlement. Valid values are as follows:
ANY. Horizon looks for resources on any pod in the pod federation.
n
SITE. Horizon looks for resources only on pods in the same site as
n
the pod to which the user is connected.
LOCAL. Horizon looks for resources only in the pod to which the
n
user is connected.
(Optional) Description of the global entitlement. The description can
contain between 1 and 1024 characters.
(Optional) Disables a previously enabled global entitlement.
(Optional) Enables a previously disabled global entitlement.
(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.
VMware, Inc. 53
Page 54
Administering Cloud Pod Architecture in Horizon 7
Table 5‑9. Options for Modifying Global Entitlements (Continued)
OptionDescription
--multipleSessionAutoClean
--disableMultipleSessionAutoClean(Optional) Disables the --multipleSessionAutoClean function for the
--multipleSessionsPerUser
--disableMultipleSessionsPerUser
--requireHomeSite
--disableRequireHomeSite(Optional) Disables the --requireHomeSite function for the global
--defaultProtocol
--htmlAccess
--disableHtmlAccess
--appVersion
--appPublisher
--appPath(Optional) Full pathname of the application, for example, C:\Program
--tags
--notags
(Optional) Logs o extra user sessions for the same entitlement.
Multiple sessions can occur when a pod that contains a session goes
oine, 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 o in Horizon Client or by launching
the sessions and logging them o.
global entitlement.
(Optional) Enables the multiple sessions per user policy, which allows
users to initiate separate desktop sessions from dierent client devices.
Users that connect to the global desktop entitlement from dierent client
devices receive dierent 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 oating desktop entitlements.
(Optional) Disables the multiple sessions per user policy for the global
desktop entitlement.
(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 specied.
entitlement.
(Optional) Species 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.
(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.
(Optional) Disables the HTML Access policy for the global entitlement.
(Optional) Version of the application.
Applies only to global application entitlements.
(Optional) Publisher of the application.
Applies only to global application entitlements.
Files\app1.exe.
Applies only to global application entitlements.
(Optional) Species 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 “Restricting Access to Global Entitlements,” on
page 13.
(Optional) Removes tags from the global entitlement.
54 VMware, Inc.
Page 55
Chapter 5 lmvutil Command Reference
Table 5‑9. Options for Modifying Global Entitlements (Continued)
OptionDescription
--preLaunch
--disablePreLaunch
(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.
(Optional) Disables the pre-launch policy for the global application
entitlement.
--updateGlobalApplicationEntitlement --entitlementName "Microsoft Office PowerPoint" --scope ANY
Deleting a Global Entitlement
To delete a global desktop entitlement, use the lmvutil command with the --deleteGlobalEntitlement
option. To delete a global application entitlement, use the lmvutil command with the
--deleteGlobalApplicationEntitlement option.
Syntax
lmvutil --deleteGlobalEntitlement --entitlementName name
lmvutil --deleteGlobalApplicationEntitlement --entitlementName name
Command Usage
These commands return an error message if the specied global entitlement does not exist, the Cloud Pod
Architecture feature is not initialized, or the commands cannot delete the global entitlement.
Options
You use the --entitlementName option to specify the name of the global entitlement to delete.
Use the lmvutil command with the --addPoolAssociation option to add a desktop pool to a global
desktop entitlement or an application pool to a global application entitlement.
Syntax
lmvutil --addPoolAssociation --entitlementName name --poolId poolid
VMware, Inc. 55
Page 56
Administering Cloud Pod Architecture in Horizon 7
Usage Notes
You must use this command on a Connection Server instance in the pod that contains the pool. For example,
if pod1 contains a desktop pool to associate with a global desktop entitlement, you must run the command
on a Connection Server instance that resides in pod1.
Repeat this command for each pool to become part of the global entitlement. You can add a particular pool
to only one global entitlement.
I If you add multiple application pools to a global application entitlement, you must add the
same application. For example, do not add Calculator and Microsoft Oce PowerPoint to the same global
application entitlement. If you add dierent applications, the results will be unpredictable and entitled users
will receive dierent applications at dierent times.
This command returns an error message if the Cloud Pod Architecture feature is not initialized, the specied
entitlement does not exist, the pool is already associated with the specied entitlement, the pool does not
exist, or the command cannot add the pool to the global entitlement.
Options
You can specify these options when you add a pool to a global entitlement.
Table 5‑10. Options for Adding a Pool to a Global Entitlement
OptionDescription
--entitlementName
--poolID
Name of the global entitlement.
ID of the pool to add to the global entitlement. The pool ID must match the pool
name as it appears on the pod.
--entitlementName "Windows 8 Desktop" --poolId "Windows 8 Desktop Pool A"
Removing a Pool from a Global Entitlement
Use the lmvutil command with the --removePoolAssociation option to remove a desktop pool from a
global desktop entitlement or an application pool from a global application entitlement.
Syntax
lmvutil --removePoolAssociation --entitlementName name --poolID poolid
Usage Notes
This command returns an error message if the Cloud Pod Architecture feature is not initialized, the specied
global entitlement or pool does not exist, or if the command cannot remove the pool from the global
entitlement.
Options
You can specify these options when you remove a pool from a global entitlement.
56 VMware, Inc.
Page 57
Chapter 5 lmvutil Command Reference
Table 5‑11. Options for Removing a Pool from a Global Entitlement
OptionDescription
--entitlementName
--poolID
Name of the global entitlement.
ID of the pool to remove from the global entitlement. The pool ID must match
the pool name as it appears on the pod.
To add a user to a global entitlement, use the lmvutil command with the --addUserEntitlement option.
To add a group to a global entitlement, use the lmvutil command with the --addGroupEntitlement
option.
Syntax
lmvutil --addUserEntitlement --userName domain\username --entitlementName name
lmvutil --addGroupEntitlement --groupName domain\groupname --entitlementName name
Usage Notes
Repeat these commands for each user or group to add to the global entitlement.
These commands return an error message if the specied entitlement, user, or group does not exist or if the
command cannot add the user or group to the entitlement.
Options
You can specify these options when you add a user or group to a global entitlement.
Table 5‑12. Options for Adding a User or Group to a Global Entitlement
OptionDescription
--userName
--groupName
--entitlementName
Name of a user to add to the global entitlement. Use the format domain\username.
Name of a group to add to the global entitlement. Use the format
domain\groupname.
Name of the global entitlement to which to add the user or group.
Removing a User or Group From a Global Entitlement
To remove a user from a global entitlement, use the lmvutil command with the --removeUserEntitlement
option. To remove a group from a global entitlement, use the lmvutil command with the
--removeGroupEntitlement option.
Syntax
lmvutil --removeUserEntitlement --userName domain\username --entitlementName name
lmvutil --removeGroupEntitlement --groupName domain\groupname --entitlementName name
Usage Notes
These commands return an error message if the Cloud Pod Architecture feature is not initialized, if the
specied user name, group name, or entitlement does not exist, or if the command cannot remove the user
or group from the entitlement.
Options
You must specify these options when you remove a user or group from a global entitlement.
Table 5‑13. Options for Removing a User or Group From a Global Entitlement
OptionDescription
--userName
--groupName
--entitlementName
Name of a user to remove from the global entitlement. Use the format
domain\username.
Name of a group to remove from the global entitlement. Use the format
domain\groupname.
Name of the global entitlement from which to remove the user or group.
You can use lmvutil command options to create, modify, delete, and list home sites.
Conguring a Home Site on page 59
n
To create a home site for a user, use the lmvutil command with the --createUserHomeSite option.
To create a home site for a group, use the lmvutil command with the --createGroupHomeSite
option. You can also use these options to associate a home site with a global desktop entitlement or
global application entitlement.
Deleting a Home Site on page 60
n
To remove the association between a user and a home site, use the lmvutil command with the
--deleteUserHomeSite option. To remove the association between a group and a home site, use the
lmvutil command with the --deleteGroupHomeSite option.
58 VMware, Inc.
Page 59
Chapter 5 lmvutil Command Reference
Configuring a Home Site
To create a home site for a user, use the lmvutil command with the --createUserHomeSite option. To
create a home site for a group, use the lmvutil command with the --createGroupHomeSite option. You
can also use these options to associate a home site with a global desktop entitlement or global application
entitlement.
Syntax
lmvutil --createUserHomeSite --userName domain\username --siteName name [--entitlementName name]
lmvutil --createGroupHomeSite --groupName domain\groupname --siteName name [--entitlementName
name]
Usage Notes
You must create a site before you can congure it as a home site. See “Creating a Site,” on page 48.
These commands return an error message if the Cloud Pod Architecture feature is not initialized, the
specied user or group does not exist, the specied site does not exist, the specied entitlement does not
exist, or the commands cannot create the home site.
Options
You can specify these options when you create a home site for a user or group.
Table 5‑14. Options for Creating a Home Site for a User or Group
OptionDescription
--userName
--groupName
--siteName
--entitlementName
Name of a user to associate with the home site. Use the format
domain\username.
Name of a group to associate with the home site. Use the format
domain\groupname.
Name of the site to associate with the user or group as the home site.
(Optional) Name of a global desktop entitlement or global application
entitlement to associate with the home site. When a user selects the specied
global entitlement, the home site overrides the user's own home site. If you do
not specify this option, the command creates a global user or group home site.
These commands return an error message if the specied user or group does not exist, the specied global
entitlement does not exist, or if the commands cannot delete the home site seing.
Options
You can specify these options when you remove the association between a user or group and a home site.
Table 5‑15. Options for Deleting a Home Site
OptionDescription
--userName
--groupName
--entitlementName
Name of a user. Use the format domain\username.
Name of a group. Use the format domain\groupname.
(Optional) Name of a global desktop entitlement or global application
entitlement. You can use this option to remove the association between the
home site and a global entitlement for the specied user or group.
You can use lmvutil command options to list information about a Cloud Pod Architecture conguration.
Listing Global Entitlements on page 61
n
To list information about all global desktop entitlements, including their policies and aributes, use
the lmvutil command with the --listGlobalEntitlements option. To list information about all
global application entitlements, including their policies and aributes, use the lmvutil command with
the --listGlobalApplicationEntitlements option.
Listing the Pools in a Global Entitlement on page 61
n
Use the lmvutil command with the --listAssociatedPools option to list the desktop or application
pools that are associated with a specic global entitlement.
Listing the Users or Groups in a Global Entitlement on page 62
n
Use the lmvutil command with the --listEntitlements option to list all the users or groups
associated with a specic global entitlement.
60 VMware, Inc.
Page 61
Chapter 5 lmvutil Command Reference
Listing the Home Sites for a User or Group on page 62
n
To list all the congured home sites for a specic user, use the lmvutil command with the
--showUserHomeSites option. To list all the congured home sites for a specic group, use the
lmvutil command with the --showGroupHomeSites option.
Listing the Eective Home Site for a User on page 63
n
Use the lmvutil command with the --resolveUserHomeSite option to determine the eective home
site for a specic user. Because home sites can be assigned to users and groups and to global
entitlements, it is possible to congure more than one home site for a user.
Listing Dedicated Desktop Pool Assignments on page 64
n
Use the lmvutil command with the --listUserAssignments option to to list the dedicated desktop
pool assignments for a user and global entitlement combination.
Listing the Pods or Sites in a Cloud Pod Architecture Topology on page 64
n
To view the pods in the pod federation, use the lmvutil command with the --listPods option. To
view the sites in the pod federation, use the lmvutil command with the --listSites option.
Listing Global Entitlements
To list information about all global desktop entitlements, including their policies and aributes, use the
lmvutil command with the --listGlobalEntitlements option. To list information about all global
application entitlements, including their policies and aributes, use the lmvutil command with the
--listGlobalApplicationEntitlements option.
Syntax
lmvutil --listGlobalEntitlements
lmvutil --listGlobalApplicationEntitlements
Usage Notes
These commands return an error message if the Cloud Pod Architecture feature is not initialized or if the
commands cannot list the global entitlements.
Use the lmvutil command with the --listAssociatedPools option to list the desktop or application pools
that are associated with a specic global entitlement.
Syntax
lmvutil --listAssociatedPools --entitlementName name
Usage Notes
This command returns an error message if the Cloud Pod Architecture feature is not initialized or if the
specied global entitlement does not exist.
VMware, Inc. 61
Page 62
Administering Cloud Pod Architecture in Horizon 7
Options
You use the --entitlementName option to specify the name of the global entitlement for which to list the
associated desktop or application pools.
This command returns an error message if the Cloud Pod Architecture feature is not initialized or if the
specied user, group, or entitlement does not exist.
Options
You can specify these options when you list global entitlement associations.
Table 5‑16. Options for Listing Global Entitlement Associations
OptionDescription
--userName
--groupName
--entitlementName
Name of the user for whom you want to list global entitlements. Use the
format domain\username. This option lists all global entitlements associated
with the specied user.
Name of the group for which you want to list global entitlements. Use the
format domain\groupname. This option lists all global entitlements associated
with the specied group.
Name of a global entitlement. This option lists all users and groups in the
specied global entitlement.
These commands return an error message if the Cloud Pod Architecture feature is not initialized or if the
specied user, group, or global entitlement does not exist.
Options
You can specify these options when you list the home sites for a user or group.
Table 5‑17. Options for Listing the Home Sites for a User or Group
OptionDescription
--userName
--groupName
--entitlementName
Name of a user. Use the format domain\username.
Name of a group. Use the format domain\groupname.
(Optional) Name of a global entitlement. Use this option if you want to show the
home sites for a user or group and global entitlement combination.
Use the lmvutil command with the --resolveUserHomeSite option to determine the eective home site
for a specic user. Because home sites can be assigned to users and groups and to global entitlements, it is
possible to congure more than one home site for a user.
Syntax
lmvutil --resolveUserHomeSite --entitlementName name --userName domain\username
Usage Notes
This command returns an error message if the Cloud Pod Architecture feature is not initialized or if the
specied global entitlement or user does not exist.
Options
You must specify these options when you list the eective home site for a user.
Table 5‑18. Options for Listing the Effective Home Site for a User
OptionDescription
--entitlementName
--userName
Name of a global entitlement. This option enables you to determine the
eective home site for a user and global entitlement combination, which might
be dierent from the home site that is congured for the user.
Name of the user whose home site you want to list. Use the format
domain\username.
Use the lmvutil command with the --listUserAssignments option to to list the dedicated desktop pool
assignments for a user and global entitlement combination.
Syntax
lmvutil --listUserAssignments {--userName domain\username | --entitlementName name | --podName
name | --siteName name}
Usage Notes
The data produced by this command is managed internally by the Cloud Pod Architecture brokering
software.
This command returns an error if the Cloud Pod Architecture feature is not initialized or if the command
cannot nd the specied user, global entitlement, pod, or site.
Options
You must specify one of the following options when you list user assignments.
Table 5‑19. Options for Listing User Assignments
OptionDescription
--userName
--entitlementName
--podName
--siteName
Name of the user for whom you want to list assignments. Use the format
domain\username. This option lists the global entitlement, pod, and site assignments for
the specied user.
Name of a global entitlement. This option lists the users assigned to the specied global
entitlement.
Name of a pod. This option lists the users assigned to the specied pod.
Name of a site. This option lists the users assigned to the specied site.
Listing the Pods or Sites in a Cloud Pod Architecture Topology
To view the pods in the pod federation, use the lmvutil command with the --listPods option. To view the
sites in the pod federation, use the lmvutil command with the --listSites option.
Syntax
lmvutil --listPods
lmvutil --listSites
Usage Notes
These commands return an error message if the Cloud Pod Architecture feature is not initialized or if the
commands cannot list the pods or sites.
You can use lmvutil command options to create and activate pending SSL certicates in a Cloud Pod
Architecture environment.
The Cloud Pod Architecture feature uses signed certicates for bidirectional SSL to protect and validate the
VIPA communication channel. The certicates are distributed in the Global Data Layer. The Cloud Pod
Architecture feature replaces these certicates every seven days.
To change a certicate for a specic Connection Server instance, you create a pending certicate, wait for the
Global Data Layer replication process to distribute the certicate to all Connection Server instances, and
activate the certicate.
The lmvutil command certicate options are intended for use only if a certicate becomes compromised
and a Horizon administrator wants to update the certicate sooner than seven days. These options aect
only the Connection Server instance on which they are run. To change all certicates, you must run the
options on every Connection Server instance.
Chapter 5 lmvutil Command Reference
Creating a Pending Certicate on page 65
n
Use the lmvutil command with the --createPendingCertificate option to create a pending SSL
certicate.
Activating a Pending Certicate on page 65
n
Use the lmvutil command with the --activatePendingCertificate option to activate a pending
certicate.
Creating a Pending Certificate
Use the lmvutil command with the --createPendingCertificate option to create a pending SSL
certicate.
Syntax
lmvutil --createPendingCertificate
Usage Notes
This command returns an error message if the Cloud Pod Architecture feature is not initialized or if the
command cannot create the certicate.
Use the lmvutil command with the --activatePendingCertificate option to activate a pending
certicate.
Syntax
lmvutil --activatePendingCertificate
VMware, Inc. 65
Page 66
Administering Cloud Pod Architecture in Horizon 7
Usage Notes
You must use the lmvutil command with the --createPendingCertificate option to create a pending
certicate before you can use this command. Wait for the Global Data Layer replication process to distribute
the certicate to all Connection Server instances before you activate the pending certicate. VIPA connection
failures and resulting brokering problems can occur if you activate a pending certicate before it is fully
replicated to all Connection Server instances.
This command returns an error message if the Cloud Pod Architecture feature is not initialized or if the
command cannot activate the certicate.