db-backup — back up the Control Center database
The db-backup command backs up the Brightmail databases, such as policies configuration settings, report data, log data, and incidents. You can store backups on the appliance or on a remote server. Only run this command on the appliance that contains the Control Center. This command does not function on a Scanner-only appliance. Only one instance of db-backup can run at a time.
By default, backup files are compressed before they are written to disk to minimize the size of backup files. The db-backup command calculates the amount of disk space the backup file requires. The command does not run unless at least twice this amount is available on the
Use db-restore or the Control Center restore feature to restore a backup on the appliance or a backup on a remote computer. If you specify --file path for a backup to the appliance, you can only restore the backup using the db-restore command, not the Control Center restore feature.
You can also create backups using the Control Center. In the Control Center, click Administration > Hosts > Version > Backup.
The number of backups to store on the appliance. If you have more backups stored than number, then older backups are deleted. Each unique combination of type and schedule is retained separately. If you do not specify --backup number, the default is 5 for each type and schedule combination. See examples 4 and 6.
The name and, optionally, location to save the backup. Use the --file option to specify an alternate file name for the backup file or to save the backup file to a remote computer. If you do not specify --file path, the backup is saved to the appliance as db-backup.<product version>.brightmail.Mon-Day-Year-Hour-Min.full.manual.tar.bz2.
You can save the backup to a remote computer using either FTP (file transfer protocol) or SCP (secure copy protocol). If the path ends with / the backup is saved in that directory using the default file name. If the path ends with a file name the backup is saved with that name in the specified path. When you save the backup to a remote computer, db-backup temporarily stores the backup file on the appliance, checks the file for data integrity, copies the file to the remote computer, and checks to ensure that the file was successfully copied.
Use one of the following two path formats to save the backup to a remote server:
Use the following format:
ftp://'user':'password'@host[:port]/path. If special characters are included in the password, you must enclose the password in single quotes ('). If the special characters in a password include a single quote, you can use the double quote instead ("). Passwords containing single and double quotes are not valid. If no user name and password are specified, an anonymous login is used.
Use the following format:
scp://'user'@host/path. You must specify a user name. The db-backup command prompts you for the password.
Use the gzip compression algorithm instead of the default bzip2 compression algorithm. The gzip algorithm performs less efficient compression than bzip2.
List existing backups on the appliance.
Display this message.
Includes content incident messages in a configuration backup. Valid only when used with --type config.
Includes log data in a configuration backup. Valid only when used with --type config.
Do not compress the backup file. Use this option if you want to visually scan the file contents.
Purge backups. Use the --purge option to delete old backup files that match the parameters that you specify. To delete all but the number most recent backups of a type and schedule combination, specify --purge --backup number along with the type and schedule. Specify --purge --backup 0 to delete all backups of a type and schedule combination. To delete a specific file, specify --file file along with --purge. See examples 5 and 6.
Includes report data in a configuration backup. Valid only when used with --type config.
The schedule name to include in the backup file name. If you specify a schedule name, db-backup does not create automatic backups at that interval. The schedule that you specify only names the backup file with that name. The schedule names differentiate backups. See --backup and --purge for more information. Use the backup feature in the Control Center to create automatic scheduled backups. The following schedules are available:
The type of backup to create. Each backup type has two aliases that are alternate short versions of the backup type. See example 4. The following types are available:
Save a full backup on the appliance with the default schedule of manual and the default type of full. The newest five backups with a schedule of manual and type of full are kept (including the backup just created) and the rest of the backups matching that combination are deleted.
Save a full backup on a remote server with SCP. The database backup file in the format
db-backup.<product version>.brightmail.date-time.full.manual.tar.bz2 is copied to 192.168.2.42 in the /tmp directory through SCP. Log on to the SCP server with the support user account. The db-backup command prompts for the password for the support user account.
db-backup --file scp://firstname.lastname@example.org/tmp/
Save a full backup on a remote server with FTP. The database backup file
db-backup.<product version>.brightmail.date-time.full.manual.tar.bz2 is copied to host.symantecexample.org in the /user/jmuir directory. Log on to the FTP server with the jmuir user account and secret password.
db-backup -f ftp://jmuir:email@example.com/user/jmuir/
Backup configuration and content filtering incident data to the appliance and include the word weekly in the backup file name. In addition to the newly created backup, keep one additional existing backup with config-incidents and weekly in the file name.
db-backup --backup 2 --schedule weekly --type ci
Delete a single backup file.
db-backup --purge --file db-backup.10.0.0-1.brightmail.Feb-25-12-19-26.config-incidents.weekly.tar.bz2
Delete all but the one most recent backup file of type config-incidents and schedule manual.
db-backup --purge --backup 1 --type config-incidents --schedule manual
Subscribing will provide email updates when this Article is updated. Login is required to Subscribe
Thanks for your feedback. Let us know if you have additional comments below. (requires login)
This will clear the history and restart the chat.