CLI zmrestoreoffline Network Edition only: Difference between revisions

No edit summary
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==<font size="4" color="#00007f" face="Arial"> ''' zmrestoreoffline (Offline Restore) ''' </font>==
{{BC|Certified}}
(Network Edition only)
__FORCETOC__
<div class="col-md-12 ibox-content">
=CLI zmrestoreoffline Network Edition only=
{{KB|{{ZC}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}
{{Archive}}{{WIP}}
This CLI command is available only on ZCS Network Edition.  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].


<font size="3" color="#000000" face="Arial"> This tool is run when the Zimbra server (i.e., the Tomcat process) is down. The MySQL database for the server and the OpenLDAP directory server must be running before you start the zmrestoreoffline command.</font>
=ZCS 6.0.x=
==zmrestoreoffline==
This tool is run when the Zimbra server (i.e., the mailbox process) is down. The MySQL database for the server and the OpenLDAP directory server must be running before you start the '''zmrestoreoffline''' command.


===<font size="3" color="#00007f" face="Arial"> ''' Syntax ''' </font>===
===Syntax===
zmrestoreoffline [options]


<font size="3" color="#000000" face=""Times New Roman""> '''  zmrestoreoffline <options> [<accounts>]  ''' </font>
===Description===
 
{|style="width:100%" border="1" cellpadding="5" cellspacing="0"
<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>
! align="left" bgcolor="tan" |Long Name
 
! align="left" bgcolor="tan" |Short Name
{| border="1" cellpadding="8"
! align="left" bgcolor="tan"|Description
|+
|-
|style="background=white" |<nowiki>--account</nowiki>
|<nowiki>-a</nowiki>
|'''<arg>''' Specifies the account email addresses. Separate accounts with a blank space or state '''all''' for restoring all accounts. Required.
|-
|<nowiki>--backedupRedologs Only</nowiki>
|<nowiki>-br</nowiki>
|Replays the redo logs in backup only, which excludes archived and current redo logs of the system
|-
|<nowiki>--continueOnError</nowiki>
|<nowiki>-c</nowiki>
|Continue to restore other accounts when an error occurs
|-
|<nowiki>--createAccount</nowiki>
|<nowiki>-ca</nowiki>
|Restores accounts to new target accounts whose names are pre-pended with prefix
|-
|-
| valign="middle" |
|<nowiki>--debug</nowiki>
<font size="3" color="#00007f" face="Arial"> ''' Long Name ''' </font>
|<nowiki>-d</nowiki>
| valign="middle" |
|Display diagnostics for debugging purposes
<font size="3" color="#00007f" face="Arial"> ''' Short Name''' </font>
| valign="middle" |
<font size="3" color="#00007f" face="Arial"> ''' Description ''' </font>
|-
|-
| valign="top" |
|<nowiki>--help</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --label  ''' </font>
|<nowiki>-h</nowiki>
| valign="top" |
|Displays the usage options for this command
<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 to restore. Type this label to specify a backup file other then the latest.</font>
|-
|-
| nowrap="nowrap" valign="top" |
|<nowiki>--ignoreRedoErrors</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  -- restorefullBackupOnly ''' </font>
|<nowiki></nowiki>
| valign="top" |
|If true, ignore all errors during redo log replay
<font size="3" color="#000000" face=""Times New Roman""> '''  -rf  ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial"> Restores to the full backup only, not any incremental backups since that backup.</font>
|-
|-
| valign="top" |
|<nowiki>--label</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --restoreAccount  ''' </font>
|<nowiki>-lb</nowiki>
| valign="top" |
|'''<arg>''' The label of the full backup to restore. Type this label to specify a backup file other then the latest.
<font size="3" color="#000000" face=""Times New Roman""> '''  -ra  ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial"> Restores the account in directory service.</font>
|-
|-
| valign="top" |
|<nowiki>--prefix</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --prefix ''' </font>
|<nowiki>-pre</nowiki>
| valign="top" |
|<prefix> The prefix to pre-pend to the original account names.  
<font size="3" color="#000000" face=""Times New Roman""> ''' -pr ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial">  <font size="3" face=""Times New Roman""><prefix> </font> The prefix to pre-pend to the original account names. </font>
|-
|-
| valign="top" |
|<nowiki>--restoreAccount</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --createAccount ''' </font>
|<nowiki>-ra</nowiki>
| valign="top" |
|Restores the account in directory service.
<font size="3" color="#000000" face=""Times New Roman""> ''' -ca ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial"> Restores accounts to new target accounts whose names are pre-pended with <prefix>.</font>
|-
|-
| valign="top" |
|<nowiki>-restoreToIncrLabel</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --account ''' </font>
|<nowiki></nowiki>
| valign="top" |
|'''<arg>'''Replay redo logs up to and including this incremental backup
<font size="3" color="#000000" face=""Times New Roman""> ''' -a ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial">  <font size="3" color="#000000" face=""Times New Roman""> '''<arg>''' </font>  Specifies the account email addresses. Separate accounts with a blank space or state <font size="3" color="#000000" face=""Times New Roman"">'''all'''</font> for restoring all accounts. Required.</font>
|-
|-
| valign="top" |
|<nowiki>-restoreToRedoSeq</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --backedupRedolog Only''' </font>
|<nowiki></nowiki>
| valign="top" |
|'''<arg>''' Replay up to and including this redo log sequence
<font size="3" color="#000000" face=""Times New Roman""> ''' -br ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial"> Replays the redo logs in backup only, which excludes archived and current redo logs of the system.</font>
|-
|-
| valign="top" |
|<nowiki>-restoreToTime</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --continueOnError ''' </font>
|<nowiki></nowiki>
| valign="top" |
|'''<arg>''' Replay rodo logs until this time
<font size="3" color="#000000" face=""Times New Roman""> ''' -c ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial"> Continue to restore other accounts when an error occurs.</font>
|-
|-
| valign="top" |
|<nowiki>--restorefullBackupOnly</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> ''' --systemData ''' </font>
|<nowiki>-rf</nowiki>
| valign="top" |
|Restores to the full backup only, not any incremental backups since that backup.
<font size="3" color="#000000" face=""Times New Roman""> ''' -sys ''' </font>
| valign="top" |
<font size="3" color="#000000" face="Arial"> Restores global tables and local config.</font>
|-
|-
| colspan="3" valign="top" |
|<nowiki>--server</nowiki>
<font size="3" color="#000000" face="Arial"> ''' Common Options ''' </font>
|<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. If <nowiki>-s</nowiki> is specified, this must be localhost.
|-
|-
| valign="top" |
|<nowiki>--skipDeletedAccounts</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --server  ''' </font>
|<nowiki></nowiki>
| valign="top" |
|Do not restore if named accounts were deleted or did not exist at backup time. (This option is always enabled with '''<nowiki>-</nowiki>a all''')
<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. If -s is specified, this must be localhost. </font>
|-
|-
| valign="top" |
|<nowiki>--systemData</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --target  ''' </font>
|<nowiki>-sys</nowiki>
| valign="top" |
|Restores global tables and local config.
<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>--target</nowiki>
<font size="3" color="#000000" face=""Times New Roman""> '''  --help  ''' </font>
|<nowiki>-t</nowiki>
| valign="top" |
|'''<arg>''' Specifies the backup target location. The default is <zimbra_home>/backup.
<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>
|}
|}


===<font size="3" color="#00007f" face="Arial"> ''' Examples ''' </font>===
===Example===
Before you begin zmrestoreoffline, the LDAP directory server must be running
 
*Perform a complete restore of all accounts on server1, including last full backup and any incremental backups since last full backup.
 
zmrestoreoffline -s server1.domain.com
 
=ZCS 5.0=
*[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.14.html#1268453 ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmrestoreoffline]
 
 
=ZCS 4.5=
*[http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.9.html#1173740 ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmrestoreoffline]
 
 
=Related Articles=
*[[:Category:Backup and Restore]]
*[[:Category:Disaster_Recovery]]


<font size="3" color="#000000" face="Arial"> Before you begin zmrestoreoffline, the LDAP directory server must be running </font>


{|
|- valign="baseline"
| width="19.2" |
<font size="3" color="#000000" face=""Times New Roman""> '''• ''' </font>
| <font size="3" color="#000000" face="Arial"> Perform a complete restore of all accounts on  '''server1''', including last full backup and any incremental backups since last full backup.</font>
|}


<blockquote>
{{Article Footer|Zimbra Collaboration 6.0.x|5/2/2006}}


<font size="3" color="#000000" face="Arial">  <font size="3" color="#000000" face=""Times New Roman""> '''zmrestoreoffline''' </font>  '''<font size="2" face=""Courier New""> -s server1.domain.com</font>''' </font>
[[Category:Backup and Restore]]
[[Category:Command Line Interface]]
[[Category:ZCS 7.0]]
[[Category:ZCS 6.0]]

Latest revision as of 16:11, 11 July 2015

  1. Zimbra Tech Center
  2. Certified
  3. CLI zmrestoreoffline Network Edition only

CLI zmrestoreoffline Network Edition only

   KB 1487        Last updated on 2015-07-11  




0.00
(0 votes)

This CLI command is available only on ZCS Network Edition. 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

zmrestoreoffline

This tool is run when the Zimbra server (i.e., the mailbox process) is down. The MySQL database for the server and the OpenLDAP directory server must be running before you start the zmrestoreoffline command.

Syntax

zmrestoreoffline [options]

Description

Long Name Short Name Description
--account -a <arg> Specifies the account email addresses. Separate accounts with a blank space or state all for restoring all accounts. Required.
--backedupRedologs Only -br Replays the redo logs in backup only, which excludes archived and current redo logs of the system
--continueOnError -c Continue to restore other accounts when an error occurs
--createAccount -ca Restores accounts to new target accounts whose names are pre-pended with prefix
--debug -d Display diagnostics for debugging purposes
--help -h Displays the usage options for this command
--ignoreRedoErrors If true, ignore all errors during redo log replay
--label -lb <arg> The label of the full backup to restore. Type this label to specify a backup file other then the latest.
--prefix -pre <prefix> The prefix to pre-pend to the original account names.
--restoreAccount -ra Restores the account in directory service.
-restoreToIncrLabel <arg>Replay redo logs up to and including this incremental backup
-restoreToRedoSeq <arg> Replay up to and including this redo log sequence
-restoreToTime <arg> Replay rodo logs until this time
--restorefullBackupOnly -rf Restores to the full backup only, not any incremental backups since that backup.
--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. If -s is specified, this must be localhost.
--skipDeletedAccounts Do not restore if named accounts were deleted or did not exist at backup time. (This option is always enabled with -a all)
--systemData -sys Restores global tables and local config.
--target -t <arg> Specifies the backup target location. The default is <zimbra_home>/backup.

Example

Before you begin zmrestoreoffline, the LDAP directory server must be running

  • Perform a complete restore of all accounts on server1, including last full backup and any incremental backups since last full backup.
zmrestoreoffline -s server1.domain.com

ZCS 5.0


ZCS 4.5


Related Articles


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

Other help Resources

User Help Page »
Official Forums »
Zimbra Documentation Page »

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 »

Retrieved from "http://wiki.zimbra.com/index.php?title=CLI_zmrestoreoffline_Network_Edition_only&oldid=59925"
Jump to: navigation, search