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