|
Size: 4112
Comment:
|
← Revision 18 as of 2022-04-26 07:08:39 ⇥
Size: 947
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| <p>doveadm-proxy - Handle Dovecot proxy connections</p> | <p>doveadm-proxy - Handle Dovecot proxy connections (obsolete)</p> |
| Line 7: | Line 7: |
| <p><b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>proxy</b><i> command</i> | <p><b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>proxy</b><i> kick</i> [<i>OPTIONS</i>] [<i>ARGUMENTS</i>]<br> <b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>proxy</b><i> list</i> |
| Line 11: | Line 13: |
| <p>The <b>doveadm proxy</b> <i>commands</i> are used to list or kick active Dovecot proxy connections.</p> <h2 id="section_options">Options <a class="permalink" href="#section_options">☜</a></h2> <p>Global <b><a href="/Tools/Doveadm">doveadm</a></b>(1) <i>options</i>:</p> <dl class="man_dl"> <dt><b>-D</b></dt> <dd>Enables verbosity and debug messages.</dd> <dt><b>-f </b><i>formatter</i></dt> <dd>Specifies the <i>formatter</i> for formatting the output. Supported formatters are: <dl class="man_dl"> <dd> <dl class="man_dl"> <dt><b>flow</b></dt> <dd>prints each line with <i>key</i><b>=</b><i>value</i> pairs.</dd> <dt><b>pager</b></dt> <dd>prints each <i>key</i>: <i>value</i> pair on its own line and separates records with form feed character (<b>^L</b>).</dd> <dt><b>tab</b></dt> <dd>prints a table header followed by tab separated value lines.</dd> <dt><b>table</b></dt> <dd>prints a table header followed by adjusted value lines.</dd> </dl> </dd> </dl> </dd> <dt><b>-o </b><i>setting</i><b>=</b><i>value</i></dt> <dd>Overrides the configuration <i>setting</i> from <i>/etc/dovecot/dovecot.conf</i> and from the userdb with the given <i>value</i>. In order to override multiple settings, the <b>-o</b> option may be specified multiple times.</dd> <dt><b>-v</b></dt> <dd>Enables verbosity, including progress counter.</dd> </dl> <p>This command uses by default the <b>table</b> output formatter.</p> <p>Command specific <i>options</i>:</p> <dl class="man_dl"> <dt><b>-a</b><i> ipc_socket_path</i></dt> <dd>This option is used to specify an alternative socket. The option's argument is either an absolute path to a local UNIX domain socket. <p>By default <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will use the socket <i>/var/run/dovecot/ipc</i>. The socket may be located in another directory, when the default <i>base_dir</i> setting was overridden in <i>/etc/dovecot/dovecot.conf</i>.</p> </dd> </dl> <h2 id="section_arguments">Arguments <a class="permalink" href="#section_arguments">☜</a></h2> <dl class="man_dl"> <dt><i>user</i></dt> <dd>Is a <i>user</i>'s login name. Depending on the configuration, a login name may be for example <b>jane</b> or <b>john@example.com</b>. It's also possible to use "<b>*</b>" and "<b>?</b>" wildcards (e.g. *@example.org).</dd> </dl> <h2 id="section_commands">Commands <a class="permalink" href="#section_commands">☜</a></h2> <h3 id="command_proxy_kick">Proxy Kick <a class="permalink" href="#command_proxy_kick">☜</a></h3> <p><b>doveadm proxy kick</b> [<b>-a</b> <i>ipc_socket_path</i>] [<b>-f</b> <i>passdb_field</i>] [<b>-h</b> <i>host_list</i> | <i>user_list</i>]</p> <p>Kick all the connections being proxied for the given <i>user_list</i> or for the given backend <i>host_list</i>.</p> <h3 id="command_proxy_list">Proxy List <a class="permalink" href="#command_proxy_list">☜</a></h3> <p><b>doveadm proxy list</b> [<b>-a</b> <i>ipc_socket_path</i>]</p> <p>List all the users currently being proxied.</p> <h2 id="section_example">Example <a class="permalink" href="#section_example">☜</a></h2> <p>List all currently active proxy connections:</p> <pre> <b>doveadm proxy list</b> username proto src ip dest ip port jane@example.net imap 192.168.0.100 192.168.0.5 143 </pre> |
<p>These commands are aliases to the <b>doveadm kick</b> and <b>doveadm who</b> commands.</p> |
Doveadm-Proxy
Name ☜
doveadm-proxy - Handle Dovecot proxy connections (obsolete)
Synopsis ☜
doveadm [-Dv] [-f formatter] proxy kick
[OPTIONS] [ARGUMENTS]
doveadm [-Dv] [-f formatter] proxy list
[OPTIONS] [ARGUMENTS]
Description ☜
These commands are aliases to the doveadm kick and doveadm who commands.
See Also ☜
doveadm(1)