Smokeping_probes_CiscoRTTMonEchoICMP(3)

1Smokeping_probes_CiscoRTTMonEchoICMPS(m3o)keSPmionkgeping_probes_CiscoRTTMonEchoICMP(3)
2
3
4

NAME

6       Smokeping::probes::CiscoRTTMonEchoICMP - Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +CiscoRTTMonEchoICMP
12
13        forks = 5
14        offset = 50%
15        step = 300
16        timeout = 15
17
18        # The following variables can be overridden in each target section
19        ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
20        iosint = 10.33.22.11
21        packetsize = 56
22        pings = 5
23        timeout = 15
24        tos = 160
25        vrf = INTERNET
26
27        # [...]
28
29        *** Targets ***
30
31        probe = CiscoRTTMonEchoICMP # if this should be the default probe
32
33        # [...]
34
35        + mytarget
36        # probe = CiscoRTTMonEchoICMP # if the default probe is something else
37        host = my.host
38        ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
39        iosint = 10.33.22.11
40        packetsize = 56
41        pings = 5
42        timeout = 15
43        tos = 160
44        vrf = INTERNET
45

DESCRIPTION

47       A probe for smokeping, which uses the ciscoRttMon MIB functionality
48       ("Service Assurance Agent", "SAA") of Cisco IOS to measure ICMP echo
49       ("ping") roundtrip times between a Cisco router and any IP address.
50

VARIABLES

52       Supported probe-specific variables:
53
54       forks
55           Run this many concurrent processes at maximum
56
57           Example value: 5
58
59           Default value: 5
60
61       offset
62           If you run many probes concurrently you may want to prevent them
63           from hitting your network all at the same time. Using the probe-
64           specific offset parameter you can change the point in time when
65           each probe will be run. Offset is specified in % of total interval,
66           or alternatively as 'random', and the offset from the 'General'
67           section is used if nothing is specified here. Note that this does
68           NOT influence the rrds itself, it is just a matter of when data
69           acqusition is initiated.  (This variable is only applicable if the
70           variable 'concurrentprobes' is set in the 'General' section.)
71
72           Example value: 50%
73
74       step
75           Duration of the base interval that this probe should use, if
76           different from the one specified in the 'Database' section. Note
77           that the step in the RRD files is fixed when they are originally
78           generated, and if you change the step parameter afterwards, you'll
79           have to delete the old RRD files or somehow convert them. (This
80           variable is only applicable if the variable 'concurrentprobes' is
81           set in the 'General' section.)
82
83           Example value: 300
84
85       timeout
86           How long a single 'ping' takes at maximum
87
88           Example value: 15
89
90           Default value: 5
91
92       Supported target-specific variables:
93
94       ioshost
95           The (mandatory) ioshost parameter specifies the Cisco router, which
96           will execute the pings, as well as the SNMP community string on the
97           router.
98
99           Example value: RTTcommunity@Myrouter.foobar.com.au
100
101           This setting is mandatory.
102
103       iosint
104           The (optional) iosint parameter is the source address for the pings
105           sent. This should be one of the active (!) IP addresses of the
106           router to get results. IOS looks up the target host address in the
107           forwarding table and then uses the interface(s) listed there to
108           send the ping packets. By default IOS uses the (primary) IP address
109           on the sending interface as source address for a ping. The RTTMon
110           MIB versions before IOS 12.0(3)T didn't support this parameter.
111
112           Example value: 10.33.22.11
113
114       packetsize
115           The packetsize parameter lets you configure the packetsize for the
116           pings sent. The minimum is 8, the maximum 16392. Use the same
117           number as with fping, if you want the same packet sizes being used
118           on the network.
119
120           Default value: 56
121
122       pings
123           How many pings should be sent to each target, if different from the
124           global value specified in the Database section. Note that the
125           number of pings in the RRD files is fixed when they are originally
126           generated, and if you change this parameter afterwards, you'll have
127           to delete the old RRD files or somehow convert them.
128
129           Example value: 5
130
131       timeout
132           How long a single RTTMonEcho ICMP 'ping' take at maximum plus 10
133           seconds to spare. Since we control our own timeout the only purpose
134           of this is to not have us killed by the ping method from basefork.
135
136           Example value: 15
137
138           Default value: 15
139
140       tos The (optional) tos parameter specifies the value of the ToS byte in
141           the IP header of the pings. Multiply DSCP values times 4 and
142           Precedence values times 32 to calculate the ToS values to
143           configure, e.g. ToS 160 corresponds to a DSCP value 40 and a
144           Precedence value of 5. The RTTMon MIB versions before IOS 12.0(3)T
145           didn't support this parameter.
146
147           Example value: 160
148
149           Default value: 0
150
151       vrf The the VPN name in which the RTT operation will be used. For
152           regular RTT operation this field should not be configured. The
153           agent will use this field to identify the VPN routing Table for
154           this operation.
155
156           Example value: INTERNET
157

AUTHORS

159       Joerg.Kummer at Roche.com
160

NOTES

162   IOS VERSIONS
163       It is highly recommended to use this probe with routers running IOS
164       12.0(3)T or higher and to test it on less critical routers first. I
165       managed to crash a router with 12.0(9) quite consistently ( in IOS
166       lingo 12.0(9) is older code than 12.0(3)T ). I did not observe crashes
167       on higher IOS releases, but messages on the router like the one below,
168       when multiple processes concurrently accessed the same router (this
169       case was IOS 12.1(12b) ):
170
171       Aug 20 07:30:14: %RTT-3-SemaphoreBadUnlock: %RTR: Attempt to unlock
172       semaphore by wrong RTR process 70, locked by 78
173
174       Aug 20 07:35:15: %RTT-3-SemaphoreInUse: %RTR: Could not obtain a lock
175       for RTR. Process 80
176
177   INSTALLATION
178       To install this probe copy ciscoRttMonMIB.pm files to
179       ($SMOKEPINGINSTALLDIR)/lib/Smokeping and CiscoRTTMonEchoICMP.pm to
180       ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes. V0.97 or higher of Simon
181       Leinen's SNMP_Session.pm is required.
182
183       The router(s) must be configured to allow read/write SNMP access.
184       Sufficient is:
185
186               snmp-server community RTTCommunity RW
187
188       If you want to be a bit more restrictive with SNMP write access to the
189       router, then consider configuring something like this
190
191               access-list 2 permit 10.37.3.5
192               snmp-server view RttMon ciscoRttMonMIB included
193               snmp-server community RTTCommunity view RttMon RW 2
194
195       The above configuration grants SNMP read-write only to 10.37.3.5 (the
196       smokeping host) and only to the ciscoRttMon MIB tree. The probe does
197       not need access to SNMP variables outside the RttMon tree.
198

BUGS

200       The probe sends unnecessary pings, i.e. more than configured in the
201       "pings" variable, because the RTTMon MIB only allows to set a total
202       time for all pings in one measurement run (one "life"). Currently the
203       probe sets the life duration to "pings"*5+3 seconds (5 secs is the ping
204       timeout value hardcoded into this probe).
205