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


Appendix A Command-Line Utilities

Appendix A Command-Line Utilities
Command Line Interface (CLI) can be used to create, modify and delete certain features and functions of the zimbra Collaboration Suite. The administration console is the main tool for maintaining the Zimbra Collaboration Suite, but some functions can only be changed from the CLI utility.
The CLI utility can be used for the following:
*In general, provisioning and managing accounts should be performed from the administration console, but bulk provisioning can be done from the CLI
General Tool Information
The Zimbra command-line utilities follow standard UNIX command-line conventions.
Follow these guidelines when using the commands
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”
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.
Zimbra CLI Commands
The table below lists the CLI commands in /opt/zimbra/bin.
Start, stop, or find the status of the MySql session. Enters interactive command-line MySQL session with the logger mysql
Check consistency of appointments and attendees in the Zimbra calendar
Start, stop, status of the Zimbra servers. Also can use to find the Zimbra version installed.
Start, stop, the conversion server or find the status of the converted attachments conversion/indexing
Start, stop, reload, or find the status of the mailbox components (mailboxd, MySQL, convert)
Performs all provisioning tasks in Zimbra LDAP, including creating accounts, domains, distribution lists and aliases
Performs data restore using backed up snapshots taken periodically. Users who use snapshots to backup and restore their information from a standby site use this command.
Start, stop, or find the status of the Swatch process, which is used in monitoring
Set the Web server mode to the communication protocol options: HTTP, HTTPS or mixed
Provides mechanism to process timezone changes from the command line

Appendix A Command-Line Utilities

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