Smokeping_probes_CiscoRTTMonTcpConnect(3)

1Smokeping_probes_CiscoRTTMonTcpConneScmtoS(km3eo)Pkienpging_probes_CiscoRTTMonTcpConnect(3)
2
3
4

NAME

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

SYNOPSIS

9        *** Probes ***
10
11        +CiscoRTTMonTcpConnect
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        pings = 5
22        port = 80
23        timeout = 15
24        tos = 160
25
26        # [...]
27
28        *** Targets ***
29
30        probe = CiscoRTTMonTcpConnect # if this should be the default probe
31
32        # [...]
33
34        + mytarget
35        # probe = CiscoRTTMonTcpConnect # if the default probe is something else
36        host = my.host
37        ioshost = RTTcommunity@Myrouter.foobar.com.au # mandatory
38        iosint = 10.33.22.11
39        pings = 5
40        port = 80
41        timeout = 15
42        tos = 160
43

DESCRIPTION

45       A probe for smokeping, which uses the ciscoRttMon MIB functionality
46       ("Service Assurance Agent", "SAA") of Cisco IOS to measure TCP connect
47       times between a Cisco router and a TCP server. The measured value is
48       the time is the time to establish a TCP session, i.e. the time between
49       the initial "SYN" TCP packet of the router and the "SYN ACK" packet of
50       the host. The router terminates the TCP session immediately after the
51       reception of "SYN ACK" with a "FIN" packet.
52

VARIABLES

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

AUTHORS

151       Joerg.Kummer at Roche.com
152

NOTES

154   IOS VERSIONS
155       This probe only works with Cisco IOS 12.0(3)T or higher. It is
156       recommended to test it on less critical routers first.
157
158   INSTALLATION
159       To install this probe copy ciscoRttMonMIB.pm to
160       ($SMOKEPINGINSTALLDIR)/Smokeping/lib and CiscoRTTMonTcpConnect.pm to
161       ($SMOKEPINGINSTALLDIR)/lib/Smokeping/probes. V0.97 or higher of Simon
162       Leinen's SNMP_Session.pm is required.
163
164       The router(s) must be configured to allow read/write SNMP access.
165       Sufficient is:
166
167               snmp-server community RTTCommunity RW
168
169       If you want to be a bit more restrictive with SNMP write access to the
170       router, then consider configuring something like this
171
172               access-list 2 permit 10.37.3.5
173               snmp-server view RttMon ciscoRttMonMIB included
174               snmp-server community RTTCommunity view RttMon RW 2
175
176       The above configuration grants SNMP read-write only to 10.37.3.5 (the
177       smokeping host) and only to the ciscoRttMon MIB tree. The probe does
178       not need access to SNMP variables outside the RttMon tree.
179

BUGS

181       The probe establishes unnecessary connections, i.e. more than
182       configured in the "pings" variable, because the RTTMon MIB only allows
183       to set a total time for all connections in one measurement run (one
184       "life"). Currently the probe sets the life duration to "pings"*5+3
185       seconds (5 secs is the timeout value hardcoded into this probe).
186