Zmprov (Provisioning): Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
== | ==zmprov (Provisioning)== | ||
< | <div class="Body"> | ||
The zmprovtool performs all provisioning tasks in Zimbra LDAP, including creating accounts, aliases, domains, distribution lists, and calendar resources. Each operation is invoked through command-line options, each of which has a long name and a short name. | |||
< | </div><div class="Body"> | ||
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]. | |||
</div><div class="Body" style="margin-bottom: 1.0pt"> | |||
< | The following objects use this syntax: | ||
</div> | |||
* <div class="Body" style="margin-bottom: 1.0pt">ModifyAccount</div> | |||
* ModifyDomain | |||
* ModifyCos | |||
* ModifyServer | |||
* ModifyConfig | |||
* ModifyDistributionList | |||
* ModifycalendarResource | |||
<div class="Body"> | |||
The following example could add the attribute '''zimbraZimlet UserProperties''' with the value 'testing" to user 1 and would not chagne the value of any other instance of that attribute. | |||
zmprov ma user1 +zimbraZimletUserProperties testing | |||
</div> | |||
{| | {| id="1121373" class="CLI_table" style="margin-bottom: pt; margin-left: pt; margin-right: pt; margin-top: pt; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; text-align: left; width: 349.2pt" | ||
| id="tc1121375" style="background-color: none; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 2.0pt; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: middle; width: 97.2pt" | | |||
<div class="CellHeading"> | |||
Short Name | |||
</div> | |||
| | | id="tc1121377" style="background-color: none; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 2.0pt; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: middle; width: 54pt" | | ||
<div class="CellHeading"> | |||
< | |||
Long Name | |||
< | </div> | ||
| id="tc1121379" style="background-color: none; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 2.0pt; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: middle; width: 198pt" | | |||
<div class="CellHeading"> | |||
Syntax, Example, and Notes | |||
</div> | |||
|- | |- | ||
| | | id="tc1121381" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
< | <div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | ||
| | |||
< | -h | ||
| | |||
</font></div> | |||
| id="tc1121383" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
>--help | |||
</font></div> | |||
| id="tc1121385" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody"> | |||
display usage | |||
</div> | |||
|- | |- | ||
| | | id="tc1121387" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
<font | |||
-f | |||
<font | </font></div> | ||
| id="tc1121389" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
--file | |||
</font></div> | |||
| id="tc1121391" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody"> | |||
use file as input stream | |||
</div> | |||
|- | |- | ||
| | | id="tc1121393" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
< | <div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | ||
| | |||
> -s | |||
</font></div> | |||
| id="tc1121395" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
<font | --server | ||
</font></div> | |||
| id="tc1121397" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody"> | |||
{host}[:{port}] server hostname and optional port | |||
</div> | |||
|- | |- | ||
| | | id="tc1121399" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
< | <div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | ||
| | |||
-l | |||
<font | </font></div> | ||
| id="tc1121401" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
<font | --ldap | ||
</font></div> | |||
| id="tc1121403" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody"> | |||
provision via LDAP instead of SOAP | |||
</div> | |||
|- | |- | ||
| | | id="tc1121405" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
<font | |||
-a | |||
<font | </font></div> | ||
| id="tc1121407" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
--account {name} | |||
<font | |||
| | </font></div> | ||
| id="tc1121409" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody"> | |||
account name to auth as | |||
</div> | |||
|- | |- | ||
| | | id="tc1121411" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
-p | |||
<font | </font></div> | ||
| | | id="tc1121413" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
<font | |||
--password {pass} | |||
<font | </font></div> | ||
| | | id="tc1121415" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody"> | |||
< | |||
password for account | |||
</div> | |||
|- | |- | ||
| | | id="tc1121417" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
-P | |||
<font | </font></div> | ||
| id="tc1121419" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | |||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
<font | |||
--passfile {file} | |||
<font | </font></div> | ||
| | | id="tc1121421" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody"> | |||
< | |||
read password from file | |||
</div> | |||
|- | |- | ||
| | | id="tc1121423" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
-z | |||
<font | </font></div> | ||
| | | id="tc1121425" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
<font | |||
--zadmin | |||
<font | </font></div> | ||
| | | id="tc1121427" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody"> | |||
< | |||
use zimbra admin name/password from localconfig for admin/password | |||
</div> | |||
|- | |- | ||
| | | id="tc1121429" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
-v | |||
<font | </font></div> | ||
| | | id="tc1121431" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
--verbose | |||
<font | </font></div> | ||
| | | id="tc1121433" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody"> | |||
< | |||
verbose mode (dumps full exception stack trace) | |||
</div><div class="CellBody"> | |||
</div> | |||
|- | |- | ||
| | | id="tc1121435" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
-d/ | |||
<font | </font></div> | ||
| | | id="tc1121437" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody" style="font-style: normal; font-variant: normal; font-weight: normal; margin-bottom: 3.0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> | |||
< | |||
--debug | |||
<font | </font></div> | ||
| | | id="tc1121439" style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: pt; padding-left: pt; padding-right: pt; padding-top: pt; vertical-align: top" | | ||
<div class="CellBody"> | |||
< | |||
debug mode (dumps SOAP messages) | |||
</div><div class="CellBody"> | |||
</div> | |||
|} | |} | ||
< | <div class="Body"> | ||
The commands in the following table are divided into the following tasks types - Account, Calendar Resources, Config, COS, Distribution List, Documents, Domain, Server, and Miscellaneous. | |||
</div><div class="HeadingCLI"> | |||
====Examples==== | |||
</div> | |||
< | |||
* <div class="HeadingCLI">Create one account with a password that is assigned to the default COS.</div> | |||
<div class="CLI_indented_command"> | |||
zmprov ca name@domain.com password | |||
</div> | |||
* <div class="CLI_indented_command">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 <span class="Code">gc <COSname>.</span></div> | |||
<div class="CLI_indented_command"> | |||
zmprov ca name@domain.com password zimbraCOS cosIDnumberstring | |||
</div> | |||
* <div class="CLI_indented_command">Create one account when the password is not authenticated internally.</div> | |||
<div class="CLI_indented_command"> | |||
zmprov ca name@domain.com ‘’ | |||
</div><div class="NumberedCont"> | |||
The empty single quote is required and indicates that there is no local password. | |||
</div> | |||
* <div class="NumberedCont">Use a batch process to create accounts, see Managing the Zimbra Collaboration Suite chapter for the procedure.</div> | |||
* <div class="NumberedCont">Add an alias to an account.</div> | |||
<div class="CLI_indented_command"> | |||
zmprov aaa accountname@domain.com aliasname@domain.com | |||
</div> | |||
* <div class="CLI_indented_command">Create distribution list. The ID of the distribution list is returned.</div> | |||
< | <div class="CLI_indented_command"> | ||
zmprov cdl listname@domain.com | |||
</ | </div> | ||
* <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 | |||
</ | </div> | ||
* <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 | |||
</ | </div> | ||
< | * <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 | |||
< | </div> | ||
< | * <div class="CLI_indented_command">Set the default domain.</div> | ||
< | <div class="CLI_indented_command"> | ||
zmprov mcf zimbraDefaultDomain domain1.com | |||
< | </div> | ||
< | * <div class="CLI_indented_command">To list all COSs and their attribute values. </div> | ||
< | <div class="CLI_indented_command"> | ||
zmprov gac -v | |||
< | </div> | ||
< | * <div class="CLI_indented_command">To list all COSs and their attribute values. </div> | ||
< | <div class="CLI_indented_command"> | ||
zmprov gaa domain.com | |||
< | </div> | ||
< | * <div class="CLI_indented_command">To list all user accounts and their configurations</div> | ||
< | <div class="CLI_indented_command"> | ||
zmprov gaa -v domain.com | |||
< | </div> | ||
< | * <div class="CLI_indented_command">To enable logger on a single server</div> | ||
< | <div class="CLI_indented_command"> | ||
zmprov +zimbraServiceEnabled logger | |||
< | </div><div class="NumberedCont"> | ||
< | 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="Bulleted2_outer" style="margin-left: 15pt; margin-bottom: 2.0pt; margin-top: 5.0pt; vertical-align: baseline"> | ||
< | {| id="SummaryNotRequired_np1121828" | ||
|- style="vertical-align: baseline" | |||
| | |||
<div class="Bulleted2_inner" style="width: 14.4pt; white-space: nowrap; font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="BulletSymbol">• </span></font>'''</div> | |||
| width="100%" | | |||
<div class="Bulleted2_inner" style="font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="Code">${SENDER_ADDRESS} </span></font>'''</div> | |||
|} | |||
</ | </div><div class="Bulleted2_outer" style="margin-left: 15pt; margin-bottom: 2.0pt; margin-top: 5.0pt; vertical-align: baseline"> | ||
{| | {| id="SummaryNotRequired_np1121832" | ||
|- | |- style="vertical-align: baseline" | ||
| | | | ||
<font | <div class="Bulleted2_inner" style="width: 14.4pt; white-space: nowrap; font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="BulletSymbol">• </span></font>'''</div> | ||
| < | | width="100%" | | ||
<div class="Bulleted2_inner" style="font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="Code">${RECIPIENT_ADDRESS} </span></font>'''</div> | |||
|} | |} | ||
< | </div><div class="Bulleted2_outer" style="margin-left: 15pt; margin-bottom: 2.0pt; margin-top: 5.0pt; vertical-align: baseline"> | ||
< | {| id="SummaryNotRequired_np1121843" | ||
|- style="vertical-align: baseline" | |||
| | |||
<div class="Bulleted2_inner" style="width: 14.4pt; white-space: nowrap; font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="BulletSymbol">• </span></font>'''</div> | |||
| width="100%" | | |||
<div class="Bulleted2_inner" style="font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="Code">${RECIPIENT_DOMAIN} </span></font>'''</div> | |||
|} | |||
</ | </div><div class="Bulleted2_outer" style="margin-left: 15pt; margin-bottom: 2.0pt; margin-top: 5.0pt; vertical-align: baseline"> | ||
{| | {| id="SummaryNotRequired_np1121844" | ||
|- | |- style="vertical-align: baseline" | ||
| | | | ||
<font | <div class="Bulleted2_inner" style="width: 14.4pt; white-space: nowrap; font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="BulletSymbol">• </span></font>'''</div> | ||
| < | | width="100%" | | ||
<div class="Bulleted2_inner" style="font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="Code">${NOTIFICATION_ADDRESSS} </span></font>'''</div> | |||
|} | |} | ||
< | </div><div class="Bulleted2_outer" style="margin-left: 15pt; margin-bottom: 2.0pt; margin-top: 5.0pt; vertical-align: baseline"> | ||
< | {| id="SummaryNotRequired_np1121845" | ||
|- style="vertical-align: baseline" | |||
| | |||
<div class="Bulleted2_inner" style="width: 14.4pt; white-space: nowrap; font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="BulletSymbol">• </span></font>'''</div> | |||
| width="100%" | | |||
<div class="Bulleted2_inner" style="font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="Code">${SUBJECT} </span></font>'''</div> | |||
|} | |||
</ | </div><div class="Bulleted2_outer" style="margin-left: 15pt; margin-bottom: 2.0pt; margin-top: 5.0pt; vertical-align: baseline"> | ||
{| | {| id="SummaryNotRequired_np1121846" | ||
|- | |- style="vertical-align: baseline" | ||
| | | | ||
<font | <div class="Bulleted2_inner" style="width: 14.4pt; white-space: nowrap; font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="BulletSymbol">• </span></font>'''</div> | ||
| < | | width="100%" | | ||
<div class="Bulleted2_inner" style="font-style: normal; font-variant: normal; text-transform: none">'''<font color="#000000"><span class="Code">${NEWLINE}</span></font>'''</div> | |||
|} | |} | ||
< | </div><div class="bullet1continued"> | ||
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 <span class="Code">zmprov mc</span>. The command is written on one line. | |||
< | </div><div class="CLI_indented_command"> | ||
zmprov ma name@domain.com zimbraNewMailNotificationBody ‘Important message from ${SENDER_ADDRESS}.${NEWLINE}Subject:${SUBJECT}’ | |||
</ | </div> |
Revision as of 20:46, 11 September 2006
zmprov (Provisioning)
The zmprovtool performs all provisioning tasks in Zimbra LDAP, including creating accounts, aliases, domains, 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:
- ModifyAccount
- ModifyDomain
- ModifyCos
- ModifyServer
- ModifyConfig
- ModifyDistributionList
- ModifycalendarResource
The following example could add the attribute zimbraZimlet UserProperties with the value 'testing" to user 1 and would not chagne the value of any other instance of that attribute.
zmprov ma user1 +zimbraZimletUserProperties testing
Short Name |
Long Name |
Syntax, Example, and Notes |
-h |
>--help |
display usage |
-f |
--file |
use file as input stream |
> -s |
--server |
{host}[:{port}] server hostname and optional port |
-l |
--ldap |
provision via LDAP instead of SOAP |
-a |
--account {name} |
account name to auth as |
-p |
--password {pass} |
password for account |
-P |
--passfile {file} |
read password from file |
-z |
--zadmin |
use zimbra admin name/password from localconfig for admin/password |
-v |
--verbose |
verbose mode (dumps full exception stack trace) |
-d/ |
--debug |
debug mode (dumps SOAP messages) |
The commands in the following table are divided into the following tasks types - Account, Calendar Resources, Config, COS, Distribution List, Documents, Domain, Server, and Miscellaneous.
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 zimbraCOS cosIDnumberstring
- Create one account when the password is not authenticated internally.
zmprov ca name@domain.com ‘’
The empty single quote is required and indicates that there is no local password.
- Use a batch process to create accounts, see Managing the Zimbra Collaboration Suite chapter 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 COSs and their attribute values.
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.
- 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}’