doveadm-cluster-group¶
NAME¶
doveadm-cluster-group - Utility actions for Dovecot Cluster user groups
SYNOPSIS¶
doveadm [GLOBAL OPTIONS] cluster group access group
doveadm [GLOBAL OPTIONS] cluster group move [ --direct ] site group host
doveadm [GLOBAL OPTIONS] cluster group status site group
doveadm [GLOBAL OPTIONS] cluster group update [ --sticky-users <yes|no> ] [ --sticky-backend <yes|no> ] site group
doveadm [GLOBAL OPTIONS] cluster group list [ mask ]
DESCRIPTION¶
doveadm cluster group can be used to run actions that interact with and modify Dovecot Cluster user groups.
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 group access¶
doveadm [GLOBAL OPTIONS] cluster group access group
Perform cluster lookup for the cluster_backend_test_username
user as if it belonged to the specified
group. This command must be run from a backend, not a proxy. For now this command is mainly used internally to finish user group moves.
cluster group move¶
doveadm [GLOBAL OPTIONS] cluster group move [ --direct ] site group host
Initiate a user group move, which finishes on background. The move is
initialized by updating the “moving” and “alt_backed_id” fields in GeoDB.
The next time a user in the group is accessed triggers the actual moving by the
original backend. This user access is also automatically triggered by running
doveadm cluster group access
command in the group’s original backend.
--direct
will update the group’s new backend immediately to GeoDB without
performing any user moving. This is intended for testing purposes only, and
should not be used.
cluster group status¶
doveadm [GLOBAL OPTIONS] cluster group status site group
Display current status of a user group.
cluster group update¶
doveadm [GLOBAL OPTIONS] cluster group update [ --sticky-users <yes|no> ] [ --sticky-backend <yes|no> ] site group
Updates group settings. Currently only two options can be given.
--sticky-users
Whether users in this user group are eligible to be moved automatically to other groups.
--sticky-backend
Whether this user group is eligible to be moved automatically to another backend in load balancing.
cluster group list¶
doveadm [GLOBAL OPTIONS] cluster group list [ mask ]
List all user groups. Optional mask can be provided for filtering the list.
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