ZCS Administrator Guide 7.2.1

Open Source Edition

General Tool Information

The Zimbra command-line utilities follow standard UNIX command-line conventions.

Follow these guidelines when using the commands

CLI commands are run as the zimbra user, that is su - zimbra.

The actual CLI commands are case-sensitive. You must type them in lower case.

Press ENTER after you type a command.

Typing the CLI command and then - h displays the usage options for the command. Example: zmprov - h lists all the options available for the zmprov utility.

Each operation is invoked through command-line options. Many have a long name and a short name. For example, these two commands are equivalent:

zmprov createAccount joe@domain.com test123

zmprov ca joe@domain.com test123

Syntax Conventions

When demonstrating the syntax of each tool, the following conventions indicate required, optional, and alternate values:

{attribute} in curly brackets is required information.

[attribute] in square brackets are optional arguments or information.

{a|b|c} or [a|b|c] options separated by the pipe character | means “a” OR “b” OR “c”

For attribute names that may contain spaces, surround the name with double quotes.

Location of Command-Line Utilities

The command-line tools available for administrators are all located in the
/opt/zimbra/bin directory on the Zimbra server.