Difference between revisions of "Zmprov Examples"

(zmprov Usage Examples)
Line 17: Line 17:
 
see the [[Managing_ZCS_Configuration#Batch_Provisioning_from_the_CLI_Utility|Batch Provisioning from the CLI Utility]] section of the Managing the Zimbra Collaboration Suite chapter for the procedure.
 
see the [[Managing_ZCS_Configuration#Batch_Provisioning_from_the_CLI_Utility|Batch Provisioning from the CLI Utility]] section of the Managing the Zimbra Collaboration Suite chapter for the procedure.
  
* <div class="NumberedCont">Add an alias to an account.</div>
+
Add an alias to an account:
 
 
<div class="CLI_indented_command">
 
  
 
  zmprov aaa accountname@domain.com aliasname@domain.com
 
  zmprov aaa accountname@domain.com aliasname@domain.com
  
</div>
 
  
 
* <div class="NumberedCont">Canonical address</div>
 
* <div class="NumberedCont">Canonical address</div>
 
>  zimbraMailCanonicalAddress
 
>  zimbraMailCanonicalAddress
  
* <div class="CLI_indented_command">Create distribution list. The ID of the distribution list is returned.</div>
+
Create distribution list. The ID of the distribution list is returned:
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov cdl listname@domain.com
 
  zmprov cdl listname@domain.com
  
</div>
+
Add a member to a distribution list. '''Tip: '''You can add multiple members to a list from the administration console:
 
 
* <div class="CLI_indented_command">Add a member to a distribution list. '''Tip: '''You can add multiple members to a list from the administration console. </div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov adlm listname@domain.com member@domain.com
 
  zmprov adlm listname@domain.com member@domain.com
  
</div>
+
Change the administrator’s password. Use this command to change any password. Enter the address of the password to be changed:
 
 
* <div class="CLI_indented_command">Change the administrator’s password. Use this command to change any password. Enter the address of the password to be changed.</div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov sp admin@domain.com password
 
  zmprov sp admin@domain.com password
  
</div>
+
Create a domain that authenticates against Zimbra OpenLDAP:
 
 
* <div class="CLI_indented_command">Create a domain that authenticates against Zimbra OpenLDAP.</div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov cd marketing.domain.com zimbraAuthMech zimbra
 
  zmprov cd marketing.domain.com zimbraAuthMech zimbra
  
</div>
+
Set the default domain:
 
 
* <div class="CLI_indented_command">Set the default domain.</div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov mcf zimbraDefaultDomainName domain1.com
 
  zmprov mcf zimbraDefaultDomainName domain1.com
  
</div>
+
To list all COSs and their attribute values:
 
 
* <div class="CLI_indented_command">To list all COSs and their attribute values. </div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov gac -v
 
  zmprov gac -v
  
</div>
+
To list all COSs and their attribute values:
 
 
* <div class="CLI_indented_command">To list all COSs and their attribute values. </div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov gaa domain.com
 
  zmprov gaa domain.com
  
</div>
+
To list all user accounts and their configurations:
 
 
* <div class="CLI_indented_command">To list all user accounts and their configurations</div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov gaa -v domain.com
 
  zmprov gaa -v domain.com
  
</div>
+
To disable the imapproxy service:
 
 
* <div class="CLI_indented_command">To disable the imapproxy service</div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov -- -zimbraServiceEnabled imapproxy
 
  zmprov -- -zimbraServiceEnabled imapproxy
  
</div>
+
To enable logger on a single server:
 
 
* <div class="CLI_indented_command">To enable logger on a single server</div>
 
 
 
<div class="CLI_indented_command">
 
 
 
 
  zmprov +zimbraServiceEnabled logger
 
  zmprov +zimbraServiceEnabled logger
  
</div><div class="NumberedCont">
+
Then type <tt>zmloggerctl start</tt>, to start the logger.
 
 
Then type <span class="Code">zmloggerctl start</span>, to start the logger.
 
  
</div>
 
  
 
* <div class="NumberedCont">Modify <span class="attribute">zimbraNewMailNotification</span> to customize the notification email template. A default email is sent from Postmaster notifying users that they have received mail in another mailbox. To change the template, you modify the receiving mailbox account. The variables are </div>
 
* <div class="NumberedCont">Modify <span class="attribute">zimbraNewMailNotification</span> to customize the notification email template. A default email is sent from Postmaster notifying users that they have received mail in another mailbox. To change the template, you modify the receiving mailbox account. The variables are </div>

Revision as of 10:43, 1 September 2009

zmprov Usage Examples

Create one account with a password that is assigned to the default COS:

zmprov ca name@domain.com password

Create one account with a password that is assigned to a specified COS. You must know the COS ID number. To find a COS ID, type gc <COSname>.:

zmprov ca name@domain.com <password> zimbraCOSid <cosIDnumberstring>

Create one account when the password is not authenticated internally:

zmprov ca name@domain.com ‘’

Note: The empty single quote is required and indicates that there is no local password

Use a batch process to create accounts: http://wiki.zimbra.com/index.php?title=Bulk_Provisioning

see the Batch Provisioning from the CLI Utility section of the Managing the Zimbra Collaboration Suite chapter for the procedure.

Add an alias to an account:

zmprov aaa accountname@domain.com aliasname@domain.com


  • Canonical address

> zimbraMailCanonicalAddress

Create distribution list. The ID of the distribution list is returned:

zmprov cdl listname@domain.com

Add a member to a distribution list. Tip: You can add multiple members to a list from the administration console:

zmprov adlm listname@domain.com member@domain.com

Change the administrator’s password. Use this command to change any password. Enter the address of the password to be changed:

zmprov sp admin@domain.com password

Create a domain that authenticates against Zimbra OpenLDAP:

zmprov cd marketing.domain.com zimbraAuthMech zimbra

Set the default domain:

zmprov mcf zimbraDefaultDomainName domain1.com

To list all COSs and their attribute values:

zmprov gac -v

To list all COSs and their attribute values:

zmprov gaa domain.com

To list all user accounts and their configurations:

zmprov gaa -v domain.com

To disable the imapproxy service:

zmprov -- -zimbraServiceEnabled imapproxy

To enable logger on a single server:

zmprov +zimbraServiceEnabled logger

Then type zmloggerctl start, to start the logger.


  • Modify zimbraNewMailNotification to customize the notification email template. A default email is sent from Postmaster notifying users that they have received mail in another mailbox. To change the template, you modify the receiving mailbox account. The variables are
${SENDER_ADDRESS}
${RECIPIENT_ADDRESS}
${RECIPIENT_DOMAIN}
${NOTIFICATION_ADDRESSS}
${SUBJECT}
${NEWLINE}

You can specify which of the above variables appear in the Subject, From, or Body of the email. The following example is changing the appearance of the message in the body of the notification email that is received at name@domain.com. You can also change the template in a class of service, use zmprov mc. The command is written on one line.

zmprov ma name@domain.com zimbraNewMailNotificationBody ‘Important message from ${SENDER_ADDRESS}.${NEWLINE}Subject:${SUBJECT}’
Jump to: navigation, search