AIMMS
Follow these steps to configure OpenLM to monitor license usage and retrieve statistics from the AIMMS License Server.
AIMMS runs no command that OpenLM Broker can call and writes no usage log that Broker can read, so Broker queries the license server through the AIMMS License Server monitoring API library, licsrv-monitor.jar.
Unlike the other license managers in this section, AIMMS takes no shell command. The Data Inquiry command for an AIMMS port is the full path to licsrv-monitor.jar on the Broker machine. Do not enter java -jar or any other executable. Broker loads the jar into the Java runtime it already runs on and queries the AIMMS License Server over the network from inside the Broker process.
Requirements
Before starting, make sure you have:
- OpenLM SLM v25.x or higher installed on a machine in your organization, or a Software License Management Cloud (SLMC) account.
- OpenLM Broker v26.1.20.946 or higher, installed on a machine that reaches the AIMMS License Server over the network, and reporting to OpenLM SLM. Earlier Broker versions do not list AIMMS as a license manager type.
licsrv-monitor.jar, the AIMMS License Server monitoring API library, in a folder that the Broker service reads. AIMMS ships this file in theAPIsubfolder of the AIMMS License Server installation, typicallyC:\Program Files (x86)\AIMMS\AIMMS License Server\API. If the file is not there, ask your AIMMS administrator or AIMMS support where it sits in your installation. OpenLM does not distribute this file.- The host name of the machine that runs the AIMMS License Server, and the port that the license server listens on. AIMMS listens on port
3400by default. On Windows an administrator can change the port from the license server's Maintenance → Port Number menu, so check which port your site uses. On Linux the license server uses ports 3400 and 3401, and the current version does not let you configure them.
The simplest arrangement runs Broker on the AIMMS License Server machine, where licsrv-monitor.jar is already present, but Broker connects over the network and can run on another machine. The Broker machine needs no separate Java installation, because Broker runs on Java and loads the jar into its own runtime.
Monitoring capabilities
The current monitoring capabilities for AIMMS through OpenLM Broker are:
| LM Type in the Broker | Commands | Logs | Quantity | Expiration date | Denied | Borrowing | Allocations | Report resolution |
|---|---|---|---|---|---|---|---|---|
| AIMMS | No (Java API) | No | Yes | Yes | No | No | No | Seconds |
On every data inquiry, Broker reports:
- Feature name: the name of each license installed on the AIMMS License Server.
- Total: the maximum number of connections that the license permits.
- In use: the number of connections that the license currently grants.
- Expiration date: the expiration date of the license, recorded at 23:59:59 on that date.
- Username, workstation, and session start time: Broker reads these from the clients logged on to the license server. Each client session counts as 1 license.
- License type: Broker reports every AIMMS feature as Floating.
- Vendor: Broker reports
AIMMSunless you enter a different vendor name on the Vendors tab.
License denials, borrowed licenses, and license allocations are not available for AIMMS. OpenLM cannot deploy License Allocation Control rules to an AIMMS License Server either, because AIMMS has no options file for Broker to write.
How OpenLM interfaces with AIMMS
When you configure an AIMMS port, Broker fills in only the settings in this list. The remaining license manager settings stay empty for AIMMS:
- Commands:
data_inquiryonly, which the Broker web UI shows as Data Inquiry. Its value is the path tolicsrv-monitor.jar, not a command line. AIMMS has no status command, so Broker reports the license server as active whenever the data inquiry connects. - Log file: None. AIMMS writes no usage log for Broker to read, so the Log Files tab stays empty.
- License file: None. Broker does not read an AIMMS license file, and the license file settings stay hidden for this license manager type.
- Java runtime: Broker loads
licsrv-monitor.jarinto its own Java runtime through a separate class loader, shared by every AIMMS port. Broker keeps that class loader open until the configured jar path changes; when it changes, Broker closes the class loader and loads the jar at the new path.
OpenLM Broker configuration
Install OpenLM Broker and confirm that it reports to OpenLM SLM before starting these steps. See the Broker installation and configuration guides.
Manual configuration (Broker web UI)
-
Copy
licsrv-monitor.jarfrom the AIMMS License Server installation to a folder on the Broker machine, for exampleC:\OpenLM\aimms. Skip this step if Broker runs on the AIMMS License Server machine and reads the file where AIMMS installed it. -
Open the Broker web UI at
http://localhost:5090. If the default port is in use, try5091or5092. -
On the License Managers page, check the Host field. Broker connects to this host on the port you add in the next step, and the field holds the host for every license manager listed on the page, not for AIMMS alone. If it already names a different machine, leave it as it is and add the AIMMS License Server as a separate license server in the OpenLM Broker Configuration Tool, or install a second Broker on or near the AIMMS machine. If the page is empty or already names the AIMMS machine, enter the host name of the machine that runs the AIMMS License Server and select the save icon next to the field.
-
Go to License Managers → Add License Manager.
-
From the LM Type drop-down list, select AIMMS.
-
Enter the port that your AIMMS License Server listens on, and select Add. Broker queries the license server on this port, so it must be the port the license server uses and not a free port.
-
On the Commands tab, select the Data Inquiry command and point it at the jar:
-
In Executable path, browse to the folder that holds
licsrv-monitor.jar. Broker rebuilds the command line as the folder path followed bylicsrv-monitor.jar. -
Or type the full path to the file in the command line box, for example:
C:\OpenLM\aimms\licsrv-monitor.jar
Fill in the path. If Executable path is empty, the command line is the bare name
licsrv-monitor.jarand Broker looks for the file in its own working folder. Broker uses the path exactly as typed, so remove any leading or trailing spaces. If you change Executable path afterwards, Broker regenerates the command line from the folder you select and discards a command line that you typed by hand. -
-
Leave Watch interval (sec) at 55 seconds, or set the polling interval you want. Timeout (sec) has no effect for AIMMS: the connection attempt times out after 5 seconds, and the rest of the query runs without a timeout.
-
Go to the Vendors tab. Select Add Vendor, enter
AIMMS, and select Continue. -
Leave the Log Files tab empty. AIMMS has no log file for Broker to watch.
-
Select Save.
-
Reopen the AIMMS license manager from the License Managers list, go to the Commands tab, and select Execute to test the data inquiry. A successful test returns the license server XML, listing each AIMMS license and the users logged on. Broker refuses Execute on a license manager that you have never saved, and answers
Need to save first in order to execute command.
Manual configuration (Broker desktop UI)
To configure the same port in the OpenLM Broker Configuration Tool instead of the web UI:
- Select the license server that runs AIMMS.
- Select Add Port and enter the port that your AIMMS License Server listens on.
- Set License Manager Type to AIMMS.
- Open the Commands tab and set Path with the browse button (...).
- Select update under Update path for commands:. The browse button only fills the field; update is what rebuilds the command lines from it.
- Confirm that the Data Inquiry command line ends with
licsrv-monitor.jar. - Select Apply.
- Select Restart Broker.
A new path to licsrv-monitor.jar takes effect when you save. Replacing the file with a new copy at the same path takes effect only after you restart the Broker service, because Broker keeps the jar loaded for as long as the path stays the same.
OpenLM SLM configuration
Automatic configuration through EasyAdmin
If the preceding steps are complete, Broker sends AIMMS data to OpenLM SLM. Approve the license server in EasyAdmin:
- Open EasyAdmin (
http://<Server IP>:5015) and go to Start → Widgets → License Manager Servers. - Select the Servers Pending Approval link.
- Open the pending AIMMS entry. Broker reports AIMMS with the OpenLM Generic protocol, so the entry shows the type as OpenLM Generic.
- Optionally rename the connection in Display Name, leave the type as OpenLM Generic, confirm the host name and port, and select Approve.
Manual configuration through EasyAdmin
If automatic configuration fails:
- Go to Start → Administration → License Manager Servers.
- Select Add LM.
- From Type, select OpenLM Generic.
- Enter a description, for example
AIMMS. - Set the time zone for the license server location.
- Enter the Hostname and the Port exactly as configured in Broker for the AIMMS License Server.
- Uncheck Is Triad Configuration. Multiple server redundancy is not available for AIMMS.
- Check Use Broker.
- Select Save.
Verify your configuration
- Open EasyAdmin in your browser.
- Go to Start → Widgets → License Manager Servers.
- Confirm that the AIMMS license server appears in the list with a green circle icon.
- Go to Start → Reports → License Activity and confirm that the AIMMS licenses appear as features with their totals and the number of licenses in use, and that each logged-on client appears with its username, workstation, and session start time.
It might take up to 3 minutes for the status to update after a new connection.
Troubleshoot the data inquiry
Select Execute on the Commands tab and compare the result with this list. The result has 2 lines: the first names what Broker was doing, and the second carries the underlying error.
The Broker log holds the rest of the detail. A manual Execute writes to logs/broker-service.log in the Broker installation folder, and the periodic data inquiry writes to logs/port-<port>-AIMMS.log, where <port> is the port you configured. Broker logs at ERROR level by default, which covers the failures in this table but hides the warnings described after it. To see those, go to Settings → Broker Log Level, set Broker service to WARN or DEBUG, and wait for the next data inquiry.
| Result of Execute | Cause | What to do |
|---|---|---|
Failed to query AIMMS License Server, then AIMMS connection failed | Broker loaded the jar, but the AIMMS License Server did not accept the connection within 5 seconds. | Confirm the host on the License Managers page and the port on the license manager, confirm that the AIMMS License Server runs, and open the port in the firewall on the route between Broker and the license server. |
Failed to query AIMMS License Server, then AIMMS JAR not found at: <path> | The command line does not resolve to an existing file. Broker prints the path it resolved. | Correct Executable path, or the command line, so that the resolved path is the full path to licsrv-monitor.jar on the Broker machine, and confirm that the account the Broker service runs as can read the file. |
Failed to query AIMMS License Server, then com.aimms.LicenseServer.connect.LicenseServerMonitor | The file exists but does not hold the AIMMS License Server monitoring API. | Replace it with licsrv-monitor.jar taken from an AIMMS License Server installation. |
A first line that starts with AIMMS Execution Error: | The AIMMS License Server monitoring API raised the error itself, for example for a host name it cannot resolve. | Read the rest of the message, and the Broker log, for the error text that the API returned. |
Other results to check:
- The license server appears in EasyAdmin with no features. The AIMMS License Server reported no licenses, and Broker still reports the license server as active. To confirm this rather than guess, set Broker service to
WARNunder Settings → Broker Log Level and look forNo licenses found in AIMMS statisticsinlogs/port-<port>-AIMMS.log. If that line appears, the problem is on the AIMMS side: confirm with your AIMMS administrator that the license server holds licenses and that you connected to the correct port. - A feature has no expiration date, or a session has no start time. AIMMS returned a value that Broker cannot read. Broker expects
yyyy-MM-ddfor expiration dates andyyyy-MM-dd HH:mm:ssfor session start times, logs a warning atWARNlevel for any other form, and reports the rest of the data. - AIMMS can restrict a floating license to the subnet of the license server or to a maximum number of network hops. One of these restrictions always applies to an academic network license, and none applies to a commercial network license by default. If Broker runs outside that range, ask your AIMMS administrator whether the restriction covers the Broker machine.
Known limitations
- Broker does not report license denials. It reads no denial data from the AIMMS License Server monitoring API.
- Broker does not report borrowed licenses. AIMMS network licensing has no documented borrowing mechanism.
- License allocations and License Allocation Control rules are not available, because AIMMS has no options file.
- Multiple server redundancy is not available. Leave Is Triad Configuration unchecked in EasyAdmin.
- The AIMMS License Server monitoring API reports the clients logged on to the license server as a whole, not per license. When the license server holds more than 1 license, OpenLM lists every logged-on client under each feature, so the user list for a feature can be longer than its In use count.
- Broker reports the licenses that the AIMMS License Server holds. It does not report AIMMS license profiles, which subdivide a license between groups of users, as separate features.
The documentation team might draft this page using a large language model. A technical writer reviews every page and verifies it against the product before publishing it. A human makes the final decision.