Zimbra CLI Commands

Using non-ASCII Characters in CLIs

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
zmgsautil
zmldappasswd
zmlocalconfig
zmmailbox
zmtlsctl
zmhsm
zmlicense
zmmetadump
zmmypasswd
zmplayredo
zmproxyconfgen
zmproxypurge
zmredodump
zmskindeploy
zmsoap
zmstat-chart
zmstat-chart-config
zmstatctl
zmthrdump
zmtrainsa
zmtzupdate
zmvolume
zmzimletctl
zmproxyconfig
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

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

zmauditswatchctl Start, stop, restart, reload, status of

the auditswatch

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

zmcertmgr Manage self-signed and commercial certificates

zmclamdctl Start, stop, or find the status of Clam AV

zmcleaniplanetics Clean iPlanet ICS calendar files

zmcontrol (Start/Stop Start, stop, status of the Zimbra servers. Also

Service)
 can use to find the Zimbra version installed.

zmconvertctl Start, stop, the conversion server or find the status

of the converted attachments conversion/indexing

zmdumpenv General information about the server environment

is displayed

zmgsautil Create, delete the GAL sync account and

initiate manual syncs.

zmhostname Find the hostname of the Zimbra server

zmhsm Start, stop and status of a HSM session.

zmitemdatafile Extracts and packs tgz files that ZCS uses

for REST import/export

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

zmloggerhostmap Used to manually map a DNS hostname to

a zmhostname.
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 Used to move selected mailboxes from

(Move Mailbox) one Zimbra server to another.

zmmboxsearch (Cross Search across mailboxes to find messages

Mailbox Search) and attachments

zmmetadump Support tool that dumps an item’s metadata in

a human-readable form

zmmtaconfigctl Start, stop, or find the status of the

MTA configuration daemon

zmmtactl Start, stop, or find the status of the MTA

zmmypasswd Trace messages

zmmypasswd Change MySQL passwords

zmmysqlstatus Status of mailbox SQL instance

zmperditionctl Start, stop, or find the status of the perdition

IMAP proxy

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.
zmprov (Provisioning) Performs all provisioning tasks in Zimbra
LDAP, including creating accounts, domains,
distribution lists and aliases

zmproxyconfgen Generates configuration for the nginx proxy

zmproxyctl Start, stop, restart, and find the status of the

IMAP proxy service

zmproxypurge Purges POP/IMAP routing information from one or

more memcached servers

zmpython Ability to write Python scripts that access

Zimbra Java libraries. It sets the ZCS class path
and starts the Jython interpreter.

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 Performs full restore when the Zimbra server

(Offline Restore) (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

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

zmstat-chart-config Outputs an XML configuration that describes

the current state of the data gathered from zmstat-
chart to generate charts on the administration
console.

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

Using non-ASCII Characters in CLIs

If you use non-ASCII characters in the CLI, in order for the characters to display
correctly, you must change this setting to the desired UTF-8 before running the CLI
command. To change this, type
export LC_All=<UTF_locale>
Important: The default locale on the zimbra user system account is  LANG=C. This
setting is necessary for starting ZCS services. Changing the default LANG=C setting
may cause performance issues with amavisd-new and the IM services may fail to
start.