Page tree
Skip to end of metadata
Go to start of metadata

The information on this page refers to LM-X v4.9.5 or newer, which includes syntax changes for licstat and licstatxml commands. If you are using a previous version of LM-X, please see the documentation relevant to your version: v4.4.3 documentation; v4.4 documentation; documentation for versions prior to v4.4

The LM-X End-user utility lets you get the HostID values for the computer system. For machine-locked licenses, application vendors will use HostID values to create licenses specifically for your system. The LM-X End-user utility also lets you:

  • See who is currently using specific licenses on the license server, and see the borrow, grace and trial licenses currently checked out
  • Remotely access the license server
  • Remove users from the license server
  • Read and verify a usage database and print the usage information to the screen

The LM-X End-user utility may be run by any user; you do not need administrator privileges to run the utility. The lmxendutil command usage is as follows. Optional parameters are enclosed in square brackets ( [ ] ). Variables are shown in italic text.

Command

Syntax

Description

-hostid

lmxendutil -hostid

Displays HostID values of your computer system.

-licstat

lmxendutil -licstat [-vendor <vendor_name> (-host <host> -port <port> | -hal <servers>) -network -borrow -grace -trial -denials]

Displays statistics and lists which users are currently using which licenses on a specific license server

Note: The lmxendutil -licstat command does not use the environment variable LMX_LICENSE_PATH when querying the license server. A client application can find license servers on the network automatically, using automatic server discovery or the -host option.

When -vendor is used, the statistics will be limited to the specified vendor. If -vendor is not used, information such as grace, borrow and trial checkouts may not be returned, because the vendor is unknown.

Information for the borrow, grace and trial licenses currently checked out is also returned unless one or more options are specified; for example, specifying -borrow will result in only borrow information being returned. If the -denials option is specified, this command additionally prints detailed information about denials for current and disconnected users for the past 24 hours, including username, hostname, IP address, login times, and denial times. 

See below for descriptions of optional parameters - hal, -host, and -port.

-licstatxml

lmxendutil -licstatxml [-vendor <vendor_name> (-host <host> -port <port> | -hal <servers>) -network -borrow -grace -trial -denials]

Displays the same information as for -licstat, but in XML format.

-restartserver

lmxendutil -restartserver [-host host -port port -password password]

Remotely restarts the license server.

See below for descriptions of optional parameters -host, -port and -password.

-shutdownserver 

lmxendutil -shutdownserver [-host host -port port -password password ]

Remotely shuts down the license server.

See below for descriptions of optional parameters -host, -port and -password.

-removeuser

lmxendutil -removeuser -clientusername username -clienthostname host
[-host host -port port-password password]

Removes a user from the license server. Parameter descriptions are as follows:

-clientusername username
Removes a user with the specified username.

-clienthostname host
Removes a user at the specified hostname.

See below for descriptions of optional parameters -host, -port and -password.

-hal-hal server1 server2 server3

Optional parameter for specifying HAL servers, used only when HAL is enabled. You must specify three servers in port@host format; for example:

lmxendutil -licstat -vendor VENDORNAME -hal 6200@localhost 6300@localhost 6400@localhost
lmxendutil -licstatxml -vendor VENDORNAME -hal 6200@localhost 6300@localhost 6400@localhost

-host

-host host

Optional parameter that connects to the specified license server host. If you don't specify the -host option, lmxendutil command will perform autodiscovery.

-port

-port port

Optional parameter that connects to license server on port 'myport'. If you do not enter this optional parameter, the default port is used.

-password

-password password

Optional parameter that uses the specified password. If you do not use this optional parameter explicitly, you will be prompted for the password (in this case, the password you enter is not displayed on the screen as you type). 

-readusagedb

lmxendutil -readusagedb usage.db

Reads the specified usage database and performs a verification, then prints the usage information to the screen. (See Pay Per Use feature.)