CLI zmschedulebackup Network Edition only: Difference between revisions

(→‎Related Articles: Adding article, rewording existing content)
No edit summary
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
For the most recent information on this CLI, including syntax and description, see [http://www.zimbra.com/docs/ne/latest/administration_guide/A_app-command-line.20.1.html ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities].
{{BC|Certified}}
__FORCETOC__
<div class="col-md-12 ibox-content">
=CLI zmschedulebackup Network Edition only=
{{KB|{{ZC}}|{{ZCS 8.6}}|{{ZCS 8.5}}|{{ZCS 8.0}}|}}
{{WIP}}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=
==zmschedulebackup==
*zmschedulebackup now supports -u for uncompressed zip blob storage.
This command is used to schedule backups and add the command to your cron table. Since Zimbra Collaboration 6.0 '''zmschedulebackup''' 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:
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 28: Line 29:
===Description===
===Description===
{|style="width:100%" border="1" cellpadding="5" cellspacing="0"
{|style="width:100%" border="1" cellpadding="5" cellspacing="0"
! align="left" bgcolor="tan" |Name
! style="color:white;" align="left" bgcolor="#0087c3" |Name
! align="left" bgcolor="tan" |Command Name
! style="color:white;" align="left" bgcolor="#0087c3" |Command Name
! align="left" bgcolor="tan"|Description
! style="color:white;" align="left" bgcolor="#0087c3"|Description
|-
| help
| style="text-align: center;" | -h
| Displays the usage options for this command.
|-
| query
| style="text-align: center;" | -q
| Default command. Displays the existing Zimbra backup schedule.
|-
| save
| style="text-align: center;" | -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.
|-
|-
|style="background=white" |help
| flush
|<nowiki>-h</nowiki>
| style="text-align: center;" | -F
|Displays the usage options for this command.
| Removes the current schedule and cancels all scheduled backups.
|-
|-
|style="background=white" |query
| append
|<nowiki>-q</nowiki>
| style="text-align: center;" | -A
|Default command.  Displays the existing Zimbra backup schedule.
| Adds an additional specified backup to the current schedule.
|-
|-
|style="background=white" |save
| replace
|<nowiki>-s</nowiki>
| style="text-align: center;" | -R
|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.
| Replaces the current schedule with the specified schedule.
|-
|-
|style="background=white" |flush
| default
|<nowiki>-F</nowiki>
| style="text-align: center;" | -D
|Removes the current schedule and cancels all scheduled backups.
| Replaces the current schedule with the default schedule.
|-
|-
|style="background=white" |append
| colspan="3" | Options that will be passed to zmbackup
|<nowiki>-A</nowiki>
|Adds an additional specified backup to the current schedule
|-
|-
|style="background=white" |replace
| no compression
|<nowiki>-R</nowiki>
| style="text-align: center;" | -n
|Replaces the current schedule with the specified schedule.
| Backs up blobs as individual files rather than in zip files
|-
|-
|style="background=white" |default
| compress
|<nowiki>-D</nowiki>
| style="text-align: center;" | -z
|Replaces the current schedule with the default schedule.
| Backs up blobs in compressed zip files. Ignored if --zipStore is specified.
|-
|-
|style="background=white" |compress
| --zipStore
|<nowiki>-z</nowiki>
|  
|Compress email blobs with zip
| Backs up blobs in zip file without compression.
|-
|-
|style="background=white" |target
| target
|<nowiki>-t</nowiki>
| style="text-align: center;" | -t
|Can be used only to designate a full back target location. The default is /opt/zimbra/backup.
| 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.
 
|-
'''''Note:''' You cannot designate a target for incremental backups. If a target (<nowiki>-</nowiki>t) location is added for incremental scheduled backups, it is ignored.''
| account
| style="text-align: center;" | -a
| Account specific. The default is all accounts.
|-
| --mail-report
|
| Send an email report to the admin user.
|-
| --server
|
| server - Mail server hostname. Default is localhost.
|-
| --sync
|
| Runs full backup synchronously.
|-
| --excludeBlobs
|
| Exclude blobs from full backup. If unspecified, server config is used.
|-
| --includeBlobs
|
| Include blobs in full backup. If unspecified, the server config is used.
|-
| --excludeHsmBlobs
|
| Exclude blobs on HSM volumes from full backup. If unspecified, the server config is used.
|-
| --includeHsmBlobs
|
| Include blobs on HSM volumes in full backup. If unspecified, the server config is used.
|-
| --excludeSearchIndex
|
| Exclude search index form full backup. If unspecified, the server config is used.
|-
| --includeSearchIndex
|
| Include search index in full backup. If unspecified, the server config is used.
|-
| Cron schedule
|
| backup-type: <i | f | d arg>
|-
|-
|style="background=white" |account
|  
|<nowiki>-a</nowiki>
|  
|Account specific.  The default is all accounts.
|  
|-
|-
|style="background=white" |Incremental Backup
| incremental backup
|<nowiki>i</nowiki>
| style="text-align: center;" | i
|<nowiki><time specifier></nowiki> Incremental backup. Incremental backup is not used with the auto-grouped backup mode.
| <time specifier> Incremental backup. Incremental backup is not used with the auto-grouped backup mode.
|-
|-
|style="background=white" |Full Backup
| full backup
|<nowiki>f</nowiki>
| style="text-align: center;" | f
|Full backup.
| Full backup
|-
|-
|style="background=white" |Delete
| delete
|<nowiki>d <arg></nowiki>
| style="text-align: center;" | d <arg>
|Delete backups.
| Delete backups. <arg> is n(d|m|y)
|}
|}


===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
<pre>zmschedulebackup -q
Current Schedule:


zmschedulebackup -q
        f 0 1 * * 6 -a all --mail-report
        i 0 1 * * 0-5 --mail-report
        d 1m 0 0 * * * --mail-report</pre>


*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.
 
<pre>zmschedulebackup -s
zmschedulebackup -s
-a all --mail-report f "0 1 * * 6"
 
--mail-report i "0 1 * * 0-5"
=ZCS 5.0=
--mail-report d 1m "0 0 * * *"</pre>
*http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.10.html#1268053
 
=ZCS 4.5=
*http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.5.html#1173386


=Related Articles=
=Related Articles=
Line 125: Line 172:
*[[5.0.x_Network_Edition_Backup_and_Restore]]
*[[5.0.x_Network_Edition_Backup_and_Restore]]


{{Article Footer|ZCS 6.0.x|5/2/2006}}
 
{{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]]
[[Category:ZCS 6.0]]
[[Category:ZCS 5.0]]
[[Category:ZCS 4.5]]

Latest revision as of 16:12, 11 July 2015

CLI zmschedulebackup Network Edition only

   KB 1483        Last updated on 2015-07-11  




0.00
(0 votes)

For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities.

zmschedulebackup

This command is used to schedule backups and add the command to your cron table. Since Zimbra Collaboration 6.0 zmschedulebackup supports -u for uncompressed zip blob storage.

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.
Options that will be passed to zmbackup
no compression -n Backs up blobs as individual files rather than in zip files
compress -z Backs up blobs in compressed zip files. Ignored if --zipStore is specified.
--zipStore Backs up blobs in zip file without compression.
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.
--mail-report Send an email report to the admin user.
--server server - Mail server hostname. Default is localhost.
--sync Runs full backup synchronously.
--excludeBlobs Exclude blobs from full backup. If unspecified, server config is used.
--includeBlobs Include blobs in full backup. If unspecified, the server config is used.
--excludeHsmBlobs Exclude blobs on HSM volumes from full backup. If unspecified, the server config is used.
--includeHsmBlobs Include blobs on HSM volumes in full backup. If unspecified, the server config is used.
--excludeSearchIndex Exclude search index form full backup. If unspecified, the server config is used.
--includeSearchIndex Include search index in full backup. If unspecified, the server config is used.
Cron schedule backup-type:
incremental backup i
full backup f Full backup
delete d <arg> m|y)

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
Current Schedule:

        f 0 1 * * 6 -a all --mail-report
        i 0 1 * * 0-5 --mail-report
        d 1m 0 0 * * * --mail-report
  • 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
 -a all --mail-report f "0 1 * * 6"
 --mail-report i "0 1 * * 0-5"
 --mail-report d 1m "0 0 * * *"

Related Articles


Verified Against: Zimbra Collaboration 8.6, 8.5, 8.0.x Date Created: 5/2/2006
Article ID: https://wiki.zimbra.com/index.php?title=CLI_zmschedulebackup_Network_Edition_only Date Modified: 2015-07-11



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