doveadm-proxy(1)

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

NAME

6       doveadm-proxy - Handle Dovecot proxy connections
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] proxy command [OPTIONS] [ARGUMENTS]
10

DESCRIPTION

12       The  doveadm  proxy  commands  are  used to list or kick active Dovecot
13       proxy connections.
14

OPTIONS

16       Global doveadm(1) options:
17
18       -D     Enables verbosity and debug messages.
19
20       -f formatter
21              Specifies the formatter for formatting  the  output.   Supported
22              formatters are:
23
24              flow   prints each line with key=value pairs.
25
26              pager  prints each key: value pair on its own line and separates
27                     records with form feed character (^L).
28
29              tab    prints a table header followed  by  tab  separated  value
30                     lines.
31
32              table  prints a table header followed by adjusted value lines.
33
34       -o setting=value
35              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
36              cot.conf and from the userdb with the given value.  In order  to
37              override  multiple settings, the -o option may be specified mul‐
38              tiple times.
39
40       -v     Enables verbosity, including progress counter.
41
42       This command uses by default the table output formatter.
43
44       Command specific options:
45
46       -a ipc_socket_path
47              This option is used  to  specify  an  alternative  socket.   The
48              option's  argument  is  either  an absolute path to a local UNIX
49              domain socket.
50
51              By default doveadm(1) will use the socket /run/dovecot/ipc.  The
52              socket  may  be  located  in another directory, when the default
53              base_dir setting was overridden in /etc/dovecot/dovecot.conf.
54

ARGUMENTS

56       user   Is a user's login name.  Depending on the configuration, a login
57              name  may  be  for  example jane or john@example.com.  It's also
58              possible to use "*" and "?" wildcards (e.g. *@example.org).
59

COMMANDS

61   proxy kick
62       doveadm proxy kick [-a ipc_socket_path] [-f passdb_field] [-h host_list
63       | user]
64
65
66       Kick  all the connections being proxied for the given user.  or for the
67       given backend hosts_list.
68
69   proxy list
70       doveadm proxy list [-a ipc_socket_path]
71
72       List all the users currently being proxied.
73

EXAMPLE

75       List all currently active proxy connections:
76
77       doveadm proxy list
78       username                    proto src ip          dest ip     port
79       jane@example.net            imap  192.168.0.100   192.168.0.5 143
80

REPORTING BUGS

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