Q100659: What are the RLM utilities (rlmutil) and how can I use it?

Roshan Khadka

Updated : April 01, 2025 10:56

Created : August 19, 2022 04:30

SUMMARY

The RLM utilities are installed as part of the Foundry License Utility. This utility includes a range of arguments that allow you to better manage your license server via a command prompt/terminal.

MORE INFORMATION

To run the RLM utilities:

1. Open a command prompt or terminal
2. Navigate to rlmutil via the following command
1. Windows:
   cd C:\Program Files\The Foundry\LicensingTools9.0\bin\RLM 
2. Mac:
   cd /Applications/TheFoundry/LicensingTools9.0/bin/RLM/
3. Linux:
   cd /usr/local/foundry/LicensingTools9.0/bin/RLM/
3. To query rlmutil, enter:
   Windows: rlmutil <command> <args>
   Mac/Linux: ./rlmutil <command> <args> 

Please note that you need to specify the port@host by typing -c port@server after the program arguments.

COMMANDS

You can find a list of useful commands available in rlmutil in the section below.

rlmdebug

Function:
The debug command helps locate how many instances of a certain product are in use, this works by entering rlmdebug followed by the product license you wish to debug.

Example:

The following example debugs your nuke_i licenses on port 4101 on the ISV server named foundry:

rlmutil rlmdebug nuke_i -c 4101@<hostname>

rlmdown

Function:
This allows you to shutdown the license server by entering rlmdown followed by the server you wish to shutdown.

Example:
The following example shuts down the foundry server on port 4101 with your license servers hostname:

rlmutil rlmdown foundry -c 4101@<hostname>

rlmhostid

Function:
You can use rlmhostid  to display different host id from particular pieces of hardware in your computer.

Example:
The following example shows how to find your System ID:

rlmutil rlmhostid ether

rlmnewlog

Function:
Rlmnewlog helps to rename an existing log file from your ISV server. Please note, that this will fail and an error will show if the license server is not currently writing a report log.

Example:
The following example shows how to rename a log file to your desktop:

rlmutil rlmnewlog C:\users\username\Desktop\logfile.txt -c 4101@foundry

rlmremove

Function:
The rlmremove command allows you to delete a particular server.

Example:
The following example shows how to remove a license server named test on port 4101:

rlmutil rlmremove hostname 4101 test -c 4101@foundry

rlmreread

Function:
You can use this command to reread the license file on the server.

Example:
To reread a specific ISV, please enter the ISV in:

rlmreread [isv]

If the ISV is not specified, it sends reread requests to all RLM servers. An example code to reread foundry license file:

rlmutil rlmreread

rlmstat

Function:
The rlmstat command displays statistics based on what arguments are entered. The list of options available are:

Example:
The following example shows the license status and checkout information for an ISV name foundry:

rlmutil rlmstat -a -i foundry -c 4101@<hostname>

rlmswitch

Function:
The rlmswitch command helps relocate your current rlm log file to a new path.

Example:
The following example shows how to change your location to your desktop:

rlmutil rlmswitch foundry C:\newfile.txt -c 4101@<hostname>

FURTHER READING 

More information on RLM License Administration can be found in the RLM documentation: https://www.reprisesoftware.com/RLM_License_Administration.pdf 

Information on RLM commands can also be found in our docs via the following link:

https://learn.foundry.com/licensing/Content/User_Guide/LicensingFloat/Useful_Commands.html