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 dump [-a director_socket_path]
15       doveadm [-Dv] director status [-a director_socket_path] [user]
16

DESCRIPTION

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

OPTIONS

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

ARGUMENTS

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

COMMANDS

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

FILES

108       /etc/dovecot/dovecot.conf
109              Dovecot's main configuration file.
110
111       /etc/dovecot/conf.d/10-director.conf
112              Director specific settings.
113

EXAMPLE

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

REPORTING BUGS

150       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
151       <dovecot@dovecot.org>.   Information  about reporting bugs is available
152       at: http://dovecot.org/bugreport.html
153