Zx Backup: Purge

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: 2.12.2
Released on: January 2nd, 2019
Compatibility List
Admin Guide
FAQ
Troubleshooting
Backup Initialization
ZspBackup logo box.png

What is the Backup Purge?

The Backup Purge is a cleanup operation that removes from the Backup Path any deleted item which exceeded the retention time defined by the "Data Retention Policy".

How does it work?

The Purge engine scans through the metadata of all deleted items, and removes any item whose last update (deletion) timestamp is higher than the retention time.

Should an item BLOB still be referenced by one or more valid metadata files - due to ZxBackup's built-in deduplication - the BLOB itself will not be deleted.

Starting from ZeXtras Suite 1.8.17, Postfix Customizations backed up by ZeXtras Backup also follow the backup path's purge policies: this can be changed in the "ZxBackup" section of the ZeXtras Administration Zimlet by unchecking the "Purge old customizations" checkbox.

When is a Backup Purge executed?

  • Weekly, if the Scan Operation Scheduling is enabled in the ZeXtras Administration Zimlet.
  • When manually started either via the ZeXtras Administration Console or the ZeXtras CLI.

"Infinite" retention

Should the "Data Retention Policy" be set to "0", meaning infinite retention, the Backup Purge will immediately exit since no deleted item will ever exceed the retention time.

Running a Backup Purge

Starting the Backup Purge via the ZeXtras Administration Zimlet

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


Zimlet Panel b.png


  • Click the "Run Purge" button on the top-right part of the UI.

Starting the Backup Purge via the ZeXtras CLI

To start a BackupPurge via the ZeXtras CLI the "doPurge" command is available

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


PARAMETER LIST

NAME              TYPE      
purgeDays(O)      String    
backup_path(O)    Path      

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

Usage example:

zxsuite backup dopurge purgeDays 30 backup_path /opt/zimbra/backup/backup_name

Checking the status of a running Backup Purge

To check the status of a running Purge 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
Personal tools