doveadm-cluster-user¶
NAME¶
doveadm-cluster-user - Utility actions for Dovecot Cluster users
SYNOPSIS¶
doveadm [GLOBAL OPTIONS] cluster user access [ -u user ] | [ -A ] | [ -f file ] [ -i ]
doveadm [GLOBAL OPTIONS] cluster user delete user
doveadm [GLOBAL OPTIONS] cluster user move [ --direct ] [ --site site ] user group [ failover group ]
doveadm [GLOBAL OPTIONS] cluster user status user
DESCRIPTION¶
doveadm cluster user can be used to run actions that interact with Dovecot Cluster users.
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 user access¶
doveadm [GLOBAL OPTIONS] cluster user access [ -u user | -A | -F file ] [ -i ]
Perform cluster lookup for the user (or users). Displays the host name or IP address of the backend which the user ended up. This command can be run from either a proxy or a backend. This command is also used internally to finish user moves.
You can use the -i
parameter to display backend’s IP rather than host name.
- -A
If the -A option is present, the command will be performed for all users. Using this option in combination with system users from userdb { driver = passwd } is not recommended, because it contains also users with a lower UID than the one configured with the
first_valid_uid
setting.When the SQL userdb module is used make sure that the iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. When using the LDAP userdb module, make sure that the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
- -F file
Execute the command for all the users in the file. This is similar to the -A option, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line.
- -u user/mask
Run the command only for the given user. It’s also possible to use ‘*’ and ‘?’ wildcards (e.g. -u *@example.org).
cluster user delete¶
doveadm [GLOBAL OPTIONS] cluster user delete user
Deletes a user record from GeoDB.
cluster user move¶
doveadm [GLOBAL OPTIONS] cluster user move [ --direct ] [ --site site ] user group [ failover group ]
Initiates moving user to a different user group which will finish in background.
The move is initialized by updating the moving_*
fields in GeoDB.
The next time the user is accessed triggers the actual moving by the
original backend. This user access is also automatically triggered by running
doveadm cluster user access
command.
--direct
will update the user’s new site/group immediately to GeoDB without
performing any user moving. This is intended for testing purposes only, and
should not be used.
cluster user status¶
doveadm [GLOBAL OPTIONS] cluster user status user
Displays status information of a user.
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