View source for How to create a contact group from CLI

{{BC|Certified}}
__FORCETOC__
<div class="col-md-12 ibox-content">
=How to create contact and contact group from CLI using Zmsoap command?= 
<hr>
{{KB|{{ZC}}|{{ZCS 10}}||||}} 
  


====Problem====
How to create contact and contact group from CLI using Zmsoap command and add local contact and GAL contact in the contact group?
 
====Solution====
====Create a local contact through the Zmsoap command.====

Create the SOAP XML as per Zimbra SOAP API - /tmp/createcontact.xml and add the following line to this file and save it :

 <CreateContactRequest xmlns="urn:zimbraMail">
 <cn l="7">
 <a n="firstName">Test</a>
 <a n="lastName">Test</a>
 <a n="homeStreet">Test street</a>
 <a n="mobilePhone">8000062359</a>
 <a n="fullName">Test, Test</a>
 <a n="email">test@gmail.com</a>
 </cn>
 </CreateContactRequest>

Run the below command to create a local contact :
 $zmsoap -v -z -m user@domain.com -f /tmp/createcontact.xml 

====Create a contact group through Zmsoap.====

Create the SOAP XML as per Zimbra SOAP API - /tmp/createcontact_group.xml and add the following line to this file and save :

 <CreateContactRequest xmlns="urn:zimbraMail">
 <cn l="7">
 <a n="fileAs">8:testgroup</a>
 <a n="nickname">testgroup</a>
 <a n="type">group</a>
 <a n="fullName">testgroup</a>
 </cn>
 </CreateContactRequest>

Run the below command to create a contact group :
 $zmsoap -v -z -m user@domain.com -f /tmp/createcontact.xml

====Add the local contact in contact group.====
 $zmsoap -v -z -m user@domain.com ModifyContactRequest/cn @id=group_id m/@op="+" @type="C" @value="contact_id"

Here "group_id" is contact group ID and "contact_id" is the local contact ID.

Run the following command to get group_id and contact_id :
 $zmmailbox -z -m user@domain.com  gact >/tmp/getall_contact.txt

Both group_id and contact_id can be found in this file /tmp/getall_contact.txt.

====Add the GAL contact in contact group.====
 $zmsoap -v -z -m test2@domain.com ModifyContactRequest/cn @id=group_id m/@op="+" @type="G" @value="uid=Gopal,ou=people,dc=domain,dc=com"

Here "group_id" is a contact group ID and "uid=Gopal,ou=people,dc=domain,dc=com" GAL contact that needs to be added to the contact group.

Contact gopal@domain.com is saved in LDAP in this format "uid=Gopal,ou=people,dc=domain,dc=com" , replace UID with the actual contact name and domain.

====Get contacts of a specific folder====
 $zmmailbox -z -m test2@domain.com gact -f "/Contacts"

It contains contacts and contact groups.

'''Example:'''
 $ zmmailbox -z -m test2@domain.com gact -f "/Contacts"
 Id: 408
 Folder: /Contacts
 Date: 08/15/24 15:22
 Revision: 3394
 Attrs:
   fileAs: 8:testGroup
   nickname: testGroup
   fullName: testGroup
   type: group
 GroupMembers: [raghu@example.com, b4349560-2294-4acc-a8ac-db31e1ddec07:260, uid=Gopal,ou=people,dc=domain,dc=com]

====Remove contact from contact group====
'''Remove GAL contact'''
 $zmsoap -v -z -m test2@domain.com ModifyContactRequest/cn @id=group_id m/@op="-" @type="G" @value="uid=Gopal,ou=people,dc=domain,dc=com"

'''Remove local/external contact'''
 $zmsoap -v -z -m test2@domain.com ModifyContactRequest/cn @id=group_id m/@op="-" @type="C" @value="contact_id"

Here "group_id" (i.e:408) is a contact group ID and "uid=Gopal,ou=people,dc=domain,dc=com" GAL contact that needs to be removed from the contact group.
Contact gopal@domain.com is saved in LDAP in this format "uid=Gopal,ou=people,dc=domain,dc=com" , replace UID with the actual contact name and domain. 
Contact_id is the contact id of the external contact (i.e: b4349560-2294-4acc-a8ac-db31e1ddec07)

====Rename contact group====
'''A.''' Create a file called "/tmp/modify.xml", and xml code as below.
    <ModifyContactRequest xmlns="urn:zimbraMail">
      <cn id="group_id">
        <a n="fullName">New Name</a>
        <a n="nickname">New Name</a>
        <a n="type">group</a>
        <a n="fileAs">8:New Name</a>
      </cn>
    </ModifyContactRequest>

'''B.''' Run below soap command to rename respective group.
    zmsoap -v -z -m test2@domain.com -f /tmp/modify.xml
Note: Replace group_id, New Name with actual values.

====Remove contact group====
 zmmailbox -z -m test2@domain.com dct group_id

For more reference : Zimbra SOAP API [https://wiki.zimbra.com/wiki/SOAP_API_Reference_Material_Beginning_with_ZCS_8 external link]

{{SubmittedBy|Gopal Singh Bhandari}}

{{Article Footer|ZCS 10 |2020-07-10}}