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. A detailed procedure follows.
1. Ensure that the first node has control of the cluster resources.
2. On the first node of the cluster, start the Citrix Licensing installation from the command-line and install it on the first node to the shared cluster drive (not the quorum drive).
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.
5. Obtain license files that specify the cluster 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.
6. Configure your Citrix product to use the cluster name—not the node name—of the license server cluster.
Note: 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.
To install licensing on a cluster-enabled server
1. Install Java on both cluster nodes. You can find a supported version on the Citrix product CD in the Support folder.
2. Ensure that the cluster IP address, cluster name, and a shared disk are configured as cluster resources and that all the cluster resources are owned by the first node of the cluster.
3. From a command-line in the first node of the cluster, run the following: msiexec /i D:\Licensing\ctx_licensing.msi
CTXCLSCLUSTRES_PATH="C:\ctxlic"
REGISTER_CTXKSCLUSTRES="No" /l*v "f:\install_firstnode.log"
Where D is the drive for your product CD (in this example, Presentation Server) and C is the local hard drive on the first node on the cluster. The Setup program wizard launches.
4. Click Next at the Welcome screen and accept the license agreement.
5. Enter the destination folder where you want the licensing components to be installed. By default, the licensing components are installed in F:\Program Files\Citrix.
6. Select the licensing components that you want to install.
7. Specify the location of the license files on the shared drive of the cluster-enabled servers. By default, the license files are stored in F:\Program Files\Citrix\Licensing\MyFiles.
Note: You cannot store the license files at the root directory level. You must store them in a folder or a subfolder.
8. Select the Web server and click next. For more information about the Web servers available for License Management Console, see the Getting Started with Citrix Licensing in the Citrix Knowledge Center.
9. Click OK to restart the Web service.
Note: Temporarily stopping the Web service affects any dependent services.
10. Click Next to install the licensing components.
11. Using the Cluster Administrator, make the second node in the cluster active.
12. From a command-line on node 2, run the following (Note: For node 2, you will be typing “Yes” to register the clustering service): msiexec /i D:\Licensing\ctx_licensing.msi
CTXLSCLUSTRES_PATH=“C:\ctxlic”
REGISTER_CTXLSCLUSTRES=“Yes” /l*v “F:\install_secondnode.log” where D is the drive for your product CD (in this example, Presentation Server) and C is the local hard drive of the second node in the cluster.
13. Repeat Steps 4 to 10.
14. After you install the licensing components, add the license files to the following directory on the shared drive of the cluster: F:\Program Files\Citrix\Licensing\MyFiles\.
15. Reread the files (the procedure follows).
To reread a license file on a clustered license server
1. Open your Web browser.
2. Type the following URL in the browser: http://clustername/lmc/index.jsp where clustername is the name of the license server cluster.
Note: “lmc” in the URL is case-sensitive and must be typed in lowercase.
3. From the Welcome page, click Configure License Server. The License Files page appears.
4. Under the License Files heading, click Update license data.
Tip: You can also use lmreread to reread license files on a clustered license server. See the Licensing: Using License Administration Commands whitepaper in the Citrix Knowledge Center.
Administering Cluster-Enabled License Servers
All licensing administration features available in standard deployments of Citrix Licensing are also available on clustered license servers.
Before you use the License Management Console or License Administration Commands to administer the license server, verify what node in the cluster owns the resources. License Administration Commands can be run only from the active node of a cluster.
Important: If you want to use License Administration Commands to administer the license server, set an environment variable as described in the section that follows.
Accessing the License Management Console
You can administer a cluster-enabled license server by using the License Management Console. When you use the License Management Console, you are administering the active node of the cluster only.
Licensing: Setting Up The License Server On A Microsoft Cluster 5
To access the License Management Console
1. Open your Web browser.
2. Type the following URL in the browser: http://clustername/lmc/index.jsp where clustername is the name of the license server cluster.
Note: “lmc” in the URL is case-sensitive and must be typed in lowercase.
For information about the License Management Console, see the Licensing: The License Management Console whitepaper in the Citrix Knowledge Center.
Using License Administration Commands
If you want to use license administration commands with a clustered license server, you must set an environment variable with the name of the license server cluster.
To set an environment variable
1. In System Properties, click the Advanced tab.
2. Click Environment Variables.
3. In the System Variables section, click New.
4. In the Variable name box, type _CLUSTER_NETWORK_NAME.
5. In the Variable Value box, type the name of your license server cluster.
For information about using License Administration Commands, see the Licensing: Using License Administration Commands whitepaper in the Citrix Knowledge Center.
Upgrading a Clustered License Server
If you installed a more recent version, you can use the following procedure.
To upgrade the license server in a clustered environment
1. Using the Cluster Administrator, make the first node in the cluster active.
2. From a command line, run the following: msiexec /i D:\Licensing\ctx_licensing.msi
CTXLSCKYSTRES_PATH="C:\ctxlic"
REGISTER_CTXLSCLUSTRES="No" /l*v "f:\install_firstnode.log" where D is the drive for your product CD (in this example, Presentation Server) and C is the local hard drive on the first node on the cluster.
Note: The resource DLL should be stored locally for each node in the cluster. This is the only file that should be stored on each cluster node.
Setup will detect the existing installation and will upgrade the first node.
3. Using the Cluster Administrator, make the second node in the cluster active.
4. From a command-line on node 2, run the following (Note: For node 2, you will be typing “Yes” to register the cluster services): msiexec /i D:\Licensing\ctx_licensing.msi
CTXLSClUSTRES_PATH=“C:\ctxlic”
REGISTER_CTXLSCLUSTRES=“Yes” /l*v “F:\install_secondnode.log” where D is the drive for your product CD (in this example, Presentation Server) and C is the local hard drive of the second node in the cluster.
Setup will detect the existing installation and will upgrade the second node. The upgrade is complete.
Uninstalling Licensing from a Clustered License Server
Uninstalling licensing from a clustered license server is a straightforward uninstall using the Control Panel > Add or Remove Programs option from the active node; however, if you installed the clustering hotfix for Presentation Server 3.0, you must remove the clustered license services before you remove licensing.
Installations that Include the Clustering Hotfix for Presentation Server 3.0
The following steps remove the clustered services if you installed the clustering hotfix for Presentation Server 3.0.
To remove Microsoft clustering using the .CMD script
1. From a command prompt, change directories to the C:\ctxlic folder.
2. Uninstall the license server clustering component by running the following command: ConfigureLS.cmd "uninstall"
Important: Insert the double quotation marks in the command exactly as shown.
3. Repeat the uninstall command on both nodes.
4. Delete the C:\ctxlic folder on both cluster nodes.
5. On the active node, launch the Cluster Administrator tool and verify that the four services below were removed from the Cluster Group:
• CitrixLicensing
• WMI
• W3SVC
• Citrix License Management Console
6. Complete the All Other Licensing Installations Procedure (below).
All Other Licensing Installations
1. From the first node in the cluster, launch Control Panel > Add or Remove Programs.
2. Remove Citrix Licensing.
Licensing: Setting Up the License Server on a Microsoft Cluster 7
3. Using the Cluster Administrator, make the second node active and launch Control Panel > Add or Remove Programs.
4. Remove Citrix Licensing from the second node.
5. Delete the remaining files from the shared drive.
Note: The uninstallation process does not remove the license files, options files, report logs, and debug logs from the shared drive. For information about the files that remain, see the “Uninstalling Licensing” section in the Readme for Citrix Licensing in the Citrix Knowledge Center.
Troubleshooting Cluster-Enabled License Servers
When troubleshooting a cluster-enabled license server, try the following:
• Check to see if all four license server resources—that is, the CitrixLicensing service, the Citrix License Management Console service, the WMI Performance Adapter service, and the Web service (IIS or Apache)—are installed and online.
Note: If any of the licensing services (including the CitrixLicensing, the Citrix License Management Console, or the Citrix Licensing WMI services) fail to start, the cluster detects that licensing is offline and attempts to restart the service three times (by default). If these attempts are unsuccessful, fail-over to the next node is initiated and the cluster attempts to start the services on the second node. If the attempts fail on the second server, the process may enter into an infinite loop. In this case, the computers running Citrix products fall into the grace period. During the grace period, client connections are not affected.
• If you move the resources to the other node, do you still see the issue?
• Does your license file have the cluster HOSTNAME in uppercase? The cluster hostname is always uppercase.
• In the Cluster Administrator, under the cluster name, expand Cluster Configuration > Resource Types and verify that ctxlsclustres is a valid resource type (appears in green).
For additional troubleshooting information, see the Licensing: Troubleshooting whitepaper in the Citrix Knowledge Center.
Suggested Reading
The following whitepapers provide more detailed information about some of the topics discussed in this paper:
Getting Started with Citrix Licensing Guide
Licensing: Using License Administration Commands
Licensing: Migrating, Upgrading, and Renaming
Licensing: Troubleshooting
Licensing: Setting Up the License Server On A Microsoft Cluster 8
