6 Shared Installations
14.3 Action Keywords
14.1 What Does This Reference Cover?
The information in this FLEXlm options file reference is limited to a discussion of those key words and commands that are immediately applicable to the license management instructions provided by Wind River. This section also includes an overview of the options file syntax.
Table 14-1 briefly describes the action keywords available for use in configuring your Wind River license manager.
NOTE: Information in this section is based on the reference information provided in the FLEXlm End User’s Guide from Macrovision. The information is provided in this guide for your convenience. Always consult the latest version of the FLEXlm End User’s Guide for complete and current information.
These options are discussed further in 14.3 Action Keywords, p.102. A complete reference of options file actions can be found in the FLEXlm End User’s Guide, available online at:
Table 14-1 Action Keywords
Keyword Description
BORROW_LOWWATER Sets the number of BORROW licenses that cannot be borrowed.
DEBUGLOG Write debug log information for a specified vendor daemon to a specified file, in the case of Wind River, wrsd.
EXCLUDE Deny a user access to a feature.
EXCLUDE_BORROW Deny a user the ability to borrow a BORROW license. EXCLUDEALL Deny a user access to all features served by wrsd. GROUP Define a group of users for use with any options. HOST_GROUP Define a group of hosts for use with any options. INCLUDE Allow a user access to a feature.
INCLUDE_BORROW Allow a user to borrow a BORROW license. INCLUDEALL Allow a user access to all features served by wrsd. MAX_BORROW_HOURS Changes the maximum borrow period for a specified
feature from the value specified in the license file. NOLOG Turn off logging of certain items in the debug log file. REPORTLOG Specify that a report log file be written, suitable for use
14 FLEXlm Options File Reference 14.2 Options File Syntax
14.2 Options File Syntax
The basic syntax of the options file is as follows:
action feature[:keyword=value] type user
For example:
INCLUDE WORKBENCH_UU_SUBSCRIPTION_cfg1 USER johnf
or
# Exclude these New York City developers.
EXCLUDE WR_SYSTEM_VIEWER:SIGN=141556876DE GROUP USER_NYC
Each line of the file controls one option.
14.2.1 Comments
Include comments in your options file by starting each comment line with a pound sign (#). Everything in an options file is case sensitive. Be sure that user names and feature names, for example, are entered correctly.
14.2.2 Feature Specification
The feature name can be modified with an optional keyword-value pair to fully qualify it. This notation is used for distinguishing a particular group of licenses when there are multiple FEATURE or INCREMENT lines for a single feature. The following syntax is used:
licenseServerComputer feature:keyword=value
For example:
WR_WORKBENCH:VERSION=2.0
or:
WR_DEBUGGER:SIGN=15308987AC
The keywords in Table 14-2 are a subset of those available for FLEXlm. They are used as feature name modifiers to denote a specific group of licenses:
If you specify an action in an options file using a package name in place of a feature name, for example, WORKBENCH_UU_SUBSCRIPTION_cfg1 instead of
WR_WORKBENCH, the action is applied to all package components.
14.2.3 Type Specification
The following action keywords restrict who can use licenses or where licenses can be used:
■ EXCLUDE ■ EXCLUDEALL ■ INCLUDE ■ INCLUDEALL
These actions specify the restriction based on the following type arguments: USER
The user name of the user executing the licensed application.
Table 14-2 Feature Name Modifiers
Keyword Definition
EXPDATE= The expiration date of your license agreement. HOSTID= The unique host ID of your license server.
KEY= The old-style checksum embedded in your FEATURE
or INCREMENT line.
SIGN= The new-style checksum embedded in your FEATURE or INCREMENT line.
VENDOR_STRING= The value of the vendor (Wind River) string in your FEATURE or INCREMENT line, if configured.
14 FLEXlm Options File Reference 14.2 Options File Syntax
DISPLAY is /dev/ttyxx (which is always /dev/tty when an application is run in the background) or the X-display name.
INTERNET
The IP address of the host where the application is executing. The IP address can contain wildcards.
PROJECT
The name of a project for which restricted user access is desired.
For licenses that allow checkouts from a terminal server (TS_OK keyword in the FEATURE line), the USER, HOST, and DISPLAY names can be different from one another.
The types listed above take a single value. For example:
EXCLUDE WORKBENCH_UU_SUBSCRIPTION_cfg1 USER joew
You can specify multiple values, such as a group of users or hosts, if you define them as a single value first using the action keywords GROUP and HOST_GROUP. For example, use GROUP to identify a group of project developers:
GROUP Dvdplayer joe barbara susan
EXCLUDE WORKBENCH_UU_SUBSCRIPTION_cfg1 GROUP Dvdplayer
14.2.4 Order of Precedence in the Options File
The INCLUDE and EXCLUDE options follow rules of precedence. Rules of
precedence take effect when INCLUDE and EXCLUDE statements are combined in the same options file and both are exercising control over access to the same features. The following define the precedence when both types of statements appear together:
EXCLUDE
Everyone not on the list is allowed to use the feature. INCLUDE
Only those users on the list are allowed to use the feature. All others are excluded.
If neither list exists, everyone is allowed to use the feature.
The EXCLUDE list is checked before the INCLUDE list; someone who is on both lists is not allowed to use the feature.
having to explicitly list each user permitted or denied access. In other words, there are two approaches:
■ Give most users access, and list only the exceptions.
■ Severely limit access, and list only users having access privileges.
14.3 Action Keywords
This section explains the action keywords used for Wind River license management. Each entry includes a definition of the keyword, an example of syntax, and explanations of associated arguments. For a complete reference of options file actions, see the FLEXlm End User’s Guide.
14.3.1 BORROW_LOWWATER
Set the number of BORROW licenses that cannot be borrowed. This action uses the following syntax:
BORROW_LOWWATER feature:keyword=value n
feature
Name of the feature being affected. keyword=value (optional)
Feature name modifier to denote a group of licenses. For details, see 14.2.2 Feature Specification, p.99.
n
Number of licenses that cannot be borrowed using license borrowing. For example, if the feature WORKBENCH_UU_SUBSCRIPTION_cfg1 has ten BORROW licenses (as configured on the FEATURE line of the license file), the
14 FLEXlm Options File Reference 14.3 Action Keywords
14.3.2 DEBUGLOG
Specify a location for the debug log output from the vendor daemon associated with this options file. This action uses the following syntax:
DEBUGLOG +debugLogPath
Preceding debugLogPath with a + character appends logging entries. Otherwise, the file is overwritten each time the vendor daemon is started.
Using DEBUGLOG affects output from only the vendor daemon associated with this options file. The debug log output of lmgrd and any other vendor daemons in the same license file is not captured in this file.
14.3.3 EXCLUDE
Exclude a user or pre-defined group of users from the list of who is allowed to use the feature. This action uses the following syntax:
EXCLUDE feature:keyword=value type name|groupName
feature
Name of the feature being affected. keyword=value (optional)
Feature name modifier to denote a group of licenses. For details, see 14.2.2 Feature Specification, p.99.
type
One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See 14.2.3 Type Specification, p.100.
name
Name of an item of type type for which to reserve licenses. groupName
Name of the group to exclude.
For example, to exclude the user hank from the list of users able to use feature
WORKBENCH_UU_SUBSCRIPTION_cfg1, as follows:
EXCLUDE WORKBENCH_UU_SUBSCRIPTION_cfg1 USER hank
NOTE: EXCLUDE supersedes INCLUDE. Conflicts between the EXCLUDE list and the INCLUDE list are resolved by EXCLUDE taking precedence.
14.3.4 EXCLUDE_BORROW
Exclude a user or pre-defined group of users from the list of who is allowed to borrow licenses for a given BORROW feature. This action uses the following syntax:
EXCLUDE_BORROW feature:keyword=value type name|groupName
feature
Name of the feature being affected. keyword=value (optional)
Feature name modifier to denote a group of licenses. For details, see 14.2.2 Feature Specification, p.99.
type
One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See 14.2.3 Type Specification, p.100.
name
Name of an item of type type for which to reserve licenses. groupName
Name of the group to exclude.
For example, to exclude the group windr from the list of groups able to borrow a license for the BORROW feature WORKBENCH_UU_SUBSCRIPTION_cfg1, use the following line:
EXCLUDE_BORROW WORKBENCH_UU_SUBSCRIPTION_cfg1 GROUP windr
14.3.5 EXCLUDEALL
Exclude a user or pre-defined group of users from the list of who is allowed to use
NOTE: EXCLUDE_BORROW supersedes INCLUDE_BORROW. Conflicts between the EXCLUDE_BORROW list and the INCLUDE_BORROW list are resolved by EXCLUDE_BORROW taking precedence.
14 FLEXlm Options File Reference 14.3 Action Keywords
name
Name of an item of type type for which to reserve licenses. groupName
Name of the group to exclude.
For example, to exclude any user on the computer jupiter from using all features served by this vendor daemon, add the following line to your options file:
EXCLUDEALL HOST jupiter
14.3.6 GROUP
Define a group of users for use in the INCLUDE, INCLUDEALL, EXCLUDE, EXCLUDEALL, and RESERVE option lines. This action uses the following syntax:
GROUP groupName userList
groupName
Name of the group being defined. userList
List of user names in that group.
For example, to define a group called Hackers that consists of bob, howard, and james, use the following line:
GROUP Hackers bob howard james
If the number of members in a group exceeds the line length limit, use multiple GROUP lines for the same group name to add all of the specified users to the group.
14.3.7 HOST_GROUP
Define a group of hosts for use in the INCLUDE, INCLUDEALL, EXCLUDE, EXCLUDEALL, and RESERVE option lines. This action uses the following syntax:
HOST_GROUP groupName hostList
groupName
Name of the group being defined. hostList
For example, to define a host group called Pacific that consists of tokyo, seattle, and auckland, use the following line:
HOST_GROUP Pacific tokyo seattle auckland
An IP address can be used anywhere a host name can be used in an options file. If the number of members in a host group exceeds the line length limit, use multiple HOST_GROUP lines to add all the specified hosts into the group.
14.3.8 INCLUDE
Include a user or pre-defined group of users in the list of who is allowed to use licenses for this feature. Anyone not in an INCLUDE statement is not allowed to use that feature.This action uses the following syntax:
INCLUDE feature:keyword=value type name|groupName
feature
Name of the feature being affected. keyword=value (optional)
Feature name modifier to denote a group of licenses. See 14.2.2 Feature Specification, p.99.
type
One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See 14.2.3 Type Specification, p.100.
name
Name of an item of type type for which to reserve licenses. groupName
Name of the group to include.
For example, to include bob in the list of users able to use feature
WORKBENCH_UU_SUBSCRIPTION_cfg1, use the following line:
INCLUDE WORKBENCH_UU_SUBSCRIPTION_cfg1 USER bob
14 FLEXlm Options File Reference 14.3 Action Keywords
14.3.9 INCLUDE_BORROW
Include a user or pre-defined group of users in the list of who is allowed to borrow licenses for a given BORROW feature. Anyone not in an INCLUDE_BORROW statement is not allowed to borrow licenses for the specified feature. This action uses the following syntax:
INCLUDE feature:keyword=value type name|groupName
feature
Name of the feature being affected. keyword=value (optional)
Feature name modifier to denote a group of licenses. See 14.2.2 Feature Specification, p.99.
type
One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See 14.2.3 Type Specification, p.100.
name
Name of an item of type type for which to reserve licenses. groupName
Name of the group to include.
For example, to include windr in the list of groups able to borrow a license for the BORROW feature WORKBENCH_UU_SUBSCRIPTION_cfg1, use the following line:
INCLUDE_BORROW WORKBENCH_UU_SUBSCRIPTION_cfg1 GROUP windr
INCLUDE is required for user-basedor host-based features. For unique user licensees, if you want to limit the number of users to the number of licensed seats, use an INCLUDE statement to define who has access.
NOTE: EXCLUDE_BORROW supersedes INCLUDE_BORROW. Conflicts between the EXCLUDE_BORROW list and the INCLUDE_BORROW list are resolved by the EXCLUDE_BORROW taking precedence.
14.3.10 INCLUDEALL
Include a user or pre-defined group of users in the list of who is allowed to use all features served by this vendor daemon. Anyone not in an INCLUDEALL statement is not allowed to use these features. This action uses the following syntax:
INCLUDEALL type name|groupName
type
One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See 14.2.3 Type Specification, p.100.
name
Name of an item of type type for which to reserve licenses. groupName
Name of the group to include.
For example, to allow jane to use all features served by this vendor daemon, use the following line:
INCLUDEALL USER jane
14.3.11 MAX_BORROW_HOURS
Changes the maximum number of hours (as specified in the license file) a BORROW license feature can be borrowed for. The new period must be less than the period specified in the license file. This action uses the following syntax:
MAX_BORROW_HOURS feature:keyword=value n
feature
Name of the feature being affected. keyword=value (optional)
Feature name modifier to denote a group of licenses. See 14.2.2 Feature Specification, p.99.
n
14 FLEXlm Options File Reference 14.3 Action Keywords
14.3.12 NOLOG
Suppress logging the selected type of event in the debug log file. This action uses the following syntax:
NOLOG eventType
eventType
The type of event you wish to suppress logging of: IN, OUT, DENIED, or QUEUED.
For example, turn off the logging of checkins as follows:
NOLOG IN
Turn off the logging of checkouts and queued requests, as follows:
NOLOG DENIED NOLOG QUEUED
Note that two separate NOLOG lines are required.
14.3.13 REPORTLOG
Specify the report log file for this vendor daemon. This action uses the following syntax:
REPORTLOG +reportLogPath
Preceding reportLogPath with a plus (+) character appends logging entries; otherwise, the file is overwritten each time the daemon is started.
NOTE: If multiple MAX_BORROW_HOURS keywords are specified in the options file, only the last one is applied to the specified feature.
NOTE: License administrators use this option to reduce the size of the debug log file. However, it can also reduce the usefulness of the debug log for debugging license server problems.
NOTE: The REPORTLOG action keyword is required for Wind River license reporting.