Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


The information on this page refers to License Statistics
v5
v6.
15
18 or newer, which
upgraded MySQL to v5.7.
introduced the CLI. If you are using an earlier version of License Statistics, please refer to the documentation for
releases prior to v5.15.
Info
Important: Be sure to make a backup before uninstalling License Statistics. All files will be deleted from the License Statistics installation directory during the uninstallation.


Important: All automated scripts (mysql_xxx.bat or mysql_xxx.sh) described in this document are configured to operate on an embedded database running on default configuration settings, as listed below. In all other cases (different configuration or external database), you must either do manual operations on the database or adjust the scripts to your custom needs.
Info
Info

Default settings for an embedded database:

HostPortUserPasswordDatabase Name
localhost3306root
xformation_licstat


Determining how to do the backup

You should use the automated backup and restore scripts provided with License Statistics if possible. However, if your needs and installation do not allow you to use the automated scripts, you can perform the backup and restore procedures manually.

Using License Statistics backup and restore scripts

License Statistics includes the following scripts for automating backups when the database created by License Statistics (EMBEDDED64) is used with default settings. Review these scripts so you are familiar with what they do, and decide if they will work for your backup and restoration needs.

can perform a backup using the License Statistics Manager for Windows, or the License Statistics CLI (Command Line Interface) for either Windows or Linux.

Using the License Statistics Manager for the backup 

For Windows installations, you can create the backup using the Backup button in the Maintenance section of the License Statistics Manager. 

Image Added

Using the CLI for the backup

The CLI can be used for backup, restore and related operations. The CLI is available for both Linux and Windows:

For Linux: xflicstat-cli

For Windows: xflicstat-cli.exe

The CLI provides the following commands for performing backups. 

ActionCLI command
Back up the License Statistics database (starts
Script for WindowsScript for LinuxDescriptionmysql_start.batmysql_start.shStarts the MySQL database.mysql_stop.batmysql_stop.shStops the MySQL database.mysql_backup.batmysql_backup.shBacks up the License Statistics database.mysql_restore.batmysql_restore.shRestores the License Statistics database.mysql_start_backup_stop.batmysql_start_backup_stop.shStarts
, backs up, and stops the MySQL database
.mysql_start_restore_stop.batmysql_start_restore_stop.shStarts
)storage backup
Restore the License Statistics database (starts, restores, and stops the
the
MySQL database
.
)
Info
Note: You may not be able to run the scripts as a normal user on Windows due to Windows limitations, so be sure to run the scripts as an administrator (see http://technet.microsoft.com/en-en/library/cc947813(v=ws.10).aspx for instructions on starting a command prompt as an administrator).

Backing up and restoring the database manually

When running License Statistics using an external database that is not maintained by License Statistics, you must do manual backups instead of using the supplied scripts. You must also do manual backups if you are running EMBEDDED64 with any custom settings, such as a custom database name, port, password set, or different user.

If you must do a manual backup, review the scripts to base the backup on what is done in the scripts.

Preparing for the backup

Before you begin your database backup:

  1. Go to the License Statistics installation directory and select the MySQL directory for your License Statistics database. This directory is named mysql.
  2. Ensure you have enough space for the database dump.
storage restore
Drop (remove) the License Statistics databasestorage clean
Reset the Admin password to the default password

Anchor
reset_pwd
reset_pwd
resetAdminPassword


Info
Note: The CLI should always be used with Administrator or root privileges.

Anchor
backup
backup
Backing up the database

The following instructions assume that you are using the License Statistics scripts CLI to backup the database. If you are backing up the database manually, use the scripts to guide you in what is needed for manual backup.

To perform a backup of the License Statistics database:

  1. Stop License Statistics. Backing up the database when License Statistics is running will cause the database dump to be inconsistent with the current state of monitored data.
  2. Open a command prompt with full administrator permissions.
  3. Navigate to the database folder named "mysql" under the License Statistics installation directory.
    • For Windows:

      Code Block
      languagebash
      cd C:\Program Files\X-Formation\License Statistics


    • For Linux:

      Code Block
      languagebash
      cd /opt/xflicstat/bin
  4. Execute the "mysql_start" script to launch MySQL client.After MySQL starts, execute the "mysql_backup" script. This script xflicstat-cli.exe storage backup" command. This command creates a .dump file in the directory from which the script command was executed.When the backup is complete, execute the "mysql_stop" script.
Tip

You can perform steps 4-6 at the same time rather than individually by using the "mysql_start_backup_stop" script.


Info
Backing up the database may take a long time, depending on the volume of data in your database.

The script creates the "xformation_licstat.dump" file.

When the backup is complete:

...

.

...


Anchor
Restoring database
Restoring database
Restoring the database

The following instructions assume that you are using the License Statistics scripts CLI to restore the database. If you are restoring the database manually, use the scripts to guide you in what is needed for manual restoration.

To restore the data:

...

  1. Stop License Statistics. Restoring the database when License Statistics is running will cause the state of the database to be inconsistent with monitored data.
  2. Open a command prompt with full administrator permissions.
  3. Navigate to the database folder named "mysql" under the License Statistics installation directory.
  4. Put the saved database dump in the "mysql" directory.
    • For Windows:

      Code Block
      languagebash
      cd C:\Program Files\X-Formation\License Statistics


    • For Linux:

      Code Block
      languagebash
      cd /opt/xflicstat/bin
    Start the MySQL database using the "mysql_start" script.
  5. If the database already exists, drop clean it before attempting the restore by running "mysql_clean."using the "xflicstat-cli.exe storage clean" command.
  6. Restore the database using the "mysql_restore" script.
  7. Run the "mysql_stop" script to shut down the MySQL database. 

...

  1. xflicstat-cli.exe storage restore dump_file" command.


Tip
When upgrading License Statistics to a new version, you do not have to restore the database dump. You can use a new database (not necessarily the one that was used before upgrading) as well. 


Info

Restoring the database may take a long time, depending on the volume of data in your database.

After the database is restored:

...

Info
Important: Do not change the structure of the new xflicstat.cfg file.

...

.