GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DOVEADM-PROXY (1)

NAME

doveadm-proxy - Handle Dovecot proxy connections

CONTENTS

Synopsis
Description
Options
Arguments
Commands
Example
Reporting Bugs
See Also

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 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.
-o setting=value
  Overrides the configuration setting from /usr/local/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\(aqs 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 /usr/local/etc/dovecot/dovecot.conf.

ARGUMENTS

user Is a user\(aqs login name. Depending on the configuration, a login name may be for example jane or john@example.com. It\(aqs also possible to use \(dq*\(dq and \(dq?\(dq 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

REPORTING BUGS

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

SEE ALSO

doveadm(1)
Search for    or go to Top of page |  Section 1 |  Main Index


Dovecot v2.2 DOVEADM-PROXY (1) 2014-10-07

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.