HOT Backup and HOT Restore

 - This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
 - This article is a Community contribution and may include unsupported customizations.
Admin Article

Article Information

This article applies to the following ZCS versions.

ZCS 6.0 Article ZCS 6.0 ZCS 5.0 Article ZCS 5.0


ZMBKPOSE is a bash script to hot backup and hot restore Zimbra Collaboration Suite Opensource. ZMBKPOSE was first developed by Rubens Alonso Filho and improved by many other people.

Would be nice if we get some reports to be always improveing the tool,please contact,, for bugs, suggestions and others.


Since 25/07/2011, this project will be on the github and any contribs are wellcome.


1.0.1 - [Download]

1.0.5 - [Download]

Inside the package look at the README for instructions.

The zmbkpose

The zmbkpose tool is a shell script that does hot backup and hot restore of ZCS Opensource accounts, GPL(OPENSOURCE). It can run from any host in the net, which means that it can be set on a backup server already existent.

It was concepted after Zimbra released ZCS 5.0.12, where a new import/export feature was exposed to user can be able to do his archiving. From that point it was clear for me that I just need to write a code to automatically get all user data from server, remotely via HTTP SOAP. Plus LDAP data. So, it is possible to run full backups and restore even deleted accounts.

Till now, zmbkpose provides

  • Full backup of all accounts;
  • Full backup of any account;
  • Incremental backup of all accounts;
  • Incremental backup of any account;
  • Lists all backup sessions done;
  • Restore all contents (mail, contacts, appointments...) to any account;
  • Restore deleted accounts back to directory and all of its contents;
  • Restore only account attributes, like password, class of service;
  • Configurable full simultaneously backup;

This tool DOES NOT DO disaster recovery.


To run zmbkpose it is necessary

  1. Install ldap-utils e curl utils;
  2. Download de packages in realease section;
  3. Copy the Config file to /etc/zmbkpose/zmbkpose.conf;
  4. Copy the script to /usr/bin
  5. Give script execute permissions
  6. To see zmbkpose syntax, type just zmbkpose

ZMBKPOSE and Kyapanel

KyaPanel is a panel to provide easy management in Gnu/Linux servers, developed to increase the network administration. Two modules are included in this new version: E-mail Management and Samba Management.

Check out this amazing tool at

You can find more informations and instructions (in portuguese) at

Verified Against: Bruno Gurgel Date Created: 12/15/2009
Article ID: Date Modified: 03/25/2015

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