Restoring the database from a backup file

You can restore the backup from three locations:

From your local appliance.
From a remote server. Do not restore the current network settings while the appliance is performing a restore operation from a remote server.
From a USB device connected to your local machine.

Note
You can also restore a backup database belonging to a different appliance model that uses the same build. This feature is useful when you upgrade from one appliance model to another.

Usage guidelines

Follow these usage guidelines when you are restoring the database from a backup file:

The appliance will not be fully operational during the restore operation. For example, the alert detection process will stop during the restore operation.
You cannot cancel the restore operation while it is in process.
If the restore process fails, you can revert the appliance back to the factory-installed defaults. If you are restoring only the configuration database, the appliance will automatically revert back to the original configuration.
Only the config, config+fedb, and fedb backup profiles can be restored from a software upgrade. You cannot restore the backup from a software downgrade.
You cannot restore a backup from another product family.
You cannot restore a backup from a release earlier than Network Security 7.5.0.

Caution
An integrated Network Security does not support restoring a backup from a version that is different from the installed version. For example, you cannot restore a version 9.1.4 backup on a Network Security running version 9.1.5 or 10.0.0. The following error message is displayed: "Restore operation is not supported because of software mismatch". Restoring a backup over a slightly later version may succeed, but it is not supported.

Prerequisites

Admin access
Verify that you have a backup FEBKP file of the current database before you begin the restore operation.
Locate the previous backup you want to restore.
Verify the details for the appliance, backup profile, version, hostname, and date stamp. These details are validated while the restore operation is in process.

Restoring the database from a backup file using the web UI

Use the Backup and Restore page to restore the database from a backup file.

Note
This illustration is from an Email Security — Server appliance, but it is representative of NX appliances as well.

To restore the database from a backup file:

Click the Settings tab.
Click Appliance Backup & Restore on the sidebar.
Locate the backup FEBKP file you want to restore in the Backup Name (Profile) column.
You have the option to restore everything using a full profile or restore portions using one of the other profiles.
If you selected Remote Server, scroll down to enter the location of the remote backup file in the Remote URL or SCP box:
```
{scp|sftp}://<username>:<password>@<hostname>/<filePath>
```
where <username> and <password> are remote server Administrator credentials, <hostname> is the remote host, and <filepath> is the full path of the backup file.
Then select the profile you want to restore from the drop-down list.
(Optional) Clear the Exclude Network Settings checkbox to include the network settings from the backup file. By default, the network settings are not included in the restore operation.
Caution
Do not restore the current network settings while the appliance is performing a restore operation from a remote server.
Click Restore to restore the backup.
In the confirmation dialog box, click Yes.
Note
The appliance will not be fully operational during the restore operation. You cannot cancel the restore operation while it is in process.

You must reinstall the guest images and license keys separately.

Restoring the database from a backup file using the CLI

Use the commands in this section to restore the database from a backup file.

To restore the database from a backup file:

Go to CLI configuration mode.

hostname > enable
hostname # configure terminal

Locate the backup FEBKP file you want to restore.
- To display a list of the backup files on the USB drive:
```
hostname (config) # show backup available on-usb
```
- To display a list of the backup files:
```
hostname (config) # show backup available local
```
Specify a backup profile.
- To set the profile for the configuration database:
```
hostname (config) # restore profile config
```
- To set the profile for the appliance database:
```
hostname (config) # restore profile fedb
```
- To set the profile for both the configuration database and the appliance database:
```
hostname (config) # restore profile config+fedb
```
- To set the profile for the configuration database, appliance database, and detected data (malware, alerts, reports, and so on):
```
hostname (config) # restore profile full
```
Specify the location of the backup file.
- To restore the backup from the local destination on the NX appliance:
```
hostname (config) # restore profile <profile> from local 
```
- To restore the backup from a remote server:
```
hostname (config) # restore profile <profile> from <url>
```
  where <url> specifies remote server Administrator credentials (<username> and <password>), the remote server (<hostname>), and the full path of the backup file (<filepath>) in the following format:
```
{scp|sftp}://<username>[:<password>]@<hostname>/<filepath>
```
  Note
  If you do not specify the remote host administrator password in the restore 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.
- To restore the backup from a USB drive on your local machine:
```
hostname (config) # restore profile <profile> from usb
```

Enter the name of the backup file.

hostname (config) # restore profile <profile> from <backupLocation> backup <name>

(Optional) Restore the network settings from the relevant backup:
```
hostname (config) # restore profile <profile> from <backupLocation> backup <name> include-network-config
```
Caution
Do not restore the current network settings while the NX appliance is performing a restore operation from a remote server.
(Optional) Monitor the progress of the restore operation. Progress tracking is enabled by default.
- To disable progress tracking for the restore operation:
```
hostname (config) # restore profile <profile> from <backupLocation> backup <name> progress no-track
```
- To enable progress tracking for the restore operation:
```
hostname (config) # restore profile <profile> from <backupLocation> backup <name> progress track
```
  You can cancel progress tracking by using Ctrl+C. The restore operation still happens in the background. Use the show restore status command to find the status of the restore operation.

Example

The following example shows how to restore a configuration database backup from local on an appliance.

hostname (config) # restore profile config from local backup vx-Config-7.9.0-vx-2-20160802-239500.febkp
Password (if required): ********
Step 1 of 4:  Performing Sanity checks
 100.0%  [##################################################################]
Step 2 of 4:  Extracting backup package
 100.0%  [##################################################################]
Step 3 of 4:  Restoring config db
 100.0%  [##################################################################]
Step 4 of 4:  Restart system services
 100.0%  [##################################################################]

Note
This example is from a Intelligent Virtual Execution - Server appliance, but it is representative of NX appliances as well.