Zimbra Suite Plus/Zimbra Backup Plus/Purge




Zimbra Backup Plus - Purge

Zimbra Backup Plus - Purge

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 Zimbra Backup Plus's built-in deduplication - the BLOB itself will not be deleted.

Zimbra Suite Plus comes with Postfix Customizations backed up by Zimbra Backup Plus also follow the backup path's purge policies: this can be changed in the "Zimbra Backup Plus" section of the Zimbra Suite Plus 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 Zimbra Suite Plus Administration Zimlet.
  • When manually started either via the Zimbra Suite Plus Administration Console or the Zimbra Suite Plus 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 Zimbra Suite Plus Administration Zimlet

  • Click the Zimbra Backup Plus tab (be sure to have a valid License).
  • Click the "Run Purge" button on the top-right part of the UI.

Starting the Backup Purge via the Zimbra Suite Plus CLI

To start a BackupPurge via the Zimbra Suite Plus 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 Zimbra Suite Plus 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 Suite Plus

Logo-zimbrasuiteplus.png

Latest Version: 2.16.2

Zimbra Suite Plus Resources

Here you can find useful resources for your Zimbra Suite Plus environment



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search