ZCS Administrator's Guide, Open Source Edition 5.0 (Rev 5.0.19 September 2009)
Table of Contents Previous Next Index


Appendix A Command-Line Utilities : zmprov (Provisioning)

zmprov (Provisioning)
The zmprov tool performs all provisioning tasks in Zimbra LDAP, including creating accounts, aliases, domains, COS, distribution lists, and calendar resources. Each operation is invoked through command-line options, each of which has a long name and a short name.
The syntax for modify can include the prefix “+” or “-” so that you can make changes to the attributes affected and do not need to reenter attributes that are not changing. Use + to add a new instance of the specified attribute name without changing any existing attributes. Use - to remove a particular instance of an attribute. The syntax is zmprov [cmd] [argument].
The following objects use this syntax:
The following example would add the attribute zimbraZimletUserProperties with the value “blue” to user 1 and would not change the value of any other instances of that attribute.
zmprov ma user1 +zimbraZimletUserProperties "com_company_testing:favoriteColor:blue"
 
--log property file
use Zimbra admin name/password from localconfig for admin/password
--authtoken (authtoken)
use auth token string (has to be in JSON format) from command line
--authtoken (authtoken file)
use auth token string (has to be in JSON format) from command line
The commands in the following table are divided into the tasks types - Account, Calendar Resources, Config, COS, Distribution List, Documents, Domain, Server, and Miscellaneous.
Short Name
Syntax:{name@domain} {password} [attribute1 value1 etc]
{name@domain|id|adminName} [attribute1 value1 etc]
zmprov ma joe@domain.com zimbraAccountStatus maintenance
{name@domain | id} {ds-name |ds-id} [attr 1 value 1 [attr2 value 2...]]
{name@domain |id} {signature-name | signature-id} [attr 1 value 1 [attr 2 value 2...]]
{name@domain |id} {identity-name} [attr 1 value 1 [attr 2 value 2...]]
Note: Passwords cannot included accented characters in the string. Example of accented characters that cannot be used: ã, é, í, ú, ü, ñ.
Note: This command does not check the password age or history.
{name@domain} {ds-type} {ds-name} [attr1 value1 [attr2 value2...]]
{name@domain} {signature-name} [attr1 value1 [attr2 value2...]]
{name@domain} {identity-name} [attr1 value1 [attr2 value2...]]
zmprov aaa joe@domain.com joe.smith@engr.domain.com
zmprov raa joe@domain.com joe.smith@engr.domain.com
[-v] {ldap-query} [limit] [offset] [sortBy {attribute} [sortAscending 0|1] [domain {domain}]
{name@domain|id} {newname@domain}
When unread message count and quota usage are out of sync with the data in the mailbox, use this command to immediately recalculate the mailbox quota usage and unread messages count.
Important: Recalculating mailbox quota usage and message count should be schedule to run in off peak hours and used on one mailbox at a time.
{name@domain|id} {newName@domain}
This lists each COS, the COS ID and the number of accounts assigned to each COS
{alias-domain-name} {local-domain-name|id} [attr1 value1 [attr2 value2...]]
zmprov cd mktng.domain.com zimbraAuthMech zimbra
zmprov md domain.com zimbraGalMaxResults 500
Note: Do not modify zimbraDomainRenameInfo manually. This is automatically updated when a domain is renamed.
Note: renameDomain can only be used with “zmprov -l/--ldap
zmprov cc Executive zimbraAttachmentsBlocked FALSE zimbraAuthTokenLifetime 60m zimbraMailQuota 100M zimbraMailMessageLifetime 0
zmprov mc Executive zimbraAttachmentsBlocked TRUE
zmprov ms domain.com zimbraVirusDefinitionsUpdateFrequency 2h
Used to publish into nginx.conf what servers should be used for reverse proxy lookup.
Used to publish into saslauthd.conf what servers should be used for saslauthd.conf MTA auth
get DistributionListmembership
Before importing files, any file that will become a Documents page (wiki-style page), must be renamed to include the extension “.wiki”. If not it is imported as a file, accessed either as an attachment or an image.
{name@domain|id} {action} [{reindex-by} {value1} [value2...]]
Generates a pre-authentication key to enable a trusted third party to authenticate to allow for single-sign on. Used in conjunction with GenerateDomainPreAuth.
{domain|id} {name} {name|id|foreignPrincipal} {timestamp|0} {expires|0}
[-s/ --server hostname] {name@domain|id} {logging-category}
When name@domain is specified, removes the custom logger created for the account otherwise removes all accounts all account loggers from the system.
Used to publish into nginx.conf the servers that should be used for reverse proxy lookup
Used to publish into saslauthd.conf the servers that should be used for saslauthd.conf MTA auth
Examples
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 zmprov gc <COSname>.
zmprov ca name@domain.com password zimbraCOS cosIDnumberstring
zmprov ca name@domain.com ‘’
The empty single quote is required and indicates that there is no local password.
Using a batch process to create accounts, see Managing the zimbra Collaboration Suite chapter for the procedure.
zmprov aaa accountname@domain.com aliasname@domain.com
zmprov cdl listname@domain.com
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
zmprov cd marketing.domain.com zimbraAuthMech zimbra
zmprov mcf zimbraDefaultDomain domain1.com
zmprov gac -v
zmprov gaa domain.com
zmprov gaa -v domain.com
zmprov +zimbraServiceEnabled logger
Then type zmloggerctl start, to start the logger.
To modify the purge interval, set zimbraMailPurgeSleepInterval to the duration of time that the server should “sleep” between every two mailboxes. Type:
zmprov ModifyServer <server-name> zimbraMailPurgeSleepInterval <Xm>
X is the duration of time between mailbox purges; m represents minutes. You could also set <xh> for hours.
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
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}’

Appendix A Command-Line Utilities : zmprov (Provisioning)

Table of Contents Previous Next Index
ZCS Administrator's Guide, Open Source Edition 5.0 (Rev 5.0.19 September 2009)
Copyright © 2009 Zimbra Inc.