Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

HealthBot Configuration – Backup and Restore

 

Back Up the Configuration

To back up the current HealthBot configuration:

  1. Select the Administration > Backup option from the left-nav bar.
  2. Check the check box for the configuration that you want to backup.

    If you also want to back up any configuration changes that have not yet been deployed, toggle the Backup Undeployed Configuration switch to the right.

  3. Click Backup.

Back Up Helper Files

Helper files are the python, yaml, or other externally created files whose tables are referenced in iAgent sensor definitions within rule definitions.

  1. Select the Administration > Backup option from the left-nav bar.
  2. Click the BACKUP HELPER FILE button.

    HealthBot creates a tar archive that you can save to your computer.

Restore the Configuration

To restore the HealthBot configuration to a previously backed up configuration:

  1. Select the Administration > Restore option from the left-nav bar.
  2. Click the Choose File button.
  3. Navigate to the backup file from which you want to restore the configuration, and click Open.

    Once opened, a list of backup configuration sections appears as buttons under Select the configuration backup file heading. By default, all configuration elements in the selected backup file are selected to restore.

  4. (Optional) From the list of buttons, you can deselect (change the “-” to “+”) individual files from restoring by clicking on the button.
  5. Click RESTORE CONFIGURATION & DEPLOY to restore and deploy the configuration.

Restore Helper File

To restore previously backed up helper file archives:

  1. Select the Administration > Restore option from the left-nav bar.
  2. Click the Choose File button directly above the second line, “Select the helper backup file”.
  3. Locate the backed up helper file in the file browser and click Open.
  4. Click the RESTORE CONFIGURATION button to restore the helper files to HealthBot, or the RESTORE CONFIGURATION & DEPLOY button to restore the helper files to their original location within HealthBot.

Backup or Restore the Time Series Database (TSDB)

Starting with HealthBot Release 3.2.0, you can backup and restore the TSDB separately from other configuration elements. The backup and restore operations for the TSDB are only available through the HealthBot CLI. The backup and restore commands are invoked by using a predefined python script, healthbot.py. You must have root access to the CLI interface of the HealthBot server in order to issue these commands.

An environment variable must be set on the HealthBot server prior to any backup or restore operation. The following shows how to set this variable.

Note

In the example above, HB_EXTRA_MOUNT1 is a variable. As such, it coulld be given any name that you want.

The following shows the generic command and the optional arguments (in square brackets) available. Each option is then described and an example is provided.

The required arguments for the healthbot tsdb command are:

  • backup–perfom a backup operation

  • restore–perform a restore operation

  • --path PATH–create the backup file or restore the database(s) from the container at PATH where PATH is HB_EXTRA_MOUNT1.

Optional Arguments

Example – Backup the TSDB and Store it in HB_EXTRA_MOUNT3

Example – Restore the TSDB from HB_EXTRA_MOUNT2

Release History Table
Release
Description
Starting with HealthBot Release 3.2.0, you can backup and restore the TSDB separately from other configuration elements