Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
Restore SOAP Command

Perform an action related to a Restore from backup

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

RestoreRequest

    <RestoreRequest> ## RestoreRequest
        <restore [method="{ca|ra|mb}"] [searchIndex="{include|exclude}"] [blobs="{include|exclude}"]
                    [secondaryBlobs="{include|exclude}"] [target="{path-to-backup-target}"]
                    [label="{label-to-full-backup-set}"] [sysData="{sysData-flag} (0|1)"]
                    [includeIncrementals="{include-incrementals} (0|1)"] [replayRedo="{replay-redo-logs} (0|1)"]
                    [continue="{continue-on-error} (0|1)"] [prefix="{new-acct-prefix}"]
                    [restoreToTime="{restore-to-millis} (Long)"] [restoreToRedoSeq="{redo-log-seq-number} (Long)"]
                    [restoreToIncrLabel="{incremental-backup-label}"] [ignoreRedoErrors="{ignore-redo-errors} (0|1)"]
                    [skipDeleteOps="{skip-delete-ops} (0|1)"] [skipDeletedAccounts="{skip-del-accts} (0|1)"]> ## RestoreSpec
            <fileCopier [fcMethod="{file-copier-method}"] [fcIOType="..."] [fcOIOCopyBufferSize="(Integer)"]
                            [fcAsyncQueueCapacity="(Integer)"] [fcParallelWorkers="(Integer)"] [fcPipes="(Integer)"]
                            [fcPipeBufferSize="(Integer)"] [fcPipeReadersPerPipe="(Integer)"]
                            [fcPipeWritersPerPipe="(Integer)"] /> ## FileCopierSpec
            (<account name="{name}" /> ## Name)*
        </restore>
    </RestoreRequest>

The following table describes elements and attributes you can define within a <RestoreRequest> element:

XPath Required / Optional Description
/restore Required (only 1) Restore specification
/restore@method Optional (0 or 1) Type:String
Method. Valid values ca|ra|mb
/restore@searchIndex Optional (0 or 1) Type:String
whether to include or exclude searchIndex. Valid values include|exclude
/restore@blobs Optional (0 or 1) Type:String
whether to include or exclude blobs. Valid values include|exclude
/restore@secondaryBlobs Optional (0 or 1) Type:String
whether to include or exclude secondary blobs. Valid values include|exclude
Meaningful only when blob restore isn't excluded
/restore@target Optional (0 or 1) Type:String
Path to backup target
/restore@label Optional (0 or 1) Type:String
Label to full backup set
/restore@sysData Optional (0 or 1) Type:0|1
When sysData is set, restore system tables and local config.
/restore@includeIncrementals Optional (0 or 1) Type:0|1
when includeIncrementals is set, any incremental backups from the last full backup are also restored. Default to 1 (true)
/restore@replayRedo Optional (0 or 1) Type:0|1
Replay redo logs
/restore@continue Optional (0 or 1) Type:0|1
Continue on error
/restore@prefix Optional (0 or 1) Type:String
Used to produce new account names if the name is reused or a new account is to be created
/restore@restoreToTime Optional (0 or 1) Type:Long
Restore to time in milliseconds
/restore@restoreToRedoSeq Optional (0 or 1) Type:Long
Redo log sequence number
/restore@restoreToIncrLabel Optional (0 or 1) Type:String
Restore to incremental backup label
/restore@ignoreRedoErrors Optional (0 or 1) Type:0|1
Ignore redo errors
/restore@skipDeleteOps Optional (0 or 1) Type:0|1
Skip delete operations during redo replay. Default 0 (false)
/restore@skipDeletedAccounts Optional (0 or 1) Type:0|1
Skip deleted accounts
/restore/fileCopier Optional (0 or 1) File copier specification
/restore/fileCopier@fcMethod Optional (0 or 1) Type:String
File copier method - PARALLEL | PIPE | SERIAL
/restore/fileCopier@fcIOType Optional (0 or 1) Type:String
fcIOTYpe - OIO | NIO. For all methods
/restore/fileCopier@fcOIOCopyBufferSize Optional (0 or 1) Type:Integer
fcOIOCopyBufferSize in bytes. For all methods
/restore/fileCopier@fcAsyncQueueCapacity Optional (0 or 1) Type:Integer
fcAsyncQueueCapacity. For PARALLEL and PIPE only
/restore/fileCopier@fcParallelWorkers Optional (0 or 1) Type:Integer
fcParallelWorkers. For PARALLEL only
/restore/fileCopier@fcPipes Optional (0 or 1) Type:Integer
fcPipes. For PIPE only
/restore/fileCopier@fcPipeBufferSize Optional (0 or 1) Type:Integer
fcPipeBufferSize. For PIPE only
/restore/fileCopier@fcPipeReadersPerPipe Optional (0 or 1) Type:Integer
fcPipeReadersPerPipe. For PIPE only
/restore/fileCopier@fcPipeWritersPerPipe Optional (0 or 1) Type:Integer
fcPipeWritersPerPipe. Ffor PIPE only
/restore/account Optional (0 or more) Accounts - if all accounts then use <account name="all"/>
/restore/account@name Required (only 1) Type:String
Name

RestoreResponse

    <RestoreResponse [status="..."] [rebuiltSchema="{rebuilt-schema} (0|1)"]> ## RestoreResponse
        (<account name="{name}" /> ## Name)*
    </RestoreResponse>

The following table describes elements and attributes you can define within a <RestoreResponse> element:

XPath Required / Optional Description
@status Optional (0 or 1) Type:String
Status - one of ok|interrupted|err
@rebuiltSchema Optional (0 or 1) Type:0|1
Flag whether schema was rebuilt
/account Optional (0 or more) Accounts
/account@name Required (only 1) Type:String
Name