Zx Backup: Real Time Scan

From ZeXtras Suite Wiki

Jump to: navigation, search
Language: English  • español • português
ZxBackup logo box.png
Available since version: 0.87
Latest Version: 3.0.0
Released on: August 7th, 2019
Compatibility List
Admin Guide
FAQ
Troubleshooting
Backup Initialization
ZspBackup logo box.png

What is the Real Time Scanner?

The Real Time Scanner is the big innovation in ZxBackup. Each event on the system is recorded live to Zimbra Open Source Edition's RedoLog and saved by ZeXtras Backup, which means that is always possible to rollback an account to a previous state. Thanks to the Real Time Scanner all the restore modes work with a split-second precision.

How does it work?

The Real Time Scanner reads all the events of the mail server almost real-time by following the flow of informations provided by the RedoLog. Then it 'replicates' the same operations on it's own data structure, creating items or updating their metadata. No information is ever overwritten in the backup, so that every item has its own complete history.

Managing the Real Time Scanner

Enabling the Real Time Scanner

Via the ZeXtras Administration Zimlet

  • Select the ZxBackup Tab.


Zimlet Panel b.png


  • Under Real Time Scanner, press the "Enable" button.


RTS 01 b.png

Note: when the Real Time Scanner is enabled for the first time or re-enabled after a stop, a Live Full Scan is required. A warning will be displayed after enabling the Real Time Scanner and you will be prompted to start the Full Scan.

Via the ZeXtras CLI

To enable the Real Time Scanner via the ZeXtras CLI, the "ZxBackup_RealTimeScanner" property of the ZeXtras Backup module must be set to "true":

zxsuite backup setProperty ZxBackup_RealTimeScanner TRUE

Disabling the Real Time Scanner

Via the ZeXtras Administration Zimlet

  • Select the ZxBackup Tab.


Zimlet Panel b.png


  • Under Real Time Scanner, press the "Disable" button.


RTS 02 b.png

Via the ZeXtras CLI

To disable the Real Time Scanner via the ZeXtras CLI, the "ZxBackup_RealTimeScanner" property of the ZeXtras Backup module must be set to "false":

zxsuite backup setProperty ZxBackup_RealTimeScanner FALSE

Why should I disable the Real Time Scanner?

The only time you should stop the Real Time Scanner is while performin an External Import of multiple domains. This is a safety measure to avoid high load on your server. After the import just re-enable the Real Time Scanner and perform a SmartScan when prompted, and you are good to go!

Limitations and safety scan

At the moment there are two main limitations when restoring data acquired via the Real Time Scanner.

Namely, those are

  • Emptied Folder - when a user uses the "Empty Folder" button in the right-click context menu

In this case, and any time ZxBackup cannot determine the status of an item by reading the metadata saved by the Real Time Scan, an Account Scan on the given account is triggered BEFORE the restore.

This fixes any misaligned data and sanitizes the backed up metadata for the mailbox.

Personal tools