OpenLM Broker web UI

Overview

Starting from v21.11, the OpenLM Broker has a Browser UI that is accessible from other machines in the same network.

This means the Broker can be controlled and configured remotely. The functionality is useful when there are many Brokers and these require a centralized control station.
Furthermore, Brokers on Linux machines can be accessed through the web UI.

Enabling the web UI

To turn on the Broker web UI:

Find broker.xml in the folder where the OpenLM Broker is installed.
Open broker.xml in a text editor.
In the first line, set the webUIPort attribute to the TCP port where the UI will be launched: change <ulm brokerId="..." webUIPort="off"> to, for example, <ulm brokerId="..." webUIPort="5090">.
Restart the OpenLM Broker service. On Windows, use Task Manager or Services; on Linux, use the ./broker.sh script.

Security concerns

The Broker web UI uses port 5090. Keeping in mind the security aspects, the port can be either opened or closed. We also set a Token to access the Broker Browser UI from a remote machine.

In the Broker XML file, the UI port can be changed:

Broker XML file showing the web UI port setting.

In Broker Browser, the web UI can be turned off:

Broker Browser UI with the web UI turned off.

This will make the Broker XML port setting to be off:

Broker XML file with the UI port setting turned off.

Change it back to the designated port whenever a revert action is required.

The OpenLM Broker has a new WebUI that is installed with Broker version 21.11 and on.

The Broker WebUI can be accessed from URL http://localhost:5090 remotely by changing localhost to the server Hostname.

You will need to generate an access token for remote access:

Broker web UI screen for generating a remote access token.

A token can only be retrieved after login into the Broker system. The following URL returns it as plain text:

http://localhost:5090/api/new-token

The commands below can be used to get a token from a command line remotely.

Linux:

ssh server_name wget -O - http://localhost:5090/api/new-token

Windows:

winrs -r:server_name powershell -command "(Invoke-WebRequest -Uri http://localhost:5090/api/new-token -Method GET).Content"

Example using putty

Retrieving a Broker access token from the command line using PuTTY.

The token will time out in 30 minutes after generation. It also expires if Broker Service is restarted.

Basic functionality

Adding the OpenLM SLM

From the OpenLM SLMs tab, select Add Server.
Select the Type of connection On-premise or OpenLM Platform and select Add:
Input the hostname of the OpenLM SLM or if you are using the Identity Service go to Start→Administration→System Security→Security→Authorization→Add and generate the authorization file. Import Broker Authorization File and select Save.
In the License Managers screen, you can see and add your license managers.
Select Add License Manager.
Select the type of license manager from the dropdown and enter the port. Select Add.
Add the License file information:
Add the Commands information. The path to the executable can be entered and this action will update the command for all the paths and Status and Data_Inquiry.
Input the Vendor information:
Add the vendor name and Options File information, then Confirm:
Add the Log File:
Select the Log File Type, update the Log name, input the log path then select the vendor. Select Confirm then Save: