.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Smokeping_probes_CiscoRTTMonEchoICMP 3"
.TH Smokeping_probes_CiscoRTTMonEchoICMP 3 "2022-10-15" "2.7.3" "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::CiscoRTTMonEchoICMP \- Probe for SmokePing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
\&
\& +CiscoRTTMonEchoICMP
\&
\& forks = 5
\& offset = 50%
\& step = 300
\& timeout = 15
\&
\& # The following variables can be overridden in each target section
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
\& iosint = 10.33.22.11
\& packetsize = 56
\& pings = 5
\& timeout = 15
\& tos = 160
\& vrf = INTERNET
\&
\& # [...]
\&
\& *** Targets ***
\&
\& probe = CiscoRTTMonEchoICMP # if this should be the default probe
\&
\& # [...]
\&
\& + mytarget
\& # probe = CiscoRTTMonEchoICMP # if the default probe is something else
\& host = my.host
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
\& iosint = 10.33.22.11
\& packetsize = 56
\& pings = 5
\& timeout = 15
\& tos = 160
\& vrf = INTERNET
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A probe for smokeping, which uses the ciscoRttMon \s-1MIB\s0 functionality (\*(L"Service Assurance Agent\*(R", \*(L"\s-1SAA\*(R"\s0) of Cisco \s-1IOS\s0 to measure \s-1ICMP\s0 echo (\*(L"ping\*(R") roundtrip times between a Cisco router and any \s-1IP\s0 address.
.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 \s-1NOT\s0 influence the rrds itself,
it is just a matter of when data acqusition 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 \s-1RRD\s0 files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
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 "ioshost" 4
.IX Item "ioshost"
The (mandatory) ioshost parameter specifies the Cisco router, which will
execute the pings, as well as the \s-1SNMP\s0 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 pings
sent. This should be one of the active (!) \s-1IP\s0 addresses of the router to
get results. \s-1IOS\s0 looks up the target host address in the forwarding table
and then uses the interface(s) listed there to send the ping packets. By
default \s-1IOS\s0 uses the (primary) \s-1IP\s0 address on the sending interface as
source address for a ping. The RTTMon \s-1MIB\s0 versions before \s-1IOS 12.0\s0(3)T
didn't support this parameter.
.Sp
Example value: 10.33.22.11
.IP "packetsize" 4
.IX Item "packetsize"
The packetsize parameter lets you configure the packetsize for the pings
sent. The minimum is 8, the maximum 16392. Use the same number as with
fping, if you want the same packet sizes being used on the network.
.Sp
Default value: 56
.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 \s-1RRD\s0 files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them.
.Sp
Example value: 5
.IP "timeout" 4
.IX Item "timeout"
How long a single RTTMonEcho \s-1ICMP\s0 '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
.IP "tos" 4
.IX Item "tos"
The (optional) tos parameter specifies the value of the ToS byte in
the \s-1IP\s0 header of the pings. Multiply \s-1DSCP\s0 values times 4 and Precedence
values times 32 to calculate the ToS values to configure, e.g. ToS 160
corresponds to a \s-1DSCP\s0 value 40 and a Precedence value of 5. The RTTMon
\&\s-1MIB\s0 versions before \s-1IOS 12.0\s0(3)T didn't support this parameter.
.Sp
Example value: 160
.Sp
Default value: 0
.IP "vrf" 4
.IX Item "vrf"
The the \s-1VPN\s0 name in which the \s-1RTT\s0 operation will be used. For regular \s-1RTT\s0
operation this field should not be configured. The agent
will use this field to identify the \s-1VPN\s0 routing Table for
this operation.
.Sp
Example value: \s-1INTERNET\s0
.SH "AUTHORS"
.IX Header "AUTHORS"
Joerg.Kummer at Roche.com
.SH "NOTES"
.IX Header "NOTES"
.SS "\s-1IOS VERSIONS\s0"
.IX Subsection "IOS VERSIONS"
It is highly recommended to use this probe with routers running \s-1IOS 12.0\s0(3)T or higher and to test it on less critical routers first. I managed to crash a router with 12.0(9) quite consistently ( in \s-1IOS\s0 lingo 12.0(9) is older code than 12.0(3)T ). I did not observe crashes on higher \s-1IOS\s0 releases, but messages on the router like the one below, when multiple processes concurrently accessed the same router (this case was \s-1IOS 12.1\s0(12b) ):
.PP
Aug 20 07:30:14: \f(CW%RTT\fR\-3\-SemaphoreBadUnlock: \f(CW%RTR:\fR Attempt to unlock semaphore by wrong \s-1RTR\s0 process 70, locked by 78
.PP
Aug 20 07:35:15: \f(CW%RTT\fR\-3\-SemaphoreInUse: \f(CW%RTR:\fR Could not obtain a lock for \s-1RTR.\s0 Process 80
.SS "\s-1INSTALLATION\s0"
.IX Subsection "INSTALLATION"
To install this probe copy ciscoRttMonMIB.pm files to ($SMOKEPINGINSTALLDIR)/lib/Smokeping and CiscoRTTMonEchoICMP.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes. V0.97 or higher of Simon Leinen's SNMP_Session.pm is required.
.PP
The router(s) must be configured to allow read/write \s-1SNMP\s0 access. Sufficient is:
.PP
.Vb 1
\&        snmp\-server community RTTCommunity RW
.Ve
.PP
If you want to be a bit more restrictive with \s-1SNMP\s0 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 \s-1SNMP\s0 read-write only to 10.37.3.5 (the smokeping host) and only to the ciscoRttMon \s-1MIB\s0 tree. The probe does not need access to \s-1SNMP\s0 variables outside the RttMon tree.
.SH "BUGS"
.IX Header "BUGS"
The probe sends unnecessary pings, i.e. more than configured in the \*(L"pings\*(R" variable, because the RTTMon \s-1MIB\s0 only allows to set a total time for all pings in one measurement run (one \*(L"life\*(R"). Currently the probe sets the life duration to \*(L"pings\*(R"*5+3 seconds (5 secs is the ping 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 \s-1SAA\s0 is Cisco's documentation on <http://www.cisco.com> and the CISCO-RTTMON-MIB documentation, which is available at:
<ftp://ftp.cisco.com/pub/mibs/v2/CISCO\-RTTMON\-MIB.my>