ZCS Administrator's Guide, Network Edition 5.0 (Rev May 2009)

Appendix A Command-Line Utilities

General Tool Information

Zimbra CLI Commands

zmprov (Provisioning)

zmaccts

zmarchive config

zmarchivectl

zmarchivesearch

zmbackup

zmblobchk

zmcalchk

zmschedulebackup

zmbackupabort

zmbackupquery

zmrestore

zmrestoreoffline (Offline Restore)

zmrestoreldap

zmcontrol (Start/Stop Service)

zmmailboxmove (Move Mailbox)

zmmboxsearch (Cross Mailbox Search)

zmcertmgr

zmldappasswd

zmlocalconfig

zmmailbox

zmtlsctl

zmhsm

zmlicense

zmmetadump

zmmsgtrace

zmmylogpasswd

zmmypasswd

zmplayredo

zmproxyconfgen

zmproxypurge

zmredodump

zmskindeploy

zmsoap

zmstat-chart

zmstat-chart-config

zmstatctl

zmthrdump

zmtrainsa

zmtzupdate

zmvolume

zmzimletctl

zmproxyinit

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:

•	Provisioning accounts*

•	Back up and restore

•	Starting and stopping a service

•	Move mailboxes

•	Cross mailbox searches

•	Installing self-signed certificates

•	Local configuration

*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

•	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.

Zimbra CLI Commands

The table below lists the CLI commands in /opt/zimbra/bin.

Table 1 zimbra CLI Commands

CLI	Description
ldap	Start, stop, or find the status of zimbra LDAP
ldapsearch	Perform a search on an LDAP server
logmysql	Start, stop, or find the status of the MySql session. Enters interactive command-line MySQL session with the logger mysql
logmysql.server	Start, stop the SQL instance for the logger package
logmysqladmin	Send myslqadmin commands to the logger mysql
mailboxd	Start, stop, find the status of the mailboxd server
mysql	Enters interactive command-line MySQL session with the mailbox mysql
mysql.server	Start, stop the SQL instance for the mailbox package
mysqladmin	Send admin commands to MySQL
postconf	Postfix command to view or modify the postfix configuration
postfix	Start, stop, reload, flush, check, upgrade-configuration of postfix
qshape	Examine postfix queue in relation to time and sender/recipient domain
zmaccts	Lists the accounts and gives the status of accounts on the domain
zmamavisdctl	Start, stop, restart, or find the status of the Amavis-D New
zmantispamctl	Start, stop, reload, status for anti-spam service
zmantivirusctl	Start, stop, reload, status for the anti-virus service
zmapachectl	Start, stop, reload, or check status of Apache service (for spell check)
zmarchive config	Command to view, modify, or configure archiving
zmarchivectl	Start, stop, reload, status for archiving
zmarchivesearch	Search archives on the account
zmbackup	Performs full backups and incremental backups for a designated mail host.
zmbackupabort	Stops a backup that is in process.
zmbackupquery	Find a specific full backup set
zmblobchk	Check consistency of the Zimbra blob store
zmcalchk	Check consistency of appointments and attendees in the Zimbra calendar
zmclamdctl	Start, stop, or find the status of Clam AV
zmcleaniplanetics	Clean iPlanet ICS calendar files
zmcontrol (Start/Stop Service)	Start, stop, status of the Zimbra servers. Also can use to find the Zimbra version installed.
zmconvertctl	Start, stop, the conversion server or find the status of the converted attachments conversion/indexing
zmcertmgr	Manage self-signed and commercial certificates
zmdumpenv	General information about the server environment is displayed
zmhostname	Find the hostname of the Zimbra server
zmhsm	Start, stop and status of a HSM session.
zmjava	Execute Java with Zimbra-specific environment settings
zmldappasswd	Changes the LDAP password
zmlicense	View and install your Zimbra license
zmlmtpinject	Testing tool
zmlocalconfig	Used to set or get the local configuration of a Zimbra server
zmloggerctl	Start, stop, reload, or find the status of the Zimbra logger service
zmlogswatchctl	Start, stop, status of the swatch that is monitoring logging
zmmailbox	Performs mailbox management tasks
zmmailboxdctl	Start, stop, reload, or find the status of the mailbox components (mailboxd, MySQL, convert)
zmmailboxmove (Move Mailbox)	Used to move selected mailboxes from one Zimbra server to another.
zmmboxsearch (Cross Mailbox Search)	Search across mailboxes to find messages and attachments
zmmetadump	Support tool that dumps an item’s metadata in a human-readable form
zmmsgtrace	Trace messages
zmmtaconfigctl	Start, stop, or find the status of the MTA configuration daemon
zmmtactl	Start, stop, or find the status of the MTA
zmmylogpasswd	Change logger MySQL password
zmmypasswd	Change MySQL passwords
zmmysqlstatus	Status of mailbox SQL instance
zmperditionctl	Start, stop, or find the status of the perdition IMAP proxy
zmprov (Provisioning)	Performs all provisioning tasks in Zimbra LDAP, including creating accounts, domains, distribution lists and aliases
zmproxyctl	Start, stop, restart, and find the status of the IMAP proxy service
zmplayredo	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.
zmproxyconfgen	Generates configuration for the nginx proxy
zmproxypurge	Purges POP/IMAP routing information from one or more memcached servers
zmredodump	Support tool for dumping contents of a redolog file for debugging purposes
zmrestore	Performs full restores and incremental restores for a designated mail host
zmrestoreldap	Restore accounts from the LDAP backup
zmrestoreoffline (Offline Restore)	Performs full restore when the Zimbra server (i.e., the mailboxd process) is down
zmsaslauthdctl	Start, stop, or find the status of saslauthd (authentication)
zmschedulebackup	Schedule backups and add the command to your cron table
zmshutil	Used for other zm scripts, do not use
zmskindeploy	Deploy skins for accounts from the command line
zmsoap	Print mail, account, and admin information in the SOAP format
zmspamextract	Retrieve spam and relocate it to a specified directory
zmspellctl	Start, stop, or find the status of the spell check server
zmsshkeygen	Generate Zimbra’s SSH encryption keys
zmstat-chart	Generate charts from zmstat data collected in a directory
zmstat-chart-config	Generate an .xml file with data included from the account setup
zmstatctl	Start, stop, check status, or rotate logs of zmstat data collectors
zmstorectl	Start, stop, or find the status of Zimbra store services
zmswatchctl	Start, stop, or find the status of the Swatch process, which is used in monitoring
zmsyslogsetup	Used to setup system log config file
zmthrdump	Initiate a thread dump and save the data to a file with a timestamp
zmtlsctl	Set the Web server mode to the communication protocol options: HTTP, HTTPS or mixed
zmtrainsa	Used to train the anti-spam filter to recognize what is spam or ham
zmtzupdate	Provides mechanism to process timezone changes from the command line
zmupdateauthkeys	Used to fetch the ssh encryption keys created by zmsshkeygen
zmvolume	Manage storage volumes on your Zimbra Mailbox server
zmzimletctl	Deploy and configure Zimlets

ZCS Administrator's Guide, Network Edition 5.0 (Rev May 2009)