home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1997 December / Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso / drafts / draft_ietf_i / draft-ietf-ifmib-mib-06.txt < prev    next >
Text File  |  1997-10-30  |  145KB  |  4,601 lines

  1.  
  2.  
  3. Draft                  Interfaces Group MIB           October 1997
  4.  
  5.  
  6.  
  7.                      The Interfaces Group MIB
  8.  
  9.                          19 October 1997
  10.  
  11.  
  12.                    draft-ietf-ifmib-mib-06.txt
  13.  
  14.  
  15.                          Keith McCloghrie
  16.                           Cisco Systems
  17.                           kzm@cisco.com
  18.  
  19.                        Frank J. Kastenholz
  20.                            FTP Software
  21.                           kasten@ftp.com
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                        Status of this Memo
  28.  
  29. This document is an Internet-Draft.  Internet-Drafts are working
  30. documents of the Internet Engineering Task Force (IETF), its
  31. areas, and its working groups.  Note that other groups may also
  32. distribute working documents as Internet-Drafts.
  33.  
  34. Internet-Drafts are draft documents valid for a maximum of six
  35. months and may be updated, replaced, or obsoleted by other
  36. documents at any time.  It is inappropriate to use Internet-
  37. Drafts as reference material or to cite them other than as ``work
  38. in progress.''
  39.  
  40. To learn the current status of any Internet-Draft, please check
  41. the ``1id-abstracts.txt'' listing contained in the Internet-
  42. Drafts Shadow Directories on ds.internic.net (US East Coast),
  43. nic.nordu.net (Europe), ftp.isi.edu (US West Coast), or
  44. munnari.oz.au (Pacific Rim).
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56. Expires April 1998                                        [Page 1]
  57.  
  58.  
  59.  
  60.  
  61.  
  62. Draft                  Interfaces Group MIB           October 1997
  63.  
  64.  
  65. 1.  Introduction
  66.  
  67. This memo defines a portion of the Management Information Base
  68. (MIB) for use with network management protocols in the Internet
  69. community.  In particular, it describes managed objects used for
  70. managing Network Interfaces.
  71.  
  72. This memo discusses the 'interfaces' group of MIB-II, especially
  73. the experience gained from the definition of numerous media-
  74. specific MIB modules for use in conjunction with the 'interfaces'
  75. group for managing various sub-layers beneath the internetwork-
  76. layer.  It specifies clarifications to, and extensions of, the
  77. architectural issues within the previous model used for the
  78. 'interfaces' group.
  79.  
  80. This memo also includes a MIB module.  As well as including new
  81. MIB definitions to support the architectural extensions, this MIB
  82. module also re-specifies the 'interfaces' group of MIB-II in a
  83. manner that is both compliant to the SNMPv2 SMI and semantically-
  84. identical to the existing SNMPv1-based definitions.
  85.  
  86. The key words "MUST" and "MUST NOT" in this document are to be
  87. interpreted as described in RFC 2119 [10].
  88.  
  89.  
  90. 1.1.  Change Log
  91.  
  92. This section tracks changes made to the revisions of the Internet
  93. Drafts of this document.  It will be *deleted* when the document
  94. is published as an RFC.
  95.  
  96. 19 October 1997
  97.  
  98. The following changes were made for the version of the document
  99. dated 19 October 1997. These changes were made at the request of
  100. the Area Director.
  101.  
  102. (1)  Added statement in Introduction that "MUST" and "MUST NOT"
  103.      are used as defined in RFC 2119.
  104.  
  105. (2)  Added Security Considerations section.
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115. Expires April 1998                                        [Page 2]
  116.  
  117.  
  118.  
  119.  
  120.  
  121. Draft                  Interfaces Group MIB           October 1997
  122.  
  123.  
  124. 26 November 1996
  125.  
  126. The following changes were made for the version of the document
  127. dated 26 November 1996. These changes were made based on Working
  128. Group email discussions following the Montreal IETF meeting.
  129.  
  130. (1)  Added additional clarifying text for when assigning an
  131.      ifIndex value is appropriate.
  132.  
  133. (2)  Added lowerLayerDown state for ifOperStatus.
  134.  
  135. (3)  Added ifCounterDiscontinuityTime.
  136.  
  137. (4)  Updated the description clause of each counter object covered
  138.      by ifCounterDiscontinuityTime (as required by RFC 1902,
  139.      section 7.1.6).
  140.  
  141. (5)  Added text on rate-limiting linkUp/linkDown text.
  142.  
  143. (6)  Minor editorial changes.
  144.  
  145. 22 February 1996
  146.  
  147. The following changes were made for the version of the document
  148. dated 19 February 1996. These changes were made based on Working
  149. Group email discussions.
  150.  
  151. (1)  Added InterfaceIndexOrZero textual convention.
  152.  
  153. (2)  Added notPresent state for ifOperStatus.
  154.  
  155. 11 February 1996
  156.  
  157. The following changes were made for the version of the document
  158. dated 11 February 1996. These changes were made based on comments
  159. received via email.
  160.  
  161. (1)  Clarified value of ifOperStatus in linkUp and linkDown traps.
  162.  
  163. (2)  Included ifIndex in the ifGeneralInformationGroup object
  164.      group.
  165.  
  166. (3)  Supplemented the explanatory text for ifName.
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174. Expires April 1998                                        [Page 3]
  175.  
  176.  
  177.  
  178.  
  179.  
  180. Draft                  Interfaces Group MIB           October 1997
  181.  
  182.  
  183. 28 January 1996
  184.  
  185. The following changes were made for the version of the document
  186. dated 28 January 1996. These changes were made based on the output
  187. of the working group's meeting at the Dallas IETF meeting.
  188.  
  189. (1)  Changed ifStackLastChange to be a scalar object.
  190.  
  191. (2)  Updated the definition of ifAlias.
  192.  
  193. (3)  Added text contrasting the use of ifDescr, ifName and
  194.      ifAlias.
  195.  
  196. (4)  Added section on the creation/deletion of interfaces.
  197.  
  198. (5)  Added section on how an interface's ifOperStatus depends on
  199.      the states of the interfaces below it in the interface stack.
  200.  
  201. (6)  Added clarification that a defective interface which
  202.      periodically tests itself does not transition to the
  203.      ifOperStatus=testing state while that testing is in progress.
  204.  
  205. 26 November 1995
  206.  
  207. The following changes were made for the version of the document
  208. dated 26 November 1995. These changes were made based on the
  209. output of the working group's meeting at the Stockholm IETF
  210. meeting.
  211.  
  212. (1)  Added the ifAlias, ifStackLastChange and ifTableLastChange
  213.      objects.
  214.  
  215. (2)  Defined new group definitions to contain the new objects, and
  216.      defined a new conformance definition.  Deprecated the old
  217.      group and conformance definitions.
  218.  
  219. (3)  Corrected the MAX-ACCESS clause values for
  220.      ifRcvAddressAddress, ifRcvAddressStatus and ifStackStatus.
  221.  
  222. (4)  Deprecated the ifTestTable and ifTestGroup.
  223.  
  224. (5)  Removed (to be defined elsewhere) the IANAifType-MIB MIB
  225.      Module.
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233. Expires April 1998                                        [Page 4]
  234.  
  235.  
  236.  
  237.  
  238.  
  239. Draft                  Interfaces Group MIB           October 1997
  240.  
  241.  
  242. (6)  Re-arranged and combined the previous sections 3.1 and 3.2.
  243.  
  244. (7)  Minor editorial changes.
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292. Expires April 1998                                        [Page 5]
  293.  
  294.  
  295.  
  296.  
  297.  
  298. Draft                  Interfaces Group MIB           October 1997
  299.  
  300.  
  301. 2.  The SNMP Network Management Framework
  302.  
  303. The SNMP Network Management Framework presently consists of three
  304. major components.  They are:
  305.  
  306. o    RFC 1902 which defines the SMI, the mechanisms used for
  307.      describing and naming objects for the purpose of management.
  308.  
  309. o    RFC 1213 defines MIB-II, the core set of managed objects for
  310.      the Internet suite of protocols.
  311.  
  312. o    RFC 1157 and RFC 1905 which define two versions of the
  313.      protocol used for network access to managed objects.
  314.  
  315. The Framework permits new objects to be defined for the purpose of
  316. experimentation and evaluation.
  317.  
  318.  
  319. 2.1.  Object Definitions
  320.  
  321. Managed objects are accessed via a virtual information store,
  322. termed the Management Information Base or MIB.  Objects in the MIB
  323. are defined using the subset of Abstract Syntax Notation One
  324. (ASN.1) defined in the SMI.  In particular, each object object
  325. type is named by an OBJECT IDENTIFIER, an administratively
  326. assigned name.  The object type together with an object instance
  327. serves to uniquely identify a specific instantiation of the
  328. object.  For human convenience, we often use a textual string,
  329. termed the descriptor, to refer to the object type.
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351. Expires April 1998                                        [Page 6]
  352.  
  353.  
  354.  
  355.  
  356.  
  357. Draft                  Interfaces Group MIB           October 1997
  358.  
  359.  
  360. 3.  Experience with the Interfaces Group
  361.  
  362. One of the strengths of internetwork-layer protocols such as IP
  363. [6] is that they are designed to run over any network interface.
  364. In achieving this, IP considers any and all protocols it runs over
  365. as a single "network interface" layer.  A similar view is taken by
  366. other internetwork-layer protocols.  This concept is represented
  367. in MIB-II by the 'interfaces' group which defines a generic set of
  368. managed objects such that any network interface can be managed in
  369. an interface-independent manner through these managed objects.
  370. The 'interfaces' group provides the means for additional managed
  371. objects specific to particular types of network interface (e.g., a
  372. specific medium such as Ethernet) to be defined as extensions to
  373. the 'interfaces' group for media-specific management.  Since the
  374. standardization of MIB-II, many such media-specific MIB modules
  375. have been defined.
  376.  
  377. Experience in defining these media-specific MIB modules has shown
  378. that the model defined by MIB-II is too simplistic and/or static
  379. for some types of media-specific management.  As a result, some of
  380. these media-specific MIB modules assume an evolution or loosening
  381. of the model.  This memo documents and standardizes that evolution
  382. of the model and fills in the gaps caused by that evolution.  This
  383. memo also incorporates the interfaces group extensions documented
  384. in RFC 1229 [7].
  385.  
  386. 3.1.  Clarifications/Revisions
  387.  
  388. There are several areas for which experience has indicated that
  389. clarification, revision, or extension of the model would be
  390. helpful.  The following sections discuss the changes in the
  391. interfaces group adopted by this memo in each of these areas.
  392.  
  393. In some sections, one or more paragraphs contain discussion of
  394. rejected alternatives to the model adopted in this memo.  Readers
  395. not familiar with the MIB-II model and not interested in the
  396. rationale behind the new model may want to skip these paragraphs.
  397.  
  398. 3.1.1.  Interface Sub-Layers
  399.  
  400. Experience in defining media-specific management information has
  401. shown the need to distinguish between the multiple sub-layers
  402. beneath the internetwork-layer.  In addition, there is a need to
  403. manage these sub-layers in devices (e.g., MAC-layer bridges) which
  404. are unaware of which, if any, internetwork protocols run over
  405.  
  406.  
  407.  
  408.  
  409.  
  410. Expires April 1998                                        [Page 7]
  411.  
  412.  
  413.  
  414.  
  415.  
  416. Draft                  Interfaces Group MIB           October 1997
  417.  
  418.  
  419. these sub-layers.  As such, a model of having a single conceptual
  420. row in the interfaces table (MIB-II's ifTable) represent a whole
  421. interface underneath the internetwork-layer, and having a single
  422. associated media-specific MIB module (referenced via the ifType
  423. object) is too simplistic.  A further problem arises with the
  424. value of the ifType object which has enumerated values for each
  425. type of interface.
  426.  
  427. Consider, for example, an interface with PPP running over an HDLC
  428. link which uses a RS232-like connector.  Each of these sub-layers
  429. has its own media-specific MIB module.  If all of this is
  430. represented by a single conceptual row in the ifTable, then an
  431. enumerated value for ifType is needed for that specific
  432. combination which maps to the specific combination of media-
  433. specific MIBs.  Furthermore, such a model still lacks a method to
  434. describe the relationship of all the sub-layers of the MIB stack.
  435.  
  436. An associated problem is that of upward and downward multiplexing
  437. of the sub-layers.  An example of upward multiplexing is MLP
  438. (Multi-Link-Procedure) which provides load-sharing over several
  439. serial lines by appearing as a single point-to-point link to the
  440. sub-layer(s) above.  An example of downward multiplexing would be
  441. several instances of PPP, each framed within a separate X.25
  442. virtual circuit, all of which run over one fractional T1 channel,
  443. concurrently with other uses of the T1 link.  The MIB structure
  444. must allow these sorts of relationships to be described.
  445.  
  446. Several solutions for representing multiple sub-layers were
  447. rejected.  One was to retain the concept of one conceptual row for
  448. all the sub-layers of an interface and have each media-specific
  449. MIB module identify its "superior" and "subordinate" sub-layers
  450. through OBJECT IDENTIFIER "pointers".  This scheme would have
  451. several drawbacks: the superior/subordinate pointers would be
  452. contained in the media-specific MIB modules; thus, a manager could
  453. not learn the structure of an interface without inspecting
  454. multiple pointers in different MIB modules; this would be overly
  455. complex and only possible if the manager had knowledge of all the
  456. relevant media-specific MIB modules; MIB modules would all need to
  457. be retrofitted with these new "pointers"; this scheme would not
  458. adequately address the problem of upward and downward
  459. multiplexing; and finally, enumerated values of ifType would be
  460. needed for each combination of sub-layers.  Another rejected
  461. solution also retained the concept of one conceptual row for all
  462. the sub-layers of an interface but had a new separate MIB table to
  463. identify the "superior" and "subordinate" sub-layers and to
  464.  
  465.  
  466.  
  467.  
  468.  
  469. Expires April 1998                                        [Page 8]
  470.  
  471.  
  472.  
  473.  
  474.  
  475. Draft                  Interfaces Group MIB           October 1997
  476.  
  477.  
  478. contain OBJECT IDENTIFIER "pointers" to the media-specific MIB
  479. module for each sub-layer.  Effectively, one conceptual row in the
  480. ifTable would represent each combination of sub-layers between the
  481. internetwork-layer and the wire.  While this scheme has fewer
  482. drawbacks, it still would not support downward multiplexing, such
  483. as PPP over MLP: observe that MLP makes two (or more) serial
  484. lines appear to the layers above as a single physical interface,
  485. and thus PPP over MLP should appear to the internetwork-layer as a
  486. single interface; in contrast, this scheme would result in two (or
  487. more) conceptual rows in the ifTable, both of which the
  488. internetwork-layer would run over.  This scheme would also require
  489. enumerated values of ifType for each combination of sub-layers.
  490.  
  491. The solution adopted by this memo is to have an individual
  492. conceptual row in the ifTable to represent each sub-layer, and
  493. have a new separate MIB table (the ifStackTable, see section 6
  494. below) to identify the "superior" and "subordinate" sub-layers
  495. through INTEGER "pointers" to the appropriate conceptual rows in
  496. the ifTable.  This solution supports both upward and downward
  497. multiplexing, allows the IANAifType to Media-Specific MIB mapping
  498. to identify the media-specific MIB module for that sub-layer, such
  499. that the new table need only be referenced to obtain information
  500. about layering, and it only requires enumerated values of ifType
  501. for each sub-layer, not for combinations of them.  However, it
  502. does require that the descriptions of some objects in the ifTable
  503. (specifically, ifType, ifPhysAddress, ifInUcastPkts, and
  504. ifOutUcastPkts) be generalized so as to apply to any sub-layer
  505. (rather than only to a sub-layer immediately beneath the network
  506. layer as previously), plus some (specifically, ifSpeed) which need
  507. to have appropriate values identified for use when a generalized
  508. definition does not apply to a particular sub-layer.
  509.  
  510. In addition, this adopted solution makes no requirement that a
  511. device, in which a sub-layer is instrumented by a conceptual row
  512. of the ifTable, be aware of whether an internetwork protocol runs
  513. on top of (i.e., at some layer above) that sub-layer.  In fact,
  514. the counters of packets received on an interface are defined as
  515. counting the number "delivered to a higher-layer protocol".  This
  516. meaning of "higher-layer" includes:
  517.  
  518. (1)  Delivery to a forwarding module which accepts
  519.      packets/frames/octets and forwards them on at the same
  520.      protocol layer.  For example, for the purposes of this
  521.      definition, the forwarding module of a MAC-layer bridge is
  522.      considered as a "higher-layer" to the MAC-layer of each port
  523.  
  524.  
  525.  
  526.  
  527.  
  528. Expires April 1998                                        [Page 9]
  529.  
  530.  
  531.  
  532.  
  533.  
  534. Draft                  Interfaces Group MIB           October 1997
  535.  
  536.  
  537.      on the bridge.
  538.  
  539. (2)  Delivery to a higher sub-layer within a interface stack.  For
  540.      example, for the purposes of this definition, if a PPP module
  541.      operated directly over a serial interface, the PPP module
  542.      would be considered the higher sub-layer to the serial
  543.      interface.
  544.  
  545. (3)  Delivery to a higher protocol layer which does not do packet
  546.      forwarding for sub-layers that are "at the top of" the
  547.      interface stack.  For example, for the purposes of this
  548.      definition, the local IP module would be considered the
  549.      higher layer to a SLIP serial interface.
  550.  
  551. Similarly, for output, the counters of packets transmitted out an
  552. interface are defined as counting the number "that higher-level
  553. protocols requested to be transmitted".  This meaning of "higher-
  554. layer" includes:
  555.  
  556. (1)  A forwarding module, at the same protocol layer, which
  557.      transmits packets/frames/octets that were received on an
  558.      different interface.  For example, for the purposes of this
  559.      definition, the forwarding module of a MAC-layer bridge is
  560.      considered as a "higher-layer" to the MAC-layer of each port
  561.      on the bridge.
  562.  
  563. (2)  The next higher sub-layer within an interface stack.  For
  564.      example, for the purposes of this definition, if a PPP module
  565.      operated directly over a serial interface, the PPP module
  566.      would be a "higher layer" to the serial interface.
  567.  
  568. (3)  For sub-layers that are "at the top of" the interface stack,
  569.      a higher element in the network protocol stack.  For example,
  570.      for the purposes of this definition, the local IP module
  571.      would be considered the higher layer to an Ethernet
  572.      interface.
  573.  
  574. 3.1.2.  Guidance on Defining Sub-layers
  575.  
  576. The designer of a media-specific MIB must decide whether to divide
  577. the interface into sub-layers or not, and if so, how to make the
  578. divisions.  The following guidance is offered to assist the
  579. media-specific MIB designer in these decisions.
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587. Expires April 1998                                        [Page 10]
  588.  
  589.  
  590.  
  591.  
  592.  
  593. Draft                  Interfaces Group MIB           October 1997
  594.  
  595.  
  596. In general, the number of entries in the ifTable should be kept to
  597. the minimum required for network management.  In particular, a
  598. group of related interfaces should be treated as a single
  599. interface with one entry in the ifTable providing that:
  600.  
  601. (1)  None of the group of interfaces performs multiplexing for any
  602.      other interface in the agent,
  603.  
  604. (2)  There is a meaningful and useful way for all of the ifTable's
  605.      information (e.g., the counters, and the status variables),
  606.      and all of the ifTable's capabilities (e.g., write access to
  607.      ifAdminStatus), to apply to the group of interfaces as a
  608.      whole.
  609.  
  610. Under these circumstances, there should be one entry in the
  611. ifTable for such a group of interfaces, and any internal structure
  612. which needs to be represented to network management should be
  613. captured in a MIB module specific to the particular type of
  614. interface.
  615.  
  616. Note that application of bullet 2 above to the ifTable's ifType
  617. object requires that there is a meaningful media-specific MIB and
  618. a meaningful ifType value which apply to the group of interfaces
  619. as a whole.  For example, it is not appropriate to treat an HDLC
  620. sub-layer and an RS-232 sub-layer as a single ifTable entry when
  621. the media-specific MIBs and the ifType values for HDLC and RS-232
  622. are separate (rather than combined).
  623.  
  624. Subject to the above, it is appropriate to assign an ifIndex value
  625. to any interface that can occur in an interface stack (in the
  626. ifStackTable) where the bottom of the stack is a physical
  627. interface (ifConnectorPresent has the value 'true') and there is a
  628. layer-3 or other application that "points down" to the top of this
  629. stack.  An example of an application that points down to the top
  630. of the stack is the Character MIB [9].
  631.  
  632. Note that the sub-layers of an interface on one device will
  633. sometimes be different from the sub-layers of the interconnected
  634. interface of another device; for example, for a frame-relay DTE
  635. interface connected a frameRelayService interface, the inter-
  636. connected DTE and DCE interfaces have different ifType values and
  637. media-specific MIBs.
  638.  
  639. These guidelines are just that, guidelines.  The designer of a
  640. media-specific MIB is free to lay out the MIB in whatever SMI
  641.  
  642.  
  643.  
  644.  
  645.  
  646. Expires April 1998                                        [Page 11]
  647.  
  648.  
  649.  
  650.  
  651.  
  652. Draft                  Interfaces Group MIB           October 1997
  653.  
  654.  
  655. conformant manner is desired.  However, in doing so, the media-
  656. specific MIB MUST completely specify the sub-layering model used
  657. for the MIB, and provide the assumptions, reasoning, and rationale
  658. used to develop that model.
  659.  
  660. 3.1.3.  Virtual Circuits
  661.  
  662. Several of the sub-layers for which media-specific MIB modules
  663. have been defined are connection oriented (e.g., Frame Relay,
  664. X.25).  Experience has shown that each effort to define such a MIB
  665. module revisits the question of whether separate conceptual rows
  666. in the ifTable are needed for each virtual circuit.  Most, if not
  667. all, of these efforts to date have decided to have all virtual
  668. circuits reference a single conceptual row in the ifTable.
  669.  
  670. This memo strongly recommends that connection-oriented sub-layers
  671. do not have a conceptual row in the ifTable for each virtual
  672. circuit.  This avoids the proliferation of conceptual rows,
  673. especially those which have considerable redundant information.
  674. (Note, as a comparison, that connection-less sub-layers do not
  675. have conceptual rows for each remote address.)  There may,
  676. however, be circumstances under which it is appropriate for a
  677. virtual circuit of a connection-oriented sub-layer to have its own
  678. conceptual row in the ifTable; an example of this might be PPP
  679. over an X.25 virtual circuit.  The MIB in section 6 of this memo
  680. supports such circumstances.
  681.  
  682. If a media-specific MIB wishes to assign an entry in the ifTable
  683. to each virtual circuit, the MIB designer must present the
  684. rationale for this decision in the media-specific MIB's
  685. specification.
  686.  
  687. 3.1.4.  Bit, Character, and Fixed-Length Interfaces
  688.  
  689. RS-232 is an example of a character-oriented sub-layer over which
  690. (e.g., through use of PPP) IP datagrams can be sent.  Due to the
  691. packet-based nature of many of the objects in the ifTable,
  692. experience has shown that it is not appropriate to have a
  693. character-oriented sub-layer represented by a whole conceptual row
  694. in the ifTable.
  695.  
  696. Experience has also shown that it is sometimes desirable to have
  697. some management information for bit-oriented interfaces, which are
  698. similarly difficult to represent by a whole conceptual row in the
  699. ifTable.  For example, to manage the channels of a DS1 circuit,
  700.  
  701.  
  702.  
  703.  
  704.  
  705. Expires April 1998                                        [Page 12]
  706.  
  707.  
  708.  
  709.  
  710.  
  711. Draft                  Interfaces Group MIB           October 1997
  712.  
  713.  
  714. where only some of the channels are carrying packet-based data.
  715.  
  716. A further complication is that some subnetwork technologies
  717. transmit data in fixed length transmission units.  One example of
  718. such a technology is cell relay, and in particular Asynchronous
  719. Transfer Mode (ATM), which transmits data in fixed-length cells.
  720. Representing such a interface as a packet-based interface produces
  721. redundant objects if the relationship between the number of
  722. packets and the number of octets in either direction is fixed by
  723. the size of the transmission unit (e.g., the size of a cell).
  724.  
  725. About half the objects in the ifTable are applicable to every type
  726. of interface: packet-oriented, character-oriented, and bit-
  727. oriented.  Of the other half, two are applicable to both
  728. character-oriented and packet-oriented interfaces, and the rest
  729. are applicable only to packet-oriented interfaces.  Thus, while it
  730. is desirable for consistency to be able to represent any/all types
  731. of interfaces in the ifTable, it is not possible to implement the
  732. full ifTable for bit- and character-oriented sub-layers.
  733.  
  734. A rejected solution to this problem would be to split the ifTable
  735. into two (or more) new MIB tables, one of which would contain
  736. objects that are relevant only to packet-oriented interfaces
  737. (e.g., PPP), and another that may be used by all interfaces.  This
  738. is highly undesirable since it would require changes in every
  739. agent implementing the ifTable (i.e., just about every existing
  740. SNMP agent).
  741.  
  742. The solution adopted in this memo builds upon the fact that
  743. compliance statements in SNMPv2 (in contrast to SNMPv1) refer to
  744. object groups, where object groups are explicitly defined by
  745. listing the objects they contain.  Thus, in SNMPv2, multiple
  746. compliance statements can be specified, one for all interfaces and
  747. additional ones for specific types of interfaces.  The separate
  748. compliance statements can be based on separate object groups,
  749. where the object group for all interfaces can contain only those
  750. objects from the ifTable which are appropriate for every type of
  751. interfaces.  Using this solution, every sub-layer can have its own
  752. conceptual row in the ifTable.
  753.  
  754. Thus, section 6 of this memo contains definitions of the objects
  755. of the existing 'interfaces' group of MIB-II, in a manner which is
  756. both SNMPv2-compliant and semantically-equivalent to the existing
  757. MIB-II definitions.  With equivalent semantics, and with the BER
  758. ("on the wire") encodings unchanged, these definitions retain the
  759.  
  760.  
  761.  
  762.  
  763.  
  764. Expires April 1998                                        [Page 13]
  765.  
  766.  
  767.  
  768.  
  769.  
  770. Draft                  Interfaces Group MIB           October 1997
  771.  
  772.  
  773. same OBJECT IDENTIFIER values as assigned by MIB-II.  Thus, in
  774. general, no rewrite of existing agents which conform to MIB-II and
  775. the ifExtensions MIB is required.
  776.  
  777. In addition, this memo defines several object groups for the
  778. purposes of defining which objects apply to which types of
  779. interface:
  780.  
  781. (1)  the ifGeneralInformationGroup.  This group contains those
  782.      objects applicable to all types of network interfaces,
  783.      including bit-oriented interfaces.
  784.  
  785. (2)  the ifPacketGroup.  This group contains those objects
  786.      applicable to packet-oriented network interfaces.
  787.  
  788. (3)  the ifFixedLengthGroup.  This group contains the objects
  789.      applicable not only to character-oriented interfaces, such as
  790.      RS-232, but also to those subnetwork technologies, such as
  791.      cell-relay/ATM, which transmit data in fixed length
  792.      transmission units.  As well as the octet counters, there are
  793.      also a few other counters (e.g., the error counters) which
  794.      are useful for this type of interface, but are currently
  795.      defined as being packet-oriented.  To accommodate this, the
  796.      definitions of these counters are generalized to apply to
  797.      character-oriented interfaces and fixed-length-transmission
  798.      interfaces.
  799.  
  800. It should be noted that the octet counters in the ifTable
  801. aggregate octet counts for unicast and non-unicast packets into a
  802. single octet counter per direction (received/transmitted).  Thus,
  803. with the above definition of fixed-length-transmission interfaces,
  804. where such interfaces which support non-unicast packets, separate
  805. counts of unicast and multicast/broadcast transmissions can only
  806. be maintained in a media-specific MIB module.
  807.  
  808. 3.1.5.  Interface Numbering
  809.  
  810. MIB-II defines an object, ifNumber, whose value represents:
  811.  
  812.      "The number of network interfaces (regardless of their
  813.      current state) present on this system."
  814.  
  815. Each interface is identified by a unique value of the ifIndex
  816. object, and the description of ifIndex constrains its value as
  817. follows:
  818.  
  819.  
  820.  
  821.  
  822.  
  823. Expires April 1998                                        [Page 14]
  824.  
  825.  
  826.  
  827.  
  828.  
  829. Draft                  Interfaces Group MIB           October 1997
  830.  
  831.  
  832.      "Its value ranges between 1 and the value of ifNumber.  The
  833.      value for each interface must remain constant at least from
  834.      one re-initialization of the entity's network management
  835.      system to the next re-initialization."
  836.  
  837. This constancy requirement on the value of ifIndex for a
  838. particular interface is vital for efficient management.  However,
  839. an increasing number of devices allow for the dynamic
  840. addition/removal of network interfaces.  One example of this is a
  841. dynamic ability to configure the use of SLIP/PPP over a
  842. character-oriented port.  For such dynamic additions/removals, the
  843. combination of the constancy requirement and the restriction that
  844. the value of ifIndex is less than ifNumber is problematic.
  845.  
  846. Redefining ifNumber to be the largest value of ifIndex was
  847. rejected since it would not help.  Such a re-definition would
  848. require ifNumber to be deprecated and the utility of the redefined
  849. object would be questionable.  Alternatively, ifNumber could be
  850. deprecated and not replaced.  However, the deprecation of ifNumber
  851. would require a change to that portion of ifIndex's definition
  852. which refers to ifNumber.  So, since the definition of ifIndex
  853. must be changed anyway in order to solve the problem, changes to
  854. ifNumber do not benefit the solution.
  855.  
  856. The solution adopted in this memo is just to delete the
  857. requirement that the value of ifIndex must be less than the value
  858. of ifNumber, and to retain ifNumber with its current definition.
  859. This is a minor change in the semantics of ifIndex; however, all
  860. existing agent implementations conform to this new definition, and
  861. in the interests of not requiring changes to existing agent
  862. implementations and to the many existing media-specific MIBs, this
  863. memo assumes that this change does not require ifIndex to be
  864. deprecated.  Experience indicates that this assumption does
  865. "break" a few management applications, but this is considered
  866. preferable to breaking all agent implementations.
  867.  
  868. This solution also results in the possibility of "holes" in the
  869. ifTable, i.e., the ifIndex values of conceptual rows in the
  870. ifTable are not necessarily contiguous, but SNMP's GetNext (and
  871. SNMPv2's GetBulk) operation easily deals with such holes.  The
  872. value of ifNumber still represents the number of conceptual rows,
  873. which increases/decreases as new interfaces are dynamically
  874. added/removed.
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882. Expires April 1998                                        [Page 15]
  883.  
  884.  
  885.  
  886.  
  887.  
  888. Draft                  Interfaces Group MIB           October 1997
  889.  
  890.  
  891. The requirement for constancy (between re-initializations) of an
  892. interface's ifIndex value is met by requiring that after an
  893. interface is dynamically removed, its ifIndex value is not re-used
  894. by a *different* dynamically added interface until after the
  895. following re-initialization of the network management system.
  896. This avoids the need for assignment (in advance) of ifIndex values
  897. for all possible interfaces that might be added dynamically.  The
  898. exact meaning of a "different" interface is hard to define, and
  899. there will be gray areas.  Any firm definition in this document
  900. would likely to turn out to be inadequate.  Instead, implementors
  901. must choose what it means in their particular situation, subject
  902. to the following rules:
  903.  
  904. (1)  a previously-unused value of ifIndex must be assigned to a
  905.      dynamically added interface if an agent has no knowledge of
  906.      whether the interface is the "same" or "different" to a
  907.      previously incarnated interface.
  908.  
  909. (2)  a management station, not noticing that an interface has gone
  910.      away and another has come into existence, must not be
  911.      confused when calculating the difference between the counter
  912.      values retrieved on successive polls for a particular ifIndex
  913.      value.
  914.  
  915. When the new interface is the same as an old interface, but a
  916. discontinuity in the value of the interface's counters cannot be
  917. avoided, the ifTable has (until now) required that a new ifIndex
  918. value be assigned to the returning interface.  That is, either all
  919. counter values have had to be retained during the absence of an
  920. interface in order to use the same ifIndex value on that
  921. interface's return, or else a new ifIndex value has had to be
  922. assigned to the returning interface.  Both alternatives have
  923. proved to be burdensome to some implementations:
  924.  
  925. (1)  maintaining the counter values may not be possible (e.g., if
  926.      they are maintained on removable hardware),
  927.  
  928. (2)  using a new ifIndex value presents extra work for management
  929.      applications.  While the potential need for such extra work
  930.      is unavoidable on agent re-initializations, it is desirable
  931.      to avoid it between re-initializations.
  932.  
  933. To address this, a new object, ifCounterDiscontinuityTime, has
  934. been defined to record the time of the last discontinuity in an
  935. interface's counters.  By monitoring the value of this new object,
  936.  
  937.  
  938.  
  939.  
  940.  
  941. Expires April 1998                                        [Page 16]
  942.  
  943.  
  944.  
  945.  
  946.  
  947. Draft                  Interfaces Group MIB           October 1997
  948.  
  949.  
  950. a management application can now detect counter discontinuities
  951. without the ifIndex value of the interface being changed.  Thus,
  952. an agent which implements this new object should, when a new
  953. interface is the same as an old interface, retain that interface's
  954. ifIndex value and update if necessary the interface's value of
  955. ifCounterDiscontinuityTime.  With this new object, a management
  956. application must, when calculating differences between counter
  957. values retrieved on successive polls, discard any calculated
  958. difference for which the value of ifCounterDiscontinuityTime is
  959. different for the two polls.  (Note that this test must be
  960. performed in addition to the normal checking of sysUpTime to
  961. detect an agent re-initialization.)  Since such discards are a
  962. waste of network management processing and bandwidth, an agent
  963. should not update the value of ifCounterDiscontinuityTime unless
  964. absolutely necessary.
  965.  
  966. While defining this new object is a change in the semantics of the
  967. ifTable counter objects, it is impractical to deprecate and
  968. redefine all these counters because of their wide deployment and
  969. importance.  Also, a survey of implementations indicates that many
  970. agents and management applications do not correctly implement this
  971. aspect of the current semantics (because of the burdensome issues
  972. mentioned above), such that the practical implications of such a
  973. change is small.  Thus, this breach of the SMI's rules is
  974. considered to be acceptable.
  975.  
  976. Note, however, that the addition of ifCounterDiscontinuityTime
  977. does not change the fact that:
  978.  
  979.          it is necessary at certain times for the
  980.          assignment of ifIndex values to change on a re-
  981.          initialization of the agent (such as a reboot).
  982.  
  983. The possibility of ifIndex value re-assignment must be
  984. accommodated by a management application whenever the value of
  985. sysUpTime is reset to zero.
  986.  
  987. Note also that some agents support multiple "naming scopes", e.g.,
  988. for an SNMPv1 agent, multiple values of the SNMPv1 community
  989. string.  For such an agent (e.g., a CNM agent which supports a
  990. different subset of interfaces for different customers), there is
  991. no required relationship between the ifIndex values which identify
  992. interfaces in one naming scope and those which identify interfaces
  993. in another naming scope.  It is the agent's choice as to whether
  994. the same or different ifIndex values identify the same or
  995.  
  996.  
  997.  
  998.  
  999.  
  1000. Expires April 1998                                        [Page 17]
  1001.  
  1002.  
  1003.  
  1004.  
  1005.  
  1006. Draft                  Interfaces Group MIB           October 1997
  1007.  
  1008.  
  1009. different interfaces in different naming scopes.
  1010.  
  1011. Because of the restriction of the value of ifIndex to be less than
  1012. ifNumber, interfaces have been numbered with small integer values.
  1013. This has led to the ability by humans to use the ifIndex values as
  1014. (somewhat) user-friendly names for network interfaces (e.g.,
  1015. "interface number 3").  With the relaxation of the restriction on
  1016. the value of ifIndex, there is now the possibility that ifIndex
  1017. values could be assigned as very large numbers (e.g., memory
  1018. addresses).  Such numbers would be much less user-friendly.
  1019. Therefore, this memo recommends that ifIndex values still be
  1020. assigned as (relatively) small integer values starting at 1, even
  1021. though the values in use at any one time are not necessarily
  1022. contiguous.  (Note that this makes remembering which values have
  1023. been assigned easy for agents which dynamically add new
  1024. interfaces)
  1025.  
  1026. A new problem is introduced by representing each sub-layer as an
  1027. ifTable entry.  Previously, there usually was a simple, direct,
  1028. mapping of interfaces to the physical ports on systems.  This
  1029. mapping would be based on the ifIndex value.  However, by having
  1030. an ifTable entry for each interface sub-layer, mapping from
  1031. interfaces to physical ports becomes increasingly problematic.
  1032.  
  1033. To address this issue, a new object, ifName, is added to the MIB.
  1034. This object contains the device's local name (e.g., the name used
  1035. at the device's local console) for the interface of which the
  1036. relevant entry in the ifTable is a component.  For example,
  1037. consider a router having an interface composed of PPP running over
  1038. an RS-232 port.  If the router uses the name "wan1" for the
  1039. (combined) interface, then the ifName objects for the
  1040. corresponding PPP and RS-232 entries in the ifTable would both
  1041. have the value "wan1".  On the other hand, if the router uses the
  1042. name "wan1.1" for the PPP interface and "wan1.2" for the RS-232
  1043. port, then the ifName objects for the corresponding PPP and RS-232
  1044. entries in the ifTable would have the values "wan1.1" and
  1045. "wan1.2", respectively.  As an another example, consider an agent
  1046. which responds to SNMP queries concerning an interface on some
  1047. other (proxied) device: if such a proxied device associates a
  1048. particular identifier with an interface, then it is appropriate to
  1049. use this identifier as the value of the interface's ifName, since
  1050. the local console in this case is that of the proxied device.
  1051.  
  1052. In contrast, the existing ifDescr object is intended to contain a
  1053. description of an interface, whereas another new object, ifAlias,
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059. Expires April 1998                                        [Page 18]
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065. Draft                  Interfaces Group MIB           October 1997
  1066.  
  1067.  
  1068. provides a location in which a network management application can
  1069. store a non-volatile interface-naming value of its own choice.
  1070. The ifAlias object allows a network manager to give one or more
  1071. interfaces their own unique names, irrespective of any interface-
  1072. stack relationship.  Further, the ifAlias name is non-volatile,
  1073. and thus an interface must retain its assigned ifAlias value
  1074. across reboots, even if an agent chooses a new ifIndex value for
  1075. the interface.
  1076.  
  1077. 3.1.6.  Counter Size
  1078.  
  1079. As the speed of network media increase, the minimum time in which
  1080. a 32 bit counter will wrap decreases.  For example, a 10Mbs stream
  1081. of back-to-back, full-size packets causes ifInOctets to wrap in
  1082. just over 57 minutes; at 100Mbs, the minimum wrap time is 5.7
  1083. minutes, and at 1Gbs, the minimum is 34 seconds.  Requiring that
  1084. interfaces be polled frequently enough not to miss a counter wrap
  1085. is increasingly problematic.
  1086.  
  1087. A rejected solution to this problem was to scale the counters; for
  1088. example, ifInOctets could be changed to count received octets in,
  1089. say, 1024 byte blocks.  While it would provide acceptable
  1090. functionality at high rates of the counted-events, at low rates it
  1091. suffers.  If there is little traffic on an interface, there might
  1092. be a significant interval before enough of the counted-events
  1093. occur to cause the scaled counter to be incremented.  Traffic
  1094. would then appear to be very bursty, leading to incorrect
  1095. conclusions of the network's performance.
  1096.  
  1097. Instead, this memo adopts expanded, 64 bit, counters.  These
  1098. counters are provided in new "high capacity" groups.  The old,
  1099. 32-bit, counters have not been deprecated.  The 64-bit counters
  1100. are to be used only when the 32-bit counters do not provide enough
  1101. capacity; that is, when the 32 bit counters could wrap too fast.
  1102.  
  1103. For interfaces that operate at 20,000,000 (20 million) bits per
  1104. second or less, 32-bit byte and packet counters MUST be used.  For
  1105. interfaces that operate faster than 20,000,000 bits/second, and
  1106. slower than 650,000,000 bits/second, 32-bit packet counters MUST
  1107. be used and 64-bit octet counters MUST be used.  For interfaces
  1108. that operate at 650,000,000 bits/second or faster, 64-bit packet
  1109. counters AND 64-bit octet counters MUST be used.
  1110.  
  1111. These speed thresholds were chosen as reasonable compromises based
  1112. on the following:
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118. Expires April 1998                                        [Page 19]
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124. Draft                  Interfaces Group MIB           October 1997
  1125.  
  1126.  
  1127. (1)  The cost of maintaining 64-bit counters is relatively high,
  1128.      so minimizing the number of agents which must support them is
  1129.      desirable.  Common interfaces (such as 10Mbs Ethernet) should
  1130.      not require them.
  1131.  
  1132. (2)  64-bit counters are a new feature, introduced in SNMPv2.  It
  1133.      is reasonable to expect that support for them will be spotty
  1134.      for the immediate future.  Thus, we wish to limit them to as
  1135.      few systems as possible.  This, in effect, means that 64-bit
  1136.      counters should be limited to higher speed interfaces.
  1137.      Ethernet (10,000,000 bps) and Token Ring (16,000,000 bps) are
  1138.      fairly wide-spread so it seems reasonable to not require 64-
  1139.      bit counters for these interfaces.
  1140.  
  1141. (3)  The 32-bit octet counters will wrap in the following times,
  1142.      for the following interfaces (when transmitting maximum-sized
  1143.      packets back-to-back):
  1144.  
  1145.      -   10Mbs Ethernet: 57 minutes,
  1146.  
  1147.      -   16Mbs Token Ring: 36 minutes,
  1148.  
  1149.      -   a US T3 line (45 megabits): 12 minutes,
  1150.  
  1151.      -   FDDI: 5.7 minutes
  1152.  
  1153. (4)  The 32-bit packet counters wrap in about 57 minutes when 64-
  1154.      byte packets are transmitted back-to-back on a 650,000,000
  1155.      bit/second link.
  1156.  
  1157. As an aside, a 1-terabit/second (1,000 Gbs) link will cause a 64
  1158. bit octet counter to wrap in just under 5 years.  Conversely, an
  1159. 81,000,000 terabit/second link is required to cause a 64-bit
  1160. counter to wrap in 30 minutes.  We believe that, while technology
  1161. rapidly marches forward, this link speed will not be achieved for
  1162. at least several years, leaving sufficient time to evaluate the
  1163. introduction of 96 bit counters.
  1164.  
  1165. When 64-bit counters are in use, the 32-bit counters MUST still be
  1166. available.  They will report the low 32-bits of the associated
  1167. 64-bit count (e.g., ifInOctets will report the least significant
  1168. 32 bits of ifHCInOctets).  This enhances inter-operability with
  1169. existing implementations at a very minimal cost to agents.
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177. Expires April 1998                                        [Page 20]
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183. Draft                  Interfaces Group MIB           October 1997
  1184.  
  1185.  
  1186. The new "high capacity" groups are:
  1187.  
  1188. (1)  the ifHCFixedLengthGroup for character-oriented/fixed-length
  1189.      interfaces, and the ifHCPacketGroup for packet-based
  1190.      interfaces; both of these groups include 64 bit counters for
  1191.      octets, and
  1192.  
  1193. (2)  the ifVHCPacketGroup for packet-based interfaces; this group
  1194.      includes 64 bit counters for octets and packets.
  1195.  
  1196. 3.1.7.  Interface Speed
  1197.  
  1198. Network speeds are increasing.  The range of ifSpeed is limited to
  1199. reporting a maximum speed of (2**31)-1 bits/second, or
  1200. approximately 2.2Gbs.  SONET defines an OC-48 interface, which is
  1201. defined at operating at 48 times 51 Mbs, which is a speed in
  1202. excess of 2.4Gbs.  Thus, ifSpeed is insufficient for the future,
  1203. and this memo defines an additional object: ifHighSpeed.
  1204.  
  1205. The ifHighSpeed object reports the speed of the interface in
  1206. 1,000,000 (1 million) bits/second units.  Thus, the true speed of
  1207. the interface will be the value reported by this object, plus or
  1208. minus 500,000 bits/second.
  1209.  
  1210. Other alternatives considered (but rejected) were:
  1211.  
  1212. (1)  Making the interface speed a 64-bit gauge.  This was rejected
  1213.      since the current SMI does not allow such a syntax.
  1214.  
  1215.      Furthermore, even if 64-bit gauges were available, their use
  1216.      would require additional complexity in agents due to an
  1217.      increased requirement for 64-bit operations.
  1218.  
  1219. (2)  We also considered making "high-32 bit" and "low-32-bit"
  1220.      objects which, when combined, would be a 64-bit value.  This
  1221.      simply seemed overly complex for what we are trying to do.
  1222.  
  1223.      Furthermore, a full 64-bits of precision does not seem
  1224.      necessary.  The value of ifHighSpeed will be the only report
  1225.      of interface speed for interfaces that are faster than
  1226.      4,294,967,295 bits per second.  At this speed, the
  1227.      granularity of ifHighSpeed will be 1,000,000 bits per second,
  1228.      thus the error will be 1/4294, or about 0.02%.  This seems
  1229.      reasonable.
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236. Expires April 1998                                        [Page 21]
  1237.  
  1238.  
  1239.  
  1240.  
  1241.  
  1242. Draft                  Interfaces Group MIB           October 1997
  1243.  
  1244.  
  1245. (3)  Adding a "scale" object, which would define the units which
  1246.      ifSpeed's value is.
  1247.  
  1248.      This would require two additional objects; one for the
  1249.      scaling object, and one to replace the current ifSpeed.  This
  1250.      later object is required since the semantics of ifSpeed would
  1251.      be significantly altered, and manager stations which do not
  1252.      understand the new semantics would be confused.
  1253.  
  1254. 3.1.8.  Multicast/Broadcast Counters
  1255.  
  1256. In MIB-II, the ifTable counters for multicast and broadcast
  1257. packets are combined as counters of non-unicast packets.  In
  1258. contrast, the ifExtensions MIB [7] defined one set of counters for
  1259. multicast, and a separate set for broadcast packets.  With the
  1260. separate counters, the original combined counters become
  1261. redundant.  To avoid this redundancy, the non-unicast counters are
  1262. deprecated.
  1263.  
  1264. For the output broadcast and multicast counters defined in RFC
  1265. 1229, their definitions varied slightly from the packet counters
  1266. in the ifTable, in that they did not count errors/discarded
  1267. packets.  Thus, this memo defines new objects with better aligned
  1268. definitions.  Counters with 64 bits of range are also needed, as
  1269. explained above.
  1270.  
  1271. 3.1.9.  Trap Enable
  1272.  
  1273. In the multi-layer interface model, each sub-layer for which there
  1274. is an entry in the ifTable can generate linkUp/Down Traps.  Since
  1275. interface state changes would tend to propagate through the
  1276. interface (from top to bottom, or bottom to top), it is likely
  1277. that several traps would be generated for each linkUp/Down
  1278. occurrence.
  1279.  
  1280. It is desirable to provide a mechanism for manager stations to
  1281. control the generation of these traps.  To this end, the
  1282. ifLinkUpDownTrapEnable object has been added.  This object allows
  1283. managers to limit generation of traps to just the sub-layers of
  1284. interest.
  1285.  
  1286. The default setting should limit the number of traps generated to
  1287. one per interface per linkUp/Down event.  Furthermore, it seems
  1288. that the state changes of most interest to network managers occur
  1289. at the lowest level of an interface stack.  Therefore we specify
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295. Expires April 1998                                        [Page 22]
  1296.  
  1297.  
  1298.  
  1299.  
  1300.  
  1301. Draft                  Interfaces Group MIB           October 1997
  1302.  
  1303.  
  1304. that by default, only the lowest sub-layer of the interface
  1305. generate traps.
  1306.  
  1307. 3.1.10.  Addition of New ifType values
  1308.  
  1309. Over time, there is the need to add new ifType enumerated values
  1310. for new interface types.  If the syntax of ifType were defined in
  1311. the MIB in section 6, then a new version of this MIB would have to
  1312. be re-issued in order to define new values.  In the past, re-
  1313. issuing of a MIB has occurred only after several years.
  1314.  
  1315. Therefore, the syntax of ifType is changed to be a textual
  1316. convention, such that the enumerated integer values are now
  1317. defined in the textual convention, IANAifType, defined in a
  1318. different document.  This allows additional values to be
  1319. documented without having to re-issue a new version of this
  1320. document.  The Internet Assigned Number Authority (IANA) is
  1321. responsible for the assignment of all Internet numbers, including
  1322. various SNMP-related numbers, and specifically, new ifType values.
  1323.  
  1324. 3.1.11.  InterfaceIndex Textual Convention
  1325.  
  1326. A new textual convention, InterfaceIndex, has been defined.  This
  1327. textual convention "contains" all of the semantics of the ifIndex
  1328. object.  This allows other mib modules to easily import the
  1329. semantics of ifIndex.
  1330.  
  1331.  
  1332. 3.1.12.  New states for IfOperStatus
  1333.  
  1334. Three new states have been added to ifOperStatus: 'dormant',
  1335. 'notPresent', and 'lowerLayerDown'.
  1336.  
  1337. The dormant state indicates that the relevant interface is not
  1338. actually in a condition to pass packets (i.e., it is not 'up') but
  1339. is in a "pending" state, waiting for some external event.  For
  1340. "on-demand" interfaces, this new state identifies the situation
  1341. where the interface is waiting for events to place it in the up
  1342. state.  Examples of such events might be:
  1343.  
  1344. (1)  having packets to transmit before establishing a connection
  1345.      to a remote system;
  1346.  
  1347. (2)  having a remote system establish a connection to the
  1348.      interface (e.g. dialing up to a slip-server).
  1349.  
  1350.  
  1351.  
  1352.  
  1353.  
  1354. Expires April 1998                                        [Page 23]
  1355.  
  1356.  
  1357.  
  1358.  
  1359.  
  1360. Draft                  Interfaces Group MIB           October 1997
  1361.  
  1362.  
  1363. The notPresent state is a refinement on the down state which
  1364. indicates that the relevant interface is down specifically because
  1365. some component (typically, a hardware component) is not present in
  1366. the managed system.  Examples of use of the notPresent state are:
  1367.  
  1368. (1)  to allow an interface's conceptual row including its counter
  1369.      values to be retained across a "hot swap" of a card/module,
  1370.      and/or
  1371.  
  1372. (2)  to allow an interface's conceptual row to be created, and
  1373.      thereby enable interfaces to be pre-configured prior to
  1374.      installation of the hardware needed to make the interface
  1375.      operational.
  1376.  
  1377. Agents are not required to support interfaces in the notPresent
  1378. state.  However, from a conceptual viewpoint, when a row in the
  1379. ifTable is created, it first enters the notPresent state and then
  1380. subsequently transitions into the down state; similarly, when a
  1381. row in the ifTable is deleted, it first enters the notPresent
  1382. state and then subsequently the object instances are deleted.  For
  1383. an agent with no support for notPresent, both of these transitions
  1384. (from the notPresent state to the down state, and from the
  1385. notPresent state to the instances being removed) are immediate,
  1386. i.e., the transition does not last long enough to be recorded by
  1387. ifOperStatus.  Even for those agents which do support interfaces
  1388. in the notPresent state, the length of time and conditions under
  1389. which an interface stays in the notPresent state is
  1390. implementation-specific.
  1391.  
  1392. The lowerLayerDown state is also a refinement on the down state.
  1393. This new state indicates that this interface runs "on top of" one
  1394. or more other interfaces (see ifStackTable) and that this
  1395. interface is down specifically because one or more of these
  1396. lower-layer interfaces are down.
  1397.  
  1398. 3.1.13.  IfAdminStatus and IfOperStatus
  1399.  
  1400. The down state of ifOperStatus now has two meanings, depending on
  1401. the value of ifAdminStatus.
  1402.  
  1403. (1)  if ifAdminStatus is not down and ifOperStatus is down then a
  1404.      fault condition is presumed to exist on the interface.
  1405.  
  1406. (2)  if ifAdminStatus is down, then ifOperStatus will normally
  1407.      also be down (or notPresent) i.e., there is not (necessarily)
  1408.  
  1409.  
  1410.  
  1411.  
  1412.  
  1413. Expires April 1998                                        [Page 24]
  1414.  
  1415.  
  1416.  
  1417.  
  1418.  
  1419. Draft                  Interfaces Group MIB           October 1997
  1420.  
  1421.  
  1422.      a fault condition on the interface.
  1423.  
  1424. Note that when ifAdminStatus transitions to down, ifOperStatus
  1425. will normally also transition to down.  In this situation, it is
  1426. possible that ifOperStatus's transition will not occur
  1427. immediately, but rather after a small time lag to complete certain
  1428. operations before going "down"; for example, it might need to
  1429. finish transmitting a packet.  If a manager station finds that
  1430. ifAdminStatus is down and ifOperStatus is not down for a
  1431. particular interface, the manager station should wait a short
  1432. while and check again.  If the condition still exists, only then
  1433. should it raise an error indication.  Naturally, it should also
  1434. ensure that ifLastChange has not changed during this interval.
  1435.  
  1436. Whenever an interface table entry is created (usually as a result
  1437. of system initialization), the relevant instance of ifAdminStatus
  1438. is set to down, and presumably ifOperStatus will be down or
  1439. notPresent.
  1440.  
  1441. An interface may be enabled in two ways: either as a result of
  1442. explicit management action (e.g. setting ifAdminStatus to up) or
  1443. as a result of the managed system's initialization process.  When
  1444. ifAdminStatus changes to the up state, the related ifOperStatus
  1445. should do one of the following:
  1446.  
  1447. (1)  Change to the up state if and only if the interface is able
  1448.      to send and receive packets.
  1449.  
  1450. (2)  Change to the lowerLayerDown state if and only if the
  1451.      interface is prevented from entering the up state because of
  1452.      the state of one or more of the interfaces beneath it in the
  1453.      interface stack.
  1454.  
  1455. (3)  Change to the dormant state if and only if the interface is
  1456.      found to be operable, but the interface is waiting for other,
  1457.      external, events to occur before it can transmit or receive
  1458.      packets.  Presumably when the expected events occur, the
  1459.      interface will then change to the up state.
  1460.  
  1461. (4)  Remain in the down state if an error or other fault condition
  1462.      is detected on the interface.
  1463.  
  1464. (5)  Change to the unknown state if, for some reason, the state of
  1465.      the interface can not be ascertained.
  1466.  
  1467.  
  1468.  
  1469.  
  1470.  
  1471.  
  1472. Expires April 1998                                        [Page 25]
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478. Draft                  Interfaces Group MIB           October 1997
  1479.  
  1480.  
  1481. (6)  Change to the testing state if some test(s) must be performed
  1482.      on the interface. Presumably after completion of the test,
  1483.      the interface's state will change to up, dormant, or down, as
  1484.      appropriate.
  1485.  
  1486. (7)  Remain in the notPresent state if interface components are
  1487.      missing.
  1488.  
  1489. 3.1.14.  IfOperStatus in an Interface Stack
  1490.  
  1491. When an interface is a part of an interface-stack, but is not the
  1492. lowest interface in the stack, then:
  1493.  
  1494. (1)  ifOperStatus has the value 'up' if it is able to pass packets
  1495.      due to one or more interfaces below it in the stack being
  1496.      'up', irrespective of whether other interfaces below it are
  1497.      'down', 'dormant', 'notPresent', 'lowerLayerDown', 'unknown'
  1498.      or 'testing'.
  1499.  
  1500. (2)  ifOperStatus may have the value 'up' or 'dormant' if one or
  1501.      more interfaces below it in the stack are 'dormant', and all
  1502.      others below it are either 'down', 'dormant', 'notPresent',
  1503.      'lowerLayerDown', 'unknown' or 'testing'.
  1504.  
  1505. (3)  ifOperStatus has the value 'lowerLayerDown' while all
  1506.      interfaces below it in the stack are either 'down',
  1507.      'notPresent', 'lowerLayerDown', or 'testing'.
  1508.  
  1509. 3.1.15.  Traps
  1510.  
  1511. The exact definition of when linkUp and linkDown traps are
  1512. generated has been changed to reflect the changes to ifAdminStatus
  1513. and ifOperStatus.
  1514.  
  1515. Operational experience indicates that management stations are most
  1516. concerned with an interface being in the down state and the fact
  1517. that this state may indicate a failure.  Thus, it is most useful
  1518. to instrument transitions into/out of either the up state or the
  1519. down state.
  1520.  
  1521. Instrumenting transitions into or out of the up state was rejected
  1522. since it would have the drawback that a demand interface might
  1523. have many transitions between up and dormant, leading to many
  1524. linkUp traps and no linkDown traps.  Furthermore, if a node's only
  1525. interface is the demand interface, then a transition to dormant
  1526.  
  1527.  
  1528.  
  1529.  
  1530.  
  1531. Expires April 1998                                        [Page 26]
  1532.  
  1533.  
  1534.  
  1535.  
  1536.  
  1537. Draft                  Interfaces Group MIB           October 1997
  1538.  
  1539.  
  1540. would entail generation of a linkDown trap, necessitating bringing
  1541. the link to the up state (and a linkUp trap)!!
  1542.  
  1543. On the other hand, instrumenting transitions into or out of the
  1544. down state (to/from all other states except notPresent) has the
  1545. advantages:
  1546.  
  1547. (1)  A transition into the down state (from a state other than
  1548.      notPresent) will occur when an error is detected on an
  1549.      interface.  Error conditions are presumably of great interest
  1550.      to network managers.
  1551.  
  1552. (2)  Departing the down state (to a state other than the
  1553.      notPresent state) generally indicates that the interface is
  1554.      going to either up or dormant, both of which are considered
  1555.      "healthy" states.
  1556.  
  1557. Furthermore, it is believed that generating traps on transitions
  1558. into or out of the down state (except to/from the notPresent
  1559. state) is generally consistent with current usage and
  1560. interpretation of these traps by manager stations.
  1561.  
  1562. Transitions to/from the notPresent state are concerned with the
  1563. insertion and removal of hardware, and are outside the scope of
  1564. these traps.
  1565.  
  1566. Therefore, this memo defines that LinkUp and linkDown traps are
  1567. generated on just after ifOperStatus leaves, or just before it
  1568. enters, the down state, respectively; except that LinkUp and
  1569. linkDown traps never generated on transitions to/from the
  1570. notPresent state.
  1571.  
  1572. Note that this definition allows a node with only one interface to
  1573. transmit a linkDown trap before that interface goes down.  (Of
  1574. course, when the interface is going down because of a failure
  1575. condition, the linkDown trap probably cannot be successfully
  1576. transmitted anyway.)
  1577.  
  1578. Some interfaces perform a link "training" function when trying to
  1579. bring the interface up.  In the event that such an interface were
  1580. defective, then the training function would fail and the interface
  1581. would remain down, and the training function might be repeated at
  1582. appropriate intervals.  If the interface, while performing this
  1583. training function, were considered to the in the testing state,
  1584. then linkUp and linkDown traps would be generated for each start
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590. Expires April 1998                                        [Page 27]
  1591.  
  1592.  
  1593.  
  1594.  
  1595.  
  1596. Draft                  Interfaces Group MIB           October 1997
  1597.  
  1598.  
  1599. and end of the training function.  This is not the intent of the
  1600. linkUp and linkDown traps, and therefore, while performing such a
  1601. training function, the interface's state should be represented as
  1602. down.
  1603.  
  1604. An exception to the above generation of linkUp/linkDown traps on
  1605. changes in ifOperStatus, occurs when an interface is "flapping",
  1606. i.e., when it is rapidly oscillating between the up and down
  1607. states.  If traps were generated for each such oscillation, the
  1608. network and the network management system would be flooded with
  1609. unnecessary traps.  In such a situation, the agent should rate-
  1610. limit its generation of traps.
  1611.  
  1612. 3.1.16.  ifSpecific
  1613.  
  1614. The original definition of the OBJECT IDENTIFIER value of
  1615. ifSpecific was not sufficiently clear.  As a result, different
  1616. implementors used it differently, and confusion resulted.  Some
  1617. implementations set the value of ifSpecific to the OBJECT
  1618. IDENTIFIER that defines the media-specific MIB, i.e., the "foo"
  1619. of:
  1620.           foo OBJECT IDENTIFIER ::= { transmission xxx }
  1621.  
  1622. while others set it to be OBJECT IDENTIFIER of the specific table
  1623. or entry in the appropriate media-specific MIB (i.e., fooTable or
  1624. fooEntry), while still others set it be the OBJECT IDENTIFIER of
  1625. the index object of the table's row, including instance
  1626. identifier, (i.e., fooIfIndex.ifIndex).  A definition based on the
  1627. latter would not be sufficient unless it also allowed for media-
  1628. specific MIBs which include several tables, where each table has
  1629. its own (different) indexing.
  1630.  
  1631. The only definition that can both be made explicit and can cover
  1632. all the useful situations is to have ifSpecific be the most
  1633. general value for the media-specific MIB module (the first example
  1634. given above).  This effectively makes it redundant because it
  1635. contains no more information than is provided by ifType.  Thus,
  1636. ifSpecific has been deprecated.
  1637.  
  1638. 3.1.17.  Creation/Deletion of Interfaces
  1639.  
  1640. While some interfaces, for example, most physical interfaces,
  1641. cannot be created via network management, other interfaces such as
  1642. logical interfaces sometimes can be.  The ifTable contains only
  1643. generic information about an interface.  Almost all 'create-able'
  1644.  
  1645.  
  1646.  
  1647.  
  1648.  
  1649. Expires April 1998                                        [Page 28]
  1650.  
  1651.  
  1652.  
  1653.  
  1654.  
  1655. Draft                  Interfaces Group MIB           October 1997
  1656.  
  1657.  
  1658. interfaces have other, media-specific, information through which
  1659. configuration parameters may be supplied prior to creating such an
  1660. interface.  Thus, the ifTable does not itself support the creation
  1661. or deletion of an interface (specifically, it has no RowStatus [2]
  1662. column).  Rather, if a particular interface type supports the
  1663. dynamic creation and/or deletion of an interface of that type,
  1664. then that media-specific MIB should include an appropriate
  1665. RowStatus object (see the ATM LAN-Emulation Client MIB [8] for an
  1666. example of a MIB which does this).  Typically, when such a
  1667. RowStatus object is created/deleted, then the conceptual row in
  1668. the ifTable appears/disappears as a by-product, and an ifIndex
  1669. value (chosen by the agent) is stored in an appropriate object in
  1670. the media-specific MIB.
  1671.  
  1672. 3.1.18.  All Values Must be Known
  1673.  
  1674. There are a number of situations where an agent does not know the
  1675. value of one or more objects for a particular interface.  In all
  1676. such circumstances, an agent MUST NOT instantiate an object with
  1677. an incorrect value; rather, it MUST respond with the appropriate
  1678. error/exception condition (e.g., noSuchInstance for SNMPv2).
  1679.  
  1680. One example is where an agent is unable to count the occurrences
  1681. defined by one (or more) of the ifTable counters.  In this
  1682. circumstance, the agent MUST NOT instantiate the particular
  1683. counter with a value of, say, zero.  To do so would be to provide
  1684. mis-information to a network management application reading the
  1685. zero value, and thereby assuming that there have been no
  1686. occurrences of the event (e.g., no input errors because ifInErrors
  1687. is always zero).
  1688.  
  1689. Sometimes the lack of knowledge of an object's value is temporary.
  1690. For example, when the MTU of an interface is a configured value
  1691. and a device dynamically learns the configured value through
  1692. (after) exchanging messages over the interface (e.g., ATM LAN-
  1693. Emulation [8]).  In such a case, the value is not known until
  1694. after the ifTable entry has already been created.  In such a case,
  1695. the ifTable entry should be created without an instance of the
  1696. object whose value is unknown; later, when the value becomes
  1697. known, the missing object can then be instantiated (e.g., the
  1698. instance of ifMtu is only instantiated once the interface's MTU
  1699. becomes known).
  1700.  
  1701. As a result of this "known values" rule, management applications
  1702. MUST be able to cope with the responses to retrieving the object
  1703.  
  1704.  
  1705.  
  1706.  
  1707.  
  1708. Expires April 1998                                        [Page 29]
  1709.  
  1710.  
  1711.  
  1712.  
  1713.  
  1714. Draft                  Interfaces Group MIB           October 1997
  1715.  
  1716.  
  1717. instances within a conceptual row of the ifTable revealing that
  1718. some of the row's columnar objects are missing/not available.
  1719.  
  1720.  
  1721.  
  1722.  
  1723.  
  1724.  
  1725.  
  1726.  
  1727.  
  1728.  
  1729.  
  1730.  
  1731.  
  1732.  
  1733.  
  1734.  
  1735.  
  1736.  
  1737.  
  1738.  
  1739.  
  1740.  
  1741.  
  1742.  
  1743.  
  1744.  
  1745.  
  1746.  
  1747.  
  1748.  
  1749.  
  1750.  
  1751.  
  1752.  
  1753.  
  1754.  
  1755.  
  1756.  
  1757.  
  1758.  
  1759.  
  1760.  
  1761.  
  1762.  
  1763.  
  1764.  
  1765.  
  1766.  
  1767. Expires April 1998                                        [Page 30]
  1768.  
  1769.  
  1770.  
  1771.  
  1772.  
  1773. Draft                  Interfaces Group MIB           October 1997
  1774.  
  1775.  
  1776. 4.  Media-Specific MIB Applicability
  1777.  
  1778. The exact use and semantics of many objects in this MIB are open
  1779. to some interpretation.  This is a result of the generic nature of
  1780. this MIB.  It is not always possible to come up with specific,
  1781. unambiguous, text that covers all cases and yet preserves the
  1782. generic nature of the MIB.
  1783.  
  1784. Therefore, it is incumbent upon a media-specific MIB designer to,
  1785. wherever necessary, clarify the use of the objects in this MIB
  1786. with respect to the media-specific MIB.
  1787.  
  1788. Specific areas of clarification include
  1789.  
  1790. Layering Model
  1791.      The media-specific MIB designer MUST completely and
  1792.      unambiguously specify the layering model used.  Each
  1793.      individual sub-layer must be identified, as must the
  1794.      ifStackTable's portrayal of the relationship(s) between the
  1795.      sub-layers.
  1796.  
  1797. Virtual Circuits
  1798.      The media-specific MIB designer MUST specify whether virtual
  1799.      circuits are assigned entries in the ifTable or not.  If they
  1800.      are, compelling rationale must be presented.
  1801.  
  1802. ifRcvAddressTable
  1803.      The media-specific MIB designer MUST specify the
  1804.      applicability of the ifRcvAddressTable.
  1805.  
  1806. ifType
  1807.      For each of the ifType values to which the media-specific MIB
  1808.      applies, it must specify the mapping of ifType values to
  1809.      media-specific MIB module(s) and instances of MIB objects
  1810.      within those modules.
  1811.  
  1812. However, wherever this interface MIB is specific in the semantics,
  1813. DESCRIPTION, or applicability of objects, the media-specific MIB
  1814. designer MUST NOT change said semantics, DESCRIPTION, or
  1815. applicability.
  1816.  
  1817.  
  1818.  
  1819.  
  1820.  
  1821.  
  1822.  
  1823.  
  1824.  
  1825.  
  1826. Expires April 1998                                        [Page 31]
  1827.  
  1828.  
  1829.  
  1830.  
  1831.  
  1832. Draft                  Interfaces Group MIB           October 1997
  1833.  
  1834.  
  1835. 5.  Overview
  1836.  
  1837. This MIB consists of 4 tables:
  1838.  
  1839. ifTable
  1840.      This table is the ifTable from MIB-II.
  1841.  
  1842. ifXTable
  1843.      This table contains objects that have been added to the
  1844.      Interface MIB as a result of the Interface Evolution effort,
  1845.      or replacements for objects of the original (MIB-II) ifTable
  1846.      that were deprecated because the semantics of said objects
  1847.      have significantly changed.  This table also contains objects
  1848.      that were previously in the ifExtnsTable.
  1849.  
  1850. ifStackTable
  1851.      This table contains objects that define the relationships
  1852.      among the sub-layers of an interface.
  1853.  
  1854. ifRcvAddressTable
  1855.      This table contains objects that are used to define the
  1856.      media-level addresses which this interface will receive.
  1857.      This table is a generic table.  The designers of media-
  1858.      specific MIBs must define exactly how this table applies to
  1859.      their specific MIB.
  1860.  
  1861.  
  1862.  
  1863.  
  1864.  
  1865.  
  1866.  
  1867.  
  1868.  
  1869.  
  1870.  
  1871.  
  1872.  
  1873.  
  1874.  
  1875.  
  1876.  
  1877.  
  1878.  
  1879.  
  1880.  
  1881.  
  1882.  
  1883.  
  1884.  
  1885. Expires April 1998                                        [Page 32]
  1886.  
  1887.  
  1888.  
  1889.  
  1890.  
  1891. Draft                  Interfaces Group MIB           October 1997
  1892.  
  1893.  
  1894. 6.  Interfaces Group Definitions
  1895.  
  1896. IF-MIB DEFINITIONS ::= BEGIN
  1897.  
  1898. IMPORTS
  1899.     MODULE-IDENTITY, OBJECT-TYPE, Counter32, Gauge32, Counter64,
  1900.     Integer32, TimeTicks, mib-2,
  1901.     NOTIFICATION-TYPE                        FROM SNMPv2-SMI
  1902.     TEXTUAL-CONVENTION, DisplayString,
  1903.     PhysAddress, TruthValue, RowStatus,
  1904.     TimeStamp, AutonomousType, TestAndIncr   FROM SNMPv2-TC
  1905.     MODULE-COMPLIANCE, OBJECT-GROUP          FROM SNMPv2-CONF
  1906.     snmpTraps                                FROM SNMPv2-MIB
  1907.     IANAifType                               FROM IANAifType-MIB;
  1908.  
  1909.  
  1910. ifMIB MODULE-IDENTITY
  1911.     LAST-UPDATED "9611031355Z"
  1912.     ORGANIZATION "IETF Interfaces MIB Working Group"
  1913.     CONTACT-INFO
  1914.             "   Keith McCloghrie
  1915.                 Cisco Systems, Inc.
  1916.                 170 West Tasman Drive
  1917.                 San Jose, CA  95134-1706
  1918.                 US
  1919.  
  1920.                 408-526-5260
  1921.                 kzm@cisco.com"
  1922.     DESCRIPTION
  1923.             "The MIB module to describe generic objects for
  1924.             network interface sub-layers.  This MIB is an updated
  1925.             version of MIB-II's ifTable, and incorporates the
  1926.             extensions defined in RFC 1229."
  1927.     REVISION      "9602282155Z"
  1928.     DESCRIPTION
  1929.             "Revisions made by the Interfaces MIB WG."
  1930.     REVISION      "9311082155Z"
  1931.     DESCRIPTION
  1932.             "Initial revision, published as part of RFC 1573."
  1933.     ::= { mib-2 31 }
  1934.  
  1935.  
  1936. ifMIBObjects OBJECT IDENTIFIER ::= { ifMIB 1 }
  1937.  
  1938. interfaces   OBJECT IDENTIFIER ::= { mib-2 2 }
  1939.  
  1940.  
  1941.  
  1942.  
  1943.  
  1944. Expires April 1998                                        [Page 33]
  1945.  
  1946.  
  1947.  
  1948.  
  1949.  
  1950. Draft                  Interfaces Group MIB           October 1997
  1951.  
  1952.  
  1953. -- OwnerString has the same semantics as used in RFC 1271
  1954.  
  1955. OwnerString ::= TEXTUAL-CONVENTION
  1956.     DISPLAY-HINT "255a"
  1957.     STATUS       current
  1958.     DESCRIPTION
  1959.             "This data type is used to model an administratively
  1960.             assigned name of the owner of a resource.  This
  1961.             information is taken from the NVT ASCII character set.
  1962.             It is suggested that this name contain one or more of
  1963.             the following: ASCII form of the manager station's
  1964.             transport address, management station name (e.g.,
  1965.             domain name), network management personnel's name,
  1966.             location, or phone number.  In some cases the agent
  1967.             itself will be the owner of an entry.  In these cases,
  1968.             this string shall be set to a string starting with
  1969.             'agent'."
  1970.     SYNTAX       OCTET STRING (SIZE(0..255))
  1971.  
  1972. -- InterfaceIndex contains the semantics of ifIndex and
  1973. -- should be used for any objects defined on other mib
  1974. -- modules that need these semantics.
  1975.  
  1976. InterfaceIndex ::= TEXTUAL-CONVENTION
  1977.     DISPLAY-HINT "d"
  1978.     STATUS       current
  1979.     DESCRIPTION
  1980.             "A unique value, greater than zero, for each interface
  1981.             or interface sub-layer in the managed system.  It is
  1982.             recommended that values are assigned contiguously
  1983.             starting from 1.  The value for each interface sub-
  1984.             layer must remain constant at least from one re-
  1985.             initialization of the entity's network management
  1986.             system to the next re-initialization."
  1987.     SYNTAX       Integer32 (1..2147483647)
  1988.  
  1989.  
  1990.  
  1991.  
  1992.  
  1993.  
  1994.  
  1995.  
  1996.  
  1997.  
  1998.  
  1999.  
  2000.  
  2001.  
  2002.  
  2003. Expires April 1998                                        [Page 34]
  2004.  
  2005.  
  2006.  
  2007.  
  2008.  
  2009. Draft                  Interfaces Group MIB           October 1997
  2010.  
  2011.  
  2012. InterfaceIndexOrZero ::= TEXTUAL-CONVENTION
  2013.     DISPLAY-HINT "d"
  2014.     STATUS       current
  2015.     DESCRIPTION
  2016.             "This textual convention is an extension of the
  2017.             InterfaceIndex convention.  The latter defines a
  2018.             greater than zero value used to identify an interface
  2019.             or interface sub-layer in the managed system.  This
  2020.             extension permits the additional value of zero.  the
  2021.             value zero is object-specific and must therefore be
  2022.             defined as part of the description of any object which
  2023.             uses this syntax.  Examples of the usage of zero might
  2024.             include situations where interface was unknown, or
  2025.             when none or all interfaces need to be referenced."
  2026.     SYNTAX       Integer32 (0..2147483647)
  2027.  
  2028.  
  2029.  
  2030.  
  2031.  
  2032.  
  2033.  
  2034.  
  2035.  
  2036.  
  2037.  
  2038.  
  2039.  
  2040.  
  2041.  
  2042.  
  2043.  
  2044.  
  2045.  
  2046.  
  2047.  
  2048.  
  2049.  
  2050.  
  2051.  
  2052.  
  2053.  
  2054.  
  2055.  
  2056.  
  2057.  
  2058.  
  2059.  
  2060.  
  2061.  
  2062. Expires April 1998                                        [Page 35]
  2063.  
  2064.  
  2065.  
  2066.  
  2067.  
  2068. Draft                  Interfaces Group MIB           October 1997
  2069.  
  2070.  
  2071. ifNumber  OBJECT-TYPE
  2072.     SYNTAX      Integer32
  2073.     MAX-ACCESS  read-only
  2074.     STATUS      current
  2075.     DESCRIPTION
  2076.             "The number of network interfaces (regardless of their
  2077.             current state) present on this system."
  2078.     ::= { interfaces 1 }
  2079.  
  2080. ifTableLastChange  OBJECT-TYPE
  2081.     SYNTAX      TimeTicks
  2082.     MAX-ACCESS  read-only
  2083.     STATUS      current
  2084.     DESCRIPTION
  2085.             "The value of sysUpTime at the time of the last
  2086.             creation or deletion of an entry in the ifTable.  If
  2087.             the number of entries has been unchanged since the
  2088.             last re-initialization of the local network management
  2089.             subsystem, then this object contains a zero value."
  2090.     ::= { ifMIBObjects 5 }
  2091.  
  2092.  
  2093. -- the Interfaces table
  2094.  
  2095. -- The Interfaces table contains information on the entity's
  2096. -- interfaces.  Each sub-layer below the internetwork-layer
  2097. -- of a network interface is considered to be an interface.
  2098.  
  2099. ifTable OBJECT-TYPE
  2100.     SYNTAX      SEQUENCE OF IfEntry
  2101.     MAX-ACCESS  not-accessible
  2102.     STATUS      current
  2103.     DESCRIPTION
  2104.             "A list of interface entries.  The number of entries
  2105.             is given by the value of ifNumber."
  2106.     ::= { interfaces 2 }
  2107.  
  2108. ifEntry OBJECT-TYPE
  2109.     SYNTAX      IfEntry
  2110.     MAX-ACCESS  not-accessible
  2111.     STATUS      current
  2112.     DESCRIPTION
  2113.             "An entry containing management information applicable
  2114.             to a particular interface."
  2115.     INDEX   { ifIndex }
  2116.  
  2117.  
  2118.  
  2119.  
  2120.  
  2121. Expires April 1998                                        [Page 36]
  2122.  
  2123.  
  2124.  
  2125.  
  2126.  
  2127. Draft                  Interfaces Group MIB           October 1997
  2128.  
  2129.  
  2130.     ::= { ifTable 1 }
  2131.  
  2132. IfEntry ::=
  2133.     SEQUENCE {
  2134.         ifIndex                 InterfaceIndex,
  2135.         ifDescr                 DisplayString,
  2136.         ifType                  IANAifType,
  2137.         ifMtu                   Integer32,
  2138.         ifSpeed                 Gauge32,
  2139.         ifPhysAddress           PhysAddress,
  2140.         ifAdminStatus           INTEGER,
  2141.         ifOperStatus            INTEGER,
  2142.         ifLastChange            TimeTicks,
  2143.         ifInOctets              Counter32,
  2144.         ifInUcastPkts           Counter32,
  2145.         ifInNUcastPkts          Counter32,  -- deprecated
  2146.         ifInDiscards            Counter32,
  2147.         ifInErrors              Counter32,
  2148.         ifInUnknownProtos       Counter32,
  2149.         ifOutOctets             Counter32,
  2150.         ifOutUcastPkts          Counter32,
  2151.         ifOutNUcastPkts         Counter32,  -- deprecated
  2152.         ifOutDiscards           Counter32,
  2153.         ifOutErrors             Counter32,
  2154.         ifOutQLen               Gauge32,    -- deprecated
  2155.         ifSpecific              OBJECT IDENTIFIER -- deprecated
  2156.     }
  2157.  
  2158.  
  2159. ifIndex OBJECT-TYPE
  2160.     SYNTAX      InterfaceIndex
  2161.     MAX-ACCESS  read-only
  2162.     STATUS      current
  2163.     DESCRIPTION
  2164.             "A unique value, greater than zero, for each
  2165.             interface.  It is recommended that values are assigned
  2166.             contiguously starting from 1.  The value for each
  2167.             interface sub-layer must remain constant at least from
  2168.             one re-initialization of the entity's network
  2169.             management system to the next re-initialization."
  2170.     ::= { ifEntry 1 }
  2171.  
  2172. ifDescr OBJECT-TYPE
  2173.     SYNTAX      DisplayString (SIZE (0..255))
  2174.     MAX-ACCESS  read-only
  2175.  
  2176.  
  2177.  
  2178.  
  2179.  
  2180. Expires April 1998                                        [Page 37]
  2181.  
  2182.  
  2183.  
  2184.  
  2185.  
  2186. Draft                  Interfaces Group MIB           October 1997
  2187.  
  2188.  
  2189.     STATUS      current
  2190.     DESCRIPTION
  2191.             "A textual string containing information about the
  2192.             interface.  This string should include the name of the
  2193.             manufacturer, the product name and the version of the
  2194.             interface hardware/software."
  2195.     ::= { ifEntry 2 }
  2196.  
  2197. ifType OBJECT-TYPE
  2198.     SYNTAX      IANAifType
  2199.     MAX-ACCESS  read-only
  2200.     STATUS      current
  2201.     DESCRIPTION
  2202.             "The type of interface.  Additional values for ifType
  2203.             are assigned by the Internet Assigned Numbers
  2204.             Authority (IANA), through updating the syntax of the
  2205.             IANAifType textual convention."
  2206.     ::= { ifEntry 3 }
  2207.  
  2208. ifMtu OBJECT-TYPE
  2209.     SYNTAX      Integer32
  2210.     MAX-ACCESS  read-only
  2211.     STATUS      current
  2212.     DESCRIPTION
  2213.             "The size of the largest packet which can be
  2214.             sent/received on the interface, specified in octets.
  2215.             For interfaces that are used for transmitting network
  2216.             datagrams, this is the size of the largest network
  2217.             datagram that can be sent on the interface."
  2218.     ::= { ifEntry 4 }
  2219.  
  2220. ifSpeed OBJECT-TYPE
  2221.     SYNTAX      Gauge32
  2222.     MAX-ACCESS  read-only
  2223.     STATUS      current
  2224.     DESCRIPTION
  2225.             "An estimate of the interface's current bandwidth in
  2226.             bits per second.  For interfaces which do not vary in
  2227.             bandwidth or for those where no accurate estimation
  2228.             can be made, this object should contain the nominal
  2229.             bandwidth.  If the bandwidth of the interface is
  2230.             greater than the maximum value reportable by this
  2231.             object then this object should report its maximum
  2232.             value (4,294,967,295) and ifHighSpeed must be used to
  2233.             report the interace's speed.  For a sub-layer which
  2234.  
  2235.  
  2236.  
  2237.  
  2238.  
  2239. Expires April 1998                                        [Page 38]
  2240.  
  2241.  
  2242.  
  2243.  
  2244.  
  2245. Draft                  Interfaces Group MIB           October 1997
  2246.  
  2247.  
  2248.             has no concept of bandwidth, this object should be
  2249.             zero."
  2250.     ::= { ifEntry 5 }
  2251.  
  2252. ifPhysAddress OBJECT-TYPE
  2253.     SYNTAX      PhysAddress
  2254.     MAX-ACCESS  read-only
  2255.     STATUS      current
  2256.     DESCRIPTION
  2257.             "The interface's address at its protocol sub-layer.
  2258.             For example, for an 802.x interface, this object
  2259.             normally contains a MAC address.  The interface's
  2260.             media-specific MIB must define the bit and byte
  2261.             ordering and the format of the value of this object.
  2262.             For interfaces which do not have such an address
  2263.             (e.g., a serial line), this object should contain an
  2264.             octet string of zero length."
  2265.     ::= { ifEntry 6 }
  2266.  
  2267. ifAdminStatus OBJECT-TYPE
  2268.     SYNTAX  INTEGER {
  2269.                 up(1),       -- ready to pass packets
  2270.                 down(2),
  2271.                 testing(3)   -- in some test mode
  2272.             }
  2273.     MAX-ACCESS  read-write
  2274.     STATUS      current
  2275.     DESCRIPTION
  2276.             "The desired state of the interface.  The testing(3)
  2277.             state indicates that no operational packets can be
  2278.             passed.  When a managed system initializes, all
  2279.             interfaces start with ifAdminStatus in the down(2)
  2280.             state.  As a result of either explicit management
  2281.             action or per configuration information retained by
  2282.             the managed system, ifAdminStatus is then changed to
  2283.             either the up(1) or testing(3) states (or remains in
  2284.             the down(2) state)."
  2285.     ::= { ifEntry 7 }
  2286.  
  2287. ifOperStatus OBJECT-TYPE
  2288.     SYNTAX  INTEGER {
  2289.                 up(1),        -- ready to pass packets
  2290.                 down(2),
  2291.                 testing(3),   -- in some test mode
  2292.                 unknown(4),   -- status can not be determined
  2293.  
  2294.  
  2295.  
  2296.  
  2297.  
  2298. Expires April 1998                                        [Page 39]
  2299.  
  2300.  
  2301.  
  2302.  
  2303.  
  2304. Draft                  Interfaces Group MIB           October 1997
  2305.  
  2306.  
  2307.                               -- for some reason.
  2308.                 dormant(5),
  2309.                 notPresent(6),    -- some component is missing
  2310.                 lowerLayerDown(7) -- down due to state of
  2311.                                   -- lower-layer interface(s)
  2312.             }
  2313.     MAX-ACCESS  read-only
  2314.     STATUS      current
  2315.     DESCRIPTION
  2316.             "The current operational state of the interface.  The
  2317.             testing(3) state indicates that no operational packets
  2318.             can be passed.  If ifAdminStatus is down(2) then
  2319.             ifOperStatus should be down(2).  If ifAdminStatus is
  2320.             changed to up(1) then ifOperStatus should change to
  2321.             up(1) if the interface is ready to transmit and
  2322.             receive network traffic; it should change to
  2323.             dormant(5) if the interface is waiting for external
  2324.             actions (such as a serial line waiting for an incoming
  2325.             connection); it should remain in the down(2) state if
  2326.             and only if there is a fault that prevents it from
  2327.             going to the up(1) state; it should remain in the
  2328.             notPresent(6) state if the interface has missing
  2329.             (typically, hardware) components."
  2330.     ::= { ifEntry 8 }
  2331.  
  2332. ifLastChange OBJECT-TYPE
  2333.     SYNTAX      TimeTicks
  2334.     MAX-ACCESS  read-only
  2335.     STATUS      current
  2336.     DESCRIPTION
  2337.             "The value of sysUpTime at the time the interface
  2338.             entered its current operational state.  If the current
  2339.             state was entered prior to the last re-initialization
  2340.             of the local network management subsystem, then this
  2341.             object contains a zero value."
  2342.     ::= { ifEntry 9 }
  2343.  
  2344. ifInOctets OBJECT-TYPE
  2345.     SYNTAX      Counter32
  2346.     MAX-ACCESS  read-only
  2347.     STATUS      current
  2348.     DESCRIPTION
  2349.             "The total number of octets received on the interface,
  2350.             including framing characters.
  2351.  
  2352.  
  2353.  
  2354.  
  2355.  
  2356.  
  2357. Expires April 1998                                        [Page 40]
  2358.  
  2359.  
  2360.  
  2361.  
  2362.  
  2363. Draft                  Interfaces Group MIB           October 1997
  2364.  
  2365.  
  2366.             Discontinuities in the value of this counter can occur
  2367.             at re-initialization of the management system, and at
  2368.             other times as indicated by the value of
  2369.             ifCounterDiscontinuityTime."
  2370.     ::= { ifEntry 10 }
  2371.  
  2372. ifInUcastPkts OBJECT-TYPE
  2373.     SYNTAX      Counter32
  2374.     MAX-ACCESS  read-only
  2375.     STATUS      current
  2376.     DESCRIPTION
  2377.             "The number of packets, delivered by this sub-layer to
  2378.             a higher (sub-)layer, which were not addressed to a
  2379.             multicast or broadcast address at this sub-layer.
  2380.  
  2381.             Discontinuities in the value of this counter can occur
  2382.             at re-initialization of the management system, and at
  2383.             other times as indicated by the value of
  2384.             ifCounterDiscontinuityTime."
  2385.     ::= { ifEntry 11 }
  2386.  
  2387. ifInNUcastPkts OBJECT-TYPE
  2388.     SYNTAX  Counter32
  2389.     MAX-ACCESS  read-only
  2390.     STATUS      deprecated
  2391.     DESCRIPTION
  2392.             "The number of packets, delivered by this sub-layer to
  2393.             a higher (sub-)layer, which were addressed to a
  2394.             multicast or broadcast address at this sub-layer.
  2395.  
  2396.             Discontinuities in the value of this counter can occur
  2397.             at re-initialization of the management system, and at
  2398.             other times as indicated by the value of
  2399.             ifCounterDiscontinuityTime.
  2400.  
  2401.             This object is deprecated in favour of
  2402.             ifInMulticastPkts and ifInBroadcastPkts."
  2403.     ::= { ifEntry 12 }
  2404.  
  2405. ifInDiscards OBJECT-TYPE
  2406.     SYNTAX      Counter32
  2407.     MAX-ACCESS  read-only
  2408.     STATUS      current
  2409.     DESCRIPTION
  2410.             "The number of inbound packets which were chosen to be
  2411.  
  2412.  
  2413.  
  2414.  
  2415.  
  2416. Expires April 1998                                        [Page 41]
  2417.  
  2418.  
  2419.  
  2420.  
  2421.  
  2422. Draft                  Interfaces Group MIB           October 1997
  2423.  
  2424.  
  2425.             discarded even though no errors had been detected to
  2426.             prevent their being deliverable to a higher-layer
  2427.             protocol.  One possible reason for discarding such a
  2428.             packet could be to free up buffer space.
  2429.  
  2430.             Discontinuities in the value of this counter can occur
  2431.             at re-initialization of the management system, and at
  2432.             other times as indicated by the value of
  2433.             ifCounterDiscontinuityTime."
  2434.     ::= { ifEntry 13 }
  2435.  
  2436. ifInErrors OBJECT-TYPE
  2437.     SYNTAX      Counter32
  2438.     MAX-ACCESS  read-only
  2439.     STATUS      current
  2440.     DESCRIPTION
  2441.             "For packet-oriented interfaces, the number of inbound
  2442.             packets that contained errors preventing them from
  2443.             being deliverable to a higher-layer protocol.  For
  2444.             character-oriented or fixed-length interfaces, the
  2445.             number of inbound transmission units that contained
  2446.             errors preventing them from being deliverable to a
  2447.             higher-layer protocol.
  2448.  
  2449.             Discontinuities in the value of this counter can occur
  2450.             at re-initialization of the management system, and at
  2451.             other times as indicated by the value of
  2452.             ifCounterDiscontinuityTime."
  2453.     ::= { ifEntry 14 }
  2454.  
  2455. ifInUnknownProtos OBJECT-TYPE
  2456.     SYNTAX      Counter32
  2457.     MAX-ACCESS  read-only
  2458.     STATUS      current
  2459.     DESCRIPTION
  2460.             "For packet-oriented interfaces, the number of packets
  2461.             received via the interface which were discarded
  2462.             because of an unknown or unsupported protocol.  For
  2463.             character-oriented or fixed-length interfaces that
  2464.             support protocol multiplexing the number of
  2465.             transmission units received via the interface which
  2466.             were discarded because of an unknown or unsupported
  2467.             protocol.  For any interface that does not support
  2468.             protocol multiplexing, this counter will always be 0.
  2469.  
  2470.  
  2471.  
  2472.  
  2473.  
  2474.  
  2475. Expires April 1998                                        [Page 42]
  2476.  
  2477.  
  2478.  
  2479.  
  2480.  
  2481. Draft                  Interfaces Group MIB           October 1997
  2482.  
  2483.  
  2484.             Discontinuities in the value of this counter can occur
  2485.             at re-initialization of the management system, and at
  2486.             other times as indicated by the value of
  2487.             ifCounterDiscontinuityTime."
  2488.     ::= { ifEntry 15 }
  2489.  
  2490. ifOutOctets OBJECT-TYPE
  2491.     SYNTAX      Counter32
  2492.     MAX-ACCESS  read-only
  2493.     STATUS      current
  2494.     DESCRIPTION
  2495.             "The total number of octets transmitted out of the
  2496.             interface, including framing characters.
  2497.  
  2498.             Discontinuities in the value of this counter can occur
  2499.             at re-initialization of the management system, and at
  2500.             other times as indicated by the value of
  2501.             ifCounterDiscontinuityTime."
  2502.     ::= { ifEntry 16 }
  2503.  
  2504. ifOutUcastPkts OBJECT-TYPE
  2505.     SYNTAX      Counter32
  2506.     MAX-ACCESS  read-only
  2507.     STATUS      current
  2508.     DESCRIPTION
  2509.             "The total number of packets that higher-level
  2510.             protocols requested be transmitted, and which were not
  2511.             addressed to a multicast or broadcast address at this
  2512.             sub-layer, including those that were discarded or not
  2513.             sent.
  2514.  
  2515.             Discontinuities in the value of this counter can occur
  2516.             at re-initialization of the management system, and at
  2517.             other times as indicated by the value of
  2518.             ifCounterDiscontinuityTime."
  2519.     ::= { ifEntry 17 }
  2520.  
  2521. ifOutNUcastPkts OBJECT-TYPE
  2522.     SYNTAX      Counter32
  2523.     MAX-ACCESS  read-only
  2524.     STATUS      deprecated
  2525.     DESCRIPTION
  2526.             "The total number of packets that higher-level
  2527.             protocols requested be transmitted, and which were
  2528.             addressed to a multicast or broadcast address at this
  2529.  
  2530.  
  2531.  
  2532.  
  2533.  
  2534. Expires April 1998                                        [Page 43]
  2535.  
  2536.  
  2537.  
  2538.  
  2539.  
  2540. Draft                  Interfaces Group MIB           October 1997
  2541.  
  2542.  
  2543.             sub-layer, including those that were discarded or not
  2544.             sent.
  2545.  
  2546.             Discontinuities in the value of this counter can occur
  2547.             at re-initialization of the management system, and at
  2548.             other times as indicated by the value of
  2549.             ifCounterDiscontinuityTime.
  2550.  
  2551.             This object is deprecated in favour of
  2552.             ifOutMulticastPkts and ifOutBroadcastPkts."
  2553.     ::= { ifEntry 18 }
  2554.  
  2555. ifOutDiscards OBJECT-TYPE
  2556.     SYNTAX      Counter32
  2557.     MAX-ACCESS  read-only
  2558.     STATUS      current
  2559.     DESCRIPTION
  2560.             "The number of outbound packets which were chosen to
  2561.             be discarded even though no errors had been detected
  2562.             to prevent their being transmitted.  One possible
  2563.             reason for discarding such a packet could be to free
  2564.             up buffer space.
  2565.  
  2566.             Discontinuities in the value of this counter can occur
  2567.             at re-initialization of the management system, and at
  2568.             other times as indicated by the value of
  2569.             ifCounterDiscontinuityTime."
  2570.     ::= { ifEntry 19 }
  2571.  
  2572. ifOutErrors OBJECT-TYPE
  2573.     SYNTAX      Counter32
  2574.     MAX-ACCESS  read-only
  2575.     STATUS      current
  2576.     DESCRIPTION
  2577.             "For packet-oriented interfaces, the number of
  2578.             outbound packets that could not be transmitted because
  2579.             of errors.  For character-oriented or fixed-length
  2580.             interfaces, the number of outbound transmission units
  2581.             that could not be transmitted because of errors.
  2582.  
  2583.             Discontinuities in the value of this counter can occur
  2584.             at re-initialization of the management system, and at
  2585.             other times as indicated by the value of
  2586.             ifCounterDiscontinuityTime."
  2587.     ::= { ifEntry 20 }
  2588.  
  2589.  
  2590.  
  2591.  
  2592.  
  2593. Expires April 1998                                        [Page 44]
  2594.  
  2595.  
  2596.  
  2597.  
  2598.  
  2599. Draft                  Interfaces Group MIB           October 1997
  2600.  
  2601.  
  2602. ifOutQLen OBJECT-TYPE
  2603.     SYNTAX      Gauge32
  2604.     MAX-ACCESS  read-only
  2605.     STATUS      deprecated
  2606.     DESCRIPTION
  2607.             "The length of the output packet queue (in packets)."
  2608.     ::= { ifEntry 21 }
  2609.  
  2610. ifSpecific OBJECT-TYPE
  2611.     SYNTAX      OBJECT IDENTIFIER
  2612.     MAX-ACCESS  read-only
  2613.     STATUS      deprecated
  2614.     DESCRIPTION
  2615.             "A reference to MIB definitions specific to the
  2616.             particular media being used to realize the interface.
  2617.             It is recommended that this value point to an instance
  2618.             of a MIB object in the media-specific MIB, i.e., that
  2619.             this object have the semantics associated with the
  2620.             InstancePointer textual convention defined in RFC
  2621.             1903.  In fact, it is recommended that the media-
  2622.             specific MIB specify what value ifSpecific should/can
  2623.             take for values of ifType.  If no MIB definitions
  2624.             specific to the particular media are available, the
  2625.             value should be set to the OBJECT IDENTIFIER { 0 0 }."
  2626.     ::= { ifEntry 22 }
  2627.  
  2628.  
  2629.  
  2630. --
  2631. --   Extension to the interface table
  2632. --
  2633. -- This table replaces the ifExtnsTable table.
  2634. --
  2635.  
  2636. ifXTable        OBJECT-TYPE
  2637.     SYNTAX      SEQUENCE OF IfXEntry
  2638.     MAX-ACCESS  not-accessible
  2639.     STATUS      current
  2640.     DESCRIPTION
  2641.             "A list of interface entries.  The number of entries
  2642.             is given by the value of ifNumber.  This table
  2643.             contains additional objects for the interface table."
  2644.     ::= { ifMIBObjects 1 }
  2645.  
  2646. ifXEntry        OBJECT-TYPE
  2647.  
  2648.  
  2649.  
  2650.  
  2651.  
  2652. Expires April 1998                                        [Page 45]
  2653.  
  2654.  
  2655.  
  2656.  
  2657.  
  2658. Draft                  Interfaces Group MIB           October 1997
  2659.  
  2660.  
  2661.     SYNTAX      IfXEntry
  2662.     MAX-ACCESS  not-accessible
  2663.     STATUS      current
  2664.     DESCRIPTION
  2665.             "An entry containing additional management information
  2666.             applicable to a particular interface."
  2667.     AUGMENTS    { ifEntry }
  2668.     ::= { ifXTable 1 }
  2669.  
  2670. IfXEntry ::=
  2671.     SEQUENCE {
  2672.         ifName                  DisplayString,
  2673.         ifInMulticastPkts       Counter32,
  2674.         ifInBroadcastPkts       Counter32,
  2675.         ifOutMulticastPkts      Counter32,
  2676.         ifOutBroadcastPkts      Counter32,
  2677.         ifHCInOctets            Counter64,
  2678.         ifHCInUcastPkts         Counter64,
  2679.         ifHCInMulticastPkts     Counter64,
  2680.         ifHCInBroadcastPkts     Counter64,
  2681.         ifHCOutOctets           Counter64,
  2682.         ifHCOutUcastPkts        Counter64,
  2683.         ifHCOutMulticastPkts    Counter64,
  2684.         ifHCOutBroadcastPkts    Counter64,
  2685.         ifLinkUpDownTrapEnable  INTEGER,
  2686.         ifHighSpeed             Gauge32,
  2687.         ifPromiscuousMode       TruthValue,
  2688.         ifConnectorPresent      TruthValue,
  2689.         ifAlias                 DisplayString,
  2690.         ifCounterDiscontinuityTime TimeStamp
  2691.     }
  2692.  
  2693.  
  2694. ifName OBJECT-TYPE
  2695.     SYNTAX      DisplayString
  2696.     MAX-ACCESS  read-only
  2697.     STATUS      current
  2698.     DESCRIPTION
  2699.             "The textual name of the interface.  The value of this
  2700.             object should be the name of the interface as assigned
  2701.             by the local device and should be suitable for use in
  2702.             commands entered at the device's `console'.  This
  2703.             might be a text name, such as `le0' or a simple port
  2704.             number, such as `1', depending on the interface naming
  2705.             syntax of the device.  If several entries in the
  2706.  
  2707.  
  2708.  
  2709.  
  2710.  
  2711. Expires April 1998                                        [Page 46]
  2712.  
  2713.  
  2714.  
  2715.  
  2716.  
  2717. Draft                  Interfaces Group MIB           October 1997
  2718.  
  2719.  
  2720.             ifTable together represent a single interface as named
  2721.             by the device, then each will have the same value of
  2722.             ifName.  Note that for an agent which responds to SNMP
  2723.             queries concerning an interface on some other
  2724.             (proxied) device, then the value of ifName for such an
  2725.             interface is the proxied device's local name for it.
  2726.  
  2727.             If there is no local name, or this object is otherwise
  2728.             not applicable, then this object contains a zero-
  2729.             length string."
  2730.     ::= { ifXEntry 1 }
  2731.  
  2732. ifInMulticastPkts OBJECT-TYPE
  2733.     SYNTAX      Counter32
  2734.     MAX-ACCESS  read-only
  2735.     STATUS      current
  2736.     DESCRIPTION
  2737.             "The number of packets, delivered by this sub-layer to
  2738.             a higher (sub-)layer, which were addressed to a
  2739.             multicast address at this sub-layer.  For a MAC layer
  2740.             protocol, this includes both Group and Functional
  2741.             addresses.
  2742.  
  2743.             Discontinuities in the value of this counter can occur
  2744.             at re-initialization of the management system, and at
  2745.             other times as indicated by the value of
  2746.             ifCounterDiscontinuityTime."
  2747.     ::= { ifXEntry 2 }
  2748.  
  2749. ifInBroadcastPkts OBJECT-TYPE
  2750.     SYNTAX      Counter32
  2751.     MAX-ACCESS  read-only
  2752.     STATUS      current
  2753.     DESCRIPTION
  2754.             "The number of packets, delivered by this sub-layer to
  2755.             a higher (sub-)layer, which were addressed to a
  2756.             broadcast address at this sub-layer.
  2757.  
  2758.             Discontinuities in the value of this counter can occur
  2759.             at re-initialization of the management system, and at
  2760.             other times as indicated by the value of
  2761.             ifCounterDiscontinuityTime."
  2762.     ::= { ifXEntry 3 }
  2763.  
  2764. ifOutMulticastPkts OBJECT-TYPE
  2765.  
  2766.  
  2767.  
  2768.  
  2769.  
  2770. Expires April 1998                                        [Page 47]
  2771.  
  2772.  
  2773.  
  2774.  
  2775.  
  2776. Draft                  Interfaces Group MIB           October 1997
  2777.  
  2778.  
  2779.     SYNTAX      Counter32
  2780.     MAX-ACCESS  read-only
  2781.     STATUS      current
  2782.     DESCRIPTION
  2783.             "The total number of packets that higher-level
  2784.             protocols requested be transmitted, and which were
  2785.             addressed to a multicast address at this sub-layer,
  2786.             including those that were discarded or not sent.  For
  2787.             a MAC layer protocol, this includes both Group and
  2788.             Functional addresses.
  2789.  
  2790.             Discontinuities in the value of this counter can occur
  2791.             at re-initialization of the management system, and at
  2792.             other times as indicated by the value of
  2793.             ifCounterDiscontinuityTime."
  2794.     ::= { ifXEntry 4 }
  2795.  
  2796. ifOutBroadcastPkts OBJECT-TYPE
  2797.     SYNTAX      Counter32
  2798.     MAX-ACCESS  read-only
  2799.     STATUS      current
  2800.     DESCRIPTION
  2801.             "The total number of packets that higher-level
  2802.             protocols requested be transmitted, and which were
  2803.             addressed to a broadcast address at this sub-layer,
  2804.             including those that were discarded or not sent.
  2805.  
  2806.             Discontinuities in the value of this counter can occur
  2807.             at re-initialization of the management system, and at
  2808.             other times as indicated by the value of
  2809.             ifCounterDiscontinuityTime."
  2810.     ::= { ifXEntry 5 }
  2811.  
  2812. --
  2813. -- High Capacity Counter objects.  These objects are all
  2814. -- 64 bit versions of the "basic" ifTable counters.  These
  2815. -- objects all have the same basic semantics as their 32-bit
  2816. -- counterparts, however, their syntax has been extended
  2817. -- to 64 bits.
  2818. --
  2819.  
  2820. ifHCInOctets OBJECT-TYPE
  2821.     SYNTAX      Counter64
  2822.     MAX-ACCESS  read-only
  2823.     STATUS      current
  2824.  
  2825.  
  2826.  
  2827.  
  2828.  
  2829. Expires April 1998                                        [Page 48]
  2830.  
  2831.  
  2832.  
  2833.  
  2834.  
  2835. Draft                  Interfaces Group MIB           October 1997
  2836.  
  2837.  
  2838.     DESCRIPTION
  2839.             "The total number of octets received on the interface,
  2840.             including framing characters.  This object is a 64-bit
  2841.             version of ifInOctets.
  2842.  
  2843.             Discontinuities in the value of this counter can occur
  2844.             at re-initialization of the management system, and at
  2845.             other times as indicated by the value of
  2846.             ifCounterDiscontinuityTime."
  2847.     ::= { ifXEntry 6 }
  2848.  
  2849. ifHCInUcastPkts OBJECT-TYPE
  2850.     SYNTAX      Counter64
  2851.     MAX-ACCESS  read-only
  2852.     STATUS      current
  2853.     DESCRIPTION
  2854.             "The number of packets, delivered by this sub-layer to
  2855.             a higher (sub-)layer, which were not addressed to a
  2856.             multicast or broadcast address at this sub-layer.
  2857.             This object is a 64-bit version of ifInUcastPkts.
  2858.  
  2859.             Discontinuities in the value of this counter can occur
  2860.             at re-initialization of the management system, and at
  2861.             other times as indicated by the value of
  2862.             ifCounterDiscontinuityTime."
  2863.     ::= { ifXEntry 7 }
  2864.  
  2865. ifHCInMulticastPkts OBJECT-TYPE
  2866.     SYNTAX      Counter64
  2867.     MAX-ACCESS  read-only
  2868.     STATUS      current
  2869.     DESCRIPTION
  2870.             "The number of packets, delivered by this sub-layer to
  2871.             a higher (sub-)layer, which were addressed to a
  2872.             multicast address at this sub-layer.  For a MAC layer
  2873.             protocol, this includes both Group and Functional
  2874.             addresses.  This object is a 64-bit version of
  2875.             ifInMulticastPkts.
  2876.  
  2877.             Discontinuities in the value of this counter can occur
  2878.             at re-initialization of the management system, and at
  2879.             other times as indicated by the value of
  2880.             ifCounterDiscontinuityTime."
  2881.     ::= { ifXEntry 8 }
  2882.  
  2883.  
  2884.  
  2885.  
  2886.  
  2887.  
  2888. Expires April 1998                                        [Page 49]
  2889.  
  2890.  
  2891.  
  2892.  
  2893.  
  2894. Draft                  Interfaces Group MIB           October 1997
  2895.  
  2896.  
  2897. ifHCInBroadcastPkts OBJECT-TYPE
  2898.     SYNTAX      Counter64
  2899.     MAX-ACCESS  read-only
  2900.     STATUS      current
  2901.     DESCRIPTION
  2902.             "The number of packets, delivered by this sub-layer to
  2903.             a higher (sub-)layer, which were addressed to a
  2904.             broadcast address at this sub-layer.  This object is a
  2905.             64-bit version of ifInBroadcastPkts.
  2906.  
  2907.             Discontinuities in the value of this counter can occur
  2908.             at re-initialization of the management system, and at
  2909.             other times as indicated by the value of
  2910.             ifCounterDiscontinuityTime."
  2911.     ::= { ifXEntry 9 }
  2912.  
  2913. ifHCOutOctets OBJECT-TYPE
  2914.     SYNTAX      Counter64
  2915.     MAX-ACCESS  read-only
  2916.     STATUS      current
  2917.     DESCRIPTION
  2918.             "The total number of octets transmitted out of the
  2919.             interface, including framing characters.  This object
  2920.             is a 64-bit version of ifOutOctets.
  2921.  
  2922.             Discontinuities in the value of this counter can occur
  2923.             at re-initialization of the management system, and at
  2924.             other times as indicated by the value of
  2925.             ifCounterDiscontinuityTime."
  2926.     ::= { ifXEntry 10 }
  2927.  
  2928. ifHCOutUcastPkts OBJECT-TYPE
  2929.     SYNTAX      Counter64
  2930.     MAX-ACCESS  read-only
  2931.     STATUS      current
  2932.     DESCRIPTION
  2933.             "The total number of packets that higher-level
  2934.             protocols requested be transmitted, and which were not
  2935.             addressed to a multicast or broadcast address at this
  2936.             sub-layer, including those that were discarded or not
  2937.             sent.  This object is a 64-bit version of
  2938.             ifOutUcastPkts.
  2939.  
  2940.             Discontinuities in the value of this counter can occur
  2941.             at re-initialization of the management system, and at
  2942.  
  2943.  
  2944.  
  2945.  
  2946.  
  2947. Expires April 1998                                        [Page 50]
  2948.  
  2949.  
  2950.  
  2951.  
  2952.  
  2953. Draft                  Interfaces Group MIB           October 1997
  2954.  
  2955.  
  2956.             other times as indicated by the value of
  2957.             ifCounterDiscontinuityTime."
  2958.     ::= { ifXEntry 11 }
  2959.  
  2960. ifHCOutMulticastPkts OBJECT-TYPE
  2961.     SYNTAX      Counter64
  2962.     MAX-ACCESS  read-only
  2963.     STATUS      current
  2964.     DESCRIPTION
  2965.             "The total number of packets that higher-level
  2966.             protocols requested be transmitted, and which were
  2967.             addressed to a multicast address at this sub-layer,
  2968.             including those that were discarded or not sent.  For
  2969.             a MAC layer protocol, this includes both Group and
  2970.             Functional addresses.  This object is a 64-bit version
  2971.             of ifOutMulticastPkts.
  2972.  
  2973.             Discontinuities in the value of this counter can occur
  2974.             at re-initialization of the management system, and at
  2975.             other times as indicated by the value of
  2976.             ifCounterDiscontinuityTime."
  2977.     ::= { ifXEntry 12 }
  2978.  
  2979. ifHCOutBroadcastPkts OBJECT-TYPE
  2980.     SYNTAX      Counter64
  2981.     MAX-ACCESS  read-only
  2982.     STATUS      current
  2983.     DESCRIPTION
  2984.             "The total number of packets that higher-level
  2985.             protocols requested be transmitted, and which were
  2986.             addressed to a broadcast address at this sub-layer,
  2987.             including those that were discarded or not sent.  This
  2988.             object is a 64-bit version of ifOutBroadcastPkts.
  2989.  
  2990.             Discontinuities in the value of this counter can occur
  2991.             at re-initialization of the management system, and at
  2992.             other times as indicated by the value of
  2993.             ifCounterDiscontinuityTime."
  2994.     ::= { ifXEntry 13 }
  2995.  
  2996. ifLinkUpDownTrapEnable  OBJECT-TYPE
  2997.     SYNTAX      INTEGER { enabled(1), disabled(2) }
  2998.     MAX-ACCESS  read-write
  2999.     STATUS      current
  3000.     DESCRIPTION
  3001.  
  3002.  
  3003.  
  3004.  
  3005.  
  3006. Expires April 1998                                        [Page 51]
  3007.  
  3008.  
  3009.  
  3010.  
  3011.  
  3012. Draft                  Interfaces Group MIB           October 1997
  3013.  
  3014.  
  3015.             "Indicates whether linkUp/linkDown traps should be
  3016.             generated for this interface.
  3017.  
  3018.             By default, this object should have the value
  3019.             enabled(1) for interfaces which do not operate on
  3020.             'top' of any other interface (as defined in the
  3021.             ifStackTable), and disabled(2) otherwise."
  3022.     ::= { ifXEntry 14 }
  3023.  
  3024. ifHighSpeed OBJECT-TYPE
  3025.     SYNTAX      Gauge32
  3026.     MAX-ACCESS  read-only
  3027.     STATUS      current
  3028.     DESCRIPTION
  3029.             "An estimate of the interface's current bandwidth in
  3030.             units of 1,000,000 bits per second.  If this object
  3031.             reports a value of `n' then the speed of the interface
  3032.             is somewhere in the range of `n-500,000' to
  3033.             `n+499,999'.  For interfaces which do not vary in
  3034.             bandwidth or for those where no accurate estimation
  3035.             can be made, this object should contain the nominal
  3036.             bandwidth.  For a sub-layer which has no concept of
  3037.             bandwidth, this object should be zero."
  3038.     ::= { ifXEntry 15 }
  3039.  
  3040. ifPromiscuousMode  OBJECT-TYPE
  3041.     SYNTAX      TruthValue
  3042.     MAX-ACCESS  read-write
  3043.     STATUS      current
  3044.     DESCRIPTION
  3045.             "This object has a value of false(2) if this interface
  3046.             only accepts packets/frames that are addressed to this
  3047.             station.  This object has a value of true(1) when the
  3048.             station accepts all packets/frames transmitted on the
  3049.             media.  The value true(1) is only legal on certain
  3050.             types of media.  If legal, setting this object to a
  3051.             value of true(1) may require the interface to be reset
  3052.             before becoming effective.
  3053.  
  3054.             The value of ifPromiscuousMode does not affect the
  3055.             reception of broadcast and multicast packets/frames by
  3056.             the interface."
  3057.     ::= { ifXEntry 16 }
  3058.  
  3059. ifConnectorPresent   OBJECT-TYPE
  3060.  
  3061.  
  3062.  
  3063.  
  3064.  
  3065. Expires April 1998                                        [Page 52]
  3066.  
  3067.  
  3068.  
  3069.  
  3070.  
  3071. Draft                  Interfaces Group MIB           October 1997
  3072.  
  3073.  
  3074.     SYNTAX      TruthValue
  3075.     MAX-ACCESS  read-only
  3076.     STATUS      current
  3077.     DESCRIPTION
  3078.             "This object has the value 'true(1)' if the interface
  3079.             sublayer has a physical connector and the value
  3080.             'false(2)' otherwise."
  3081.     ::= { ifXEntry 17 }
  3082.  
  3083. ifAlias   OBJECT-TYPE
  3084.     SYNTAX      DisplayString (SIZE(0..64))
  3085.     MAX-ACCESS  read-write
  3086.     STATUS      current
  3087.     DESCRIPTION
  3088.             "This object is an 'alias' name for the interface as
  3089.             specified by a network manager, and provides a non-
  3090.             volatile 'handle' for the interface.
  3091.  
  3092.             On the first instantiation of an interface, the value
  3093.             of ifAlias associated with that interface is the
  3094.             zero-length string.  As and when a value is written
  3095.             into an instance of ifAlias through a network
  3096.             management set operation, then the agent must retain
  3097.             the supplied value in the ifAlias instance associated
  3098.             with the same interface for as long as that interface
  3099.             remains instantiated, including across all re-
  3100.             initializations/reboots of the network management
  3101.             system, including those which result in a change of
  3102.             the interface's ifIndex value.
  3103.  
  3104.             An example of the value which a network manager might
  3105.             store in this object for a WAN interface is the
  3106.             (Telco's) circuit number/identifier of the interface.
  3107.  
  3108.             Some agents may support write-access only for
  3109.             interfaces having particular values of ifType.  An
  3110.             agent which supports write access to this object is
  3111.             required to keep the value in non-volatile storage,
  3112.             but it may limit the length of new values depending on
  3113.             how much storage is already occupied by the current
  3114.             values for other interfaces."
  3115.     ::= { ifXEntry 18 }
  3116.  
  3117. ifCounterDiscontinuityTime OBJECT-TYPE
  3118.     SYNTAX      TimeStamp
  3119.  
  3120.  
  3121.  
  3122.  
  3123.  
  3124. Expires April 1998                                        [Page 53]
  3125.  
  3126.  
  3127.  
  3128.  
  3129.  
  3130. Draft                  Interfaces Group MIB           October 1997
  3131.  
  3132.  
  3133.     MAX-ACCESS  read-only
  3134.     STATUS      current
  3135.     DESCRIPTION
  3136.             "The value of sysUpTime on the most recent occasion at
  3137.             which any one or more of this interface's counters
  3138.             suffered a discontinuity.  The relevant counters are
  3139.             the specific instances associated with this interface
  3140.             of any Counter32 or Counter64 object contained in the
  3141.             ifTable or ifXTable.  If no such discontinuities have
  3142.             occurred since the last re-initialization of the local
  3143.             management subsystem, then this object contains a zero
  3144.             value."
  3145.     ::= { ifXEntry 19 }
  3146.  
  3147.  
  3148.  
  3149.  
  3150.  
  3151.  
  3152.  
  3153.  
  3154.  
  3155.  
  3156.  
  3157.  
  3158.  
  3159.  
  3160.  
  3161.  
  3162.  
  3163.  
  3164.  
  3165.  
  3166.  
  3167.  
  3168.  
  3169.  
  3170.  
  3171.  
  3172.  
  3173.  
  3174.  
  3175.  
  3176.  
  3177.  
  3178.  
  3179.  
  3180.  
  3181.  
  3182.  
  3183. Expires April 1998                                        [Page 54]
  3184.  
  3185.  
  3186.  
  3187.  
  3188.  
  3189. Draft                  Interfaces Group MIB           October 1997
  3190.  
  3191.  
  3192. --           The Interface Stack Group
  3193. --
  3194. -- Implementation of this group is mandatory for all systems
  3195. --
  3196.  
  3197. ifStackTable  OBJECT-TYPE
  3198.      SYNTAX        SEQUENCE OF IfStackEntry
  3199.      MAX-ACCESS    not-accessible
  3200.      STATUS        current
  3201.      DESCRIPTION
  3202.             "The table containing information on the relationships
  3203.             between the multiple sub-layers of network interfaces.
  3204.             In particular, it contains information on which sub-
  3205.             layers run 'on top of' which other sub-layers, where
  3206.             each sub-layer corresponds to a conceptual row in the
  3207.             ifTable.  For example, when the sub-layer with ifIndex
  3208.             value x runs over the sub-layer with ifIndex value y,
  3209.             then this table contains:
  3210.  
  3211.               ifStackStatus.x.y=active
  3212.  
  3213.             For each ifIndex value, I, which identifies an active
  3214.             interface, there are always at least two instantiated
  3215.             rows in this table associated with I.  For one of
  3216.             these rows, I is the value of ifStackHigherLayer; for
  3217.             the other, I is the value of ifStackLowerLayer.  (If I
  3218.             is not involved in multiplexing, then these are the
  3219.             only two rows associated with I.)
  3220.  
  3221.             For example, two rows exist even for an interface
  3222.             which has no others stacked on top or below it:
  3223.  
  3224.               ifStackStatus.0.x=active
  3225.               ifStackStatus.x.0=active "
  3226.      ::= { ifMIBObjects 2 }
  3227.  
  3228.  
  3229. ifStackEntry  OBJECT-TYPE
  3230.      SYNTAX        IfStackEntry
  3231.      MAX-ACCESS    not-accessible
  3232.      STATUS        current
  3233.      DESCRIPTION
  3234.             "Information on a particular relationship between two
  3235.             sub-layers, specifying that one sub-layer runs on
  3236.             'top' of the other sub-layer.  Each sub-layer
  3237.  
  3238.  
  3239.  
  3240.  
  3241.  
  3242. Expires April 1998                                        [Page 55]
  3243.  
  3244.  
  3245.  
  3246.  
  3247.  
  3248. Draft                  Interfaces Group MIB           October 1997
  3249.  
  3250.  
  3251.             corresponds to a conceptual row in the ifTable."
  3252.      INDEX { ifStackHigherLayer, ifStackLowerLayer }
  3253.      ::= { ifStackTable 1 }
  3254.  
  3255.  
  3256. IfStackEntry ::=
  3257.     SEQUENCE {
  3258.         ifStackHigherLayer  Integer32,
  3259.         ifStackLowerLayer   Integer32,
  3260.         ifStackStatus       RowStatus
  3261.      }
  3262.  
  3263.  
  3264. ifStackHigherLayer  OBJECT-TYPE
  3265.      SYNTAX        Integer32
  3266.      MAX-ACCESS    not-accessible
  3267.      STATUS        current
  3268.      DESCRIPTION
  3269.             "The value of ifIndex corresponding to the higher
  3270.             sub-layer of the relationship, i.e., the sub-layer
  3271.             which runs on 'top' of the sub-layer identified by the
  3272.             corresponding instance of ifStackLowerLayer.  If there
  3273.             is no higher sub-layer (below the internetwork layer),
  3274.             then this object has the value 0."
  3275.      ::= { ifStackEntry 1 }
  3276.  
  3277.  
  3278. ifStackLowerLayer  OBJECT-TYPE
  3279.      SYNTAX        Integer32
  3280.      MAX-ACCESS    not-accessible
  3281.      STATUS        current
  3282.      DESCRIPTION
  3283.             "The value of ifIndex corresponding to the lower sub-
  3284.             layer of the relationship, i.e., the sub-layer which
  3285.             runs 'below' the sub-layer identified by the
  3286.             corresponding instance of ifStackHigherLayer.  If
  3287.             there is no lower sub-layer, then this object has the
  3288.             value 0."
  3289.      ::= { ifStackEntry 2 }
  3290.  
  3291.  
  3292. ifStackStatus  OBJECT-TYPE
  3293.     SYNTAX         RowStatus
  3294.     MAX-ACCESS     read-create
  3295.     STATUS         current
  3296.  
  3297.  
  3298.  
  3299.  
  3300.  
  3301. Expires April 1998                                        [Page 56]
  3302.  
  3303.  
  3304.  
  3305.  
  3306.  
  3307. Draft                  Interfaces Group MIB           October 1997
  3308.  
  3309.  
  3310.     DESCRIPTION
  3311.             "The status of the relationship between two sub-
  3312.             layers.
  3313.  
  3314.             Changing the value of this object from 'active' to
  3315.             'notInService' or 'destroy' will likely have
  3316.             consequences up and down the interface stack.  Thus,
  3317.             write access to this object is likely to be
  3318.             inappropriate for some types of interfaces, and many
  3319.             implementations will choose not to support write-
  3320.             access for any type of interface."
  3321.     ::= { ifStackEntry 3 }
  3322.  
  3323. ifStackLastChange OBJECT-TYPE
  3324.     SYNTAX         TimeTicks
  3325.     MAX-ACCESS     read-only
  3326.     STATUS         current
  3327.     DESCRIPTION
  3328.             "The value of sysUpTime at the time of the last change
  3329.             of the (whole) interface stack.  A change of the
  3330.             interface stack is defined to be any creation,
  3331.             deletion, or change in value of any instance of
  3332.             ifStackStatus.  If the interface stack has been
  3333.             unchanged since the last re-initialization of the
  3334.             local network management subsystem, then this object
  3335.             contains a zero value."
  3336.     ::= { ifMIBObjects 6 }
  3337.  
  3338.  
  3339. --   Generic Receive Address Table
  3340. --
  3341. -- This group of objects is mandatory for all types of
  3342. -- interfaces which can receive packets/frames addressed to
  3343. -- more than one address.
  3344. --
  3345. -- This table replaces the ifExtnsRcvAddr table.  The main
  3346. -- difference is that this table makes use of the RowStatus
  3347. -- textual convention, while ifExtnsRcvAddr did not.
  3348.  
  3349. ifRcvAddressTable  OBJECT-TYPE
  3350.     SYNTAX      SEQUENCE OF IfRcvAddressEntry
  3351.     MAX-ACCESS  not-accessible
  3352.     STATUS      current
  3353.     DESCRIPTION
  3354.             "This table contains an entry for each address
  3355.  
  3356.  
  3357.  
  3358.  
  3359.  
  3360. Expires April 1998                                        [Page 57]
  3361.  
  3362.  
  3363.  
  3364.  
  3365.  
  3366. Draft                  Interfaces Group MIB           October 1997
  3367.  
  3368.  
  3369.             (broadcast, multicast, or uni-cast) for which the
  3370.             system will receive packets/frames on a particular
  3371.             interface, except as follows:
  3372.  
  3373.             - for an interface operating in promiscuous mode,
  3374.             entries are only required for those addresses for
  3375.             which the system would receive frames were it not
  3376.             operating in promiscuous mode.
  3377.  
  3378.             - for 802.5 functional addresses, only one entry is
  3379.             required, for the address which has the functional
  3380.             address bit ANDed with the bit mask of all functional
  3381.             addresses for which the interface will accept frames.
  3382.  
  3383.             A system is normally able to use any unicast address
  3384.             which corresponds to an entry in this table as a
  3385.             source address."
  3386.     ::= { ifMIBObjects 4 }
  3387.  
  3388. ifRcvAddressEntry  OBJECT-TYPE
  3389.     SYNTAX      IfRcvAddressEntry
  3390.     MAX-ACCESS  not-accessible
  3391.     STATUS      current
  3392.     DESCRIPTION
  3393.             "A list of objects identifying an address for which
  3394.             the system will accept packets/frames on the
  3395.             particular interface identified by the index value
  3396.             ifIndex."
  3397.     INDEX  { ifIndex, ifRcvAddressAddress }
  3398.     ::= { ifRcvAddressTable 1 }
  3399.  
  3400. IfRcvAddressEntry ::=
  3401.     SEQUENCE {
  3402.         ifRcvAddressAddress   PhysAddress,
  3403.         ifRcvAddressStatus    RowStatus,
  3404.         ifRcvAddressType      INTEGER
  3405.     }
  3406.  
  3407. ifRcvAddressAddress OBJECT-TYPE
  3408.     SYNTAX      PhysAddress
  3409.     MAX-ACCESS  not-accessible
  3410.     STATUS      current
  3411.     DESCRIPTION
  3412.             "An address for which the system will accept
  3413.             packets/frames on this entry's interface."
  3414.  
  3415.  
  3416.  
  3417.  
  3418.  
  3419. Expires April 1998                                        [Page 58]
  3420.  
  3421.  
  3422.  
  3423.  
  3424.  
  3425. Draft                  Interfaces Group MIB           October 1997
  3426.  
  3427.  
  3428.     ::= { ifRcvAddressEntry 1 }
  3429.  
  3430. ifRcvAddressStatus OBJECT-TYPE
  3431.     SYNTAX      RowStatus
  3432.     MAX-ACCESS  read-create
  3433.     STATUS      current
  3434.     DESCRIPTION
  3435.             "This object is used to create and delete rows in the
  3436.             ifRcvAddressTable."
  3437.  
  3438.     ::= { ifRcvAddressEntry 2 }
  3439.  
  3440. ifRcvAddressType OBJECT-TYPE
  3441.     SYNTAX      INTEGER {
  3442.                     other(1),
  3443.                     volatile(2),
  3444.                     nonVolatile(3)
  3445.                 }
  3446.  
  3447.     MAX-ACCESS  read-create
  3448.     STATUS      current
  3449.     DESCRIPTION
  3450.             "This object has the value nonVolatile(3) for those
  3451.             entries in the table which are valid and will not be
  3452.             deleted by the next restart of the managed system.
  3453.             Entries having the value volatile(2) are valid and
  3454.             exist, but have not been saved, so that will not exist
  3455.             after the next restart of the managed system.  Entries
  3456.             having the value other(1) are valid and exist but are
  3457.             not classified as to whether they will continue to
  3458.             exist after the next restart."
  3459.  
  3460.     DEFVAL  { volatile }
  3461.     ::= { ifRcvAddressEntry 3 }
  3462.  
  3463.  
  3464.  
  3465.  
  3466.  
  3467.  
  3468.  
  3469.  
  3470.  
  3471.  
  3472.  
  3473.  
  3474.  
  3475.  
  3476.  
  3477.  
  3478. Expires April 1998                                        [Page 59]
  3479.  
  3480.  
  3481.  
  3482.  
  3483.  
  3484. Draft                  Interfaces Group MIB           October 1997
  3485.  
  3486.  
  3487. -- definition of interface-related traps.
  3488.  
  3489. linkDown NOTIFICATION-TYPE
  3490.         OBJECTS { ifIndex, ifAdminStatus, ifOperStatus }
  3491.         STATUS  current
  3492.         DESCRIPTION
  3493.             "A linkDown trap signifies that the SNMPv2 entity,
  3494.             acting in an agent role, has detected that the
  3495.             ifOperStatus object for one of its communication links
  3496.             is about to enter the down state from some other state
  3497.             (but not from the notPresent state).  This other state
  3498.             is indicated by the included value of ifOperStatus."
  3499.     ::= { snmpTraps 3 }
  3500.  
  3501. linkUp NOTIFICATION-TYPE
  3502.         OBJECTS { ifIndex, ifAdminStatus, ifOperStatus }
  3503.         STATUS  current
  3504.         DESCRIPTION
  3505.             "A linkDown trap signifies that the SNMPv2 entity,
  3506.             acting in an agent role, has detected that the
  3507.             ifOperStatus object for one of its communication links
  3508.             left the down state and transitioned into some other
  3509.             state (but not into the notPresent state).  This other
  3510.             state is indicated by the included value of
  3511.             ifOperStatus."
  3512.     ::= { snmpTraps 4 }
  3513.  
  3514.  
  3515.  
  3516.  
  3517.  
  3518.  
  3519.  
  3520.  
  3521.  
  3522.  
  3523.  
  3524.  
  3525.  
  3526.  
  3527.  
  3528.  
  3529.  
  3530.  
  3531.  
  3532.  
  3533.  
  3534.  
  3535.  
  3536.  
  3537. Expires April 1998                                        [Page 60]
  3538.  
  3539.  
  3540.  
  3541.  
  3542.  
  3543. Draft                  Interfaces Group MIB           October 1997
  3544.  
  3545.  
  3546. -- conformance information
  3547.  
  3548. ifConformance OBJECT IDENTIFIER ::= { ifMIB 2 }
  3549.  
  3550. ifGroups      OBJECT IDENTIFIER ::= { ifConformance 1 }
  3551. ifCompliances OBJECT IDENTIFIER ::= { ifConformance 2 }
  3552.  
  3553.  
  3554. -- compliance statements
  3555.  
  3556. ifCompliance2 MODULE-COMPLIANCE
  3557.     STATUS  current
  3558.     DESCRIPTION
  3559.             "The compliance statement for SNMPv2 entities which
  3560.             have network interfaces."
  3561.  
  3562.     MODULE  -- this module
  3563.         MANDATORY-GROUPS { ifGeneralInformationGroup, ifStackGroup2,
  3564.                            ifCounterDiscontinuityGroup }
  3565.  
  3566.         GROUP       ifFixedLengthGroup
  3567.         DESCRIPTION
  3568.             "This group is mandatory for all network interfaces
  3569.             which are character-oriented or transmit data in
  3570.             fixed-length transmission units."
  3571.  
  3572.         GROUP       ifHCFixedLengthGroup
  3573.         DESCRIPTION
  3574.             "This group is mandatory only for those network
  3575.             interfaces which are character-oriented or transmit
  3576.             data in fixed-length transmission units, and for which
  3577.             the value of the corresponding instance of ifSpeed is
  3578.             greater than 20,000,000 bits/second."
  3579.  
  3580.         GROUP       ifPacketGroup
  3581.         DESCRIPTION
  3582.             "This group is mandatory for all network interfaces
  3583.             which are packet-oriented."
  3584.  
  3585.         GROUP       ifHCPacketGroup
  3586.         DESCRIPTION
  3587.             "This group is mandatory only for those network
  3588.             interfaces which are packet-oriented and for which the
  3589.             value of the corresponding instance of ifSpeed is
  3590.             greater than 650,000,000 bits/second."
  3591.  
  3592.  
  3593.  
  3594.  
  3595.  
  3596. Expires April 1998                                        [Page 61]
  3597.  
  3598.  
  3599.  
  3600.  
  3601.  
  3602. Draft                  Interfaces Group MIB           October 1997
  3603.  
  3604.  
  3605.         GROUP       ifRcvAddressGroup
  3606.         DESCRIPTION
  3607.             "The applicability of this group MUST be defined by
  3608.             the media-specific MIBs.  Media-specific MIBs must
  3609.             define the exact meaning, use, and semantics of the
  3610.             addresses in this group."
  3611.  
  3612.         OBJECT      ifLinkUpDownTrapEnable
  3613.         MIN-ACCESS  read-only
  3614.         DESCRIPTION
  3615.             "Write access is not required."
  3616.  
  3617.         OBJECT      ifPromiscuousMode
  3618.         MIN-ACCESS  read-only
  3619.         DESCRIPTION
  3620.             "Write access is not required."
  3621.  
  3622.         OBJECT      ifStackStatus
  3623.         SYNTAX      INTEGER { active(1) } -- subset of RowStatus
  3624.         MIN-ACCESS  read-only
  3625.         DESCRIPTION
  3626.             "Write access is not required, and only one of the six
  3627.             enumerated values for the RowStatus textual convention
  3628.             need be supported, specifically: active(1)."
  3629.  
  3630.         OBJECT       ifAdminStatus
  3631.         SYNTAX       INTEGER { up(1), down(2) }
  3632.         MIN-ACCESS   read-only
  3633.         DESCRIPTION
  3634.             "Write access is not required, nor is support for the
  3635.             value testing(3)."
  3636.  
  3637.         OBJECT       ifAlias
  3638.         MIN-ACCESS   read-only
  3639.         DESCRIPTION
  3640.             "Write access is not required."
  3641.  
  3642.     ::= { ifCompliances 2 }
  3643.  
  3644.  
  3645.  
  3646.  
  3647.  
  3648.  
  3649.  
  3650.  
  3651.  
  3652.  
  3653.  
  3654.  
  3655. Expires April 1998                                        [Page 62]
  3656.  
  3657.  
  3658.  
  3659.  
  3660.  
  3661. Draft                  Interfaces Group MIB           October 1997
  3662.  
  3663.  
  3664. -- units of conformance
  3665.  
  3666. ifGeneralInformationGroup    OBJECT-GROUP
  3667.     OBJECTS { ifIndex, ifDescr, ifType, ifSpeed, ifPhysAddress,
  3668.               ifAdminStatus, ifOperStatus, ifLastChange,
  3669.               ifLinkUpDownTrapEnable, ifConnectorPresent,
  3670.               ifHighSpeed, ifName, ifNumber, ifAlias,
  3671.               ifTableLastChange }
  3672.     STATUS  current
  3673.     DESCRIPTION
  3674.             "A collection of objects providing information
  3675.             applicable to all network interfaces."
  3676.     ::= { ifGroups 10 }
  3677.  
  3678. -- the following five groups are mutually exclusive; at most
  3679. -- one of these groups is implemented for any interface
  3680.  
  3681. ifFixedLengthGroup    OBJECT-GROUP
  3682.     OBJECTS { ifInOctets, ifOutOctets, ifInUnknownProtos,
  3683.               ifInErrors, ifOutErrors }
  3684.     STATUS  current
  3685.     DESCRIPTION
  3686.             "A collection of objects providing information
  3687.             specific to non-high speed (non-high speed interfaces
  3688.             transmit and receive at speeds less than or equal to
  3689.             20,000,000 bits/second) character-oriented or fixed-
  3690.             length-transmission network interfaces."
  3691.     ::= { ifGroups 2 }
  3692.  
  3693. ifHCFixedLengthGroup    OBJECT-GROUP
  3694.     OBJECTS { ifHCInOctets, ifHCOutOctets,
  3695.               ifInOctets, ifOutOctets, ifInUnknownProtos,
  3696.               ifInErrors, ifOutErrors }
  3697.     STATUS  current
  3698.     DESCRIPTION
  3699.             "A collection of objects providing information
  3700.             specific to high speed (greater than 20,000,000
  3701.             bits/second) character-oriented or fixed-length-
  3702.             transmission network interfaces."
  3703.     ::= { ifGroups 3 }
  3704.  
  3705. ifPacketGroup    OBJECT-GROUP
  3706.     OBJECTS { ifInOctets, ifOutOctets, ifInUnknownProtos,
  3707.               ifInErrors, ifOutErrors,
  3708.               ifMtu, ifInUcastPkts, ifInMulticastPkts,
  3709.  
  3710.  
  3711.  
  3712.  
  3713.  
  3714. Expires April 1998                                        [Page 63]
  3715.  
  3716.  
  3717.  
  3718.  
  3719.  
  3720. Draft                  Interfaces Group MIB           October 1997
  3721.  
  3722.  
  3723.               ifInBroadcastPkts, ifInDiscards,
  3724.               ifOutUcastPkts, ifOutMulticastPkts,
  3725.               ifOutBroadcastPkts, ifOutDiscards,
  3726.               ifPromiscuousMode }
  3727.     STATUS  current
  3728.     DESCRIPTION
  3729.             "A collection of objects providing information
  3730.             specific to non-high speed (non-high speed interfaces
  3731.             transmit and receive at speeds less than or equal to
  3732.             20,000,000 bits/second) packet-oriented network
  3733.             interfaces."
  3734.     ::= { ifGroups 4 }
  3735.  
  3736. ifHCPacketGroup    OBJECT-GROUP
  3737.     OBJECTS { ifHCInOctets, ifHCOutOctets,
  3738.               ifInOctets, ifOutOctets, ifInUnknownProtos,
  3739.               ifInErrors, ifOutErrors,
  3740.               ifMtu, ifInUcastPkts, ifInMulticastPkts,
  3741.               ifInBroadcastPkts, ifInDiscards,
  3742.               ifOutUcastPkts, ifOutMulticastPkts,
  3743.               ifOutBroadcastPkts, ifOutDiscards,
  3744.               ifPromiscuousMode }
  3745.     STATUS  current
  3746.     DESCRIPTION
  3747.             "A collection of objects providing information
  3748.             specific to high speed (greater than 20,000,000
  3749.             bits/second but less than or equal to 650,000,000
  3750.             bits/second) packet-oriented network interfaces."
  3751.     ::= { ifGroups 5 }
  3752.  
  3753. ifVHCPacketGroup    OBJECT-GROUP
  3754.     OBJECTS { ifHCInUcastPkts, ifHCInMulticastPkts,
  3755.               ifHCInBroadcastPkts, ifHCOutUcastPkts,
  3756.               ifHCOutMulticastPkts, ifHCOutBroadcastPkts,
  3757.               ifHCInOctets, ifHCOutOctets,
  3758.               ifInOctets, ifOutOctets, ifInUnknownProtos,
  3759.               ifInErrors, ifOutErrors,
  3760.               ifMtu, ifInUcastPkts, ifInMulticastPkts,
  3761.               ifInBroadcastPkts, ifInDiscards,
  3762.               ifOutUcastPkts, ifOutMulticastPkts,
  3763.               ifOutBroadcastPkts, ifOutDiscards,
  3764.               ifPromiscuousMode }
  3765.     STATUS  current
  3766.     DESCRIPTION
  3767.             "A collection of objects providing information
  3768.  
  3769.  
  3770.  
  3771.  
  3772.  
  3773. Expires April 1998                                        [Page 64]
  3774.  
  3775.  
  3776.  
  3777.  
  3778.  
  3779. Draft                  Interfaces Group MIB           October 1997
  3780.  
  3781.  
  3782.             specific to higher speed (greater than 650,000,000
  3783.             bits/second) packet-oriented network interfaces."
  3784.     ::= { ifGroups 6 }
  3785.  
  3786. ifRcvAddressGroup    OBJECT-GROUP
  3787.     OBJECTS { ifRcvAddressStatus, ifRcvAddressType }
  3788.     STATUS  current
  3789.     DESCRIPTION
  3790.             "A collection of objects providing information on the
  3791.             multiple addresses which an interface receives."
  3792.     ::= { ifGroups 7 }
  3793.  
  3794. ifStackGroup2    OBJECT-GROUP
  3795.     OBJECTS { ifStackStatus, ifStackLastChange }
  3796.     STATUS  current
  3797.     DESCRIPTION
  3798.             "A collection of objects providing information on the
  3799.             layering of MIB-II interfaces."
  3800.     ::= { ifGroups 11 }
  3801.  
  3802. ifCounterDiscontinuityGroup  OBJECT-GROUP
  3803.     OBJECTS { ifCounterDiscontinuityTime }
  3804.     STATUS  current
  3805.     DESCRIPTION
  3806.             "A collection of objects providing information
  3807.             specific to interface counter discontinuities."
  3808.     ::= { ifGroups 13 }
  3809.  
  3810.  
  3811.  
  3812.  
  3813.  
  3814.  
  3815.  
  3816.  
  3817.  
  3818.  
  3819.  
  3820.  
  3821.  
  3822.  
  3823.  
  3824.  
  3825.  
  3826.  
  3827.  
  3828.  
  3829.  
  3830.  
  3831.  
  3832. Expires April 1998                                        [Page 65]
  3833.  
  3834.  
  3835.  
  3836.  
  3837.  
  3838. Draft                  Interfaces Group MIB           October 1997
  3839.  
  3840.  
  3841. -- Deprecated Definitions - Objects
  3842.  
  3843.  
  3844. --
  3845. --    The Interface Test Table
  3846. --
  3847. -- This group of objects is optional.  However, a media-specific
  3848. -- MIB may make implementation of this group mandatory.
  3849. --
  3850. -- This table replaces the ifExtnsTestTable
  3851. --
  3852.  
  3853. ifTestTable   OBJECT-TYPE
  3854.     SYNTAX      SEQUENCE OF IfTestEntry
  3855.     MAX-ACCESS  not-accessible
  3856.     STATUS      deprecated
  3857.     DESCRIPTION
  3858.             "This table contains one entry per interface.  It
  3859.             defines objects which allow a network manager to
  3860.             instruct an agent to test an interface for various
  3861.             faults.  Tests for an interface are defined in the
  3862.             media-specific MIB for that interface.  After invoking
  3863.             a test, the object ifTestResult can be read to
  3864.             determine the outcome.  If an agent can not perform
  3865.             the test, ifTestResult is set to so indicate.  The
  3866.             object ifTestCode can be used to provide further
  3867.             test-specific or interface-specific (or even
  3868.             enterprise-specific) information concerning the
  3869.             outcome of the test.  Only one test can be in progress
  3870.             on each interface at any one time.  If one test is in
  3871.             progress when another test is invoked, the second test
  3872.             is rejected.  Some agents may reject a test when a
  3873.             prior test is active on another interface.
  3874.  
  3875.             Before starting a test, a manager-station must first
  3876.             obtain 'ownership' of the entry in the ifTestTable for
  3877.             the interface to be tested.  This is accomplished with
  3878.             the ifTestId and ifTestStatus objects as follows:
  3879.  
  3880.          try_again:
  3881.              get (ifTestId, ifTestStatus)
  3882.              while (ifTestStatus != notInUse)
  3883.                  /*
  3884.                   * Loop while a test is running or some other
  3885.                   * manager is configuring a test.
  3886.  
  3887.  
  3888.  
  3889.  
  3890.  
  3891. Expires April 1998                                        [Page 66]
  3892.  
  3893.  
  3894.  
  3895.  
  3896.  
  3897. Draft                  Interfaces Group MIB           October 1997
  3898.  
  3899.  
  3900.                   */
  3901.                  short delay
  3902.                  get (ifTestId, ifTestStatus)
  3903.              }
  3904.  
  3905.              /*
  3906.               * Is not being used right now -- let's compete
  3907.               * to see who gets it.
  3908.               */
  3909.              lock_value = ifTestId
  3910.  
  3911.              if ( set(ifTestId = lock_value, ifTestStatus = inUse,
  3912.                       ifTestOwner = 'my-IP-address') == FAILURE)
  3913.                  /*
  3914.                   * Another manager got the ifTestEntry -- go
  3915.                   * try again
  3916.                   */
  3917.                  goto try_again;
  3918.  
  3919.              /*
  3920.               * I have the lock
  3921.               */
  3922.              set up any test parameters.
  3923.  
  3924.              /*
  3925.               * This starts the test
  3926.               */
  3927.              set(ifTestType = test_to_run);
  3928.  
  3929.              wait for test completion by polling ifTestResult
  3930.  
  3931.              when test completes, agent sets ifTestResult
  3932.                   agent also sets ifTestStatus = 'notInUse'
  3933.  
  3934.              retrieve any additional test results, and ifTestId
  3935.  
  3936.              if (ifTestId == lock_value+1) results are valid
  3937.  
  3938.            A manager station first retrieves the value of the
  3939.            appropriate ifTestId and ifTestStatus objects,
  3940.            periodically repeating the retrieval if necessary,
  3941.            until the value of ifTestStatus is 'notInUse'.  The
  3942.            manager station then tries to set the same ifTestId
  3943.            object to the value it just retrieved, the same
  3944.            ifTestStatus object to 'inUse', and the corresponding
  3945.  
  3946.  
  3947.  
  3948.  
  3949.  
  3950. Expires April 1998                                        [Page 67]
  3951.  
  3952.  
  3953.  
  3954.  
  3955.  
  3956. Draft                  Interfaces Group MIB           October 1997
  3957.  
  3958.  
  3959.            ifTestOwner object to a value indicating itself.  If
  3960.            the set operation succeeds then the manager has
  3961.            obtained ownership of the ifTestEntry, and the value of
  3962.            the ifTestId object is incremented by the agent (per
  3963.            the semantics of TestAndIncr).  Failure of the set
  3964.            operation indicates that some other manager has
  3965.            obtained ownership of the ifTestEntry.
  3966.  
  3967.            Once ownership is obtained, any test parameters can be
  3968.            setup, and then the test is initiated by setting
  3969.            ifTestType.  On completion of the test, the agent sets
  3970.            ifTestStatus to 'notInUse'.  Once this occurs, the
  3971.            manager can retrieve the results.  In the (rare) event
  3972.            that the invocation of tests by two network managers
  3973.            were to overlap, then there would be a possibility that
  3974.            the first test's results might be overwritten by the
  3975.            second test's results prior to the first results being
  3976.            read.  This unlikely circumstance can be detected by a
  3977.            network manager retrieving ifTestId at the same time as
  3978.            retrieving the test results, and ensuring that the
  3979.            results are for the desired request.
  3980.  
  3981.            If ifTestType is not set within an abnormally long
  3982.            period of time after ownership is obtained, the agent
  3983.            should time-out the manager, and reset the value of the
  3984.            ifTestStatus object back to 'notInUse'.  It is
  3985.            suggested that this time-out period be 5 minutes.
  3986.  
  3987.            In general, a management station must not retransmit a
  3988.            request to invoke a test for which it does not receive
  3989.            a response; instead, it properly inspects an agent's
  3990.            MIB to determine if the invocation was successful.
  3991.            Only if the invocation was unsuccessful, is the
  3992.            invocation request retransmitted.
  3993.  
  3994.            Some tests may require the interface to be taken off-
  3995.            line in order to execute them, or may even require the
  3996.            agent to reboot after completion of the test.  In these
  3997.            circumstances, communication with the management
  3998.            station invoking the test may be lost until after
  3999.            completion of the test.  An agent is not required to
  4000.            support such tests.  However, if such tests are
  4001.            supported, then the agent should make every effort to
  4002.            transmit a response to the request which invoked the
  4003.            test prior to losing communication.  When the agent is
  4004.  
  4005.  
  4006.  
  4007.  
  4008.  
  4009. Expires April 1998                                        [Page 68]
  4010.  
  4011.  
  4012.  
  4013.  
  4014.  
  4015. Draft                  Interfaces Group MIB           October 1997
  4016.  
  4017.  
  4018.            restored to normal service, the results of the test are
  4019.            properly made available in the appropriate objects.
  4020.            Note that this requires that the ifIndex value assigned
  4021.            to an interface must be unchanged even if the test
  4022.            causes a reboot.  An agent must reject any test for
  4023.            which it cannot, perhaps due to resource constraints,
  4024.            make available at least the minimum amount of
  4025.            information after that test completes."
  4026.     ::= { ifMIBObjects 3 }
  4027.  
  4028. ifTestEntry OBJECT-TYPE
  4029.     SYNTAX       IfTestEntry
  4030.     MAX-ACCESS   not-accessible
  4031.     STATUS       deprecated
  4032.     DESCRIPTION
  4033.             "An entry containing objects for invoking tests on an
  4034.             interface."
  4035.     AUGMENTS  { ifEntry }
  4036.     ::= { ifTestTable 1 }
  4037.  
  4038. IfTestEntry ::=
  4039.     SEQUENCE {
  4040.         ifTestId           TestAndIncr,
  4041.         ifTestStatus       INTEGER,
  4042.         ifTestType         AutonomousType,
  4043.         ifTestResult       INTEGER,
  4044.         ifTestCode         OBJECT IDENTIFIER,
  4045.         ifTestOwner        OwnerString
  4046.     }
  4047.  
  4048. ifTestId         OBJECT-TYPE
  4049.     SYNTAX       TestAndIncr
  4050.     MAX-ACCESS   read-write
  4051.     STATUS       deprecated
  4052.     DESCRIPTION
  4053.             "This object identifies the current invocation of the
  4054.             interface's test."
  4055.     ::= { ifTestEntry 1 }
  4056.  
  4057. ifTestStatus     OBJECT-TYPE
  4058.     SYNTAX       INTEGER { notInUse(1), inUse(2) }
  4059.     MAX-ACCESS   read-write
  4060.     STATUS       deprecated
  4061.     DESCRIPTION
  4062.             "This object indicates whether or not some manager
  4063.  
  4064.  
  4065.  
  4066.  
  4067.  
  4068. Expires April 1998                                        [Page 69]
  4069.  
  4070.  
  4071.  
  4072.  
  4073.  
  4074. Draft                  Interfaces Group MIB           October 1997
  4075.  
  4076.  
  4077.             currently has the necessary 'ownership' required to
  4078.             invoke a test on this interface.  A write to this
  4079.             object is only successful when it changes its value
  4080.             from 'notInUse(1)' to 'inUse(2)'.  After completion of
  4081.             a test, the agent resets the value back to
  4082.             'notInUse(1)'."
  4083.     ::= { ifTestEntry 2 }
  4084.  
  4085. ifTestType       OBJECT-TYPE
  4086.     SYNTAX       AutonomousType
  4087.     MAX-ACCESS   read-write
  4088.     STATUS       deprecated
  4089.     DESCRIPTION
  4090.             "A control variable used to start and stop operator-
  4091.             initiated interface tests.  Most OBJECT IDENTIFIER
  4092.             values assigned to tests are defined elsewhere, in
  4093.             association with specific types of interface.
  4094.             However, this document assigns a value for a full-
  4095.             duplex loopback test, and defines the special meanings
  4096.             of the subject identifier:
  4097.  
  4098.                 noTest  OBJECT IDENTIFIER ::= { 0 0 }
  4099.  
  4100.             When the value noTest is written to this object, no
  4101.             action is taken unless a test is in progress, in which
  4102.             case the test is aborted.  Writing any other value to
  4103.             this object is only valid when no test is currently in
  4104.             progress, in which case the indicated test is
  4105.             initiated.
  4106.  
  4107.             When read, this object always returns the most recent
  4108.             value that ifTestType was set to.  If it has not been
  4109.             set since the last initialization of the network
  4110.             management subsystem on the agent, a value of noTest
  4111.             is returned."
  4112.     ::= { ifTestEntry 3 }
  4113.  
  4114. ifTestResult  OBJECT-TYPE
  4115.     SYNTAX       INTEGER {
  4116.                      none(1),          -- no test yet requested
  4117.                      success(2),
  4118.                      inProgress(3),
  4119.                      notSupported(4),
  4120.                      unAbleToRun(5),   -- due to state of system
  4121.                      aborted(6),
  4122.  
  4123.  
  4124.  
  4125.  
  4126.  
  4127. Expires April 1998                                        [Page 70]
  4128.  
  4129.  
  4130.  
  4131.  
  4132.  
  4133. Draft                  Interfaces Group MIB           October 1997
  4134.  
  4135.  
  4136.                      failed(7)
  4137.                  }
  4138.     MAX-ACCESS   read-only
  4139.     STATUS       deprecated
  4140.     DESCRIPTION
  4141.             "This object contains the result of the most recently
  4142.             requested test, or the value none(1) if no tests have
  4143.             been requested since the last reset.  Note that this
  4144.             facility provides no provision for saving the results
  4145.             of one test when starting another, as could be
  4146.             required if used by multiple managers concurrently."
  4147.     ::= { ifTestEntry 4 }
  4148.  
  4149. ifTestCode  OBJECT-TYPE
  4150.     SYNTAX       OBJECT IDENTIFIER
  4151.     MAX-ACCESS   read-only
  4152.     STATUS       deprecated
  4153.     DESCRIPTION
  4154.             "This object contains a code which contains more
  4155.             specific information on the test result, for example
  4156.             an error-code after a failed test.  Error codes and
  4157.             other values this object may take are specific to the
  4158.             type of interface and/or test.  The value may have the
  4159.             semantics of either the AutonomousType or
  4160.             InstancePointer textual conventions as defined in RFC
  4161.             1903.  The identifier:
  4162.  
  4163.                 testCodeUnknown  OBJECT IDENTIFIER ::= { 0 0 }
  4164.  
  4165.             is defined for use if no additional result code is
  4166.             available."
  4167.     ::= { ifTestEntry 5 }
  4168.  
  4169. ifTestOwner      OBJECT-TYPE
  4170.     SYNTAX       OwnerString
  4171.     MAX-ACCESS   read-write
  4172.     STATUS       deprecated
  4173.     DESCRIPTION
  4174.             "The entity which currently has the 'ownership'
  4175.             required to invoke a test on this interface."
  4176.     ::= { ifTestEntry 6 }
  4177.  
  4178.  
  4179.  
  4180.  
  4181.  
  4182.  
  4183.  
  4184.  
  4185.  
  4186. Expires April 1998                                        [Page 71]
  4187.  
  4188.  
  4189.  
  4190.  
  4191.  
  4192. Draft                  Interfaces Group MIB           October 1997
  4193.  
  4194.  
  4195. -- Deprecated Definitions - Groups
  4196.  
  4197.  
  4198. ifGeneralGroup    OBJECT-GROUP
  4199.     OBJECTS { ifDescr, ifType, ifSpeed, ifPhysAddress,
  4200.               ifAdminStatus, ifOperStatus, ifLastChange,
  4201.               ifLinkUpDownTrapEnable, ifConnectorPresent,
  4202.               ifHighSpeed, ifName }
  4203.     STATUS  deprecated
  4204.     DESCRIPTION
  4205.             "A collection of objects deprecated in favour of
  4206.             ifGeneralInformationGroup."
  4207.     ::= { ifGroups 1 }
  4208.  
  4209.  
  4210. ifTestGroup    OBJECT-GROUP
  4211.     OBJECTS { ifTestId, ifTestStatus, ifTestType,
  4212.               ifTestResult, ifTestCode, ifTestOwner }
  4213.     STATUS  deprecated
  4214.     DESCRIPTION
  4215.             "A collection of objects providing the ability to
  4216.             invoke tests on an interface."
  4217.     ::= { ifGroups 8 }
  4218.  
  4219.  
  4220. ifStackGroup    OBJECT-GROUP
  4221.     OBJECTS { ifStackStatus }
  4222.     STATUS  deprecated
  4223.     DESCRIPTION
  4224.             "The previous collection of objects providing
  4225.             information on the layering of MIB-II interfaces."
  4226.     ::= { ifGroups 9 }
  4227.  
  4228.  
  4229. ifOldObjectsGroup    OBJECT-GROUP
  4230.     OBJECTS { ifInNUcastPkts, ifOutNUcastPkts,
  4231.               ifOutQLen, ifSpecific }
  4232.     STATUS  deprecated
  4233.     DESCRIPTION
  4234.             "The collection of objects deprecated from the
  4235.             original MIB-II interfaces group."
  4236.     ::= { ifGroups 12 }
  4237.  
  4238.  
  4239. -- Deprecated Definitions - Compliance
  4240.  
  4241.  
  4242.  
  4243.  
  4244.  
  4245. Expires April 1998                                        [Page 72]
  4246.  
  4247.  
  4248.  
  4249.  
  4250.  
  4251. Draft                  Interfaces Group MIB           October 1997
  4252.  
  4253.  
  4254. ifCompliance MODULE-COMPLIANCE
  4255.     STATUS  deprecated
  4256.     DESCRIPTION
  4257.             "The previous compliance statement for SNMPv2 entities
  4258.             which have network interfaces."
  4259.  
  4260.     MODULE  -- this module
  4261.         MANDATORY-GROUPS { ifGeneralGroup, ifStackGroup }
  4262.  
  4263.         GROUP       ifFixedLengthGroup
  4264.         DESCRIPTION
  4265.             "This group is mandatory for all network interfaces
  4266.             which are character-oriented or transmit data in
  4267.             fixed-length transmission units."
  4268.  
  4269.         GROUP       ifHCFixedLengthGroup
  4270.         DESCRIPTION
  4271.             "This group is mandatory only for those network
  4272.             interfaces which are character-oriented or transmit
  4273.             data in fixed-length transmission units, and for which
  4274.             the value of the corresponding instance of ifSpeed is
  4275.             greater than 20,000,000 bits/second."
  4276.  
  4277.         GROUP       ifPacketGroup
  4278.         DESCRIPTION
  4279.             "This group is mandatory for all network interfaces
  4280.             which are packet-oriented."
  4281.  
  4282.         GROUP       ifHCPacketGroup
  4283.         DESCRIPTION
  4284.             "This group is mandatory only for those network
  4285.             interfaces which are packet-oriented and for which the
  4286.             value of the corresponding instance of ifSpeed is
  4287.             greater than 650,000,000 bits/second."
  4288.  
  4289.         GROUP       ifTestGroup
  4290.         DESCRIPTION
  4291.             "This group is optional.  Media-specific MIBs which
  4292.             require interface tests are strongly encouraged to use
  4293.             this group for invoking tests and reporting results.
  4294.             A medium specific MIB which has mandatory tests may
  4295.             make implementation of this group mandatory."
  4296.  
  4297.         GROUP       ifRcvAddressGroup
  4298.         DESCRIPTION
  4299.  
  4300.  
  4301.  
  4302.  
  4303.  
  4304. Expires April 1998                                        [Page 73]
  4305.  
  4306.  
  4307.  
  4308.  
  4309.  
  4310. Draft                  Interfaces Group MIB           October 1997
  4311.  
  4312.  
  4313.             "The applicability of this group MUST be defined by
  4314.             the media-specific MIBs.  Media-specific MIBs must
  4315.             define the exact meaning, use, and semantics of the
  4316.             addresses in this group."
  4317.  
  4318.         OBJECT      ifLinkUpDownTrapEnable
  4319.         MIN-ACCESS  read-only
  4320.         DESCRIPTION
  4321.             "Write access is not required."
  4322.  
  4323.         OBJECT      ifPromiscuousMode
  4324.         MIN-ACCESS  read-only
  4325.         DESCRIPTION
  4326.             "Write access is not required."
  4327.  
  4328.         OBJECT      ifStackStatus
  4329.         SYNTAX      INTEGER { active(1) } -- subset of RowStatus
  4330.         MIN-ACCESS  read-only
  4331.         DESCRIPTION
  4332.             "Write access is not required, and only one of the six
  4333.             enumerated values for the RowStatus textual convention
  4334.             need be supported, specifically: active(1)."
  4335.  
  4336.         OBJECT       ifAdminStatus
  4337.         SYNTAX       INTEGER { up(1), down(2) }
  4338.         MIN-ACCESS   read-only
  4339.         DESCRIPTION
  4340.             "Write access is not required, nor is support for the
  4341.             value testing(3)."
  4342.     ::= { ifCompliances 1 }
  4343.  
  4344. END
  4345.  
  4346.  
  4347.  
  4348.  
  4349.  
  4350.  
  4351.  
  4352.  
  4353.  
  4354.  
  4355.  
  4356.  
  4357.  
  4358.  
  4359.  
  4360.  
  4361.  
  4362.  
  4363. Expires April 1998                                        [Page 74]
  4364.  
  4365.  
  4366.  
  4367.  
  4368.  
  4369. Draft                  Interfaces Group MIB           October 1997
  4370.  
  4371.  
  4372. 7.  Acknowledgements
  4373.  
  4374. This memo has been produced by the IETF's Interfaces MIB working-
  4375. group.
  4376.  
  4377. The original proposal evolved from conversations and discussions
  4378. with many people, including at least the following: Fred Baker,
  4379. Ted Brunner, Chuck Davin, Jeremy Greene, Marshall Rose, Kaj
  4380. Tesink, and Dean Throop.
  4381.  
  4382.  
  4383.  
  4384.  
  4385.  
  4386.  
  4387.  
  4388.  
  4389.  
  4390.  
  4391.  
  4392.  
  4393.  
  4394.  
  4395.  
  4396.  
  4397.  
  4398.  
  4399.  
  4400.  
  4401.  
  4402.  
  4403.  
  4404.  
  4405.  
  4406.  
  4407.  
  4408.  
  4409.  
  4410.  
  4411.  
  4412.  
  4413.  
  4414.  
  4415.  
  4416.  
  4417.  
  4418.  
  4419.  
  4420.  
  4421.  
  4422. Expires April 1998                                        [Page 75]
  4423.  
  4424.  
  4425.  
  4426.  
  4427.  
  4428. Draft                  Interfaces Group MIB           October 1997
  4429.  
  4430.  
  4431. 8.  References
  4432.  
  4433. [1]  SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  4434.      S. Waldbusser, "Structure of Management Information for
  4435.      version 2 of the Simple Network Management Protocol
  4436.      (SNMPv2)", RFC 1902, January 1996.
  4437.  
  4438. [2]  SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  4439.      S. Waldbusser, "Textual Conventions for version 2 of the
  4440.      Simple Network Management Protocol (SNMPv2)", RFC 1903,
  4441.      January 1996.
  4442.  
  4443. [3]  SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  4444.      S. Waldbusser, "Protocol Operations for version 2 of the
  4445.      Simple Network Management Protocol (SNMPv2)", RFC 1905,
  4446.      January 1996.
  4447.  
  4448. [4]  McCloghrie, K., and M. Rose, "Management Information Base for
  4449.      Network Management of TCP/IP-based internets - MIB-II", RFC
  4450.      1213, Hughes LAN Systems, Performance Systems International,
  4451.      March 1991.
  4452.  
  4453. [5]  Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple
  4454.      Network Management Protocol", RFC 1157, SNMP Research,
  4455.      Performance Systems International, Performance Systems
  4456.      International, MIT Laboratory for Computer Science, May 1990.
  4457.  
  4458. [6]  J. Postel, "Internet Protocol", RFC 791, Information Sciences
  4459.      Institute, USC, September 1981.
  4460.  
  4461. [7]  K. McCloghrie, "Extensions to the Generic-Interface MIB", RFC
  4462.      1229, Hughes LAN Systems, May 1991.
  4463.  
  4464. [8]  ATM Forum Technical Committee, "LAN Emulation Client
  4465.      Management: Version 1.0 Specification", af-lane-0044.000, ATM
  4466.      Forum, September 1995.
  4467.  
  4468. [9]  B. Stewart, "Definitions of Managed Objects for Character
  4469.      Stream Devices using SMIv2", RFC 1658, Xyplex Inc., July
  4470.      1994.
  4471.  
  4472. [10] S. Bradner, "Key words for use in RFCs to Indicate
  4473.      Requirements Levels", RFC 2119, Harvard University, March
  4474.      1997.
  4475.  
  4476.  
  4477.  
  4478.  
  4479.  
  4480.  
  4481. Expires April 1998                                        [Page 76]
  4482.  
  4483.  
  4484.  
  4485.  
  4486.  
  4487. Draft                  Interfaces Group MIB           October 1997
  4488.  
  4489.  
  4490. 9.  Security Considerations
  4491.  
  4492. This MIB contains both readable objects whose values provide the
  4493. number and status of a device's network interfaces, and write-able
  4494. objects which allow an administrator to control the interfaces and
  4495. to perform tests on the interfaces.  Unauthorized access to the
  4496. readable objects is relatively innocuous.  Unauthorized access to
  4497. the write-able objects could cause a denial of service, or in
  4498. combination with other (e.g., physical) security breaches, could
  4499. cause unauthorized connectivity to a device.
  4500.  
  4501.  
  4502. 10.  Authors' Addresses
  4503.  
  4504.      Keith McCloghrie
  4505.      Cisco Systems, Inc.
  4506.      170 West Tasman Drive
  4507.      San Jose, CA  95134-1706
  4508.  
  4509.      Phone: 408-526-5260
  4510.      Email: kzm@cisco.com"
  4511.  
  4512.  
  4513.      Frank Kastenholz
  4514.      FTP Software
  4515.      2 High Street
  4516.      North Andover, Mass. USA 01845
  4517.  
  4518.      Phone: (508)685-4000
  4519.      Email: kasten@ftp.com
  4520.  
  4521.  
  4522.  
  4523.  
  4524.  
  4525.  
  4526.  
  4527.  
  4528.  
  4529.  
  4530.  
  4531.  
  4532.  
  4533.  
  4534.  
  4535.  
  4536.  
  4537.  
  4538.  
  4539.  
  4540. Expires April 1998                                        [Page 77]
  4541.  
  4542.  
  4543.  
  4544.  
  4545.  
  4546. Draft                  Interfaces Group MIB           October 1997
  4547.  
  4548.  
  4549. Table of Contents
  4550.  
  4551.  
  4552. 1 Introduction ..............................................    2
  4553. 1.1 Change Log ..............................................    2
  4554. 2 The SNMP Network Management Framework .....................    6
  4555. 2.1 Object Definitions ......................................    6
  4556. 3 Experience with the Interfaces Group ......................    7
  4557. 3.1 Clarifications/Revisions ................................    7
  4558. 3.1.1 Interface Sub-Layers ..................................    7
  4559. 3.1.2 Guidance on Defining Sub-layers .......................   10
  4560. 3.1.3 Virtual Circuits ......................................   12
  4561. 3.1.4 Bit, Character, and Fixed-Length Interfaces ...........   12
  4562. 3.1.5 Interface Numbering ...................................   14
  4563. 3.1.6 Counter Size ..........................................   19
  4564. 3.1.7 Interface Speed .......................................   21
  4565. 3.1.8 Multicast/Broadcast Counters ..........................   22
  4566. 3.1.9 Trap Enable ...........................................   22
  4567. 3.1.10 Addition of New ifType values ........................   23
  4568. 3.1.11 InterfaceIndex Textual Convention ....................   23
  4569. 3.1.12 New states for IfOperStatus ..........................   23
  4570. 3.1.13 IfAdminStatus and IfOperStatus .......................   24
  4571. 3.1.14 IfOperStatus in an Interface Stack ...................   26
  4572. 3.1.15 Traps ................................................   26
  4573. 3.1.16 ifSpecific ...........................................   28
  4574. 3.1.17 Creation/Deletion of Interfaces ......................   28
  4575. 3.1.18 All Values Must be Known .............................   29
  4576. 4 Media-Specific MIB Applicability ..........................   31
  4577. 5 Overview ..................................................   32
  4578. 6 Interfaces Group Definitions ..............................   33
  4579. 7 Acknowledgements ..........................................   75
  4580. 8 References ................................................   76
  4581. 9 Security Considerations ...................................   77
  4582. 10 Authors' Addresses .......................................   77
  4583.  
  4584.  
  4585.  
  4586.  
  4587.  
  4588.  
  4589.  
  4590.  
  4591.  
  4592.  
  4593.  
  4594.  
  4595.  
  4596.  
  4597.  
  4598.  
  4599. Expires April 1998                                        [Page 78]
  4600.  
  4601.