- General Tool Information
- Zimbra CLI Commands
- Using non-ASCII Characters in CLIs
- zmprov (Provisioning)
- zmaccts
- zmarchiveconfig
- zmarchivectl
- zmarchivesearch
- zmbackup
- zmblobchk
- zmcalchk
- zmschedulebackup
- zmbackupabort
- zmbackupquery
- zmrestore
- zmrestoreoffline (Offline Restore)
- zmrestoreldap
- zmcontrol (Start/Stop/Restart Service)
- zmmboxsearch (Cross Mailbox Search)
- zmmboxmove
- zmmboxmovequery
- zmpurgeoldmbox
- 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
- zmsyncreverseproxy
Command Line Interface (CLI) can be used to create, modify and delete certain features and functions of the {product-name}. The Administration Console is the main tool for maintaining the {product-name}, but some functions can only be changed from the CLI utility.
The CLI utility can be used for the following purposes:
-
Provisioning accounts
-
Backup and Restore
-
Starting and stopping a service
-
Move mailboxes
-
Cross-mailbox searches
-
Installing self-signed certificates
-
Local configuration
|
Note
|
In general, provisioning and managing accounts should be performed from the Administration Console. |
The {product-name} command-line utilities follow standard UNIX command-line conventions. Use the following general guidelines with the CLI:
-
CLI commands are run as the zimbra user:
su - zimbrA -
The CLI commands are case-sensitive. You must type them in lower case.
-
Press ENTER after you type a command.
-
To display usage information about a command, type the CLI command with
- h.Example:
zmprov - hlists all the options available for thezmprovutility. -
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 [email protected] test123 zmprov ca [email protected] test123
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.
The table below lists the CLI commands in /opt/zimbra/bin.
| CLI | Description |
|---|---|
|
Send admin commands to anti=spam MySQL server |
|
Enters interactive command-line MySQL session with the mailbox mysql |
|
Start, stop the SQL instance for the mailbox package |
|
Start, stop, or find the status of Zimbra LDAP |
|
Perform a search on an LDAP server |
|
Send myslqadmin commands to the logger mysql |
|
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, upgrade-configuration of postfix |
|
Examine postfix queue in relation to time and sender/recipient domain |
|
Lists the accounts and gives the status of accounts on 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 |
|
Changes anti-spam MySQL database password |
|
Start, stop, reload, or check status of Apache service (for spell check) |
|
Command to view, modify, or configure archiving |
|
Start, stop, reload, status for archiving |
|
Search archives on the account |
|
Start, stop, restart, reload, status of the auditswatch |
|
Performs full backups and incremental backups for a designated mail host. |
|
Stops a backup that is in process. |
|
Find a specific full backup set |
|
Check consistency of the Zimbra blob store |
|
Check consistency of appointments and attendees in the Zimbra calendar |
|
Start, stop, and restart the cluebringer policyd service, if enabled |
|
Start, stop, kill, restart status of the MTA configuration daemon. |
|
Manage self-signed and commercial certificates |
|
Start, stop, or find the status of Clam AV |
|
Clean iPlanet ICS calendar files |
`zmcontrol (Start/Stop/Restart Service) |
Start, stop, restart, 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 |
|
Number of unique ActiveSync device IDs per server |
|
(get devices count) gives the total devices system wide without the need of specifying individual servers. |
|
General information about the server environment is displayed |
|
Global Address Book (GAL) synchronization command line utility. Create, delete the GAL sync account and initiate manual syncs. |
|
Find the hostname of the Zimbra server |
|
Start, stop and status of a HSM session. |
|
Extracts and packs tgz files that {product-abbrev} uses for REST import/export |
|
Execute Java with Zimbra-specific environment settings |
|
Execute Java and Zimbra-specific environment settings including extension based jars. |
|
Changes the LDAP password |
|
View and install your Zimbra license |
|
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 (zmmailboxd, MySQL, convert) |
|
Search across mailboxes to find messages and attachments |
|
7.1.3 and later. Used to move selected mailboxes from one Zimbra server to another. |
|
7.1.3 and later. Used to query ongoing mailbox moves on a server |
|
7.1.3 and later. Purges a mailbox from the old server after a mailbox move |
|
Start, stop, and restart |
|
Support tool that dumps an item’s metadata in a human-readable form |
|
Start, stop, and restart the zimbra milter server if enabled |
|
Beginning in {product-abbrev} 7.0, this command is not used. Use |
|
Start, stop, or find the status of the MTA |
|
Change MySQL passwords |
|
Status of mailbox SQL instance |
|
Command line utility to output the reverse proxy configuration |
|
Start, stop, and restart the zimbra reverse proxy |
|
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. |
|
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 |
|
Purges POP/IMAP routing information from one or more memcached servers |
|
Ability to write Python scripts that access Zimbra Java libraries. It sets the {product-abbrev} class path and starts the Jython interpreter. |
|
Support tool for dumping contents of a redolog file for debugging purposes |
|
Performs full restores and incremental restores for a designated mail host |
|
Restore accounts from the LDAP backup |
|
Performs full restore when the Zimbra server (i.e., the mailboxd process) is down |
|
Start, stop, or find the status of saslauthd (authentication) |
|
Schedule backups and add the command to your cron table |
|
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 Zimbra’s SSH encryption keys |
|
Generate charts from zmstat data collected in a directory |
|
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 |
|
Decodes the sync request/responses and logs them when verbose mode is turned on. |
|
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 time zone changes from the command line |
|
Used to fetch the ssh encryption keys created by |
|
Manage storage volumes on your Zimbra Mailbox server |
|
Deploy and configure Zimlets |
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 {product-abbrev} services. Changing the default LANG=C setting may cause performance issues with amavisd-new. |
The zmprov tool performs all provisioning tasks in Zimbra LDAP, including
creating accounts, aliases, domains, COS, distribution lists, and calendar
resources. Each operation is invoked through command-line options, each of
which has a long name and a short name.
The syntax is zmprov [cmd] [argument].
The syntax for modify can include the prefix “+” or “-” so that you can make changes to the attributes affected and do not need to reenter attributes that are not changing.
-
Use
+to add a new instance of the specified attribute name without changing any existing attributes. -
Use
-to remove a particular instance of an attribute.
The following example would add the attribute zimbraZimletUserProperties
with the value "blue" to user 1 and would not change the value of any other
instances of that attribute.
zmprov ma user1 +zimbraZimletUserProperties "com_company_testing:favoriteColor:blue"The attributes for the tasks zmprov can be used with are listed when you
type zmprov -h. The task area divided into the following sections:
| Long Name | Syntax, Example, and Notes |
|---|---|
|
display usage |
|
use file as input stream |
|
{host}[:{port}] server hostname and optional port |
|
provision via LDAP instead of SOAP |
|
log 4j property file, valid only with |
|
account name to auth as |
|
password for account |
|
read password from file |
|
use Zimbra admin name/password from localconfig for admin/password |
|
use auth token string (has to be in JSON format) from command line |
|
use auth token string (has to be in JSON format) from command line |
|
verbose mode (dumps full exception stack trace) |
|
debug mode (dumps SOAP messages) |
|
use LDAP master. This only valid with |
|
allow replacement of safe-guarded multi-value attribute configured in
localconfig key |
The commands are categorized and briefly described in the following topics:
zmprov — Account Provisioning Commands
| Commnad | Syntax | Example/Notes | ||
|---|---|---|---|---|
|
{name@domain | id | adminName} {alias@domain} |
zmprov aaa [email protected] [email protected] |
||
|
{name@doman | id} {password} |
zmprov cps [email protected] test123
|
||
|
{name@domain} {password} [attribute1 value1 etc] |
zmprov ca [email protected] test123 displayName JSmith |
||
|
{name@domain} {ds-type} {ds-name} zimbraDataSourceEnabled {TRUE | FALSE} zimbraDataSourceFolderId {folder-id} [attr1 value1 [attr2 value2…]] |
|||
|
{name@domain} {identity-name} [attr1 value1 [attr2 value2…]] |
|||
|
{name@domain} {signature-name} [attr1 value1 [attr2 value2…]] |
|||
|
{name@domain | id | adminName} |
zmprov da [email protected] |
||
|
{name@domain | id} {ds-name | ds-id} |
|||
|
{name@domain | id} {identity-name} |
|||
|
{name@domain | id} {signature-name} |
|||
|
{name@domain | id | adminName} |
zmprov ga [email protected] |
||
|
{name@domain | id} |
|||
|
[-v] [{domain}] |
Must include zmprov -l gaa
zmprov -l gaa -v domain.com |
||
|
zmprov gaaa |
|||
|
{name@domain | id} [arg 1 [arg 2…]] |
|||
|
{name@domain | id} [arg 1 [arg 2…]] |
|||
|
{name@domain | id} [arg 1 [arg 2…]] |
|||
|
{name@domain | id | adminName} [attribute1 value1 etc] |
zmprov ma [email protected] zimbraAccountStatus maintenance |
||
|
{name@domain | id} {ds-name | ds-id} [attr 1 value 1 [attr2 value 2…]] |
|||
|
{name@domain | id} {identity-name} [attr 1 value 1 [attr2 value 2…]] |
|||
|
{name@domain | id} {signature-name | signature-id} [attr 1 value 1 [attr 2 value 2…]] |
|||
|
{name@domain | id | adminName} {alias@domain} |
zmprov raa [email protected] [email protected] |
||
|
{name@domain | id} {newname@domain} |
zmprov ra [email protected] [email protected]
zmbackup -f -<servername.com> -a <[email protected]> |
||
|
{name@domain | id | adminName} {cos-name | cos-id} |
zmprov sac [email protected] FieldTechnician |
||
|
{name@domain | id | adminName} {password} |
zmprov sp [email protected] test321
|
zmprov — Calendar Resource Provisioning Commands
| Commnad | Syntax |
|---|---|
|
{name@domain} [attr1 value1 [attr2 value2…]] |
|
{name@domain | id} |
|
[-v] [{domain}] |
|
{name@domain | id} |
|
{name@domain | id} [attr1 value1 {attr2 value2…]] |
|
{name@domain} […] |
|
{name@domain | id} {newName@domain} |
zmprov — Free Busy Commands
| Commnad | Syntax |
|---|---|
|
[-v] |
|
[{provider-name}] |
|
{domain | account-id} [account-id…] |
|
{domain} |
|
[{provider-name}] |
zmprov — Domain Provisioning Commands
| Commnad | Syntax | Example/Notes | ||
|---|---|---|---|---|
|
{domain | id} |
This lists each COS, the COS ID and the number of accounts assigned to each COS |
||
|
{alias-domain-name} {local-domain-name | id} [attr1 value1 [attr2 value2…]] |
|||
|
{domain} [attribute1 value1 etc] |
zmprov cd mktng.domain.com zimbraAuthMech zimbra |
||
|
{domain | id} |
zmprov dd mktng.domain.com |
||
|
{domain | id} |
zmprov gd mktng.domain.com |
||
|
name | id | virtualHostname {value} [attr1 [attr2…]] |
|||
|
[-v] |
|||
|
{domain | id} [attribute1 value1 etc] |
zmprov md domain.com zimbraGalMaxResults 500
|
||
|
{domain | id} {newDomain} |
|
zmprov — COS Provisioning Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{src-cos-name | id} {dest-cos-name} |
|
|
{name} [attribute1 value1 etc] |
zmprov cc Executive zimbraAttachmentsBlocked FALSE zimbraAuthTokenLifetime 60m zimbraMailQuota 100M zimbraMailMessageLifetime 0 |
|
{name | id} |
zmprov dc Executive |
|
{name | id} |
zmprov gc Executive |
|
[-v] |
zmprov gac -v |
|
{name | id} [attribute1 value1 etc] |
zmprov mc Executive zimbraAttachmentsBlocked TRUE |
|
{name | id} {newName} |
zmprov rc Executive Business |
zmprov — Server Provisioning Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{name} [attribute1 value1 etc] |
|
|
{name | id} |
zmprov ds domain.com |
|
{name | id} |
zmprov gs domain.com |
|
[-v] |
zmprov gas |
|
{name | id} [attribute1 value1 etc] |
zmprov ms domain.com zimbraVirusDefinitionsUpdateFrequency 2h |
|
Used to publish into saslauthd.conf what servers should be used for saslauthd.conf MTA auth |
|
|
Used to list memcached servers (for nginix use). |
zmprov — Config Provisioning Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
[-v] |
All LDAP settings are displayed |
|
{name} |
|
|
attr1 value1 |
Modifies the LDAP settings. |
|
{short-name} {domain} {server} {classname} {category} {type} [attr value1 [attr2 value2…]] |
|
|
{xmpp-component-name} |
|
|
{name@domain} [attr1 [attr2 value2]] |
|
|
{name@domain} [attr1 [attr2 value2]] |
zmprov — Distribution List Provisioning Commands
| Commnad | Syntax | Example/Notes | ||
|---|---|---|---|---|
|
{list@domain} |
zmprov cdl [email protected] |
||
|
{list@domain | id} {member@domain} |
zmprov adlm [email protected] [email protected] |
||
|
{list@domain | id} |
zmprov rdlm [email protected] [email protected] |
||
|
[-v] |
|||
|
{name@domain | id} |
|
||
|
{list@domain | id} |
zmprov gdl [email protected] |
||
|
{list@domain | id} attr1 value1 {attr2 value2…} |
zmprov md [email protected] |
||
|
{list@domain | id} |
|||
|
{list@domain | id} {alias@domain} |
|||
|
{list@domain | id} {alias@domain} |
|||
|
{list@domain | id} {newName@domain} |
zmprov — Mailbox Commands
| Commnad | Syntax | Example/Notes | ||
|---|---|---|---|---|
|
{account} |
|||
|
{server} |
|||
|
{name@domain | id} {start | status | cancel} [{reindex-by} {value1} [value2…]] |
|||
RecalculateMailbox Counts (rmc) |
{name@domain | id} |
When unread message count and quota usage are out of sync with the data in the mailbox, use this command to immediately recalculate the mailbox quota usage and unread messages count.
|
||
|
{start | status | cancel} [{types | ids} {type or id} [type or id…]] |
|||
|
{name@domain | id} {start | status} |
|||
|
{name@domain | id} |
|||
|
{name@domain | id} |
|||
|
{account-name} [{zmmailbox commands}] |
zmprov — Miscellaneous Provisioning Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{type} [-d {domain | id}] |
|
|
{domain} {namemask} {number of accounts to create} |
|
|
[[-v] [-ni] [{entry-type}]] | [-a {attribute-name}] |
Prints all attribute names (account, domain, COS, servers, etc.). |
|
[-a] {acl | locale | skin | uistrings | license | all | account | config | glo | balgrant | cos | domain | galgroup | group | mime | server | zimlet | <extension-cache-type>} [name1 | id1 [name2 | i d2…]] |
Flush cached LDAP entries for a type. See Zimbra LDAP Service. |
|
{domain | id} |
Generates a pre-authentication key to enable a trusted third party to
authenticate to allow for single-sign on. Used in conjunction with
|
|
{domain | id} {name} {name | id | foreignPrincipal} {timestamp | 0} {expires | 0} |
Generates preAuth values for comparison. |
|
{domain} [{token}] |
|
|
[-s /--server hostname] {name@domain | id} |
zmprov — Logs Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{name@domain | id} {logging-category} {debug | info | warn | error} |
Creates custom logging for a single account. |
|
[-s/--server hostname] {name@domain | id} {logging-category} {debug | info | warn | error} |
|
|
[-s/--server hostname] |
Shows all individual custom logger account. |
|
[-s/ --server hostname] {name@domain | id} {logging-category} |
When name@domain is specified, removes the custom logger created for the account otherwise removes all accounts all account loggers from the system. |
|
[-s/--server hostname] |
This command removes all account loggers and
reloads |
See the zmprov Log Categories for a list of
logging categories.
zmprov — Search Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{domain} {name} |
|
|
{domain} {name} |
|
`searchAccounts (sa) |
[-v] {ldap-query} [limit] [offset] [sortBy {attribute}] [sortAscending 0 | 1] [domain {domain}] |
|
|
[-v] domain attr op value {attr op value…] |
zmprov—Share Provisioning Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{owner-name | owner-id} |
zmprov — Unified Communication Service Commands
| Commnad | Syntax | Example/Notes |
|---|---|---|
|
{name} [attr1 value1 [attr2 value2…]] |
|
|
{name | id} |
|
|
[-v] |
|
|
[-e] {name | id} [attr1 [attr2…]] |
|
|
{name | id} [attr1 value1 [attr2 value2…]] |
|
|
{name | id} {newName} |
zmprov — IMAP/POP Proxy Commands
| Commnad | Example/Notes |
|---|---|
|
Used to publish into nginx.conf the servers that should be used for reverse proxy lookup. |
`--getAllReverseProxy Backends (garpb) |
Returns the list of servers that have
Basically if a mailbox server is available for lookup requests from the proxy. |
`--getAllReverseProxyDomains (garpd) |
Returns a list of all domains configured with |
zmprov ca [email protected] passwordYou must know the COS ID number. To find a COS ID:
zmprov gc <COSname>
zmprov ca [email protected] password zimbraCOS cosIDnumberstringzmprov ca [email protected] ''The empty single quote is required and indicates that there is no local password.
See Provisioning User Accounts for the procedure.
See the Zimbra wiki page Bulk_Provisioning.
zmprov aaa [email protected] [email protected]zmprov cdl [email protected]The ID of the distribution list is returned.
zmprov adlm [email protected] [email protected]|
Tip
|
You can add multiple members to a list from the Administration Console. |
Use this command to change any password. Enter the address of the password to be changed.
zmprov sp [email protected] passwordzmprov cd marketing.domain.com zimbraAuthMech zimbrazmprov mcf zimbraDefaultDomain domain1.comzmprov gac -vzmprov gaa domain.comzmprov gaa -v domain.comzmprov ms server.com +zimbraServiceEnabled loggerThen type zmloggerctl start, to start the logger.
zmprov gs server.com attribute=valueFor example, zmprov gs example.com zimbraServiceEnabled=ldap to find out if the ldap service is enabled.
To modify the purge interval, set zimbraMailPurgeSleepInterval to the
duration of time that the server should "sleep" between every two
mailboxes.
zmprov ms server.com zimbraMailPurgeSleepInterval <Xm>X is the duration of time between mailbox purges; m represents minutes.You could also set <xh> for hours.
Modify zimbraNewMailNotification to customize the notification email
template. A default email is sent from Postmaster notifying users that
they have received mail in another mailbox. To change the template, you
modify the receiving mailbox account. The variables are
-
${SENDER_ADDRESS}
-
${RECIPIENT_ADDRESS}
-
${RECIPIENT_DOMAIN}
-
${NOTIFICATION_ADDRESSS}
-
${SUBJECT}
-
${NEWLINE}
You can specify which of the above variables appear in the Subject,
From, or Body of the email. The following example is changing the
appearance of the message in the body of the notification email that is
received at [email protected]. You can also change the template in a class
ofservice, use zmprov mc. The command is written on one line.
zmprov ma [email protected] zimbraNewMailNotificationBody 'Important message from ${SENDER_ADDRESS}.${NEWLINE}Subject:${SUBJECT}'zmprov mc <default> zimbingaFeatureCalendarReminderDeviceEmailEnabled TRUE
zmprov ma <user1> zimbraFeatureCalendarReminderDeviceEmailEnabled TRUE
zmprov md <domain> zimbraFeatureCalendarReminderDeviceEmailEnabled TRUEzmprov mc <default> zimbraFeaturePriorityInboxEnabled TRUE
zmprov ma <user1> zimbraFeaturePriorityInboxEnabled TRUESet the backup method in the global configuration, and you can override the configuration on a per server basis if you do not want a server to use the auto-grouped backup method.
To set up auto-grouped backup, you modify LDAP attributes using the zmprov CLI. Type the command as
zmprov mcf <ldap_attribute> <arg>You can also set the attributes at the server level using zmprov ms.
The following LDAP attributes are modified:
-
zimbraBackupMode— Set it to beAuto-Grouped. The default isStandard. -
zimbraBackupAutoGroupedInterval — Set this to the interval in either days or weeks that backup sessions should run for a group. The default is `1d. Backup intervals can be 1 or more days, entered asxd(1d); or 1 or more weeks, entered asxw(1w). -
zimbraBackupAutoGroupedNumGroups— This the number of groups to spread mailboxes over. The default is 7 groups.
Messages can be grouped into conversations by a common thread. The default is to thread messages in a conversation by the References header. If there is no References header, the Subject is used to determine the conversation thread. The default options can be changed from the COS or for individual accounts.
zmprov mc [cosname] zimbraMailThreadingAlgorithm [type]The types include:
-
none — no conversation threading is performed.
-
subject — the message will be threaded based solely on its normalized subject.
-
strict — only the threading message headers (References, In-Reply-To, Message-ID, and Resent-Message-ID) are used to correlate messages. No checking of normalized subjects is performed.
-
references — the same logic as "strict" with the constraints slightly altered so that the non-standard Thread-Index header is considered when threading messages and that a reply message lacking References and In-Reply-To headers will fall back to using subject-based threading.
-
subjrefs — the same logic as "references" with the further caveat thatchanges in the normalized subject will break a thread in two.
Run zmprov verifyIndex as a sanity check for the specified mailbox index.
Diagnostic information is written to stdout. If problems are detected, a
failure status is returned.
verifyIndex locks the index while it’s running, and checks every byte in
the index. Therefore, it’s not recommended to run this on a regular basis
such as in a cron job. The zmprov verifyIndex command should be used only
when you need to make a diagnosis.
zmprov verifyIndex <[email protected]>If verifyIndex reports that the index is corrupted, you can repair the
mailbox index by running reIndexMailbox (rim).
zmprov rim <[email protected]> startzmprov — Log Categories
|
Account operations |
|
ACL operations |
|
Backup and restore |
|
Inmemory cache operations |
|
Calendar operations |
|
DAV operations |
|
Database connection tracing |
|
Server extension loading |
|
Mail filtering |
|
GAL operations |
|
IMAP protocol operations |
|
Index operations |
|
Filesystem operations |
|
LDAP operations |
|
LMTP operations (incoming mail) |
|
General mailbox operations |
|
Miscellaneous |
|
Changes to mailbox state |
|
POP protocol operations |
|
Redo log operations |
|
Security events |
|
User session tracking |
|
SMTP operations (outgoing mail) |
|
SOAP protocol |
|
SQL tracing |
|
Mail store disk operations |
|
Sync client operations |
|
Startup/shutdown and other system messages |
|
Wiki operations |
|
Zimlet operations |
Use zmaccts to run a report that lists all the accounts, their status, when they were created and the last time anyone logged on. The domain summary shows the total number of accounts and their status.
Use zmarchiveconfig for configuring the archiving mailbox. It has the option of using short commands or full names for commands that lead to the same function being carried out.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Displays the usage options for this command |
|
|
(host)[:(port)] Displays the server hostname and optional port |
|
|
(name) Returns the value of the account name to be authorized |
|
|
Allows archiving to be provisioned via LDAP |
|
|
(pass) Returns the password for auth account |
|
|
(file) Allows password to be read from file |
|
|
Allows use of Zimbra admin/password from local |
|
|
Activates debug mode (dumps SOAP messages) |
Command in … |
||
|
[archive-address <aaddr> [archive-cos <cos>] [archive-create <TRUE/FALSE>] [archive-password <pa [zimbraAccountAttrName <archive-attr-value]+ |
|
|
||
Use zmarchivectl to start, stop, reload, or check the status of the Zimbra account archive.
Use zmarchivesearch to search across account archives. You can search for archives that match specific criteria and save copies to a directory.
zmarchivesearch {-m <[email protected]>} {-q <query_string>} [-o <offset>] [-l <limit>] [-d <output_directory>]| Long Name | Short Name | Description |
|---|---|---|
|
|
<arg> Directory to write messages to. If none is specified, then only the headers are fetched. Filenames are generated in the form RESULTNUM_ACCOUNT-ID_MAILITEMID |
|
|
Displays help messages |
|
|
<arg> Sets the limit for the number of results returned. The default is 25 |
|
|
<arg> Name of archive account to search |
|
|
<arg> Specifies where the hit list should begin. The default is 0 |
|
|
<arg> The query string for archive search |
|
|
<arg> Mail server hostname. Default is localhost |
|
|
Allows printing of status messages while the search is being executed |
zmarchivesearch -m [email protected] -q "in:sent" -o 0 -l 30 -d /var/tmpUse zmbackup to perform full backups and incremental backups for a designated mail host.
This utility has short option names and full names. The short option is
preceded by a single dash, while the full option is preceded by a double
dash. For example, -f is the same as --fullBackup.
| Long Name | Short Name | Description |
|---|---|---|
|
|
<arg> Account email addresses separated by white space or all for all accounts. This option is not specified for auto-grouped backups since the system knows which accounts to backup every night. |
|
|
Display diagnostics for debugging purposes. |
|
|
<arg> Deletes the backups including and prior to the specified label, date (YYYY/MM/DD[-hh:mm:ss]) or period (nn(d | m | y]). |
|
Exclude blobs from full backup. If unspecified, use server config |
|
|
Exclude blobs on HSM volumes from full backup; if unspecified, use server config |
|
|
Exclude search index from full backup; if unspecified, use server config |
|
|
|
Starts a full backup. In auto-grouped backup mode, this option also copies the redologs since the last backup (which is the main function of an incremental backup). |
|
|
Displays the usage options for this command. |
|
|
Starts an incremental backup. This option is not available in the auto-grouped backup mode. |
|
Include blobs in full backup. If this is unspecified, the server config is used. |
|
|
Include blobs on HSM volumes in full backup. If this is unspecified, the server config is used. |
|
|
Include search index in full backup. If this is unspecified, the server config is used. |
|
|
Backs up blobs as individual files rather than in zip files. |
|
|
|
<arg> Mail server host name. For format, use either the plain host name or the server.domain.com name. The default is the localhost name. |
|
|
Runs full backup synchronously. |
|
|
<arg> Specifies the target backup location. The default is
|
|
|
Backs up blobs in compressed zip files. Ignored if |
|
Backup blobs in zip file without compression. (default) |
In these examples, the server (-s) is server1.domain.com. The (-t)
is not required if the target is the default directory,
(zimbra_home/backup).
zmbackup -f -a all -s server1.domain.comzmbackup -i -a all -s server1.domain.comzmbackup -f -a [email protected] -s server1|
Note
|
Hostname does not need full domain if account is used. |
zmbackup -i -a [email protected] -s server1Use zmblobchk to check the consistency of the Zimbra blob store
(/opt/zimbra/store). This command checks and records notes of files
without matching database metadata. It also checks to make sure that size
information is correct for the files.
zmblobchk [options] startThe start command is required to avoid unintentionally running a blob check. The ID values are separated by commas.
| Long Name | Short Name | Description |
|---|---|---|
|
<path> Target directory for database export files. |
|
|
|
Displays help messages |
|
|
<mailbox-ids> Specify which mailboxes to check. If not specified, check all mailboxes. |
|
Delete any items that have a missing blob. |
|
|
Delete items without exporting |
|
|
Skip blob size check |
|
|
<path> Write the paths of any unexpected blobs to a file |
|
|
|
Display verbose output; display stack trace on error |
|
<volume-ids> Specify which volumes to check. If not specified, check all volumes |
Use zmcalchk to check the consistency of appointments on the Zimbra calendar and sends an email notification regarding inconsistencies. For example, it checks if all attendees and organizers of an event on the calendar agree on start/stop times and occurrences of a meeting.
See the output of *zmmailbox help appointmen*t for details on time-specs.
Use zmschedulebackup to schedule backups and add the command to your cron table.
The default schedule is as follows:
-
Full backup, every Saturday at 1:00 a.m. (
0 1 * * 6) -
Incremental backup, Sunday through Friday at 1:00 a.m. (
0 1 * * 0-5)
Each crontab entry is a single line composed of five fields separated by a blank space. Specify the fields as follows:
-
minute — 0 through 59
-
hour — 0 through 23
-
day of month — 1 through 31
-
month — 1 through 12
-
day of week — 0 through 7 (0 or 7 is Sunday, or use names)
Type an asterisk (*) in the fields you are not using.
This command automatically writes the schedule to the crontab.
| Name | Command Name | Description | ||
|---|---|---|---|---|
|
|
Displays the usage options for this command. |
||
|
|
Default command. Displays the existing Zimbra backup schedule. |
||
|
|
Save the schedule. Allows you to save the schedule command to a text file so that you can quickly regenerate the backup schedule when the system is restored. |
||
|
|
Removes the current schedule and cancels all scheduled backups. |
||
|
|
Adds an additional specified backup to the current schedule. |
||
|
|
Replaces the current schedule with the specified schedule. |
||
|
|
Replaces the current schedule with the default schedule. |
||
Options that will be passed to zmbackup |
||||
|
|
Backs up blobs as individual files rather than in zip files |
||
|
|
Backs up blobs in compressed zip files. Ignored if |
||
|
Backs up blobs in zip file without compression. |
|||
|
|
Can be used only to designate a full back target location. The default is
|
||
|
|
Account specific. The default is all accounts. |
||
|
Send an email report to the admin user. |
|||
|
server - Mail server hostname. Default is localhost. |
|||
|
Runs full backup synchronously. |
|||
|
Exclude blobs from full backup. If unspecified, server config is used. |
|||
|
Include blobs in full backup. If unspecified, the server config is used. |
|||
|
Exclude blobs on HSM volumes from full backup. If unspecified, the server config is used. |
|||
|
Include blobs on HSM volumes in full backup. If unspecified, the server config is used. |
|||
|
Exclude search index form full backup. If unspecified, the server config is used. |
|||
|
Include search index in full backup. If unspecified, the server config is used. |
|||
Cron schedule — backup-type: |
||||
|
|
Incremental backup is not used with the auto-grouped backup mode. |
||
|
|
Full backup |
||
|
|
Delete backups. |
||
zmschedulebackup -Dzmschedulebackup -R f ["schedule"]zmschedulebackup -A f ["schedule"]zmschedulebackup -A i ["schedule"]zmschedulebackup -qDisplay the schedules on one line as a command, so that they can be copied to a text file and saved to be used if the application needs to be restored.
zmschedulebackup -sUse zmbackupabort to stop a backup process. Before you can abort an
account you must know its backup label. This label is displayed after you
start the backup procedure. If you do not know the label, use
zmbackupquery to find the label name.
To stop the restore process:
The zmbackupabort -r interrupts an ongoing restore. The restore process
is stopped after the current account is restored. The command displays
message showing which accounts were not restored.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Display diagnostics for debugging purposes |
|
|
Displays the usage options for this command |
|
|
` <arg>` Label of the full backup to be aborted. Use the |
|
|
Abort the restore in process |
|
|
|
|
|
The default is |
Use zmbackupquery to find full backup sets. The command can be used to find a specific full backup set or full backup sets since a specific date, or all backup sets in the backup directory.
To find out the best full backup to use as the basis for point-in-time restore of an account, run a command like this:
zmbackupquery -a <account email> --type full --to <restore-to time>| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Display diagnostics for debugging purposes |
|
|
Displays the usage options for this command |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Returns detailed status information |
Specify date/time in one of these formats:
|
|
|
|
|
|
|
|
|
Specify year, month, date, hour, minute, second, and optionally millisecond.
Month/date/hour/minute/second are 0-padded to 2 digits, millisecond to 3 digits.
Hour must be specified in 24-hour format, and time is in local time zone.
Use zmrestore to perform full restores and incremental restores for a
designated mail host. You can either specify specific accounts, or, if no
accounts are specified, all accounts are in the backup are restored. In
addition, you can restore to a specific point in time.
This utility has short option names and full names. The short option is
preceded by a single dash, the full option is proceeded by a double dash.
For example, -rf is the same as --restorefullBackupOnly.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Replays the redo logs in backup only, which Only excludes archived and current redo logs of the system. |
|
|
Continue to restore other accounts when an error occurs. |
|
|
Restores accounts to target accounts whose names are prepended with prefix. (Can only be used in commands that use the |
|
|
Display diagnostics for debugging purposes. |
|
Do not restore blobs (HSM or not). |
|
|
Do not restore HSM blobs. |
|
|
Do not restore search index. |
|
|
|
Displays the usage options for this command. |
|
|
|
|
|
|
|
|
Restores the account in directory service. |
|
|
|
|
|
|
|
|
|
|
|
Restores to the full backup only, not any incremental backups since that backup. |
|
|
|
|
If true, do not execute delete operation during redo log replay. |
|
|
Do not restore if named accounts were deleted or did not exist at backup
time. (This option is always enabled with |
|
|
|
Restores global tables and local config. |
|
|
`
<arg>` Specifies the backup target location. The default is
|
Perform complete restore of all accounts on server1, including last full backup and any incremental backups since last full backup.
zmrestore -a all -s server1.domain.comPerform restore only to last full backup, excluding incremental backups since then, for all accounts on server1.
zmrestore -rf -a all -s server1.domain.comThe name of the new account will be [email protected].
zmrestore -a [email protected] -ca -pre new_Run zmresotreoffline when the Zimbra server (i.e., the mailbox process)
is down. The MySQL database for the server and the OpenLDAP directory
server must be running before you start the zmrestoreoffline command.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Replays the redo logs in backup only, which excludes archived and current redo logs of the system. |
|
|
Continue to restore other accounts when an error occurs. |
|
|
Restores accounts to new target accounts whose names are pre-pended with prefix. |
|
|
Display diagnostics for debugging purposes. |
|
|
Displays the usage options for this command. |
|
If true, ignore all errors during redo log replay. |
|
|
|
|
|
|
|
|
|
Restores the account in directory service. |
|
|
|
|
|
|
|
|
|
|
|
Restores to the full backup only, not any incremental backups since that backup. |
|
|
|
|
|
Do not restore if named accounts were deleted or did not exist at backup
time. (This option is always enabled with |
|
|
Restores global tables and local config. |
|
|
|
Before you begin zmrestoreoffline, the LDAP directory server must be
running.
Perform a complete restore of all accounts on server1, including last full backup and any incremental backups since last full backup.
zmrestoreoffline -s server1.domain.comUse zmrestoreldap to restore accounts from the LDAP backup.
| Short Name | Description |
|---|---|
|
|
|
|
|
Lists all session labels in backup. |
|
Lists accounts in file. |
|
|
Use zmcontrol to start, to stop, or to restart services. You can also
find which version of the {product-name} is installed.
| Long Name | Short Name | Description |
|---|---|---|
|
Displays {product-abbrev} software version. |
|
|
Displays the usage options for this command. |
|
|
Host name (localhost). |
|
Command in… |
||
|
Toggle maintenance mode. |
|
|
Restarts all services and manager on this host. |
|
|
Shutdown all services and manager on this host. When the manager is shutdown, you cannot query that status. |
|
|
Startup manager and all services on this host. |
|
|
Startup manager and all services on this host. |
|
|
Returns services information for the named host. |
|
|
Stop all services but leaves the manager running. |
|
Use zmmboxsearch is used to search across mailboxes. You can search
across mailboxes to find messages and attachments that match specific
criteria and save copies of these messages to a directory.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Displays help information. |
|
|
Sets the limit for the number of results returned. The default is 25. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Request that the status message print while the search is being executed. |
The following example is to do a cross-mailbox search in the inbox folder of two different mailboxes on the specified server and put a copy of the message in to the specified directory.
zmmboxsearch -m [email protected],[email protected] -q "in:inbox" -d /var/tmpUse zmmboxmove to move mailboxes. The destination server manages the
overall move process. Using the zmmboxmove command significantly reduces
the account lockout time.
The CLI command zmmboxmove is used to move mailboxes from one Zimbra
server to another. Mailboxes can be moved between Zimbra servers that
share the same LDAP server. All the files are copied to the new server and
the LDAP is updated. After the mailbox is moved to a new server a copy
still remains on the older server, but the status of the old mailbox is
closed. Users cannot log on and mail is not delivered. You should check
to see that all the mailbox content was moved successfully before purging
the old mailbox.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Displays the usage options for this command. |
|
|
|
|
|
|
|
|
Run synchronously |
Use zmmboxmovequery to query ongoing mailbox moves on a server, both
move-ins and move-outs.
Use zmpurgeoldmbox to purge the mailbox from the older server after a
mailbox move.
Use zmgsautil to create or delete the GAL sync account, and to force
syncing of the LDAP data to the GAL sync account.
A GAL sync account is created when the GAL is configured on a domain. This account is created and the polling interval for performing a full sync is managed from the Administration Console.
To see attributes and settings for a GAL sync account, run zmprov gds
against the account.
| Long Name | Description |
|---|---|
|
Creates the GAL sync account. This should be done from the Administration Console. The parameter "server" is required.
|
|
When configuring a datasource for a server, specify a folder name other
than
|
|
Deletes the GAL sync account and the references to the LDAP server. The account can also be deleted from the Administration Console.
|
|
This syncs new and updated contact data only.
The datasource ID the LDAP datasource ID. The datasource name is the name of the address book (folder) in the GAL account created to sync LDAP to. A cron job can be set up to run trickleSync. |
|
This syncs all LDAP contact data. You can also set this from the Administration Console.
|
|
This should be used to reload the entire GAL if there is change in the filter, attribute mapping or LDAP server parameters.
|
Use zmldappasswd to change the LDAP password on the local server. In
multi node environments, this command must be run on the LDAP master server
only.
This CLI command used with options changes other passwords.
For better security and audit trails the following passwords are generated in {product-abbrev}:
-
LDAP Admin password. This is the master LDAP password.
-
LDAP Root password. This is used for internal LDAP operations.
-
LDAP Postfix password. This is the password used by the postfix user toidentify itself to the LDAP serve and must be configured on the MTA server to be the same as the password on the LDAP master server.
-
LDAP Amavis password. This is the password used by the amavis userto identify itself to the LDAP server and must be configured on the MTA server to be the same as the password on the LDAP server.
-
LDAP Replication password. This is the password used by the LDAPreplication user to identify itself to the LDAP master and must be the same as the password on the LDAP master server.
| Name | Syntax, Example, Notes |
|---|---|
|
Displays the help. |
|
Changes |
|
Changes |
|
Changes |
|
Changes |
|
Changes |
|
Changes |
|
Updates the password in the config database on replicas. Must be used with
|
Only one of |
|
Use zmlocalconfig to set or get the local configuration for a zimbra
server. Use zmlocalconfig -i to see a list of supported properties that
can be configured by an administrator.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Show default values for keys listed in |
|
|
Edit the configuration file, change keys and values specified. The
|
|
|
Edit the keys whose change is known to be potentially dangerous. |
|
|
Shows the help for the usage options for this tool. |
|
|
Shows the list of supported properties. |
|
|
|
|
|
Shows the values for only those keys listed in the |
|
|
Shows which configuration file will be used. |
|
|
Suppress logging. |
|
|
This option is used with the edit option. Specified key is set to a random password string. |
|
|
Forces the display of the password strings. |
|
|
Remove a configuration key. If this is a key with compiled-in defaults, set its value to the empty string. |
|
|
Expand values. |
|
Allows control of the concurrency of Amavisd (default 10). |
|
|
Allows control of the concurrency of ClamAV (default 10). |
Use zmmailbox for mailbox management. The command can help
administrators provision new mailboxes along with accounts, debug issues
with a mailbox, and help with migrations.
You can invoke the zmmailbox command from within the zmprov command.
You enter selectMailbox within zmprov to access the zmmailbox command
connected to that specified mailbox. You can then enter zmmailbox
commands until you type exit. Exit returns you to zmprov. This is
useful when you want to create accounts and also pre-create some folders,
tags, or saved searches at the same time.
| Short Name | Long Name | Syntax, Example, and Notes |
|---|---|---|
|
|
Display usage. |
|
|
Use file as input stream. |
|
|
|
|
|
Account name to auth as |
|
|
Use zimbra admin name/password from localconfig for admin/password. |
|
|
Use authtoken string (has to be in JSON format) from command line. |
|
|
Use authtoken string (has to be in JSON format) from command line. |
|
|
Mailbox to open. Can be used as both authenticated and targeted unless other options are specified. |
|
Account name to authorize as. Defaults to
|
|
|
|
Execute requests with admin privilege. |
|
|
Password for admin account and or mailbox. |
|
|
Read password from file. |
|
|
Timeout (in seconds). |
|
|
Verbose mode (dumps full exception stack trace) |
|
|
Debug mode (dumps SOAP messages) |
Specific CLI tools are available for the different components of a mailbox. Usage is described in the CLI help for the following.
|
Help on admin-related commands. |
|
Help on all |
|
Help on appointment-related commands. |
|
Help on contact-related commands (address book). |
|
Help on conversation-related commands. |
|
Help on filter-related commands. |
|
Help on folder-related commands. |
|
Help on item-related commands. |
|
Help on message-related commands. |
|
Help on miscellaneous commands. |
|
Help on right commands. |
|
Help on search-related commands. |
|
Help on tag-related commands. |
When you create an account, you may want to pre-create some tags and
folders. You can invoke zmmailbox inside of zmprov by using
selectMailbox(sm).
domain.example.com$ /opt/zimbra/bin/zmprov
prov> ca [email protected] test123
9a993516-aa49-4fa5-bc0d-f740a474f7a8
prov> sm [email protected]
mailbox: [email protected], size: 0 B, messages: 0, unread: 0
mbox [email protected]> createFolder /Archive
257
mbox [email protected]> createTag TODO
64
mbox [email protected]> createSearchFolder /unread "is:unread"
258
mbox [email protected]> exit
prov>zmmailbox -z-m [email protected] gmsThis is required when using the command emptyDumpster. Use
--admin-priv to skip delegated auth as the target mailbox.
zmmailbox -z --admin-priv -m [email protected] emptyDumpster--admin-priv with select Mailbox commandzmmailbox -z mbox> sm --admin-priv [email protected]This lets one user login to another user’s mailbox. The authenticating
user must be a delegated admin account and must have adminLoginAs right
on the target mailbox. This auth option uses a non-admin auth token. Use
the --auth option to specify the authenticating account. To login as
user bar and open mailbox foo:
$ zmmailbox --auth [email protected] -p password -m [email protected]zmmailbox -z-m [email protected] gmsWhen you use zmmailbox to backup individual mailboxes, you can save
the file as either a zip file or a tgz file. The default settings for
the information that is saved in these formats is different.
| File | TGZ | ZIP |
|---|---|---|
Briefcase |
X |
X |
Calendar |
X |
|
Conversations |
X |
|
Contacts |
X |
X |
Deleted Messages |
X |
X |
Emailed Contacts |
X |
|
Inbox |
X |
X |
Sent |
X |
X |
Sent Messages |
X |
X |
Tasks |
X |
To include all the mailbox content in a zip file, you must enable the meta data. Type as:
zmmailbox -z-m [email protected] gru "?fmt=zip&meta=1" > /<filename.zip>Use zmtlsctl to set the Web server zimbraMailMode to the communication
protocol options: HTTP, HTTPS, Mixed, Both and Redirect. The default
setting is HTTPS.
|
Important
|
The zmtlsctl setting also impacts the ZCO’s Use Secure Connection
setting. ZCO users in a self-signed environment will encounter warnings
about connection security unless the root CA certificate is added to Window
Certificate Store. See the Zimbra Wiki article
ZCO Connection
Security for more information.
|
-
HTTP. HTTP only, the user would browse to http://zimbra.domain.com.
-
HTTPS. HTTPS only (default), the user would browse to https:/zimbra.domain.com. http:// is denied.
-
Mixed If the user goes to http:// it will switch to https:// for the login only,then will revert to http:// for normal session traffic. If the user browses to https://, then the user will stay https://
-
Both A user can go to http:// or https:// and will keep that mode for the entire session.
-
Redirect Like mixed if the user goes to http:// it will switch to https:// but they will stay https:// for their entire session.
All modes use SSL encryption for back-end administrative traffic.
|
Important
|
Only zimbraMailMode HTTPS can ensure that no listener will be available
on HTTP/port 80, that no client application will try to auth over HTTP, and
that all data exchanged with the client application will be encrypted.
|
Mailboxd has to be stopped and restarted for the change to take effect.
|
Note
|
If you switch to HTTPS, you use the self-signed certificate generated during {product-abbrev} installation in /opt/zimbra/ssl/zimbra/server/server.crt. For ZCO users, secure ZCO profiles will display Certificate Trust dialogs unless the root CA certificate is deployed to the server. For more information about ZCO certificates, see the Zimbra Wiki page ZCO Connection Security. |
-
Type
zmtlsctl [mode]and press ENTER. -
Type
zmmailboxdctl stopand press ENTER. -
When mailboxd is stopped, type
zmmailboxdctl startand press ENTER.
-
Many client applications send an auth request in the initial HTTP request to the Server ("blind auth"). The implications of this are that this auth request is sent in the clear/unencrypted prior to any possible opportunity to redirect the client application to HTTPS.
-
Redirect mode allows for the possibility of a man-in-the-middle attack, international/unintentional redirection to a non-valid server, or the possibility that a user will mis type the server name and not have certificate-based validity of the server.
-
In many client applications, it is impossible for users to tell if they have been redirected (for example, ActiveSync), and therefore the users continue to use HTTP even if the auth request is being sent unencrypted.
Use zmhsm to start, stop (abort), and see the status of a HSM session.
The threshold for when messages are moved to a storage volume is
configured from the Administration Console, Servers > Volumes page.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Aborts the current HSM session. If all the messages in a mailbox being processed were not moved before you clicked Abort, no messages from that mailbox are moved from the primary volume. Messages for mailboxes that have completed the move to the secondary volume are not moved back to the primary volume. |
|
|
Shows the help for the usage options for this tool. |
|
|
|
|
|
Manually starts the HSM process. |
|
|
The status of the last HSM session is displayed. |
Use zmlicense to view and install your Zimbra license. The license can
be viewed and installed from the Administration Console, Global Settings >
License page.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Check to see if a valid license is installed. |
|
|
Shows the help for the usage options for this tool. |
|
|
|
|
|
Install on LDAP only. |
|
|
Displays the license information. |
The zmmetadump command is a support tool that dumps the contents of an
item’s metadata in a human readable form.
Use zmmypasswd to change zimbra_mysql_password. If the --root option
is specified, the mysql_root_passwd is changed. In both cases, MySQL is
updated with the new passwords. Refer to the MySQL documentation to see
how you can start the MySQL server temporarily to skip grant tables, to
override the root password.
|
Note
|
This requires a restart for the change to take effect. |
Users who maintain a backup and restore mechanism using the snapshot
facility of the storage layer use zmplayredo to restore backed up data.
This command brings all backed up data to the current state so that there
is no loss of information during the restore process.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
|
|
|
Shows the help information for this command. |
|
|
|
|
|
|
`--queueCapacity |
|
|
|
Stops the replay on occurrence of any error. |
|
|
|
|
|
|
|
|
|
Time is specified in the local time zone. The year, month, date, hour, minute, second, and optionally millisecond should be specified. Month/date/hour/ minute/second are 0 -padded to 2 digits, millisecond to 3 digits. The hour must be specified in a 24- hour format.
Use zmproxyconfgen to generate the Nginx proxy configuration files. It
reads LDAP settings to replace template variables and generates the
final Nginx configuration.
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
Prints the default variable map. |
|
|
Prints the Definitions variable map after loading LDAP configuration and processing overrides. |
|
|
Displays help information. |
|
|
|
|
|
Specifies not to write configuration and only display the files that would be written. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Displays verbose data. |
|
|
|
Use zmproxypurge to purge POP/IMAP proxy routing information from one or
more memcached servers. Available memcached servers are discovered by the
zmprov gamcs function. Others can be specified if necessary using the
server port.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Shows the help for the usage options for this tool. |
|
|
Displays verbose data. |
|
|
Displays account routing information. |
|
|
Displays account name. |
|
|
Displays file containing list of accounts, one per line. |
|
|
Specifies the format to be used for printing routing information with information. The fields that display by default are
|
|
(optional command) Specifies additional memcache server in the form of server:port. |
Use zmredodump for debugging purposes and to dump the contents of a
redolog file. When users are debugging a problem, Zimbra support might
ask them to run zmredodump with specific options.
Multiple log files/directories can be specified with all redolog files under each directory being sorted in ascending order and processed.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Displays help messages. |
|
Specifies the mailbox ids separated by a comma or a space. The entire list of mailbox ids must be quoted if using space as a separator. To dump contents of all the redolog files, omit this option. |
|
|
Specifies if file offsets and size for each redolog dump should not be shown. |
|
|
|
Activates the quiet mode. Used to only print the log filename and errors, if any. Useful for verifying integrity of redologs with minimal output. |
|
Shows blob content. The specified item’s blob is printed with |
Use zmskindeploy to simplify the process of deploying skins in ZWC. This
tool processes the skin deployment, enables the skin for all users of the
ZWC deployment, and restarts the web server so that it recognizes the new
skin.
For more information about this tool, see http://wiki.zimbra.com/index.php?title=About_Creating_{product-abbrev}_Themes.
Use zmsoap to print mail, account, and admin information in the SOAP
format.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Prints usage information. |
|
|
|
|
|
|
|
|
|
|
|
Displays the Zimbra admin name and password to authenticate as. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Prints the SOAP request and other status information. |
|
|
Use zmstat-chart to collect statistical information for the CPU, IO,
mailboxd, MTAqueue, MySQL, and other components and to run a script on the
csv files to display the usage details in various charts. These csv files
are saved to /opt/zimbra/zmstat/.
You must enable zmstat to collect the performance charts data:
-
Enter
zmprov ms {hostname} zimbraServerEnable : stats. -
Restart the server, Enter:
zmcontrol stop zmcontrol start
| Long Name | Short Name | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary data generation is not included. |
|
|
|
|
|
|
|
|
One or more directories where the csv files are located. The csv files are
moved to directories listed by date under |
Use zmstat-chart-config to generate an xml file
/opt/zimbra/conf/zmstat-chart.xml from a template, taking into account
the server setup including theLDAP node and the processes run, among other
specifications.
Use zmstatctl to run a control script for checking zmstat data
collectors. This instruction starts or stops monitoring processes, and
checks status or rotates logs.
Use zmthrdump to invoke a thread dump in the {product-abbrev} server process and
print the output file. This command also gives the option of saving the
thread dump to a file and inserts a timestamp on the logfile.
| Short Name | Description |
|---|---|
|
Displays help messages. |
|
Appends the timestamp to the LOGFILE before invoking SIGQUIT. |
|
Returns the PID to send SIGQUIT. The default value can be found in
|
|
Specifies the LOGFILE to save the thread dump output in. The default value
is |
|
Specifies the output file of the thread dump. The default value is stdout. |
|
Specifies the timeout value (in seconds) to exit if the process becomes unresponsive. The default value is 30 seconds. |
Use zmtrainsa to train the anti-spam filter. This command is run
automatically every night to train the SpamAssasin filter from messages
users mark as "junk" / "not junk" from their mailbox. See
SpamAssassin’s sa-update tool, which is
included with SpamAssassin. This tool updates SpamAssassin rules from the
SA organization. The tool is installed into /opt/zimbra/common/bin.
The zmtrainsa command can be run manually to forward any folder from any
mailbox to the spam training mailboxes. If you do not enter a folder name
when you manually run zmtrainsa for an account, for spam, the default
folder is Junk. For ham, the default folder is Inbox.
Use zmtzupdate to update time zone changes in existing appointments for
specific users or all users. A .ics rule file should first be created to
run with this command. A rule file lists a series of rules to match a time
zone and the replacement time zone definitions. More information about
this command can be found at:
https://wiki.zimbra.com/wiki/Changing_{product-abbrev}_Time_Zones.
zmtzupdate --rulefile <rule file> -a <"all" or list of specific email addresses> [--sync] [--after <date/time stamp>]| Long Name* | Short Name | Description |
|---|---|---|
|
|
|
|
|
|
|
|
Displays help information. |
|
Specifies the .ics XML file that should be used to update time zone definitions. |
|
|
|
|
|
If specified, this option causes the |
Use zmvolume to manage storage volumes from the CLI. Note that volumes
can be managed from the Administration Console, Server > Volumes page.
| Long Name | Short Name | Description |
|---|---|---|
|
|
Adds a volume. |
|
|
|
|
|
Compression threshold; default 4KB. |
|
|
Deletes a volume. |
|
|
Displays the current volume. |
|
|
Edits a volume. |
|
|
Shows the help for the usage options for this tool. |
|
|
|
|
|
Lists volumes. |
|
|
|
|
|
|
|
|
|
|
|
Sets the current volume. |
|
|
|
|
|
Turns off the current secondary message volume. |
Use zmzimletctl to manage Zimlets and to list all zimlets on the server.
Additional information is provided in Zimlets. Most Zimlet
deployment can be completed from the zimbra Administration Console.
| Long Name | Short Name | Description |
|---|---|---|
deploy |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Sets the access control, grant|deny, to a COS. |
|
|
|
|
|
View details about all Zimlets on the server. |
|
|
|
|
|
|
|
|
Shows the current Zimlet priorities (0 is high, 9 is low) |
|
|
|
Use zmproxyconfig to manage Zimbra proxy and should only be used when
you have to make changes to Zimbra proxy after it has been installed.
See Zimbra Proxy Server.
|
Note
|
Previous to {product-abbrev} 6.0, this command was called zmproxyinit.
|
/opt/zimbra/libexec/zmproxyconfig [-h] [-o] [-m] [-w] [-d [-r] [-s] [-a w1:w2:w3:w4] [-i p1:p2:p3:p4] [-p p1:p2:p3:p4] [-x mailmode]] [-e [-a w1:w2:w3:w4] [-i p1:p2:p3:p4] [-p p1:p2:p3:p4] [-x mailmode]] [-f] -H hostname| Short Name | Description |
|---|---|
|
Displays help messages. |
|
Hostname of the server on which enable/disable proxy functionality. |
|
Colon separated list of Web ports to use. Format: HTTP-STORE:HTTP-PROXY:HTTPS-STORE:HTTPS-PROXY (Ex: 8080:80:8443:443) |
|
Disable proxy. |
|
Enable proxy. |
|
Full reset on memcached port and search queries and POP/IMAP throttling. |
|
Colon separated list of IMAP ports to use. Format: IMAP-STORE:IMAP-PROXY:IMAPS-STORE:IMAPS-PROXY (Ex: 7143:143:7993:993) |
|
Toggle mail proxy portions. |
|
Override enabled checks. |
|
Colon separated list of POP ports to use. Format: POP-STORE:POP-PROXY:POPS-STORE:POPS-PROXY (Ex: 7110:110:7995:995) |
|
Run against a remote host. Note that this requires the server to be properly configured in the LDAP master. |
|
Set Cleartext to FALSE (secure mode) on disable. |
|
Disable reverse proxy lookup target for the store server. Only valid with
|
|
Toggle Web proxy portions. |
|
|
hostname is the value of the zimbra_server_hostname LC key for the
server being modified.
Required options are -f by itself, or -f with -d or -e.
Note that
-
-dor-erequire one or both of-mand-w. -
-ior-prequire-m. -
-arequires-w. -
-xrequires-wand-dfor store. -
-xrequires-wfor proxy.
The following are the defaults for -a, -i, -p, and -x if they are
not supplied as options.
|
default on enable: 8080:80:8443:443 |
default on disable: 80:0:443:0 |
|
default on enable: 7143:143:7993:993 |
default on disable: 143:7143:993:7993 |
|
default on enable: 7110:110:7995:995 |
default on disable: 110:7110:995:7995 |
|
default on store disable: http |
default on proxy enable/disable: http |
Use zmsyncreverseproxy to reserve proxies mobile sync HTTP traffic
between the source and forwarding server and port. Decodes the sync
requests/responses and logs them when verbose mode is turned on.
zmsyncreverseproxy [-v] [-d] [-L log4j.properties] -p <port number> -fs <fwd server> -fp <fwd port> [-sv syncversions]| Long Name | Short | Description |
|---|---|---|
|
|
Displays help. |
|
|
Verbose mode, dumps full exception stack trace. |
|
|
Debug mode, dumps decoded sync messages. |
|
|
The port this service listens on. |
|
|
The server host to forward requests to. |
|
|
The server port to forward requests to. |
|
|
Active sync versions supported. |
|
|
|