lmadmin Command-line Arguments

This section describes in outline each of the lmadmin command-line arguments. Arguments defined as persistent will remain set until they are reset.

Usage

lmadmin [-version] [-config <configFile>] [-configDir <configFileDirectory>] [-cacheDir <cacheDirectory>][-root <lmadmin_install_dir>] [-force] [-import <licenseFileList>]

[-importInstallation <oldInstallDirectory>[-config <configFileForImport>][-configDir <configDirForImport>]] [-licPort <licenseServerPort>][-webPort <httpPort>]

[-allowStopServer <yes|no>] [-allowRemoteStopServer <yes|no>][-allowLicenseReclaim <yes|no>]

[-installService <servicename> [-addDependencyFNLS] [-delay <seconds>]] [-removeService <serviceName>]

[-defaultAdminUser <domain\username>] [-defaultAdminGroup <domain\groupname>]

[-uploadDir <uploadDirectory>] [-<userid> -Pass <password> -Role <roleType> [-FirstName <name>] [‑LastName <name>][-offlineupdate <1/0>]] [-<userid> [-Pass <password>] [-Role <role_type>] [-FirstName <name>] [‑LastName <name>][-offlineupdate <1/0>]] [-userdel <userid> [-foreground] [-adminOnly <yes|no>] [-logDir <logDirectory>][-offlineupdate <1/0>]]

 

lmadmin Command-line Arguments

Argument Syntax

Description

Function

-addDependencyFNLS

Default - Do not add dependency on FlexNet Licensing Service

Persistent - N/A

Set from UI - No

(applicable only for Windows)

Can be used with the -installService option. This results in addition of a dependency on FlexNet Licensing Service, (32-bit or 64-bit depending on the lmadmin executable type), for lmadmin service.

The default is not to have this dependency.

-adminOnly
<yes|no>

Default—Yes

Persistent —Yes

Set from UI—No

Restricts usage of lmdown, lmreread, and lmremove—as well as lmswitch, lmswitchr, and lmnewlog. If you set -adminOnly no, command-line access to these utilities is unrestricted. (Access to related features in the lmadmin UI is governed separately by lmadmin login credentials.)

By default, lmadmin restricts command-line access to these utilities. The default argument, ‑adminOnly yes, overrides other lmadmin command-line options, such as ‑allowLicenseReclaim, -allowStopServer, and ‑allowRemoteStopServer.

Restrictions vary depending on the operating system on which lmadmin is running.

On Windows, command-line access to these utilities is completely restricted. If -adminOnly yes is used when starting lmadmin, no user on Windows can shut down the license server with lmdown, nor can they use the lmswitch, lmswitchr, and lmnewlog command-line utilities.

On UNIX, -adminOnly yes permits access by the root user only, by default. However, if you define a UNIX group called lmadmin, then access is permitted to members of that group only. (If root is not a member of this group, then root does not have permission to use any of the above utilities.)

-allowLicenseReclaim
<yes|no>

Default —No

Persistent—Yes

Set from UI—No

Controls the operation of lmremove (in License File–Based Licensing). If set to yes, licenses can be reclaimed from a user. If set to no, licenses cannot be reclaimed from a user.

Note:Restrictions from the ‑adminOnly yes argument may prevent license reclamation even if you set ‑allowLicenseReclaim yes.

-allowStopServer
<yes|no>

Default—Yes value

Persistent —Yes

Set from UI —No

Configures how the license server can be stopped.

If set to yes, local clients can stop the license server using either lmdown or the Stop Server button in the UI.

Note:Restrictions from the ‑adminOnly yes argument may prohibit stopping the server from the command line even if you set ‑allowStopServer yes.

If set to no, then the license server must be stopped by stopping the process. See Manually Stopping the License Server Manager.

Note:Setting ‑allowStopServer no also sets ‑allowRemoteStopServer to no.

-allowRemoteStopServer
<yes|no>

Default—No value

Persistent—Yes

Set from UI—No

Configures whether the license server can be stopped from a remote location.

If set to yes, then you can stop the license server from a remote location and local clients can stop the license server using either lmdown or the Stop Server button in the UI.

Note:Restrictions from the ‑adminOnly yes argument may prohibit remotely stopping the server from the command line even if you set ‑allowRemoteStopServer yes.

If set to no, then it must be stopped from a local client. See Online help for further details.

Note:Setting ‑allowRemoteStopServer yes when ‑allowStopServer is not defined, forces ‑allowStopServer to be set to yes.

-config
<configFile>

Default—server.xml

Persistent—Yes

Set from UI—No

Defines the name of the license server configuration file to use when starting the license server manager. If all defaults are set, the path and name is the following: <lmadmin_runtimedata_dir>\conf\server.xml.

-configDir
<configDir>

Default—<lmadmin_runtimedata_dir>
\conf (Windows); <lmadmin_install_dir>/conf (non-Windows)

Persistent—Yes

Set from UI—No

Defines the directory where the license server configuration files are located.

-cacheDir <cacheDirectory>

Default—<lmadmin_runtimedata_dir>
\cache (Windows); <lmadmin_install_dir>/cache (non-Windows)

Persistent—Yes

Set from UI—No

Defines the destination directory path for cache files.

-delay
<seconds>

Default—0

Persistent—Yes

Set from UI—No

(applicable only for Windows)

Used when configuring the license server as a service on Windows. See Installing lmadmin License Server Manager as an Operating System Service.

-defaultAdminUser <domain\username>

Default—N/A

Persistent—Yes

Set from UI—Yes

(applicable only for Windows and Linux)

Adds the specified Windows Active Directory user as an lmadmin Administrator. The license administrator can then log in to the lmadmin user interface initially using this user ID (and its Active Directory password) and proceed to perform administrative tasks.

To identify this user, use the format domain\username, where domain is a valid Windows Active Directory domain to which the machine running lmadmin has a trusted relationship, and username identifies a valid account within that domain. This value is not case-sensitive and can include up to 64 characters.

Note:Use this argument sparingly. Its main purpose is to provide initial access to the lmadmin interface.

-defaultAdminGroup <domain\groupname>

Default—N/A

Persistent—Yes

Set from UI—Yes

(applicable only for Windows)

Adds the specified Windows Active Directory group as an lmadmin Administrator. The license administrator can then log in to the lmadmin user interface initially using any Active Directory user ID (and its associated password) belonging to this group and proceed to perform administrative tasks.

To identify this group, use the format domain\groupname, where domain is a valid Windows Active Directory domain to which the machine running lmadmin has a trusted relationship, and groupname identifies a valid account within that domain. This value is not case-sensitive and can include up to 64 characters.

Note:Consider the following:

• Setting a domain group as the lmadmin Administrator is helpful in a large enterprise where you might have several license administrators who need access to the interface. For more information, see the Online help once you have opened the interface.
• Use this argument sparingly. Its main purpose is to provide initial access to the lmadmin interface.

-force

Default—Do not overwrite settings

Persistent—No

Set from UI—No

Use with the -import argument to overwrite existing vendor daemon settings in the license server configuration file. The following settings are overwritten or reset to the default:

• License file location (overwritten).
• Vendor daemon location (overwritten).
• Vendor daemon port (reset to default).
• Restart retries (reset to default).
• Date-based versions (reset to default).
• Overwrite vendor daemon log (reset to default).
• Vendor daemon log location and name (reset to default).

-foreground

Default—Run in background

Persistent—No

Set from UI—N/A

Runs lmadmin in the foreground (output status and errors are sent to the command window).

-import
<licenseFileList>

Default—N/A

Persistent—N/A

Set from UI —Import License button

Updates the license server configuration file with information extracted from the specified license files. See license_file_list for details of the format of <licenseFileList>. This option does not start lmadmin. The only arguments that can be combined with -import are: ‑config, -configDir, -cacheDir, and -force.

-importInstallation
<oldInstallDirectory>
[-config <configFileForImport>]
[-configDir <configDirForImport>]

Default—N/A

Persistent—N/A

Set from installer—Specify in Import Files from Previous Installation in the lmadmin installer.

Imports configuration information from the specified existing lmadmin installation directory or from a specified location for the license server configuration files (optional use of -config or -confDir). This option does not start lmadmin. The only arguments that can be combined with -importInstallation are: ‑config, ‑configDir, and -root.

-installService
<serviceName>

Default—Do not install lmadmin as a Windows service

Persistent—N/A

Set from UI—No

(applicable only for Windows)

Used when configuring the license server as a service on Windows. See Installing lmadmin License Server Manager as an Operating System Service.

-licPort
<licenseServerPort>

Default—First available in range 27000-27009

Persistent—Yes

Set from UI—Specify for License Server Manager Port (located under the License Server Configuration heading on the Server Configuration tab on the Administration page)

Configures the license server manager port. To set a specific port, enter a positive integer for <licenseServerPort>. A valid number is any unused port number in the range 1 to 65535. On UNIX, choose a port >1024, since those <1024 are privileged port numbers.

If you specify a port number greater than 65535, the client fails to establish a connection with lmadmin.

If no port is specified, the license server will automatically use the next available port number in the range 27000 to 27009. Applications, when connecting to a server, try all numbers in the range 27000 to 27009.

Note:Those producers concerned about potential DoS attacks based on knowledge of common license server ports may want to consider specifying a server port outside the range 27000 to 27009.

-logDir
<logDirectory>

Default—<lmadmin_runtimedata_dir>
\logs (Windows); <lmadmin_install_dir>/logs (non-Windows)

Persistent—Yes

Set from UI—No

Writes the lmadmin logs to the location you specify for <logDirectory>. Enter an absolute path for <logDirectory>.

Assuming no vendor daemon logs have been set (in the options file) to write to a custom location, lmadmin writes all lmadmin logs to the location you set for <logDirectory>. When a custom vendor daemon log location is set, that setting overrides the -logDir setting for that particular vendor-daemon log.

-offlineupdate <1/0>

Default is online update

Persistent - N/A

Set from UI - No

Do offline/online update for user configuration

-removeService
<serviceName>

Default—N/A

Persistent—N/A

Set from UI—No

(applicable only for Windows)

Used when configuring the license server as a service on Windows. See Installing lmadmin License Server Manager as an Operating System Service.

-root
<lmadmin_install_dir>

Default— root installation directory.

Persistent—No

Set from UI—No

Specifies the root directory for lmadmin. This enables you to issue an lmadmin command from somewhere other than the directory where lmadmin is installed.

Note:Any command-line arguments that specify relative paths define paths relative to the current directory and not the directory specified with -root.

-uploadDir
<uploadDirectory>

Default—<lmadmin_runtimedata_dir>
\licenses\
<vendor> (Windows); <lmadmin_install_dir>/licenses/<vendor> (non-Windows)

Persistent—Yes

Set from UI—No

Configures the directory where license files that are uploaded to the license server manager are stored. A directory with the name of the vendor daemon can be set by using the string “%v” as in the following example:

-uploadDir flexlicenses\%v

-<userid> -Pass <password> -Role <roleType> [-FirstName <name>] [‑LastName <name>]

Persistent—Yes

Set from UI—Yes

Adds a new lmadmin user-interface user. Provide the following parameters:

• -<userid>—Provide either value:

For a locally managed account (that is, defined and managed by lmadmin), a user-defined sign-in ID, up to 64 characters. The value is case-sensitive and can include spaces but no backslashes (\).

or

For a Windows Active Directory domain account, the account ID in the following format:

<domain>\<username> | <groupname>

where <domain> is the active Active Directory domain to which the machine running lmadmin has a trusted relationship and <username> or <groupname> identifies a valid user or group account existing within that domain. This value is not case-sensitive and can include up to 64 characters. Separate multiple domains with a backslash (\).

Note:When a Windows Active Directory group account is defined to lmadmin, only the group name is identified in the account. However, a user must sign in to lmadmin using a domain user name (not the group name) and its password. lmadmin then contacts the domain server to validate the user as a member of a group account defined to lmadmin.

• -Pass <password>—(Locally managed accounts only) Specify the password for the specified user ID. The password must be at least 8 characters.

-<userid> -Pass <password> -Role <roleType> [-FirstName <name>] [‑LastName <name>]

(continued)

 
• -Role <roleType>—Specify one of these roles to assign lmadmin user-interface privileges to the account:

user—The user is limited to lmadmin Dashboard functionality only.* Assign this role only when you are password-protecting the Dashboard.*** Otherwise, the user has automatic access to the Dashboard.

admin—The user (locally managed or in Windows Active Directory) has administrator rights.**

userGroup—(Windows Active Directory group account only) The domain group is limited to lmadmin Dashboard functionality only.* Assign this role only when you are password-protecting the Dashboard.*** Otherwise, the group has automatic access to the Dashboard.

adminGroup—(Windows Active Directory group account only) The domain group has administrator rights.**

• -FirstName <name>—(Locally managed accounts only; optional) The user’s first name. This value can include up to 32 characters.
• -LastName <name>—(Locally managed accounts only; optional) The user’s last name. This value can include up to 32 characters.

-<userid> [-Pass <password>] [-Role <role_type>] [-FirstName <name>] [-LastName <name>]

Persistent—Yes

Set from UI—Yes

Enables you to modify the lmadmin user-interface user account identified by the account ID (<userid>). You can modify the account's role and, for locally managed accounts, the password and first and last names of the user. See the ‑useradd argument described previously in this table for descriptions of these parameters.

-userdel <userid>

Persistent—Yes

Set from UI—Yes

Removes the lmadmin user-interface user account identified by the account ID (<userid>).

-webPort <httpPort>

Default—8090

Persistent—Yes

Set from UI—Specify for HTTP Port (located under the Web Server Configuration heading on the Server Configuration tab on the Administration page)

Configures the TCP/IP port that the Web server uses to listen for communication with clients connecting to the license server management interface. See License Server Manager Not Starting for an example of how to use this argument.

-webSecurePort <httpsPort>

Default—0

Persistent—Yes

Set from UI—Specify for HTTPS Port (located under the Secure Web Server Configuration heading on the Server Configuration tab on the Administration page)

Configures the TCP/IP port (five characters maximum) that the lmadmin web server uses to listen for HTTPS (HTTP-over-SSL) communication. If you change the port, you must stop and restart the license server.

Important:Specify the -webSecurePort option only if you are configuring HTTPS communication with the lmadmin web server interface.

-version

N/A

Outputs details of the lmadmin version to the command prompt.

* Dashboard privileges provide access to all the lmadmin user-interface Dashboard functionality. This includes viewing license activity and alterts, changing the user password (locally managed accounts only), and selecting a locale when multiple locales are configured on the system.

** Administrator privileges include all Dashboard privileges plus the ability to access the Administration page of the lmadmin user interface. From this page, the administrator can perform license-server configuration and management tasks, and set up, edit, or delete other lmadmin user accounts.

*** To password-protect the Dashboard, use the Password Protect Dashboard option on the Server Configuration tab located on the Administration page in the lmadmin user interface.

Obtaining lmadmin Command-Line Help

For a handy reference to lmadmin command-line arguments, use this procedure.

To obtain a handy reference of lmadmin command-line arguments:

1. Open a command-prompt window.
2. Change to the directory where the lmadmin file is located.
3. Enter the following command to view a list of available arguments with a description of each:

lmadmin -help

The help descriptions identify the default arguments and which arguments are persistent, arguments that will remain in effect for later instances of lmadmin.