~ubuntu-branches/ubuntu/oneiric/smokeping/oneiric-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<title>Smokeping/probes/EchoPingChargen</title>
 
5
<link rev="made" href="mailto:dws@ee.ethz.ch" />
 
6
</head>
 
7
 
 
8
<body style="background-color: white">
 
9
 
 
10
<p><a name="__index__"></a></p>
 
11
<!-- INDEX BEGIN -->
 
12
<!--
 
13
 
 
14
<ul>
 
15
 
 
16
        <li><a href="#name">NAME</a></li>
 
17
        <li><a href="#overview">OVERVIEW</a></li>
 
18
        <li><a href="#synopsis">SYNOPSIS</a></li>
 
19
        <li><a href="#variables">VARIABLES</a></li>
 
20
        <li><a href="#authors">AUTHORS</a></li>
 
21
        <li><a href="#notes">NOTES</a></li>
 
22
        <li><a href="#see_also">SEE ALSO</a></li>
 
23
</ul>
 
24
-->
 
25
<!-- INDEX END -->
 
26
 
 
27
<p>
 
28
</p>
 
29
<h1><a name="name">NAME</a></h1>
 
30
<p>Smokeping::probes::EchoPingChargen - an <code>echoping(1)</code> probe for SmokePing</p>
 
31
<p>
 
32
</p>
 
33
<hr />
 
34
<h1><a name="overview">OVERVIEW</a></h1>
 
35
<p>Measures TCP chargen (port 19) roundtrip times for SmokePing.</p>
 
36
<p>
 
37
</p>
 
38
<hr />
 
39
<h1><a name="synopsis">SYNOPSIS</a></h1>
 
40
<pre>
 
41
 *** Probes ***</pre>
 
42
<pre>
 
43
 +EchoPingChargen</pre>
 
44
<pre>
 
45
 binary = /usr/bin/echoping
 
46
 forks = 5
 
47
 offset = 50%
 
48
 step = 300</pre>
 
49
<pre>
 
50
 # The following variables can be overridden in each target section
 
51
 extraopts = -some-letter-the-author-did-not-think-of
 
52
 fill = A
 
53
 ipversion = 4
 
54
 pings = 5
 
55
 priority = 6
 
56
 size = 510
 
57
 timeout = 1
 
58
 tos = 0xa0
 
59
 waittime = 1</pre>
 
60
<pre>
 
61
 # [...]</pre>
 
62
<pre>
 
63
 *** Targets ***</pre>
 
64
<pre>
 
65
 probe = EchoPingChargen # if this should be the default probe</pre>
 
66
<pre>
 
67
 # [...]</pre>
 
68
<pre>
 
69
 + mytarget
 
70
 # probe = EchoPingChargen # if the default probe is something else
 
71
 host = my.host
 
72
 extraopts = -some-letter-the-author-did-not-think-of
 
73
 fill = A
 
74
 ipversion = 4
 
75
 pings = 5
 
76
 priority = 6
 
77
 size = 510
 
78
 timeout = 1
 
79
 tos = 0xa0
 
80
 waittime = 1</pre>
 
81
<p>
 
82
</p>
 
83
<hr />
 
84
<h1><a name="variables">VARIABLES</a></h1>
 
85
<p>Supported probe-specific variables:</p>
 
86
<dl>
 
87
<dt><strong><a name="item_binary">binary</a></strong><br />
 
88
 
 
89
</dt><dd>
 
90
The location of your echoping binary.
 
91
 
 
92
</dd><dd>
 
93
<p>Default value: /usr/bin/echoping</p>
 
94
 
 
95
<p></p>
 
96
</dd><dt><strong><a name="item_forks">forks</a></strong><br />
 
97
 
 
98
</dt><dd>
 
99
Run this many concurrent processes at maximum
 
100
 
 
101
</dd><dd>
 
102
<p>Example value: 5</p>
 
103
 
 
104
</dd><dd>
 
105
<p>Default value: 5</p>
 
106
 
 
107
<p></p>
 
108
</dd><dt><strong><a name="item_offset">offset</a></strong><br />
 
109
 
 
110
</dt><dd>
 
111
If you run many probes concurrently you may want to prevent them from
 
112
hitting your network all at the same time. Using the probe-specific
 
113
offset parameter you can change the point in time when each probe will
 
114
be run. Offset is specified in % of total interval, or alternatively as
 
115
'random', and the offset from the 'General' section is used if nothing
 
116
is specified here. Note that this does NOT influence the rrds itself,
 
117
it is just a matter of when data acqusition is initiated.
 
118
(This variable is only applicable if the variable 'concurrentprobes' is set
 
119
in the 'General' section.)
 
120
 
 
121
</dd><dd>
 
122
<p>Example value: 50%</p>
 
123
 
 
124
<p></p>
 
125
</dd><dt><strong><a name="item_step">step</a></strong><br />
 
126
 
 
127
</dt><dd>
 
128
Duration of the base interval that this probe should use, if different
 
129
from the one specified in the 'Database' section. Note that the step in
 
130
the RRD files is fixed when they are originally generated, and if you
 
131
change the step parameter afterwards, you'll have to delete the old RRD
 
132
files or somehow convert them. (This variable is only applicable if
 
133
the variable 'concurrentprobes' is set in the 'General' section.)
 
134
 
 
135
</dd><dd>
 
136
<p>Example value: 300</p>
 
137
 
 
138
<p></p></dd></dl>
 
139
<p>Supported target-specific variables:</p>
 
140
<dl>
 
141
<dt><strong><a name="item_extraopts">extraopts</a></strong><br />
 
142
 
 
143
</dt><dd>
 
144
Any extra options specified here will be passed unmodified to echoping(1).
 
145
 
 
146
</dd><dd>
 
147
<p>Example value: -some-letter-the-author-did-not-think-of</p>
 
148
 
 
149
<p></p>
 
150
</dd><dt><strong><a name="item_fill">fill</a></strong><br />
 
151
 
 
152
</dt><dd>
 
153
The ``-f'' <code>echoping(1)</code> option.
 
154
 
 
155
</dd><dd>
 
156
<p>Example value: A</p>
 
157
 
 
158
<p></p>
 
159
</dd><dt><strong><a name="item_ipversion">ipversion</a></strong><br />
 
160
 
 
161
</dt><dd>
 
162
The IP protocol used. Possible values are ``4'' and ``6''. 
 
163
Passed to <code>echoping(1)</code> as the ``-4'' or ``-6'' options.
 
164
 
 
165
</dd><dd>
 
166
<p>Example value: 4</p>
 
167
 
 
168
<p></p>
 
169
</dd><dt><strong><a name="item_pings">pings</a></strong><br />
 
170
 
 
171
</dt><dd>
 
172
How many pings should be sent to each target, if different from the global
 
173
value specified in the Database section. Note that the number of pings in
 
174
the RRD files is fixed when they are originally generated, and if you
 
175
change this parameter afterwards, you'll have to delete the old RRD
 
176
files or somehow convert them.
 
177
 
 
178
</dd><dd>
 
179
<p>Example value: 5</p>
 
180
 
 
181
<p></p>
 
182
</dd><dt><strong><a name="item_priority">priority</a></strong><br />
 
183
 
 
184
</dt><dd>
 
185
The ``-p'' <code>echoping(1)</code> option.
 
186
 
 
187
</dd><dd>
 
188
<p>Example value: 6</p>
 
189
 
 
190
<p></p>
 
191
</dd><dt><strong><a name="item_size">size</a></strong><br />
 
192
 
 
193
</dt><dd>
 
194
The ``-s'' <code>echoping(1)</code> option.
 
195
 
 
196
</dd><dd>
 
197
<p>Example value: 510</p>
 
198
 
 
199
<p></p>
 
200
</dd><dt><strong><a name="item_timeout">timeout</a></strong><br />
 
201
 
 
202
</dt><dd>
 
203
The ``-t'' <code>echoping(1)</code> option.
 
204
 
 
205
</dd><dd>
 
206
<p>Example value: 1</p>
 
207
 
 
208
</dd><dd>
 
209
<p>Default value: 5</p>
 
210
 
 
211
<p></p>
 
212
</dd><dt><strong><a name="item_tos">tos</a></strong><br />
 
213
 
 
214
</dt><dd>
 
215
The ``-P'' <code>echoping(1)</code> option.
 
216
 
 
217
</dd><dd>
 
218
<p>Example value: 0xa0</p>
 
219
 
 
220
<p></p>
 
221
</dd><dt><strong><a name="item_waittime">waittime</a></strong><br />
 
222
 
 
223
</dt><dd>
 
224
The ``-w'' <code>echoping(1)</code> option.
 
225
 
 
226
</dd><dd>
 
227
<p>Example value: 1</p>
 
228
 
 
229
<p></p></dd></dl>
 
230
<p>
 
231
</p>
 
232
<hr />
 
233
<h1><a name="authors">AUTHORS</a></h1>
 
234
<p>Niko Tyni &lt;<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>&gt;</p>
 
235
<p>
 
236
</p>
 
237
<hr />
 
238
<h1><a name="notes">NOTES</a></h1>
 
239
<p>The <em>udp</em> variable is not supported.</p>
 
240
<p>
 
241
</p>
 
242
<hr />
 
243
<h1><a name="see_also">SEE ALSO</a></h1>
 
244
<p><a href="./../../Smokeping/probes/EchoPing.html">the Smokeping::probes::EchoPing manpage</a></p>
 
245
 
 
246
</body>
 
247
 
 
248
</html>