Skip to main content

Generic License Server Interface

This topic describes the steps required to monitor a license manager using the OpenLM Generic License Server Interface to obtain license statistics. See the OpenLM Generic License Protocol reference for how to align your license server output with the Open Standard protocol.

Requirements

To query your license manager, the following components must be installed:

  1. OpenLM Server installed on a machine in your organization.
  2. OpenLM Broker installed on the same machine as the license manager.

OpenLM Broker configuration

Diagram of how OpenLM interfaces with the license manager through OpenLM Broker.

The mechanism for interfacing the license manager through OpenLM Broker works as follows. The license manager server must have a utility or tool that generates the license usage output in the XML generic format. It is then queried locally by Broker through the license manager command line. The command line / HTTP URL of the license manager utility that reads the current license usage in the Generic XML format should be configured in the data_inquiry node under Commands. The data inquiry command periodically queries the license manager for the license usage information. Once queried, this data is compiled by Broker and sent to OpenLM Server for processing.

To configure the license manager manually in the OpenLM Broker:

  1. Click Add Port.

  2. Enter the license manager port number (e.g. 27021).

  3. Select OpenLM Generic as the License Manager Type from the drop-down menu. Click Apply.

  4. In the Status node, enter the same command as added in data inquiry, or it can be disabled.

  5. Select the data_inquiry node under Commands, add the command line / HTTP URL of the license manager utility on the license manager server, then click Execute. Make sure that you see a valid output (i.e. no errors).

    OpenLM Broker configuration tool with the data_inquiry command configured for the OpenLM Generic license manager type.

  6. Click Restart Broker.

  7. Follow the steps in the next section to complete the OpenLM Server configuration.

OpenLM Server configuration

Automatic configuration through EasyAdmin

If you have followed the steps in the section above, OpenLM Broker should now be transmitting the added license usage data to OpenLM Server. The final step is to approve the configuration in EasyAdmin:

  1. Open the EasyAdmin interface in your browser or through Windows Start → OpenLM → OpenLM EasyAdmin User Interface.

  2. In the Administration – License Manager Servers window, hover over the row that contains the details of your newly added license server entry pending approval.

    EasyAdmin License Manager Servers window with a license server entry pending approval.

  3. Click the Approve button to approve the license server entry.

    EasyAdmin approval prompt for the pending license server entry.

At this point, the license manager has been automatically added to OpenLM Server and the configuration is complete.

Manual configuration

If automatic configuration has failed, you can manually configure OpenLM Server to connect to the OpenLM Broker installation located on the license manager machine.

  1. Select the License Manager Servers tab under Administration in the OpenLM EasyAdmin User Interface.

    EasyAdmin Administration menu with the License Manager Servers option.

  2. Click Add LM.

    License Manager Servers window with the Add LM button.

  3. From the Type drop-down menu, select OpenLM Generic.

  4. Insert a unique display name to identify the license manager in the Display Name text box.

  5. Enter the Hostname and Port number of the machine where the license manager is installed. These must be exactly the same as configured for Broker in the previous section.

  6. Set the Time Zone to where the license manager physically resides.

  7. Check the Use Broker box.

  8. Click Save.

    Add License Manager form configured with the OpenLM Generic type and Use Broker checked.

OpenLM Server is now configured to monitor the incoming data from OpenLM Broker.

Verifying the license manager configuration

To check if the license manager is being monitored correctly:

  1. Open the EasyAdmin web application.

  2. Click EasyAdmin Start → Widgets → License Manager – Servers. Verify that the configured license manager(s) appears in the server list. A green circle node indicates an active connection to the license server.

    License Manager Servers widget showing the generic license manager with an active connection.