1Smokeping_probes_Radius(3) SmokePing Smokeping_probes_Radius(3)
2
6 Smokeping::probes::Radius - a RADIUS authentication probe for SmokePing
7
9 Measures RADIUS authentication latency for SmokePing
10
12 *** Probes ***
13 +Radius
15 forks = 5
17 offset = 50%
18 passwordfile = /some/place/secret
19 secretfile = /another/place/secret
20 step = 300
21 # The following variables can be overridden in each target section
23 /^influx_.+/ = influx_location = In the basement
24 allowreject = true
25 mininterval = 1
26 nas_ip_address = 10.1.2.3
27 password = test-password
28 pings = 5
29 port = 1645
30 secret = test-secret
31 timeout = 5
32 username = test-user # mandatory
33 # [...]
35 *** Targets ***
37 probe = Radius # if this should be the default probe
39 # [...]
41 + mytarget
43 # probe = Radius # if the default probe is something else
44 host = my.host
45 /^influx_.+/ = influx_location = In the basement
46 allowreject = true
47 mininterval = 1
48 nas_ip_address = 10.1.2.3
49 password = test-password
50 pings = 5
51 port = 1645
52 secret = test-secret
53 timeout = 5
54 username = test-user # mandatory
55
57 This probe measures RADIUS (RFC 2865) authentication latency for
58 SmokePing.
59 The username to be tested is specified in either the probe-specific or
61 the target-specific variable `username', with the target-specific one
62 overriding the probe-specific one.
63 The password can be specified either (in order of precedence, with the
65 latter overriding the former) in the probe-specific variable
66 `password', in an external file or in the target-specific variable
67 `password'. The location of this file is given in the probe-specific
68 variable `passwordfile'. See Smokeping::probes::passwordchecker(3pm)
69 for the format of this file (summary: colon-separated triplets of the
70 form `<host>:<username>:<password>')
71 The RADIUS protocol requires a shared secret between the server and the
73 client. This secret can be specified either (in order of precedence,
74 with the latter overriding the former) in the probe-specific variable
75 `secret', in an external file or in the target-specific variable
76 `secret'. This external file is located by the probe-specific variable
77 `secretfile', and it should contain whitespace-separated pairs of the
78 form `<host> <secret>'. Comments and blank lines are OK.
79 If the optional probe-specific variable `nas_ip_address' is specified,
81 its value is inserted into the authentication requests as the
82 `NAS-IP-Address' RADIUS attribute.
83 The probe tries to be nice to the server and does not send
85 authentication requests more frequently than once every X seconds,
86 where X is the value of the target-specific "min_interval" variable (1
87 by default).
88
90 Supported probe-specific variables:
91 forks
93 Run this many concurrent processes at maximum
94 Example value: 5
96 Default value: 5
98 offset
100 If you run many probes concurrently you may want to prevent them
101 from hitting your network all at the same time. Using the probe-
102 specific offset parameter you can change the point in time when
103 each probe will be run. Offset is specified in % of total interval,
104 or alternatively as 'random', and the offset from the 'General'
105 section is used if nothing is specified here. Note that this does
106 NOT influence the rrds itself, it is just a matter of when data
107 acquisition is initiated. (This variable is only applicable if the
108 variable 'concurrentprobes' is set in the 'General' section.)
109 Example value: 50%
111 passwordfile
113 Location of the file containing usernames and passwords.
114 Example value: /some/place/secret
116 secretfile
118 A file containing the RADIUS shared secrets for the targets. It
119 should contain whitespace-separated pairs of the form `<host>
120 <secret>'. Comments and blank lines are OK.
121 Example value: /another/place/secret
123 step
125 Duration of the base interval that this probe should use, if
126 different from the one specified in the 'Database' section. Note
127 that the step in the RRD files is fixed when they are originally
128 generated, and if you change the step parameter afterwards, you'll
129 have to delete the old RRD files or somehow convert them. (This
130 variable is only applicable if the variable 'concurrentprobes' is
131 set in the 'General' section.)
132 Example value: 300
134 Supported target-specific variables:
136 /^influx_.+/
138 This is a tag that will be sent to influxdb and has no impact on
139 the probe measurement. The tag name will be sent without the
140 "influx_" prefix, which will be replaced with "tag_" instead. Tags
141 can be used for filtering.
142 Example value: influx_location = In the basement
144 allowreject
146 Treat "reject" responses as OK
147 Example value: true
149 mininterval
151 The minimum interval between each authentication request sent, in
152 (possibly fractional) seconds.
153 Default value: 1
155 nas_ip_address
157 The NAS-IP-Address RADIUS attribute for the authentication
158 requests. Not needed everywhere.
159 Example value: 10.1.2.3
161 password
163 The password for the user, if not present in the password file.
164 Example value: test-password
166 pings
168 How many pings should be sent to each target, if different from the
169 global value specified in the Database section. Note that the
170 number of pings in the RRD files is fixed when they are originally
171 generated, and if you change this parameter afterwards, you'll have
172 to delete the old RRD files or somehow convert them.
173 Example value: 5
175 port
177 The RADIUS port to be used
178 Example value: 1645
180 secret
182 The RADIUS shared secret for the target, if not present in the
183 secrets file.
184 Example value: test-secret
186 timeout
188 Timeout in seconds for the RADIUS queries.
189 Default value: 5
191 username
193 The username to be tested.
194 Example value: test-user
196 This setting is mandatory.
198
200 Niko Tyni <ntyni@iki.fi>
201
203 There should be a more general way of specifying RADIUS attributes.
2042.8.2 2022-01-22 Smokeping_probes_Radius(3)