Product Documentation

Install, upgrade, and uninstall

Feb 26, 2018

Install licensing on a clustered-enabled server

The following drive letters and paths/variables are used in this procedure:

  • D is the drive for your product media.
  • C is the local hard drive on the specified node.
  • F is the cluster shared drive resource. (This is the installation drive. That is, the place where installation files used by each node are stored.)


Because of a NetBios restriction, ensure the client access point name is fewer than 15 characters.

You must create a separate, noncore cluster resource group. The resource group must have attached storage assigned a drive letter and a client access point with the same hostname name used when obtaining the license file. Create this by using the failover cluster manager and going to Services and applications in Windows 2008 or Roles in Windows 2012 and select the Other Server type in the menu. Ensure all cluster resources are owned by the first node of the cluster.

Run the License Server installer, CitrixLicensing.exe, as an administrator.

On the Install Location page, set the drive letter to correspond with the cluster shared drive. By default, the licensing components are installed in F:\Program Files\Citrix\Licensing.

Leave the Last Node in Cluster checkbox unchecked during the installation on the first node.

Move the resources for the resource group you created in Step 1 to the second node.

In node 2 of the cluster, run CitrixLicensing.exe as an administrator.

Go back to Step 3. You can install more than two nodes on the cluster. You can install more than two nodes on the cluster. For each additional cluster, repeat Step 3.

When installing the License Server on the last node in the cluster, ensure that the Last node in the cluster check box is checked. The last node is where the ports are configured.

If you installed License Server build 20104 or later, use the Citrix Licensing Manager to import your license files. Otherwise, import your license files using the console and these steps. For more information, see Install licenses.

Open the License Administration Console from http://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 the console Web server (8082 by default).

Click Administration and choose the Vendor Daemon Configuration tab.

Click Import License.

Click the link.

On the My Account page, enter your user ID and password.

Select All Licensing Tools.

From the main menu, select Allocate.

Follow the process to allocate and generate your file. Select the licenses you want to download, click Download and save generated license files to the shared drive of the cluster: F:\Program Files\Citrix\Licensing\MyFiles\.

In the License Administration Console on the Import License File page, browse to the license file.

Select Overwrite License File on License Server.

Click Import License.

Reread the license files.

Choose the Vendor Daemon Configuration tab.

Click Administer in the CITRIX vendor daemon line.

Click Reread License Files.


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 -all

Upgrade a clustered License Server

If you are running a version of a License Server older than 11.12.1, uninstall it and then install this version. The older versions of the License Server do not conform to current Microsoft cluster guidelines.This version of the License Server has the functionality required to work with Windows Server 2008 and greater.

Uninstall a clustered License Server

Uninstall licensing from a clustered License Server using the Control Panel > Programs and Features option from the active node.
Ensure the first node contains all the resources.
  1. From the first node in the cluster, launch Control Panel > Programs and Features .
  2. Remove Citrix Licensing.
  3. Using the failover cluster manager, move the resources in the Citrix Licensing resource group to the second node.
  4. Remove Citrix Licensing from the second node. If there are additional nodes, repeat Steps 3 and 4 for each node, and then procede to Step 5.
  5. Delete the remaining files from the shared drive.
    Note: The uninstallation process does not remove the license files and options file from the shared drive.

For troubleshooting information, see Troubleshoot.