.\" -*- 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_CiscoRTTMonDNS 3"
.TH Smokeping_probes_CiscoRTTMonDNS 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::CiscoRTTMonDNS.pm \- Probe for SmokePing
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
\&
\& +CiscoRTTMonDNS
\&
\& forks = 5
\& offset = 50%
\& step = 300
\& timeout = 15
\&
\& # The following variables can be overridden in each target section
\& /^influx_.+/ = influx_location = In the basement
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
\& iosint = 10.33.22.11
\& name = www.foobar.com.au # mandatory
\& pings = 5
\& timeout = 15
\&
\& # [...]
\&
\& *** Targets ***
\&
\& probe = CiscoRTTMonDNS # if this should be the default probe
\&
\& # [...]
\&
\& + mytarget
\& # probe = CiscoRTTMonDNS # if the default probe is something else
\& host = my.host
\& /^influx_.+/ = influx_location = In the basement
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
\& iosint = 10.33.22.11
\& name = www.foobar.com.au # mandatory
\& pings = 5
\& timeout = 15
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A probe for smokeping, which uses the ciscoRttMon MIB functionality ("Service Assurance Agent", "SAA") of Cisco IOS to time ( recursive, type A) DNS queries to a DNS server.
.SH VARIABLES
.IX Header "VARIABLES"
Supported probe-specific variables:
.IP forks 4
.IX Item "forks"
Run this many concurrent processes at maximum
.Sp
Example value: 5
.Sp
Default value: 5
.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 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"
How long a single 'ping' takes at maximum
.Sp
Example value: 15
.Sp
Default value: 5
.PP
Supported target-specific variables:
.IP /^influx_.+/ 4
.IX Item "/^influx_.+/"
This is a tag that will be sent to influxdb and has no impact on the probe measurement. The tag name will be sent without the "influx_" prefix, which will be replaced with "tag_" instead. Tags can be used for filtering.
.Sp
Example value: influx_location = In the basement
.IP ioshost 4
.IX Item "ioshost"
The (mandatory) ioshost parameter specifies the Cisco router, which will send the DNS requests, 
as well as the SNMP community string on the router.
.Sp
Example value: RTTcommunity@Myrouter.foobar.com.au
.Sp
This setting is mandatory.
.IP iosint 4
.IX Item "iosint"
The (optional) iosint parameter is the source address for the DNS packets.
This should be one of the active (!) IP addresses of the router to get
results. IOS looks up the target host address in the forwarding table
and then uses the interface(s) listed there to send the DNS packets. By
default IOS uses the (primary) IP address on the sending interface as
source address for packets originated by the router.
.Sp
Example value: 10.33.22.11
.IP name 4
.IX Item "name"
The (mandatory) name parameter is the DNS name to resolve.
.Sp
Example value: www.foobar.com.au
.Sp
This setting is mandatory.
.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: 5
.IP timeout 4
.IX Item "timeout"
How long a single RTTMonDNS 'ping' take at maximum plus 10 seconds to spare. Since we control our own timeout the only purpose of this is to not have us killed by the ping method from basefork.
.Sp
Example value: 15
.Sp
Default value: 15
.SH AUTHORS
.IX Header "AUTHORS"
Joerg.Kummer at Roche.com
.SH NOTES
.IX Header "NOTES"
.SS "host parameter"
.IX Subsection "host parameter"
The host parameter specifies the DNS server, which the router will use.
.SS "IOS VERSIONS"
.IX Subsection "IOS VERSIONS"
This probe only works with IOS 12.0(3)T or higher.  It is recommended to test it on less critical routers first.
.SS INSTALLATION
.IX Subsection "INSTALLATION"
To install this probe copy ciscoRttMonMIB.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping and CiscoRTTMonDNS.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes.
.PP
The router(s) must be configured to allow read/write SNMP access. Sufficient is:
.PP
.Vb 1
\&        snmp\-server community RTTCommunity RW
.Ve
.PP
If you want to be a bit more restrictive with SNMP write access to the router, then consider configuring something like this
.PP
.Vb 3
\&        access\-list 2 permit 10.37.3.5
\&        snmp\-server view RttMon ciscoRttMonMIB included
\&        snmp\-server community RTTCommunity view RttMon RW 2
.Ve
.PP
The above configuration grants SNMP read-write only to 10.37.3.5 (the smokeping host) and only to the ciscoRttMon MIB tree. The probe does not need access to SNMP variables outside the RttMon tree.
.SH BUGS
.IX Header "BUGS"
The probe does unnecessary DNS queries, i.e. more than configured in the "pings" variable, because the RTTMon MIB only allows to set a total time for all queries in one measurement run (one "life"). Currently the probe sets the life duration to "pings"*5+3 seconds (5 secs is the timeout value hardcoded into this probe).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://oss.oetiker.ch/smokeping/>
.PP
<http://www.switch.ch/misc/leinen/snmp/perl/>
.PP
The best source for background info on SAA is Cisco's documentation on <http://www.cisco.com> and the CISCO-RTTMON-MIB documentation, which is available at:
.PP
<ftp://ftp.cisco.com/pub/mibs/v2/CISCO\-RTTMON\-MIB.my>