Citrix states in their article: CTX764288

CTX764288 - Adding, Activating, and Backing Up Licenses with the Mlicense Utility

This document was published at: http://support.citrix.com/kb/entry.jspa?externalID=CTX764288

Document ID: CTX764288, Created on: Oct 30, 2002, Updated: May 23, 2003

Products: Citrix MetaFrame XP 1.0 for Microsoft Windows 2000

Attachment: CTX764288.htm (13.5 K)

Mlicense Utility

Adding, Activating, and Backing Up Licenses with the Mlicense Utility for MetaFrame XP 1.0 Feature Release 1 and Feature Release 2.

NOTE: The below processes do not work if the licenses have already been manually added to the Citrix Management Console.

Use the mlicense utility to add multiple licenses, activate multiple licenses, and back up licenses in a MetaFrame XP server farm. You can use mlicense in a MetaFrame XP server farm with servers running MetaFrame XP Feature Release 1 or Feature Release 2. MetaFrame XP Feature Release 3 will include the mlicense utility.

You must complete the following tasks before you can run mlicense:

1.
Create a filename.txt file and save all of the license serial numbers that you want to add to the MetaFrame XP Feature Release 1 or Feature Release 2 server farm. You can add other text to the filename.txt file, such as section headings. The mlicense utility reads the license serial numbers in the file and then adds them to the data store.

Note: Use all uppercase letters when adding serial numbers to the filename.txt file.

2.
If you have a MetaFrame XP Feature Release 2 server farm, download and install Hotfix XE102W065 or its replacement on each of the servers. This hotfix must be present on the MetaFrame XP Feature Release 2 servers before you can run mlicense in the farm.

3.
Download and copy Mlicense.exe to the \System32 directory on one of the servers in the farm.

Mlicense Utility
Download the Mlicense Utility here.

English
Mlicense.exe

German
Mlicense.exe

French
Mlicense.exe

Spanish
Mlicense.exe

A. On MetaFrame XP Feature Release 1 servers or on servers upgraded to MetaFrame XP with Feature Release 2, copy mlicense to the default directory C:\%System Root%\System32.

B. If you performed a clean installation of MetaFrame XP with Feature Release 2, the default directory is C:\Program Files\Citrix\System32.

Directions for Using Mlicense

1.
From a command prompt, run the command parameters listed below. For example:

C:\Documents and Settings\Administrator>mlicense add /I C:\Temp\filename.txt /O
C:\Temp\filename.xml

Note: You can save the filename.xml file to a directory of your choice by specifying the directory path. Mlicense outputs the filename.xml file, which includes the license numbers to be used for activation.

2.
Open the Web browser and navigate to the Multiple Activation page on the Citrix Activation (CAS) Web site. Upload the filename.xml file. The Web site processes the filename.xml file and returns a filename_processed.xml file. Save the filename_processed.xml file on the server.

Note: Detailed directions for using the CAS Web site are on the CAS Multiple License Activation Web page.

3.
Run the mlicense activate command, using the filename_processed.xml file. Use the command parameters listed below; for example:

C:\Program Files\Citrix\System32>mlicense activate /I filename_processed.xml

The licenses are now activated in the MetaFrame farm.

4.
After you activate the licenses, you can use the backup feature of mlicense to create a backup file of the licenses; for example:

C:\Documents and Settings\Administrator>mlicense backup /O
C:\Temp\backupfilename.txt

MLicense

Use this command-line utility to add groups of licenses to a MetaFrame XP Feature Release 1 or Feature Release 2 farm. Executing mlicense with no parameters displays help for the utility.

Important: The backup option is not available for MetaFrame XP Feature Release 1 servers.

Syntax

MLicense [add /I filename.txt] [/O filename.xml]
MLicense [/L number] [/Q]
MLicense [activate /I filename_processed.xml]
MLicense [backup /O backupfilename.txt]
MLicense [/?]

Parameters

Filename.txt — The name of the text file listing all of the license serial numbers to be added.

Filename.xml — The name of the output .xml file specified when using the syntax. This file is uploaded to the CAS Multiple License Activation Web site.

number — The maximum number of license numbers that each filename.xml file will contain. The maximum number that you can specify is 2000.

Filename_processed.xml — The file name of the license number and activation codes output file from the CAS Multiple License Activation CAS Web site to be used.

Backupfilename.txt — The file name containing a backup of the license serial numbers.

Options

/add filename.txt — Adds the license serial numbers from the filename.txt file to the mlicense tool. When this command is successfully completed, mlicense displays the message, Successfully added all the serial numbers.”

/activate filename_processed.xml — Activates the filename_processed.xml licenses in the MetaFrame farm. When this command is successfully completed, mlicense displays the message, “Successfully activated all the licenses.”

/I — Input command.

/O — Output command.

/L — Allows you to list the number of licenses to be put in the filename.xml file by mlicense. This is optional.

Example:

The example puts 10 license numbers in each of the filename.xml files. The first file is named filename.xml, the second file is named filename_1.xml, then filename_2.xml, and so on. If you do not use the /L option and the filename.txt file has more than 2000 license numbers, mlicense creates filename.xml with the initial 2000 license numbers and filename_1.xml with any license numbers over and above the initial 2000.

For example, if filename.txt contains 2100 license numbers, mlicense creates filename.xml that contains 2000 license numbers and filename_1.xml that contains the additional 100 license numbers.

/Q — This command runs after mlicense /L.

Example:

This allows the output file naming convention to restart. In this example, it overwrites the existing files such as filename.xml, filename_1.xml, and filename._2.xml in the directory. If you do not use the /Q option, the files are created using the next number available in the naming convention, such as filename_3.xml, filename_4.xml, and filename_5.xml. This is optional.

/Backup — Saves the serial number strings from the MetaFrame farm in the backupfilename.txt file for backup and disaster recovery purposes.

/? — Displays the syntax for the utility and information about the utilitys options.

Remarks

Important: For increased efficiency and performance, you must install Hotfix XE102W064 on each of the MetaFrame XP Feature Release 2 servers.

Mlicense is not installed by default on MetaFrame XP Feature Release 1 and Feature Release 2 servers. The executable is available from the Citrix Web site at http://www.citrix.com.

Mlicense does not add autoactivated licenses to the filename.xml file.

When creating the filename.txt file, be sure to use all uppercase letters.

The term serial number refers to license numbers before they are added to the farm.

The term license number is synonymous with license string and license key.

Security Restrictions

You must have full administrative rights to execute this command or be a user with delegated administration rights to assign licenses.

Copyright 2002 Citrix Systems, Inc. All rights reserved. Citrix is a registered trademark and MetaFrame XP is a trademark of Citrix Systems, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.