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::CiscoRTTMonDNS 3"
132
.TH doc::Smokeping::probes::CiscoRTTMonDNS 3 "2006-07-14" "2.0.9" "SmokePing"
134
Smokeping::probes::CiscoRTTMonDNS.pm \- Probe for SmokePing
136
.IX Header "SYNOPSIS"
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
156
\& name = www.foobar.com.au # mandatory
169
\& probe = CiscoRTTMonDNS # if this should be the default probe
178
\& # probe = CiscoRTTMonDNS # if the default probe is something else
180
\& ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
181
\& iosint = 10.33.22.11
182
\& name = www.foobar.com.au # mandatory
186
.IX Header "DESCRIPTION"
187
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 time ( recursive, type A) \s-1DNS\s0 queries to a \s-1DNS\s0 server.
189
.IX Header "VARIABLES"
190
Supported probe-specific variables:
193
Run this many concurrent processes at maximum
200
If you run many probes concurrently you may want to prevent them from
201
hitting your network all at the same time. Using the probe-specific
202
offset parameter you can change the point in time when each probe will
203
be run. Offset is specified in % of total interval, or alternatively as
204
\&'random', and the offset from the 'General' section is used if nothing
205
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
206
it is just a matter of when data acqusition is initiated.
207
(This variable is only applicable if the variable 'concurrentprobes' is set
208
in the 'General' section.)
213
Duration of the base interval that this probe should use, if different
214
from the one specified in the 'Database' section. Note that the step in
215
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
216
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
217
files or somehow convert them. (This variable is only applicable if
218
the variable 'concurrentprobes' is set in the 'General' section.)
223
How long a single 'ping' takes at maximum
229
Supported target-specific variables:
232
The (mandatory) ioshost parameter specifies the Cisco router, which will send the \s-1DNS\s0 requests,
233
as well as the \s-1SNMP\s0 community string on the router.
235
Example value: RTTcommunity@Myrouter.foobar.com.au
237
This setting is mandatory.
240
The (optional) iosint parameter is the source address for the \s-1DNS\s0 packets.
241
This should be one of the active (!) \s-1IP\s0 addresses of the router to get
242
results. \s-1IOS\s0 looks up the target host address in the forwarding table
243
and then uses the interface(s) listed there to send the \s-1DNS\s0 packets. By
244
default \s-1IOS\s0 uses the (primary) \s-1IP\s0 address on the sending interface as
245
source address for packets originated by the router.
247
Example value: 10.33.22.11
250
The (mandatory) name parameter is the \s-1DNS\s0 name to resolve.
252
Example value: www.foobar.com.au
254
This setting is mandatory.
257
How many pings should be sent to each target, if different from the global
258
value specified in the Database section. Note that the number of pings in
259
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
260
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
261
files or somehow convert them.
266
Joerg.Kummer at Roche.com
270
.IX Subsection "host parameter"
271
The host parameter specifies the \s-1DNS\s0 server, which the router will use.
272
.Sh "\s-1IOS\s0 \s-1VERSIONS\s0"
273
.IX Subsection "IOS VERSIONS"
274
This probe only works with \s-1IOS\s0 12.0(3)T or higher. It is recommended to test it on less critical routers first.
275
.Sh "\s-1INSTALLATION\s0"
276
.IX Subsection "INSTALLATION"
277
To install this probe copy ciscoRttMonMIB.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping and CiscoRTTMonDNS.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes.
279
The router(s) must be configured to allow read/write \s-1SNMP\s0 access. Sufficient is:
282
\& snmp-server community RTTCommunity RW
285
If you want to be a bit more restrictive with \s-1SNMP\s0 write access to the router, then consider configuring something like this
288
\& access-list 2 permit 10.37.3.5
289
\& snmp-server view RttMon ciscoRttMonMIB included
290
\& snmp-server community RTTCommunity view RttMon RW 2
293
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.
296
The probe does unnecessary \s-1DNS\s0 queries, 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 queries 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 timeout value hardcoded into this probe).
298
.IX Header "SEE ALSO"
299
<http://oss.oetiker.ch/smokeping/>
301
<http://www.switch.ch/misc/leinen/snmp/perl/>
303
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:
305
<ftp://ftp.cisco.com/pub/mibs/v2/CISCO\-RTTMON\-MIB.my>
added
removed
doc/Smokeping/probes/Smokeping::probes::CiscoRTTMonDNS.3
