CLI zmschedulebackup Network Edition only

Revision as of 20:15, 14 April 2010 by Cfremon (talk | contribs) (Adding Article Infobox)

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

  • zmschedulebackup now supports -u for uncompressed zip blob storage.


This command is used to schedule backups and add the command to your cron table. The default schedule is as follows:

  • Full backup, every Saturday at 1:00 a.m. (0 1 * * 6)
  • Incremental backup, Sunday through Friday at 1:00 a.m. (0 1 * * 0-5)

Each crontab entry is a single line composed of five fields separated by a blank space. Specify the fields as follows:

  • minute — 0 through 59
  • hour — 0 through 23
  • day of month — 1 through 31
  • month — 1 through 12
  • day of week — 0 through 7 (0 or 7 is Sunday, or use names)

Type an asterisk (*) in the fields you are not using.

This command automatically writes the schedule to the crontab.


zmschedulebackup {-q|-s|-A|-R|-F|-D}[f|i|d|] [“schedule”]


Name Command Name Description
help -h Displays the usage options for this command.
query -q Default command. Displays the existing Zimbra backup schedule.
save -s Save the schedule. Allows you to save the schedule command to a text file so that you can quickly regenerate the backup schedule when the system is restored.
flush -F Removes the current schedule and cancels all scheduled backups.
append -A Adds an additional specified backup to the current schedule
replace -R Replaces the current schedule with the specified schedule.
default -D Replaces the current schedule with the default schedule.
compress -z Compress email blobs with zip
target -t Can be used only to designate a full back target location. The default is /opt/zimbra/backup.

Note: You cannot designate a target for incremental backups. If a target (-t) location is added for incremental scheduled backups, it is ignored.

account -a Account specific. The default is all accounts.
Incremental Backup i <time specifier> Incremental backup. Incremental backup is not used with the auto-grouped backup mode.
Full Backup f Full backup.
Delete d <arg> Delete backups.


  • To schedule the default full and incremental backup
zmschedulebackup -D
  • To replace the existing schedule with a new schedule
zmschedulebackup -R f [“schedule”]
  • To add an additional full backup to the existing schedule
zmschedulebackup -A f [“schedule”]
  • To add an additional incremental backup to the existing schedule
zmschedulebackup -A i [“schedule”]
  • To display the existing schedules
zmschedulebackup -q
  • To display the schedules on one line as a command, so that they can be copied to a text file and saved to be used if the application needs to be restored.
zmschedulebackup -s

ZCS 5.0

ZCS 4.5

Related Articles

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

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