This command provides the ability to backup your appliance based on a set of profiles listed below. When backing up your appliance, you can choose the following profiles (options):
config – Performs a backup of the appliance configuration
fedb – Performs a backup of the fedb database
config+fedb – Performs a backup of the appliance configuration and the fedb database
full – Performs a full back up of the appliance software
You can choose to backup your appliance to the following locations:
local – On the appliance's local drive
usb – On a USB device attached to your local machine
url – To a remote location using the secure copy protocol (SCP).
Note
To backup the appliance to a remote location, the remote location must be on the same subnet or otherwise directly accessible from the appliance.
The file save location must have sufficient space to save the back up file. You cannot proceed with the backup operation if there is not enough space at the file save location.
Starting with Network Security release 8.0.0, you can use the force option to back up your system even if you exceed the allotted memory for backups. However, using this feature can cause system performance degradation. Trellix does not recommend using this option only when needed and not as a daily practice.
Syntax
backup profile <profileName> to <location> [force] [no-encryption] [prefix <prefixText>] [progress {track | notrack}]
Parameters
profileName
The profile used to back up the appliance data: The following profiles are available:
config – Backs up the configuration database, the appliance database and appliance-specific data.
Note
This profile is not available on Central Management System appliances.
fedb – Performs a backup of the fedb database.
config+fedb – Backs up the configuration database, the FireEye appliance database, and appliance-specific data.
full – Backs up the configuration database, FireEye appliance database, and detected data (malware, alerts, reports, and so on).
Note
This profile is not available on Central Management System appliances.
location
Specifies the destination of the generated backup file.
local – Saves the backup file to the local destination on your appliance.
URL <destinationUrl> – Saves the backup file to a remote location specified by <destinationUrl> using the following format:
scp://<username>[<password>]<hostname>/<directory.
where <username> and <password> are remote server Administrator credentials, <hostname> is the remote server IP address, and <directory> is the directory in which the backup file is saved.
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.
usb – Saves the backup file to the USB drive location on your local machine.
Options
The following options can be included with the backup command. These options can be included individually or combined in one command. For more information, see the examples below.
force
Forces the back-up when the appliance will exceed the available backup memory.
no-encryption
Disables encryption. Each backup file is signed by default using the public and private key pairs.
Note
Encryption delays the backup operation. Backups are encrypted only using static keys.
prefix <prefixText>
Adds a prefix to the backup file name.
progress {notrack | track}
Allows you to override the default CLI configuration and display the progress of the backup operation:
no-track – Disables progress tracking for the backup operation.
track – Enables progress tracking for the backup operation. By default, progress tracking is enabled.
You can cancel progress tracking by using Ctrl+C. The backup operation still happens in the background. Use the show backup status command to find the status of the backup operation.
Example
The following example backs up the system configuration database, detected data, and artifacts to a local destination on the appliance:
hostname (config) # backup profile full to local
When the backup command is issued, you should see the following output:
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% [#################################################################]
This example backs up the system configuration database to a remote server at the URL: admin:admin@remotehost/tmp while adding the prefix remote to the file name.
hostname (config) # backup profile config to scp://admin:admin@remotehost/tmp prefix remote
This example backs up the system configuration database to a local server. During the backup, encryption has been disabled and progress tracking has been enabled.
hostname (config) # backup profile config to local no-encryption progress track
User role
admin
Command mode
config
Supported appliances
Malware Analysis: Release 7.7
Central Management System: Release 7.5
Email Security — Server: Release 7.6
File Protect: Release 7.7
Endpoint Security (HX): Release 2.5
Network Security: Release 7.5