doveadm-cluster-site¶
NAME¶
doveadm-cluster-site - Utility actions for Dovecot Cluster site
SYNOPSIS¶
doveadm [GLOBAL OPTIONS] cluster site add [ --id id ] [ --tag tag ] [ --load-balancer host ] name
doveadm [GLOBAL OPTIONS] cluster site remove name
doveadm [GLOBAL OPTIONS] cluster site update [ --status online|offline|standby|evacuate ] [ --load-balancer host ] --self | name
doveadm [GLOBAL OPTIONS] cluster site status name
doveadm [GLOBAL OPTIONS] cluster site list
doveadm [GLOBAL OPTIONS] cluster site init [ --update ] --self | name
DESCRIPTION¶
doveadm cluster site can be used to run actions that interact with and modify Dovecot Cluster sites.
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.
COMMANDS¶
cluster site add¶
doveadm [GLOBAL OPTIONS] cluster site add [ --id id ] [ --tag tag ] [ --load-balancer host ] name
Adds a new site to cluster. Load balancer is the host or IP address where another site’s proxy connects to do site to site connections. New sites are added in online state. UUID should not be used unless you are re-adding the same site.
cluster site remove¶
doveadm [GLOBAL OPTIONS] cluster site remove name
Remove a site. This currently has no safety checks, so be sure to remove first all of the site’s backends and remove it from all users’ preferred sites.
cluster site update¶
doveadm [GLOBAL OPTIONS] cluster site update [ --status online|offline|standby|evacuate ] [ --load-balancer host ] --self | name
Update site status and load balancer. The --self
parameter can be used to target the local site.
cluster site list¶
doveadm [GLOBAL OPTIONS] cluster site list
List all sites.
cluster site init¶
doveadm [GLOBAL OPTIONS] cluster site init [ --update] --self | name
Initialise site by creating cluster_default_group_count user groups. The --self
parameter can be used to target the local site.
If --update
is passed this command removes existing groups and recreates them. Users get their users_groups unassigned when running with
--update
.
SITE STATUS¶
- Online
The site is reachable and accepts connections.
- Offline
The site is unreachable.
- Standby
The site is reachable, but does not accept connections.
- Evacuate
The site is being evacuated of all users.
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