1Smokeping_probes_RemoteFPing(3)    SmokePing   Smokeping_probes_RemoteFPing(3)
2
3
4

NAME

6       Smokeping::probes::RemoteFPing - Remote FPing Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +RemoteFPing
12
13        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        rbinary = /usr/bin/fping # mandatory
21        rhost = my.pinger.host # mandatory
22        ruser = foo
23        sourceaddress = 192.168.0.1
24        step = 300
25        timeout = 1.5
26        tos = 0x20
27        usestdout = true
28
29        # [...]
30
31        *** Targets ***
32
33        probe = RemoteFPing # if this should be the default probe
34
35        # [...]
36
37        + mytarget
38        # probe = RemoteFPing # if the default probe is something else
39        host = my.host
40

DESCRIPTION

42       Integrates the remote execution of FPing via ssh/rsh into smokeping.
43       The variable binary must point to your copy of the ssh/rsh program.
44       The variable rbinary must point to your copy of the fping program at
45       the remote end.
46

VARIABLES

48       Supported probe-specific variables:
49
50       binary
51           This variable specifies the path of the remote shell program
52           (usually ssh, rsh or remsh). Any other script or binary that can be
53           called as
54
55           binary [ -l ruser ] rhost rbinary
56
57           may be used.
58
59           Example value: /usr/bin/ssh
60
61           This setting is mandatory.
62
63       blazemode
64           Send an extra ping and then discarge the first answer since the
65           first is bound to be an outliner.
66
67           Example value: true
68
69       hostinterval
70           The fping "-p" parameter, but in (possibly fractional) seconds
71           rather than milliseconds, for consistency with other Smokeping
72           probes. From fping(1):
73
74           This parameter sets the time that fping  waits between successive
75           packets to an individual target.
76
77           Example value: 1.5
78
79       mininterval
80           The fping "-i" parameter, but in (probably fractional) seconds
81           rather than milliseconds, for consistency with other Smokeping
82           probes. From fping(1):
83
84           The minimum amount of time between sending a ping packet to any
85           target.
86
87           Example value: 0.001
88
89           Default value: 0.01
90
91       offset
92           If you run many probes concurrently you may want to prevent them
93           from hitting your network all at the same time. Using the probe-
94           specific offset parameter you can change the point in time when
95           each probe will be run. Offset is specified in % of total interval,
96           or alternatively as 'random', and the offset from the 'General'
97           section is used if nothing is specified here. Note that this does
98           NOT influence the rrds itself, it is just a matter of when data
99           acqusition is initiated.  (This variable is only applicable if the
100           variable 'concurrentprobes' is set in the 'General' section.)
101
102           Example value: 50%
103
104       packetsize
105           The ping packet size (in the range of 12-64000 bytes).
106
107           Example value: 5000
108
109       pings
110           How many pings should be sent to each target, if different from the
111           global value specified in the Database section. Note that the
112           number of pings in the RRD files is fixed when they are originally
113           generated, and if you change this parameter afterwards, you'll have
114           to delete the old RRD files or somehow convert them.
115
116           Example value: 20
117
118       rbinary
119           The location of your fping binary.
120
121           Example value: /usr/bin/fping
122
123           This setting is mandatory.
124
125       rhost
126           The rhost option specifies the remote device from where fping will
127           be launched.
128
129           Example value: my.pinger.host
130
131           This setting is mandatory.
132
133       ruser
134           The (optional) ruser option allows you to specify the remote user,
135           if different from the one running the smokeping daemon.
136
137           Example value: foo
138
139       sourceaddress
140           The fping "-S" parameter . From fping(1):
141
142           Set source address.
143
144           Example value: 192.168.0.1
145
146       step
147           Duration of the base interval that this probe should use, if
148           different from the one specified in the 'Database' section. Note
149           that the step in the RRD files is fixed when they are originally
150           generated, and if you change the step parameter afterwards, you'll
151           have to delete the old RRD files or somehow convert them. (This
152           variable is only applicable if the variable 'concurrentprobes' is
153           set in the 'General' section.)
154
155           Example value: 300
156
157       timeout
158           The fping "-t" parameter, but in (possibly fractional) seconds
159           rather than milliseconds, for consistency with other Smokeping
160           probes. Note that as Smokeping uses the fping 'counting' mode (-C),
161           this apparently only affects the last ping.
162
163           Example value: 1.5
164
165       tos Set the type of service (TOS) of outgoing ICMP packets.  You need
166           at laeast fping-2.4b2_to3-ipv6 for this to work. Find a copy on
167           www.smokeping.org/pub.
168
169           Example value: 0x20
170
171       usestdout
172           Listen for FPing output on stdout instead of stderr ... (version
173           3.3+ sends its statistics on stdout).
174
175           Example value: true
176

AUTHORS

178        Luis F Balbinot <hades@inf.ufrgs.br>
179
180        Niko Tyni <ntyni@iki.fi>
181
182        derived from Smokeping::probes::FPing by
183
184        Tobias Oetiker <tobi@oetiker.ch>
185

NOTES

187       It is important to make sure that you can access the remote machine
188       without a password prompt, otherwise this probe will not work properly.
189       To test just try something like this:
190
191           $ ssh foo@HostA.foobar.com fping HostB.barfoo.com
192
193       The next thing you see must be fping's output.
194
195       The rhost, ruser and rbinary variables used to be configured in the
196       Targets section of the first target or its parents They were moved to
197       the Probes section, because the variables aren't really target-specific
198       (all the targets are measured with the same parameters). The Targets
199       sections aren't recognized anymore.
200

BUGS

202       This functionality should be in a generic 'remote execution' module so
203       that it could be used for the other probes too.
204
205
206
2072.7.2                             2019-02-02   Smokeping_probes_RemoteFPing(3)
Impressum