HOT Backup and HOT Restore

Revision as of 20:30, 15 December 2009 by Rubão (talk | contribs)


by Rubens Alonso Filho <>

The zmbkpose tool is a shell script that does hot backup and hot restore of ZCS Opensource accounts

This tool DOES NOT DO disaster recovery.

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.

In the version 1.0.0 of zmbkpose, the tool 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, etc

To run zmbkpose it is necessary

  1. Install ldap-utils e curl utils
  2. Create /etc/zmbkpose
  3. Config /etc/zmbkpose/zmbkpose.conf file (bellow)
  4. Create the script from code bellow, giving execute permissions
  5. To see zmbkpose syntax, type just zmbkpose

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

Config and Scripts files from zmbkpose


# This file is part of zmbkpose.

#    zmbkopse is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.

#    zmbkopse is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    GNU General Public License for more details.

#    You should have received a copy of the GNU General Public License
#    along with Foobar.  If not, see <>

# Configuration file for ZCS Opensource Edition Backup Tool
# Lines begining with "#" will not be used
# Values must have to be filled without spaces, quotes, or any kind of special characters

# Privileged user that will run zmbkpose and write in the work directory

# Work directory where will be the backup sessions (all user data)
# 	# Keep the directory access strict to the backup user as long as it contains all user data.

# Must have be filled with an administrator account
# Hint: If you have deleted admin, or missed its password, you can create a new admin directly from command line:
#	# zmprov ca password
#	# zmprov ma zimbraIsAdminAccount TRUE

# Must be filled with ADMINUSER password

# Must be filled with ldap url from Zimbra-LDAP master host
# Example: ldap://hostname:389

# Must be filled with zimbra_ldap_userdn key's value 
# Hint: To get this value, at Zimbra's server, run:
#	# zmlocalconfig zimbra_ldap_userdn

# Must be filled with zimbra_ldap_password key's value 
# Hint: To get this value, at Zimbra's server, run:
#       # zmlocalconfig -s zimbra_ldap_password

# Log file location. It must to have write permission to BACKUPUSER
Jump to: navigation, search