Backing up the database using the CLI

Prev Next

Use the commands in this section to back up the  database.

To back up the database:
  1. Go to CLI configuration mode.

    hostname > enable
    hostname # configure terminal
  2. To back up a profile to a specified location:

    hostname (config) # backup profile <profile> to <backup location>  [prefix <prefix>]

    Parameters

    profile

    Specifies the type of profile for backup.

    • config: To set the profile for the configuration database.

    • fedb: To set the profile for the Malware Analysis appliance database.

    • config+fedb: To set the profile for both the configuration database and theMalware Analysis appliance database.

    • full: To set the profile for the configuration database, Malware Analysis appliance database, and detected data (malware, alerts, reports, and so on).

    backup location

    Specifies the location for the backup file.

    • local: To save the backup file to a local destination on the appliance.

      Important

      When the number of backup files on your appliance reaches the backup file limit set for your appliance, you need to delete old backups to continue performing local backups.

      The following command automatically deletes the oldest local backup file (when the backup files limit is crossed) and then backs up the appliance: backup profile <profile> to local auto-delete-old. For details, see CLI Command Reference.

      For details on specifying a limit to the number of backup files, see Limiting the number of backup files on your appliance .

    • usb: To save the backup file to a USB drive on your local machine.

    • url: To save the backup file on a remote server:

      where <url> specifies remote server admin credentials (<username> and <password>), the remote server (<hostname>), and the directory in which to save the backup file (<directory>) in the following format:

      scp://<username>[:<password>]@<hostname>/<directory>

      Note

      If you do not specify the remote host administrator password in the backup profile command (where the password would be visible as clear text), the CLI prompts for the password and obfuscates the keyboard input as you type it.

      A remote backup first creates a local backup and then transfers it to the remote server.

    prefix

    Specifies a custom prefix for the backup file name.

  3. (Optional) Monitor the progress of the backup operation.

    • To disable progress tracking for the backup operation:

      hostname (config) # backup profile <profile> to <backup location> progress no-track
    • To enable progress tracking for the backup operation:

      hostname (config) # backup profile <profile> to <backup location> progress track 

    By default, progress tracking is enabled.

  4. (Optional) Disable public and private key encryption for the backup operation:

    hostname (config) # backup profile <profile> to <backup location> no-encryption

    The following example backs up the appliance database to a local destination on the appliance without encryption:

    hostname (config) # backup profile fedb to local no-encryption

    Note

    Encryption is enabled by default. Encryption delays the backup operation. Backups are encrypted only using static keys.

Note

To cancel a backup that is in progress, enter the backup cancel command. When you cancel the backup operation that is in progress, the system finishes the current step before canceling the entire operation.

Examples

Note

The following examples are from a Intelligent Virtual Execution - Server appliance, but they are representative of AX appliances as well.

The following example backs up the configuration database, detected data, and artifacts to a local destination on the appliance:

hostname (config) # backup profile full to local
Step 1 of 5: Performing Sanity checks
100.0%  [##################################################################]
Step 2 of 5: Backing up config db
100.0%  [#################################################################]
Step 3 of 5: Backing up fedb
100.0%  [#################################################################]
Step 4 of 5: Backing up Artifacts
100.0%  [#################################################################]
Step 5 of 5: Generating Backup package
100.0%  [#################################################################]

The following example backs up the configuration database, detected data, and artifacts to a remote destination:

hostname (config) # backup profile full to scp://remoteAdmin3@vx-2/vx-2-bkp
Password (if required): ********
Step 1 of 4:  Performing Sanity checks
100.0%  [##################################################################]
Step 2 of 4:  Backing up config db
100.0%  [##################################################################]
Step 3 of 4:  Generating backup package
100.0%  [##################################################################]
Step 4 of 4:  Transferring backup to remote loc
100.0%  [##################################################################]