Page tree
Skip to end of metadata
Go to start of metadata
The information on this page refers to LM-X v5.0 and newer, which added the upgrade license type. If you are using an older version of LM-X, refer to documentation for earlier versions.

As a minimum requirement, each feature must have a name. All other feature settings are optional. The syntax for settings is <SETTING tagname="value"/>. All strings in settings are empty by default and version numbers default to 1.0.

The following is a list of valid values that can be used in <FEATURE> tags. This section contains only information for setting each feature. For full descriptions of feature settings, see Feature descriptions.

Value

Usage

Required Settings


FEATURE="feature_name"

Specify the feature name.

The specified value is case-insensitive and may be up to 64 characters in length. Feature names must consist of only letters, numbers, underscores and dashes, and cannot contain spaces.

 Example:

<FEATURE="F1">
  <SETTING MAJOR_VERSION="2"/>

  <SETTING MINOR_VERSION="1"/>...
</FEATURE>

General License Information Settings


MAJOR_VERSION="version number"

Specify the major version of the feature. If no version number is set, the version number defaults to 1.

Example:

<SETTING MAJOR_VERSION="2"/>

MINOR_VERSION="version number"

Specify the minor version of the feature. If no version number is set, the version number defaults to 0.

Example:

<SETTING MINOR_VERSION="5"/>

LICENSEE="customer name"

Specify the LICENSEE field (customer name) in the license.

Example:  

<SETTING LICENSEE="ABC Inc."/>

START="YYYY-MM-DD"

Specify the license activation date in YYYY-MM-DD format.

Example:  

<SETTING START="2014-01-25"/>

END="YYYY-MM-DD"

Specify the license expiration date in YYYY-MM-DD format.

The specified date may be up to 9999-12-31.

Example:  

<SETTING END="2015-01-25"/>.

MAINTENANCE_START="YYYY-MM-DD"

Specify the license maintenance start date in YYYY-MM-DD format.

Example:  

<SETTING MAINTENANCE_START ="2014-01-25"/>

MAINTENANCE_END="YYYY-MM-DD"

Specify the license maintenance end date in YYYY-MM-DD format.

The specified date may be up to 9999-12-31.

Example:  

<SETTING MAINTENANCE_END="2015-01-25"/>

ISSUED="YYYY-MM-DD"

Specify the license issue date in YYYY-MM-DD format.

The special keyword "TODAY" can be used to set the current date.

Example:  

<SETTING ISSUED="2014-01-25"/>

DATA="custom data"

Set the DATA field (custom data) in the license.

Optional field for specifying a comment, such as additional licensing options and additional licensing restrictions. This field is not evaluated during the generation of the KEY checksum; therefore, you can edit the DATA field values without needing to generate a new key.

Example:  

<SETTING DATA="My custom data"/>

COMMENT= "product description"

Specify the COMMENT field (product description) in the license. (Note: This field is the same as the OPTIONS field.)

The specified value is validated in the key, so it is protected from tampering.

Example:  

<SETTING COMMENT="My software product description"/>

OPTIONS="licensing options"

Specify the OPTIONS field (licensing options) in the license. (Note: This field is the same as the COMMENTS field.)

The specified value is validated in the key, so it is protected from tampering.

Example:  

<SETTING OPTIONS="My option"/>

REPLACES="feature name or license key"

Specify the REPLACES field in the license.

A license can be replaced by specifying the feature name or the license key.

Multiple entries are separated by commas.

Example:  

<SETTING REPLACES="FEATURE=F1"/>
or
<SETTING REPLACES="KEY=0fNzdLhI5MJGgDyjV..."/>

KEYCOMMENT="my text"

Set the KEYCOMMENT field (raw data) in the license.

The specified value is hidden inside the KEY field in the generated license.

Example:  

<SETTING KEYCOMMENT="My comment"/>

PLATFORMS="platform strings"

Specify a single platform or a subset of platforms to which license usage will be restricted.

Multiple entries are separated by spaces.

See PLATFORMS for more details, including a list of platform keywords.

Example:  

<SETTING PLATFORMS="Win32_x86 Linux_x64"/>

TIME_ZONES="GMT offset values"

Specify the time zones in which to limit license usage relative to GMT.

Time zones earlier than GMT use a minus sign preceding the number (for example, an entry of "-1" specifies the time zone GMT -01:00). Multiple entries are separated by commas.

Example:  

<SETTING TIME_ZONES="1,-4,-5,-6,-7,-8"/>

Settings for Network Licenses


COUNT="number of network licenses"

Set the license count to the specified number, making this a network license that requires a license server.

The license count can be up to 2147483647 (the 32-bit integer limit). The count can alternatively be set to "UNLIMITED," which creates a network license with no upper limit.

Example:  

<SETTING COUNT="10"/>

TOKEN_DEPENDENCY="FEATURE=product_name VERSION=version_number COUNT=number of network licenses to fulfill token-based license checkout requests"

Define the license as token-based, and specify the real license upon which the token-based license is dependent, including the real product's name, version number, and number of licenses required to fulfill checkout requests for the token-based license.

This setting must be used together with KEYTYPE="TOKEN" and is used in place of the COUNT setting. The value for COUNT used within this setting can be up to 2147483647 (the 32-bit integer limit).

Example:  

<SETTING TOKEN_DEPENDENCY="FEATURE=realproduct VERSION=1.5 COUNT=5"/>

KEYTYPE="EXCLUSIVE/ADDITIVE/UPGRADE/TOKEN"

Used for network licenses only. Enable the license type for a network license to be:

  • Exclusive - the default network license type; used with COUNT for a regular network license
  • Additive - used with COUNT to add a license pool alongside an exclusive network license
  • Upgrade - used with COUNT to add licenses to an exclusive network license
  • Token-based - used with TOKEN_DEPENDENCY for a token-based license

Example:  

<SETTING KEYTYPE="UPGRADE"/>

SN="serial number"

Set the SN field (custom serial number) in the license.

The special keyword "RANDOM" can be used to specify a random serial number in the format AAAA-BBBB-CCCC-DDDD, output as hexadecimal characters.

Example:  

<SETTING SN="RANDOM"/>

SOFTLIMIT= "number of network licenses"

Enable segmentation of the license count. The number of licenses must be less than that specified for the COUNT field.

Example:  

<SETTING SOFTLIMIT="8"/>

HAL_SERVERS= "3"

Enable redundant servers, known as high availability licensing (HAL). Using HAL requires the end user to have a set of 3 license servers, so the HAL_SERVERS setting is set to 3.

See HAL_SERVERS (redundant servers) for more information.

BORROW="hours"

Enable the license borrow time for a network license up to the specified number of hours, from 1 to 8760 hours (1 year).

Example:  

<SETTING BORROW="168"/>

GRACE="hours"

Enable the license grace time for a network license, from 1 to 168 hours (7 days).

Example:  

<SETTING GRACE="48"/>

HOLD="seconds"

Enable the license hold time (time before licenses are checked in) for a network license, from 1 to 31536000 seconds (1 year).

Example:  

<SETTING HOLD="60"/>

USERBASED="number of user-based licenses"

Specify a number of licenses that will be available only to named users. The number of licenses can be up to 2147483647 (the 32-bit integer limit). The number can alternatively be set to "ALL," which reserves all licenses. This setting may be used only with network licenses.

Example:  

<SETTING USERBASED="10"/>

HOSTBASED="number of host-based licenses"

Specify a number of licenses that will be available only to named hosts. The number of licenses can be up to 2147483647 (the 32-bit integer limit). The number can alternatively be set to "ALL," which reserves all licenses.

This setting may be used only with network licenses.

Example:  

<SETTING HOSTBASED="5"/>

License Share Settings


Note: For network licenses, HOST, USER, CUSTOM and VIRTUAL sharing can be used together. For local licenses, TERMINALSERVER and VIRTUAL can be used together. When combining multiple share options, separate them with a vertical bar ( | ); for example, SHARE = HOST|USER|CUSTOM.


SHARE="HOST"

For counted network licenses, enable license sharing amongst multiple processes running on the same host. If you combine this with another share option, sharing is enabled only if the combination matches (for example, HOST+USER).

SHARE="USER"

For counted network licenses, enable license sharing amongst processes running as the same user on multiple hosts. If you combine this with another share option, sharing is enabled only if the combination matches (for example, USER+HOST).

SHARE="CUSTOM"

For counted network licenses, enable license sharing amongst processes running with the same custom sharing criteria. If you combine this with another share option, sharing is enabled only if the combination matches (for example, CUSTOM+USER).

SHARE="TERMINALSERVER"

For local licenses, enable application license sharing for remote terminal server clients. If this flag is not used, terminal server clients cannot check out local licenses.

SHARE="SINGLE"

For local licenses, enable application license sharing to limit checkouts to one instance of a feature across multiple sessions.

SHARE="VIRTUAL"

Enable application usage with virtual machines. If this flag is not used, checkout requests for local licenses are denied and license servers will refuse to load the license.

Additional Security Settings


SYSTEMCLOCKCHECK="LOCAL/INTERNET/FALSE"

Specify the system clock check performed by the client application and license server. You can set this value to LOCAL to check the clock against the local file system (the default) or to INTERNET to check the clock against a remote Network Time Protocol (NTP) time server. Setting the value to FALSE disables the system clock check.

Example:  

<SETTING SYSTEMCLOCKCHECK="LOCAL"/>

HOSTID_MATCH_RATE="match rate percentage"

Specify a HostID match rate for the license feature. Possible values are 0 to 100. The default value is 100.

See HOSTID_MATCH_RATE for more information about using HostID match rate.

Example:  

<SETTING HOSTID_MATCH_RATE="50"/>