Zx Backup: External Backup

From ZeXtras Suite Wiki

Jump to: navigation, search
Language: English  • español • português
Warning.png Warning!

This wiki is outdated and not maintained anymore, please refer to the new Zextras Documentation Hub at https://docs.zextras.com

ZxBackup logo box.png
This documentation is outdated.
Please refer to https://docs.zextras.com

What is the External Backup?

The External Backup is one of the Bakcup Modes of ZxBackup.

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 ZxBackup engine scans through all the data in the Zimbra Datastore, saving all the items (deduplicated and compressed) on an empty 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 ZeXtras Administration Zimlet

  • Click the Backup tab (be sure to have a valid License).

Zimlet Panel b.png

  • Click on the "Export Backup" button under "Import/Export" to open the Export Backup wizard.

ExB 01 b.png

  • Enter the Destination Path in the textbox and press Next. ZeXtras will check if the destination folder is empty and whether the 'zimbra' user has R/W permissions or not.

ExB 02 b.png

  • Select the domains you want to export and press Next.

ExB 03 b.png

  • 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.

ExB 04 b.png

Via the ZeXtras CLI

To start an External Backup via the ZeXtras 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

Personal tools