Difference between revisions of "CLI zmbackupquery Network Edition only"
(Adding category) |
|||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{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]. | ||
| − | + | =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=== |
| − | + | {|style="width:100%" border="1" cellpadding="5" cellspacing="0" | |
| − | + | ! 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 | ||
|- | |- | ||
| − | | | + | |<nowiki>--help</nowiki> |
| − | < | + | |<nowiki>-h</nowiki> |
| − | | | + | |Shows the help for the usage options for this tool |
| − | < | ||
| − | | | ||
| − | |||
|- | |- | ||
| − | | | + | |<nowiki>--from</nowiki> |
| − | < | + | |<nowiki></nowiki> |
| − | | | + | |'''<arg>''' List backups whose start date/time is at or after the date/time specified here. |
| − | < | ||
| − | | | ||
| − | |||
|- | |- | ||
| − | | | + | |<nowiki>--label</nowiki> |
| − | < | + | |<nowiki>-lb</nowiki> |
| − | | | + | |'''<arg>''' The label of the full backup session to query. An example of a label is '''backup200507121559510'''. |
| − | < | ||
| − | | | ||
| − | < | ||
|- | |- | ||
| − | | | + | |<nowiki>--server</nowiki> |
| − | < | + | |<nowiki>-s</nowiki> |
| − | | | + | |'''<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. |
| − | < | ||
| − | | | ||
| − | |||
|- | |- | ||
| − | | | + | |<nowiki>--target</nowiki> |
| − | < | + | |<nowiki>-t</nowiki> |
| + | |'''<arg>''' Specifies the backup target location (The default is <zimbra_home>/backup.) | ||
|- | |- | ||
| − | | | + | |<nowiki>--to</nowiki> |
| − | < | + | |<nowiki></nowiki> |
| − | | | + | |'''<arg>''' List backups whose start date/time is at or before the date/time specified here. |
| − | < | ||
| − | |||
| − | |||
|- | |- | ||
| − | | | + | |<nowiki>--type</nowiki> |
| − | < | + | |<nowiki></nowiki> |
| − | | | + | |'''<arg>''' Backup set type to query. “full” or “incremental”, both are queried if one is not specified. |
| − | < | ||
| − | | | ||
| − | < | ||
|- | |- | ||
| − | | | + | |<nowiki>--verbose</nowiki> |
| − | < | + | |<nowiki>-v</nowiki> |
| − | | | + | |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= | ||
| + | *[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:Command Line Interface]] | ||
| + | [[Category:ZCS 7.0]] | ||
| + | [[Category:ZCS 6.0]] | ||
Latest revision as of 15:54, 11 July 2015
Contents
CLI zmbackupquery Network Edition only
- This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
- This article is a Work in Progress, and may be unfinished or missing sections.
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
