doveadm-cluster(1) - Utility actions for Palomar

SYNOPSIS

doveadm [GLOBAL OPTIONS] cluster command [arguments]

DESCRIPTION

doveadm cluster can be used to run actions that interact with and modify Palomar.

GLOBAL OPTIONS

Global doveadm(1) options:

-D

Enables verbosity and debug messages.

-O

Do not read any config file, just use defaults. The dovecot_storage_version defaults to the latest version, but can be overridden with -o.

-k

Preserve entire environment for doveadm, not just import_environment.

-v

Enables verbosity, including progress counter.

-i instance-name

If using multiple Dovecot instances, choose the config file based on this instance name.

See instance_name for more information.

-c config-file

Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.

-o setting=value

Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.

-f formatter

Specifies the formatter for formatting the output. Supported formatters are:

flow

prints each line with key=value pairs.

json

prints a JSON array of JSON objects.

pager

prints each key: value pair on its own line and separates records with form feed character (^L).

tab

prints a table header followed by tab separated value lines.

table

prints a table header followed by adjusted value lines.

COMMANDS

cluster tag

doveadm-cluster-tag(1), Tag management commands

cluster site

doveadm-cluster-site(1), Site management commands

cluster backend

doveadm-cluster-backend(1), Backend management commands

cluster user

doveadm-cluster-user(1), User management commands

cluster geodb

doveadm-cluster-geodb(1), GeoDB management commands

cluster localdb

doveadm-cluster-localdb(1), LocalDB management commands

cluster kick

doveadm-cluster-kick(1), Disconnect user connections from cluster

REPORTING BUGS

Report bugs, including doveconf -n output, to the Dovecot Mailing List dovecot@dovecot.org. Information about reporting bugs is available at: https://dovecot.org/bugreport.html

SEE ALSO

doveadm(1), dovecot-cluster(7)