Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


The information on this page refers to LM-X v5.4.1 or newer, which added the "-verifyauth" command and introduced brute-force password protection. If you are using a previous version of LM-X, please see the documentation for previous versions

The LM-X End-user utility lets you get the hostid HostID values for the computer system. For machine-locked licenses, application vendors will use hostid 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 screenActivate a license

Wiki MarkupThe 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

HostID values of your computer system.

-licstat

unmigrated-wiki-markup

lmxendutil

\

-licstat

\

[-

host host -port port

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

.
See below for descriptions of optional parameters -host and -port.
Information for all options is

 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>)

-licstatxml

Wiki Markup
lmxendutil \-licstatxml \[-host
host -port port
-network -borrow -grace -trial -denials]

Displays

statistics and lists currently used licenses on a specific license server as XML.
See below for descriptions of optional parameters -host and -port.
Information for all options is returned unless one or more options are specified (for example, specifying -borrow will result in only borrow information being returned).

-restartserver

Wiki Markup
lmxendutil \-restartserver \[-host

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 Wiki Markuplmxendutil \

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.

-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.)

-removeuser

lmxendutil -removeuser -clientusername username -clienthostname

host

hostname

unmigrated

[-

wiki-markup\[

feature feature [-version version] -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

hostname
Removes a user at the specified hostname.

See below for descriptions of optional parameters -host, -port, -password and -feature [-version].

-verifyauth

lmxendutil -verifyauth -host host -port port -password password

Verify the license server's credentials on the current or a foreign host.

Optional parameters

Command

Syntax

Description

-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

do not enter this optional parameter, the local host is used

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).

 

Note that LM-X uses brute force password protection to prevent brute-force attacks.

-feature [-version]-feature feature [-version version]

Optional parameter for use with -removeuser command that limits user removal to a specified user/host who has checked out a specified feature. For example:

lmxendutil -removeuser -clientusername username -clienthostname hostname -feature feature [-version version]

-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.)

-activate

lmxendutil -activate -orderid order -url url

Wiki Markup
\[-output
output_file -hostid type=value,... -proxyhost host -proxyport port -proxyuser username -proxypassword password]

Activates a license from a specified License Distribution Service URL using the Ethernet hostid of the current machine. Parameter descriptions are as follows:
-orderid orderid The Order ID provided by the application vendor, with the format AAAAA-BBBBB-CCCCC-DDDDD.
-url url The activation URL provided by your application vendor, such as http://licservice.company.com.
Optional parameters:
-output output_fileSpecifies the name of the output file that will contain the  activated license. By default, this filename is named license-current_date.lic and is saved to the current directory. Note that you should save the license to the location recommended by your application vendor.
-hostid type=value,... Specifies the hostid of the machine used to activate the license. By default, the Ethernet hostid of the current machine is used.
This default can be overridden to perform offline activations for other machines by specifying one or more hostids, which may be of the same or different types. For example, -hostid LONG=11223344556677,ETHERNET=AABB1122CCDD3344,...
Valid hostid types are: LONG, USERNAME, IPADDRESS, CUSTOM, DONGLE_HASPHL, ETHERNET, HOSTNAME, HARDDISK and WIN_PRODUCT_ID.
-proxyhost hostSpecifies the web-proxy hostname required to access the web.
-proxyport portSpecifies the web-proxy port associated with the proxy hostname.
-proxyuser usernameSpecifies the web-proxy user name.
-proxypassword passwordSpecifies the web-proxy user password.