ZxBackup Smartscan

Warning! This wiki is outdated and not maintained anymore, please refer to the new Zextras Documentation Hub at https://docs.zextras.com

This documentation is outdated.

Please refer to https://docs.zextras.com

Warning! After 3 years of honorable service, the FullScan feature has been removed from ZeXtras Suite. Thus, starting from ZeXtras Suite 1.8.17 the "SmartScan" and "Purge" features of ZeXtras Backup will be used instead.

What is the Smart Scan?

The Smart Scan is the main coherency check for the health of your backup system. It's "Smart" because it operates only on accounts modified since the last SmartScan, hence improving system performance and decreasing scan time exponentially.

By default a SmartScan is scheduled to be executed each night (if "Scan Operation Scheduling" is enabled in the ZxBackup section of the ZeXtras Administrative Zimlet). Once a week, on a day set by the user, a Purge is executed together with the SmartScan to clear ZxBackup's datastore from any deleted item that exceeded the retention period.

How does it work?

The ZxBackup engine scans all the items on the Zimbra Datastore looking for items modified after the last SmartScan updating any outdated entry and creating any item not yet present in the backup while flagging as deleted any item found in the backup and not in the Zimbra Datastore.

Finally, it updates all Configuration metadata in the backup, so that Domains, Accounts, COSs and Server Configurations are stored.

When is a Smart Scan executed?

• When the ZeXtras Backup module is started.
• Daily, if the Scan Operation Scheduling is enabled in the ZeXtras Administration Zimlet.
• When the Real Time Scanner is re-enabled via the ZeXtras Administration Zimlet after being previously disabled.

Running a Smart Scan

Starting the scan via the ZeXtras Administration Zimlet

• Open the ZeXtras Administration Zimlet

• Click the ZxBackup tab (be sure to have a valid License).

• Click "Run Smartscan"

Starting the scan via the ZeXtras CLI

To start a FullScan via the ZeXtras CLI the "doSmartScan" command is available

Syntax:
   zxsuite backup doSmartScan [attr1 value1 [attr2 value2...]]


PARAMETER LIST

NAME                TYPE                  
notifications(O)    Email Address[,..]    

(M) == mandatory parameter, (O) == optional parameter

Usage example:

zxsuite backup dosmartscan notifications user1@example.com,user2@example.com
Performs a smart scan and sends notifications to user1@example.com and user2@example.com

Checking the status of a running scan

To check the status of a running scan via the ZeXtras 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