Zmprov

For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities.

ZCS 6.0.x

• Bug 23920 - a new CLI command, zmprov desc, prints all attribute names.

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.

Syntax

zmprov [cmd] [argument]

The following objects use this syntax:

• ModifyAccount
• ModifyDomain
• ModifyCos
• ModifyServer
• ModifyConfig
• ModifyDistributionList
• ModifyCalendarResource

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"

Description

Long Name	Short Name	Description
--help	-h	display usage
--file	-f	use file as input stream
--server	-s	{host}[:{port}] server hostname and optional port
--ldap	-l	provision via LDAP instead of SOAP
--log property file	-L	log 4j property file, valid only with -l
--account {name}	-a	account name to auth as
--password {pass}	-p	password for account
--passfile {file}	-P	read password from file
--zadmin	-z	use Zimbra admin name/password from localconfig for admin/password
--authtoken (authtoken)	-y	use auth token string (has to be in JSON format) from command line
--authtoken (authtoken file)	-Y	use auth token string (has to be in JSON format) from command line
--verbose	-v	verbose mode (dumps full exception stack trace)
--debug	-d/	debug mode (dumps SOAP messages)
--master	-m	use LDAP master. This only valid with -l

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 zmprov gc <COSname>.

zmprov ca name@domain.com password zimbraCOS 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.

• Using a batch process to create accounts, see the Managing the Zimbra Collaboration Suite chapter in the Zimbra Administration Guide for the procedure.

• Add an alias to an account.

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

• 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 zimbraDefaultDomain domain1.com

• To list all COSs and their attribute values.

zmprov gac -v

• To list all user accounts in a domain (domain.com)

zmprov gaa domain.com

• To list all user accounts and their configurations

zmprov gaa -v domain.com

• To enable logger on a single server

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:
  • ${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}’

ZCS 5.0

• ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmprov (Provisioning)

ZCS 4.5

• ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmprov (Provisioning)