|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 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
|
|
|
|
|
|
|
|
|
|
|
|
Ability to write Python scripts that access Zimbra Java libraries. It sets the ZCS class path and starts the Jython interpreter.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Outputs an XML configuration that describes the current state of the data gathered from zmstat-chart to generate charts on the administration console.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 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.
The syntax is zmprov [cmd] [argument].
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.
The commands in the following table are divided into the tasks types - Account, Calendar Resources, Config, COS, Distribution List, Documents, Domain, Server, and Miscellaneous.
|
|
|
|
|
|
|
|
|
zmprov aaa joe@domain.com joe.smith@engr.domain.com
|
|
|
|
Note: This command does not check the password age or history.
|
|
|
|
|
|
|
|
{name@domain} {ds-type} {ds-name} [attr1 value1 [attr2 value2...]]
|
|
|
|
|
|
|
|
{name@domain} {signature-name} [attr1 value1 [attr2 value2...]]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
zmprov ma joe@domain.com zimbraAccountStatus maintenance
|
|
|
|
{name@domain | id} {ds-name |ds-id} [attr 1 value 1 [attr2 value 2...]]
|
|
|
|
|
|
|
|
{name@domain |id} {signature-name | signature-id} [attr 1 value 1 [attr 2 value 2...]]
|
|
|
|
zmprov raa joe@domain.com joe.smith@engr.domain.com
|
|
|
|
{name@domain|id} {newname@domain}
Note: After you rename an account, you should run a full backup for that account. zmbackup -f - <servername.com> -a <newaccountname@servername.com>
|
|
|
|
|
|
|
|
Note: Passwords cannot included accented characters in the string. Example of accented characters that cannot be used: ã, é, í, ú, ü, ñ.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{name@domain|id} {newName@domain}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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...]]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
zmprov md domain.com zimbraGalMaxResults 500
Note: Do not modify zimbraDomainRenameInfo manually. This is automatically updated when a domain is renamed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
zmprov cc Executive zimbraAttachmentsBlocked FALSE zimbraAuthTokenLifetime 60m zimbraMailQuota 100M zimbraMailMessageLifetime 0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
zmprov mc Executive zimbraAttachmentsBlocked TRUE
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
zmprov ms domain.com zimbraVirusDefinitionsUpdateFrequency 2h
|
|
|
|
Used to publish into nginx.conf what servers should be used for reverse proxy lookup.
|
|
|
|
Used to publish into saslauthd.conf what servers should be used for saslauthd.conf MTA auth
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
get DistributionListmembership
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Before importing files, any file that will become a Documents page (wiki-style page), must be renamed to include the extension “.wiki”. If not it is imported as a file, accessed either as an attachment or an image.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
Important: Recalculating mailbox quota usage and message count should be schedule to run in off peak hours and used on one mailbox at a time.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[-s/--server hostname] {name@domain|id} {logging-category} {debug|info|warn|error}
|
|
|
|
|
|
|
|
[-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.
|
See the zmprov Log Categories for a list of logging categories.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[-v] {ldap-query} [limit] [offset] [sortBy {attribute} [sortAscending 0|1] [domain {domain}]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{+|-} {dl-name@domain|id} {owner-name|owner-id} [{folder-path|folder-id}]
|
|
|
|
|
|
|
|
|
|
Generates a pre-authentication key to enable a trusted third party to authenticate to allow for single-sign on. Used in conjunction with GenerateDomainPreAuth.
|
|
|
|
{domain|id} {name} {name|id|foreignPrincipal} {timestamp|0} {expires|0}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Used to publish into nginx.conf the servers that should be used for reverse proxy lookup
|
|
|
|
Used to publish into saslauthd.conf the servers that should be used for saslauthd.conf MTA auth
|
|
|
|
|
Then type zmloggerctl start, to start the logger.
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
|
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
name@domain.com. You can also change the template in a class of service, use
zmprov mc. The command is written on one line.
This command runs 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.
This command is used 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.
|
|
|
|
|
|
|
<arg> Directory to write messages to. If none is specified, then only the headers are fetched. Filenames are generated in the form
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Allows printing of status messages while the search is being executed
|
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.
|
|
|
|
|
|
|
<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.
|
|
|
|
|
|
|
|
<arg> Deletes the backups including and prior to the specified label, date (YYYY/MM/DD[-hh:mm:ss]) or period (nn(d|m|y]).
|
|
|
|
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).
|
|
|
|
|
|
|
|
Starts an incremental backup. This option is not available in the auto-grouped backup mode
|
|
|
|
<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.
|
|
|
|
|
|
|
|
<arg> Specifies the target backup location. The default is <zimbra_home>/backup.
|
|
|
|
|
|
|
|
|
Checks 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.
|
|
|
|
|
|
|
<arg> Saves or loads report to and from the specified file
|
|
|
|
|
|
|
|
<arg> Displays report from the specified file
|
|
|
|
<arg> Returns the Zimbra user MySQL password
|
This command checks 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 appointment for details on time-specs.
This command can be used 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 on going restore. The restore process is stopped after the current account is restored. The command displays message showing which accounts were not restored.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<arg> Label of the full backup to be aborted. Use the zmbackupquery, to find the label name.
|
|
|
|
|
|
|
|
<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.
|
|
|
|
<arg> Specifies the target backup location. The default is <zimbra_home>/backup.
|
The zmbackupquery command is used 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.
|
|
|
|
|
|
|
<arg> Account email addresses separated by white space or all for all accounts
|
|
|
|
|
|
|
|
|
|
|
|
<arg> List backups whose start date/time is at or after the date/time specified here.
|
|
|
|
<arg> The label of the full backup session to query. An example of a label is backup200507121559510.
|
|
|
|
<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.
|
|
|
|
<arg> Specifies the backup target location (The default is <zimbra_home>/backup.)
|
|
|
|
<arg> List backups whose start date/time is at or before the date/time specified here.
|
|
|
|
<arg> Backup set type to query. “full” or “incremental”, both are queried if one is not specified.
|
|
|
|
|
This tool performs 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.
|
|
|
|
|
|
|
<arg> Specifies the account email addresses. Separate accounts with a blank space or type all to restore all accounts.
|
|
|
|
Replays the redo logs in backup only, which excludes archived and current redo logs of the system
|
|
|
|
|
|
|
|
Restores accounts to target accounts whose names are prepended with prefix. (Can only be used in commands that use the -pre option.)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<arg> The label of the full backup to restore. Restores to the latest full backup if this is omitted.
|
|
|
|
<arg> The prefix to pre-pend to the original account names
|
|
|
|
|
|
|
|
<arg> Replay redo logs up to and including this incremental backup
|
|
|
|
<arg> Replay up to and including this redo log sequence
|
|
|
|
<arg> Replay rodo logs until this time
|
|
|
|
Restores to the full backup only, not any incremental backups since that backup.
|
|
|
|
<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.
|
|
|
|
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 -a all)
|
|
|
|
|
|
|
|
<arg> Specifies the backup target location. The default is <zimbra_home>/backup.
|
This tool is run 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.
|
|
|
|
|
|
|
<arg> Specifies the account email addresses. Separate accounts with a blank space or state all for restoring all accounts. Required.
|
|
|
|
Replays the redo logs in backup only, which excludes archived and current redo logs of the system
|
|
|
|
|
|
|
|
Restores accounts to new target accounts whose names are pre-pended with prefix
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<arg> The label of the full backup to restore. Type this label to specify a backup file other then the latest.
|
|
|
|
<prefix> The prefix to pre-pend to the original account names.
|
|
|
|
|
|
|
|
<arg> Replay redo logs up to and including this incremental backup
|
|
|
|
<arg> Replay up to and including this redo log sequence
|
|
|
|
<arg> Replay rodo logs until this time
|
|
|
|
Restores to the full backup only, not any incremental backups since that backup.
|
|
|
|
<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. If -s is specified, this must be localhost.
|
|
|
|
Do not restore if named accounts were deleted or did not exist at backup time. (This option is always enabled with -a all)
|
|
|
|
|
|
|
|
<arg> Specifies the backup target location. The default is <zimbra_home>/backup.
|
|
|
|
|
|
<arg> Session label to restore from. For example, full200612291821113.
|
|
|
<arg> Specifies the backup target location. The default is /opt/zimbra/backup.
|
|
|
|
|
|
|
|
|
<arg> Restores named account(s). List account names separated by white space.
|
This command is used to move a mailbox 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 LDAP is updated. After the mailbox is moved to a new server, a copy still remains on the older server, but the status of old mailbox is closed. Users cannot log on and mail is not delivered. You should check to see that all the mailbox contents were moved successfully before purging the old mailbox.
|
|
|
|
|
|
|
<arg> Email address of account to move
|
|
|
|
|
|
|
|
|
|
|
|
Purge old mailbox on previous server. After a mailbox has been successfully moved to a new server, perform purgeOld to remove the mailbox and its contents from the previous server.
|
|
|
|
<arg> Mail server hostname. The default is the localhost. Server where the --account mailbox is located.
|
|
|
|
<arg> Server where mailbox is moved to Use -t option to move a mailbox from the current server to the new server specified by the option. .
|
|
|
|
|
|
|
|
|
|
|
|
|
The CLI command 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.
zmmboxsearch {-m <arg>} {- q <arg>} [-o <arg>] [-l <arg>] [-d <arg>] [options]
|
|
|
|
|
|
|
<arg> Directory to write the messages to. If none is specified, then only the headers are fetched. Files names are generated in the form RESULTNUM_ACCOUNT-ID_ MAILITEMID.
|
|
|
|
|
|
|
|
|
|
|
|
<arg> Comma-separated list of mailboxes to search. UIDs or email-address or /SERVER/MAILBOXID or *.
|
|
|
|
<arg> Specify where the hit list should start. The default is 0
|
|
|
|
<arg> The query string for the search
|
|
|
|
<arg> Mail server hostname. default is the localhost
|
|
|
|
|
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.
The CLI command zmcertmgr is used to manage your certificates from the command line. You can use the administration console to easily view, update and install self-signed and commercial certificates. See the administration console help for more information about using this tool.
The CLI command zmgsautil can be used 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.
The CLI command zmldappasswd changes the LDAP password on the local server. In multi node environments, this command must be run on the LDAP master server only.
|
•
|
LDAP Postfix password. This is the password used by the postfix user to identify 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 user to 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 LDAP replication user to identify itself to the LDAP master and must be the same as the password on the LDAP master server.
|
The zmmailbox tool is used 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.
|
•
|
Mixed mode redirects to HTTPS for login and HTTP for normal session traffic.
|
|
•
|
Both mode means that an HTTP session stays HTTP, including during the log in phase, and an HTTPS session remains HTTPS throughout, including the log in phase.
|
|
•
|
Redirect mode redirects any users connecting via HTTP to a HTTPS connection.
|
Mailboxd has to be stopped and restarted for the change to take effect.
This command is 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>Volume tab.
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
<arg> The mail server host name. The default is the localhost [args].
|
|
|
|
|
|
|
|
|
This command is used to view and install your Zimbra license. The license can be viewed and installed from the administration console, Global Settings, License tab.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<arg> Installs the specified license file.[arg] This is the Zimbra license file that you received.
|
|
|
|
|
|
|
|
|
or zmmetadump -f <file containing encoded metadata>
This command is used to change zimbra_myql_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. 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 this command 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.
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.
This command generates the nginx proxy configuration files. It reads LDAP settings to replace template variables and generates the final nginx configuration.
This command purges 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.
This command is mainly used for debugging purposes and dumps the contents of a redolog file. When users are debugging a problem, Zimbra support might ask them to run
zmredodump with specific options.
This command simplifies 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_ZCS_Themes
This command is used 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/.
|
1.
|
Enter zmprov ms {hostname} zimbraServerEnable : stats.
|
This command generates an xml file /opt/zimbra/conf/zmstat-chart.xml from a template, taking into account the server setup including the LDAP node and the processes run, among other specifications.
This command invokes a thread dump in the ZCS server process and prints the output file. It also gives the option of saving the thread dump to a file and inserts a timestamp on the logfile.
This command is used 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
Anti-Spam Training Filters.
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.
This command is used 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
http://wiki.zimbra.com index.php?title=Changing_ZCS_Time_Zones
This command can be used to manage storage volumes from the CLI. Volumes can be easily managed from the administration console, Server, Volume tab.
|
|
|
|
|
|
|
|
|
|
|
<arg> Compress BLOBs; “true” or “false”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<arg> Mail server hostname. Default is localhost.
|
|
|
|
|
|
|
|
<arg> Volume type (primaryMessage, secondaryMessage, or index)
|
|
|
|
|
|
|
|
|
|
|
|
<zimlet.zip> Creates the Zimlet entry in the LDAP server, installs the zimlet files on the Server, grants, access to the members of the default COS, and turns on the Zimlet
|
|
|
|
<zimlet> Uninstall a zimlet from the zimbra server
|
|
|
|
