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] [-D dictionary_directory]
10       [-n name] [-i ipv4-address]  [-I  ipv6-address]  [-f  socket_file]  [-t
11       timeout] [-u user-name]
12

DESCRIPTION

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

OPTIONS

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

SEE ALSO

87       radmin(8),        raddb/sites-available/control-socket,      unlang(5),
88       radiusd.conf(5)
89

AUTHORS

91       Alan DeKok <aland@freeradius.org>
92
93
94
95                               1 September 2010                    RADDEBUG(8)
Impressum