Difference between revisions of "CLI zmbackupquery Network Edition only"

 
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==<font size="4" color="#00007f" face="Arial"> ''' zmbackupquery ''' </font>==
+
{{BC|Certified}}
 +
__FORCETOC__
 +
<div class="col-md-12 ibox-content">
 +
=CLI zmbackupquery Network Edition only=
 +
{{KB|{{ZC}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}
 +
{{Archive}}{{WIP}}
 +
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].
  
(Network Edition only)
+
=ZCS 6.0.x=
 +
==zmbackupquery==
 +
The '''zmbackupquery''' command is used to find full backup sets. The command can be used to find a specific full backup set or full backup sets since a specific date, or all backup sets in the backup directory.
  
<font size="3" color="#000000" face="Arial">The  <font size="3" color="#000000" face=""Times New Roman""> '''zmbackupquery''' </font> command is used to find full backup sets. The command can be used to find a specific full backup set, full backup sets since a specific date, or all backup sets in the backup directory.</font>
+
To find out the best full backup to use as the basis for point-in-time restore of an account, run a command like this:
  
===<font size="3" color="#00007f" face="Arial"> ''' Syntax ''' </font>===
+
$ zmbackupquery -a <account email> --type full --to <restore-to time>
  
<font size="3" color="#000000" face=""Times New Roman""> '''  zmbackupquery <options>  ''' </font>
+
===Syntax===
 +
zmbackupquery [options]
  
===<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>===
+
===Description===
 
+
{|style="width:100%" border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="8"
+
! align="left" bgcolor="tan" |Long Name
|+
+
! align="left" bgcolor="tan" |Short Name
 +
! align="left" bgcolor="tan"|Description
 +
|-
 +
|style="background=white" |<nowiki>--account</nowiki>
 +
|<nowiki>-a</nowiki>
 +
|'''<arg>''' Account email addresses separated by white space or '''all''' for all accounts
 +
|-
 +
|<nowiki>--debug</nowiki>
 +
|<nowiki>-d</nowiki>
 +
|Display diagnostics for debugging purposes
 
|-
 
|-
| valign="middle" |
+
|<nowiki>--help</nowiki>
<font size="3" color="#00007f" face="Arial"> ''' Long Name ''' </font>
+
|<nowiki>-h</nowiki>
| valign="middle" |
+
|Shows the help for the usage options for this tool
<font size="3" color="#00007f" face="Arial"> ''' Short Name''' </font>
 
| valign="middle" |
 
<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--from</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  account <arg>  ''' </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<arg>''' List backups whose start date/time is at or after the date/time specified here.
<font size="3" color="#000000" face=""Times New Roman""> ''' - a ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Account email addresses separated by white space or <font size="3" color="#000000" face=""Times New Roman"">'''all '''</font>for all accounts.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--label</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --label <label> ''' </font>
+
|<nowiki>-lb</nowiki>
| valign="top" |
+
|'''<arg>''' The label of the full backup session to query. An example of a label is '''backup200507121559510'''.
<font size="3" color="#000000" face=""Times New Roman""> ''' -lb ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> The label of the full backup session to query. An example of a label is <font size="3" color="#000000" face=""Times New Roman"">'''backup200507121559510.'''</font></font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--server</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --list <date> ''' </font>
+
|<nowiki>-s</nowiki>
| valign="top" |
+
|'''<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.
<font size="3" color="#000000" face=""Times New Roman""> ''' -l ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> If a date is used, the query returns a list of full backup sets since the specified date. Enter date as <font size="3" color="#000000" face=""Times New Roman"">'''YYYY/'''</font><font size="3" color="#000000" face=""Times New Roman"">'''MM/DD hh:mm:ss'''</font>. The hours, minutes, and seconds are not required.</font>
 
 
|-
 
|-
| colspan="3" valign="top" |
+
|<nowiki>--target</nowiki>
<font size="3" color="#000000" face="Arial"> ''' Common Options''' </font>
+
|<nowiki>-t</nowiki>
 +
|'''<arg>''' Specifies the backup target location (The default is <zimbra_home>/backup.)
 
|-
 
|-
| valign="top" |
+
|<nowiki>--to</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --server  ''' </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<arg>''' List backups whose start date/time is at or before the date/time specified here.
<font size="3" color="#000000" face=""Times New Roman""> ''' -s  ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Mail server host name. For format, use either the plain host name or the server.domain.com name. The default is the localhost name.</font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--type</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --target  ''' </font>
+
|<nowiki></nowiki>
| valign="top" |
+
|'''<arg>''' Backup set type to query. “full” or “incremental”, both are queried if one is not specified.  
<font size="3" color="#000000" face=""Times New Roman""> '''  -t  ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Specifies the backup target location. The default is <zimbra_home>/backup. </font>
 
 
|-
 
|-
| valign="top" |
+
|<nowiki>--verbose</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --help  ''' </font>
+
|<nowiki>-v</nowiki>
| valign="top" |
+
|Returns detailed status information
<font size="3" color="#000000" face=""Times New Roman""> '''  -h  ''' </font>
 
| valign="top" |
 
<font size="3" color="#000000" face="Arial"> Displays the usage options for this command.</font>
 
 
|}
 
|}
 +
 +
===Date/Time Formats===
 +
Specify date/time in one of these formats:
 +
 +
2008/12/16 12:19:23
 +
2008/12/16 12:19:23 257
 +
2008/12/16 12:19:23.257
 +
2008/12/16-12:19:23-257
 +
2008/12/16-12:19:23
 +
20081216.121923.257
 +
20081216.121923
 +
20081216121923257
 +
20081216121923
 +
 +
Specify year, month, date, hour, minute, second, and optionally millisecond.
 +
 +
Month/date/hour/minute/second are 0-padded to 2 digits, millisecond to 3 digits.
 +
 +
Hour must be specified in 24-hour format, and time is in local time zone.
 +
 +
 +
=ZCS 5.0.x=
 +
*[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.12.html#1268223 ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmbackupquery]
 +
 +
=ZCS 4.5.x=
 +
*[http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.7.html#1173535 ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmbackupquery]
 +
 +
 +
{{Article Footer|Zimbra Collaboration 7.0, 6.0|5/2/2006}}
 +
 +
[[Category:Command Line Interface]]
 +
[[Category:ZCS 7.0]]
 +
[[Category:ZCS 6.0]]

Latest revision as of 15:54, 11 July 2015

CLI zmbackupquery Network Edition only

   KB 1485        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.

ZCS 6.0.x

zmbackupquery

The zmbackupquery command is used to find full backup sets. The command can be used to find a specific full backup set or full backup sets since a specific date, or all backup sets in the backup directory.

To find out the best full backup to use as the basis for point-in-time restore of an account, run a command like this:

$ zmbackupquery -a <account email> --type full --to <restore-to time>

Syntax

zmbackupquery [options]

Description

Long Name Short Name Description
--account -a <arg> Account email addresses separated by white space or all for all accounts
--debug -d Display diagnostics for debugging purposes
--help -h Shows the help for the usage options for this tool
--from <arg> List backups whose start date/time is at or after the date/time specified here.
--label -lb <arg> The label of the full backup session to query. An example of a label is backup200507121559510.
--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.
--target -t <arg> Specifies the backup target location (The default is <zimbra_home>/backup.)
--to <arg> List backups whose start date/time is at or before the date/time specified here.
--type <arg> Backup set type to query. “full” or “incremental”, both are queried if one is not specified.
--verbose -v Returns detailed status information

Date/Time Formats

Specify date/time in one of these formats:

2008/12/16 12:19:23
2008/12/16 12:19:23 257
2008/12/16 12:19:23.257
2008/12/16-12:19:23-257
2008/12/16-12:19:23
20081216.121923.257
20081216.121923
20081216121923257
20081216121923

Specify year, month, date, hour, minute, second, and optionally millisecond.

Month/date/hour/minute/second are 0-padded to 2 digits, millisecond to 3 digits.

Hour must be specified in 24-hour format, and time is in local time zone.


ZCS 5.0.x

ZCS 4.5.x


Verified Against: Zimbra Collaboration 7.0, 6.0 Date Created: 5/2/2006
Article ID: https://wiki.zimbra.com/index.php?title=CLI_zmbackupquery_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