.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "doc::Smokeping::probes::Radius 3"
.TH doc::Smokeping::probes::Radius 3 "2008-07-24" "2.4.2" "SmokePing"
.SH "NAME"
Smokeping::probes::Radius \- a RADIUS authentication probe for SmokePing
.SH "OVERVIEW"
.IX Header "OVERVIEW"
Measures \s-1RADIUS\s0 authentication latency for SmokePing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
.Ve
.PP
.Vb 1
\& +Radius
.Ve
.PP
.Vb 5
\& forks = 5
\& offset = 50%
\& passwordfile = /some/place/secret
\& secretfile = /another/place/secret
\& step = 300
.Ve
.PP
.Vb 9
\& # The following variables can be overridden in each target section
\& mininterval = 1
\& nas_ip_address = 10.1.2.3
\& password = test\-password
\& pings = 5
\& port = 1645
\& secret = test\-secret
\& timeout = 5
\& username = test\-user # mandatory
.Ve
.PP
.Vb 1
\& # [...]
.Ve
.PP
.Vb 1
\& *** Targets ***
.Ve
.PP
.Vb 1
\& probe = Radius # if this should be the default probe
.Ve
.PP
.Vb 1
\& # [...]
.Ve
.PP
.Vb 11
\& + mytarget
\& # probe = Radius # if the default probe is something else
\& host = my.host
\& mininterval = 1
\& nas_ip_address = 10.1.2.3
\& password = test\-password
\& pings = 5
\& port = 1645
\& secret = test\-secret
\& timeout = 5
\& username = test\-user # mandatory
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This probe measures \s-1RADIUS\s0 (\s-1RFC\s0 2865) authentication latency for SmokePing.
.PP
The username to be tested is specified in either the probe-specific or the 
target-specific variable `username', with the target-specific one overriding
the probe-specific one.
.PP
The password can be specified either (in order of precedence, with
the latter overriding the former) in the probe-specific variable
`password', in an external file or in the target-specific variable
`password'.  The location of this file is given in the probe-specific
variable `passwordfile'. See \fISmokeping::probes::passwordchecker\fR\|(3pm) for the
format of this file (summary: colon-separated triplets of the form
`<host>:<username>:<password>')
.PP
The \s-1RADIUS\s0 protocol requires a shared secret between the server and the client.
This secret can be specified either (in order of precedence, with the latter
overriding the former) in the probe-specific variable `secret', in an external file
or in the target-specific variable `secret'.
This external file is located by the probe-specific variable `secretfile', and it should
contain whitespace-separated pairs of the form `<host> <secret>'. Comments and blank lines
are \s-1OK\s0.
.PP
If the optional probe-specific variable `nas_ip_address' is specified, its
value is inserted into the authentication requests as the `NAS\-IP\-Address'
\&\s-1RADIUS\s0 attribute.
.PP
The probe tries to be nice to the server and does not send authentication
requests more frequently than once every X seconds, where X is the value
of the target-specific \*(L"min_interval\*(R" variable (1 by default).
.SH "VARIABLES"
.IX Header "VARIABLES"
Supported probe-specific variables:
.IP "forks" 4
.IX Item "forks"
Run this many concurrent processes at maximum
.Sp
Example value: 5
.Sp
Default value: 5
.IP "offset" 4
.IX Item "offset"
If you run many probes concurrently you may want to prevent them from
hitting your network all at the same time. Using the probe-specific
offset parameter you can change the point in time when each probe will
be run. Offset is specified in % of total interval, or alternatively as
\&'random', and the offset from the 'General' section is used if nothing
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
it is just a matter of when data acqusition is initiated.
(This variable is only applicable if the variable 'concurrentprobes' is set
in the 'General' section.)
.Sp
Example value: 50%
.IP "passwordfile" 4
.IX Item "passwordfile"
Location of the file containing usernames and passwords.
.Sp
Example value: /some/place/secret
.IP "secretfile" 4
.IX Item "secretfile"
A file containing the \s-1RADIUS\s0 shared secrets for the targets. It should contain
whitespace-separated pairs of the form `<host> <secret>'. Comments and blank lines
are \s-1OK\s0.
.Sp
Example value: /another/place/secret
.IP "step" 4
.IX Item "step"
Duration of the base interval that this probe should use, if different
from the one specified in the 'Database' section. Note that the step in
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)
.Sp
Example value: 300
.PP
Supported target-specific variables:
.IP "mininterval" 4
.IX Item "mininterval"
The minimum interval between each authentication request sent, in (possibly fractional) seconds.
.Sp
Default value: 1
.IP "nas_ip_address" 4
.IX Item "nas_ip_address"
The NAS-IP-Address \s-1RADIUS\s0 attribute for the authentication requests. Not needed everywhere.
.Sp
Example value: 10.1.2.3
.IP "password" 4
.IX Item "password"
The password for the user, if not present in the password file.
.Sp
Example value: test-password
.IP "pings" 4
.IX Item "pings"
How many pings should be sent to each target, if different from the global
value specified in the Database section. Note that the number of pings in
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them.
.Sp
Example value: 5
.IP "port" 4
.IX Item "port"
The \s-1RADIUS\s0 port to be used
.Sp
Example value: 1645
.IP "secret" 4
.IX Item "secret"
The \s-1RADIUS\s0 shared secret for the target, if not present in the secrets file.
.Sp
Example value: test-secret
.IP "timeout" 4
.IX Item "timeout"
Timeout in seconds for the \s-1RADIUS\s0 queries.
.Sp
Default value: 5
.IP "username" 4
.IX Item "username"
The username to be tested.
.Sp
Example value: test-user
.Sp
This setting is mandatory.
.SH "AUTHORS"
.IX Header "AUTHORS"
Niko Tyni <ntyni@iki.fi>
.SH "BUGS"
.IX Header "BUGS"
There should be a more general way of specifying \s-1RADIUS\s0 attributes.