CLI - zmbackup Network Edition Only

Revision as of 08:10, 8 August 2008 by Pcosta (talk | contribs)


(Network Edition only)

This tool performs full backups and incremental backups for a designated mail host. You can either specify specific accounts, or, if no accounts are specified, all accounts are included.

This utility has short option names and full names. The short option is preceded by a single dash, the full option is proceeded by a double dash. For example, -fb is the same as --fullBackup.


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

zmbackup {-f | -i | del} -acct (account) [options]


Long Name

Short Name




Starts a full backup.

-- incrementalBackup


Starts an incremental backup.



Specifies the account email addresses. Separate accounts with a blank space. Enter all to backup all accounts. Required.



< label|date > Deletes the backups including and prior to the specified label/date.

Common Options



Starts full backup.



Starts incremental backup.



<arg> Mail server host name. For format, use either the plain host name or the name. The default is the localhost name.



Runs full backup synchronously.



<arg> Specifics the target backup location. The default is <zimbra_home>/backup.



Zips email blobs in backup.



Displays the usage options for this command.


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


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 -s server1 -a

Perform incremental backup of user1’s mailbox on server1.

zmbackup -i -s server1 -a

See also

  • zmschedulebackup - This command is used to schedule backups and add the command to your cron table.
Jump to: navigation, search