home *** CD-ROM | disk | FTP | other *** search
/ Unix System Administration Handbook 1997 October / usah_oct97.iso / rfc / 2000s / rfc2012.txt < prev    next >
Text File  |  1996-12-02  |  17KB  |  564 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                              K. McCloghrie, Editor
  8. Request for Comments: 2012                                 Cisco Systems
  9. Updates: 1213                                              November 1996
  10. Category: Standards Track
  11.  
  12.  
  13.                    SNMPv2 Management Information Base
  14.            for the Transmission Control Protocol using SMIv2
  15.  
  16. Status of this Memo
  17.  
  18.    This document specifies an Internet standards track protocol for the
  19.    Internet community, and requests discussion and suggestions for
  20.    improvements.  Please refer to the current edition of the "Internet
  21.    Official Protocol Standards" (STD 1) for the standardization state
  22.    and status of this protocol.  Distribution of this memo is unlimited.
  23.  
  24. IESG Note:
  25.  
  26.    The IP, UDP, and TCP MIB modules currently support only IPv4.  These
  27.    three modules use the IpAddress type defined as an OCTET STRING of
  28.    length 4 to represent the IPv4 32-bit internet addresses.  (See RFC
  29.    1902, SMI for SNMPv2.)  They do not support the new 128-bit IPv6
  30.    internet addresses.
  31.  
  32. Table of Contents
  33.  
  34.    1. Introduction ................................................    1
  35.    2. Definitions .................................................    2
  36.    2.1 The TCP Group ..............................................    3
  37.    2.2 Conformance Information ....................................    8
  38.    2.2.1 Compliance Statements ....................................    8
  39.    2.2.2 Units of Conformance .....................................    9
  40.    3. Acknowledgements ............................................   10
  41.    4. References ..................................................   10
  42.    5. Security Considerations .....................................   10
  43.    6. Editor's Address ............................................   10
  44.  
  45. 1.  Introduction
  46.  
  47.    A management system contains: several (potentially many) nodes, each
  48.    with a processing entity, termed an agent, which has access to
  49.    management instrumentation; at least one management station; and, a
  50.    management protocol, used to convey management information between
  51.    the agents and management stations.  Operations of the protocol are
  52.    carried out under an administrative framework which defines
  53.    authentication, authorization, access control, and privacy policies.
  54.  
  55.  
  56.  
  57.  
  58. McCloghrie                  Standards Track                     [Page 1]
  59.  
  60. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  61.  
  62.  
  63.    Management stations execute management applications which monitor and
  64.    control managed elements.  Managed elements are devices such as
  65.    hosts, routers, terminal servers, etc., which are monitored and
  66.    controlled via access to their management information.
  67.  
  68.    Management information is viewed as a collection of managed objects,
  69.    residing in a virtual information store, termed the Management
  70.    Information Base (MIB).  Collections of related objects are defined
  71.    in MIB modules.  These modules are written using a subset of OSI's
  72.    Abstract Syntax Notation One (ASN.1) [1], termed the Structure of
  73.    Management Information (SMI) [2].
  74.  
  75.    This document is the MIB module which defines managed objects for
  76.    managing implementations of the Transmission Control Protocol (TCP)
  77.    [3].
  78.  
  79.    The managed objects in this MIB module were originally defined using
  80.    the SNMPv1 framework as a part of MIB-II [4].  This document defines
  81.    the same objects for TCP using the SNMPv2 framework.
  82.  
  83. 2.  Definitions
  84.  
  85. TCP-MIB DEFINITIONS ::= BEGIN
  86.  
  87. IMPORTS
  88.     MODULE-IDENTITY, OBJECT-TYPE, Integer32, Gauge32,
  89.     Counter32, IpAddress, mib-2        FROM SNMPv2-SMI
  90.     MODULE-COMPLIANCE, OBJECT-GROUP    FROM SNMPv2-CONF;
  91.  
  92. tcpMIB MODULE-IDENTITY
  93.     LAST-UPDATED "9411010000Z"
  94.     ORGANIZATION "IETF SNMPv2 Working Group"
  95.     CONTACT-INFO
  96.             "        Keith McCloghrie
  97.  
  98.              Postal: Cisco Systems, Inc.
  99.                      170 West Tasman Drive
  100.                      San Jose, CA  95134-1706
  101.                      US
  102.  
  103.              Phone:  +1 408 526 5260
  104.              Email:  kzm@cisco.com"
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114. McCloghrie                  Standards Track                     [Page 2]
  115.  
  116. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  117.  
  118.  
  119.     DESCRIPTION
  120.             "The MIB module for managing TCP implementations."
  121.     REVISION      "9103310000Z"
  122.     DESCRIPTION
  123.             "The initial revision of this MIB module was part of MIB-
  124.             II."
  125.     ::= { mib-2 49 }
  126.  
  127. -- the TCP group
  128.  
  129. tcp      OBJECT IDENTIFIER ::= { mib-2 6 }
  130.  
  131. tcpRtoAlgorithm OBJECT-TYPE
  132.     SYNTAX      INTEGER {
  133.                     other(1),    -- none of the following
  134.                     constant(2), -- a constant rto
  135.                     rsre(3),     -- MIL-STD-1778, Appendix B
  136.                     vanj(4)      -- Van Jacobson's algorithm [5]
  137.                 }
  138.     MAX-ACCESS  read-only
  139.     STATUS      current
  140.     DESCRIPTION
  141.             "The algorithm used to determine the timeout value used for
  142.             retransmitting unacknowledged octets."
  143.     ::= { tcp 1 }
  144.  
  145. tcpRtoMin OBJECT-TYPE
  146.     SYNTAX      Integer32
  147.     UNITS       "milliseconds"
  148.     MAX-ACCESS  read-only
  149.     STATUS      current
  150.     DESCRIPTION
  151.             "The minimum value permitted by a TCP implementation for the
  152.             retransmission timeout, measured in milliseconds.  More
  153.             refined semantics for objects of this type depend upon the
  154.             algorithm used to determine the retransmission timeout.  In
  155.             particular, when the timeout algorithm is rsre(3), an object
  156.             of this type has the semantics of the LBOUND quantity
  157.             described in RFC 793."
  158.     ::= { tcp 2 }
  159.  
  160. tcpRtoMax OBJECT-TYPE
  161.     SYNTAX      Integer32
  162.     UNITS       "milliseconds"
  163.     MAX-ACCESS  read-only
  164.     STATUS      current
  165.     DESCRIPTION
  166.             "The maximum value permitted by a TCP implementation for the
  167.  
  168.  
  169.  
  170. McCloghrie                  Standards Track                     [Page 3]
  171.  
  172. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  173.  
  174.  
  175.             retransmission timeout, measured in milliseconds.  More
  176.             refined semantics for objects of this type depend upon the
  177.             algorithm used to determine the retransmission timeout.  In
  178.             particular, when the timeout algorithm is rsre(3), an object
  179.             of this type has the semantics of the UBOUND quantity
  180.             described in RFC 793."
  181.     ::= { tcp 3 }
  182.  
  183. tcpMaxConn OBJECT-TYPE
  184.     SYNTAX      Integer32
  185.     MAX-ACCESS  read-only
  186.     STATUS      current
  187.     DESCRIPTION
  188.             "The limit on the total number of TCP connections the entity
  189.             can support.  In entities where the maximum number of
  190.             connections is dynamic, this object should contain the value
  191.             -1."
  192.     ::= { tcp 4 }
  193.  
  194. tcpActiveOpens OBJECT-TYPE
  195.     SYNTAX      Counter32
  196.     MAX-ACCESS  read-only
  197.     STATUS      current
  198.     DESCRIPTION
  199.             "The number of times TCP connections have made a direct
  200.             transition to the SYN-SENT state from the CLOSED state."
  201.     ::= { tcp 5 }
  202.  
  203. tcpPassiveOpens OBJECT-TYPE
  204.     SYNTAX      Counter32
  205.     MAX-ACCESS  read-only
  206.     STATUS      current
  207.     DESCRIPTION
  208.             "The number of times TCP connections have made a direct
  209.             transition to the SYN-RCVD state from the LISTEN state."
  210.     ::= { tcp 6 }
  211.  
  212. tcpAttemptFails OBJECT-TYPE
  213.     SYNTAX      Counter32
  214.     MAX-ACCESS  read-only
  215.     STATUS      current
  216.     DESCRIPTION
  217.             "The number of times TCP connections have made a direct
  218.             transition to the CLOSED state from either the SYN-SENT
  219.             state or the SYN-RCVD state, plus the number of times TCP
  220.             connections have made a direct transition to the LISTEN
  221.             state from the SYN-RCVD state."
  222.     ::= { tcp 7 }
  223.  
  224.  
  225.  
  226. McCloghrie                  Standards Track                     [Page 4]
  227.  
  228. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  229.  
  230.  
  231. tcpEstabResets OBJECT-TYPE
  232.     SYNTAX      Counter32
  233.     MAX-ACCESS  read-only
  234.     STATUS      current
  235.     DESCRIPTION
  236.             "The number of times TCP connections have made a direct
  237.             transition to the CLOSED state from either the ESTABLISHED
  238.             state or the CLOSE-WAIT state."
  239.     ::= { tcp 8 }
  240.  
  241. tcpCurrEstab OBJECT-TYPE
  242.     SYNTAX      Gauge32
  243.     MAX-ACCESS  read-only
  244.     STATUS      current
  245.     DESCRIPTION
  246.             "The number of TCP connections for which the current state
  247.             is either ESTABLISHED or CLOSE- WAIT."
  248.     ::= { tcp 9 }
  249.  
  250.  
  251. tcpInSegs OBJECT-TYPE
  252.     SYNTAX      Counter32
  253.     MAX-ACCESS  read-only
  254.     STATUS      current
  255.     DESCRIPTION
  256.             "The total number of segments received, including those
  257.             received in error.  This count includes segments received on
  258.             currently established connections."
  259.     ::= { tcp 10 }
  260.  
  261. tcpOutSegs OBJECT-TYPE
  262.     SYNTAX      Counter32
  263.     MAX-ACCESS  read-only
  264.     STATUS      current
  265.     DESCRIPTION
  266.             "The total number of segments sent, including those on
  267.             current connections but excluding those containing only
  268.             retransmitted octets."
  269.     ::= { tcp 11 }
  270.  
  271. tcpRetransSegs OBJECT-TYPE
  272.     SYNTAX      Counter32
  273.     MAX-ACCESS  read-only
  274.     STATUS      current
  275.     DESCRIPTION
  276.             "The total number of segments retransmitted - that is, the
  277.             number of TCP segments transmitted containing one or more
  278.             previously transmitted octets."
  279.  
  280.  
  281.  
  282. McCloghrie                  Standards Track                     [Page 5]
  283.  
  284. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  285.  
  286.  
  287.     ::= { tcp 12 }
  288.  
  289.  
  290. -- the TCP Connection table
  291.  
  292. -- The TCP connection table contains information about this
  293. -- entity's existing TCP connections.
  294.  
  295. tcpConnTable OBJECT-TYPE
  296.     SYNTAX      SEQUENCE OF TcpConnEntry
  297.     MAX-ACCESS  not-accessible
  298.     STATUS      current
  299.     DESCRIPTION
  300.             "A table containing TCP connection-specific information."
  301.     ::= { tcp 13 }
  302.  
  303. tcpConnEntry OBJECT-TYPE
  304.     SYNTAX      TcpConnEntry
  305.     MAX-ACCESS  not-accessible
  306.     STATUS      current
  307.     DESCRIPTION
  308.             "A conceptual row of the tcpConnTable containing information
  309.             about a particular current TCP connection.  Each row of this
  310.             table is transient, in that it ceases to exist when (or soon
  311.             after) the connection makes the transition to the CLOSED
  312.             state."
  313.     INDEX   { tcpConnLocalAddress,
  314.               tcpConnLocalPort,
  315.               tcpConnRemAddress,
  316.               tcpConnRemPort }
  317.     ::= { tcpConnTable 1 }
  318.  
  319. TcpConnEntry ::= SEQUENCE {
  320.         tcpConnState          INTEGER,
  321.         tcpConnLocalAddress   IpAddress,
  322.         tcpConnLocalPort      INTEGER,
  323.         tcpConnRemAddress     IpAddress,
  324.         tcpConnRemPort        INTEGER
  325.     }
  326.  
  327. tcpConnState OBJECT-TYPE
  328.     SYNTAX      INTEGER {
  329.                     closed(1),
  330.                     listen(2),
  331.                     synSent(3),
  332.                     synReceived(4),
  333.                     established(5),
  334.                     finWait1(6),
  335.  
  336.  
  337.  
  338. McCloghrie                  Standards Track                     [Page 6]
  339.  
  340. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  341.  
  342.  
  343.                     finWait2(7),
  344.                     closeWait(8),
  345.                     lastAck(9),
  346.                     closing(10),
  347.                     timeWait(11),
  348.                     deleteTCB(12)
  349.                 }
  350.     MAX-ACCESS  read-write
  351.     STATUS      current
  352.     DESCRIPTION
  353.             "The state of this TCP connection.
  354.  
  355.             The only value which may be set by a management station is
  356.             deleteTCB(12).  Accordingly, it is appropriate for an agent
  357.             to return a `badValue' response if a management station
  358.             attempts to set this object to any other value.
  359.  
  360.             If a management station sets this object to the value
  361.             deleteTCB(12), then this has the effect of deleting the TCB
  362.             (as defined in RFC 793) of the corresponding connection on
  363.             the managed node, resulting in immediate termination of the
  364.             connection.
  365.  
  366.             As an implementation-specific option, a RST segment may be
  367.             sent from the managed node to the other TCP endpoint (note
  368.             however that RST segments are not sent reliably)."
  369.     ::= { tcpConnEntry 1 }
  370.  
  371. tcpConnLocalAddress OBJECT-TYPE
  372.     SYNTAX      IpAddress
  373.     MAX-ACCESS  read-only
  374.     STATUS      current
  375.     DESCRIPTION
  376.             "The local IP address for this TCP connection.  In the case
  377.             of a connection in the listen state which is willing to
  378.             accept connections for any IP interface associated with the
  379.             node, the value 0.0.0.0 is used."
  380.     ::= { tcpConnEntry 2 }
  381.  
  382. tcpConnLocalPort OBJECT-TYPE
  383.     SYNTAX      INTEGER (0..65535)
  384.     MAX-ACCESS  read-only
  385.     STATUS      current
  386.     DESCRIPTION
  387.             "The local port number for this TCP connection."
  388.     ::= { tcpConnEntry 3 }
  389.  
  390. tcpConnRemAddress OBJECT-TYPE
  391.  
  392.  
  393.  
  394. McCloghrie                  Standards Track                     [Page 7]
  395.  
  396. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  397.  
  398.  
  399.     SYNTAX      IpAddress
  400.     MAX-ACCESS  read-only
  401.     STATUS      current
  402.     DESCRIPTION
  403.             "The remote IP address for this TCP connection."
  404.     ::= { tcpConnEntry 4 }
  405.  
  406. tcpConnRemPort OBJECT-TYPE
  407.     SYNTAX      INTEGER (0..65535)
  408.     MAX-ACCESS  read-only
  409.     STATUS      current
  410.     DESCRIPTION
  411.             "The remote port number for this TCP connection."
  412.     ::= { tcpConnEntry 5 }
  413.  
  414. tcpInErrs OBJECT-TYPE
  415.     SYNTAX      Counter32
  416.     MAX-ACCESS  read-only
  417.     STATUS      current
  418.     DESCRIPTION
  419.             "The total number of segments received in error (e.g., bad
  420.             TCP checksums)."
  421.     ::= { tcp 14 }
  422.  
  423. tcpOutRsts OBJECT-TYPE
  424.     SYNTAX      Counter32
  425.     MAX-ACCESS  read-only
  426.     STATUS      current
  427.     DESCRIPTION
  428.             "The number of TCP segments sent containing the RST flag."
  429.     ::= { tcp 15 }
  430.  
  431. -- conformance information
  432.  
  433. tcpMIBConformance OBJECT IDENTIFIER ::= { tcpMIB 2 }
  434.  
  435. tcpMIBCompliances OBJECT IDENTIFIER ::= { tcpMIBConformance 1 }
  436. tcpMIBGroups      OBJECT IDENTIFIER ::= { tcpMIBConformance 2 }
  437.  
  438.  
  439. -- compliance statements
  440.  
  441. tcpMIBCompliance MODULE-COMPLIANCE
  442.     STATUS  current
  443.     DESCRIPTION
  444.             "The compliance statement for SNMPv2 entities which
  445.             implement TCP."
  446.     MODULE  -- this module
  447.  
  448.  
  449.  
  450. McCloghrie                  Standards Track                     [Page 8]
  451.  
  452. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  453.  
  454.  
  455.         MANDATORY-GROUPS { tcpGroup
  456.                            }
  457.     ::= { tcpMIBCompliances 1 }
  458.  
  459. -- units of conformance
  460.  
  461. tcpGroup OBJECT-GROUP
  462.     OBJECTS   { tcpRtoAlgorithm, tcpRtoMin, tcpRtoMax,
  463.                 tcpMaxConn, tcpActiveOpens,
  464.                 tcpPassiveOpens, tcpAttemptFails,
  465.                 tcpEstabResets, tcpCurrEstab, tcpInSegs,
  466.                 tcpOutSegs, tcpRetransSegs, tcpConnState,
  467.                 tcpConnLocalAddress, tcpConnLocalPort,
  468.                 tcpConnRemAddress, tcpConnRemPort,
  469.                 tcpInErrs, tcpOutRsts }
  470.     STATUS    current
  471.     DESCRIPTION
  472.             "The tcp group of objects providing for management of TCP
  473.             entities."
  474.     ::= { tcpMIBGroups 1 }
  475.  
  476. END
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506. McCloghrie                  Standards Track                     [Page 9]
  507.  
  508. RFC 2012                   SNMPv2 MIB for TCP              November 1996
  509.  
  510.  
  511. 3.  Acknowledgements
  512.  
  513.    This document contains a modified subset of RFC 1213.
  514.  
  515. 4.  References
  516.  
  517.    [1]  Information processing systems - Open Systems Interconnection -
  518.         Specification of Abstract Syntax Notation One (ASN.1),
  519.         International Organization for Standardization.  International
  520.         Standard 8824, (December, 1987).
  521.  
  522.    [2]  McCloghrie, K., Editor, "Structure of Management Information
  523.         for version 2 of the Simple Network Management Protocol
  524.         (SNMPv2)", RFC 1902, Cisco Systems, January 1996.
  525.  
  526.    [3]  Postel, J., "Transmission Control Protocol - DARPA Internet
  527.         Program Protocol Specification", STD 7, RFC 793, DARPA,
  528.         September 1981.
  529.  
  530.    [4]  McCloghrie, K., and M. Rose, "Management Information Base for
  531.         Network Management of TCP/IP-based internets: MIB-II", STD 17,
  532.         RFC 1213, March 1991.
  533.  
  534.    [5]  Jacobson, V., "Congestion Avoidance and Control", SIGCOMM 1988,
  535.         Stanford, California.
  536.  
  537. 5.  Security Considerations
  538.  
  539.    Security issues are not discussed in this memo.
  540.  
  541. 6.  Editor's Address
  542.  
  543.    Keith McCloghrie
  544.    Cisco Systems, Inc.
  545.    170 West Tasman Drive
  546.    San Jose, CA  95134-1706
  547.    US
  548.  
  549.    Phone: +1 408 526 5260
  550.    EMail: kzm@cisco.com
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562. McCloghrie                  Standards Track                    [Page 10]
  563.  
  564.