IBM Support

Common features used in the FLEXlm Licensing options file

Technote (FAQ)


What are the common features used in the FLEXlm Licensing options file to control the IBM Rational License Server?


IBM Rational provides the least restrictive licensing environment possible.

For a more controlled license environment, use the options file to reserve or deny licenses for certain users, hosts, displays, groups, or IP addresses.
You can also limit the number of licenses each user or group can access.


Create a text file named [rational.opt] or [ibmratl.opt] (for License key server v8.1.x ) and save it in <license install directory>\common\ .

This case-sensitive text file (.opt) sets the options for the license server and can be used with any type of floating licenses keys, temporary, evaluation, or permanent licenses keys

Note: The method for creating or referencing this file depends on the version of FLEXlm that in use on the license server.
For additional information on creating or referencing this file, or for more information on the FLEXlm License Server, see the FLEXnet License Administration Guide at the Macrovision Web site.

Common options

The following is a listing of common variables used with the FLEXlm options file. This is not an all-inclusive list of the available options.
See the FLEXnet License Administration Guide for all available variables used with the option file.

License timeout:

Set a license timeout value for a specific type of license. Using this option will place a time limit on the amount of time a license key is checked out during a period of inactivity. The license server will retrieve checked out license keys from the client after the set period of inactivity, thus freeing it up for another user.

    This way if a user forgets to close the application after completing their work, the license key is not held in the checked out state indefinitely.

    The timeout variable can be associated to the individual licenses or all license keys:

    Individual license key Timeout:

      To set a license key timeout for individual license keys use the TIMEOUT variable:

      Note: Referenced license keys in the same manor as they are referenced in the license key file.

      Note: The minimum time-out period (set in seconds) is 7200, or 2 hours, anything less is ignored.

      TIMEOUT RequisitePro 7200
      TIMEOUT RationalSuiteEnterprise 10800

    License key timeout for all keys

      To set a license key timeout for all license keys use the TIMEOUTALL variable:

      Note: The minimum time-out period (set in seconds) is 7200, or 2 hours, anything less is ignored.

      TIMEOUTALL 7200

Note: After IBM Rational License Server fix pack, Rational License Server minimum time out value was changed from 2 hours to 30 minutes.

License key usage though Named Users or Groups:

    Reserve / exclude a license key for a particular user or group.

    For example, if you have four Rational Suite license keys, but you reserve one for user "John", even if four users request a Suite license, the fourth license key can only be used by user "John". The fourth user who is not John will get an error message saying that no license keys are available.

    Note: If the user name has spaces in it, it will be read as multiple user names. If there is a space, put the user name in double quotation marks so that it is read as one user name.

    Reserving a license for a specific user example:
    RESERVE 1 ClearQuest USER John
    RESERVE 1 RationalSuites USER "Mark Brown"

    Excluding a license from a specific user example:
    EXCLUDE ClearQuest USER Bob

    Using Groups to Reserve and Exclude license key usage example:
    GROUP ProjectA smith jones white tran
    GROUP ProjectB dorsey kelley davis
    RESERVE 2 RequisitePro GROUP ProjectA
    EXCLUDE ClearQuest GROUP ProjectB

    Using Groups and setting a limit to the number of licenses available example:
    GROUP DeptA randall mohr johnson burnett
    GROUP DeptB mosey kenton denman wright
    MAX 2 RequisitePro GROUP DeptA
    MAX 3 RationalSuites GROUP DeptB

    Note: The same user name can exist in multiple GROUP listings, but the most restrictive option will apply, in the order of EXCLUDE > RESERVE > MAX > INCLUDE.

    Note: The RESERVE line, as is, will work on each license group in the license file. For example, if you have a license file that has ClearQuest FEATURE and INCREMENT lines:
    FEATURE ClearQuest ... \
    INCREMENT ClearQuest ... \

    a RESERVE line like

    RESERVE 1 ClearQuest USER John

    will result in 1 license from the FEATURE group, and also 1 license from the INCREMENT group being reserved for user John. In many cases, this is not the intention -- what you want is 1 license being reserved from just one of the license groups. To accomplish this, you need to add a keyword to the RESERVE line that will distinguish its license group from all the other license groups of that same feature. One way to do this is by using the KEY keyword -- the KEY is the unique string right before the \ (backslash) in the FEATURE or INCREMENT line. For example:

    RESERVE 1 ClearQuest:KEY=xxxxxxxxxxxxxxxxxxxx USER John

    where xxxxxxxxxxxxxxxxxxxx is the unique string right before the \ in the FEATURE or INCREMENT line.

Related information

Creating and referencing a Flexlm options file
How to reserve licenses for specific users or groups
IBM InfoCenter - Configure the License options file
A Japanese translation is available
A simplified Chinese translation is available
A Korean translation is available

FLEXlm End User Manual.pdf

Document information

More support for: Rational License Key Server
Option Files

Software version: Version Independent

Operating system(s): Windows

Reference #: 1135435

Modified date: 25 October 2005