License Controller (greWrt)

The greWrt command line tool is used to install, upgrade, or delete Genero Report Engine and Genero Report Writer licenses. There are also options to provide various types of license information and statistics.

Syntax

greWrt { import-license [ import-options ] | [ options ] }
  1. The general options of the greWrt command are described in Table 1.
  2. The import-license verb is used to import a license from another product installation. There are import-options specific to this command and these are described in Table 2.
Table 1. greWrt options
Option Description
-h or --help Displays options for the tool.
-V or -version Displays version information.
--short-version Displays short version information.
-L license license_key [ maintenance_key | subscription_key ] Installs a temporary license (requires license number and license key).

For example, you can install an existing license 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 ]

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

If --auto is provided, HTTP licensing is used (Internet connection is required).
-l license license_key [ maintenance_key | subscription_key ] Installs a license.

To escape when prompted to enter a license number and license key, type "stop" at the prompt.
-m option Maintenance key installation, possible options are:
  • key : Install a key directly.
  • auto : The key is automatically installed (Internet connection is required).
-u Check for active users.
-k option Installation key for license validation, possible options are:
  • key : Install a key directly.
  • auto : The key is automatically installed (Internet connection is required).
-d Remove current installed license.
--decode-license-string license-string Decode the license string and write the license string information to the standard out.
--encode-license-string [ license ] [license_key] [ maintenance_key | subscription_key ] [login ] Encode license information into a license string that is written to the standard out.
-i Clears the list of registered user sessions.
-a option Check or view options.

Here option can be one of the following:

  • info users : Shows information about registered active users.
  • info license : Shows license information.
  • cpu : Shows number of CPU in the computer.
  • up : Shows if license server is up and responding.
  • ps : Shows processes on this machine.
  • env : Shows current environment
  • hostname : Shows name of this machine.
-x or -kill-session pid Clears the session referenced by the specified pid.
--batch action=command Performs the specified action in batch mode.
Here command can be one of the following:
  • target-info (Get operating system information)
  • lm-info (Get license manager information)
  • product-info (Get license controller information )
  • license-info (Get license information)
  • install-license^lnum=license_num^lkey=license_key
  • uninstall-license
  • install-mkey^mkey=[ maintenance_key | subscription_key ]
  • install-mkey-http^login=username^proxy=http://myproxy^proxy-port=port-number^proxy-user=proxy-user^proxy-passwd=proxy-password
  • install-ikey^ikey=installation_key
  • install-ikey-http^user=username^proxy=http://myproxy^proxy-user=proxy-user^proxy-passwd=proxy-password
    The caret character (^) is used for parsing. In Windows® the caret is also used to escape special characters so you may need to double (^^) it up in commands, for example: 
    greWrt --batch action=install-mkey^^mkey=maintenance_key
--batch-console action=command Opens greWrt in console mode for the batch commands. 
C:\gst\gre\bin>greWrt --batch-console
$ action=product-info
{
  "product": "greWrt",
  "version": "5.20.11",
  "wrtminver": "5.20.05",
  "build": "201908061357",
  "target": "w64v141",
  "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.
--log-rotate

Force log rotation. You can force a log rotation even while log files are in use.

Table 2. greWrt import-license command options
Option Description
-h or --help

Display help for the command.
--from installation_directory

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

Specify the license number if --from is a Four Js License Manager installation.

Usage

The greWrt is the command line tool you use to administer licensing:

For example:
  • Use the greWrt -a info license command to get license information.
  • Use the greWrt -l command to install licenses.
Running commands in Windows elevated command
In a Windows system, some greWrt 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:
  • greWrt -L # install a temporary license
  • greWrt -l # install a license
  • greWrt -k # install an installation key
  • greWrt -m # install a maintenance/subscription key
  • greWrt -d # delete a license
  • greWrt --install-license-string
  • If the commands above are run with the --batch option, the UAC prompt is raised too.
  • greWrt 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.