userapps/opensource/net-snmp/mibs/TCP-MIB.txt

   1 TCP-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4     MODULE-IDENTITY, OBJECT-TYPE, Integer32, Gauge32,
   5     Counter32, IpAddress, mib-2        FROM SNMPv2-SMI
   6     MODULE-COMPLIANCE, OBJECT-GROUP    FROM SNMPv2-CONF;
   7
   8 tcpMIB MODULE-IDENTITY
   9     LAST-UPDATED "9411010000Z"
  10     ORGANIZATION "IETF SNMPv2 Working Group"
  11     CONTACT-INFO
  12             "        Keith McCloghrie
  13
  14              Postal: Cisco Systems, Inc.
  15                      170 West Tasman Drive
  16                      San Jose, CA  95134-1706
  17                      US
  18
  19              Phone:  +1 408 526 5260
  20              Email:  kzm@cisco.com"
  21     DESCRIPTION
  22             "The MIB module for managing TCP implementations."
  23     REVISION      "9103310000Z"
  24     DESCRIPTION
  25             "The initial revision of this MIB module was part of MIB-
  26             II."
  27     ::= { mib-2 49 }
  28
  29 -- the TCP group
  30
  31 tcp      OBJECT IDENTIFIER ::= { mib-2 6 }
  32
  33 tcpRtoAlgorithm OBJECT-TYPE
  34     SYNTAX      INTEGER {
  35                     other(1),    -- none of the following
  36                     constant(2), -- a constant rto
  37                     rsre(3),     -- MIL-STD-1778, Appendix B
  38                     vanj(4)      -- Van Jacobson's algorithm [5]
  39                 }
  40     MAX-ACCESS  read-only
  41     STATUS      current
  42     DESCRIPTION
  43             "The algorithm used to determine the timeout value used for
  44             retransmitting unacknowledged octets."
  45     ::= { tcp 1 }
  46
  47 tcpRtoMin OBJECT-TYPE
  48     SYNTAX      Integer32
  49     UNITS       "milliseconds"
  50     MAX-ACCESS  read-only
  51     STATUS      current
  52     DESCRIPTION
  53             "The minimum value permitted by a TCP implementation for the
  54             retransmission timeout, measured in milliseconds.  More
  55             refined semantics for objects of this type depend upon the
  56             algorithm used to determine the retransmission timeout.  In
  57             particular, when the timeout algorithm is rsre(3), an object
  58             of this type has the semantics of the LBOUND quantity
  59             described in RFC 793."
  60     ::= { tcp 2 }
  61
  62 tcpRtoMax OBJECT-TYPE
  63     SYNTAX      Integer32
  64     UNITS       "milliseconds"
  65     MAX-ACCESS  read-only
  66     STATUS      current
  67     DESCRIPTION
  68             "The maximum value permitted by a TCP implementation for the
  69
  70             retransmission timeout, measured in milliseconds.  More
  71             refined semantics for objects of this type depend upon the
  72             algorithm used to determine the retransmission timeout.  In
  73             particular, when the timeout algorithm is rsre(3), an object
  74             of this type has the semantics of the UBOUND quantity
  75             described in RFC 793."
  76     ::= { tcp 3 }
  77
  78 tcpMaxConn OBJECT-TYPE
  79     SYNTAX      Integer32
  80     MAX-ACCESS  read-only
  81     STATUS      current
  82     DESCRIPTION
  83             "The limit on the total number of TCP connections the entity
  84             can support.  In entities where the maximum number of
  85             connections is dynamic, this object should contain the value
  86             -1."
  87     ::= { tcp 4 }
  88
  89 tcpActiveOpens OBJECT-TYPE
  90     SYNTAX      Counter32
  91     MAX-ACCESS  read-only
  92     STATUS      current
  93     DESCRIPTION
  94             "The number of times TCP connections have made a direct
  95             transition to the SYN-SENT state from the CLOSED state."
  96     ::= { tcp 5 }
  97
  98 tcpPassiveOpens OBJECT-TYPE
  99     SYNTAX      Counter32
 100     MAX-ACCESS  read-only
 101     STATUS      current
 102     DESCRIPTION
 103             "The number of times TCP connections have made a direct
 104             transition to the SYN-RCVD state from the LISTEN state."
 105     ::= { tcp 6 }
 106
 107 tcpAttemptFails OBJECT-TYPE
 108     SYNTAX      Counter32
 109     MAX-ACCESS  read-only
 110     STATUS      current
 111     DESCRIPTION
 112             "The number of times TCP connections have made a direct
 113             transition to the CLOSED state from either the SYN-SENT
 114             state or the SYN-RCVD state, plus the number of times TCP
 115             connections have made a direct transition to the LISTEN
 116             state from the SYN-RCVD state."
 117     ::= { tcp 7 }
 118
 119 tcpEstabResets OBJECT-TYPE
 120     SYNTAX      Counter32
 121     MAX-ACCESS  read-only
 122     STATUS      current
 123     DESCRIPTION
 124             "The number of times TCP connections have made a direct
 125             transition to the CLOSED state from either the ESTABLISHED
 126             state or the CLOSE-WAIT state."
 127     ::= { tcp 8 }
 128
 129 tcpCurrEstab OBJECT-TYPE
 130     SYNTAX      Gauge32
 131     MAX-ACCESS  read-only
 132     STATUS      current
 133     DESCRIPTION
 134             "The number of TCP connections for which the current state
 135             is either ESTABLISHED or CLOSE- WAIT."
 136     ::= { tcp 9 }
 137
 138 tcpInSegs OBJECT-TYPE
 139     SYNTAX      Counter32
 140     MAX-ACCESS  read-only
 141     STATUS      current
 142     DESCRIPTION
 143             "The total number of segments received, including those
 144             received in error.  This count includes segments received on
 145             currently established connections."
 146     ::= { tcp 10 }
 147
 148 tcpOutSegs OBJECT-TYPE
 149     SYNTAX      Counter32
 150     MAX-ACCESS  read-only
 151     STATUS      current
 152     DESCRIPTION
 153             "The total number of segments sent, including those on
 154             current connections but excluding those containing only
 155             retransmitted octets."
 156     ::= { tcp 11 }
 157
 158 tcpRetransSegs OBJECT-TYPE
 159     SYNTAX      Counter32
 160     MAX-ACCESS  read-only
 161     STATUS      current
 162     DESCRIPTION
 163             "The total number of segments retransmitted - that is, the
 164             number of TCP segments transmitted containing one or more
 165             previously transmitted octets."
 166     ::= { tcp 12 }
 167
 168 -- the TCP Connection table
 169
 170 -- The TCP connection table contains information about this
 171 -- entity's existing TCP connections.
 172
 173 tcpConnTable OBJECT-TYPE
 174     SYNTAX      SEQUENCE OF TcpConnEntry
 175     MAX-ACCESS  not-accessible
 176     STATUS      current
 177     DESCRIPTION
 178             "A table containing TCP connection-specific information."
 179     ::= { tcp 13 }
 180
 181 tcpConnEntry OBJECT-TYPE
 182     SYNTAX      TcpConnEntry
 183     MAX-ACCESS  not-accessible
 184     STATUS      current
 185     DESCRIPTION
 186             "A conceptual row of the tcpConnTable containing information
 187             about a particular current TCP connection.  Each row of this
 188             table is transient, in that it ceases to exist when (or soon
 189             after) the connection makes the transition to the CLOSED
 190             state."
 191     INDEX   { tcpConnLocalAddress,
 192               tcpConnLocalPort,
 193               tcpConnRemAddress,
 194               tcpConnRemPort }
 195     ::= { tcpConnTable 1 }
 196
 197 TcpConnEntry ::= SEQUENCE {
 198         tcpConnState          INTEGER,
 199         tcpConnLocalAddress   IpAddress,
 200         tcpConnLocalPort      INTEGER,
 201         tcpConnRemAddress     IpAddress,
 202         tcpConnRemPort        INTEGER
 203     }
 204
 205 tcpConnState OBJECT-TYPE
 206     SYNTAX      INTEGER {
 207                     closed(1),
 208                     listen(2),
 209                     synSent(3),
 210                     synReceived(4),
 211                     established(5),
 212                     finWait1(6),
 213                     finWait2(7),
 214                     closeWait(8),
 215                     lastAck(9),
 216                     closing(10),
 217                     timeWait(11),
 218                     deleteTCB(12)
 219                 }
 220     MAX-ACCESS  read-write
 221     STATUS      current
 222     DESCRIPTION
 223             "The state of this TCP connection.
 224
 225             The only value which may be set by a management station is
 226             deleteTCB(12).  Accordingly, it is appropriate for an agent
 227             to return a `badValue' response if a management station
 228             attempts to set this object to any other value.
 229
 230             If a management station sets this object to the value
 231             deleteTCB(12), then this has the effect of deleting the TCB
 232             (as defined in RFC 793) of the corresponding connection on
 233             the managed node, resulting in immediate termination of the
 234             connection.
 235
 236             As an implementation-specific option, a RST segment may be
 237             sent from the managed node to the other TCP endpoint (note
 238             however that RST segments are not sent reliably)."
 239     ::= { tcpConnEntry 1 }
 240
 241 tcpConnLocalAddress OBJECT-TYPE
 242     SYNTAX      IpAddress
 243     MAX-ACCESS  read-only
 244     STATUS      current
 245     DESCRIPTION
 246             "The local IP address for this TCP connection.  In the case
 247             of a connection in the listen state which is willing to
 248             accept connections for any IP interface associated with the
 249             node, the value 0.0.0.0 is used."
 250     ::= { tcpConnEntry 2 }
 251
 252 tcpConnLocalPort OBJECT-TYPE
 253     SYNTAX      INTEGER (0..65535)
 254     MAX-ACCESS  read-only
 255     STATUS      current
 256     DESCRIPTION
 257             "The local port number for this TCP connection."
 258     ::= { tcpConnEntry 3 }
 259
 260 tcpConnRemAddress OBJECT-TYPE
 261     SYNTAX      IpAddress
 262     MAX-ACCESS  read-only
 263     STATUS      current
 264     DESCRIPTION
 265             "The remote IP address for this TCP connection."
 266     ::= { tcpConnEntry 4 }
 267
 268 tcpConnRemPort OBJECT-TYPE
 269     SYNTAX      INTEGER (0..65535)
 270     MAX-ACCESS  read-only
 271     STATUS      current
 272     DESCRIPTION
 273             "The remote port number for this TCP connection."
 274     ::= { tcpConnEntry 5 }
 275
 276 tcpInErrs OBJECT-TYPE
 277     SYNTAX      Counter32
 278     MAX-ACCESS  read-only
 279     STATUS      current
 280     DESCRIPTION
 281             "The total number of segments received in error (e.g., bad
 282             TCP checksums)."
 283     ::= { tcp 14 }
 284
 285 tcpOutRsts OBJECT-TYPE
 286     SYNTAX      Counter32
 287     MAX-ACCESS  read-only
 288     STATUS      current
 289     DESCRIPTION
 290             "The number of TCP segments sent containing the RST flag."
 291     ::= { tcp 15 }
 292
 293 -- conformance information
 294
 295 tcpMIBConformance OBJECT IDENTIFIER ::= { tcpMIB 2 }
 296
 297 tcpMIBCompliances OBJECT IDENTIFIER ::= { tcpMIBConformance 1 }
 298 tcpMIBGroups      OBJECT IDENTIFIER ::= { tcpMIBConformance 2 }
 299
 300 -- compliance statements
 301
 302 tcpMIBCompliance MODULE-COMPLIANCE
 303     STATUS  current
 304     DESCRIPTION
 305             "The compliance statement for SNMPv2 entities which
 306             implement TCP."
 307     MODULE  -- this module
 308
 309         MANDATORY-GROUPS { tcpGroup
 310                            }
 311     ::= { tcpMIBCompliances 1 }
 312
 313 -- units of conformance
 314
 315 tcpGroup OBJECT-GROUP
 316     OBJECTS   { tcpRtoAlgorithm, tcpRtoMin, tcpRtoMax,
 317                 tcpMaxConn, tcpActiveOpens,
 318                 tcpPassiveOpens, tcpAttemptFails,
 319                 tcpEstabResets, tcpCurrEstab, tcpInSegs,
 320                 tcpOutSegs, tcpRetransSegs, tcpConnState,
 321                 tcpConnLocalAddress, tcpConnLocalPort,
 322                 tcpConnRemAddress, tcpConnRemPort,
 323                 tcpInErrs, tcpOutRsts }
 324     STATUS    current
 325     DESCRIPTION
 326             "The tcp group of objects providing for management of TCP
 327             entities."
 328     ::= { tcpMIBGroups 1 }
 329
 330 END