doveadm-cluster-backend¶
NAME¶
doveadm-cluster-backend - Utility actions for Dovecot Cluster backend
SYNOPSIS¶
doveadm [GLOBAL OPTIONS] cluster backend add [ --id id ] [ --site host ] --self | name
doveadm [GLOBAL OPTIONS] cluster backend remove --self | host
doveadm [GLOBAL OPTIONS] cluster backend update [ --status online|offline|standby ] [ --load-factor <0..100> ] --self | host
doveadm [GLOBAL OPTIONS] cluster backend evacuate --self | host
doveadm [GLOBAL OPTIONS] cluster backend status --self | host
doveadm [GLOBAL OPTIONS] cluster backend list
DESCRIPTION¶
doveadm cluster backend can be used to run actions that interact with and modify Dovecot Cluster backends.
GLOBAL OPTIONS¶
Global doveadm(1) options:
- -D
Enables verbosity and debug messages.
- -O
Do not read any config file, just use defaults.
- -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
setting 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.
GLOBAL OPTIONS¶
Global doveadm(1) options:
- -D
Enables verbosity and debug messages.
- -O
Do not read any config file, just use defaults.
- -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
setting 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.
- 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.
Command specific options¶
- --self
Target the same host where the command is ran from. Uses
cluster_backend_name
setting as the host name.
COMMANDS¶
cluster backend add¶
doveadm [GLOBAL OPTIONS] cluster backend add [ --id id ] [ --site host ] --self | name
Adds a new backend to cluster. New backends are added in standby state. UUID should not be used unless you are re-adding the same backend.
- name
must be a resolvable DNS name. Unresolvable DNS names and IPv4/v6 literal addresses will be rejected.
cluster backend remove¶
doveadm [GLOBAL OPTIONS] cluster backend remove --self | host
Remove a backend from cluster.
cluster backend update¶
doveadm [GLOBAL OPTIONS] cluster backend update [ --status online|offline|standby ] [ --load-factor <0..100> ] --self | host
--status
See BACKEND STATUS
--load-factor
Load factor is the approximate amount of site load in percentage that this backend gets allocated. This value is not exact, and requires Dovecot Cluster Controller to work correctly. Recommended values are 100, 75, 50, 25 and 0. Setting it to 0 will indicate that backend should be drained in Cluster Controller.
cluster backend evacuate¶
doveadm [GLOBAL OPTIONS] cluster backend evacuate --self | host
Start moving all user groups to other backends. Will not wait for the moves to finish. Also sets the backend to standby and load factor to 0.
cluster backend status¶
doveadm [GLOBAL OPTIONS] cluster backend status --self | host
Shows the current status of the backend.
cluster backend list¶
doveadm [GLOBAL OPTIONS] cluster backend list [ –site host ]
Lists all backends in this cluster, including other sites. You can use optional --site
parameter to specify site to list.
BACKEND STATUS¶
- Online
The backend is reachable and accepts connections.
- Offline
The backend is unreachable.
- Standby
The backend is reachable, but does not accept connections.
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