Zimbra Next Generation Modules/Zimbra NG Backup/doCoherencyCheck
Zimbra NG Backup - doCoherencyCheck
Zimbra NG Backup - doCoherencyCheck
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.
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
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
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
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
Zimbra Next Generation Modules
Zimbra Next Generation Modules Resources
Here you can find useful resources for your Zimbra NG Modules
- What are the Zimbra NG Modules?
- FAQs
- Downloads
- Zimbra NG Modules Installation Guide
- Zimbra Client Zimlet
- How to migrate Zimbra with Zimbra Migration Tool
- How to perform an incremental Migration with Zimbra NG Modules
- Known Issues