Zimbra NG Modules/Zimbra NG Backup/ExternalBackup

Zimbra NG Backup - External Backup

Zimbra NG Backup - External Backup

What is the External Backup?

The External Backup is one of the Bakcup Modes of Zimbra NG Backup.

It creates a snapshot of the mail system, ready to be used for a migration. Exported data is deduplicated and compressed to optimize disk utilization, transfer times and I/O rates.

How does it work?

The Zimbra NG Backup engine scans through all the data in the Zimbra Datastore, saving all the items (deduplicated and compressed) on a folder of your choice.

Before you start

If you are working on a Multistore environment make sure to have read and understood the Multistore informations page before starting an External Backup.

Folder Permissions

The destination folder must be readable and writable by the zimbra user.

In order to create a valid export directory you can run the following commands:

mkdir /opt/zimbra/backup/yourdestfolder

chown -R zimbra:zimbra /opt/zimbra/backup/yourdestfolder

Preparing the migration

In order to minimize the risk of errors, please perform the following mainteinance procedures before migrating:

  • Doublecheck Zimbra permissions with the following command (must be ran as root): /opt/zimbra/libexec/zmfixperms --verbose --extended
  • Reindex all mailboxes.
  • Check the BLOB consistency with the zmblobchk utility (see Here for more details)

Running an External Backup

Via the Zimbra NG Modules Administration Zimlet

  • Click the Backup tab (be sure to have a valid License).
  • Click on the "Export Backup" button under "Import/Export" to open the Export Backup wizard.
  • Enter the Destination Path in the textbox and press Next. Zimbra NG Modules will check if the destination folder is empty and whether the 'zimbra' user has R/W permissions or not.
  • Select the domains you want to export and press Next.
  • Verify all your choices in the Operation Summary window. You can also add additional email addresses to be notified when the Restore operation is finished. Pleas notice that the Admin account and the User who started the Restore procedure are notified by default.

Via the Zimbra NG Modules CLI

To start an External Backup via the Zimbra NG Modules CLI, the "doExport" command is available:

   zxsuite backup doExport {destination_path} [attr1 value1 [attr2 value2...]]


NAME                   TYPE                  DEFAULT
destination_path(M)    Path                  
domains(O)             Domain Name[,..]      all
notifications(O)       Email Address[,..]    

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite backup doexport /opt/zimbra/backup/ domains example.com notifications john@example.com
Exports a backup of example.com to /opt/zimbra/backup/ and notifies john@example.com

Scheduling Script

The Zimbra NG Modules Suite CLI can be used to schedule External Backup operation. This comes very handy when you need to keep a daily/weekly/monthly backup for corporate or legal reasons.

Zimbra NG Modules


Latest Version: 8.8

Zimbra NG Modules Resources

Here you can find useful resources for your Zimbra NG Modules

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search