How to find and backup different COS users

Revision as of 10:49, 13 September 2022 by Barry de Graaff (talk | contribs)

How to backup & restore COS, including the COS users.

   KB 23121        Last updated on 2022-09-13  

(0 votes)


In this article we will show how to:

  • Back-up COS subtree (LDAP).
  • Find which users belong to which COS, and place them into different files, based on COS.
  • Restore COS subtree.
  • Assign users to specific COS


1. Backup COS.

This step assumes that you would like to migrate a server to another one, and this is a way to move just the COS to the other server.

Create new entry as follows:

Host: "client" server IP
Port 389 ; Protocol v3
Base DN: cn=zimbra


Level: User + Password
User DN: cn=config
Password is the output from: zmlocalconfig -s ldap_root_password

Click OK.

  • From the left Tree View, expand cos.
  • Select the COS that you want to export&move.
  • From the File menu line above, click on LDIF > Export Subtree > Save on the local disk.
  • Do that with all COS you want to move.

2. Create files for each non-default COS, and their respective user members.

This step assumes that you are going to move the users from this server to another, and you want to create file for each non-default COS, and to include their members in it.

A short script accomplishes that:


# The result is a file/s for each COS, and the users within this specific COS
# Note: If there are no custom created COS, there will be no users listed in the default and default_external files. That 
# means all users are in the "default" COS.
# Since the default and the default_external files will contain no users, their respective files are deleted at 
# the end. Zimbra only detect users that are not in the default COS. Thus, every non detected user is in the default COS. 

mkdir /tmp/cos_users
source ~/bin/zmshutil; zmsetvars

for i in `zmprov gac`
       id=`zmprov gc "$i" | grep -e "\bzimbraId\b"|cut -d " " -f 2`

       ldapsearch -x -H $ldap_master_url -D $zimbra_ldap_userdn -w $zimbra_ldap_password| grep -e "$id" -e "dn: uid=" -e mail:|grep -v Email| grep -e zimbraCOSId -B1 -A1|grep mail|awk '{print $2}' > "/tmp/cos_users/$i"

/bin/rm -rf /migration/cos_users/default*


3. How to restore COS.

This step assumes you are restoring the backed up COS to the new server.

  • Create new entry in the JXplorer as in point 1, but this time specify the "destination" server IP.
  • Click on the "cos"
  • LDIF > Import File > Select File > Import

Do that with all COS you want to import.

4. This step assumes that you moved the users from the old to the new server, and this script will assign the correct COS to the migrated users.

# The script first list the exported cos names, then iterate through all members within this cos and finally assigns the 
# user to the COS. 

for cos in /tmp/cos_users/*
   while read user; do
      echo "zmprov sac $user" \"$(basename -- "$cos")\" >> /tmp/cos_users.prov
   done <"$cos"
zmprov < /tmp/cos_users.prov

Additional Content


Verified Against: Zimbra Collaboration 10.0,9.0,8.8,8.7, 8.6, 8.0 Date Created: 24/12/2016
Article ID: Date Modified: 2022-09-13

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 »

Wiki/KB reviewed by SME1 SME2 COPY EDITOR Last edit by Barry de Graaff
Jump to: navigation, search