LSERVOPTS and Command-line Options

The following table below lists the various options that can be set using.

> LSERVOPTS - The environment variable that can be used to configure the License Manager.

>Command-line - The options can be set on both Windows (See How to Set) and UNIX (using the lserv process)

The last column in the table points the specific environment variables which can instead used to set a particular option. Any settings made with LSERVOPTS will be overridden by any settings made using a specific environment variable. To avoid contradictory settings, it is recommended that the specific environment variables be used whenever possible.

Options-Description Specific Environment Variable
-s <license-file>

By default, the license file is named lservrc and is placed in the same directory in which the License Manager resides. It may contain multiple license codes. Usually, the Sentinel RMS utilities (lslic, WlmAdmin and lsmon) are used to install the license code in the license file.

Here are few recommended settings for the license file:

>For non-redundant License Managers, the default name of the license file is lservrc. For redundant License Managers, the redundant license should be added in the lservrlf file. A redundant License Manager can service both redundant and non-redundant license codes, if both types of license files are available to the License Manager.

>The License Manager must have read/write access to the license file when the license installation program is being executed. If you are facing a problem installing license codes, then you should verify that the License Manager has read/write access to the license file.

>If the License Manager cannot find the license file and error tracing is enabled, it will log the errors in the trace file.

LSERVRC
-e <license-configuration-file>

Specifies the name and location of the optional license configuration file. The license configuration file can contain the following:

>Remap statements for readable license strings If you have used remap statements for generating readable license codes, you need to ship them to your customers with the License Manager and the lsdecode utility (only if you send lsdecode to your customers).

>Alert specifications for a license code The system administrator can optionally invoke alerts using a script or an e-mail under certain scenarios.

By default, the License Manager will look for the configuration file in the License Manager local directory. Alternatively, the location of the configuration file can also be provided by the environment variable, LSERVRCCNF or via the -e option.

The License Manager appends the .cnf extension to the license configuration file path and filename and searches for license-file-name.cnf.

See also: Alert Specifications.

LSERVRCCNF
-l < usage-log-file>

Sets the name and location of the License Manager’s usage log file. The usage log can give you a good idea about how much each application is being used.

NOTE   Usage logging remains enabled on license addition for RMS version 7 and later licenses.

On Windows, the default name and location for the usage log file is:

>On Windows 32-bit - <OSdrive>:\Windows\System32\lservsta

>On Windows 64-bit - <OSdrive>:\Windows\SysWOW64\lservsta

On UNIX, the default name of the usage log file is lservsta and is created at the location where the License Manager program (lserv) exists.

NOTE   Do not specify .xml as the extension name of the usage log file. If done, the License Manager will not start.

 
-extended-log

Apart from the information included in the plain logs (generated when the extended-log is not used), the extended log option contains the following additional details:

>The transaction IDs corresponding to the implicit entries. In case of plain logs, the implicit license request entries are collectively represented by transaction ID 0 and the implicit license release entries are collectively represented by transaction ID 2.

>The Client ID that requested or released a license token.

 
-f <trace-log-file>

Specifies the name and location of the trace log file. The specified location should refer to an existing directory structure. If the specified location (or any particular directory) does not exist, the trace file is not created.

 

By default, trace logging is disabled.

 
-tr <level>

Sets the tracing level defined here.

 
-z <file-size>

Sets the maximum size of both the usage and trace file log (if logging is enabled).

>The size can be specified in bytes, kilobytes, or megabytes. For instance, -z 2000 means 2000 bytes, -z 2k means 2 kilobytes, -z 2m means 2 megabytes.

>The default value is 50,00000 bytes (approximately 4.76MB).

> The minimum value for a usage log file is 1000 bytes.

 
-x

Disables automatic backup of the usage and trace log files in case of overflow. In other words, if the -x option is specified, the log file (both usage and trace log) will not be backed up on overflow and the License Manager will stop writing further records to the log file.

 

See also: Managing the Size and Number of the Log Files

 
-port <port-number>

The License Manager port number 5093 is used by the TCP/IP protocol when transferring data between the License Manager and the client. If that port is in use, any other port can be set using the -port startup option.

LSPORT
-com <percentage>

Commuter licensing uses the same license tokens as other network licenses. To ensure that not all license tokens are used up by commuters, set the -com option to the percentage of license tokens you want to be used for commuter licensing. Once that percentage of tokens are used by commuter licenses, no more will be made available to commuters until tokens are returned.

 
-rlf < redundant-license-file>

Starts the License Manager as a redundant License Manager using the specified redundant license file. The file, lservrlf, is created using the rlftool or WRlfTool utilities (or by using WlmAdmin to call WRlfTool) to define the redundant License Manager pool. By default, the License Manager’s local directory is searched for the lservrlf file to start the License Manager as a redundant License Manager.

NOTE   You do not need to use this option to start the License Manager as a redundant License Manager if a lservrlf redundant license file is in the same directory as the License Manager.

 
-lfe <encryption-level>

Specifies the level of encryption with which license transactions will be written to the license server log file, 1 to 4. For a discussion of why you might want to encrypt transactions and for information on the different levels, see Setting Usage Logging.

NOTE   Your software vendor can override your encryption level choice for specific license codes.

 
-u <group-reservations-file>

Specifies the name and location of the optional group reservations file.

The group reservation feature helps you restrict the use of the licensed application to particular users, groups, or computers. A group reservation file lsreserv is generated using the WlsGrMgr utility. It contains information about how many license tokens are reserved for members of different groups.

By default, the License Manager uses the lsreserv file in the current directory.

LSRESERV
-us

Use this option to specify upgrade license file.

 

If the base licenses lservrc is installed in the same directory in which the License Manager resides, then the upgrade license file ulservrc must reside in the same directory.

If the base license is installed at a custom location (using the -s option or LSERVRC environment variable), then the upgrade license location can be configured using the -us option or ULSERVRC environment variable.

ULSERVRC
-sbm <socket buffer size multiplier>

Use this option to increase the socket buffer size.

There can be a scenario when multiple client applications are getting timed out while accessing the License Manager and error ‘The License Manager is not running’ is being displayed. To overcome this problem, the administrator can try to increase the default socket buffer size assigned by the operating system for the RMS License Manager.

To change the size of default socket buffer, a multiplier value is assigned using this option. The multiplier increases the current buffer size by n times—subjected to the condition that the resultant socket size is within the maximum permissible size allowed by the operating system. Otherwise, the socket size is not updated.

For example, assume the default socket buffer size of 2000 bytes, the multiplier value as 4, and maximum permissible size of socket buffer as 2500 bytes. Here, the given option will not change the socket buffer size to (2000*4) 8000 bytes because this value is more than the maximum permissible size defined by the operating system. The default socket buffer size will remain unchanged (2000 bytes).

On Windows, the allocated socket buffer size is logged in the Windows event log after RMS License Manager startup. On UNIX based platforms, this information is displayed on the console while starting the License Manager.

NOTE   If any invalid multiplier value is provided, the default buffer size remains unaltered. On Windows, a message is also added to the Application Event log. On UNIX based platforms, a similar message is displayed on the console.

 
-q

Quiet mode. When this option is specified, the License Manager will start up quietly without displaying its banner. Unexpected conditions will still be logged as usual. (UNIX only.)

 
-log-anonymity

Allows anonymous logging in the usage log files. As a result, real information for the following entries is shown anonymously in the usage log line:

> User name

>Host name

>Any log comments inserted by the software vendor

Correspondingly, an XML file is generated along with the usage log file. The XML file maps the anonymous details with the real ones. It would be kept at the same path and will have the same name as the usage log file and .xml extension.

The format of the XML file is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<map Product="Sentinel RMS License Manager v8.5.3.0000"XmlCreationTime="Thu Sep 10 20:02:30 2012">
  <mapRecord Original="hostName1" Anonymous ="ABCDE123456"/>
  <mapRecord Original="hostName2" Anonymous ="ABCDE123457"/>
  <mapRecord Original="user1" Anonymous ="ABCDE123458"/>
  <mapRecord Original="user2" Anonymous ="ABCDE123459"/>
  <mapRecord Original="logComment" Anonymous ="ABCDE123450"/>
</map>

Where,

>Product is the RMS License Manager and its version.

>XmlCreationTime – The time when the map file was originally created. This time will not change even when the License Manager is restarted.

>mapRecord – Each line containing a unique mapping of original to anonymous details. Any new entries are added into the same file.

LS_LOG_ANONYMITY

EXAMPLE

For example, to tell the License Manager running on a Windows computer to set a 2 megabyte limit on the log file, to stop logging when the file size limit is reached, and to start the License Manager in quiet mode, use the following command:

SET LSERVOPTS=-z 2m -x -q  

See Also

Ways to Set the License Manager Options