Product Documentation

Commands

Mar 16, 2015

While the License Administration Console provides an easy method of accessing many licensing features, you can also perform licensing tasks using commands. You might use license administration commands when performing advanced operations on the license server that are not available in the console. Such operations include diagnosing check-out problems using lmdiag.

License administration commands are stored in:

C:\Program Files\Citrix\Licensing\LS on a 32-bit computer

C:\Program Files (x86)\Citrix\Licensing\LS on a 64-bit computer

Table of commands

Utility Description
lmadmin Provides licensing configuration. Use the License Administration Console for licensing configuration and administration tasks. Do not use lmadmin.
lmdiag Diagnoses license check-out problems. See lmdiag.
lmdown Gracefully shuts down the License Manager and Citrix vendor daemons (disabled by default). See lmdown.
lmhostid Reports the host ID of the server on which Citrix Licensing is running. See lmhostid.
lmreread Causes the License Manager daemon to reread the license file and start the Citrix vendor daemon. See lmreread.
lmstat Displays the status of a license server. See lmstat.
lmutil Displays a list of licensing utilities or executes other commands. See lmutil.
lmver Displays version information for the licensing binaries. See lmver.
udadmin Displays all licensed users and devices and deletes specified licensed users and devices. This command applies to User/Device licenses only. See udadmin.

Formatting license commands

Formatting conventions for the license administration commands:
Convention Description
Bold A command or switch, such as lmstat.
Italic You need to replace variables with a value; for example, in the expression:

lmstat -c license_file_list

Before you run the command you must replace license_file_list with the names of one or more license files.

[square brackets] Square brackets around text indicate options that can be added to the command or that text within the brackets needs to be replaced.

Universal arguments

Valid arguments for most license administration commands:
Argument Description
-all Applies the command to all of the license servers on the network.
-c Lets you specify license file(s) or license server port and host name.

If you specify the path without a license file name, the command applies to all the license files in the directory.

For a local host: -c @localhost

For a remote license server: -c @servername

For a license server in a cluster: -c @clustername

For a specified path: -c path

For the names of one or more license files: -c license_file_list

You can enter more than one license file path by separating each path with a semicolon.

Path names that include spaces must be enclosed in double quotes.

-h License handle, as reported by lmstat -a. The license handle is a number used to identify a specific checked out license.
-help Displays usage information and exits.
-s [server] Displays the status of all license files listed on the license server or on all license servers, if server is not specified.
-verbose Displays a longer description for all errors found.