FLM (flmprg) options

The flmprg command line tool is used to install, upgrade, or delete Genero licenses. There are also options that apply specifically to Windows®, and options to provide various types of license information.

Syntax

flmprg { -V | -h | --short-version | import-license [ import-options ] | import-all-licenses [ import-all-options ] | [ options ] }
  1. Display help or version information for the flmprg command.
  2. The general options of the flmprg command are described in Table 1. There are various options to manage licensing:
    1. Options to manage licenses, such as install and uninstall licenses, are described in Table 2.
    2. Options to manage users, such as check active users, are described in Table 3.
    3. Options to manage the service, such as stop and start it, are described in Table 4.
    4. Options to run commands from a batch file are described in Table 5. Options to use the batch console are described in Batch commands (flmprg).
    5. Options for use on Windows only, such as install and uninstall the service, are described in Table 6.
    6. Options for log rotation are described in Table 7.
  3. The import-license command is used to import a license from another product installation. There are import-options specific to this command, and these are described in Table 8 .
  4. The import-all-licenses command is used to import all licenses from another FLM installation. There are import-all-options specific to this command, and these are described in Table 9.

Syntax 1: import-license command

flmprg import-license [import-options]
  1. The import-license command imports a license from another product installation.
  2. import-options are described in Table 8.

Syntax 2: import-all-licenses command

flmprg import-all-licenses [import-all-options]
  1. The import-all-licenses command imports all licenses from another FLM installation. For example, import licenses from a previous FLM installation.
  2. import-all-options are described in Table 9.

flmprg Options

Table 1. Help and version options
Option Description
-h or --help

Display help for the license manager tool.
-V or --version Shows license manager version information.
--short-version Displays short version information about the license manager.
flmprg 6.00.05 build-202105200957 rev-5f61e35 target-w64v141
Table 2. License management options
Option Description
-L lnum lkey [ mkey ] Installs a temporary license (requires license number and license key). If the maintenance/subscription key is provided, it is installed.
Note: Temporary license

You can install an existing license, for example, on a new server on a temporary basis for 30 days. In that time, you validate the license with Four Js and install the Installation key (-k option) from the license validation.
--install-license-string license-string [ --auto ]

Installs a license or update an installed license using the provided license string.

If --auto is provided, HTTP licensing is used (Internet connection is required). Optional parameters for proxy may be used:

  • --proxy-host host
  • --proxy-port port
  • --proxy-user user
  • --proxy-passwd passwd
-l [ lnum ]

Installs a license (requires license number and license key).

To escape at any stage, type "stop" at the prompt.

-m lnum option Installs the maintenance/subscription key for the specified license, possible options are:
  • mkey : Install a maintenance/subscription key directly.
  • auto : The key is automatically installed (Internet connection is required).
-k lnum option Installs the installation key for license validation, possible options are:
  • ikey : Install an installation key directly.
  • auto : The key is automatically installed (Internet connection is required).
-d lnum
Deletes the specified license.
Important:

You cannot remotely add or remove licenses registered on Four Js License Manager (FLM) with a local license controller command, for example, fglWrt.
-a option
Shows various license information, possible options are shown in the table.
Option Description
env Shows current environment.
hostname Shows name of the host machine.
cpu Shows number of CPUs in the computer.
info license Shows license information.
info users Shows all registered active users.
info up Checks if the FLM is started.
--decode-license-string license-string Decodes a license string and write the license string information to the standard out.
--encode-license-string [ lnum ] [lkey] [mkey] [login ] Encodes license information into a license string that is written to the standard out. See Encode a license string.
Table 3. Registered user management options
Option Description
-u or --verify-users [ host | all ]

Checks active users working on a given host.

-u all checks users on all machines.
-i or --clear-sessions [ lnum | all ]
Clears the list of registered user sessions for a given license.
Warning:

All active users will be disconnected.

Use -i all to clear lists for all licenses.
-x or --kill-session[host : pid | host ] Kills all sessions owned by the specified host, if pid is provided, only the specified session is cleared.
Table 4. Service management options
Option Description
-r or --service-start

Runs the license server daemon.
-s or --service-stop

Stops the license server daemon.
--service-restart

Restart the license server daemon - same as stopping and starting the service.

-D or --no-detach

Stops the flmprg tool from detaching from the terminal and becoming a daemon.
--validate-configuration Validate the FLM configuration. If issues are found, they are displayed to the standard out. The process exit status is 0 if the configuration is valid or 1 if not valid.
Table 5. Batch command options
Option Description
--batch [ help | action=command ] Performs the specified action in batch mode.

Here command can be an action to display information, manage licenses, and view active users, etc.

Type help for instructions on its use and to display all available commands:
flmprg --batch help
You can write batch commands to a file and apply license configuration changes easily. For more information, see Batch commands (flmprg) and Batch command file.
--batch-console action=command Opens flmprg in console mode for the batch commands. 
{
  "product": "flmprg",
  "version": "6.00.13",
  "wrtminver": "6.00.10",
  "build": "202301131121",
  "git-rev": "01e1199",
  "target": "w64v142",
  "status": 0,
  "status-msg": "Success."
}
The output is JSON formatted. You can enable / disable indentation on the output. The default is indented. To quit the console type exit. Type help for instructions on its use.
Table 6. Windows only command options
Option Description
--service-install

Installs the service and exits.
--service-uninstall

Uninstalls the service and exits.
Table 7. Log rotation
Option Description
--log-rotate

Force log rotation. For more information on log file rotation, go to Log file rotation
Table 8. flmprg import-license command options for importing licenses from another installation
Option Description
-h or --help

Display help for the command.
--from InstallationDir

Specify the path to the product installation directory the license is to be moved from.
--license lnum

Specify the license number of the license to move if --from is a Four Js License Manager installation. For example:

flmprg import-license --from /opt/fourjs/old_flm --license TAB#XXXXXXXX

For more details, go to Import licenses from another installation (flmprg)
Table 9. flmprg import-all-licenses command options for importing licenses from another FLM installation
Option Description
-h or --help

Display help for the command.
--from InstallationDir

Specify the path to the FLM installation directory that licenses are to be moved from. For example:

flmprg import-all-licenses --from /opt/fourjs/old_flm

For more details, go to Import licenses from another installation (flmprg)

Usage

The flmprg is the command line tool you use to administer the FLM:

For example:
  • Use the flmprg -a up command to check if the server is accessible.
  • Use the flmprg -l command to install licenses.
Running commands in Windows elevated command
In a Windows system, some flmprg commands will only work if run as administrator, and a Microsoft® User Account Control (UAC) prompt will be raised to open an elevated command terminal where you can complete the action. If you have not started the command terminal with "Run as Administrator", the following commands will raise the UAC prompt:
  • flmprg -L # install a temporary license
  • flmprg -l # install a license
  • flmprg -k # install an installation key
  • flmprg -m # install a maintenance/subscription key
  • flmprg -d # delete a license
  • flmprg --install-license-string
  • If the commands above are run with the --batch option, the UAC prompt is raised too. For more information, see Batch commands (flmprg).
  • flmprg import-license

Commands will fail if you cancel the prompt and run without administrator privileges. If you are an administrator, or have administrator privileges, you can validate the UAC by clicking Yes. Once you have validated the UAC, an elevated command terminal is opened where you can complete the action.

Tip: If you need to disable the UAC prompt, you can set the environment variable FLM_BYPASS_UAC=1. Be aware that with the UAC prompt disabled, you will need to open a terminal with "Run as Administrator" to run commands that need administrator privileges.