Backup and Restore the Messaging Gateway
search cancel

Backup and Restore the Messaging Gateway

book

Article ID: 180646

calendar_today

Updated On: 04-21-2025

Products

Messaging Gateway

Issue/Introduction

Backing up the configuration of SMG prior to a version update.

Resolution

Backup


Command Line


Store backup locally on the system


To store the backup on the Control Center system:

    • db-backup
      NOTE: Backup will be available to download in the Control Center (Administration -> Version -> Restore/Download)


Store on a remote server

SCP
    • db-backup -f scp://'user'@hostname/path_to_store_file/
      • user is replaced by the username on the SCP server
      • You will be prompted for the scp server password
      • hostname is replaced by the IP of the SCP server, and path_to_store_file is replaced by a path pre-existing on the SCP server.
      • The path should always end with a '/' character as shown above

FTP
    • db-backup -f ftp://'user':password@hostname/path_to_store_file/
      • user is replaced by the username on the FTP server
      • password is replaced by the FTP server password
      • hostname is replaced by the IP of the FTP server, and path_to_store_file is replaced by a path pre-existing on the FTP server.
      • The path should always end with a "/" (without the quotes).
      • "db-backup --help" will give you the options for the db-backup command


Control Center Web Interface


Open the Control Center and go to Administration > Version

Store backup locally on the system

    1. Click Backup Now.
    2. Select your backup type:
      • Full Backup
      • Custom backup
      • Policies only
      • Configuration (includes policies)
        • Include content incident messages
        • Include report data
        • Include log data
    3. Select "Store backup on server".
    4. Click "Backup now".


Store on a remote server

    1. Click Backup Now.
    2. Select your backup type:
      • Full Backup
      • Custom backup
      • Policies only
      • Configuration (includes policies)
        • Include content incident messages
        • Include report data
        • Include log data
    3. Select Store backup on remote location using FTP or SCP.
    4. Add IP address and port of FTP or SCP server.
    5. Add a path (NOTE: you must have something in this box. If you want to specify the root of the FTP server then put "/" without the quotes in this box. Any backup path must end with a "/" without the quotes)
    6. Optionally add a username and password. (required with SCP)
    7. Click "Backup now".

Restore:

(NOTE: Backups can only be restored on the same version and build they were created on)

Command Line:


To restore a locally stored backup

      • Run db-restore --list
      • Run db-restore [file_name]
        • Example: db-restore db-backup.10.7.3-5.brightmail.May-22-20-08-42.full.manual.tar.bz2


To restore a backup using SCP

      • db-restore scp://user@hostname/path_to_file/filename
        • user is replaced with the scp server username
        • hostname is replaced with the server IP
        • path_to_file is the path where the backup is stored and filename is the file name of the backup file


Control Center Web Interface:


Open the Control Center and go to (Administration -> Version -> Restore/Download)


To Restore/Download backup from server

      • Select "Restore/Download backup from server" and select the backup.
      • Click "Restore".


To Restore backup from a remote location

      • Select "Restore backup from a remote location" and enter the FTP or SCP server information. (NOTE: File name requires an entry if there is no path enter "/" without the quotes)
      • Click Restore.
      • (NOTE: Files uploaded through the control center web interface can be a maximum size of 2GB. Larger files must be restored using the command line interface)


To Upload a backup file from your local computer

    • Select "Upload a backup file from your local computer" and browse the local computer for the backup file.
    • Click Restore.
    • (NOTE: Files uploaded through the control center web interface can be a maximum size of 2GB. Larger files must be restored using the command line interface)

Additional Information