ZCS Administrator Guide 8.0

Network Edition

zmbackup

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.

Syntax

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

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

Description

 

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]).
--excludeBlobs		Exclude blobs from full backup. If unspecified, use server config
--excludeHsmBlobs		Exclude blobs on HSM volumes from full backup; if unspecified, use server config
--excludeSearchIndex		Exclude search index from full backup; if unspecified, use server config
--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.
--includeBlobs		Include blobs in full backup. If this is unspecified, the server config is used.
--includeHsmBlobs		Include blobs on HSM volumes in full backup. If this is unspecified, the server config is used.
--includeSearchIndex		Include search index in full backup. If this is unspecified, the server config is used.
--noZip		Backs up blobs as individual files rather than in zip files.

 

--server	-s	<arg> Mail server host name. For format, use either the plain host name or the server.domain.com 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 blobs in zip file without compression. (default)

Examples

In these examples, the server (-s) is server1.domain.com. 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 server1.domain.com

Perform incremental backup of all mailboxes on server1 since last full backup

zmbackup -i -a all -s server1.domain.com

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 user1@domain.com -s server1

Perform incremental backup of user1’s mailbox on server1

zmbackup -i -a user1@domain.com -s server1