doveadm-director(1)

1DOVEADM-DIRECTOR(1)                 Dovecot                DOVEADM-DIRECTOR(1)
2
3
4

NAME

6       doveadm-director - Manage Dovecot directors
7

SYNOPSIS

9       doveadm [-Dv] director add [-a director_socket_path] host [vhost_count]
10       doveadm [-Dv] director flush [-a director_socket_path] host|all
11       doveadm  [-Dv]  director  map [-a director_socket_path] [-f users_file]
12       [host]
13       doveadm [-Dv] director remove [-a director_socket_path] host
14       doveadm [-Dv] director status [-a director_socket_path] [user]
15

DESCRIPTION

17       doveadm director can be used to manage and query the status of the list
18       of  backend  mail  servers where Dovecot proxy can redirect connections
19       to.
20

OPTIONS

22       Global doveadm(1) options:
23
24       -D     Enables verbosity and debug messages.
25
26       -v     Enables verbosity, including progress counter.
27
28       Command specific options:
29
30       -a director_socket_path
31              This option is used  to  specify  an  alternative  socket.   The
32              option's  argument  is  either  an absolute path to a local UNIX
33              domain socket, or a hostname and port (hostname:port), in  order
34              to connect a remote host via a TCP socket.
35
36              By   default  doveadm(1)  will  use  the  socket  /var/run/dove‐
37              cot/director-admin.  The socket may be located in another direc‐
38              tory,  when  the  default  base_dir  setting  was  overridden in
39              /etc/dovecot/dovecot.conf.
40

ARGUMENTS

42       host   A mail server's hostname or IP address.
43
44       user   Is a user's login name.  Depending on the configuration, a login
45              name may be for example jane or john@example.com.
46
47       vhost_count
48              The  number  of  "virtual  hosts"  to assign to this server. The
49              higher the number is relative to other servers, the more connec‐
50              tions it gets. The default is 100.
51

COMMANDS

53   director add
54       doveadm director add [-a director_socket_path] host [vhost_count]
55
56       The command's tasks are:
57
58       *   assign a new mail server to the director.
59
60       *   increase/decrease the vhost_count of an already assigned server.
61
62   director flush
63       doveadm director flush [-a director_socket_path] host|all
64
65       doveadm  director  flush  drops  all  user associations either from the
66       given host or all hosts.  This command is intended mainly  for  testing
67       purposes.
68
69   director map
70       doveadm director map [-a director_socket_path] [-f users_file] [host]
71
72       The  command  doveadm  director map is used to list current user → host
73       mappings.
74
75       -f users_file
76              Path to a file containing all user names (one per  line).   When
77              given no userdb lookup will be performed.  This may be a helpful
78              alternative when for example the network connection to the  LDAP
79              or SQL server is slow.
80
81       host   Specify a server's IP address or hostname, to list only mappings
82              of the given host.
83
84   director remove
85       doveadm director remove [-a director_socket_path] host
86
87       Use this command in oder to remove the given host from the director.
88
89   director status
90       doveadm director status [-a director_socket_path] [user]
91
92       This command is used to show the current usage  of  all  assigned  mail
93       servers.
94       When  a user name is given, this command shows which server the user is
95       currently assigned to, where the user will be assigned after  the  cur‐
96       rent saved assignment gets removed and where the user would be assigned
97       to if the whole proxy cluster was restarted fresh.
98

FILES

100       /etc/dovecot/dovecot.conf
101              Dovecot's main configuration file.
102
103       /etc/dovecot/conf.d/10-director.conf
104              Director specific settings.
105

EXAMPLE

107       Add a director with vhost count 150 (or  change  existing  one's  vhost
108       count to 150):
109
110       doveadm -v director add x1357.imap.ha.example.net 150
111       2001:db8:543:6861:143::1357: OK
112
113       Remove a director:
114
115       doveadm director remove x1357.imap.ha.example.net
116
117       Query the status of mail hosts in a director:
118
119       doveadm director status
120       mail server ip       vhosts  users
121       192.168.10.1            100    125
122       192.168.10.2            100    144
123       192.168.10.3            100    115
124
125       Query the status of a user's assignment:
126
127       doveadm director status user@example.com
128       Current: 192.168.10.1 (expires 2010-06-18 20:17:04)
129       Hashed: 192.168.10.2
130       Initial config: 192.168.10.3
131
132       This  means  that  the  user is currently assigned to mail server on IP
133       192.168.10.1. After all of user's  connections  have  logged  out,  the
134       assignment  will  be  removed (currently it looks like at 20:17:04, but
135       that may be increased). After the assignment has expired, the user will
136       next  time be redirected to 192.168.10.2 (assuming no changes to direc‐
137       tor settings). If the entire Dovecot proxy cluster  was  restarted,  so
138       that all of the director configuration would revert back to its initial
139       values, the user would be redirected to 192.168.10.3.
140

REPORTING BUGS

142       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
143       <dovecot@dovecot.org>.   Information  about reporting bugs is available
144       at: http://dovecot.org/bugreport.html
145