← Back to branch summary

~ubuntu-branches/debian/lenny/smokeping/lenny

« back to all changes in this revision

Viewing changes to doc/probes/CiscoRTTMonTcpConnect.pm.txt

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
http://bugs.debian.org/395056
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/probes/CiscoRTTMonTcpConnect.pm.txt
1
 
probes::CiscoRTTMonTcpConnectS(m3o)kePpirnogbes::CiscoRTTMonTcpConnect(3)
2
 
 
3
 
 
4
 
 
5
 
NNAAMMEE
6
 
       probes::CiscoRTTMonTcpConnect - Probe for SmokePing
7
 
 
8
 
SSYYNNOOPPSSIISS
9
 
        *** Probes ***
10
 
        + CiscoRTTMonTcpConnect
11
 
        + forks=50
12
 
 
13
 
        *** Targets ***
14
 
        + MyRouter-TCPVictim
15
 
        menu = MyRouter->TCPVictim
16
 
        title = RTTMon TCP connect from MyRouter to TCPVictim
17
 
        host = TCPVictim.foobar.com.au
18
 
        probe=CiscoRTTMonTcpConnect
19
 
        ++ PROBE_CONF
20
 
        ioshost = RTTcommunity@Myrouter.foobar.com.au
21
 
        iosint = 10.33.22.11
22
 
        tos = 160
23
 
        port = 23
24
 
 
25
 
DDEESSCCRRIIPPTTIIOONN
26
 
       A probe for smokeping, which uses the ciscoRttMon MIB
27
 
       functionality ("Service Assurance Agent", "SAA") of Cisco
28
 
       IOS to measure TCP connect times between a Cisco router
29
 
       and a TCP server. The measured value is the time is the
30
 
       time to establish a TCP session, i.e. the time between the
31
 
       initial "SYN" TCP packet of the router and the "SYN ACK"
32
 
       packet of the host. The router terminates the TCP session
33
 
       immediately after the reception of "SYN ACK" with a "FIN"
34
 
       packet.
35
 
 
36
 
PPAARRAAMMEETTEERRSS
37
 
       The (mandatory) host parameter specifies the IP host,
38
 
       which the router will connect to. This can be a DNS name,
39
 
       the smokeping host can resolve or a dotted-quad IP
40
 
       address.
41
 
 
42
 
       The (mandatory) ioshost parameter specifies the Cisco
43
 
       router, which will establish the TCP connections as well
44
 
       as the SNMP community string on the router.
45
 
 
46
 
       The (optional) port parameter lets you configure the des-
47
 
       tination TCP port on the host. The default is the http
48
 
       port 80.
49
 
 
50
 
       The (optional) iosint parameter is the source address for
51
 
       the TCP connections. This should be one of the active (!)
52
 
       IP addresses of the router to get results. IOS looks up
53
 
       the target host address in the forwarding table and then
54
 
       uses the interface(s) listed there to send the TCP pack-
55
 
       ets. By default IOS uses the (primary) IP address on the
56
 
       sending interface as source address for a connection.
57
 
 
58
 
       The (optional) tos parameter specifies the value of the
59
 
       ToS byte in the IP header of the packets from the router.
60
 
       Multiply DSCP values times 4 and Precedence values times
61
 
       32 to calculate the ToS values to configure, e.g. ToS 160
62
 
       corresponds to a DSCP value 40 and a Precedence value of
63
 
       5. Please note that this will not influence the ToS value
64
 
       in the packets sent by the the host.
65
 
 
66
 
IIOOSS VVEERRSSIIOONNSS
67
 
       This probe only works with Cisco IOS 12.0(3)T or higher.
68
 
       It is recommended to test it on less critical routers
69
 
       first.
70
 
 
71
 
IINNSSTTAALLLLAATTIIOONN
72
 
       To install this probe copy ciscoRttMonMIB.pm to
73
 
       ($SMOKEPINGINSTALLDIR)/lib and CiscoRTTMonTcpConnect.pm to
74
 
       ($SMOKEPINGINSTALLDIR)/lib/probes. V0.97 or higher of
75
 
       Simon Leinen's SNMP_Session.pm is required.
76
 
 
77
 
       The router(s) must be configured to allow read/write SNMP
78
 
       access. Sufficient is:
79
 
 
80
 
               snmp-server community RTTCommunity RW
81
 
 
82
 
       If you want to be a bit more restrictive with SNMP write
83
 
       access to the router, then consider configuring something
84
 
       like this
85
 
 
86
 
               access-list 2 permit 10.37.3.5
87
 
               snmp-server view RttMon ciscoRttMonMIB included
88
 
               snmp-server community RTTCommunity view RttMon RW 2
89
 
 
90
 
       The above configuration grants SNMP read-write only to
91
 
       10.37.3.5 (the smokeping host) and only to the ciscoRttMon
92
 
       MIB tree. The probe does not need access to SNMP variables
93
 
       outside the RttMon tree.
94
 
 
95
 
BBUUGGSS
96
 
       The probe establishes unnecessary connections, i.e. more
97
 
       than configured in the "pings" variable, because the
98
 
       RTTMon MIB only allows to set a total time for all connec-
99
 
       tions in one measurement run (one "life"). Currently the
100
 
       probe sets the life duration to "pings"*2+3 seconds (2
101
 
       secs is the timeout value hardcoded into this probe).
102
 
 
103
 
SSEEEE AALLSSOO
104
 
       http://people.ee.ethz.ch/~oetiker/webtools/smokeping/
105
 
       http://www.switch.ch/misc/leinen/snmp/perl/
106
 
 
107
 
       The best source for background info on SAA is Cisco's doc-
108
 
       umentation on http://www.cisco.com and the CISCO-RTTMON-
109
 
       MIB documentation, which is available at:
110
 
       ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my
111
 
 
112
 
AAUUTTHHOORR
113
 
       Joerg.Kummer at Roche.com
114
 
 
115
 
 
116
 
 
117
 
1.35pre1                    2005-0p1r-o0b4es::CiscoRTTMonTcpConnect(3)