1DOVEADM-KICK(1) Dovecot DOVEADM-KICK(1)
2
3
4
6 doveadm-kick - Disconnect users by user name and/or IP address
7
9 doveadm [-Dv] kick [ -a anvil_socket_path] [-f] user
10 doveadm [-Dv] kick [ -a anvil_socket_path] [-f] ip[/mask]
11 doveadm [-Dv] kick [ -a anvil_socket_path] [-f] user ip[/mask]
12
14 doveadm's kick command is used to disconnect users by user name and/or
15 the ip address, from which they are connected.
16
17 In the first form, all users, whose login name matches the user argu‐
18 ment, will be disconnected.
19
20 In the second form, all users, connected from the given IP address or
21 network range, will be disconnected.
22
23 In the last form, only users connected from the given IP address or
24 networks range and a matching login name will be disconnected.
25
27 Global doveadm(1) options:
28
29 -D Enables verbosity and debug messages.
30
31 -v Enables verbosity, including progress counter.
32
33 Command specific options:
34
35 -a anvil_socket_path
36 This option is used to specify an absolute path to an alterna‐
37 tive UNIX domain socket.
38
39 By default doveadm(1) will use the socket /var/run/dove‐
40 cot/anvil. The socket may be located in another directory, when
41 the default base_dir setting was overridden in /etc/dove‐
42 cot/dovecot.conf.
43
44 -f Enforce the disconnect, even when there are multiple users, from
45 different networks, connected to a single process. This option
46 may be only required when you have configured something like:
47
48 service imap {
49 ...
50 client_limit = 1+n
51 service_count = 0
52 ...
53 }
54
56 ip[/mask]
57 ip or ip/mask is the host or network, from which the users are
58 connected.
59
60 user Is a user's login name. Depending on the configuration, a login
61 name may be for example jane or john@example.com. It's also
62 possible to use '*' and '?' wildcards (e.g. -u *@example.org).
63
65 If you don't want to disconnect all users at once, you can check who's
66 currently logged in. The first example demonstrates how to disconnect
67 all users whose login name is 3 characters long and begins with ba.
68
69 doveadm who -1 ja*
70 username proto pid ip
71 jane imap 8192 ::1
72 james imap 8203 2001:db8:543:2::1
73 doveadm kick ba?
74 kicked connections from the following users:
75 bar baz
76
77 The next example shows how to kick user foo's connections from
78 192.0.2.*.
79
80 doveadm who -1 foo
81 username proto pid ip
82 foo imap 8135 fd95:4eed:38ba::25
83 foo imap 9112 192.0.2.53
84 foo imap 8216 192.0.2.111
85 doveadm kick foo 192.0.2.0/24
86 kicked connections from the following users:
87 foo
88 doveadm who f*
89 username # proto (pids) (ips)
90 foo 1 imap (8135) (fd95:4eed:38ba::25)
91
93 Report bugs, including doveconf -n output, to the Dovecot Mailing List
94 <dovecot@dovecot.org>. Information about reporting bugs is available
95 at: http://dovecot.org/bugreport.html
96
98 doveadm(1), doveadm-who(1)
99
100
101
102Dovecot v2.0 2010-06-12 DOVEADM-KICK(1)