Documentation | Support

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Forcepoint Appliances Command Line Interface > Maintenance and support > Backup and restore
Backup and restore
CLI Guide | Forcepoint Appliances | v8.4.x
It is a best practice to backup appliances regularly. Use "create backup schedule" to define an automated backup schedule.
Backup files can be stored locally—on the appliance, or saved to a filestore that you specify.
There are 2 types of backup:
*
A full backup saves all appliance settings, as well as configuration and policy information for all active modules. The best practice is to run a full backup on every appliance in your network on a regular basis.
*
A component backup (web or email) saves all configuration information for the selected module. This includes any client and policy data stored on the appliance.
 
* 
Note 
The web component backup does not include the proxy—Content Gateway. Content Gateway backups (snapshots) can be performed in Content Gateway manager. Snapshots must be performed manually; there is no scheduling facility.
Components that do not reside on the appliance (like Log Server and Forcepoint Security Manager) should be backed up at approximately the same time that you back up your appliance. When you restore the system, this allows you to restore from a time-synchronized set of backups on all machines.
Restoring from backup
When a backup is restored, all current settings for the appliance or module are erased. The appliance is always restarted after a restore.
Before performing a restore, stop all TRITON Architecture components running off the appliance.
Full appliance restores and module-specific restores require that these conditions are met:
*
The current appliance version must match the version associated with the backup file. Thus, a version 8.4.0 backup can be restored only on an appliance that is at version 8.4.0.
*
The module version must match the version associated with the backup file.
*
The current appliance mode—Forcepoint Web Security, Forcepoint Email Security, or Forcepoint URL Filtering — must match that of the backup file. For example, a backup from a Forcepoint Email Security appliance must be used to restore a Forcepoint Email Security appliance.
*
If the appliance is a web protection appliance, the current appliance policy source mode (full, user, filter) and policy source IP (or policy server IP) must match the policy source mode and IP addresses in effect when the backup file was created.
*
The hardware model of the current appliance must be the same as the model that was backed up. For example, a backup from a Forcepoint V10000 Appliance must be used to restore a Forcepoint V10000 Appliance.
*
The original appliance that was backed up cannot also be running elsewhere in the network. Restoring a full configuration re-creates the original appliance.
Before restarting the off-box components, ensure that the system time of all TRITON Architecture component hosts is synchronized. You can then restart the TRITON Architecture components located off the appliance.
 
* 
Warning 
If the restore process changed appliance IP addresses, you may need to reconfigure or reinstall off-box components to re-establish communication between on-box and off-box components.
 
Action and Syntax
Details
Display all available backups in a specified location.
show backup list
--location <local|filestore_alias>
Displays the file name, date, and description of each backup file found in the specified location.
*
local is the current appliance.
*
filestore_alias is the filestore alias of a remote storage location.
Example:
(view)# show backup list
--location local
Display the configured backup schedule.
show backup schedule
Includes the schedule frequency, the last scheduled backup, the next scheduled backup, and the backup location.
Create an appliance backup now.
create backup now
--location <local|filestore_alias>
[--desc <description>]
--type <full|email|web>
You can back up files onto the appliance (local) or onto a remote filestore. You can restore from either location.
The optional description of the backup is limited to 18 characters.
Example:
(config)# create backup now
--location local --desc full-2017-1-24 --type full
Restore the appliance configuration settings saved in the specified backup file.
restore backup
--location <local|filestore_alias>
[--file <file_name>]
For location, specify a filestore alias or "local" for a local file.
Optionally specify the name of the backup file to restore. If you do not specify a name, you can choose a file from a list.
Example:
(config)# restore backup
--location local --file mybackup.bak
Define a schedule for automatic backups.
create backup schedule
--location <local|filestore_alias>
--freq <daily|weekly|monthly>
--day <Mon|Tue|Wed|Thu|
Fri|Sat|Sun>
--date <integer>
--time <hh:mm>
--type <full|web|email>
Location: You can schedule a backup to the appliance ("local") or to a remote filestore.
Freq: You can schedule a backup to occur daily, weekly, or monthly.
Day: If the interval is weekly, also specify the day of the week: Mon, Tue, Wed, Thu, Fri, Sat, or Sun (case-sensitive).
Date: If the interval is monthly, also specify the day of the month (integer from 1-28).
Time: For all interval options, specify the time of day in 24-hour format (hh:mm). Do not specify seconds.
Example of a weekly backup:
(config)# create backup schedule
--location local --freq weekly day Mon time 01:30
Type: The type of backup being created (full appliance backup, email-only, or web-only).
Cancel all scheduled backups.
cancel backup schedule
 
Delete any or all backup files stored locally on the appliance.
delete backup
[--file <file_name|all>]
Optionally takes one of the following values:
*
name: the name of a specific file
*
all: every backup file on the appliance
If the option is not used, interactive mode will be used to select files to delete.
Examples with file option:
(config)# delete backup --file all
Successfully deleted backup file(s).
 
(config)# delete backup --file backupfile123.bak
Successfully deleted backup file(s).
Example without file option:
(config)# delete backup
Backup Selection:
1) backupfile123.bak:
Description:
Time : 2016-11-18_12:21
2) backupfile456.bak:
Description:
Time : 2016-11-18_12:20
Please make a selection (enter 'q' to quit): 1
Successfully deleted backup file(s).
 

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Forcepoint Appliances Command Line Interface > Maintenance and support > Backup and restore
Copyright 2017 Forcepoint. All rights reserved.