ZCS Administrator's Guide 7.2.3
ZCS Administrator's Guide 7.2.3
Open Source Edition


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 is zmprov [cmd] [argument].
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.
*
*
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"
The attributes for the tasks zmprov can be used with are listed when you type zmprov -h. The task area divided into the following sections:
*
*
*
*
*
*
*
*
*
*
*
*
*
*
 
 
 
The commands in the following table are divided into the tasks types.
 
Note: This command does not check the password age or history.
Note: Passwords cannot included accented characters in the string. Example of accented characters that cannot be used: ã, é, í, ú, ü, ñ.
Note:
Do not modify zimbraDomainRenameInfo manually. This is automatically updated when a domain is renamed.
Note:
See the zmprov Log Categories for a list of logging categories.
Returns the list of servers that have zimbraReverseProxyLookupTarget=TRUE. Basically if a mailbox server is available for lookup requests from the proxy.
Returns a list of all domains configured with ZimbraSSLCertificate zimbraVirtualHostname and zimbraVirtualIPAddress configured. This allows the proxy to configure a list of domains to serve customized/domain certificates for.
Examples
*
zmprov ca name@domain.com password
*
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.
*
*
zmprov aaa accountname@domain.com aliasname@domain.com
*
zmprov cdl listname@domain.com
*
zmprov adlm listname@domain.com member@domain.com
*
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.
*
zmprov gs server.com attribute=value
For example, zmprov gs example.com zimbraServiceEnabled=ldap to find out if the ldap service is enabled.
*
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}’
zmprov Log Categories
 
 
 
Copyright © 2013 VMware Inc.