Licensing commands

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 the license administration commands for 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

Descriptions of the commands

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

• lmdown — Gracefully shuts down the License Manager and Citrix vendor daemons (disabled by default).

• lmhostid — Reports the host ID of the server on which Citrix Licensing is running.

• lmreread — Causes the License Manager daemon to reread the license file and start the Citrix vendor daemon.

• lmstat — Displays the status of a License Server.

• lmutil — Displays a list of licensing utilities or executes other commands.

• lmver — Displays version information for the licensing binaries.

• udadmin — Displays all licensed users and devices and deletes specified licensed users and devices. This command applies to user/device licenses only. Specifying udadmin -export exports unprocessed user and device data. This data is used to calculate license use and is not a list of licenses in use. To get a list of licenses, specify udadmin -list.

Format license commands

Formatting conventions for the license administration commands:

Universal arguments

Valid arguments for most license administration commands:

Diagnose checkout problems (lmdiag)

The lmdiag command allows you to diagnose problems when a product cannot check out a license. In particular, you can test if your licenses are valid and if the License Server is running. When you run this command, it attempts to check out a license.

You can also use the lmdiag command to see if a specific type of license is working.

Example:

Run lmdiag on your Citrix Virtual Apps server Advanced edition licenses only. Specify MPS_ADV_CCU as an argument.

Syntax:

lmdiag -c license_file_list [-n] [feature[:keyword=value]]

If no feature is specified, lmdiag operates on all features in the license files in your list. The lmdiag command displays information about the license, then attempts to check out each license. When the checkout succeeds, lmdiag indicates that the checkout was successful. When the checkout fails, lmdiag gives you the reason for the failure. The lmdiag command tries to connect to each TCP/IP port on the License Server. It detects if the port number in the license file is incorrect. lmdiag lists each TCP/IP port number that is listening, and if -c license_file_list is specified, diagnoses the specified files.

The lmdiag command does not contact the computer running the Citrix product when it attempts to check out licenses. The lmdiag command indicates only if there are problems on the License Server. That is, your product cannot check out licenses because it is pointing to the wrong License Server, but lmdiag does not detect this problem. For example, a License Server that does not have licenses for that product on it. The lmdiag command reports that it can check out licenses when the Citrix product is pointing to the wrong License Server.

Stop daemons (lmdown)

The lmdown command shuts down the License Manager daemon and the Citrix vendor daemon on your License Server or all License Servers on your network. The lmdown command is disabled by default. To enable it:

1. Stop the license service.
2. Run lmadmin - allowStopServer and -allowRemoteStop Server or -allowRemoteStop Server.
3. Restart the License Server.

Syntax:

lmdown -c license_file_list [-vendor CITRIX] [-q] [-all]

Run the lmdown command on a License Server. You can use -all to shut down all the License Servers on your network.

If lmdown encounters more than one server and you didn’t specify the -all argument, the command displays a choice of License Servers to shut down. For example, the -c argument specifies a directory with many *.lic files. Shut down the remote License Servers by using -c and specifying the name of the License Server.

Note:

If you use the Task Manager to terminate the License Manager daemon (Citrix Licensing Service), stop the lmgrd process first, then stop the Citrix vendor daemon process.

To stop and restart the Citrix vendor daemon only, use lmdown -c @localhost -vendor CITRIX, then use lmreread -c @localhost -vendor CITRIX to restart the vendor daemon.

Check host names (lmhostid)

The lmhostid command returns the host ID of the License Server. You can use the command to check the host name of your License Server. You can open a license file and compare the host name in the license file to that of your License Server.

Note

Citrix Licensing, versions 11.5 and later for Windows allows you to display multiple host IDs if there are more than one host.

Syntax:

lmhostid -bindingidentifier

Reread license and options files (lmreread)

The lmreread command causes the Citrix vendor daemon to reread changes to the license file and the options file. After rereading, the Citrix vendor daemon uses the new settings and licenses from then on.

You cannot use lmreread remotely; run it locally on the License Server.

Syntax:

lmreread -c license_file_list [-all] [-vendor CITRIX]

Examples:

• lmreread -c @localhost \[-all\]
• lmreread -c @client\_access\_point\_name
• lmreread -c /opt/citrix/licensing/myfiles/CITRIX.lic -vendor CITRIX

Display the list of licensing utilities (lmutil)

The lmutil command displays a list of licensing utilities when used standalone. When you specify lmutilwith another command, it executes that command.

Syntax:

lmutil

lmutil other_command

Examples:

• lmutil

  Displays all the licensing utilities.

• lmutil lmstat -c @localhost

  Executes the lmstat command.

Determine licensing status (lmstat)

The lmstat command helps you monitor the status of all network licensing activities and provides you with information about license check outs, including:

• The product that checked out one or more licenses
• The checkout data
• The version of the license file
• The License Server name and port
• The date the license was checked out
• Information about the Citrix vendor daemon status and the license files

The lmstat command displays information that it receives from the License Server. The lmstat command displays only one use of the license, even if there are multiple connections sharing that license.

Syntax:

lmstat [-a] [-c license_file_list] [-f [feature]] [-i [feature] [-s[server] [-S [CITRIX]] [-t timeout_value]

The output from lmstat -c@localhost -a looks similar to this example. The lines in the example might break because of the screen space.

License Server status: 27000@localhost

   License file(s) on localhost: C:\Program Files (x86)\Citrix\Licensing\MyFiles\citrix_startup.lic:C:\Program Files (x86)\Citrix\Licensing\MyFiles\License.lic:

   localhost: license server UP v11.15.0

   Vendor daemon status (on LicenseServer):

      CITRIX: UP v11.15.0

Feature usage info:

   Users of CITRIX: (Total of 10000 licenses issued; Total of 1 licenses in use)

   "CITRIX" v2038.0101, vendor: CITRIX, expiry: permanent(no expiration date)
vendor_string: ;LT=SYS;GP=720;SA=0
floating license

   XDT DDCPrinc-0001.citrix.com XDT XDT\_PLT\&MPS_PLT_2018.0518 (v1.0) (localhost/27000 102), start Tue 5/8 17:59

Users of CTXLSDIAG: (Total of 10000 licenses issued; Total of 0 licenses in use)

Users of XDT_PLT_CCS: (Total of 200000 licenses issued; Total of 3 licenses in use)

   "XDT_PLT_CCS" v2018.1201, vendor: CITRIX, expiry: 01-dec-2018
vendor_string: ;LT=Retail;GP=720;PSL=10;CL=VDS,VDA,VDE,VDP;SA=0;ODP=0;NUDURMIN=2880;NUDURMAX=525600
floating license

   XDT DDCAux-0001.citrix.com XDT 00001E3A (v2018.0518) (localhost/27000 534201), start Wed 5/9 15:17
   XDT DDCAux-0001.citrix.com XDT 00001E81 (v2018.0518) (localhost/27000 392504), start Wed 5/9 15:18
   XDT DDCAux-0001.citrix.com XDT 00001E0C (v2018.0518) (localhost/27000 419703), start Wed 5/9 15:18
<!--NeedCopy-->

The following represents a breakdown of the information contained in the MPS_ENT_CCU line of the lmstat output:

The command lmstat -c@localhost -a can potentially generate much network activity in systems that have many product licenses checked out.

You can use lmstat -a to verify license checkout data.

Display versions of binaries (lmver)

The lmver command displays version information for the licensing binaries, such as the command utilities. One exception is the lmadmin command. To display version information for the lmadmin command, use lmadmin -version.

Syntax:

lmver binary

Example:

lmver lmdiag

Display or release licenses for users or devices (udadmin)

udadmin displays the licensed users and devices and releases licenses for specified users and devices.

You can release a license for a user only when:

• The employee is no longer associated with the company.
• The employee is on an extended leave of absence.

You can release licenses for devices only when the devices are out of service.

Caution:

Mass releases of licenses, before the automatic 90-day lease period, outside of the reasons highlighted earlier might violate the Citrix EULA. Before doing so, contact Citrix.

The udadmin command-line help displays usage information only in English, but you can use the command on non-English systems.

Syntax:

udadmin [-options] [-delete | -events | -export | -list | -times]

Examples:

-  udadmin -list -times

    Usage data is 0 minutes old. Next update in 15 minutes.

    Users:

    u01.01 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)

    u01.04 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)
    .
    .
    .

    Devices:

    D.ADV.23 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)

    D01 XDT_PLT_UD 2017.1201 (Tue Sep 12 14:30:33 2017)

-  udadmin -list -a

    Lists all features, versions, counts of licenses, and the users and devices for each feature.

-  udadmin -export

    feature,userId,deviceId,deviceName,versionRequested,versionUserAllocated,versionDeviceAllocated,time

-  udadmin -f XDT_ENT_UD -device dn01.88 -delete

    Releases one device from one feature.

<!--NeedCopy-->