The information on this page refers to License Statistics v6.23 and newer, which no longer requires stopping License Statistics prior to performing a backup. If you are using an earlier version, please refer to the documentation for earlier versions. 

The License Statistics CLI (Command Line Interface) can be used for administration operations such as storage, license management, etc. The CLI is included in your License Statistics installation in the main installation directory.

For Linux: xflicstat-cli

For Windows: xflicstat-cli.exe

Open the terminal using escalated permissions (Administrator or root privileges).

The CLI commands are described below.

CommandCommand OptionsDescription
storage

backup <writeTo>

Creates a data backup

  • Can use an optional "--compress" flag, which creates a zip archive of the database dump
  • Can use an optional "--allow-live-backup" flag to create the database dump without stopping License Statistics
  • The CLI automatically starts and stops the database before executing this operation if needed

Backup creation may take some time. When creating the backup without stopping License Statistics, the dump will contain data from the time when the backup process was started.


restore <readFrom>

Restores a data backup from the database dump file and from the zip archive, if one was created using the  "–compress" flag with the storage backup command

  • Requires a "--confirm" flag for safety
  • Can use an optional "--force" flag to suppress optional validation of used files and existing database structures
  • You must stop License Statistics before executing this operation
  • The CLI automatically starts and stops the database before executing this operation if needed

clean

Removes data

  • Requires "--confirm" flag for safety
  • You must stop License Statistics before executing this operation
  • The CLI automatically starts and stops the database before executing this operation if needed

apply <readFrom>

Runs a custom SQL script delivered by X-Formation Support Team

  • Requires "--confirm" flag for safety
  • Can use optional "--force" flag to suppress optional validation of used files and existing database structures
  • You must stop License Statistics before executing this operation
  • The CLI automatically starts and stops the database before executing this operation if needed
licenseimport <licenseFile>

Imports the license from the specified file

  • You must stop License Statistics before executing this operation
  • The CLI automatically starts and stops the database before executing this operation if needed

activate <activationKey> 

Activates the license remotely using the specified activation key

  • You must stop License Statistics before executing this operation
  • The CLI automatically starts and stops the database before executing this operation if needed

hostId

Returns the License Statistics server's host ID values


activationUrl  <activationKey>

Returns the URL to License Activation Center for specified activation key as an alternative way of activating the license

createSupportFile<path>Creates a support file in the specified path, or if the path is not specified, in the current directory
status 
Returns the server status
resetAdminPassword
Resets the admin account password to the default "admin" value
version 
Returns the server version