This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 5 and 6
Revision 5 as of 2017-05-15 07:10:10
Size: 4263
Editor: PageImporter
Comment:
Revision 6 as of 2017-05-15 07:18:25
Size: 4236
Editor: PageImporter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 14: Line 14:
<p>Global <b><a href="/man/man2html?1+doveadm">doveadm</a></b>(1) <i>options</i>:</p> <p>Global <b><a href="/Tools/Doveadm">doveadm</a></b>(1) <i>options</i>:</p>
Line 50: Line 50:
<p>By default <b><a href="/man/man2html?1+doveadm">doveadm</a></b>(1) will use the socket <p>By default <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will use the socket
Line 77: Line 77:
<p><b><a href="/man/man2html?1+doveadm">doveadm</a></b>(1) }}} <p><b><a href="/Tools/Doveadm">doveadm</a></b>(1) }}}

Doveadm-Proxy

Name

doveadm-proxy - Handle Dovecot proxy connections

Synopsis

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

Description

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

Options

Global doveadm(1) options:

-D
Enables verbosity and debug messages.
-f formatter
Specifies the formatter for formatting the output. Supported formatters are:
flow
prints each line with key=value pairs.
pager
prints each keyvalue 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.
-o setting=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.

This command uses by default the table output formatter.

Command specific options:

-a ipc_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 /var/run/dovecot/ipc. The socket may be located in another directory, when the default base_dir setting was overridden in /etc/dovecot/dovecot.conf.

Arguments

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

Commands

Proxy Kick

doveadm proxy kick [-a ipc_socket_path] user

Kick all the connections being proxied for the given user.

Proxy List

doveadm proxy list [-a ipc_socket_path]

List all the users currently being proxied.

Example

List all currently active proxy connections:

doveadm proxy list
username                    proto src ip          dest ip     port
jane@example.net            imap  192.168.0.100   192.168.0.5 143

See Also

doveadm(1)


CategoryMan

None: Tools/Doveadm/Proxy (last edited 2022-04-26 07:08:39 by PageImporter)