Options file commands

Use this reference of command Information when you use options file.
Table 1. Options file command attributes
Options file command attributes Description
EXCLUDE Prevents a user from obtaining a license.
GROUP Defines a group of users for use in INCLUDE, INCLUDEALL, INCLUDE_ENTITLEMENT, EXCLUDE, EXCLUDEALL, EXCLUDE_ENTITLEMENT, and RESERVE option lines.
Note: USER_GROUP is an alias for GROUP.
Multiple group listings can include the same user name, but the most restrictive option applies, in the order of these option lines entries:
  1. EXCLUDE
  2. RESERVE
  3. MAX
  4. INCLUDE

For more information, see GROUP
INCLUDE Allows a user or a predefined users group to use licenses for a feature. Only users who are in the INCLUDE statement can use the feature. The total number of names in the INCLUDE list must be less than or equal to the number of available licenses.

The EXCLUDE option supersedes the INCLUDE option. Conflicts between the EXCLUDE list and the INCLUDE list are resolved by the EXCLUDE list taking precedence.

For more information, see INCLUDE
RESERVE 1 product

where 1 is the number of licenses to reserve and product is the name of the license to reserve.

 Tells the server to reserve a license.
TIMEOUT feature 7200

where feature is the IBM® Engineering Lifecycle Management (ELM) or IBM Rational® product as the product is listed in your license key file.

 Sets a license key timeout for individual license keys. The value is set in seconds. The value must be a minimum of 900 (15 minutes) and can be greater than the default value of 7200 (120 minutes).
The license server reclaims a floating license after a product is not used for the time that the TIMEOUT value sets. If the connection between the product and the license server is lost, the license server reclaims a floating license after the time that the TIMEOUT value sets. If you use the product again after the server reclaims the license, the product checks out the license again from the server.
Note: Setting a license key timeout for a specific license key will only work with ELM or IBM Rational products that use manual heartbeats to communicate with the license server. It does not work with ELM or IBM Rational products that use automatic heartbeats. Check the ELM or IBM Rational documentation for your product to evaluate if it uses manual or automatic heartbeats.
TIMEOUTALL 7200 Sets a license key timeout for all license keys. The value is set in seconds. The value must be a minimum of 900 (15 minutes) and can be greater than the default value of 7200 (120 minutes).
The license server reclaims a floating license after a product is not used for the time that the TIMEOUT value sets. If the connection between the product and the license server is lost, the license server reclaims a floating license after the time that the TIMEOUT value sets. If you use the product again after the server reclaims the license, the product checks out the license again from the server.
Note: Setting a license key timeout for all license keys will only work with ELM or IBM Rational products that use manual heartbeats to communicate with the license server. It will not work with ELM or IBM Rational products that use automatic heartbeats. Check the ELM or IBM Rational documentation for your product to evaluate if it uses manual or automatic heartbeats.
USER userid Tells the licensing server to reserve a license for a specific user ID.
Note: For information about the options file or general knowledge about FlexNet licensing, contact IBM Software Support.

The GROUP command in the options file

GROUP group_name user_list
Table 2. GROUP command
Term Description
group_name The name of the group that is being defined. Group names are case-sensitive.
user_list The list of user names in that group. Names are case-sensitive. Set the GROUPCASEINSENSITIVE options file keyword to ignore the uppercase and lowercase letters.

If the user name has spaces in it, the name is read as multiple user names. For user names that contain spaces, use double quotation marks around the user name.

Multiple GROUP lines for the same group name add all the specified users into the group. For example, to define the group Group1 consisting of Monica, Howard, and James:
GROUP Group1 monica howard james

The INCLUDE command in the options file

The INCLUDE command applies to floating licenses that license files hold.
INCLUDE feature[:keyword=value] type {name | group_name}
Table 3. INCLUDE command
Term Description
feature The name of the affected feature or package.
keyword=value The feature name modifier to denote a group of licenses.
type One of these attributes: USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP.
name The name of an item of type for which license usage is included.
group_name The name of the group for which license usage is included.
Note:
  • The PROJECT type is set by the LM_PROJECT environment variable.
  • The INCLUDE attribute is required for USER_BASED features for the authorized user fixed term licenses. The system administrator uses the INCLUDE attribute to specify the users who can use the product. The license limits the number of users that can be on the attribute INCLUDE list.
To include Amy in the list of users who can use feature f1, enter this line in the options file:
INCLUDE f1 USER amy
To reserve a license for a specific user, enter this line in the options file:
RESERVE 1 ClearQuest USER John
RESERVE 1 RationalSuites USER "Karen Brown"
To exclude a license from a specific user, enter this line in the options file: 
EXCLUDE ClearCase USER "Mike Smith"
Using Groups to Reserve and Exclude license key usage:
GROUP ProjectA smith jones lee
GROUP ProjectB miller rao davis
RESERVE 2 RequisitePro GROUP ProjectA
EXCLUDE ClearQuest GROUP ProjectB
To use the Groups attribute to set a limit to the number of available licenses, enter this line in the options file:
GROUP DeptA harris macdonald johnson nelson
GROUP DeptB mezias morin hecht
MAX 2 RequisitePro GROUP DeptA
MAX 3 ClearCase GROUP DeptB
Feedback