Difference between revisions of "CLI - zmbackup Network Edition Only"

(Adding category)
m (wording per bug 28721 - now matches help & NE guide)
Line 55: Line 55:
 
<font size="3" color="#000000" face=""Times New Roman""> ''' -del ''' </font>
 
<font size="3" color="#000000" face=""Times New Roman""> ''' -del ''' </font>
 
| valign="top" |
 
| valign="top" |
<font size="3" color="#000000" face="Arial"> < <font size="3" color="#000000" face=""Times New Roman""> '''label|date''' </font>> Deletes the backup session on or prior to the specified label/date. </font>
+
<font size="3" color="#000000" face="Arial"> < <font size="3" color="#000000" face=""Times New Roman""> '''label|date''' </font>> Deletes the backups including and prior to the specified label/date. </font>
 
|-
 
|-
 
| valign="top" |
 
| valign="top" |

Revision as of 14:50, 19 June 2008

zmbackup

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

Syntax

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

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

Description

Long Name

Short Name

Description

--fullBackup

-f

Starts a full backup.

-- incrementalBackup

-i

Starts an incremental backup.

--account

-a

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

--delete

-del

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

Common Options

--fullBackup

-f

Starts full backup.

--incrementalBackup

-i

Starts incremental backup.

--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> Specifics the target backup location. The default is <zimbra_home>/backup.

--zip

-z

Zips email blobs in backup.

--help

-h

Displays the usage options for this command.

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

Perform incremental backup of user1’s mailbox on server1.
zmbackup -i -s server1 -a user1@domain.com
Jump to: navigation, search