Zimbra CLI Commands: Server | Zimbra

Document
Alert! This article is written for Zimbra OSE users. As of December 2023, Synacor will no longer be providing support for Zimbra OSE. You might want to consider trying out Carbonio Community Edition – Zextras’s free and open-source email and collaboration platform.

For additional guidance, check out our community articles detailing the process of migrating from your current platform to Carbonio CE.

For enterprise-level requirements and advanced features, consider checking out Zextras Carbonio – the all-in-one private digital workplace designed for digital sovereignty trusted by the public sector, telcos, and regulated industries.

In this article we are going to see how to manage your Server(s) with CLI Commands using zmprov. As usual, for every command, we will show you the extendend and short form along with the syntax to be used.

Remember that all commands are intended to be executed logging in as Zimbra user, with the command: su - zimbra

Create Server:

To create a Server you need to use createServer (cs) with the following syntax:

zmprov createServer {serverName} [attr1 value1 ...]

Modify Server:

To modify a Server you need to use modifyServer (ms) with the following syntax:

zmprov modifyServer {serverName|id} [attr1 value1 ...]

Example:

zmprov modifyServer sampledomain.com zimbraVirusDefinitionsUpdateFrequency 1h

Delete Server:

To delete a Server you need to use deleteServer (ds) with the following syntax:

zmprov deleteServer {serverName|id}

Get Server:

To get a Server you need to use getServer (gs) with the following syntax:

zmprov getServer {serverName|id}

Get All Servers:

To get all Servers you need to use getAllServers (gas) with the following syntax:

zmprov getAllServers [-v]

The -v attribute, stands for verbose. Verbose mode dumps full exception stack trace

Get All Reverse Proxy Backends:

To get all Reverse Proxy Backends you need to use getAllReverseProxyBackends (garpb) with the following syntax:

zmprov getAllReverseProxyBackends

Get All Reverse Proxy URLs:

To get all Reverse Proxy URLs you need to use getAllReverseProxyURLs (garpu) with the following syntax:

zmprov getAllReverseProxyURLs

This command is used to publish in nginx.conf which servers should be used for reverse proxy look-up.

Get All MTA Auth URLs:

To get all Mta Auth URLs you need to use getAllMtaAuthURLs (gamau) with the following syntax:

zmprov getAllMtaAuthURLs

This command is used to publish in saslauthd.conf which servers should be used for saslauthd.conf MTA auth.

Get All Memcached Servers:

To get all Memcached Servers you need to use getAllMemcachedServers (gamcs) with the following syntax:

zmprov getAllMemcachedServers

This command is used to list memcached servers for nginix use.

Download Zextras Suite for Zimbra OSE

Post your comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.

How to syncronize Zimbra with Outlook | Zimbra
Zimbra CLI Commands: Domain | Zimbra