Interfacing the Reprise RLM license manager – KB4001b
This document describes the steps required to interface OpenLM with the Reprise License Manager (RLM) in order to monitor license usage and obtain license statistics.
To query the RLM server OpenLM Server v4.3 or higher must be installed on a machine in your organization.
Installing OpenLM Broker is optional but highly recommended in order to take advantage of additional monitoring and control features.
Monitoring capabilities will depend on which method you choose to query the RLM license server:
- Querying remotely through OpenLM Server gives you only license totals and license usage data.
- Querying locally through OpenLM Broker gives you the same data as when queried through Server plus additional benefits such as:
- Buffered communication with the OpenLM Server in order to overcome temporary network failures
- Ability to remotely start / stop the license manager service
- Access to license denial information
- 1-second resolution for license usage reports
- Ability to read Reprise RLM license and log files
- Ability to view RLM license file content in EasyAdmin
Diagram of how OpenLM interfaces with the Reprise License Manager using OpenLM Server only
In order to get OpenLM Server to query the RLM license server:
- After installing OpenLM Server (guide), click Windows Start → OpenLM → OpenLM Server. The OpenLM Server configuration tool will open.
- Select the LM Tools tab located on the left side.
- Select the RLM tab.
- Copy rlmutil.exe from the RLM folder to “C:\Program Files\OpenLM\OpenLM Server\LM” (32bit) or “C:\Program Files (x86)\OpenLM\OpenLM Server\LM” (64bit).
- Copy the full path of the executable file (e.g. “C:\Program Files\OpenLM\OpenLM Server\LM\rlmutil.exe”) in the RLM executable file text field.
- Click Apply to save the configuration.
After setting up the OpenLM configuration tool to work with RLM as described above, add a new RLM server under the License Servers tab:
- Select the License Servers tab.
- Click Add.
- From the Type drop-down menu, select RLM.
- Insert a description in the Description text box.
- Set the Time Zone to where the License Server physically resides.
- Submit an appropriate Hostname and Port numbers. The RLM default port is 5054 (prior to RLM version 6, the default port was 9000).
- Is Triad Configuration: keep this box unchecked.
- Use Broker check box:
- Unchecked (Default): The OpenLM Server will query the license manager directly. Keep this unchecked if not using OpenLM Broker.
- Checked: Usage information is obtained solely by the OpenLM Broker installation on the license manager machine.
- Click Apply then close the OpenLM Server configuration tool.
OpenLM Server should now be ready to query your Reprise RLM license manager and present the relevant license information via the EasyAdmin interface.
Diagram of how OpenLM interfaces with the Reprise License Manager using OpenLM Broker
The OpenLM Broker component should be installed (guide) and configured (guide) on the same machine where the Reprise License Manager resides. OpenLM Broker reads the RLM server locally through both log and license files and then sends this data back to OpenLM Server.
By default, the Reprise License Manager does not record report log files. This setting may vary from vendor to vendor, however it must be enabled in order for OpenLM Broker to provide additional monitoring benefits.
Instructions on how to enable report log functionality for your version of RLM can be found here or in the RLM manual (PDF link) under the The ISV Options File chapter, specifically, the REPORTLOG option. Please note that the std argument should also be specified.
Once report log functionality is enabled, it is important to locate the correct log file. The exact location will be specified in the ISV options file. Usually, the file extension is .txt and the first 6 lines of the file will contain “RLM Report Log Format”:
RLM Report Log Format 0, version 11.0, authenticated ISV: ssi, RLM version 11.1 BL2 Logfile format Copyright (C) 2006-2014 Reprise Software, Inc. For documentation on this format, email firstname.lastname@example.org You are encouraged to build tools to process this data.
Automatic OpenLM Broker configuration
To automatically configure OpenLM Broker with the Reprise License Manager, click Detect in the bottom right corner of the Broker configuration tool window:
If the RLM service (e.g. “rlm”) is started, Broker will detect and configure all the required settings automatically. We recommend executing step 11 from the Manual configuration section below to make sure that the server is queried successfully without any errors.
Manual OpenLM Broker configuration
If auto-detect did not work, you can also add and configure the license manager manually. To do so:
- Click Add Port
- Enter the RLM server port number (e.g. 5054)
- Select RLM from the “License Manager Type” drop-down menu.
- Click on the blue Advanced link to expand the section.
- Check the Set Path Manually box.
- Fill in the correct filename and full path in the text box (or click Add and browse to the license file location).
- Check the Watch license file box.
- Click Apply.
- Select the Commands node. Click […] to the left of “Update path for commands:” and browse to the folder where the rlmutil.exe command-line utility is located (typically C:\RLMServer). Click Update.
- (Optional) If you have configured RLM to run as a service, check the Use Service box and enter the Service Name. Click Apply.
- Select the data_inquiry node under Commands then click Execute. Make sure that you see a valid output (i.e. no errors).
- Click Restart Broker.
In order to obtain license denial information and 1-second resolution usage reports, OpenLM needs to read the content of the Reprise RLM Report log file as well as associate the correct vendor name with the reports. In order to do so:
- Click the data_inquiry node under Commands then click Execute.
- In the output window that appears, locate the Vendor name under the “ISV servers” section and copy or write it down.
- Click the Vendor Name to Be Filled node underneath Vendors.
- In the “Vendor Name” text box, paste or write down the vendor name from step 2, then click Apply.
- Click the Log Files node.
- Click the green Add Log File button above then select the newly created “log” item underneath.
- Select the RLM Report Log file from the “Type” menu.
- Fill in the full path to the Reprise RLM report log file or click on “…” and browse to its location.
- Click Apply.
- Click Restart Broker.
- Follow step 4.3 below.
Automatic EasyAdmin configuration
To have OpenLM Server configured automatically via EasyAdmin:
- Open the EasyAdmin interface either by accessing http://<OpenLM Server IP>:7019/EasyAdmin2/ in your browser or through Windows Start → OpenLM → OpenLM EasyAdmin User Interface)
- In the License Servers window, hover over the red row that contains the details of the newly added RLM server entry and click Approve.
The RLM configuration has now been automatically added to OpenLM Server.
Manual OpenLM Server configuration
If automatic configuration of OpenLM Server via EasyAdmin has failed, you can manually configure OpenLM Server to connect to the OpenLM Broker installation located on the RLM machine.
The hostname and port settings must match those that have been configured for OpenLM Broker above.
The steps for configuring OpenLM Server are as described for option #1, with the following exceptions:
1. Check the “Use Broker” box.
2. If a license file is available for reading on the Reprise RLM license server, also check the “Use license file” underneath the “Use Broker” box.
To check if the RLM License Server is monitored correctly:
- Open the EasyAdmin web application (access http://<OpenLM Server hostname>/EasyAdmin2/index.html in your browser)
- Click EasyAdmin Start → Widgets → License Servers. The License Servers window will open. Verify that the configured license manager(s) appears on the list. A green circle node indicates an active connection to the license server
Please note that sometimes it may take up to 5 minutes for the status indicator to change if this is a new connection.