Product Documentation

License file format

Apr 08, 2013

Important

Modifications can make license files unusable. If using Citrix Licensing for Windows 11.6.1 or later, you should never need to edit license files. You can manage licenses and their tasks through the License Administration Console and the My Account site.

Note: You can change the name of the license file, but it must have a .lic extension.

Citrix License files employ the following naming convention: license_FID_XDT-PLT-UD_25-mar-2013.lic.

License files are composed of lines that list specific information, such as the server name (SERVER) or quantity of licenses (INCREMENT). These lines begin with words denoting their purpose in uppercase letters, such as VENDOR, SERVER, INCREMENT, USE_SERVER, and so on.

The following sections provide in-depth information about the following elements of license file syntax: the SERVER line, VENDOR line, USE_SERVER line, INCREMENT line, and UPGRADE line. While the term feature is used in the options and license file syntax, in this document, the term product license is used whenever possible for clarity.

Example license file with numbers corresponding to the explanations following the example:


1 SERVER Line

The SERVER Line. The SERVER line specifies the binding identifier (also known as the hostname) of the license server.
Caution: Do not modify the binding identifier on the SERVER line; otherwise, the license file will not work.
Syntax
SERVER this_host ether
or
SERVER this_host HOSTNAME=hostname
Parameters Description
ether The MAC address of the appliance on which the license server is running. Do not edit this string.
hostname The name of the computer on which the license server is running. Do not edit this string.
Example
SERVER this_host HOSTNAME=license_server1

2 VENDOR Line

The VENDOR line specifies the Citrix vendor daemon name.

Syntax
VENDOR CITRIX [vendor_daemon_path]
Field Description
VENDOR CITRIX Name of the Citrix vendor daemon. Do not edit this name.
vendor_daemon_path Path to the executable for the Citrix vendor daemon. Citrix recommends that you do not change this path.

3 INCREMENT Lines

An INCREMENT line describes the license required to use a product. License files (*.lic) contain one or more INCREMENT lines. Each INCREMENT line makes up a user-specified allocation of product and license (users, connections) counts..

Each increment line contains a signature based on the data in that line, the hostids specified in the SERVER line(s), and data chosen by Citrix. INCREMENT lines use a backslash ( \ ) to wrap long lines of text.
Syntax
INCREMENT feature vendor SA_expiry_date exp_date num_lic \ 
  SIGN=sign [optional_attributes]
Caution: Do not modify the six fields after the INCREMENT line keyword; they are required and have a fixed order.
The following table explains these fields in the order they appear:
Field Description
feature The product license. Do not edit this line.
vendor Indicates this license is for a Citrix vendor daemon. Do not edit this line.
SA_expiry_date Indicates the date until which you are entitled to product version upgrades. If you do not have a Subscription Advantage membership or this is not a Subscription Advantage license, the date indicates when you ordered or redeemed the license. Do not edit this line.
Note: If you renewed your Subscription Advantage membership and received an upgrade license, two dates are listed.
  • The first date is the date when the Subscription Advantage membership was originally purchased
  • The second date is the SA_expiry_date

Example:

INCREMENT MPS_ENT_CCU CITRIX 2005.0311 2007.0311 permanent 1000 \

See Upgrade Lines for additional information.

exp_date Expiration date of license in the format dd-mmm-yyyy, that is, 07-may-2006. Do not edit this line.
Note: If the exp_date field contains the string "permanent," the license never expires.
num_lic Number of concurrent licenses for this product license. Do not edit this line.
SIGN=sign SIGN= signature to authenticate this INCREMENT line. Do not edit this line.
INCREMENT lines also determine the grouping of licenses in the management console. These groups are known as license pools. The Citrix vendor daemon creates the license pools based on common attributes, such as product license or version. When a new pool is created, the console displays and tracks this pool independently from other license pools. When two or more attributes are different, the Citrix vendor daemon creates a new license pool.
Citrix Attributes in INCREMENT Lines
INCREMENT lines can also include additional attributes from Citrix. These attributes provide information about the license, such as the date on which it was issued or that the license is an upgrade license.
Caution: Do not modify or delete these attributes.
Example
Important items are highlighted in the above example:
  • The Product (license feature) appears in blue
  • The Citrix Subscription Advantage expiration date appears in red (Format: YYYY.MMDD)
  • The License (user, connection) Count appears in GREEN
Syntax
keyword=value
The following table describes the Citrix attributes. The uppercase letters of the attributes indicate that this attribute is not editable.
Attribute Description
DUP_GROUP=V This attribute allows license sharing for the same client device.
ISSUED=dd-mmm-yyyy Date issued.
ISSUER="..." Issuer of the license.
NOTICE="..." Your company's name.
SN=serial_num A number that is used to identify INCREMENT lines.
START= dd-mmm-yyyy The date from which you can use a license. The license server cannot use licenses before their start date.
SUPERSEDE="MPS_ADV_CCU MPS_STD_CCU ..." This appears in the upgrade license file when you move to a higher product edition. If this appears, all licenses issued before the date specified in ISSUED= are superseded by this line and become ineffective.
VENDOR_STRING="..." String defined by Citrix.
Optional Attributes in INCREMENT Lines
INCREMENT lines contain several attributes that you can add, edit, or delete. You can add attributes, if desired. For example, you can insert an asset tag or a purchase order number beside each license in a file. Likewise, you can add attributes that indicate a specific group of licenses is dedicated for a department in your organization.
Some of these attributes may be inserted by Citrix or your Value Added Reseller.
Optional attributes are listed in the table that follows. Like the Citrix-specific attributes, the optional attributes have a keyword=value syntax where keyword is in lowercase. You can tell the difference between optional and required attributes by the case of the letters: optional attributes have lowercase letters.
Attribute Description
asset_info= "..." Additional information you can add for asset management
dist_info= "..." Additional information provided by the software distributor
user_info= "..." Additional information provided by the license administrator
vendor_info= "..." Additional information provided by Citrix

UPGRADE Lines

An UPGRADE line indicates the date when a Subscription Advantage membership was renewed and the date it expires.
Caution: Do not modify this line.
Syntax
UPGRADE feature CITRIX from_Subscription_Advantage_date 
to_Subscription_Advantage_renewal_date 
exp_date num_lic \ 
[options ... ] SIGN=sign
All the data is the same as for an INCREMENT line, with the addition of the from_Subscription_Advantage_date field. An UPGRADE line removes up to the number of licenses specified from any old version (>= from_Subscription_Advantage_date) and creates a new version with that same number of licenses.
Example 1
For example, the following lines renew the ABCD Corporation's Subscription Advantage membership for 1000 MPS_ENT_CCU licenses for one year (until March 11, 2006):
INCREMENT MPS_ENT_CCU CITRIX 2005.0311 permanent 1000 \ VENDOR_STRING=;LT=Retail;GP=96;CL=ENT,ADV,STD;SA=1;ODP=0 \ DUP_GROUP=V ISSUED=12-Mar-2004 NOTICE="ABCD Corporation" \ SN=LA-0000150712-12345:123 START=11-mar-2004 SIGN="1234567"
UPGRADE MPS_ENT_CCU CITRIX 2005.0311 2006.0311 permanent 1000 \ 
 VENDOR_STRING=;LT=Retail;GP=96;CL=ENT,ADV,STD;SA=1;ODP=0 \ 
 DUP_GROUP=V ISSUED=12-Mar-2005 NOTICE="ABCD Corporation" \ 
 SN=RE-0000164638-12345:123 START=11-mar-2005 SIGN="1234567"
Example 2
For example, the following lines renew the ABCD Corporation's Subscription Advantage membership for 1000 MPS_ENT_CCU licenses for one year (until March 11, 2006):
INCREMENT MPS_ENT_CCU CITRIX 2005.0311 permanent 1000 \ VENDOR_STRING=;LT=Retail;GP=96;CL=ENT,ADV,STD;SA=1;ODP=0 \ DUP_GROUP=V ISSUED=12-Mar-2004 NOTICE="ABCD Corporation" \ SN=LA-0000150712-12345:123 START=11-mar-2004 SIGN="1234567"
UPGRADE MPS_ENT_CCU CITRIX 2005.0311 2006.0311 permanent 1000 \ 
 VENDOR_STRING=;LT=Retail;GP=96;CL=ENT,ADV,STD;SA=1;ODP=0 \ 
 DUP_GROUP=V ISSUED=12-Mar-2005 NOTICE="ABCD Corporation" \ 
 SN=RE-0000164638-12345:123 START=11-mar-2005 SIGN="1234567"
An UPGRADE line applies to the closest preceding INCREMENT line with a Subscription Advantage date that is greater than or equal to from_Subscription_Advantage_date, and less than to_Subscription_Advantage_renewal_date.
Upgrade lines use a continuation character ( \ ) to break up long lines. When using license files with an UPGRADE line, you must keep the license files with the original INCREMENT lines in the same folder.