License Manager Specific Environment Variables

As an alternative way, the following environment variables can be used for configuring the License Manager.

The LSDEFAULTDIR environment variable can be used to set the default location for License Manager files (such as lservrc, lservlf, etc).

The folder that the system sets by default is the directory where the License Manager executable is located.

NOTE   It is recommended not to change the default directory for the License Manager.

For example:

Operating System Example Outcome
Windows

SET LSDEFAULTDIR=C:\LS_FILES

 Tells the License Manager that the default directory for License Manager files is a directory named, C:\LS_FILES
UNIX export LSDEFAULTDIR=/home/LS_FILES Tells the License Manager that the default directory for License Manager files is a directory named, /home/LS_FILES.

The LSERVRC environment variable can be used to set the name and location of the license code file. By default, this file will be called lservc and reside in the License Manager default directory.

NOTE   It’s recommended that the default name and location are used for this file.

For example:

Operating System Example Outcome
Windows

SET LSERVRC=NETWORK.LIC

 Tells the License Manager that license code file is in the current directory, but named, network.lic
Windows

SET LSERVRC=C:\LS_FILES\NETWORK.LIC

 Tells the License Manager running that license code file name and path is, C:\LS_FILES\NETWORK.LIC
UNIX export LSERVRC=NETWORK.LIC Tells the License Manager that license code file is in the current directory, but named, network.lic
UNIX export LSERVRC=/home/LS_FILES/NETWORK.LIC Tells the License Manager that license code file name and path is, /home/LS_FILES/NETWORK.LIC

The LSERVRCCNF environment variable can be used to set the custom name and location of the License Manager general purpose configuration file. This file contains readable license remap statements and alert action statements. If LSERVRCCNF is not used to specify the configuration file, then the name and location of this file will be based on the name and location of the license code file. Therefore, the configuration file will be searched in the same directory as the license code file and have the same base name as the license code file but with the extension .cnf.

NOTE   Typically, the License Manager configuration file is called lservrc.cnf and resides in the License Manager default directory. It’s recommended that the default name and location are used for this file.

For example:

Operating System Example Outcome
Windows SET LSERVRCCNF=C:\LS_FILES\NETWORK.CNF Tells the License Manager that configuration file is in the C:\LS_FILES directory and named, network.cnf:  
Windows SET LSERVRCCNF=NETWORK.CNF Tells the License Manager that configuration file is in the default directory (which will be the License Manager directory) and named, network.cnf:  
UNIX export LSERVRCCNF=/home/LS_FILES/NETWORK.CNF Tells the License Manager that configuration file is in the /home/LS_FILES directory and named, network.cnf:  
UNIX export LSERVRCCNF=NETWORK.CNF Tells the License Manager that configuration file is in the default directory (which will be the License Manager directory) and named, network.cnf:  

The LSRESERV environment variable can be used to set the name and location of the License Manager reservation file. This file is used by a system administrator to specify the machines and users who are authorized to run a licensed application. It is recommended to use the default name and location for this file. By default, this file will be called lsreserv and reside in the License Manager default directory.

For example:

Operating System Example Outcome
Windows SET LSRESERV=RESERVE Tells the License Manager that the license reservation file is in the current directory but named, "reserve"
UNIX export LSRESERV=RESERVE

The License Manager port number is used by the UDP protocol when transferring data between the License Manager and the client. Do not change the port number unless your software vendor has instructed you to do so or conflicts are occurring between the License Manager and another network application that is using the License Manager’s port number. (The License Manager default port number is 5093, and has been registered to Thales, Inc.) A symptom of such a conflict would be License Manager communication errors.

For example:

Operating System Example Outcome
Windows SET LSPORT=5093 Tells the License Manager to use the port number 5093
UNIX export LSPORT=5093

This environment variable can be used to get the name of the error log file.

When Tracing is disabled and this environment variable is set, the LSERVLOG event is triggered. Due to this, Error Logs are generated which collect the same information in logs as Tracing at level 4.

On the contrary, when Tracing is enabled and this environment variable is set, Trace Logs get a higher priority and the environment variable is suppressed. Due to this, the LSERVLOG event is not triggered and Error Logs are not generated. Trace logs get generated and they store information at the level which has been set. The Trace Log file will also be stored at the defined location.

For further details, refer to Levels of Tracing

For example:

Operating System Example Outcome
Windows SET LSERVLOG=C:\Error.log Tells the License Manager that the error log file is in the "C: "drive and named “Error.log
UNIX export LSERVLOG=/home/test/Error.log Tells the License Manager that the error log file is in “/home/test” directory and named “Error.log”

This environment variable can be used to set the location of LSERVSTA log file. If you want to store this file at some other location, set the "LSERVSTA" environment variable with a valid path.

For example:

Operating System Example Outcome
Windows SET LSERVSTA=C:\Usage.log Tells the License Manager that the lservsta log file is in the "C: "drive and named “Usage.log”
UNIX export LSERVSTA=/home/test/Usage.log Tells the License Manager that the lservsta log file is in “/home/test” directory and named “Usage.log”

This environment variable can be used to set the name and location of the upgrade file. This file contains the upgrade license string. By default, the License Manager searches for this file at its current location.

For example:

Operating System Example Outcome
Windows SET ULSERVRC=C:\Update\upgrade_code Tells the License Manager that the upgrade license string is available in the file “upgrade_code” and located in “C:\Update” folder
UNIX export ULSERVRC=/home/test/upgrade_code Tells the License Manager that the upgrade license string is available in file “upgrade_code” and located in “/home/test” directory

The LS_LOG_ANONYMITY environment variable can be used to enable or disable the anonymous usage logging of the following information in the RMS License Manager usage log files. You can enable or disable client-side anonymous logging, by setting its value to 1 or 0.

> User name

>Host name

>Any log comments inserted by the software vendor

An example

Operating System Example Outcome
Windows SET LS_LOG_ANONYMITY=1

Enables client-side anonymous usage logging

UNIX export LS_LOG_ANONYMITY=1

The environment variable is applicable to Sentinel RMS usage log only.

Refer to the information about Anonymous Usage Logging Option.

The LSUSGHOSTNAME environment variable is used to customize the hostname (where either RMS License Manager or standalone application is running) in the usage log to hide the real information. This environment variable is applicable to cloud-based usage log only.

An example

Operating System Example Outcome
Windows SET LSUSGHOSTNAME= CUSTOMHOSTNAME

Customizes the hostname
UNIX export LSUSGHOSTNAME= CUSTOMHOSTNAME