doveadm-director - Manage Dovecot directors

host   A mail server's hostname or IP address.

       ip     A director's IP address.

       port   The TCP port, on which the director server is listening for connections.  The default port is  the
              same as what the local director is listening in.

       user   Is  a  user's login name.  Depending on the configuration, a login name may be for example jane or
              john@example.com.

       vhost_count
              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.

directoradddoveadmdirectoradd [-adirector_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.

   directordumpdoveadmdirectordump [-adirector_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.

   directorflushdoveadmdirectorflush [-adirector_socket_path] [-F] [--max-paralleln] host|alldoveadmdirectorflush  removes  all user associations either from the given host or all hosts. All the
       existing connections will be kicked. If director_flush_socket  is  specified,  a  flush  script  is  also
       automatically executed.

       Because  the  kicking  and  moving of users to new backends creates a temporary load spike, all the users
       aren't moved at once. The --max-parallel parameter specifies how many users can  be  moved  concurrently.
       The default is 100.

       If  the  -F  parameter  is  used, the user associations are simply dropped. Existing connections won't be
       kicked and flush scripts aren't run.

   directorkickdoveadmdirectorkick [-adirector_socket_path] user

       Kick the specified user from the entire Dovecot cluster.  This is similar to doveadm proxy kick, but this
       command needs to be run only once instead of in each director server.

   directormapdoveadmdirectormap [-adirector_socket_path] [-fusers_file] [-h|-u] [host]

       The command doveadmdirectormap 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.

       -fusers_file
              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.

       -h     Output all usernames, which match the given hash.

       -u     Output hash for the given username.

       host   Specify a server's IP address or hostname, to list only mappings of the given host.

   directormovedoveadmdirectormove [-adirector_socket_path] userhost

       Move  the  user  to  the  specified  backend host.  If the user has any existing connections they will be
       killed.

   directorremovedoveadmdirectorremove [-adirector_socket_path] host

       Use this command in order to remove the given host from the director.

   directorringadddoveadmdirectorringadd [-adirector_socket_path] ip [port]

       Add a new director to the ring.

   directorringremovedoveadmdirectorringremove [-adirector_socket_path] ip [port]

       Remove a director from the ring.

   directorringstatusdoveadmdirectorringstatus [-adirector_socket_path]

       Show the status of all the directors currently in the ring.

   directorstatusdoveadmdirectorstatus [-adirector_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.

doveadmdirector  can  be  used to manage and query the status of the list of backend mail servers where
       Dovecot proxy can redirect connections to.

       Add a director with vhost count 150 (or change existing one's vhost count to 150):

       doveadm-vdirectoraddx1357.imap.ha.example.net150
       2001:db8:543:6861:143::1357: OK

       Remove a director:

       doveadmdirectorremovex1357.imap.ha.example.net

       Query the status of mail hosts in a director:

       doveadmdirectorstatus
       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:

       doveadmdirectorstatususer@example.com
       Current: 192.168.10.1 (expires 2010-06-18 20:17:04)
       Hashed: 192.168.10.2
       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  settings).  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 192.168.10.3.

/etc/dovecot/dovecot.conf
              Dovecot's main configuration file.

       /etc/dovecot/conf.d/10-director.conf
              Director specific settings.

       doveadm-director - Manage Dovecot directors

       Global doveadm(1) options:

       -D     Enables verbosity and debug messages.

       -fformatter
              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.

       -osetting=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.

       -v     Enables verbosity, including progress counter.

       Command specific options:

       -adirector_socket_path
              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 /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.

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

doveadm(1)

Dovecot v2.3                                       2014-08-30                                DOVEADM-DIRECTOR(1)

doveadm [-Dv] [-fformatter] directorcommand [OPTIONS] [ARGUMENTS]