Install Broker

Install the Broker on each license server so that OpenLM Platform receives its license usage data. The Broker collects usage data from your license managers and sends it to OpenLM Platform through the Broker Hub. The OpenLM Broker for OpenLM Platform and for Version 26 is the same program. For the Version 26 steps, see OpenLM Broker.

To collect data from SaaS platforms where you can't install anything, you don't need a Broker. Use the Cloud Broker or the SaaS Agent instead.

The Broker is a Java application and runs on any platform that Java supports. Install it on the license server machine, or next to it. On Windows, the installer includes a Java runtime. On Linux and Unix, install a Java runtime (Java Runtime Environment (JRE) or Java Development Kit (JDK)) first: Java 11 or higher, or Java 8. Java 9 and 10 aren't supported.

Before you begin

Confirm these prerequisites:

• The license server machine meets the Components system requirements.
• You plan one Broker for each license server.
• One Broker can monitor several license managers on its own machine, but each additional license server needs its own Broker, so repeat the installation once per server.
• You have the authorization file for this Broker. See Authorize components.
• The network allows the connections in Network requirements. If the Broker can't reach the internet directly, connect it through an HTTP or HTTPS proxy, with optional credentials. See Broker settings.

Network requirements

The Broker only opens connections to OpenLM. OpenLM Platform never connects into your network. Open these ports:

Direction	Port	Purpose
Outbound	443 (HTTPS)	Reporting to OpenLM Platform
Outbound	5015 (default)	Reporting to an on-premises OpenLM Server (older installations might use 7016)
Local	License manager ports (for example, 27000 for FLEXlm)	Querying the license managers on the same machine
Inbound (optional)	5090	The Broker UI, if you want to open it from another computer

Download the installer

The installers need an OpenLM Platform account. To download the Broker from inside OpenLM Platform, open Navigation, select Platform Administration, then OpenLM Products, and open the Downloads page. Select the Platform tab, find the Broker, and select Download to pick the package format. See Download OpenLM components. The Downloads page on openlm.com leads to the same installers after you sign in.

Install the Broker

To install the Broker, complete these tasks:

• Download the installer

  Download the Broker installer for your platform. See Download the installer.

• Run the installer

  On Windows, run the installer on the license server machine and follow the prompts. On Linux or Unix, install a Java runtime, then install the Broker from the tar.gz archive or the DEB or RPM package.

• Upload the authorization file

  Import the authorization file in Broker Initial Setup, which opens in your browser when the installation finishes. A silent Windows installation can import it for you. On Linux or Unix, import it with auth_import.sh and restart the Broker. For more information, see Authorize components.

• Approve and verify the Broker

  In OpenLM Platform, approve the new Broker in Broker Hub. Then detect or add your license managers in the Broker UI, and approve them under License Servers. For the steps, see Verify the connection.

Choose your platform

Each platform has its own installation page. Follow the page for the operating system of the license server.

Install on Windows

On Windows, the installer includes a Java runtime and runs the Broker as the OpenLM Broker Windows service. Install it interactively, or silently from the command line, as described in Install Broker on Windows.

Install on Linux or Unix

On Linux and Unix, install a Java runtime first, and then install the Broker from the tar.gz archive, or from the DEB or RPM package, as described in Install Broker on Linux or Unix.

Manage the Broker after installation

After the installation, these pages help you keep the Broker running:

• Change, upgrade, or uninstall Broker: import a TLS certificate, upgrade the Broker, or remove it.
• Troubleshoot Broker: find the logs, and fix a Broker that doesn't install, open, connect, or report as expected.

The Broker UI

To add OpenLM Platform connections, configure license managers, or change Broker settings, open the Broker UI in a browser. On every platform, the Broker serves it on port 5090 by default:

http://<license-server>:5090/

The license server doesn't need a desktop environment. On the license server itself, the Broker UI opens without a sign-in. From another computer, it asks for a short-lived access token, which you can generate only on the license server. If port 5090 is already in use, the Broker takes the next free port and records it in broker.xml.

For more about the Broker UI, see OpenLM Broker.

Verify the connection

To start collecting data from the new Broker, approve it in OpenLM Platform:

1. Open Navigation (the grid icon in the OpenLM Platform header), then select Brokers, then Broker Hub.

   Alternatively, select OpenLM User Interface on the last Broker Initial Setup page.

2. Select Pending Brokers.

3. Select the check box of the new Broker.

4. Select Approve Brokers.

   The Broker moves to the Brokers list, with status Up.

Then connect your license managers and approve them:

1. In the Broker UI, detect the license managers on the machine of the Broker, or add a license manager by hand.
2. In OpenLM Platform, open Navigation, then select Licenses and Features, then License Servers.
3. Under Management, select Pending Servers.
4. Select the license server.
5. Select Approve And Merge.

OpenLM Platform collects usage data from a license server only after you approve it.

For more information, see Connect your first license manager, or find your license manager in Connect license managers.

Next step

Continue to Connect your first license manager to start collecting license data. Then continue to Install Workstation Agent to collect activity data from end-user machines.