License Server Monitoring

Each license server to be monitored must be identified in the Monitor configuration. This can be accomplished by using the Admin web page or by editing the vovlmd configuration file (licmon.swd/vovlmd/config.tcl). The web page maintains a separate configuration, so when using both methods, be careful to configure only one monitor for each tag to avoid configuration conflicts.

Choose a Tag Name

Monitor tags are used to give symbolic names to license servers, and to distinguish between the same feature from different servers, e.g. WAN vs. LAN licenses. Tag names may contain letters, digits, underscore (_), and dash (-) characters ( regexp [a-zA-Z0-9_-]+ ) and are case-sensitive.

When initially configuring Monitor, it is important to choose tag names carefully so they will not need to be changed later. Changing is possible, (see Tag Administration), but it is better to avoid this process by choosing appropriate tag names during the initial configuration phase.

One naming convention that works well is to construct tag names in the form <site>_<vendor>_<type>, where type is e.g. LAN, WAN, since it permits using Monitors filters to easily find things by site, tool vendor, and license type (for example NY_MENTOR_LAN, SF_MENTOR_WAN).

Browser-based Configuration

To configure monitoring via the web interface, click on the Admin tab and navigate to the Monitors page. Fill in the form with the required information for each license server and click Add New Monitor. Existing monitors are shown at the bottom of the page. The Edit button can be used to change the properties of an existing monitor.

Figure 1. Monitor Administration Page

The Monitor configurations managed by the web interface are not stored in the main vovlmd configuration file, but are instead written to the licmon.swd/vovlmd/config_aux.tcl file. This file is loaded after the main configuration file and can override it.

File-based Configuration

In addition to the browser-based setup, you may specify license servers to be monitored by editing the .../licmon.swd/vovlmd/config.tcl file. If the file is not already present, you may copy a complete and self-documented example from $VOVDIR/etc/config/vovlmd/config.tcl.

Supported License Managers

The following table shows licensing systems that are supported in this release, and has links to the reference documentation for the configuration options that are available for each system.

System Config Statement
Altium Log File add_ALTIM_LOG
ClearCase add_CLEARCASE
Wibu CodeMeter Log File add_CODEMETER_LOG
Dassault DSLS add_DSLS
Dassault DSLS Log File add_DSLS_LOG
Green Hills Legacy (Elan) add_GHS_LEGACY
FlexNet Publisher add_LM_LICENSE_FILE
FlexNet Publisher add_DEBUG_LOG
FlexNet Publisher add_LIC_OPTIONS
Fujitsu ICAD (Windows only) add_ICAD
Green Hills add_GHS
Wolfram MathLM add_MATHLM
Remote Monitor add_REMOTE_LM
Reprise RLM ad_REPRISE
Altair License Key File (RTDAKEY) add_RTDAKEY
Sentinel HASP add_HASP
Sentinel RMS add_SENTINEL
Silvaco add_SILVACO
OLicense add_OLICENSE
QF-Test add_QFTEST
X-Formation LM-X add_LMX
Process Tracking add_PROCESS_TRACKING
Configuration Example
add_LM_LICENSE_FILE 5280@lichost1 -tag CADENCE
add_LM_LICENSE_FILE 2233@lichost1,2233@lichost2,2233@lichost3 -tag SYNOPSYS
add_LM_LICENSE_FILE /vendor/mentor/current/license/license.dat -tag MENTOR
add_LM_LICENSE_FILE 1717@lichost4 -tag MGC -lmstat /tools/flexlm/bin/lmstat

About FlexNet Publisher Reservations

In both configuration methods, there is an option to enable the tracking of FlexNet Publisher reservations. Reserved licenses that are not used are considered checkouts by Monitor if this option is enabled. The checkouts are for a special user, beginning with "r:", that includes the reservation object name, so that these checkouts can be distinguished from real usage in the Monitor reports. Enabling this option allows Monitor to quickly and easily identify waste that is created as a result of obsolete and overly aggressive reservations.

Status Command Specification

Before Monitor can obtain data from any license server, a supported status command must be present to interface with. Some status commands are simple in their installation and operation, requiring only a single binary to query a license server (eg FlexNet Publisher lmstat, Reprise's rlmstat, and Sentinel's lsmon). Others, however, require a full installation and configuration (eg ClearCase and IBM's LUM).
Important: It is important to understand that unless a status command is present and working on the Monitor server machine outside of the Monitor environment, no data will be obtained.
It is recommended to test the status command that is to be used by Monitor manually with a UNIX shell or Windows command prompt to validate its operation before configuring Monitor to use it.

Command Versions

By default, Monitor searches the system path for the status command. It is common practice to copy the status commands to the $VOVDIR/bin directory so that there is at least a default command always available. However, due to version incompatibilities, this may not always work. For this reason, it is recommended to point to the version of status command that matches that of the license server being monitored.

If a specific status command is defined in the configuration, the path to this command is honored. This is accomplished in the browser interface by filling in the status command form input with a full path to the desired status command. In the configuration file, each license type has a status command argument that is used to specify the location. For example, the -lmstat argument is used to specify a path to the lmstat command for FlexNet Publisher-based monitors.

  • Reprise: As of version 2015.03, the vovrlmstat utility is no longer supported. The native rlmstat command now provides expiration information and is the default command utilized when the add_REPRISE monitor is selected. The add_RLM_LICENSE_FILE monitor is to be phased out, and utilizes rlmstat as well.
  • Sentinel:Some versions of Sentinel's lsmon utility on Windows have the behavior of requiring the enter key to be pressed at the end of its output dump. This means that when executed as a background task in Monitor, the task will never end. If the lsmon utility being interfaced with exhibits this behavior, make a copy of the vovlsmon.bat script template found in $VOVDIR/bat and place it somewhere outside of the $VOVDIR directory. Modify it to point to the lsmon.exe being interfaced with, then configure the status command to point to this script instead of lsmon.exe directly.

Working With Remote License Servers

For UNIX-based installations, the status command can be used in conjunction with rsh or ssh to increase the performance of monitoring license servers across the WAN. FlexNet Publisher uses small packets, leading to many round-trips to get all of the required information. Remote execution of lmstat on the remote license server (or on a machine located in the same location as the license server) via rsh/ssh can speed up the response significantly when compared to executing lmstat on the Monitor host against a remote license server. If the remote server is located in a different time zone, the time zone should be overriden to the time zone in which the Monitor server is located so that reported checkout times will be tracked correctly. See below for some examples of using ssh in the status command specification:
ssh remotesrv /usr/local/bin/lmstat
ssh remotesrv env TZ=PST8PDT /usr/local/bin/lmstat

For this to work, you must have an account at the remote site that can remote-shell without a password, by using rsh or setting up ssh to use authorized keys.