Product Documentation

Clustered license servers

Mar 16, 2015

Cluster servers are groups of computers that are combined to increase availability, reliability, and scalability. Microsoft clustering functionality exists in:

  • Windows Server 2008
  • Windows Server 2008 R2
  • Windows Server 2012
  • Windows Server 2012 R2

Clustering the License Server lets users continue working during failure situations without interrupting their access to critical applications. When the active node in a cluster-enabled License Server suffers from hardware failure, failover occurs automatically. Resources are available again in a few seconds.

A typical cluster configuration has, at a minimum, one active and one passive (backup) server. When the active server in a cluster fails, the ownership of the resources in the cluster are transferred to the backup (passive) server. Typically, users cannot detect when one server in a cluster fails over to another.

When the active node of a clustered License Server fails, there is no impact on users connected to the Citrix product. The product may briefly enter the licensing grace period and an event may be written in the product's event log.


License Server VPX does not support clustered License Servers. You can use the High Availability (HA) feature on XenServer 5.6 and later.

Citrix Licensing in a cluster

Like most clusters, a private network is used to send heartbeats, commands, and state information between the nodes of the cluster. If the connection is interrupted, the nodes try to reconnect by the private network first, then the public network. The following diagram illustrates a cluster-enabled licensing deployment:

Figure 1. Communications in a clustered licensing environment

Only one node can use the resources in a cluster at any given time. If you already deployed Citrix Licensing and you want to migrate your deployment to a cluster-enabled server, keep the following points in mind:
  • Because you already generated license files that reference a specific server name, you must either give the client access point the same name as the original License Server or rehost your license files with the new name of the License Server cluster.
  • Host names in license files are case-sensitive; therefore, the client access point names must be the same case as the host names in the license file. If they are not, you must rehost your license files with the correct capitalization of the names. You can use the Failover Cluster Manager to ensure the client access point name matches the host name specified in the license file. Note: Cluster and host name case is not an issue if you use Studio in XenDesktop or the Simple License Service (from the Start menu on your License Server) to download your licenses.
  • You must point all product installations (for example, servers running Citrix XenDesktop) serviced by the old License Server to the new License Server cluster. Change product communication settings so that they use the name of the client access point as the License Server name. For information about editing product-side communication settings, see the product's documentation.

Opening the console or running commands

All licensing administration features available in standard deployments are also available on clustered License Servers, including the management console and the ability to run license administration commands.

Open the License Administration Console in a cluster by browsing to:

https://client access point name:web service port

Where client access point name is the name of the cluster and web service port is the port number for console communications (the default port number is 8082).

You can run many license administration commands using the argument -c @client access point name to specify the location of the license file(s) in the cluster. For example:

lmreread -c @client access point name

Requirements for clustered License Servers

The following list outlines the requirements for setting up a License Server in a Microsoft Cluster:
  • Citrix Licensing does not support Clustered Shared Volumes or third party Volume Management products for clusters.
  • Before configuring Citrix Licensing for Microsoft clustering, you must have a fully-functional Microsoft cluster environment. Citrix Licensing Services runs on only one node at a time.
  • To cluster the License Server, you must follow the following cluster requirements in addition to any requirements from Microsoft for hardware and clustering in general.
  • You must install licensing on the cluster with the License Server installer CitrixLicensing.exe.
  • When you install Citrix Licensing on a cluster, you must specify the name of the client access point when prompted for the name of the License Server during product installation.
  • Citrix recommends that you use identical License Server hardware for each node in the cluster. In particular, Citrix recommends two network adapters on each node and the servers have one drive configured as a shared drive.
  • Each node should have two network adapters-one for connection to the public network and the other for the node-to-node private cluster network. Citrix does not support using one network adapter for both connections.
  • The public and the private IP address must be on different subnets because the Cluster Service will recognize only one network interface per subnet.
  • A name resolution method, such as DNS, WINS, HOSTS, or LMHOSTS, is necessary to resolve the client access point name.
  • Each server that form the cluster must be in the same domain.
  • Set static IP addresses for the private network connector.
  • When you generate a license file at, use the name of the client access point when prompted for the host name.
  • After you download a license file, you must copy it to the F:\Program Files\Citrix\Licensing\MyFiles folder (where F: is the shared drive for the cluster) on the License Server and reread it. Alternatively, use the License Administration Console to download, copy, and reread the file.


Citrix recommends setting static IP addresses for all network adapters in the cluster, both private and public. If IP addresses are obtained by Dynamic Host Configuration Protocol (DHCP), access to cluster nodes could become unavailable if the DHCP server goes down. If you must use DHCP for your public network adapter, use long lease periods to assure that the dynamically assigned lease address remains valid even if the DHCP service is temporarily lost or perform a DHCP reservation.

Overview of the clustering process

The following steps describe the overall process involved in installing and configuring licensing on a cluster-enabled server. These steps assume you configured the clustering on the hardware on which you intend to install the License Server.
  1. Create a cluster resource group. Assign a client access point and shared storage to the resource group. Ensure that the first node has control of the cluster resources and the resource group you created points to the first node.
  2. On the first node of the cluster, start the Citrix Licensing installer, CitrixLicensing.exe, as an administrator and install it on the first node to the shared cluster drive (not the quorum drive). Leave the Last Node in Cluster checkbox unchecked.
  3. Move the resources from the active node in the cluster to the second node.
  4. Install the License Server on the second node to the same shared location as the first node. Note that you can add more than two nodes to a cluster.
  5. When installing the License Server on the last node in the cluster, ensure that you check the Last Node in Cluster checkbox.
  6. Obtain license files that specify the client access point name of the License Server as the host name. After obtaining license files, you must add them to the License Server and then reread them.
  7. Configure your Citrix product to use the client access point name-not the node name-of the License Server cluster.


When a clustered License Server fails over, the cluster service renames the lmgrd_debug.log to the name of the node that previously hosted the services. Then it starts the services on the new active node and creates a new lmgrd_debug.log.