1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<title>Smokeping/probes/CiscoRTTMonDNS</title>
5
<link rev="made" href="mailto:dws@ee.ethz.ch" />
8
<body style="background-color: white">
10
<p><a name="__index__"></a></p>
16
<li><a href="#name">NAME</a></li>
17
<li><a href="#synopsis">SYNOPSIS</a></li>
18
<li><a href="#description">DESCRIPTION</a></li>
19
<li><a href="#variables">VARIABLES</a></li>
20
<li><a href="#authors">AUTHORS</a></li>
21
<li><a href="#notes">NOTES</a></li>
24
<li><a href="#host_parameter">host parameter</a></li>
25
<li><a href="#ios_versions">IOS VERSIONS</a></li>
26
<li><a href="#installation">INSTALLATION</a></li>
29
<li><a href="#bugs">BUGS</a></li>
30
<li><a href="#see_also">SEE ALSO</a></li>
37
<h1><a name="name">NAME</a></h1>
38
<p>Smokeping::probes::CiscoRTTMonDNS.pm - Probe for SmokePing</p>
42
<h1><a name="synopsis">SYNOPSIS</a></h1>
53
# The following variables can be overridden in each target section
54
ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
56
name = www.foobar.com.au # mandatory
63
probe = CiscoRTTMonDNS # if this should be the default probe</pre>
68
# probe = CiscoRTTMonDNS # if the default probe is something else
70
ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
72
name = www.foobar.com.au # mandatory
77
<h1><a name="description">DESCRIPTION</a></h1>
78
<p>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.</p>
82
<h1><a name="variables">VARIABLES</a></h1>
83
<p>Supported probe-specific variables:</p>
85
<dt><strong><a name="item_forks">forks</a></strong><br />
88
Run this many concurrent processes at maximum
91
<p>Example value: 5</p>
94
<p>Default value: 5</p>
97
</dd><dt><strong><a name="item_offset">offset</a></strong><br />
100
If you run many probes concurrently you may want to prevent them from
101
hitting your network all at the same time. Using the probe-specific
102
offset parameter you can change the point in time when each probe will
103
be run. Offset is specified in % of total interval, or alternatively as
104
'random', and the offset from the 'General' section is used if nothing
105
is specified here. Note that this does NOT influence the rrds itself,
106
it is just a matter of when data acqusition is initiated.
107
(This variable is only applicable if the variable 'concurrentprobes' is set
108
in the 'General' section.)
111
<p>Example value: 50%</p>
114
</dd><dt><strong><a name="item_step">step</a></strong><br />
117
Duration of the base interval that this probe should use, if different
118
from the one specified in the 'Database' section. Note that the step in
119
the RRD files is fixed when they are originally generated, and if you
120
change the step parameter afterwards, you'll have to delete the old RRD
121
files or somehow convert them. (This variable is only applicable if
122
the variable 'concurrentprobes' is set in the 'General' section.)
125
<p>Example value: 300</p>
128
</dd><dt><strong><a name="item_timeout">timeout</a></strong><br />
131
How long a single 'ping' takes at maximum
134
<p>Example value: 15</p>
137
<p>Default value: 5</p>
140
<p>Supported target-specific variables:</p>
142
<dt><strong><a name="item_ioshost">ioshost</a></strong><br />
145
The (mandatory) ioshost parameter specifies the Cisco router, which will send the DNS requests,
146
as well as the SNMP community string on the router.
149
<p>Example value: <a href="mailto:RTTcommunity@Myrouter.foobar.com.au">RTTcommunity@Myrouter.foobar.com.au</a></p>
152
<p>This setting is mandatory.</p>
155
</dd><dt><strong><a name="item_iosint">iosint</a></strong><br />
158
The (optional) iosint parameter is the source address for the DNS packets.
159
This should be one of the active (!) IP addresses of the router to get
160
results. IOS looks up the target host address in the forwarding table
161
and then uses the <code>interface(s)</code> listed there to send the DNS packets. By
162
default IOS uses the (primary) IP address on the sending interface as
163
source address for packets originated by the router.
166
<p>Example value: 10.33.22.11</p>
169
</dd><dt><strong><a name="item_name">name</a></strong><br />
172
The (mandatory) name parameter is the DNS name to resolve.
175
<p>Example value: www.foobar.com.au</p>
178
<p>This setting is mandatory.</p>
181
</dd><dt><strong><a name="item_pings">pings</a></strong><br />
184
How many pings should be sent to each target, if different from the global
185
value specified in the Database section. Note that the number of pings in
186
the RRD files is fixed when they are originally generated, and if you
187
change this parameter afterwards, you'll have to delete the old RRD
188
files or somehow convert them.
191
<p>Example value: 5</p>
197
<h1><a name="authors">AUTHORS</a></h1>
198
<p>Joerg.Kummer at Roche.com</p>
202
<h1><a name="notes">NOTES</a></h1>
205
<h2><a name="host_parameter">host parameter</a></h2>
206
<p>The host parameter specifies the DNS server, which the router will use.</p>
209
<h2><a name="ios_versions">IOS VERSIONS</a></h2>
210
<p>This probe only works with IOS 12.0(3)T or higher. It is recommended to test it on less critical routers first.</p>
213
<h2><a name="installation">INSTALLATION</a></h2>
214
<p>To install this probe copy ciscoRttMonMIB.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping and CiscoRTTMonDNS.pm to ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes.</p>
215
<p>The <code>router(s)</code> must be configured to allow read/write SNMP access. Sufficient is:</p>
217
snmp-server community RTTCommunity RW
219
If you want to be a bit more restrictive with SNMP write access to the router, then consider configuring something like this</pre>
221
access-list 2 permit 10.37.3.5
222
snmp-server view RttMon ciscoRttMonMIB included
223
snmp-server community RTTCommunity view RttMon RW 2</pre>
224
<p>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.</p>
228
<h1><a name="bugs">BUGS</a></h1>
229
<p>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''*2+3 seconds (2 secs is the timeout value hardcoded into this probe).</p>
233
<h1><a name="see_also">SEE ALSO</a></h1>
234
<p><a href="http://oss.oetiker.ch/smokeping/">http://oss.oetiker.ch/smokeping/</a></p>
235
<p><a href="http://www.switch.ch/misc/leinen/snmp/perl/">http://www.switch.ch/misc/leinen/snmp/perl/</a></p>
236
<p>The best source for background info on SAA is Cisco's documentation on <a href="http://www.cisco.com">http://www.cisco.com</a> and the CISCO-RTTMON-MIB documentation, which is available at:</p>
237
<p><a href="ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my">ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my</a></p>
added
removed
doc/Smokeping/probes/CiscoRTTMonDNS.html
