doveadm-kick(1)

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

NAME

6       doveadm-kick - Disconnect users by user name and/or IP address
7

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

27       Global doveadm(1) options:
28
29       -D     Enables verbosity and debug messages.
30
31       -o setting=value
32              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
33              cot.conf and from the userdb with the given value.  In order  to
34              override  multiple settings, the -o option may be specified mul‐
35              tiple times.
36
37       -v     Enables verbosity, including progress counter.
38
39       Command specific options:
40
41       -a anvil_socket_path
42              This option is used to specify an absolute path to  an  alterna‐
43              tive UNIX domain socket.
44
45              By   default  doveadm(1)  will  use  the  socket  /var/run/dove‐
46              cot/anvil.  The socket may be located in another directory, when
47              the  default  base_dir  setting  was  overridden  in  /etc/dove‐
48              cot/dovecot.conf.
49
50       -f     Enforce the disconnect, even when there are multiple users, from
51              different  networks, connected to a single process.  This option
52              may be only required when you have configured something like:
53
54              service imap {
55                ...
56                client_limit = 1+n
57                service_count = 0
58                ...
59              }
60

ARGUMENTS

62       ip[/mask]
63              ip or ip/mask is the host or network, from which the  users  are
64              connected.
65
66       user   Is a user's login name.  Depending on the configuration, a login
67              name may be for example jane  or  john@example.com.   It's  also
68              possible to use '*' and '?' wildcards (e.g. -u *@example.org).
69

EXAMPLE

71       If  you don't want to disconnect all users at once, you can check who's
72       currently logged in.  The first example demonstrates how to  disconnect
73       all users whose login name is 3 characters long and begins with ba.
74
75       doveadm who -1 ja*
76       username                      proto pid  ip
77       jane                          imap  8192 ::1
78       james                         imap  8203 2001:db8:543:2::1
79       doveadm kick ba?
80       kicked connections from the following users:
81       bar baz
82
83       The  next  example  shows  how  to  kick  user  foo's  connections from
84       192.0.2.*.
85
86       doveadm who -1 foo
87       username                     proto pid  ip
88       foo                          imap  8135 fd95:4eed:38ba::25
89       foo                          imap  9112 192.0.2.53
90       foo                          imap  8216 192.0.2.111
91       doveadm kick foo 192.0.2.0/24
92       kicked connections from the following users:
93       foo
94       doveadm who f*
95       username                  # proto (pids) (ips)
96       foo                       1 imap  (8135) (fd95:4eed:38ba::25)
97

REPORTING BUGS

99       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
100       <dovecot@dovecot.org>.   Information  about reporting bugs is available
101       at: http://dovecot.org/bugreport.html
102