doveadm-cluster-localdb¶
NAME¶
doveadm-cluster-localdb - Utility actions for Dovecot Cluster local cache.
Warning
These commands are intended for testing and debugging purposes only, they should not be normally used.
SYNOPSIS¶
doveadm [GLOBAL OPTIONS] cluster localdb user status group user
doveadm [GLOBAL OPTIONS] cluster localdb user list [ mask ]
doveadm [GLOBAL OPTIONS] cluster localdb user remove group user
doveadm [GLOBAL OPTIONS] cluster localdb group status group
doveadm [GLOBAL OPTIONS] cluster localdb group list [ mask ]
doveadm [GLOBAL OPTIONS] cluster localdb group remove group
DESCRIPTION¶
doveadm cluster localdb can be used to run actions that interact with and modify Dovecot Cluster local cache.
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 localdb user status¶
doveadm [GLOBAL OPTIONS] cluster localdb user status group user
Displays locally cached information about a user.
cluster localdb user list¶
doveadm [GLOBAL OPTIONS] cluster localdb user list [ mask ]
List users in local cache.
cluster localdb user remove¶
doveadm [GLOBAL OPTIONS] cluster localdb user remove group user
Remove locally cached information for a user.
cluster localdb group status¶
doveadm [GLOBAL OPTIONS] cluster localdb group status group
Display locally cached information about a group.
cluster localdb group list¶
doveadm [GLOBAL OPTIONS] cluster localdb group list [ mask ]
List groups in local cache.
cluster localdb group remove¶
doveadm [GLOBAL OPTIONS] cluster localdb group remove group
Remove locally cached information for a group.
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