DOVEADM-DIRECTOR(1) Dovecot DOVEADM-DIRECTOR(1)
doveadm-director - Manage Dovecot directors
doveadm [-Dv] director add [-a director_socket_path] host [vhost_count]
doveadm [-Dv] director flush [-a director_socket_path] host|all
doveadm [-Dv] director map [-a director_socket_path] [-f users_file] [host]
doveadm [-Dv] director remove [-a director_socket_path] host
doveadm [-Dv] director dump [-a director_socket_path]
doveadm [-Dv] director status [-a director_socket_path] [user]
doveadm director can be used to manage and query the status of the list of backend mail
servers where Dovecot proxy can redirect connections to.
Global doveadm(1) options:
-D Enables verbosity and debug messages.
-v Enables verbosity, including progress counter.
Command specific options:
This option is used to specify an alternative socket. The option's argument is
either an absolute path to a local UNIX domain socket, or a hostname and port
(hostname:port), in order to connect a remote host via a TCP socket.
By default doveadm(1) will use the socket /var/run/dovecot/director-admin. The
socket may be located in another directory, when the default base_dir setting was
overridden in /etc/dovecot/dovecot.conf.
host A mail server's hostname or IP address.
user Is a user's login name. Depending on the configuration, a login name may be for
example jane or email@example.com.
The number of "virtual hosts" to assign to this server. The higher the number is
relative to other servers, the more connections it gets. The default is 100.
doveadm director add [-a director_socket_path] host [vhost_count]
The command's tasks are:
* assign a new mail server to the director.
* increase/decrease the vhost_count of an already assigned server.
doveadm director flush [-a director_socket_path] host|all
doveadm director flush drops all user associations either from the given host or all
hosts. This command is intended mainly for testing purposes.
doveadm director map [-a director_socket_path] [-f users_file] [host]
The command doveadm director map is used to list current user -> host mappings. Note that
the director works using 32bit hashes which makes collisions quite likely, so this command
can't reliably list exactly which users have recently logged in.
Path to a file containing all user names (one per line). When given no userdb
lookup will be performed. This may be a helpful alternative when for example the
network connection to the LDAP or SQL server is slow.
host Specify a server's IP address or hostname, to list only mappings of the given host.
doveadm director remove [-a director_socket_path] host
Use this command in order to remove the given host from the director.
doveadm director dump [-a director_socket_path]
Dump the current host configuration as doveadm commands. These commands can be easily run
after a full director cluster restart to get back to the dumped state.
doveadm director status [-a director_socket_path] [user]
This command is used to show the current usage of all assigned mail servers.
When a user name is given, this command shows which server the user is currently assigned
to, where the user will be assigned after the current saved assignment gets removed and
where the user would be assigned to if the whole proxy cluster was restarted fresh.
Dovecot's main configuration file.
Director specific settings.
Add a director with vhost count 150 (or change existing one's vhost count to 150):
doveadm -v director add x1357.imap.ha.example.net 150
Remove a director:
doveadm director remove x1357.imap.ha.example.net
Query the status of mail hosts in a director:
doveadm director status
mail server ip vhosts users
192.168.10.1 100 125
192.168.10.2 100 144
192.168.10.3 100 115
Query the status of a user's assignment:
doveadm director status firstname.lastname@example.org
Current: 192.168.10.1 (expires 2010-06-18 20:17:04)
Initial config: 192.168.10.3
This means that the user is currently assigned to mail server on IP 192.168.10.1. After
all of user's connections have logged out, the assignment will be removed (currently it
looks like at 20:17:04, but that may be increased). After the assignment has expired, the
user will next time be redirected to 192.168.10.2 (assuming no changes to director set-
tings). If the entire Dovecot proxy cluster was restarted, so that all of the director
configuration would revert back to its initial values, the user would be redirected to
Report bugs, including doveconf -n output, to the Dovecot Mailing List <dovecot@dove-
cot.org>. Information about reporting bugs is available at: http://dovecot.org/bugre-
Dovecot v2.2 2013-07-12 DOVEADM-DIRECTOR(1)