zm

Make a new draft

$ zm new

$ zm edit

$ zm publish

zm<command> [options] [arguments]

This represents the general pattern for invoking Zimbra commands. The specific options and arguments vary widely depending on the <command> invoked.

Examples:
zmcontrol start | stop | restart | status
zmprov ca user@example.com password
zmmailbox -z getRestURL /service/home/user@example.com/?fmt=tgz

zmcontrol
    Manages Zimbra server processes, including starting, stopping, restarting, and checking the status of services.

zmprov
    The Zimbra Provisioning tool, used for creating, modifying, and deleting accounts, domains, distribution lists, aliases, and other LDAP-backed objects.

zmmailbox
    Provides command-line access to user mailboxes for operations like creating folders, managing messages, setting user preferences, and importing/exporting data.

zmlogger
    Used for managing and configuring Zimbra logging settings and retrieving log information.

zmtlsctl
    Manages TLS/SSL certificates and configurations for Zimbra services.

zmbackup/zmrestore
    Commands related to backing up and restoring Zimbra data, often involving full system or individual account backups.

The zm prefix designates a comprehensive suite of command-line utilities used for managing and administering the Zimbra Collaboration Suite (ZCS). These commands provide powerful control over various aspects of a Zimbra installation, including server operations, user provisioning, mailbox management, logging, security, and more.

Unlike typical standalone Linux commands, 'zm' itself is not a direct executable but serves as a common prefix for a vast array of specialized tools (e.g., zmcontrol, zmprov, zmmailbox). Administrators use these tools to automate tasks, script complex operations, and perform detailed configurations that may not be available through the graphical administration console. The suite is essential for maintaining the health, performance, and security of a Zimbra environment.

The zm command prefix is specific to the Zimbra Collaboration Suite and is not a standard Linux utility. It requires a functioning Zimbra installation. Command syntax, options, and arguments are highly specific to each individual zm-prefixed command and often change between Zimbra versions. Always consult the official Zimbra documentation or the specific command's help (e.g., zmprov help) for accurate usage.

Zimbra commands typically need to be run by the 'zimbra' user or by a root user who can switch to the 'zimbra' user context (e.g., using su - zimbra). This ensures proper permissions and access to Zimbra's internal configurations and services.

While zm commands operate on the Zimbra data store (LDAP, MySQL, filesystem), their behavior and the overall Zimbra environment are governed by configuration files primarily located under the Zimbra installation directory (commonly /opt/zimbra). Key configurations are often stored in LDAP and managed via zmprov, but some settings reside in XML or property files.

Zimbra Collaboration Suite was initially developed by Zimbra, Inc., and first released in 2005. It quickly gained popularity as an open-source alternative to Microsoft Exchange. Over the years, Zimbra has been acquired by various companies, including Yahoo!, VMware, Telligent, Synacor, and currently by Vertuoz by VNC. The command-line utilities, especially those prefixed with 'zm', have been a core part of its administration interface since its early days, evolving with the product's features and architecture.

zmcontrol(8), zmprov(8), zmmailbox(8), ldapsearch(1), postfix(1), apache2(8)