DOVEADM-DIRECTOR(1)                 Dovecot                DOVEADM-DIRECTOR(1)

<?><?><?> (NAME)
       doveadm-director - <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>
       Dovecot

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       doveadm [-Dv] [-f formatter] director command [OPTIONS] [ARGUMENTS]

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> doveadm director <?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> backend <?><?>
       <?><?><?><?><?><?> Dovecot <?><?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?>.

<?><?><?><?><?><?><?><?> (OPTIONS)
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> doveadm(1):

       -D     <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>
              (debug) <?> <?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?>.

       -f formatter
              <?><?><?><?><?><?><?><?> (formatter) <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?>.  <?><?><?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?>:

              flow   <?><?> <?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?>
                     key=value <?><?><?> <?><?><?><?><?><?>.

              pager  <?><?> <?><?><?> key: value <?><?> <?><?> <?><?>
                     <?><?><?> <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?>
                     <?> <?><?><?><?><?><?><?> <?><?> <?><?>
                     <?><?><?><?><?><?> <?><?><?><?><?><?><?> (^L) <?><?>
                     <?><?> <?><?><?> <?><?><?><?><?><?>.

              tab    <?><?> <?><?><?><?><?> <?><?><?><?> <?> <?><?>
                     <?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>
                     <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?> (tab)
                     <?><?> <?><?><?> <?><?><?><?><?><?>.

              table  <?><?> <?><?><?><?><?> <?><?><?><?> <?> <?><?>
                     <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
                     <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?>
                     <?><?><?><?><?><?>.

       -o setting=value
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> setting <?><?> <?><?>
              /etc/dovecot/dovecot.conf <?> <?><?> userdb <?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?><?> value
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?> -o <?><?>
              <?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?>.

       -v     <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>.

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?>:

       -a director_socket_path
              <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?>.  <?><?><?><?><?><?><?> <?><?><?>
              <?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?><?> <?><?>
              <?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?> <?><?><?>
              <?><?><?><?><?><?> <?> <?><?><?><?><?> (hostname:port)<?>
              <?><?><?> <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?> TCP.

              <?><?><?><?><?><?> <?><?><?><?><?><?><?> doveadm(1) <?><?>
              <?><?><?><?> /run/dovecot/director-admin <?><?><?><?><?><?><?>
              <?><?><?><?><?><?>. <?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?> base_dir <?><?> /etc/dovecot/dovecot.conf
              <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?>
              <?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?>.

<?><?><?><?><?><?><?><?><?><?> (ARGUMENTS)
       host   <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?> IP <?><?>
              <?><?><?><?> <?><?><?><?><?>.

       ip     <?><?><?><?><?> IP <?><?> <?><?><?><?><?><?><?><?> (director).

       port   <?><?><?><?><?> TCP <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?>.  <?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?>.

       user   <?><?><?> <?><?><?><?> <?><?><?><?><?> (user).  <?><?><?><?>
              <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?>
              jane <?><?> john@example.com <?><?><?><?>.

       vhost_count
              <?><?><?><?><?> <<<?><?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?>>> (virtual hosts)
              <?><?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?>
              <?><?><?><?>. <?><?><?><?> <?><?><?> <?><?><?> <?><?><?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?> <?><?><?>.

<?><?><?><?><?><?><?> (COMMANDS)
   director add
       doveadm director add [-a director_socket_path] host [vhost_count]

       <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>:

       *   <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>.

       *   <?><?><?><?><?><?> <?><?> <?><?><?><?> vhost_count <?><?>
           <?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?> <?><?><?> <?><?><?>.

   director dump
       doveadm director dump [-a director_socket_path]

       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?> doveadm <?><?><?><?><?> (dump)
       <?><?><?><?><?><?>. <?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>.

   director flush
       doveadm director flush [-a director_socket_path] [-F] [--x-parallel n]
       host|all

       <?><?><?><?><?> doveadm director flush <?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?> (host) <?><?><?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?> (all) <?><?><?>
       <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?> (kick) <?><?><?><?><?><?> <?><?>.
       <?><?><?> director_flush_socket <?><?><?><?> <?><?><?> <?><?><?><?><?>
       <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> (flush) <?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>.

       <?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?> (load spike) <?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?>.
       <?><?><?><?><?><?><?> --x-parallel <?><?><?><?> <?><?><?><?><?><?>
       <?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?> <?><?><?>.

       <?><?><?> <?><?> <?><?><?><?><?><?><?> -F <?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?> (drop) <?><?><?><?><?><?><?>.
       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?>
       <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?>.

   director kick
       doveadm director kick [-a director_socket_path] user

       <?><?><?><?><?> (user) <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?>
       <?><?><?><?><?> Dovecot <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       (kick).  <?><?><?> <?><?><?><?><?> <?><?><?><?><?> doveadm proxy kick
       <?><?><?><?> <?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?> <?><?>
       <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>.

   director map
       doveadm director map [-a director_socket_path] [-f users_file] [-h|-u]
       [host]

       <?><?><?><?><?> doveadm director map <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> user -> host
       <?><?><?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?> (collision) <?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?> <?>
       <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?>
       <?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?>.

       -f users_file
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?> (<?><?> <?><?><?>
              <?><?> <?><?> <?><?><?>).  <?><?> <?><?><?><?>
              <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?> userdb
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?>.  <?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
              LDAP <?><?> SQL <?><?><?> <?><?><?>.

       -h     <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?> <?><?><?><?><?><?>.

       -u     <?><?> <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?>.

       host   <?><?><?><?><?> IP <?><?> <?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
              host <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>.

   director move
       doveadm director move [-a director_socket_path] user host

       <?><?><?><?><?> (user) <?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?> (host) <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?> user <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> (kill).

   director remove
       doveadm director remove [-a director_socket_path] host

       <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?> host
       <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?>.

   director ring add
       doveadm director ring add [-a director_socket_path] ip [port]

       <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?> <?><?><?><?>
       (ring) <?><?><?><?><?> <?><?><?><?><?><?>.

   director ring remove
       doveadm director ring remove [-a director_socket_path] ip [port]

       <?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?>
       <?><?><?><?><?><?>.

   director ring status
       doveadm director ring status [-a director_socket_path]

       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?>.

   director status
       doveadm director status [-a director_socket_path] [user]

       <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?>.
       <?><?><?><?><?><?> <?><?> <?><?> <?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?> user <?><?> <?><?><?> <?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?> <?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?>
       <?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?><?><?>.

<?><?><?><?><?><?><?> (FILES)
       /etc/dovecot/dovecot.conf
              <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> Dovecot.

       /etc/dovecot/conf.d/10-director.conf
              <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?>
              (Director).

<?><?><?><?><?><?><?> (EXAMPLES)
       <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> vhost <?><?><?><?><?> <?><?> <?><?><?> (<?><?>
       <?><?><?><?><?> vhost <?><?><?><?><?> <?><?> <?><?><?>):

       doveadm -v director add x1357.imap.ha.example.net 150
       2001:db8:543:6861:143::1357: OK

       <?><?><?> <?><?> <?><?><?><?><?><?><?><?>:

       doveadm director remove x1357.imap.ha.example.net

       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?><?>:

       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

       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?><?>:

       doveadm director status user@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

       <?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?> <?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?> <?><?><?><?><?> IP <?><?><?><?><?> <?><?> 192.168.10.1
       <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?>. <?><?> <?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?> (<?><?>
       <?><?><?> <?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?> <?><?>
       <?><?><?><?> 20:17:04<?> <?><?><?> <?><?><?><?> <?><?><?>
       <?><?><?><?><?><?> <?><?><?><?>). <?><?> <?><?> <?><?><?><?><?>
       <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?>
       <?><?> 192.168.10.2 <?><?><?><?><?> <?><?><?><?><?> <?><?> (<?><?>
       <?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?>). <?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?> Dovecot <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> 192.168.10.3 <?><?><?><?><?> <?><?><?><?><?>
       <?><?>.

<?><?><?><?><?> <?><?><?><?><?><?> (BUGS)
       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       doveconf -n <?><?> <?><?> <?><?><?><?><?> <?><?><?><?> Dovecot <?><?>
       <?><?><?><?><?> <dovecot@dovecot.org> <?><?><?><?><?> <?><?><?><?>.
       <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?>: <http://dovecot.org/bugreport.html>

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       doveadm(1)

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