Difference between revisions of "Zimbra Next Generation Modules/Zimbra NG Backup/doCoherencyCheck"

m (1 revision imported: Zimbra NG)
 
Line 1: Line 1:
<div class="col-md-12"><br></div>
+
#REDIRECT [[Zimbra_NG_Modules/Zimbra_NG_Backup/doCoherencyCheck]]
<div class="col-md-12"><br></div>
 
<ol class="breadcrumb">
 
  <li>[[Main Page|Zimbra Wiki]]</li>
 
  <li>[[Zimbra_Next_Generation_Modules]]</li>
 
  <li>[[Zimbra_NG_Backup]]</li>
 
  <li class="active"> doCoherencyCheck</li>
 
</ol>
 
__NOTOC__
 
<div class="col-md-12"><br /></div>
 
<div class="col-md-9">
 
    <h2 class="title-header" style="padding-bottom: 9px; border-bottom: 4px solid #0087c3;">Zimbra NG Backup - doCoherencyCheck</h2>
 
    <div class="col-md-12">
 
        <div class="ibox-content">
 
            <div class="post animated fadeInLeft animation-delay-8" style="padding-top:5px">
 
                <div class="panel panel-default">
 
                    <div class="panel-body">
 
                        <h5 class="post-title">Zimbra NG Backup - doCoherencyCheck</h5>
 
                        <div class="row">
 
== What is the Coherency Check? ==
 
The "Coherency Check" is a feature which performs a deeper check of a Backup Path than the one done by the SmartScan.
 
 
 
While the SmartScan works "incrementally", by only checking items which have been modified since the last SmartScan, the Coherency Check performs a throughout check of all metadata and BLOBs in the backup path.
 
 
 
It's specifically designed to detect corrupted metadata and BLOBs.
 
 
== How does it work? ==
 
The Coherency Check verifies the integrity of every metadata in the backup path and of the related BLOBs: should any errors be found, running the check with the "fixBackup" option will move any orphaned or corrupted metadata/BLOB to a dedicated directory within the backup path.
 
 
 
== When should a Coherency Check be executed? ==
 
* At interval periods in order to make sure that everything is ok (e.g. every 3 or 6 months).
 
* After a system crash.
 
* After the filesystem or storage device containing the backup path experiences any issue.
 
 
 
Should the SmartScan detect a possible item corruption, a Coherency Check will be started automatically.
 
 
 
{{WarningBoxxy|The Coherency Check is highly I/O consuming, so make sure to run it only during off-peak periods}}
 
 
 
== Running a Coherency Check ==
 
=== Starting the Check via the Zimbra Next Generation Modules Administration Zimlet ===
 
The Coherency Check is not available on the Zimbra Next Generation Modules Administration Zimlet.
 
 
 
=== Starting the Check via the Zimbra Next Generation Modules CLI ===
 
To start a Coherency Check via the Zimbra Next Generation Modules CLI the "doCoherencyCheck" command is available
 
<pre><nowiki>
 
Syntax:
 
  zxsuite backup doCoherencyCheck {backup_path} [attr1 value1 [attr2 value2...]]
 
 
 
 
 
PARAMETER LIST
 
 
 
NAME                TYPE                    EXPECTED VALUES    DEFAULT
 
backup_path(M)      Path                                     
 
accounts(O)        Account Name/ID[,..]                       all
 
checkZimbra(O)      Boolean                true|false        false
 
fixBackup(O)        Boolean                true|false        false
 
notifications(O)    Email Address[,..]                        
 
 
 
(M) == mandatory parameter, (O) == optional parameter
 
 
 
Usage example:
 
 
 
zxsuite backup docoherencycheck /opt/zimbra/backup/zextras/ accounts jack@exmaple.com,john@exmaple.com
 
Performs a coherency check on /opt/zimbra/backup/zextras/ for Jack's and John's accounts
 
zxsuite backup docoherencycheck /opt/zimbra/backup/zextras/ fixBackup true
 
Performs a coherency check on /opt/zimbra/backup/zextras/ and moves corrupted backup files and blob files not referenced by any metadata out of backup
 
</nowiki></pre>
 
 
 
=== Checking the status of a running check ===
 
To check the status of a running scan via the Zimbra Next Generation Modules CLI the "monitor" command is available
 
<pre><nowiki>
 
Syntax:
 
  zxsuite backup monitor {operation_uuid} [attr1 value1 [attr2 value2...]]
 
 
 
 
 
PARAMETER LIST
 
 
 
NAME                TYPE     
 
operation_uuid(M)    Uiid     
 
operation_host(O)    String   
 
 
 
(M) == mandatory parameter, (O) == optional parameter
 
</nowiki></pre>
 
                        </div>
 
                    </div>
 
                    <div class="col-md-9">
 
                        <div class="panel-footer">
 
                            <p><i class="fa fa-clock-o"></i> Aug 25, 2016 - [https://www.zimbra.com/email-server-software/ Know more »]</p>
 
                        </div>
 
                    </div>
 
                </div>
 
            </div>
 
        </div>
 
    </div>
 
</div>
 
<div class="col-md-3"><br /></div>
 
<div class="col-md-3">
 
    <div class="panel panel-zimbrared-light-border">
 
        <div class="panel-heading">
 
            <h3 class="panel-title"><i class="fa fa-gear pull-left"></i> Zimbra Next Generation Modules</h3>
 
        </div>
 
        <div class="panel-body">
 
            {{ZNG}}
 
        </div>
 
    </div>
 
</div>
 
<div class="col-md-3">
 
    <div class="panel panel-primary-light-border">
 
        <div class="panel-heading">
 
            <h3 class="panel-title"><i class="fa fa-info-circle pull-left"></i> Zimbra Next Generation Modules Resources</h3>
 
        </div>
 
        <div class="panel-body">
 
            {{ZNGL}}
 
        </div>
 
    </div>
 
</div>
 
<div class="clearfix"></div>
 
<div class="col-md-12"><br></div>
 
{{FH}}
 

Latest revision as of 12:47, 29 November 2017

Jump to: navigation, search