Floating License Installation

License Server Distribution

If you are using a floating license you will need to download our license tools which includes our specific ISV files and license server. You can find the latest release at License Tool Distribution.

Running the License Server

The rlm command is::

% rlm [-c license_file] [-dlog [+]logfile]
    [-nows] [-ws port] [-x [rlmdown|rlmremove]]
    [-install_service] [-service_name sname]
    [-isv_startup_delay seconds]

The -c license_file option specifies which license file to use. This option overrides the setting of the RLM_LICENSE environment variable. The license_file parameter can be a directory containing license files, all of which will be processed.

The -dlog logfile specifies the pathname for the server debug log. If logfile is preceded by the ‘+’ character, the logfile will be appended, otherwise it is overwritten.

The -nows and -ws port options control the operation of the embedded Web Server. The -nows option instructs the rlm server to not start the embedded web server. The -ws port option instructs the rlm server to use port as the port number for the web server.

The -x [rlmdown | rlmremove] option controls whether the rlmdown and/or rlmremove commands will be processed by the server. Specifying only -x will disable both commands. Specifying either command name after the -x will disable just that command.

These options can appear in any order on the command line.

Note that if the rlm server cannot bind the web server port (5054 by default), it will exit.

Accessing the Server from Clients

Once you have a license server up and running you need to tell the client where to find it, this is done with either the peregrinel_LICENSE environment variable or a client side license file.

The environment variables should be set to port@hostname where port is the TCP/IP port of the license server and hostname is the name of the license server. For example:


If you are unfamiliar with the process of setting environment variables for your specific platform here please refer to the Setting Global environment variables section of the documentation - if using Linux you should add these to your .tcshrc, .cshrc or .bashrc files depending on what Shell you’re using.

An alternative way is to use a client side license file, this can be a simple text file placed in one of

Mac: /Library/Application Support/PeregrineLabs/rlm/

Linux: /var/PeregrineLabs/rlm/

Windows: C:/ProgramData/PeregrineLabs/rlm/

with the contents::

HOST <server_name> 5053
ISV peregrinel

where server_name is the name of your license server.

RLM Embedded Web Server

The rlm server contains an embedded Web Server which can be used to perform most administration of the rlm server itself. The web server allows you to retrieve server and license status (similar to rlmstat), cause the servers to re-read the license files (rlmreread), switch debug (rlmswitch) or report log (rlmswitchr) files, move the current report log file to a new name (rlmnewlog), or shut down the license servers (rlmdown). Using this web-based interface, you can administer the license servers from any platform, and you do not need to install the rlm utilities - you only need a web browser.

The web server is started automatically on port 5054 when rlm is started. To use the web server, simply point your browser to: http://ServerHostName:5054 and select the operation you would like to perform. You will be prompted for any required information.

If you would like to run the web server on a different port, specify the -ws NNNNN command-line argument when starting rlm, where NNNNN is the desired port.

The RLM web server is 100% self-contained in the rlm binary; no additional html files are required for operation.

Setting Timeouts for Checked Out Licenses

In some situations it’s likely that a client may hold onto a checked out license longer than the lifetime of the application - when Maya crashes for instance. The reason being is that because of the early exit from the application the code used to return the license to the license server was unable to run.

To avoid zombie licenses the TIMEOUT ISV option may be used to tell RLM to release licenses owned by instances that haven’t sent a heartbeat back to the server for the specified amount of time.

You can edit the peregrinel options file by navigating to the RLM web interface and selecting the Status option. Find the peregrinel ISV server and select peregrinel in the Options column. Once editing the options file add TIMEOUT <num seconds> peregrinel - the minimum value for <num seconds> is 3600 ( one hour ).

Once you’re happy with the changes use the Update Options button to save your changes and Reread the server ( to force the options to take effect ).

Serving Licenses for Multiple RLM ISV’s

When you have licensed software from multiple ISVs, you have two choices for how to configure rlm and the ISV servers when running them on a single license server system.

The first choice is to keep them entirely separate, using separate installation directories and port numbers for the client and web interface. Although conceptually simple management and use becomes more complex, the number of used ports are increased and there will be multiple web interfaces to check license usage.

The second choice is to run a single instance rlm, which manages two (or more) ISV servers. This is the method recommended by ourselves and Reprise Software and is much simpler to manage, you only have a single RLM port to be managed and a unified web interface.

To do this you need to make sure you choose the latest version of the RLM license manager supplied by the vendors ( they are backwards compatible ) or better yet, download the latest version from Reprises website ( http://www.reprisesoftware.com/enduser_kits/end-useragreement.php ).

Copy over the <ISV>[.exe] or <ISV>.set files from all of the vendors.

Copy over all of the .lic ( license ) files supplied by all of the vendors.

Once all of the required files have been copied the RLM server can be started as usual, use the web interface to confirm that all relevant licenses have been accounted for.