citrix licensing clustering

S

Su

up

pp

po

or

rt

ti

in

ng

g

M

Mi

ic

cr

ro

os

so

of

f

t

t

Cl

C

lu

us

s

t

t

er

e

r

in

i

ng

g

f

f

o

o

r

r

M

M

e

e

t

t

a

a

F

F

r

r

a

a

m

m

e

e

A

A

c

c

c

c

e

e

s

s

s

s

S

S

u

u

i

i

t

t

e

e

L

Li

ic

ce

en

ns

se

e

Se

S

er

rv

ve

er

r

1

1.

.0

0.

.0

0

Notice

The information in this publication is subject to change without notice.

THIS PUBLICATION IS PROVIDED “AS IS” WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. CITRIX SYSTEMS, INC. (“CITRIX”), SHALL NOT BE LIABLE FOR TECHNICAL OR EDITORIAL ERRORS OR OMISSIONS CONTAINED HEREIN, NOR FOR DIRECT, INCIDENTAL, CONSEQUENTIAL OR ANY OTHER DAMAGES RESULTING FROM THE FURNISHING, PERFORMANCE, OR USE OF THIS PUBLICATION, EVEN IF CITRIX HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES IN ADVANCE.

This publication contains information protected by copyright. Except for internal distribution, no part of this publication may be photocopied or reproduced in any form without prior written consent from Citrix.

The exclusive warranty for Citrix products, if any, is stated in the product documentation accompanying such products. Citrix does not warrant products other than its own.

Product names mentioned herein may be trademarks and/or registered trademarks of their respective companies.

Copyright © 2004 Citrix Systems, Inc., 851 West Cypress Creek Road, Ft. Lauderdale, Florida 33309-2009 U.S.A. All rights reserved.

Globetrotter, Macrovision and FLEXlm, are registered trademarks or trademarks of Macrovision Corporation.

All other trademarks and registered trademarks are the property of their owners.

Version History

1.0 Chris Realmuto, Citrix Consulting 2 June 2004

1.1 Hopeful Owitti, Citrix Consulting (QA) 17 June 2004

1.2 Chris Realmuto, Citrix Consulting 6 July 2004

1.3 Manu Chauhan, Ailin Lek, Tapan Divekar, Sarah Vallieres, Brett Duch, Bill Haberkam

3 August 2004

Table of Contents

INTRODUCTION ... 2

THE DECISION TO SUPPORT MICROSOFT CLUSTERING... 2

SOLUTION OVERVIEW... 2

REQUESTING LICENSE FILES FOR CLUSTER... 3

KNOWN ISSUES... 3

CONFIGURING CLUSTERED LICENSE SERVERS... 4

CITRIX TESTING ENVIRONMENT... 4

Server Environment ... 5

Windows Environment ... 5

MetaFrame Access Suite License Server Version ... 5

Cluster Environment... 6

INSTALLATION AND CONFIGURATION ... 6

JAVA 2RUNTIME ENVIRONMENT INSTALLATION... 7

LICENSE SERVER INSTALLATION... 9

MOVING THE ACTIVE NODE... 15

MICROSOFT CLUSTERING OF THE LICENSE SERVER... 16

CONFIGURING THE METAFRAME PRESENTATION SERVER FARM... 17

INSTALLATION VERIFICATION... 18

UNINSTALLATION ... 18

Introduction

In response to user requests for improvements to licensing, Citrix introduced MetaFrame Access Suite licensing with MetaFrame Presentation Server 3.0 and MetaFrame Conferencing Manager 3.0. Both products now require a license server to function.

In some situations, customers want to ensure high availability for the license server beyond that which is available out of the box. Citrix supports Microsoft clustering as a high availability solution for the license server.

This document is divided into two sections:

• The rationale for using Microsoft Clustering as a high availability solution and the ways in which Citrix supports this solution

• Configuration information for customers who want to employ this solution

The target audience for this paper is administrators that would like to install the license server on a Microsoft cluster in their data centers.

Note:

Customers are responsible for having a fully functional cluster environment prior to configuring MetaFrame Access Suite licensing for Microsoft clustering. Citrix will only support the aspects of configuring MetaFrame Access Suite licensing described in this document.

The Decision to Support Microsoft Clustering

MetaFrame Access Suite licensing abstracts licensing functionality from individual Citrix products (removing it from IMA in the case of MetaFrame Presentation Server) and puts it into a common central server. Eventually, all Citrix products will share this central licensing mechanism. The license server contains license files that define which products are licensed.

When a client logs on to a MetaFrame Access Suite product, the product checks out an available license. When the client logs off, the product checks the license back in to the license server. The Citrix product maintains on-going, periodic communication with the license server to ensure availability. If the check-out process fails, the product lapses into a licensing grace period. In addition to the grace period, Citrix offers Microsoft clustering of the license server as a option that gives customers increased flexibility in situations when communication between the product server and the license server fails and that requires no manual intervention.

Solution Overview

A server cluster is a group of independent servers running a cluster service and working collectively as a single system. All servers in the cluster have a single identity (name): the data is consistent across nodes. The solution supports the Active - Passive Microsoft clustering configuration.

Note that the second part of this document provides notes about installing Microsoft clustering as a licensing availability solution. Specifically, this document has steps for installing the license server on a two-node Microsoft cluster in an Active/Passive configuration. Customers are responsible for having a fully functional cluster environment prior to configuring MetaFrame Access Suite licensing for Microsoft clustering. Citrix will only support the aspects of configuring MetaFrame Access Suite Licensing

described in this document. In addition, while Citrix does not provide technical support for clustering between geographically disparate sites, interested administrators may wish to reference Microsoft Knowledge Base articles 280743 and 309395.

Requesting License Files for Cluster

When allocating licenses for a clustered environment, it is important to note that the license file hostname must reflect the cluster name and not the names of the individual nodes in the cluster. The license file hostname is case-sensitive. Care should be taken when specifying the cluster name during the license allocation process on CAS.

Known Issues

1. Each time the MetaFrame Access Suite licensing is installed on the shared drive of the cluster, an entry for the location of the report log is created in the options file called Citrix.opt located in \Program Files\Citrix\Licensing\MyFiles. Because the MetaFrame Access Suite licensing was installed twice in the same location during the cluster setup, two REPORTLOG entries appear in options file. Only the first entry is active. The second entry can be deleted without causing problems. In fact, all REPORTLOG entries, except for the first one, must be removed if you change the reportlog to non-append mode. Here is an example of ReportLog entry in the options file:

REPORTLOG +"F:\Citrix\Licensing\LS\reportlog.rl" REPORTLOG +"F:\Citrix\Licensing\LS\reportlog.rl"

2. The options file must specify a full path to the report log. The registry must specify a full path to the debug log (in KEY_LOCAL_MACHINE\Software\Citrix\Licensing\ LMGRD_LOG_FILE). If no paths or relative paths are specified, the files are stored relative to the %windir%\system32 folder. In this case, system files can be overwritten accidentally.

4. Microsoft Operations Manager (MOM) cannot contact the cluster nodes based on the cluster name. If you wish to monitor the servers, both cluster nodes need to be added to the MOM console. “WMI error retrieving license info” messages appear on the passive node in the event log and the MOM Console, but you can safely ignore these messages.

5. For the License Administration Commands lmdown and lmremove to work in a clustered environment, the following command needs to be run first:

"set _CLUSTER_NETWORK_NAME_=LSCLUSTER", where LSCLUSTER is the name of the license-server cluster. Otherwise, these License Administration Commands will fail. Note: You can also use an environment variable for this purpose. Setting an environment variable makes this change permanent.

6. If any of the Citrix Licensing, the License Management Console, or the Citrix Licensing WMI services fail to start, the cluster will detect that licensing is offline and attempt 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 MetaFrame Presentation Server fall into the grace period. During the grace period, client connections are not affected.

Configuring Clustered License Servers

During June 2004, Citrix Consulting assisted Citrix Engineering with the testing of Microsoft clustering for the license server on Windows 2000 and Windows Server 2003. Microsoft clustering of the license server was tested over a three-week period in the Citrix eLab located in Fort Lauderdale, Florida. This paper documents the process followed during this testing to install the license server clustering

component.

The objective of this paper is to provide administrators with a step-by-step guide to installing the

MetaFrame Access Suite licensing, also referred to as the license server, on a two-node Microsoft cluster in an Active/Passive configuration. The steps outlined in this paper are for the MetaFrame Access Suite licensing, version 1.0.0. The steps are the same for clusters using Windows 2000 and Windows Server 2003. Citrix Engineering used a SAN as the shared drive during testing. It is important to note that a SAN is not a requirement of Microsoft clustering.

The configuration files can be found at CLScluster.

Citrix Testing Environment

Server Environment

The two servers used in the Microsoft cluster were Compaq Proliant DL320 servers. Both servers were connected by Fibre Channel to a Compaq StorageWorks Modular SAN Array 1000.

Windows Environment

The servers were installed with standard installations of the following operating system configurations: • Windows 2000 SP4 with Internet Information Services (IIS) 5.0

• Windows Server 2003 with IIS 6.0

Each server was configured with one hard disk partition, the C: drive, and a CD-ROM, the D: drive. They were also configured with two partitions from the SAN; the shared partition, the F: drive, and the quorum partition, the Q: drive.

MetaFrame Access Suite License Server Version

Cluster Environment

The servers were installed as a two-node Microsoft cluster in an Active/Passive configuration following the instructions contained in the Step-by-Step Guide to Installing Cluster Service document (published by Microsoft at http://www.microsoft.com/windows2000/techinfo/planning/server/clustersteps.asp). These instructions were used to configure the cluster service on both the Windows 2000 Server and Windows Server 2003 operating systems.

The following diagram represents the Microsoft clustering environment prior to installing MetaFrame Access Suite licensing:

Installation and Configuration

Citrix Consulting used the steps outlined in this section to configure Microsoft clustering of the license server in compliance with Microsoft and Citrix best practices. The following steps are detailed in the sections that follow.

1. Ensure that the first node has control of the cluster resources 2. Install the Java 2 Runtime Environment on the first node

4. Move the active node in the cluster to the second node 5. Install The Java 2 Runtime Environment on the second node

6. Install the license server on the second node to the same, shared location as the first node 7. Install the license server clustering components on each node

8. Configure your MetaFrame Presentation Server to use the cluster name or IP address of license server cluster

Java 2 Runtime Environment Installation

1. Install the Java 2 Runtime

Environment by launching the j2re-1_4_1_02-windows-i586-i.exe

executable on the first node.

The executable can be located in the

D:\Support\JRE14102 folder on the MetaFrame Presentation Server CD-ROM.

3. Select the Typical radio button. Click the Next button.

4. The Java 2 Runtime Environment will install.

License Server Installation

Step Action / Description Caption

1. Install the license server by

launching the CTX_Licensing.msi

Microsoft Installer package on the first node.

The executable is in the

D:\Licensing folder on the MetaFrame Presentation Server CD-ROM.

3. Select the I accept the license

agreement radio button.

Click the Next button.

5. Change the path to F:\Citrix. Click the OK button.

7. Click the Next button.

9. Select the OK to restart IIS radio button.

Click the Next button.

11. The license server begins to install.

Moving the Active Node

Step Action / Description Caption

1. Move the active node using the

Cluster Administrator tool:

C:\WINNT\cluster\cluadmin.exe.

2. Right-click Cluster Group and select Move Group.

This moves the cluster resources to the passive node.

3. Repeat the process for installing the Java 2 Runtime Environment and the license server for the second node.

Microsoft Clustering of the License Server

1. Create a local folder on both the active and passive nodes called

C:\CTXLIC

Copy the ctxlsclustres.dll and

configureLS.cmd files to this location on both nodes.

Note: Either the %TEMP%

or %TMP% or %USERPROFILE% folder must exist on the system and the user running the script must have write permissions to them in order for ConfigureLS.cmd to function properly.

2. On the active node, open a command prompt and change directories to the C:\CTXLIC

folder.

Install the license server clustering component by running the following command:

ConfigureLS.cmd "install" "c:\ctxlic\ctxlsclustres.dll"

It is important to place the double quotes in the command exactly as shown.

Configuring the MetaFrame Presentation Server Farm

1. Open the Management Console Right-click the MetaFrame

Presentation Server farm name and select Properties.

2. Select License Server

Enter the cluster name into the

Specify license server name text box.

Ensure that the license server is

directed to the cluster name and

3. This step is for installing a new MetaFrame Presentation Server only.

When installing a new MetaFrame Presentation Server to the farm, ensure that the License Server Name is pointing to the cluster name and not one of the cluster nodes.

The screenshot to the right demonstrates where during the install to reference the cluster name.

Installation Verification

Step Action / Description Caption

1. On the active node, launch the Cluster Administrator tool and verify that the four services below are configured as cluster resources and that they are all online:

• CitrixLicensing • WMI

• W3SVC • LMC

Uninstallation

The following steps remove the MetaFrame Access Suite license server and the Microsoft clustering of the MetaFrame Access Suite from the cluster servers. You must remove the Microsoft clustering of the MetaFrame Access Suite using the .CMD script before removing the MetaFrame Access Suite from the Add/Remove Programs control panel.

1. Open a command prompt and change directories to the

C:\CTXLIC folder

Uninstall the MetaFrame Access Suite license server clustering component by running the following command:

ConfigureLS.cmd "uninstall"

It is important to place the double quotes in the command exactly as shown.

Repeat the uninstallation command on both nodes.

3. 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 • LMC

4. On the active node, launch the

Add/Remove Programs control panel and select Citrix MetaFrame Access Suite Licensing.

Click the Remove button.

5. Click the Yes button.

7. Move the cluster resources to the passive node and repeat the uninstallation process for the MetaFrame Access Suite license server.

It is important to note that the uninstallation process does not remove the license files, options files, report logs, and debug logs from the shared drive, F:

Summary