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 and Windows Server 2012. 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 to a few minutes.

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.

Citrix Licensing supports clustering the license server with two servers in a cluster and a shared drive. That is, you can cluster the license server in a two-node Microsoft Cluster in an Active/Passive Microsoft clustering configuration.

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 cluster 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 cluster 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 cluster 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 cluster 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:

http://clustername:web service port

Where clustername 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 @clustername to specify the location of the license file(s) in the cluster. For example:

lmreread -c @clustername