CLI zmschedulebackup Network Edition only: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{Archive}}{{WIP}}{{Article Infobox|{{admin}}|{{ZCS | {{Archive}}{{WIP}}{{Article Infobox|{{admin}}|{{ZCS 8.6}}|{{ZCS 8.5}}|{{ZCS 8.0}}}}For the most recent information on this CLI, including syntax and description, see [https://www.zimbra.com/docs/ne/latest/administration_guide/wwhelp/wwhimpl/js/html/wwhelp.htm#href=860_admin_ne.Appendix_A%E2%80%82Command_Line_Utilities.html ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities]. | ||
=ZCS 6.0.x= | =ZCS 6.0.x= | ||
Line 7: | Line 7: | ||
This command is used to schedule backups and add the command to your cron table. | This command is used to schedule backups and add the command to your cron table. | ||
The default schedule is as follows: | The default schedule is as follows: | ||
*Full backup, every Saturday at 1:00 a.m. (0 1 * * 6) | *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) | *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: | 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 | *minute — 0 through 59 | ||
*hour — 0 through 23 | *hour — 0 through 23 | ||
Line 91: | Line 89: | ||
===Examples=== | ===Examples=== | ||
*To schedule the default full and incremental backup | *To schedule the default full and incremental backup | ||
zmschedulebackup -D | zmschedulebackup -D | ||
*To replace the existing schedule with a new schedule | *To replace the existing schedule with a new schedule | ||
zmschedulebackup -R f [“schedule”] | zmschedulebackup -R f [“schedule”] | ||
*To add an additional full backup to the existing schedule | *To add an additional full backup to the existing schedule | ||
zmschedulebackup -A f [“schedule”] | zmschedulebackup -A f [“schedule”] | ||
*To add an additional incremental backup to the existing schedule | *To add an additional incremental backup to the existing schedule | ||
zmschedulebackup -A i [“schedule”] | zmschedulebackup -A i [“schedule”] | ||
*To display the existing schedules | *To display the existing schedules | ||
zmschedulebackup -q | 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. | *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 | zmschedulebackup -s | ||
=Related Articles= | =Related Articles= | ||
Line 126: | Line 112: | ||
{{Article Footer| | {{Article Footer|Zimbra Collaboration 8.6, 8.5, 8.0.x|5/2/2006}} | ||
[[Category:Command Line Interface]] | [[Category:Command Line Interface]] | ||
[[Category:Backup and Restore]] | [[Category:Backup and Restore]] | ||
Revision as of 13:23, 23 June 2015
Article Information |
---|
This article applies to the following ZCS versions. |
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.
zmschedulebackup
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.
Syntax
zmschedulebackup {-q|-s|-A|-R|-F|-D}[f|i|d|] [“schedule”]
Description
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. |
Examples
- 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
Related Articles
- Zimbra Backup/Restore blog post -- contains more information on planning backup schedules and using the zmschedulebackup command.
- 5.0.x_Network_Edition_Backup_and_Restore