~ubuntu-branches/debian/squeeze/smokeping/squeeze

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/Radius.txt

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2008-08-29 18:29:34 UTC
  • mfrom: (2.1.14 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080829182934-ad5b9csusoqn1155
Tags: 2.3.6-3
* Unset LC_ALL in the init script because the daemon needs to 
  reset LC_NUMERIC. (Closes: #489766)
* Fix a bashism in the postinst script. Thanks, lintian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
doc::Smokeping::probes::RadiuSsm(o3k)edPoicn:g:Smokeping::probes::Radius(3)
 
1
doc::Smokeping::probes::Radius(3)  SmokePing doc::Smokeping::probes::Radius(3)
2
2
 
3
3
 
4
4
 
5
5
NNAAMMEE
6
 
       Smokeping::probes::Radius - a RADIUS authentication probe
7
 
       for SmokePing
 
6
       Smokeping::probes::Radius - a RADIUS authentication probe for SmokePing
8
7
 
9
8
OOVVEERRVVIIEEWW
10
9
       Measures RADIUS authentication latency for SmokePing
51
50
        username = test-user # mandatory
52
51
 
53
52
DDEESSCCRRIIPPTTIIOONN
54
 
       This probe measures RADIUS (RFC 2865) authentication
55
 
       latency for SmokePing.
56
 
 
57
 
       The username to be tested is specified in either the
58
 
       probe-specific or the target-specific variable `username',
59
 
       with the target-specific one overriding the probe-specific
60
 
       one.
61
 
 
62
 
       The password can be specified either (in order of prece-
63
 
       dence, with the latter overriding the former) in the
64
 
       probe-specific variable `password', in an external file or
65
 
       in the target-specific variable `password'.  The location
66
 
       of this file is given in the probe-specific variable
67
 
       `passwordfile'. See _S_m_o_k_e_p_i_n_g_:_:_p_r_o_b_e_s_:_:_p_a_s_s_w_o_r_d_-
68
 
       _c_h_e_c_k_e_r(3pm) for the format of this file (summary: colon-
69
 
       separated triplets of the form `<host>:<username>:<pass-
70
 
       word>')
71
 
 
72
 
       The RADIUS protocol requires a shared secret between the
73
 
       server and the client.  This secret can be specified
74
 
       either (in order of precedence, with the latter overriding
75
 
       the former) in the probe-specific variable `secret', in an
76
 
       external file or in the target-specific variable `secret'.
77
 
       This external file is located by the probe-specific vari-
78
 
       able `secretfile', and it should contain whitespace-sepa-
79
 
       rated pairs of the form `<host> <secret>'. Comments and
80
 
       blank lines are OK.
81
 
 
82
 
       If the optional probe-specific variable `nas_ip_address'
83
 
       is specified, its value is inserted into the authentica-
84
 
       tion requests as the `NAS-IP-Address' RADIUS attribute.
85
 
 
86
 
       The probe tries to be nice to the server and does not send
87
 
       authentication requests more frequently than once every X
88
 
       seconds, where X is the value of the target-specific
89
 
       "min_interval" variable (1 by default).
 
53
       This probe measures RADIUS (RFC 2865) authentication latency for
 
54
       SmokePing.
 
55
 
 
56
       The username to be tested is specified in either the probe-specific or
 
57
       the target-specific variable `username', with the target-specific one
 
58
       overriding the probe-specific one.
 
59
 
 
60
       The password can be specified either (in order of precedence, with the
 
61
       latter overriding the former) in the probe-specific variable `pass-
 
62
       word', in an external file or in the target-specific variable `pass-
 
63
       word'.  The location of this file is given in the probe-specific vari-
 
64
       able `passwordfile'. See _S_m_o_k_e_p_i_n_g_:_:_p_r_o_b_e_s_:_:_p_a_s_s_w_o_r_d_c_h_e_c_k_e_r(3pm) for
 
65
       the format of this file (summary: colon-separated triplets of the form
 
66
       `<host>:<username>:<password>')
 
67
 
 
68
       The RADIUS protocol requires a shared secret between the server and the
 
69
       client.  This secret can be specified either (in order of precedence,
 
70
       with the latter overriding the former) in the probe-specific variable
 
71
       `secret', in an external file or in the target-specific variable
 
72
       `secret'.  This external file is located by the probe-specific variable
 
73
       `secretfile', and it should contain whitespace-separated pairs of the
 
74
       form `<host> <secret>'. Comments and blank lines are OK.
 
75
 
 
76
       If the optional probe-specific variable `nas_ip_address' is specified,
 
77
       its value is inserted into the authentication requests as the
 
78
       `NAS-IP-Address' RADIUS attribute.
 
79
 
 
80
       The probe tries to be nice to the server and does not send authentica-
 
81
       tion requests more frequently than once every X seconds, where X is the
 
82
       value of the target-specific "min_interval" variable (1 by default).
90
83
 
91
84
VVAARRIIAABBLLEESS
92
85
       Supported probe-specific variables:
99
92
           Default value: 5
100
93
 
101
94
       offset
102
 
           If you run many probes concurrently you may want to
103
 
           prevent them from hitting your network all at the same
104
 
           time. Using the probe-specific offset parameter you
105
 
           can change the point in time when each probe will be
106
 
           run. Offset is specified in % of total interval, or
107
 
           alternatively as 'random', and the offset from the
108
 
           'General' section is used if nothing is specified
109
 
           here. Note that this does NOT influence the rrds
110
 
           itself, it is just a matter of when data acqusition is
111
 
           initiated.  (This variable is only applicable if the
112
 
           variable 'concurrentprobes' is set in the 'General'
113
 
           section.)
 
95
           If you run many probes concurrently you may want to prevent them
 
96
           from hitting your network all at the same time. Using the probe-
 
97
           specific offset parameter you can change the point in time when
 
98
           each probe will be run. Offset is specified in % of total interval,
 
99
           or alternatively as 'random', and the offset from the 'General'
 
100
           section is used if nothing is specified here. Note that this does
 
101
           NOT influence the rrds itself, it is just a matter of when data
 
102
           acqusition is initiated.  (This variable is only applicable if the
 
103
           variable 'concurrentprobes' is set in the 'General' section.)
114
104
 
115
105
           Example value: 50%
116
106
 
117
107
       passwordfile
118
 
           Location of the file containing usernames and pass-
119
 
           words.
 
108
           Location of the file containing usernames and passwords.
120
109
 
121
110
           Example value: /some/place/secret
122
111
 
123
112
       secretfile
124
 
           A file containing the RADIUS shared secrets for the
125
 
           targets. It should contain whitespace-separated pairs
126
 
           of the form `<host> <secret>'. Comments and blank
127
 
           lines are OK.
 
113
           A file containing the RADIUS shared secrets for the targets. It
 
114
           should contain whitespace-separated pairs of the form `<host>
 
115
           <secret>'. Comments and blank lines are OK.
128
116
 
129
117
           Example value: /another/place/secret
130
118
 
131
119
       step
132
 
           Duration of the base interval that this probe should
133
 
           use, if different from the one specified in the
134
 
           'Database' section. Note that the step in the RRD
135
 
           files is fixed when they are originally generated, and
136
 
           if you change the step parameter afterwards, you'll
137
 
           have to delete the old RRD files or somehow convert
138
 
           them. (This variable is only applicable if the vari-
139
 
           able 'concurrentprobes' is set in the 'General' sec-
140
 
           tion.)
 
120
           Duration of the base interval that this probe should use, if dif-
 
121
           ferent from the one specified in the 'Database' section. Note that
 
122
           the step in the RRD files is fixed when they are originally gener-
 
123
           ated, and if you change the step parameter afterwards, you'll have
 
124
           to delete the old RRD files or somehow convert them. (This variable
 
125
           is only applicable if the variable 'concurrentprobes' is set in the
 
126
           'General' section.)
141
127
 
142
128
           Example value: 300
143
129
 
144
130
       Supported target-specific variables:
145
131
 
146
132
       mininterval
147
 
           The minimum interval between each authentication
148
 
           request sent, in (possibly fractional) seconds.
 
133
           The minimum interval between each authentication request sent, in
 
134
           (possibly fractional) seconds.
149
135
 
150
136
           Default value: 1
151
137
 
152
138
       nas_ip_address
153
 
           The NAS-IP-Address RADIUS attribute for the authenti-
154
 
           cation requests. Not needed everywhere.
 
139
           The NAS-IP-Address RADIUS attribute for the authentication
 
140
           requests. Not needed everywhere.
155
141
 
156
142
           Example value: 10.1.2.3
157
143
 
158
144
       password
159
 
           The password for the user, if not present in the pass-
160
 
           word file.
 
145
           The password for the user, if not present in the password file.
161
146
 
162
147
           Example value: test-password
163
148
 
164
149
       pings
165
 
           How many pings should be sent to each target, if dif-
166
 
           ferent from the global value specified in the Database
167
 
           section. Note that the number of pings in the RRD
168
 
           files is fixed when they are originally generated, and
169
 
           if you change this parameter afterwards, you'll have
 
150
           How many pings should be sent to each target, if different from the
 
151
           global value specified in the Database section. Note that the num-
 
152
           ber of pings in the RRD files is fixed when they are originally
 
153
           generated, and if you change this parameter afterwards, you'll have
170
154
           to delete the old RRD files or somehow convert them.
171
155
 
172
156
           Example value: 5
177
161
           Example value: 1645
178
162
 
179
163
       secret
180
 
           The RADIUS shared secret for the target, if not pre-
181
 
           sent in the secrets file.
 
164
           The RADIUS shared secret for the target, if not present in the
 
165
           secrets file.
182
166
 
183
167
           Example value: test-secret
184
168
 
198
182
       Niko Tyni <ntyni@iki.fi>
199
183
 
200
184
BBUUGGSS
201
 
       There should be a more general way of specifying RADIUS
202
 
       attributes.
203
 
 
204
 
 
205
 
 
206
 
2.0.9                       2006-d0o7c-:1:4Smokeping::probes::Radius(3)
 
185
       There should be a more general way of specifying RADIUS attributes.
 
186
 
 
187
 
 
188
 
 
189
2.3.6                             2008-04-26 doc::Smokeping::probes::Radius(3)