Options file syntax

The options file is a plaintext file that is read by the activation server when it determines the activation request to grant a license to a client. Each line of the options file control one option identified by a keyword. The keyword implementation options are specified using the following syntax items:
  • count
    The limit being defined by the element
  • featurekey
    The
    Rockwell Automation
     software this element applies to, identified by executable name.
  • USER, HOST, DISPLAY, GROUP or HOST_GROUP
    Identifies the type of account to which to apply the element.
  • name
    Identifier for the account, such as a user name, group name, or IP address
The following keywords are used to define the behavior specified by the options file:
Keyword
Syntax
Example
BORROW_LOWWATER
Sets limit of licenses that cannot be borrowed.
There must be more than one install available for borrowing to use this option.
BORROW_LOWWATER [featurekey] [count]
BORROW_LOWWATER RSLINX.EXE 3
Restricts three licenses of
RSLinx
 from being available to borrow.
DEBUGLOG
Specifies a location for the debug log output. Precede the
debug_log_path
 with a + character to append log entries to the existing file; otherwise, the log file is overwritten with each restart of the service FactoryTalk Activation Service.
DEBUGLOG [+] [debug_log_path]
DEBUGLOG +C:\Logs\RSsvr.log
Will append log entries to C:\Logs\RSsvr.log
DEBUGLOG C:\Logs\RSsvr.log
Log file C:\Logs\RSsvr.log will be overwritten when FactoryTalk Activation Service is started.
EXCLUDE
Creates a list of users, groups, or computers that are prevented from using the software. If a user or group is identified by an INCLUDE element as well as an EXCLUDE element, the user or group is excluded. To give a previously excluded user or group permission to use the software, remove them from the EXCLUDE list.
EXCLUDE [featurekey] [USER | HOST | DISPLAY | GROUP | HOST_GROUP] [name]
EXCLUDE RSLINX.EXE USER jondoe
Prevents a user named
jondoe
 from using
RSLinx
.
EXCLUDE RS5K_700.EXE HOST 10.15.123.*
Prevents computers in the 10.15.123 network from using the
Logix Designer
 application.
EXCLUDE_BORROW
Creates a list of computers or groups of computers that are prevented from borrowing an activation for a software application. If a computer is identified by an INCLUDE_BORROW element, as well as an EXCLUDE_BORROW element, the computer is excluded. To give previously excluded computers permission to borrow an activation for a software application, remove them from the EXCLUDE_BORROW list.
Tip:
A specific user cannot be excluded from borrowing a license. A borrowed license is available for all users logged into the computer.
EXCLUDE_BORROW [featurekey] [HOST | HOST_GROUP] [name]
EXCLUDE_BORROW RS5K_700.EXE HOST 10.15.123.*
Prevents computers in the 10.15.123 network from borrowing activations for the
Logix Designer
 application.
EXCLUDEALL
Creates a list of users, groups, or computers that are prevented from using all
Rockwell Automation
 software activations on the activation server.
EXCLUDEALL
[USER | HOST | DISPLAY | GROUP | HOST_GROUP]
[name]
EXCLUDEALL GROUP officepcs
Prevents the
officepcs
group from using any applications managed by the activation server.
GROUP
Used to define a group name for a list of user account names. Use the group name to assign options or a group of users instead of specifying each user individually. Group and User names are case-sensitive by default.
GROUP [group_name] [user1] [user2] [userN]
GROUP authusers Frank Sarah Will
Creates a group of users called
authusers
, consisting of
Frank
,
Sarah,
and
Will
.
GROUPCASEINSENSITIVE
Turns on case insensitivity for groups and group members.
Does not turn on case insensitivity for the group name.
GROUPCASEINSENSITIVE ON
GROUPCASEINSENSITIVE ON
GROUP testgroup usr
EXCLUDE RSLINX.GW GROUP testgroup
Excludes the user
usr
or
USR
from checking out the RSLINX.GW license.
HOST_GROUP
Defines a group of host computers. Use Multiple HOST_GROUP lines to add all the specified hosts into the group. Host computers can be specified using computer names or IP addresses. Host names are case insensitive.
HOST_GROUP [group_name] [host1] [host2] [hostN]
HOST_GROUP officepcs frontdeskpc accountingpc1 accountingpc2
Creates a group of host computers called
officepcs
consisting of PCs named
frontdeskpc
,
accountingpc1
, and
accountingpc2
.
HOST_GROUP plantfloor 10.15.*
Create a group of host computers called
plantfloor
that includes all PCs with IP addresses starting with 10.15.
INCLUDE
Creates a list of users, groups, or computers that are allowed to use the software. If a user or group is identified by an INCLUDE element as well as an EXCLUDE element, the user or group is excluded. To give a previously excluded user or group permission to use a feature, remove them from the EXCLUDE list.
INCLUDE [featurekey] [USER | HOST | DISPLAY | GROUP | HOST_GROUP] [name]
INCLUDE RSLINX.EXE USER jondoe
Allows a user named
jondoe
to activate
RSLinx
.
INCLUDE RS5K_700.EXE HOST 10.15.123.*
Allow computers in the 10.15.123 network to activate the
Logix Designer
 application.
INCLUDE_BORROW
Creates a list of computers or groups that are allowed to borrow an activation for a feature. If a computer or group is identified by an INCLUDE_BORROW element as well as an EXCLUDE_BORROW element, the computer or group is excluded. To give a previously excluded computer or group permission to borrow an activation for a feature, remove them from the EXCLUDE_BORROW list.
Tip:
 A specific user cannot be allowed to borrow a license. A borrowed license is available for all users logged into the computer.
INCLUDE_BORROW [featurekey] | HOST | HOST_GROUP] [name]
INCLUDE_BORROW RS5K_700.EXE HOST 10.15.123.*
Allows computers in the 10.15.123 network to borrow activations for the
Logix Designer
 application.
INCLUDEALL
Creates a list of users, groups, or computers that are allowed to use any of the
Rockwell Automation
 software activations on the activation server.
INCLUDEALL [USER | HOST | DISPLAY | GROUP | HOST_GROUP] [name]
INCLUDEALL GROUP plantadmins
Allows the members of the
plantadmins
group to use any applications managed by the activation server.
MAX
Limits the usage of a software application for a user or group.
MAX [count] [featurekey] [USER | HOST | DISPLAY | GROUP | HOST_GROUP] [name]
MAX 3 RSLINX.EXE GROUP China
Allows only 3 users in the
China
group to run
FactoryTalk® Linx
 at one time.
MAX_BORROW_HOURS
Changes the maximum time for which a license can be borrowed. New duration must be less than in the original license certificate.
MAX_BORROW_HOURS [featurekey] [count]
MAX_BORROW_HOURS RS5K_700.exe 36
Sets the maximum borrow time limit for borrowed activations for the
Logix Designer
 application to 36 hours.
NOLOG
Disables logging of a specific type of event in the log file. The event types are:
  • IN - Check in of activations
  • OUT - Check out of activations
  • DENIED - Activations denied
  • QUEUED - Activation request queued
NOLOG [IN | OUT| DENIED | QUEUED]
NOLOG IN
Turns off logging of activations checked in.
RESERVE
Holds a license back to be used by a specific user, computer, or group.
RESERVE [count] [featurekey] [USER | HOST | DISPLAY | GROUP | HOST_GROUP] [name]
RESERVE 1 RSlgx5.exe HOST electricianbullpen_pc
Verifies that the computer named
electriacianbullpen_pc
 will always have an available activation for the
Logix Designer
 application.
TIMEOUT
Sets the time in seconds after which inactive licenses for a specific product are freed and reclaimed by the activation server.
TIMEOUT [featurekey] [count]
TIMEOUT RSlgx5.exe 3600
Reclaims
RSLogix 5
 licenses that have been inactive for 1 hour (3600 seconds).
TIMEOUTALL
Sets the time in seconds after which inactive licenses for all products are freed and reclaimed by the activation server.
TIMEOUTALL [count]
TIMEOUTALL 7200
Reclaims any licenses that have been inactive for 2 hours (7200 seconds).
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.