1Smokeping_probes_RemoteFPing(3) SmokePing Smokeping_probes_RemoteFPing(3)
2
6 Smokeping::probes::RemoteFPing - Remote FPing Probe for SmokePing
7
9 *** Probes ***
10 +RemoteFPing
12 binary = /usr/bin/ssh # mandatory
14 blazemode = true
15 hostinterval = 1.5
16 mininterval = 0.001
17 offset = 50%
18 packetsize = 5000
19 pings = 20
20 protocol = 4
21 rbinary = /usr/bin/fping # mandatory
22 rhost = my.pinger.host # mandatory
23 rport = 22
24 ruser = foo
25 sourceaddress = 192.168.0.1
26 step = 300
27 timeout = 1.5
28 tos = 0x20
29 usestdout = true
30 # [...]
32 *** Targets ***
34 probe = RemoteFPing # if this should be the default probe
36 # [...]
38 + mytarget
40 # probe = RemoteFPing # if the default probe is something else
41 host = my.host
42
44 Integrates the remote execution of FPing via ssh/rsh into smokeping.
45 The variable binary must point to your copy of the ssh/rsh program.
46 The variable rbinary must point to your copy of the fping program at
47 the remote end.
48
50 Supported probe-specific variables:
51 binary
53 This variable specifies the path of the remote shell program
54 (usually ssh, rsh or remsh). Any other script or binary that can be
55 called as
56 binary [ -l ruser ] [ -p rport ] rhost rbinary
58 may be used.
60 Example value: /usr/bin/ssh
62 This setting is mandatory.
64 blazemode
66 Send an extra ping and then discarge the first answer since the
67 first is bound to be an outliner.
68 Example value: true
70 hostinterval
72 The fping "-p" parameter, but in (possibly fractional) seconds
73 rather than milliseconds, for consistency with other Smokeping
74 probes. From fping(1):
75 This parameter sets the time that fping waits between successive
77 packets to an individual target.
78 Example value: 1.5
80 mininterval
82 The fping "-i" parameter, but in (probably fractional) seconds
83 rather than milliseconds, for consistency with other Smokeping
84 probes. From fping(1):
85 The minimum amount of time between sending a ping packet to any
87 target.
88 Example value: 0.001
90 Default value: 0.01
92 offset
94 If you run many probes concurrently you may want to prevent them
95 from hitting your network all at the same time. Using the probe-
96 specific offset parameter you can change the point in time when
97 each probe will be run. Offset is specified in % of total interval,
98 or alternatively as 'random', and the offset from the 'General'
99 section is used if nothing is specified here. Note that this does
100 NOT influence the rrds itself, it is just a matter of when data
101 acqusition is initiated. (This variable is only applicable if the
102 variable 'concurrentprobes' is set in the 'General' section.)
103 Example value: 50%
105 packetsize
107 The ping packet size (in the range of 12-64000 bytes).
108 Example value: 5000
110 pings
112 How many pings should be sent to each target, if different from the
113 global value specified in the Database section. Note that the
114 number of pings in the RRD files is fixed when they are originally
115 generated, and if you change this parameter afterwards, you'll have
116 to delete the old RRD files or somehow convert them.
117 Example value: 20
119 protocol
121 Choose if the ping should use IPv4 or IPv6.
122 Example value: 4
124 Default value: 4
126 rbinary
128 The location of your fping binary.
129 Example value: /usr/bin/fping
131 This setting is mandatory.
133 rhost
135 The rhost option specifies the remote device from where fping will
136 be launched.
137 Example value: my.pinger.host
139 This setting is mandatory.
141 rport
143 The (optional) rport option allows you to specify the port of the
144 remote host.
145 Example value: 22
147 ruser
149 The (optional) ruser option allows you to specify the remote user,
150 if different from the one running the smokeping daemon.
151 Example value: foo
153 sourceaddress
155 The fping "-S" parameter . From fping(1):
156 Set source address.
158 Example value: 192.168.0.1
160 step
162 Duration of the base interval that this probe should use, if
163 different from the one specified in the 'Database' section. Note
164 that the step in the RRD files is fixed when they are originally
165 generated, and if you change the step parameter afterwards, you'll
166 have to delete the old RRD files or somehow convert them. (This
167 variable is only applicable if the variable 'concurrentprobes' is
168 set in the 'General' section.)
169 Example value: 300
171 timeout
173 The fping "-t" parameter, but in (possibly fractional) seconds
174 rather than milliseconds, for consistency with other Smokeping
175 probes. Note that as Smokeping uses the fping 'counting' mode (-C),
176 this apparently only affects the last ping.
177 Example value: 1.5
179 tos Set the type of service (TOS) of outgoing ICMP packets. You need
181 at laeast fping-2.4b2_to3-ipv6 for this to work. Find a copy on
182 www.smokeping.org/pub.
183 Example value: 0x20
185 usestdout
187 Listen for FPing output on stdout instead of stderr ... (version
188 3.3+ sends its statistics on stdout).
189 Example value: true
191
193 Luis F Balbinot <hades@inf.ufrgs.br>
194 Niko Tyni <ntyni@iki.fi>
196 derived from Smokeping::probes::FPing by
198 Tobias Oetiker <tobi@oetiker.ch>
200
202 It is important to make sure that you can access the remote machine
203 without a password prompt, otherwise this probe will not work properly.
204 To test just try something like this:
205 $ ssh foo@HostA.foobar.com fping HostB.barfoo.com
207 The next thing you see must be fping's output.
209 The rhost, ruser, rport and rbinary variables used to be configured in
211 the Targets section of the first target or its parents They were moved
212 to the Probes section, because the variables aren't really target-
213 specific (all the targets are measured with the same parameters). The
214 Targets sections aren't recognized anymore.
215
217 This functionality should be in a generic 'remote execution' module so
218 that it could be used for the other probes too.
2192.7.3 2021-07-23 Smokeping_probes_RemoteFPing(3)