6/5/13

Zimbra CLI Commands

ZCS Administrator's Guide, Open Source Edition, 6.0.8

Appendix A Command-Line Utilities : Zimbra CLI Commands

Zimbra CLI Commands

Using non-ASCII Characters in CLIs zmprov (Provisioning) zmaccts zmcalchk zmcontrol (Start/Stop Service) zmcertmgr zmgsautil zmldappasswd zmlocalconfig zmmailbox zmtlsctl zmmetadump zmmypasswd zmproxyconfgen zmproxypurge 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
ldap ldapsearch

Description Start, stop, or find the status of Zimbra LDAP Perform a search on an LDAP server
1/5

www.zimbra.com/docs/os/6.0.8/administration_guide/A_app-command-line.13.03.html

6/5/13

Zimbra CLI Commands

logmysqladmin

Send myslqadmin commands to the logger mysql Start, stop, find the status of the mailboxd server Enters interactive command-line MySQL session with the mailbox mysql Start, stop the SQL instance for the mailbox package Send admin commands to MySQL Postfix command to view or modify the postfix configuration Start, stop, reload, flush, check, upgradeconfiguration of postfix Examine postfix queue in relation to time and sender/recipient domain Lists the accounts and gives the status of accounts on the domain Start, stop, restart, or find the status of the Amavis-D New Start, stop, reload, status for anti-spam service Start, stop, reload, status for the anti-virus service Start, stop, reload, or check status of Apache service (for spell check) Start, stop, restart, reload, status of the auditswatch Check consistency of appointments and attendees in the Zimbra calendar Manage self-signed and commercial certificates Start, stop, or find the status of Clam AV Clean iPlanet ICS calendar files 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 General information about the server environment is displayed
2/5

mailboxd mysql mysql.server mysqladmin postconf postfix qshape zmaccts zmamavisdctl zmantispamctl zmantivirusctl zmapachectl zmauditswatchctl zmcalchk zmcertmgr zmclamdctl zmcleaniplanetics zmcontrol (Start/Stop Service) zmconvertctl

zmdumpenv

www.zimbra.com/docs/os/6.0.8/administration_guide/A_app-command-line.13.03.html

6/5/13

Zimbra CLI Commands

zmgsautil

Create, delete the GAL sync account and initiate manual syncs. Find the hostname of the Zimbra server Extracts and packs tgz files that ZCS uses for REST import/export Execute Java with Zimbra-specific environment settings Changes the LDAP password Testing tool Used to set or get the local configuration of a Zimbra server Start, stop, reload, or find the status of the Zimbra logger service Used to manually map a DNS hostname to a zmhostname. Start, stop, status of the swatch that is monitoring logging Performs mailbox management tasks Start, stop, reload, or find the status of the mailbox components (mailboxd, MySQL, convert) Support tool that dumps an items metadata in a human-readable form Start, stop, or find the status of the MTA configuration daemon Start, stop, or find the status of the MTA Trace messages Change MySQL passwords Status of mailbox SQL instance Start, stop, or find the status of the perdition IMAP proxy Performs all provisioning tasks in Zimbra LDAP, including creating accounts, domains, distribution lists and aliases Generates configuration for the nginx proxy Start, stop, restart, and find the status of the IMAP proxy service
3/5

zmhostname zmitemdatafile zmjava zmldappasswd zmlmtpinject zmlocalconfig zmloggerctl zmloggerhostmap zmlogswatchctl zmmailbox zmmailboxdctl

zmmetadump zmmtaconfigctl zmmtactl zmmypasswd zmmypasswd zmmysqlstatus zmperditionctl zmprov (Provisioning)

zmproxyconfgen zmproxyctl

www.zimbra.com/docs/os/6.0.8/administration_guide/A_app-command-line.13.03.html

6/5/13

Zimbra CLI Commands

zmproxypurge zmpython

Purges POP/IMAP routing information from one or more memcached servers Ability to write Python scripts that access Zimbra Java libraries. It sets the ZCS class path and starts the Jython interpreter. Start, stop, or find the status of saslauthd (authentication) Used for other zm scripts, do not use Deploy skins for accounts from the command line Print mail, account, and admin information in the SOAP format Start, stop, or find the status of the spell check server Generate Zimbras SSH encryption keys Generate charts from zmstat data collected in a directory Generate an .xml file with data included from the account setup Outputs an XML configuration that describes the current state of the data gathered from zmstat-chart to generate charts on the administration console. Start, stop, check status, or rotate logs of zmstat data collectors Start, stop, or find the status of Zimbra store services Start, stop, or find the status of the Swatch process, which is used in monitoring Used to setup system log config file Initiate a thread dump and save the data to a file with a timestamp Set the Web server mode to the communication protocol options: HTTP, HTTPS or mixed Used to train the anti-spam filter to recognize what is spam or ham Provides mechanism to process timezone changes from the command line
4/5

zmsaslauthdctl zmshutil zmskindeploy zmsoap zmspellctl zmsshkeygen zmstat-chart zmstat-chart-config zmstat-chart-config

zmstatctl zmstorectl zmswatchctl zmsyslogsetup zmthrdump zmtlsctl

zmtrainsa zmtzupdate

www.zimbra.com/docs/os/6.0.8/administration_guide/A_app-command-line.13.03.html

6/5/13

Zimbra CLI Commands

zmupdateauthkeys zmvolume zmzimletctl

Used to fetch the ssh encryption keys created by zmsshkeygen Manage storage volumes on your Zimbra Mailbox server 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.
Appendix A Command-Line Utilities : Zimbra CLI Commands

Copyright 2010 Zimbra Inc.

ZCS Administrator's Guide, Open Source Edition, 6.0.8

www.zimbra.com/docs/os/6.0.8/administration_guide/A_app-command-line.13.03.html

5/5