.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Smokeping_probes_FPing6 3"
.TH Smokeping_probes_FPing6 3 2024-02-04 2.8.2 SmokePing
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Smokeping::probes::FPing6 \- FPing6 Probe for SmokePing
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
\&
\& +FPing6
\&
\& binary = /usr/bin/fping6 # mandatory
\& blazemode = true
\& hostinterval = 1.5
\& interface = eth0
\& mininterval = 0.001
\& offset = 50%
\& packetsize = 5000
\& pings = 20
\& protocol = 6
\& sourceaddress = ::1
\& step = 300
\& timeout = 1.5
\& tos = 0x20
\& usestdout = true
\&
\& # The following variables can be overridden in each target section
\& /^influx_.+/ = influx_location = In the basement
\&
\& # [...]
\&
\& *** Targets ***
\&
\& probe = FPing6 # if this should be the default probe
\&
\& # [...]
\&
\& + mytarget
\& # probe = FPing6 # if the default probe is something else
\& host = my.host
\& /^influx_.+/ = influx_location = In the basement
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
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.
.SH VARIABLES
.IX Header "VARIABLES"
Supported probe-specific variables:
.IP binary 4
.IX Item "binary"
The location of your fping binary.
.Sp
Example value: /usr/bin/fping6
.Sp
This setting is mandatory.
.IP blazemode 4
.IX Item "blazemode"
Send an extra ping and then discard the first answer since the first is bound to be an outlier.
.Sp
Example value: true
.IP hostinterval 4
.IX Item "hostinterval"
The fping "\-p" parameter, but in (possibly fractional) seconds rather than
milliseconds, for consistency with other Smokeping probes. From \fBfping\fR\|(1):
.Sp
This parameter sets the time that fping  waits between successive packets
to an individual target.
.Sp
Example value: 1.5
.IP interface 4
.IX Item "interface"
The name of the network interface to perform the ping on.
.Sp
Example value: eth0
.IP mininterval 4
.IX Item "mininterval"
The fping "\-i" parameter, but in (probably fractional) seconds rather than
milliseconds, for consistency with other Smokeping probes. From \fBfping\fR\|(1):
.Sp
The minimum amount of time between sending a ping packet to any target.
.Sp
Example value: 0.001
.Sp
Default value: 0.01
.IP offset 4
.IX Item "offset"
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 acquisition is initiated.
(This variable is only applicable if the variable 'concurrentprobes' is set
in the 'General' section.)
.Sp
Example value: 50%
.IP packetsize 4
.IX Item "packetsize"
The ping packet size (in the range of 12\-64000 bytes).
.Sp
Example value: 5000
.IP pings 4
.IX Item "pings"
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.
.Sp
Example value: 20
.IP protocol 4
.IX Item "protocol"
Choose if the ping should use IPv4 or IPv6.
.Sp
Example value: 6
.Sp
Default value: 6
.IP sourceaddress 4
.IX Item "sourceaddress"
The fping "\-S" parameter . From \fBfping\fR\|(1):
.Sp
Set source address.
.Sp
Example value: ::1
.IP step 4
.IX Item "step"
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.)
.Sp
Example value: 300
.IP timeout 4
.IX Item "timeout"
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.
.Sp
Example value: 1.5
.IP tos 4
.IX Item "tos"
Set the type of service (TOS) of outgoing ICMP packets.
You need at laeast fping\-2.4b2_to3\-ipv6 for this to work. Find
a copy on www.smokeping.org/pub.
.Sp
Example value: 0x20
.IP usestdout 4
.IX Item "usestdout"
Listen for FPing output on stdout instead of stderr ... (version 3.3+ sends its statistics on stdout).
.Sp
Example value: true
.SH AUTHORS
.IX Header "AUTHORS"
Tobias Oetiker <tobi@oetiker.ch>
.PP
Niko Tyni <ntyni@iki.fi>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Smokeping::probes::FPing