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

1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
1
<?xml version="1.0" ?>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml">
4
<head>
5
<title>Smokeping/probes/FPing6</title>
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
6
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
1.1.7 by Lionel Porcheron
Import upstream version 2.1.1
7
<link rev="made" href="mailto:root@localhost" />
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
8
</head>
9
10
<body style="background-color: white">
11
12
<p><a name="__index__"></a></p>
13
<!-- INDEX BEGIN -->
14
<!--
15
16
<ul>
17
18
	<li><a href="#name">NAME</a></li>
19
	<li><a href="#synopsis">SYNOPSIS</a></li>
20
	<li><a href="#description">DESCRIPTION</a></li>
21
	<li><a href="#variables">VARIABLES</a></li>
22
	<li><a href="#authors">AUTHORS</a></li>
23
	<li><a href="#see_also">SEE ALSO</a></li>
24
</ul>
25
-->
26
<!-- INDEX END -->
27
28
<p>
29
</p>
30
<h1><a name="name">NAME</a></h1>
31
<p>Smokeping::probes::FPing6 - FPing6 Probe for SmokePing</p>
32
<p>
33
</p>
34
<hr />
35
<h1><a name="synopsis">SYNOPSIS</a></h1>
36
<pre>
37
 *** Probes ***</pre>
38
<pre>
39
 +FPing6</pre>
40
<pre>
41
 binary = /usr/bin/fping6 # mandatory
42
 hostinterval = 1.5
43
 mininterval = 0.001
44
 offset = 50%
45
 packetsize = 5000
46
 pings = 20
1.1.7 by Lionel Porcheron
Import upstream version 2.1.1
47
 sourceaddress = ::1
1.2.2 by Niko Tyni
Import upstream version 2.0.9
48
 step = 300
49
 timeout = 1.5</pre>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
50
<pre>
51
 # [...]</pre>
52
<pre>
53
 *** Targets ***</pre>
54
<pre>
55
 probe = FPing6 # if this should be the default probe</pre>
56
<pre>
57
 # [...]</pre>
58
<pre>
59
 + mytarget
60
 # probe = FPing6 # if the default probe is something else
61
 host = my.host</pre>
62
<p>
63
</p>
64
<hr />
65
<h1><a name="description">DESCRIPTION</a></h1>
66
<p>Integrates FPing6 as a probe into smokeping. This probe is derived from
67
FPing; the only difference is that the target host used for checking
68
the fping command output is ::1 instead of localhost.</p>
69
<p>
70
</p>
71
<hr />
72
<h1><a name="variables">VARIABLES</a></h1>
73
<p>Supported probe-specific variables:</p>
74
<dl>
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
75
<dt><strong><a name="item_binary">binary</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
76
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
77
<dd>
78
<p>The location of your fping binary.</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
79
80
</dd><dd>
81
<p>Example value: /usr/bin/fping6</p>
82
83
</dd><dd>
84
<p>This setting is mandatory.</p>
85
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
86
</li>
87
</dd><dt><strong><a name="item_hostinterval">hostinterval</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
88
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
89
<dd>
90
<p>The fping ``-p'' parameter, but in (possibly fractional) seconds rather than
91
milliseconds, for consistency with other Smokeping probes. From fping(1):</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
92
93
</dd><dd>
94
<p>This parameter sets the time that fping  waits between successive packets
95
to an individual target.</p>
96
97
</dd><dd>
98
<p>Example value: 1.5</p>
99
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
100
</li>
101
</dd><dt><strong><a name="item_mininterval">mininterval</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
102
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
103
<dd>
104
<p>The fping ``-i'' parameter, but in (probably fractional) seconds rather than
105
milliseconds, for consistency with other Smokeping probes. From fping(1):</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
106
107
</dd><dd>
108
<p>The minimum amount of time between sending a ping packet to any target.</p>
109
110
</dd><dd>
111
<p>Example value: 0.001</p>
112
113
</dd><dd>
114
<p>Default value: 0.01</p>
115
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
116
</li>
117
</dd><dt><strong><a name="item_offset">offset</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
118
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
119
<dd>
120
<p>If you run many probes concurrently you may want to prevent them from
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
121
hitting your network all at the same time. Using the probe-specific
122
offset parameter you can change the point in time when each probe will
123
be run. Offset is specified in % of total interval, or alternatively as
124
'random', and the offset from the 'General' section is used if nothing
125
is specified here. Note that this does NOT influence the rrds itself,
126
it is just a matter of when data acqusition is initiated.
127
(This variable is only applicable if the variable 'concurrentprobes' is set
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
128
in the 'General' section.)</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
129
130
</dd><dd>
131
<p>Example value: 50%</p>
132
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
133
</li>
134
</dd><dt><strong><a name="item_packetsize">packetsize</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
135
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
136
<dd>
137
<p>The ping packet size (in the range of 12-64000 bytes).</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
138
139
</dd><dd>
140
<p>Example value: 5000</p>
141
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
142
</li>
143
</dd><dt><strong><a name="item_pings">pings</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
144
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
145
<dd>
146
<p>How many pings should be sent to each target, if different from the global
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
147
value specified in the Database section. Note that the number of pings in
148
the RRD files is fixed when they are originally generated, and if you
149
change this parameter afterwards, you'll have to delete the old RRD
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
150
files or somehow convert them.</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
151
152
</dd><dd>
153
<p>Example value: 20</p>
154
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
155
</li>
156
</dd><dt><strong><a name="item_sourceaddress">sourceaddress</a></strong>
1.1.7 by Lionel Porcheron
Import upstream version 2.1.1
157
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
158
<dd>
159
<p>The fping ``-S'' parameter . From fping(1):</p>
1.1.7 by Lionel Porcheron
Import upstream version 2.1.1
160
161
</dd><dd>
162
<p>Set source address.</p>
163
164
</dd><dd>
165
<p>Example value: ::1</p>
166
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
167
</li>
168
</dd><dt><strong><a name="item_step">step</a></strong>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
169
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
170
<dd>
171
<p>Duration of the base interval that this probe should use, if different
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
172
from the one specified in the 'Database' section. Note that the step in
173
the RRD files is fixed when they are originally generated, and if you
174
change the step parameter afterwards, you'll have to delete the old RRD
175
files or somehow convert them. (This variable is only applicable if
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
176
the variable 'concurrentprobes' is set in the 'General' section.)</p>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
177
178
</dd><dd>
179
<p>Example value: 300</p>
180
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
181
</li>
182
</dd><dt><strong><a name="item_timeout">timeout</a></strong>
1.2.2 by Niko Tyni
Import upstream version 2.0.9
183
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
184
<dd>
185
<p>The fping ``-t'' parameter, but in (possibly fractional) seconds rather than
1.2.2 by Niko Tyni
Import upstream version 2.0.9
186
milliseconds, for consistency with other Smokeping probes. Note that as
187
Smokeping uses the fping 'counting' mode (-C), this apparently only affects
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
188
the last ping.</p>
1.2.2 by Niko Tyni
Import upstream version 2.0.9
189
190
</dd><dd>
191
<p>Example value: 1.5</p>
192
1.1.8 by Lionel Porcheron
Import upstream version 2.2.4
193
</li>
194
</dd></dl>
1.1.4 by Jose Carlos Garcia Sogo
Import upstream version 2.0.5
195
<p>
196
</p>
197
<hr />
198
<h1><a name="authors">AUTHORS</a></h1>
199
<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
200
<p>Niko Tyni &lt;<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>&gt;</p>
201
<p>
202
</p>
203
<hr />
204
<h1><a name="see_also">SEE ALSO</a></h1>
205
<p><a href="./../../Smokeping/probes/FPing.html">the Smokeping::probes::FPing manpage</a></p>
206
207
</body>
208
209
</html>