~ubuntu-branches/debian/experimental/smokeping/experimental

« back to all changes in this revision

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

  • 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
<?xml version="1.0" ?>
1
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
3
<html xmlns="http://www.w3.org/1999/xhtml">
3
4
<head>
4
5
<title>Smokeping/probes/Radius</title>
5
 
<link rev="made" href="mailto:dws@ee.ethz.ch" />
 
6
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
 
7
<link rev="made" href="mailto:root@localhost" />
6
8
</head>
7
9
 
8
10
<body style="background-color: white">
111
113
<h1><a name="variables">VARIABLES</a></h1>
112
114
<p>Supported probe-specific variables:</p>
113
115
<dl>
114
 
<dt><strong><a name="item_forks">forks</a></strong><br />
 
116
<dt><strong><a name="item_forks">forks</a></strong>
115
117
 
116
 
</dt><dd>
117
 
Run this many concurrent processes at maximum
 
118
<dd>
 
119
<p>Run this many concurrent processes at maximum</p>
118
120
 
119
121
</dd><dd>
120
122
<p>Example value: 5</p>
122
124
</dd><dd>
123
125
<p>Default value: 5</p>
124
126
 
125
 
<p></p>
126
 
</dd><dt><strong><a name="item_offset">offset</a></strong><br />
 
127
</li>
 
128
</dd><dt><strong><a name="item_offset">offset</a></strong>
127
129
 
128
 
</dt><dd>
129
 
If you run many probes concurrently you may want to prevent them from
 
130
<dd>
 
131
<p>If you run many probes concurrently you may want to prevent them from
130
132
hitting your network all at the same time. Using the probe-specific
131
133
offset parameter you can change the point in time when each probe will
132
134
be run. Offset is specified in % of total interval, or alternatively as
134
136
is specified here. Note that this does NOT influence the rrds itself,
135
137
it is just a matter of when data acqusition is initiated.
136
138
(This variable is only applicable if the variable 'concurrentprobes' is set
137
 
in the 'General' section.)
 
139
in the 'General' section.)</p>
138
140
 
139
141
</dd><dd>
140
142
<p>Example value: 50%</p>
141
143
 
142
 
<p></p>
143
 
</dd><dt><strong><a name="item_passwordfile">passwordfile</a></strong><br />
 
144
</li>
 
145
</dd><dt><strong><a name="item_passwordfile">passwordfile</a></strong>
144
146
 
145
 
</dt><dd>
146
 
Location of the file containing usernames and passwords.
 
147
<dd>
 
148
<p>Location of the file containing usernames and passwords.</p>
147
149
 
148
150
</dd><dd>
149
151
<p>Example value: /some/place/secret</p>
150
152
 
151
 
<p></p>
152
 
</dd><dt><strong><a name="item_secretfile">secretfile</a></strong><br />
 
153
</li>
 
154
</dd><dt><strong><a name="item_secretfile">secretfile</a></strong>
153
155
 
154
 
</dt><dd>
155
 
A file containing the RADIUS shared secrets for the targets. It should contain
 
156
<dd>
 
157
<p>A file containing the RADIUS shared secrets for the targets. It should contain
156
158
whitespace-separated pairs of the form `&lt;host&gt; &lt;secret&gt;'. Comments and blank lines
157
 
are OK.
 
159
are OK.</p>
158
160
 
159
161
</dd><dd>
160
162
<p>Example value: /another/place/secret</p>
161
163
 
162
 
<p></p>
163
 
</dd><dt><strong><a name="item_step">step</a></strong><br />
 
164
</li>
 
165
</dd><dt><strong><a name="item_step">step</a></strong>
164
166
 
165
 
</dt><dd>
166
 
Duration of the base interval that this probe should use, if different
 
167
<dd>
 
168
<p>Duration of the base interval that this probe should use, if different
167
169
from the one specified in the 'Database' section. Note that the step in
168
170
the RRD files is fixed when they are originally generated, and if you
169
171
change the step parameter afterwards, you'll have to delete the old RRD
170
172
files or somehow convert them. (This variable is only applicable if
171
 
the variable 'concurrentprobes' is set in the 'General' section.)
 
173
the variable 'concurrentprobes' is set in the 'General' section.)</p>
172
174
 
173
175
</dd><dd>
174
176
<p>Example value: 300</p>
175
177
 
176
 
<p></p></dd></dl>
 
178
</li>
 
179
</dd></dl>
177
180
<p>Supported target-specific variables:</p>
178
181
<dl>
179
 
<dt><strong><a name="item_mininterval">mininterval</a></strong><br />
 
182
<dt><strong><a name="item_mininterval">mininterval</a></strong>
180
183
 
181
 
</dt><dd>
182
 
The minimum interval between each authentication request sent, in (possibly fractional) seconds.
 
184
<dd>
 
185
<p>The minimum interval between each authentication request sent, in (possibly fractional) seconds.</p>
183
186
 
184
187
</dd><dd>
185
188
<p>Default value: 1</p>
186
189
 
187
 
<p></p>
188
 
</dd><dt><strong><a name="item_nas_ip_address">nas_ip_address</a></strong><br />
 
190
</li>
 
191
</dd><dt><strong><a name="item_nas_ip_address">nas_ip_address</a></strong>
189
192
 
190
 
</dt><dd>
191
 
The NAS-IP-Address RADIUS attribute for the authentication requests. Not needed everywhere.
 
193
<dd>
 
194
<p>The NAS-IP-Address RADIUS attribute for the authentication requests. Not needed everywhere.</p>
192
195
 
193
196
</dd><dd>
194
197
<p>Example value: 10.1.2.3</p>
195
198
 
196
 
<p></p>
197
 
</dd><dt><strong><a name="item_password">password</a></strong><br />
 
199
</li>
 
200
</dd><dt><strong><a name="item_password">password</a></strong>
198
201
 
199
 
</dt><dd>
200
 
The password for the user, if not present in the password file.
 
202
<dd>
 
203
<p>The password for the user, if not present in the password file.</p>
201
204
 
202
205
</dd><dd>
203
206
<p>Example value: test-password</p>
204
207
 
205
 
<p></p>
206
 
</dd><dt><strong><a name="item_pings">pings</a></strong><br />
 
208
</li>
 
209
</dd><dt><strong><a name="item_pings">pings</a></strong>
207
210
 
208
 
</dt><dd>
209
 
How many pings should be sent to each target, if different from the global
 
211
<dd>
 
212
<p>How many pings should be sent to each target, if different from the global
210
213
value specified in the Database section. Note that the number of pings in
211
214
the RRD files is fixed when they are originally generated, and if you
212
215
change this parameter afterwards, you'll have to delete the old RRD
213
 
files or somehow convert them.
 
216
files or somehow convert them.</p>
214
217
 
215
218
</dd><dd>
216
219
<p>Example value: 5</p>
217
220
 
218
 
<p></p>
219
 
</dd><dt><strong><a name="item_port">port</a></strong><br />
 
221
</li>
 
222
</dd><dt><strong><a name="item_port">port</a></strong>
220
223
 
221
 
</dt><dd>
222
 
The RADIUS port to be used
 
224
<dd>
 
225
<p>The RADIUS port to be used</p>
223
226
 
224
227
</dd><dd>
225
228
<p>Example value: 1645</p>
226
229
 
227
 
<p></p>
228
 
</dd><dt><strong><a name="item_secret">secret</a></strong><br />
 
230
</li>
 
231
</dd><dt><strong><a name="item_secret">secret</a></strong>
229
232
 
230
 
</dt><dd>
231
 
The RADIUS shared secret for the target, if not present in the secrets file.
 
233
<dd>
 
234
<p>The RADIUS shared secret for the target, if not present in the secrets file.</p>
232
235
 
233
236
</dd><dd>
234
237
<p>Example value: test-secret</p>
235
238
 
236
 
<p></p>
237
 
</dd><dt><strong><a name="item_timeout">timeout</a></strong><br />
 
239
</li>
 
240
</dd><dt><strong><a name="item_timeout">timeout</a></strong>
238
241
 
239
 
</dt><dd>
240
 
Timeout in seconds for the RADIUS queries.
 
242
<dd>
 
243
<p>Timeout in seconds for the RADIUS queries.</p>
241
244
 
242
245
</dd><dd>
243
246
<p>Default value: 5</p>
244
247
 
245
 
<p></p>
246
 
</dd><dt><strong><a name="item_username">username</a></strong><br />
 
248
</li>
 
249
</dd><dt><strong><a name="item_username">username</a></strong>
247
250
 
248
 
</dt><dd>
249
 
The username to be tested.
 
251
<dd>
 
252
<p>The username to be tested.</p>
250
253
 
251
254
</dd><dd>
252
255
<p>Example value: test-user</p>
254
257
</dd><dd>
255
258
<p>This setting is mandatory.</p>
256
259
 
257
 
<p></p></dd></dl>
 
260
</li>
 
261
</dd></dl>
258
262
<p>
259
263
</p>
260
264
<hr />