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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Smokeping/probes/FPing6</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body style="background-color: white">

<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<!--

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#variables">VARIABLES</a></li>
	<li><a href="#authors">AUTHORS</a></li>
	<li><a href="#see_also">SEE ALSO</a></li>
</ul>
-->
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Smokeping::probes::FPing6 - FPing6 Probe for SmokePing</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
 *** Probes ***</pre>
<pre>
 +FPing6</pre>
<pre>
 binary = /usr/bin/fping6 # mandatory
 hostinterval = 1.5
 mininterval = 0.001
 offset = 50%
 packetsize = 5000
 pings = 20
 sourceaddress = ::1
 step = 300
 timeout = 1.5</pre>
<pre>
 # [...]</pre>
<pre>
 *** Targets ***</pre>
<pre>
 probe = FPing6 # if this should be the default probe</pre>
<pre>
 # [...]</pre>
<pre>
 + mytarget
 # probe = FPing6 # if the default probe is something else
 host = my.host</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>Integrates FPing6 as a probe into smokeping. This probe is derived from
FPing; the only difference is that the target host used for checking
the fping command output is ::1 instead of localhost.</p>
<p>
</p>
<hr />
<h1><a name="variables">VARIABLES</a></h1>
<p>Supported probe-specific variables:</p>
<dl>
<dt><strong><a name="item_binary">binary</a></strong>

<dd>
<p>The location of your fping binary.</p>

</dd><dd>
<p>Example value: /usr/bin/fping6</p>

</dd><dd>
<p>This setting is mandatory.</p>

</li>
</dd><dt><strong><a name="item_hostinterval">hostinterval</a></strong>

<dd>
<p>The fping ``-p'' parameter, but in (possibly fractional) seconds rather than
milliseconds, for consistency with other Smokeping probes. From fping(1):</p>

</dd><dd>
<p>This parameter sets the time that fping  waits between successive packets
to an individual target.</p>

</dd><dd>
<p>Example value: 1.5</p>

</li>
</dd><dt><strong><a name="item_mininterval">mininterval</a></strong>

<dd>
<p>The fping ``-i'' parameter, but in (probably fractional) seconds rather than
milliseconds, for consistency with other Smokeping probes. From fping(1):</p>

</dd><dd>
<p>The minimum amount of time between sending a ping packet to any target.</p>

</dd><dd>
<p>Example value: 0.001</p>

</dd><dd>
<p>Default value: 0.01</p>

</li>
</dd><dt><strong><a name="item_offset">offset</a></strong>

<dd>
<p>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 NOT 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.)</p>

</dd><dd>
<p>Example value: 50%</p>

</li>
</dd><dt><strong><a name="item_packetsize">packetsize</a></strong>

<dd>
<p>The ping packet size (in the range of 12-64000 bytes).</p>

</dd><dd>
<p>Example value: 5000</p>

</li>
</dd><dt><strong><a name="item_pings">pings</a></strong>

<dd>
<p>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 RRD files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old RRD
files or somehow convert them.</p>

</dd><dd>
<p>Example value: 20</p>

</li>
</dd><dt><strong><a name="item_sourceaddress">sourceaddress</a></strong>

<dd>
<p>The fping ``-S'' parameter . From fping(1):</p>

</dd><dd>
<p>Set source address.</p>

</dd><dd>
<p>Example value: ::1</p>

</li>
</dd><dt><strong><a name="item_step">step</a></strong>

<dd>
<p>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 RRD files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old RRD
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)</p>

</dd><dd>
<p>Example value: 300</p>

</li>
</dd><dt><strong><a name="item_timeout">timeout</a></strong>

<dd>
<p>The fping ``-t'' parameter, but in (possibly fractional) seconds rather than
milliseconds, for consistency with other Smokeping probes. Note that as
Smokeping uses the fping 'counting' mode (-C), this apparently only affects
the last ping.</p>

</dd><dd>
<p>Example value: 1.5</p>

</li>
</dd></dl>
<p>
</p>
<hr />
<h1><a name="authors">AUTHORS</a></h1>
<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
<p>Niko Tyni &lt;<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>&gt;</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="./../../Smokeping/probes/FPing.html">the Smokeping::probes::FPing manpage</a></p>

</body>

</html>