1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4
.\" ========================================================================
5
.de Sh \" Subsection heading
13
.de Sp \" Vertical space (when we can't use .PP)
17
.de Vb \" Begin verbatim text
22
.de Ve \" End verbatim text
26
.\" Set up some character translations and predefined strings. \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote. | will give a
29
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD. Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
57
. tm Index:\\$1\t\\n%\t"\\$2"
63
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear. Run. Save yourself. No user-serviceable parts.
70
. \" fudge factors for nroff and troff
79
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85
. \" simple accents for nroff and troff
95
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102
. \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
. \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
. \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
129
.\" ========================================================================
131
.IX Title "doc::Smokeping::probes::CiscoRTTMonEchoICMP 3"
132
.TH doc::Smokeping::probes::CiscoRTTMonEchoICMP 3 "2006-07-14" "2.0.9" "SmokePing"
134
Smokeping::probes::CiscoRTTMonEchoICMP \- Probe for SmokePing
136
.IX Header "SYNOPSIS"
142
\& +CiscoRTTMonEchoICMP
153
\& # The following variables can be overridden in each target section
154
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
155
\& iosint = 10.33.22.11
171
\& probe = CiscoRTTMonEchoICMP # if this should be the default probe
180
\& # probe = CiscoRTTMonEchoICMP # if the default probe is something else
182
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
183
\& iosint = 10.33.22.11
190
.IX Header "DESCRIPTION"
191
A probe for smokeping, which uses the ciscoRttMon \s-1MIB\s0 functionality (\*(L"Service Assurance Agent\*(R", \*(L"\s-1SAA\s0\*(R") 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.
193
.IX Header "VARIABLES"
194
Supported probe-specific variables:
197
Run this many concurrent processes at maximum
204
If you run many probes concurrently you may want to prevent them from
205
hitting your network all at the same time. Using the probe-specific
206
offset parameter you can change the point in time when each probe will
207
be run. Offset is specified in % of total interval, or alternatively as
208
\&'random', and the offset from the 'General' section is used if nothing
209
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
210
it is just a matter of when data acqusition is initiated.
211
(This variable is only applicable if the variable 'concurrentprobes' is set
212
in the 'General' section.)
217
Duration of the base interval that this probe should use, if different
218
from the one specified in the 'Database' section. Note that the step in
219
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
220
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
221
files or somehow convert them. (This variable is only applicable if
222
the variable 'concurrentprobes' is set in the 'General' section.)
227
How long a single 'ping' takes at maximum
233
Supported target-specific variables:
236
The (mandatory) ioshost parameter specifies the Cisco router, which will
237
execute the pings, as well as the \s-1SNMP\s0 community string on the router.
239
Example value: RTTcommunity@Myrouter.foobar.com.au
241
This setting is mandatory.
244
The (optional) iosint parameter is the source address for the pings
245
sent. This should be one of the active (!) \s-1IP\s0 addresses of the router to
246
get results. \s-1IOS\s0 looks up the target host address in the forwarding table
247
and then uses the interface(s) listed there to send the ping packets. By
248
default \s-1IOS\s0 uses the (primary) \s-1IP\s0 address on the sending interface as
249
source address for a ping. The RTTMon \s-1MIB\s0 versions before \s-1IOS\s0 12.0(3)T
250
didn't support this parameter.
252
Example value: 10.33.22.11
254
.IX Item "packetsize"
255
The packetsize parameter lets you configure the packetsize for the pings
256
sent. The minimum is 8, the maximum 16392. Use the same number as with
257
fping, if you want the same packet sizes being used on the network.
262
How many pings should be sent to each target, if different from the global
263
value specified in the Database section. Note that the number of pings in
264
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
265
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
266
files or somehow convert them.
271
The (optional) tos parameter specifies the value of the ToS byte in
272
the \s-1IP\s0 header of the pings. Multiply \s-1DSCP\s0 values times 4 and Precedence
273
values times 32 to calculate the ToS values to configure, e.g. ToS 160
274
corresponds to a \s-1DSCP\s0 value 40 and a Precedence value of 5. The RTTMon
275
\&\s-1MIB\s0 versions before \s-1IOS\s0 12.0(3)T didn't support this parameter.
282
The the \s-1VPN\s0 name in which the \s-1RTT\s0 operation will be used. For regular \s-1RTT\s0
283
operation this field should not be configured. The agent
284
will use this field to identify the \s-1VPN\s0 routing Table for
287
Example value: \s-1INTERNET\s0
290
Joerg.Kummer at Roche.com
293
.Sh "\s-1IOS\s0 \s-1VERSIONS\s0"
294
.IX Subsection "IOS VERSIONS"
295
It is highly recommended to use this probe with routers running \s-1IOS\s0 12.0(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\s0 12.1(12b) ):
297
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
299
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
300
.Sh "\s-1INSTALLATION\s0"
301
.IX Subsection "INSTALLATION"
302
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.
304
The router(s) must be configured to allow read/write \s-1SNMP\s0 access. Sufficient is:
307
\& snmp-server community RTTCommunity RW
310
If you want to be a bit more restrictive with \s-1SNMP\s0 write access to the router, then consider configuring something like this
313
\& access-list 2 permit 10.37.3.5
314
\& snmp-server view RttMon ciscoRttMonMIB included
315
\& snmp-server community RTTCommunity view RttMon RW 2
318
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.
321
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"*2+3 seconds (2 secs is the ping timeout value hardcoded into this probe).
323
.IX Header "SEE ALSO"
324
<http://oss.oetiker.ch/smokeping/>
326
<http://www.switch.ch/misc/leinen/snmp/perl/>
328
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:
329
<ftp://ftp.cisco.com/pub/mibs/v2/CISCO\-RTTMON\-MIB.my>
added
removed
doc/Smokeping/probes/Smokeping::probes::CiscoRTTMonEchoICMP.3
