Update radwho.1
[freeradius.git] / man / man1 / radwho.1
1 .TH RADWHO 1 "17 Feb 2013" "" "FreeRADIUS Daemon"
2 .SH NAME
3 radwho - show online users
4 .SH SYNOPSIS
5 .B radwho
6 .RB [ \-c ]
7 .RB [ \-d
8 .IR raddb_directory ]
9 .RB [ \-F
10 .IR radutmp_file ]
11 .RB [ \-i ]
12 .RB [ \-n ]
13 .RB [ \-N
14 .IR nas_ip_address ]
15 .RB [ \-p ]
16 .RB [ \-P
17 .IR nas_port ]
18 .RB [ \-r ]
19 .RB [ \-R ]
20 .RB [ \-s ]
21 .RB [ \-S ]
22 .RB [ \-u
23 .IR user ]
24 .RB [ \-U
25 .IR user ]
26 .RB [ \-Z ]
27 .SH DESCRIPTION
28 The FreeRADIUS server can be configured to maintain an active session
29 database in a file called \fIradutmp\fP. This utility shows the
30 content of that session database.
31 .SH OPTIONS
32 .IP \-c
33 Shows caller ID (if available) instead of the full name.
34 .IP \-d\ \fIraddb_directory\fP
35 The directory that contains the RADIUS configuration files. Defaults to
36 \fI/etc/raddb\fP.
37 .IP \-F\ \fIradutmp_file\fP
38 The file that contains the radutmp file.  If this is specified, -d is
39 not necessary.
40 .IP \-i
41 Shows the session ID instead of the full name.
42 .IP \-n
43 Normally radwho looks up the username in the systems password file,
44 and shows the full username as well. The \fB-n\fP flags prevents this.
45 .IP \-N\ \fInas_ip_address\fP
46 Show only those entries which match the given NAS IP address.
47 .IP \-p
48 Adds an extra column for the port type - I for ISDN, A for Analog.
49 .IP \-P\ \fInas_port\fP
50 Show only those entries which match the given NAS port.
51 .IP \-r
52 Outputs all data in \fIraw\fP format - no headers, no formatting,
53 fields are comma-separated.
54 .IP \-R
55 Output all data in RADIUS attribute format.  All fields are printed.
56 .IP \-s
57 Show full name.
58 .IP \-S
59 Hide shell users. Doesn't show the entries for users that do not
60 have a SLIP or PPP session.
61 .IP \-u\ \fIuser\fP
62 Show only those entries which match the given username (case insensitive).
63 .IP \-U\ \fIuser\fP
64 Show only those entries which match the given username (case sensitive).
65 .IP \-Z
66 When combined with \fI-R\fP, prints out the contents of an
67 Accounting-Request packet which can be passed to \fIradclient\fP, in
68 order to "zap" that users session from \fIradutmp\fP.
69 .PP
70 For example,
71 .RS
72 .sp
73 .nf
74 .ne 3
75 $ radwho -ZRN 10.0.0.1 | radclient -f - radius.example.net acct testing123
76 .fi
77 .sp
78 .RE
79 will result in all an Accounting-Request packet being sent to the
80 RADIUS server, which tells the server that the NAS rebooted.  i.e. It
81 "zaps" all of the users on that NAS.
82
83 To "zap" one user, specify NAS, username, and NAS port:
84 .RS
85 .sp
86 .nf
87 .ne 3
88 $ radwho -ZRN 10.0.0.1 -u user -P 10 | radclient -f - radius.example.net acct testing123
89 .fi
90 .sp
91 .RE
92 Other combinations are also possible.
93
94 .SH SEE ALSO
95 radiusd(8),
96 radclient(1),
97 radiusd.conf(5).
98 .SH AUTHOR
99 Miquel van Smoorenburg, miquels@cistron.nl.