CLI - zmbackup Network Edition Only

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Admin Article

Article Information

This article applies to the following ZCS versions.

ZCS 6.0 Article ZCS 6.0 ZCS 5.0 Article ZCS 5.0 ZCS 4.5 Article ZCS 4.5

For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities.

ZCS 6.0.x


This tool performs full backups and incremental backups for a designated mail host. This utility has short option names and full names. The short option is preceded by a single dash, while the full option is preceded by a double dash. For example, -f is the same as --fullBackup.


One of -f, -i, or -del must be specified.

zmbackup {-f | -i | del} {-a <arg>} [options]


Long Name Short Name Description
--account -a <arg> Account email addresses separated by white space or all for all accounts. This option is not specified for auto-grouped backups since the system knows which accounts to backup every night.
--debug -d Display diagnostics for debugging purposes.
--delete -del <arg> Deletes the backups including and prior to the specified label, date (YYYY/MM/DD[-hh:mm:ss]) or period (nn(d|m|y]).
--fullBackup -f Starts a full backup. In auto-grouped backup mode, this option also copies the redologs since the last backup (which is the main function of an incremental backup).
--help -h Displays the usage options for this command.
--incrementalBackup -i Starts an incremental backup. This option is not available in the auto-grouped backup mode.
--server -s <arg> Mail server host name. For format, use either the plain host name or the name. The default is the localhost name.
--sync -sync Runs full backup synchronously.
--target -t <arg> Specifies the target backup location. The default is <zimbra_home>/backup.
--zip -z Backs up blobs in compressed zip files. Ignored if --zipStore is specified.
--zipStore Backup up blobs in zip files without compression. (default)


In these examples, the server (-s) is The (-t) is not required if the target is the default directory, (zimbra_home/backup).

  • Perform a full backup of all mailboxes on server1
zmbackup -f -a all -s
  • Perform incremental backup of all mailboxes on server1 since last full backup
zmbackup -i -a all -s
  • Perform full backup of only user1’s mailbox on server1. Note that hostname does not need full domain if account is used.
zmbackup -f -a -s server1
  • Perform incremental backup of user1’s mailbox on server1
zmbackup -i -a -s server1 

ZCS 5.0.x

ZCS 4.5.x


Resulting backup sessions make use of hard links to previous backup sessions to save space on the filesystem. Take this into account when performing tape backups and when foreseeing disk usage, eg.:

[zimbra@gw1a ~]$ cd /opt/zimbra/backup/sessions
[zimbra@gw1a sessions]$ du -sh full-20080805.101920.991
75G     full-20080805.101920.991
[zimbra@gw1a sessions]$ du -sh *full*
75G     full-20080801.230004.637
2.5G    full-20080805.101920.991
[zimbra@gw1a sessions]$ du -shl *full*
75G     full-20080801.230004.637
75G     full-20080805.101920.991

Related Articles

  • zmschedulebackup - This command is used to schedule backups and add the command to your cron table.

Verified Against: ZCS 6.0.x Date Created: 5/2/2006
Article ID: Date Modified: 2010-05-11

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