1RADDEBUG(8)                    FreeRADIUS Daemon                   RADDEBUG(8)
2
3
4

NAME

6       raddebug - Display debugging output from a running server.
7

SYNOPSIS

9       raddebug  [-c  condition]  [-d  config_directory] [-i ipv4-address] [-I
10       ipv6-address] [-f socket_file] [-t timeout] [-u user-name]
11

DESCRIPTION

13       raddebug is a shell script wrapper around  radmin  that  automates  the
14       process  of  obtaining debugging output from a running server.  It does
15       this without impacting service availability, unlike using  radiusd  -X.
16       There  are  a  number of prerequisites that are required for its proper
17       operation:
18
19          * radmin must be available in the PATH.
20          * The user running raddebug must have permission to connect to
21            the server control socket.
22          * The control socket must be configured.  For instructions, see
23            raddb/sites-available/control-socket
24          * The control socket must be marked as "mode = rw".
25          * The user running raddebug must have permission to read and
26            write files in the "logdir" directory.  This is usually
27            /var/log/radiusd.
28
29       For a number of reasons, the debugging output is placed in an  interme‐
30       diate  file,  rather  than  being sent directly to standard output.  In
31       order to prevent this file from growing too large, the raddebug program
32       is  automatically  terminated  after  10  seconds.  This timeout can be
33       changed via the "-t" parameter.
34
35       When the script exits, debug mode in the server is  disabled,  and  the
36       intermediate file is deleted.
37
38       Debug output from a live server can be redirected to only one location.
39       If a second instance of raddebug is started  while  the  first  one  is
40       still  running,  the  later  one  will over-ride the first one, and the
41       first will stop producing output.
42

OPTIONS

44       -c condition
45              Set a specific debug condition.  The format of the condition  is
46              as  specified  in  the  CONDITIONS  section of the unlang manual
47              page.
48
49       -f socket_file
50              The path to the control socket.  See the radmin manual page  for
51              more description of this option.
52
53       -i ipv4-address
54              Show  debug output for the client having the given IPv4 address.
55              This option is equivalent to using:
56                 -c '(Packet-Src-IP-Address == ipv4-address)'
57
58       -d config directory
59              The radius configuration directory, usually /etc/raddb.  See the
60              radmin manual page for more description of this option.
61
62       -I ipv6-address
63              Show  debug output for the client having the given IPv6 address.
64              This option is equivalent to using:
65                 -c '(Packet-Src-IPv6-Address == ipv6-address)'
66
67       -t timeout
68              Stop printing debug output after "timeout" seconds.  The default
69              timeout  is  sixty  (60) seconds.  Use "-t 0" to print debugging
70              output forever, or until the script exits.
71
72       -u name
73              Show debug output for users having the given name.  This  option
74              is equivalent to using:
75                 -c '(User-Name == name)'
76
77

SEE ALSO

79       radmin(8),        raddb/sites-available/control-socket,      unlang(5),
80       radiusd.conf(5)
81

AUTHORS

83       Alan DeKok <aland@freeradius.org>
84
85
86
87                               1 September 2010                    RADDEBUG(8)
Impressum