lmu utility

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX

 

The lmu utility is used to initialize or reinitialize License Manager, configure License Manager to allow Synergy/DE products to run, and generate license usage reports. See Windows options below or UNIX options.

lmu [option][...]

Windows options

One or more of the following:

<none>

Display concurrent usage and configuration information. See figure 1. This command will first start License Manager, if it is not already running. To send the output to a file, use ‑o.

‑app_code

Display license information for the specified app_code(s). You can list multiple application (product) codes on the command line. See also the ‑u option. See Displaying license usage information for sample output.

‑a app_code

Configure product app_code. Used with ‑i and ‑p.

‑b

Brief display of license information, including licensee name, registration string, and system code. On a Windows license client, the license server name and port display instead of the licensee name. On a Windows license client or server, if a backup license server is configured, its server name and port will also display.

‑c lic_name

Initialize License Manager on a license server for licensee lic_name.

The minimum number of characters for lic_name is 4; the maximum is 50. Valid characters are alphanumeric; if the name is longer than 4 characters, it may include spaces and punctuation characters. If lic_name contains spaces, it must be enclosed in quotation marks (" "). Used with ‑ns.

‑c svr_name[:port]

Initialize License Manager on a license client for server svr_name.

Svr_name may be an IP address or the server DNS name. The minimum number of characters for svr_name is determined by your Windows operating system; the maximum is 255 (including the port, if specified). Valid characters are alphanumeric, period (.), and hyphen (‑).

You may optionally specify a non‑default port number that synd is running on. The default port is 2380. Valid ports are in the range 1024 through 32767. Used with ‑nc.

‑d

Initialize License Manager (prompted).

‑f filename

Configure License Manager using the Synergy key file filename (the .skf file). If filename is not in the current directory, specify the complete path. This command installs all the product keys in the .skf file for the machine from which it is run, and then displays a list of products for which keys were installed.

‑h

Display a list of lmu options.

‑i config_key

Specify configuration key config_key. Used with ‑a and ‑p.

‑k password

Remove licensing with a password obtained from Synergy/DE Developer Support. This password is valid for seven days. After running the ‑k option, you’ll need to reinitialize License Manager. Use lmu ‑c or lmu ‑d to reinitialize licensing and then reconfigure all products.

‑l lang_code

Initialize or reinitialize License Manager with foreign language copyright messages. Valid codes:
1 = Dutch
2 = French
3 = Italian

‑m filename

Display the contents of the Synergy key file filename for the machine on which the command is run. This command may not display all data in the file. See also the ‑t option.

‑nb

Initialize a license client as a backup server. To specify a non‑default port, use ‑po. Before running this option, licensing (including a BLS license) must be configured on the primary server, and the backup server must be configured as a license client to the primary server. See Configuring a backup license server (Windows) for additional requirements.

‑nc

Network client installation. Used with ‑c or ‑r.

‑ns

Network server installation. Used with ‑c or ‑r.

‑ofilename

Send concurrent usage and configuration information to a file instead of the screen. This option applies only to the output that is produced when you run lmu without any options.

‑p id

Specify producer ID id. Used with ‑a, ‑i, and ‑u. Required with ‑u when producer code is other than 999.

‑po port

Specify a non‑default port for the License Manager service. The default is 2380. Valid ports are in the range 1024 through 32767. Used with ‑ns, ‑nc, and ‑nb. This option is primarily for use with ‑ns, where the licensee name is specified instead of the server name. When you run lmu with the ‑nc option, you can specify the port as part of the server name (‑c or ‑r); if you also specify ‑po, it is used instead. If ‑po is specified without a port number, the port is set to the default, 2380.

‑r

Reinitialize License Manager and change the license server port. When used without an argument, ‑r can be used with ‑ns and ‑po to change the server to a non‑default port. When used with just ‑ns, it changes the port back to the default. See Changing a license server’s port and Changing back to the default port.

‑r lic_name

Reinitialize License Manager on a license server where lic_name is the licensee name. Used with ‑ns. Use this option to change the licensee name for a license server prior to configuring products. If you have already configured products, you must use lmu ‑k. See the ‑clic_name option above for details on valid values for lic_name. This option can be used without specifying the licensee name to change the port on the server.

‑r svr_name[:port]

Reinitialize License Manager on a license client where svr_name is the license server name. Used with ‑nc. Use this option to change the license server used by an existing license client or change a license server to a license client. Specify the port number if the license server is running on a non‑default port. See the ‑csvr_name[:port] option above for details on valid values for svr_name and port.

‑s

Display the License Manager seat ID. Knowing the seat ID is useful when displaying detailed license usage or when tracking license log‑ins using verbose logging (see Error logging), because you can match up the ID with the usage or debug output. On a terminal server machine, this option also displays details such as whether the workstation is a client or console and whether install mode is enabled.

‑t filename

Display the contents of the Synergy key file filename, sorted by registration string. This option displays all data in the file, regardless of whether it is for the current machine. See also the ‑m option.

‑u app_code

Display detailed license usage for the specified app_code(s). You can list multiple application (product) codes on the command line, separated by a space. Specify ‑p with ‑u when the producer ID is other than 999. See Displaying license usage information for sample output.

‑v

Display the lmu version.

‑x string

Specify extended data string; used only with special application codes.

‑xb

Remove backup licensing. This option is normally run from the backup server, but it can be run from the primary server if the backup server no longer exists or is not accessible. It cannot be used with any other option. Once ‑xb is run, the backup server reverts to license client status and the change is propagated to all license clients. Do not use this option to change either the backup license server or the primary server; instead, follow the instructions in Changing the backup license server for a primary server and Changing the primary server for a backup license server.

UNIX options

One or more of the following:

<none>

Display concurrent usage and configuration information. See figure 1. To send the output to a file, use ‑o.

‑app_code

Display license information for the specified app_code(s). You can list multiple application (product) codes on the command line. See also the ‑u option. See Displaying license usage information for sample output.

‑a app_code

Configure product app_code. Used with ‑i and ‑p.

‑b

Brief display of license information, including licensee name, registration string, and system code.

‑c lic_name

Initialize License Manager for licensee lic_name. The minimum number of characters for lic_name is 4; the maximum is 50. Valid characters are alphanumeric; if the name is longer than 4 characters, it may include spaces and punctuation characters. If lic_name contains spaces, it must be enclosed in quotation marks (" ").

‑f filename

Configure License Manager using the Synergy key file filename (the .skf file). If filename is not in the current directory, specify the complete path. This command installs all the product keys in the .skf file for the machine from which it is run, and then displays a list of products for which keys were installed.

‑h

Display a list of lmu options.

‑i config_key

Specify configuration key config_key. Used with ‑a and ‑p.

‑k password

Remove licensing with a password obtained from Synergy/DE Developer Support. This password is valid for seven days. After running the ‑k option, you’ll need to reinitialize License Manager. Use install_lm to reinitialize; contact Synergy/DE Developer Support for information about install_lm.

‑l lang_code

Initialize or reinitialize License Manager with foreign language copyright messages. Valid codes:
1 = Dutch
2 = French
3 = Italian

‑m filename

Display the contents of the Synergy key file filename for the machine on which the command is run. This command may not display all data in the file. See also the ‑t option.

‑ofilename

Send concurrent usage and configuration information to a file instead of the screen. This option applies only to the output that is produced when you run lmu without any options.

‑p id

Specify producer ID id. Used with ‑a, ‑i, and ‑u. Required with ‑u when producer code is other than 999.

‑q

Display Synergy/DE message queue information.

‑rlic_name

Reinitialize License Manager for licensee lic_name prior to configuring products. See the ‑c option above for details on valid values for lic_name.

‑t filename

Display the contents of the Synergy key file filename, sorted by registration string. This option displays all data in the file, regardless of whether it is for the current machine. See also the ‑m option.

‑u app_code

Display detailed license usage for the specified app_code(s). You can list multiple application (product) codes on the command line, separated by a space. Specify ‑p with ‑u when the producer ID is other than 999. See Displaying license usage information for sample output.

‑v

Display the lmu version.

‑x string

Specify extended data string; used only with special application codes.

‑1

Stop debug logging and send a reset signal to License Manager. See Error logging for more information.

‑2

Start debug logging by License Manager. See Error logging for more information.

Discussion

The lmu utility must be run from the synergyde\dbl\bin directory if the bin directory is not in your path.

See the lmu Error Messages table for a list of error messages returned by the lmu utility and assistance in resolving them.

Displaying license configuration information

Running the lmu utility without any arguments displays to the screen information about license configuration, including the registration string, product code, and current and maximum number of users. On a Windows license server, you’ll see the port number that it is running on. On a Windows license client, you’ll see “Network Client with Server name on port ####”, along with the products that are configured on the license server. Figure 1 shows a sample report on a Windows license server. You can run lmu with the ‑o option to send this information to a file.

1. Sample lmu report showing configured products for a license server.

If the 14‑day evaluation period has not yet expired, you’ll see a message telling you how many days remain for evaluation of the installed products. Note that some products may already be configured, while others are still running as evaluation copies, as shown in figure 2.

2. Sample lmu report showing evaluation period remaining.

If you are using a backup license server (Windows only), the lmu report will tell you how many BLS keys have been installed and the number of configurations remaining as shown in figure 3. The maximum number of configurations is 8; when the displayed value reaches 1, you should contact your Synergy/DE customer service representative to obtain a replacement configuration key. The status of the primary and backup license servers is also displayed.

3. Sample lmu report showing backup license server information from a license client. The backup server is currently in use.

Displaying license usage information

Running lmu and specifying an application (product) code displays license usage information for the specified product. You can include multiple application codes on the command line by separating them with a space. The example below shows output for the runtime (RUN10) and Workbench (PSW10). Each product is configured for 10 users. There are currently two users using runtime licenses and one user using a Workbench license.

c:\lmu RUN10 PSW10
License: RUN10 Producer: 999    (10 User)
  Configured on July 13, 2014
  Current usage: 2

License: PSW10 Producer: 999    (10 User)
  Configured on July 13, 2014
  Current usage: 1

To see more detail, run lmu with the ‑u option followed by the application code(s). On the Windows sample below, the seats match the seat IDs that display when you run lmu ‑s. This will tell you exactly who is using the licenses. On UNIX, the seats match the process IDs of the applications taking the licenses. You can look at the processes on the system to match the seat with a user name.

c:\lmu -u RUN10 PSW10
License: RUN10 Producer: 999    (10 User)
  Configured on July 13, 2014
  Current usage: 2
      Seat 1: MICKEYf75dc5f1 - 1 active process
      Seat 2: BARNEYbe71aa31 - 1 active process (Non-interactive)

License: PSW10 Producer: 999    (10 User)
  Configured on July 13, 2014
  Current usage: 1
  Seat 1: MICKEYf75dc5f1 - 1 active process

Displaying Synergy key file contents

Running lmu with the ‑t option displays the contents of a Synergy key file (.skf). The output includes the registration string, licensee name, and a list of the products that can be configured from the file. There may be data for more than one licensee (i.e., more than one machine) in the file, as shown in the example below.

c:\lmu -t 000999_SY101091605.skf
ABCD-12-EFGH-34 - Larson Weed and Feed, store 217
        PSDE10            Professional Series Development Environment
        RUN10             Synergy Runtime
IJKL-67-MNOP-93 - Larson Weed and Feed, store 354
        RUN10             Synergy Runtime
        PSW10             Professional Series Workbench

To see the keys only for the system on which you are running the command, use the ‑m option. The output will look similar to the following:

c:\lmu -m 000999_SY101091605.skf
The specified Synergy Key file contains the following keys for this system:
        PSDE10      Professional Series Development Environment
        RUN10       Synergy Runtime

Examples

See the Discussion above for examples of using lmu to display information about licensing.

Windows

lmu -cTiger -nc
lmu -rLion -nc 

If the new server is running on a non‑default port, append the port number to the end of the server name:

lmu -rLion:5555 -nc 
lmu -cFred -ns -po5555

UNIX

lmu -aRUN10 -p999 -i58W4-ZA2T-BO42-X4AP

Error messages returned by lmu

If you get errors while running lmu, check the table below to determine the cause.   

lmu Error Messages

Message

Cause

Backup license server requires a client license

You attempted to configure a backup license server on a system that is not configured as a license client. The backup license server must be a license client of the primary license server. See Changing license configurations. (Windows)

Backup license server requires an active Primary Server.

You attempted to configure the backup license server when the License Manager server on the primary server was not available.

Backup server already configured. To make changes, first revert back to a client with (lmu ‑xb)

You issued an lmu ‑nb command on a machine already configured as a backup license server. Before making any changes to the backup server configuration (such as the port number), you must first “undo” it by running lmu ‑xb. See Configuring a backup license server (Windows). (Windows)

Backup server license is not configured

You must configure a backup license server key on the primary server before initializing the backup server. See Configuring a backup license server (Windows). (Windows)

Backup server not allowed from 32‑bit client on 64‑bit machine

A 32‑bit license client running on a 64‑bit machine cannot be a backup server because the 32‑bit synd is not installed in this configuration. (Windows)

Cannot access license file

Lmu cannot access the license information. The file may not exist.

Cannot access license server

The License Manager server is not running on your license server machine on the specified port or the server name specified on the client is incorrect. See Troubleshooting License Manager on Windows. (Windows)

Cannot access newer license information

The version of License Manager you are running is incompatible with the license information. You need a newer version of lmu. (Windows)

Cannot access primary server

You attempted to configure a backup license server to a license server other than the primary server. (Windows)

Changing licensee name is not allowed once licenses have been configured

lmu: Reinstall aborted

You ran lmu ‑r ‑ns after products had already been configured. See Troubleshooting License Manager on Windows.

Configuration limit for BLS exceeded

You have exceeded the limit for configuring the backup license server. You can configure a backup license server eight times for a given BLS license. Contact your Synergy/DE customer service representative for a replacement key. (Windows)

Corrupted license file

The license database is damaged. Contact Synergy/DE Developer Support.

Corrupted license information

The license database in the registry is damaged. Contact Synergy/DE Developer Support.

File name too long; max 255 characters allowed

The Synergy key file name you supplied is too long.

Insufficient privilege

You aren’t running with sufficient privileges to restart synd with your configuration changes. Or, the set‑user‑ID bit is not set for synd. See synd: Insufficient privilege message. (UNIX)

Invalid configuration key

You either typed the configuration key incorrectly or incorrectly relayed your registration string to Synergex. Re‑type the key, paying special attention to occurrences of the number one (1) and the letter “l” and occurrences of the number zero (0) and the letter “O”. If you still get this message, contact Synergex to see if you provided an incorrect registration string. (To see the registration string, use the ‑b option.)

Invalid language code

You entered an invalid language code. See the ‑l option in lmu utility for the valid codes.

Invalid network server port number

The port specified is not in the range 1024 through 32767. (Windows)

Invalid option (‑nx): network type already specified

Where x is b, c, or s. You’ve entered two network types (backup server, client, or server) on the command line. (Windows)

Invalid registration string

The license file is not registered for this machine. Contact Synergy/DE Developer Support.

Invalid use of IP address address

The backup license server requires that the primary server be specified by DNS name rather than IP address.

License file already installed

You have already initialized the licensing system.

License installation corrupt

Your license registry has been changed in error or removed. Use lmu ‑k. Contact Synergy/DE Developer Support for the password and assistance.

License manager did not start…

License manager did not re‑start…

License manager did not stop…

service error

The license service could not be started, restarted, or stopped. (Windows)

License server install requires a local drive image

You attempted to configure a Synergy Client machine as a license server. To be a license server, the machine must have Synergy/DE installed to run locally. (Windows)

Missing language code

You didn’t enter a language code.

Missing required application code

You didn’t type anything at the Product Code prompt.

Missing required configuration key

You didn’t specify the ‑i (configuration key) option or you entered a blank configuration key.

Missing required licensee name

You didn’t type anything at the Licensee Name prompt.

Missing required network type

You didn’t specify ‑nc or ‑ns to indicate network client or network server. (Windows)

Missing required producer ID

You didn’t type anything at the Producer Code prompt.

Network server name too long

The name of the network server exceeds the limit of 255 characters. (Windows)

No Synergy Key Files specified

You ran lmu with the ‑f, ‑m, or ‑t option but didn’t supply a Synergy key file name.

Old version of Synergy License Manager

You did not upgrade your License Manager software when you upgraded some other component of Synergy/DE. Install the latest version of the License Manager software.

Producer file not found

You entered an invalid response at the Producer Code prompt.

Products can only be configured on server

You attempted to install configuration keys on a license client. In a client/server configuration, configuration keys are installed only on the license server. (Windows)

Primary server has no configured products.

No products, other than BLS, have been configured on the primary license server. (Windows)

Server port already in use

The port you have specified for the license server is already in use; choose a different port. (Windows)

Synergy Key File is invalid

The specified Synergy key file is invalid (e.g., contains a misspelled keyword or is missing a required keyword). Contact Synergy/DE Developer Support.

The specified Synergy Key File does not contain any keys for this system

The filename you specified with the ‑f or ‑m option doesn’t contain any keys for the current system.

Uninitialized license file

Your license installation has become corrupt. Use lmu ‑k. Contact Synergy/DE Developer Support for the password and assistance.

Wrong configuration key for installation

The configuration key is not compatible with your installation. For example, the registration string or the licensee name may be wrong. Verify that the configuration key you entered is intended for the current system.

Wrong product code

You entered an invalid product code or a configuration key from another product configuration.  

You must install the license file first

You attempted to configure licenses before installing License Manager.