home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1997 December / Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso / drafts / draft_ietf_j_p / draft-ietf-ptopomib-pdp-01.txt < prev   
Text File  |  1997-09-17  |  51KB  |  1,830 lines
  1.  
  2.  
  3.  
  4.  
  5. Draft               PTOPO Discovery Protocol and MIB      September 1997
  6.  
  7.  
  8.                     <draft-ietf-ptopomib-pdp-01.txt>
  9.               Physical Topology Discovery Protocol and MIB
  10.  
  11.  
  12.                            17 September 1997
  13.  
  14.  
  15.                               Andy Bierman
  16.                            Cisco Systems Inc.
  17.                            abierman@cisco.com
  18.  
  19.  
  20.                             Keith McCloghrie
  21.                            Cisco Systems Inc.
  22.                              kzm@cisco.com
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                           Status of this Memo
  29.  
  30.  
  31. This document is an Internet-Draft.  Internet-Drafts are working
  32. documents of the Internet Engineering Task Force (IETF), its areas, and
  33. its working groups.  Note that other groups may also distribute working
  34. documents as Internet-Drafts.
  35.  
  36. Internet-Drafts are draft documents valid for a maximum of six months
  37. and may be updated, replaced, or obsoleted by other documents at any
  38. time.  It is inappropriate to use Internet- Drafts as reference material
  39. or to cite them other than as ``work in progress.''
  40.  
  41. To learn the current status of any Internet-Draft, please check the
  42. ``1id-abstracts.txt'' listing contained in the Internet- Drafts Shadow
  43. Directories on ds.internic.net (US East Coast), nic.nordu.net (Europe),
  44. ftp.isi.edu (US West Coast), or munnari.oz.au (Pacific Rim).
  45.  
  46.  
  47. 1.  Introduction
  48.  
  49. This memo defines an experimental protocol, and an experimental portion
  50. of the Management Information Base (MIB) for use with network management
  51. protocols in the Internet community.  In particular, it describes a
  52. physical topology discovery protocol and managed objects used for
  53.  
  54.  
  55.  
  56.  
  57.  
  58. Bierman/McCloghrie         Expires March 1998                   [Page 1]
  59.  
  60.  
  61.  
  62.  
  63.  
  64. Draft               PTOPO Discovery Protocol and MIB      September 1997
  65.  
  66.  
  67. managing the protocol.
  68.  
  69.  
  70. 2.  The SNMP Network Management Framework
  71.  
  72. The SNMP Network Management Framework presently consists of three major
  73. components.  They are:
  74.  
  75. o    the SMI, described in RFC 1902 [RFC1902], - the mechanisms used for
  76.      describing and naming objects for the purpose of management.
  77.  
  78. o    the MIB-II, STD 17, RFC 1213 [RFC1213], - the core set of managed
  79.      objects for the Internet suite of protocols.
  80.  
  81. o    the protocol, RFC 1157 [RFC1157] and/or RFC 1905 [RFC1905], - the
  82.      protocol for accessing managed information.
  83.  
  84. Textual conventions are defined in RFC 1903 [RFC1903], and conformance
  85. statements are defined in RFC 1904 [RFC1904].
  86.  
  87. The Framework permits new objects to be defined for the purpose of
  88. experimentation and evaluation.
  89.  
  90. This memo specifies a MIB module that is compliant to the SNMPv2 SMI.  A
  91. semantically identical MIB conforming to the SNMPv1 SMI can be produced
  92. through the appropriate translation.
  93.  
  94.  
  95. 2.1.  Object Definitions
  96.  
  97. Managed objects are accessed via a virtual information store, termed the
  98. Management Information Base or MIB.  Objects in the MIB are defined
  99. using the subset of Abstract Syntax Notation One (ASN.1) defined in the
  100. SMI.  In particular, each object type is named by an OBJECT IDENTIFIER,
  101. an administratively assigned name.  The object type together with an
  102. object instance serves to uniquely identify a specific instantiation of
  103. the object.  For human convenience, we often use a textual string,
  104. termed the descriptor, to refer to the object type.
  105.  
  106.  
  107. 3.  Overview
  108.  
  109. There is a need for a standardized way of representing the physical
  110. network connections pertaining to a given management domain.  A
  111. standardized discovery mechanism is also required to increase the
  112.  
  113.  
  114.  
  115.  
  116.  
  117. Bierman/McCloghrie         Expires March 1998                   [Page 2]
  118.  
  119.  
  120.  
  121.  
  122.  
  123. Draft               PTOPO Discovery Protocol and MIB      September 1997
  124.  
  125.  
  126. likelihood of multi-vendor interoperability of such physical topology
  127. management information.
  128.  
  129. This document specifies a discovery protocol, suitable for use with the
  130. Physical Topology MIB [PTOPO].
  131.  
  132.  
  133. 3.1.  Terms
  134.  
  135. Some terms are used throughout this document:
  136.  
  137. SNMP Agent
  138.      This term refers to an SNMP agent co-located with a particular PDP
  139.      Agent. Specifically, it refers to the SNMP Agent providing PDP MIB,
  140.      Entity MIB, Interfaces MIB, and possibly PTOPO MIB support for a
  141.      particular chassis.
  142.  
  143. PDP Agent
  144.      This term refers to a software entity which implements the PTOPO
  145.      Discovery Protocol for a particular chassis.
  146.  
  147.  
  148. 3.2.  Persistent Identifiers
  149.  
  150. The PTOPO MIB utilizes non-volatile identifiers to distinguish
  151. individual chassis and port components.  These identifiers are
  152. associated with external objects in order to relate topology information
  153. to the existing managed objects.
  154.  
  155. In particular, an object from the Entity MIB or Interfaces MIB can be
  156. used as the 'reference-point' for a connection component identifier.
  157.  
  158.  
  159. 3.3.  Relationship to the Physical Topology MIB
  160.  
  161. The Physical Topology MIB [PTOPO] allows a PDP Agent to expose learned
  162. physical topology information, using a standard MIB.  PDP is intended to
  163. fully support the PTOPO MIB.
  164.  
  165.  
  166. 3.4.  Relationship to Entity MIB
  167.  
  168. The Entity MIB [RFC2037] allows the physical component inventory and
  169. hierarchy to be identified.  The chassis identifier strings passed in
  170. PDP messages identify entPhysicalTable entries, and implementation of
  171.  
  172.  
  173.  
  174.  
  175.  
  176. Bierman/McCloghrie         Expires March 1998                   [Page 3]
  177.  
  178.  
  179.  
  180.  
  181.  
  182. Draft               PTOPO Discovery Protocol and MIB      September 1997
  183.  
  184.  
  185. the entPhysicalTable and entPhysicalXTable (found in 'Entity MIB
  186. Extensions for Persistent Component Identification' [ENTITY-EXT]) are
  187. required for SNMP agents which also implement the PDP MIB.
  188.  
  189.  
  190. 3.5.  Relationship to Interfaces MIB
  191.  
  192. The Interfaces MIB provides a standard mechanism for managing network
  193. interfaces. The port identifier strings passed in PDP messages identify
  194. ifTable (or entPhysicalTable) entries, and implementation of the ifTable
  195. and ifXTable [RFC1573] are required for SNMP agents which also implement
  196. the PDP MIB, for the ports which are represented in the Interfaces MIB.
  197.  
  198.  
  199. 4.  PTOPO Discovery Protocol
  200.  
  201. This section defines a discovery protocol, suitable for supporting the
  202. data requirements of the PTOPO MIB.
  203.  
  204. The PTOPO Discovery Protocol (PDP) is a media independent protocol
  205. intended to be run on routers, bridges, access servers, switches,
  206. repeaters, etc., allowing a PDP agent to learn SNMP reachability and
  207. connection endpoint information from adjacent devices.
  208.  
  209. PDP runs on various media that support Subnetwork Access Protocol
  210. (SNAP), and runs over the data-link layer only, allowing two systems
  211. running different network layer protocols can learn about each other.
  212.  
  213. Each device configured with an active PDP Agent sends periodic messages
  214. to a multicast MAC address on all physical interfaces enabled for PDP
  215. transmission, and listens for PDP messages on the same set on
  216. interfaces. Each PDP message contains information identifying the source
  217. port as a PTOPO connection endpoint identifier. It also contains at
  218. least one network address which can be used by an NMS to reach an SNMP
  219. agent on the device (via the indicated source port).  Each PDP message
  220. contains a configurable time-to-live value, which tells the recipient
  221. PDP agent when to discard each element of learned topology information.
  222.  
  223.  
  224. 4.1.  Frame Encapsulation
  225.  
  226. The following open issues are under consideration by the working group:
  227.  
  228.      An EtherType value must be selected to identify PDP messages
  229.      transmitted over DIX Ethernet, and IEEE 802.3,802.5 media types
  230.  
  231.  
  232.  
  233.  
  234.  
  235. Bierman/McCloghrie         Expires March 1998                   [Page 4]
  236.  
  237.  
  238.  
  239.  
  240.  
  241. Draft               PTOPO Discovery Protocol and MIB      September 1997
  242.  
  243.  
  244.      (using LLC/SNAP encapsulation).
  245.  
  246.      A multicast MAC address must be selected for the destination
  247.      address (DA) field in PDP messages transmitted over DIX Ethernet,
  248.      IEEE 802.3, and IEEE 802.5 media types.
  249.  
  250.  
  251. 4.2.  PDP Forwarding
  252.  
  253. If at all possible, PDP agents are not supposed to forward PDP messages
  254. received on any port.   However, some devices, such as repeaters, cannot
  255. examine each frame received on an interface or port.  Such a device will
  256. allow PDP messages to be retransmitted on one or more local ports, and
  257. will transmit its own PDP messages on those ports as well.  These agents
  258. are termed 'forwarding' PDP agents.
  259.  
  260. PDP agents located on devices which examine each frame before
  261. retransmitting it (e.g., routers and bridges), are expected to process
  262. received PDP messages and not retransmit them on any local port. These
  263. agents are termed 'non-forwarding' PDP agents.
  264.  
  265. An NMS may find physical topology information about the same physical
  266. port, represented by several PTOPO agents.  This may occur for one of
  267. several reasons, including a mixture of forwarding and non-forwarding
  268. PDP agents within a network.
  269.  
  270.  
  271. 4.3.  PDP Message Format
  272.  
  273. The basic PDP packet consists of a header, followed by a variable number
  274. of variable bindings in an ASN.1/BER encoded 'VarBindList', as indicated
  275. in Figure 1.
  276.  
  277.          +------------+--------------------------------------+
  278.          |   header   |        (ASN.1/BER) VarBindList       |
  279.          +------------+--------------------------------------+
  280.  
  281.                 [ Figure 1 -- Basic PDP Message Format ]
  282.  
  283.  
  284. 4.3.1.  PDP Header Format
  285.  
  286. The PDP header is a 6 byte header, in network byte order,
  287.  containing 4 fields, as shown in figure 2:
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294. Bierman/McCloghrie         Expires March 1998                   [Page 5]
  295.  
  296.  
  297.  
  298.  
  299.  
  300. Draft               PTOPO Discovery Protocol and MIB      September 1997
  301.  
  302.  
  303.           0                   1                   2                   3
  304.           0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  305.          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  306.          |      Version  |     Flags     |         Time To Live          |
  307.          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  308.  
  309.           0                   1
  310.           0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
  311.          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  312.          |          Checksum             |
  313.          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  314.  
  315.                         [ figure 2 -- PDP Message Format ]
  316.  
  317. The PDP header contains the following fields:
  318.  
  319.    - Version
  320.      The PDP protocol version number, set to 0x01 for this version of
  321.      the protocol.
  322.  
  323.    - Flags
  324.      The PDP flags field provide for future header extensions and keep
  325.      the header word-aligned for easier processing. No flag definition
  326.      bits are defined at this time. This field must be set to zero in
  327.      all version 1 PDP messages.
  328.  
  329.    - Time to live
  330.      The number of seconds the information in this PDP message should be
  331.      regarded as valid by the recipient. Agents of the PTOPO MIB must
  332.      not return MIB information based on expired PDP messages.  The
  333.      valid range is 0 to 65535 for this field.
  334.  
  335.    - Checksum
  336.      An optional one's complement of the one's complement checksum of
  337.      the entire PDP message. An entity generating PDP messages shall set
  338.      this field to zero if the checksum is omitted.  An entity receiving
  339.      PDP messages must skip the checksum validation if this field is
  340.      zero, otherwise the checksum is calculated and compared to the
  341.      value of this field.  Messages containing incorrect checksums must
  342.      be ignored.  (See section 4.5.2.3 for a detailed description of
  343.      checksum processing.)
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353. Bierman/McCloghrie         Expires March 1998                   [Page 6]
  354.  
  355.  
  356.  
  357.  
  358.  
  359. Draft               PTOPO Discovery Protocol and MIB      September 1997
  360.  
  361.  
  362. 4.3.2.  PDP PDU Encoding
  363.  
  364. Following the PDP header is an SNMP varbind list encoded in ASN.1/BER
  365. [ref. TBD], also referred to as the PDP protocol data unit (PDP-PDU).
  366. The invidual MIB instances contained in a PDP PDU are referred to as PDP
  367. data elements.
  368.  
  369. The standard PDP data elements, defined in the PDP Data MIB, are encoded
  370. as a VarBindList in each PDP message.  This data enables a PDP agent to
  371. implement the PTOPO MIB for connections terminating on the local
  372. chassis.
  373.  
  374. This section defines the ASN.1 syntax specific to the PDP message.
  375. Refer to the Protocol Operations specification [RFC1905] for a complete
  376. definition of the 'VarBindList' construct.
  377.  
  378. Note that PDP places no constraints on which MIB instances may be
  379. included in a particular VarBindList.
  380.  
  381. PDP-PDU DEFINITIONS ::= BEGIN
  382.  
  383. IMPORTS
  384.     MODULE-IDENTITY
  385.         FROM SNMPv2-SMI
  386.     VarBindList
  387.         FROM SNMPv2-PDU;
  388.  
  389. PDPv1-PDU MODULE-IDENTITY
  390.     LAST-UPDATED "9709150000Z"
  391.     ORGANIZATION "IETF PTOPOMIB Working Group"
  392.     CONTACT-INFO
  393.        "PTOPOMIB WG Discussion:
  394.         ptopo@3com.com
  395.         Subscription:
  396.         majordomo@3com.com
  397.           msg body: [un]subscribe ptopomib
  398.  
  399.         Andy Bierman
  400.         Cisco Systems Inc.
  401.         170 West Tasman Drive
  402.         San Jose, CA 95134
  403.         408-527-3711
  404.         abierman@cisco.com
  405.  
  406.         Keith McCloghrie
  407.  
  408.  
  409.  
  410.  
  411.  
  412. Bierman/McCloghrie         Expires March 1998                   [Page 7]
  413.  
  414.  
  415.  
  416.  
  417.  
  418. Draft               PTOPO Discovery Protocol and MIB      September 1997
  419.  
  420.  
  421.         Cisco Systems Inc.
  422.         170 West Tasman Drive
  423.         San Jose, CA 95134
  424.         408-526-5260
  425.         kzm@cisco.com"
  426.     DESCRIPTION
  427.             "The definition module for version 1 of the PTOPO Discovery
  428.             Protocol PDU syntax."
  429.     ::= { experimental xx }
  430.  
  431. PDP-PDU ::=
  432.     SEQUENCE {
  433.         pdp-variable-bindings
  434.             VarBindList
  435.     }
  436.  
  437. END
  438.  
  439.  
  440. 4.4.  PDP Data MIB
  441.  
  442. This section defines the standard data elements which may be contained
  443. in PDP messages.  These elements are defined as MIB objects, but are
  444. only intended to be encoded into PDP PDUs, and not intended to be
  445. instrumented by an SNMP agent.
  446.  
  447. The MIB defines six standard data elements:
  448.  
  449.     - Chassis ID
  450.     - Chassis ID Type
  451.     - Port ID
  452.     - Port ID Type
  453.     - Management Address Type
  454.     - Management Address
  455.  
  456.  
  457. 4.4.1.  Definitions
  458.  
  459. PDP-DATA-MIB DEFINITIONS ::= BEGIN
  460.  
  461. IMPORTS
  462.     MODULE-IDENTITY, OBJECT-TYPE, Integer32
  463.         FROM SNMPv2-SMI
  464.     MODULE-COMPLIANCE, OBJECT-GROUP
  465.         FROM SNMPv2-CONF
  466.  
  467.  
  468.  
  469.  
  470.  
  471. Bierman/McCloghrie         Expires March 1998                   [Page 8]
  472.  
  473.  
  474.  
  475.  
  476.  
  477. Draft               PTOPO Discovery Protocol and MIB      September 1997
  478.  
  479.  
  480.     IANAAddrFamily, PtopoGenAddr, PtopoChassisIdType,
  481.     PtopoChassisId, PtopoPortIdType, PtopoPortId
  482.         FROM PTOPO-MIB;
  483.  
  484.  
  485. pdpDataMIB MODULE-IDENTITY
  486.     LAST-UPDATED "9709150000Z"
  487.     ORGANIZATION "IETF PTOPOMIB Working Group"
  488.     CONTACT-INFO
  489.        "PTOPOMIB WG Discussion:
  490.         ptopo@3com.com
  491.         Subscription:
  492.         majordomo@3com.com
  493.           msg body: [un]subscribe ptopomib
  494.  
  495.         Andy Bierman
  496.         Cisco Systems Inc.
  497.         170 West Tasman Drive
  498.         San Jose, CA 95134
  499.         408-527-3711
  500.         abierman@cisco.com
  501.  
  502.         Keith McCloghrie
  503.         Cisco Systems Inc.
  504.         170 West Tasman Drive
  505.         San Jose, CA 95134
  506.         408-526-5260
  507.         kzm@cisco.com"
  508.     DESCRIPTION
  509.             "The MIB module for describing PDP data elements."
  510.     ::= { experimental xx }
  511.  
  512. pdpDataMIBObjects   OBJECT IDENTIFIER ::= { pdpDataMIB 1 }
  513.  
  514. -- MIB groups
  515. pdpDataElements     OBJECT IDENTIFIER ::= { pdpDataMIBObjects 1 }
  516.  
  517. --
  518. --  ***********************************************************
  519. --
  520. --              P D P    D A T A    E L E M E N T S
  521. --
  522. --  ***********************************************************
  523. --
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530. Bierman/McCloghrie         Expires March 1998                   [Page 9]
  531.  
  532.  
  533.  
  534.  
  535.  
  536. Draft               PTOPO Discovery Protocol and MIB      September 1997
  537.  
  538.  
  539. pdpChassisIdType OBJECT-TYPE
  540.     SYNTAX      PtopoChassisIdType
  541.     MAX-ACCESS  read-only
  542.     STATUS      current
  543.     DESCRIPTION
  544.             "This object identifies the type of chassis component
  545.             identifier contained in the pdpChassisId object, within a
  546.             given PDP message."
  547.     ::= { pdpDataElements 1 }
  548.  
  549. pdpChassisId OBJECT-TYPE
  550.     SYNTAX      PtopoChassisId
  551.     MAX-ACCESS  read-only
  552.     STATUS      current
  553.     DESCRIPTION
  554.             "This object identifies the chassis component of the
  555.             particular connection endpoint identifier containing the PDP
  556.             agent transmitting PDP messages.
  557.  
  558.             If the chassis ID is unknown for the entry, then this object
  559.             will contain an empty string."
  560.     ::= { pdpDataElements 2 }
  561.  
  562. pdpPortIdType OBJECT-TYPE
  563.     SYNTAX      PtopoPortIdType
  564.     MAX-ACCESS  read-only
  565.     STATUS      current
  566.     DESCRIPTION
  567.             "This object identifies the type of port component
  568.             identifier contained in the pdpPortId object, within a given
  569.             PDP message."
  570.     ::= { pdpDataElements 3 }
  571.  
  572. pdpPortId OBJECT-TYPE
  573.     SYNTAX      PtopoPortId
  574.     MAX-ACCESS  read-only
  575.     STATUS      current
  576.     DESCRIPTION
  577.             "This object identifies the port component of a particular
  578.             connection endpoint identifier, associated with the port
  579.             chosen for transmission of a given PDP message.
  580.  
  581.             For PDP agents contained within repeaters or concentrators,
  582.             this object may identify the backplane component chosen for
  583.             transmission of a given PDP message, instead of a specific
  584.  
  585.  
  586.  
  587.  
  588.  
  589. Bierman/McCloghrie         Expires March 1998                  [Page 10]
  590.  
  591.  
  592.  
  593.  
  594.  
  595. Draft               PTOPO Discovery Protocol and MIB      September 1997
  596.  
  597.  
  598.             port component (attached to the identified backplane).
  599.  
  600.             If the port ID is unknown for the entry, then this object
  601.             will contain an empty string."
  602.     ::= { pdpDataElements 4 }
  603.  
  604. pdpMgmtAddrType OBJECT-TYPE
  605.     SYNTAX      IANAAddrFamily
  606.     MAX-ACCESS  read-only
  607.     STATUS      current
  608.     DESCRIPTION
  609.             "This object identifies the type of network address
  610.             contained in the pdpMgmtAddr object, within a given PDP
  611.             message."
  612.     ::= { pdpDataElements 5 }
  613.  
  614. pdpMgmtAddr OBJECT-TYPE
  615.     SYNTAX      PtopoGenAddr
  616.     MAX-ACCESS  read-only
  617.     STATUS      current
  618.     DESCRIPTION
  619.             "This object identifies a particular network address,
  620.             associated with an SNMP agent which contains additional
  621.             information pertaining to the connection endpoint identified
  622.             in a given PDP message.
  623.  
  624.             If a management address is unknown for the endpoint
  625.             described in a given PDP message, then this object will
  626.             contain an empty string."
  627.     ::= { pdpDataElements 6 }
  628.  
  629.  
  630.  
  631. -- conformance information
  632. pdpDataConformance OBJECT IDENTIFIER ::= { pdpDataMIB 2 }
  633.  
  634. pdpDataCompliances OBJECT IDENTIFIER ::= { pdpDataConformance 1 }
  635. pdpDataGroups      OBJECT IDENTIFIER ::= { pdpDataConformance 2 }
  636.  
  637. -- compliance statements
  638.  
  639. pdpDataCompliance MODULE-COMPLIANCE
  640.    STATUS  current
  641.     DESCRIPTION
  642.             "The compliance statement for entities which implement the
  643.  
  644.  
  645.  
  646.  
  647.  
  648. Bierman/McCloghrie         Expires March 1998                  [Page 11]
  649.  
  650.  
  651.  
  652.  
  653.  
  654. Draft               PTOPO Discovery Protocol and MIB      September 1997
  655.  
  656.  
  657.             PTOPO Discovery Protocol."
  658.     MODULE  -- this module
  659.         MANDATORY-GROUPS { pdpPtopoDataGroup }
  660.  
  661.     ::= { pdpDataCompliances 1 }
  662.  
  663. -- MIB groupings
  664.  
  665. pdpPtopoDataGroup    OBJECT-GROUP
  666.     OBJECTS {
  667.         pdpChassisIdType,
  668.         pdpChassisId,
  669.         pdpPortIdType,
  670.         pdpPortId,
  671.         pdpMgmtAddrType,
  672.         pdpMgmtAddr
  673.     }
  674.     STATUS  current
  675.     DESCRIPTION
  676.             "The collection of objects which identify connection
  677.             endpoint data elements, as used in the PTOPO Discovery
  678.             Protocol, and represented in the PTOPO MIB.
  679.  
  680.             This group is mandatory for agents which implement the PTOPO
  681.             Discovery Protocol."
  682.     ::= { pdpDataGroups 1 }
  683.  
  684. END
  685.  
  686.  
  687. 4.5.  Protocol Operation
  688.  
  689. An active PDP Agent must perform the following tasks:
  690.  
  691.    - transmit PDP messages
  692.    - process received PDP messages
  693.    - maintain an instance of the PDP MIB
  694.    - maintain an instance of the PTOPO MIB
  695.    - maintain appropriate ifEntry and/or entPhysicalEntry instances
  696.    - implement ifAlias and/or entPhysicalAlias MIB objects
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707. Bierman/McCloghrie         Expires March 1998                  [Page 12]
  708.  
  709.  
  710.  
  711.  
  712.  
  713. Draft               PTOPO Discovery Protocol and MIB      September 1997
  714.  
  715.  
  716. 4.5.1.  Protocol Initialization
  717.  
  718. Upon system reinitialization, the following tasks are performed by the
  719. PDP agent:
  720.  
  721.      Non-volatile configuration for the PDP MIB is retrieved if
  722.      applicable, otherwise appropriate default values are assigned to
  723.      all PDP configuration variables.
  724.  
  725.      If pdpAdminStatus is equal to 'disabled(2)', then PDP
  726.      initialization is terminated (until such time that the
  727.      pdpAdminStatus object is set to 'enabled(1)'), otherwise continue.
  728.  
  729.      Internal (implementation-specific) data structures are initialized.
  730.      such that appropriate local physical topology information and PDP
  731.      transmission parameters are set.
  732.  
  733.  
  734. 4.5.2.  Message Encoding
  735.  
  736. This section does not assume a particular buffering strategy, and such
  737. details are omitted.
  738.  
  739.  
  740. 4.5.2.1.  Header Fields
  741.  
  742. The version field is set to one (0x01).
  743.  
  744. The flags field is set to zero (0x00).
  745.  
  746. The time-to-live field is set to the value obtained by the following
  747. formula:
  748.  
  749. TTL = min(65535, (pdpMessageTxInterval * pdpMessageTxHoldMultiplier))
  750.  
  751. The checksum is set to zero (0x0000).  If checksums are implemented by
  752. the PDP agent, then this field will be set again later.
  753.  
  754.  
  755. 4.5.2.2.  VarBindList
  756.  
  757. Each message must contain one instance of each of the six mandatory
  758. PDP-PDU data elements, defined in the PDP Data MIB.  Additional data
  759. elements may be added as maximum frame size permits.
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766. Bierman/McCloghrie         Expires March 1998                  [Page 13]
  767.  
  768.  
  769.  
  770.  
  771.  
  772. Draft               PTOPO Discovery Protocol and MIB      September 1997
  773.  
  774.  
  775. ASN.1/BER encoding is defined in [TBD], and is outside the scope of this
  776. document.
  777.  
  778.  
  779. 4.5.2.3.  Checksum
  780.  
  781. If checksums are implemented by the PDP agent, then a simple UDP-style
  782. checksum is calculated for the PDP message (i.e., concatenated header
  783. and ASN.1/BER encoded VarBindList).
  784.  
  785. If the PDP message length is odd, then a zero-valued octet is appended
  786. to the PDP message.  This padding is done only for PDP checksum
  787. calculation, and the additional octet is not transmitted with the PDP
  788. message.
  789.  
  790. A 16-bit unsigned integer temporary variable is initialized to zero.
  791.  
  792. Each unsigned 16-bit word of the PDP message is added to the temporary
  793. variable, and any overflows are ignored.
  794.  
  795. The ones-complement (i.e., all bits reversed) of the temporary variable
  796. is written to the checksum field, in network byte order.
  797.  
  798.  
  799. 4.5.3.  Message Transmission
  800.  
  801. An active PDP agent must transmit a PDP message out each appropriate
  802. port, once each message interval, as determined by the
  803. pdpMessageTxInterval MIB object. Messages transmitted on repeater
  804. devices may be sent for each repeater backplane, once per message
  805. interval. Actual transmission intervals should be jittered to prevent
  806. synchronization effects.
  807.  
  808. Regarding the transmission of a single PDP message, for the indicated
  809. physical interface contained in the local system:
  810.  
  811.      The PDP agent checks for the existence of a pdpSuppressEntry for
  812.      the port.  If an entry exists then this port is skipped, otherwise
  813.      continue.
  814.  
  815.      The PDP message is encapsulated as appropriate for the port.
  816.  
  817.      The MAC header is filled in with appropriate SA and DA and
  818.      EtherType fields.  (Ignoring LLC/SNAP details).
  819.  
  820.  
  821.  
  822.  
  823.  
  824.  
  825. Bierman/McCloghrie         Expires March 1998                  [Page 14]
  826.  
  827.  
  828.  
  829.  
  830.  
  831. Draft               PTOPO Discovery Protocol and MIB      September 1997
  832.  
  833.  
  834.      The frame is transmitted or passed to a lower layer for
  835.      transmission.
  836.  
  837.      The pdpStatsOutPkts counter is incremented for the indicated local
  838.      port.
  839.  
  840.  
  841. 4.5.4.  Received Message Processing
  842.  
  843. An active PDP agent must process PDP messages received on each
  844. appropriate port, as such messages arrive.
  845.  
  846. The following sections refer to the reception of a single PDP message,
  847. for the indicated physical interface contained in the local system:
  848.  
  849.  
  850. 4.5.4.1.  Header Fields
  851.  
  852. The PDP message and the chassis/port indices associated with the
  853. receiving port are retrieved.
  854.  
  855. The PDP version and flags field are checked.  The version should equal
  856. one (0x01) and the flags should equal zero (0x00).  If not, the
  857. pdpStatsInErrors counter for the receiving port is incremented and
  858. processing is terminated; otherwise continue.
  859.  
  860.  
  861. 4.5.4.2.  Checksum
  862.  
  863. If the checksum field is zero then continue, otherwise verify the
  864. checksum with the following procedure:
  865.  
  866.      The value of checksum is saved in a temporary variable.
  867.  
  868.      The checksum field is set to zero.
  869.  
  870.      If the PDP message length is odd, then a zero-valued octet is
  871.      conceptually appended to the PDP message. This padding is done only
  872.      for PDP checksum calculation.
  873.  
  874.      A 16-bit unsigned integer temporary variable is initialized to
  875.      zero.
  876.  
  877.      Each unsigned 16-bit word of the PDP message is added to temporary
  878.      variable, and any overflows are ignored.
  879.  
  880.  
  881.  
  882.  
  883.  
  884. Bierman/McCloghrie         Expires March 1998                  [Page 15]
  885.  
  886.  
  887.  
  888.  
  889.  
  890. Draft               PTOPO Discovery Protocol and MIB      September 1997
  891.  
  892.  
  893.      The ones-complement (i.e., all bits reversed) of this temporary
  894.      variable is compared to the saved checksum field.  If they are
  895.      different, then the pdpStatsInErrors counter for the receiving port
  896.      is incremented, and processing is terminated. Otherwise, the
  897.      checksum is valid, so continue.
  898.  
  899.  
  900. 4.5.4.3.  VarBindList
  901.  
  902. The ASN.1/BER portion of the message is decoded.  (Such parsing
  903. techniques are beyond the scope of this document.) If this portion of
  904. the PDP message is not properly encoded, as defined in the PDP Data MIB,
  905. then the pdpStatsInErrors counter for the receiving port is incremented,
  906. and processing is terminated; otherwise continue.
  907.  
  908. The list of data elements is examined. The agent must skip and ignore
  909. PDU data elements unknown to the agent.  If any of the mandatory data
  910. elements are missing, then the pdpStatsInErrors counter for the
  911. receiving port is incremented, and processing is terminated; otherwise
  912. continue.
  913.  
  914. The pdpStatsInPkts counter is incremented for the receiving port.
  915.  
  916.  
  917. 4.5.4.4.  PTOPO MIB Update
  918.  
  919. If the time-to-live field in the PDP message header is zero then execute
  920. this interface shutdown procedure, described below.  Processing of the
  921. PDP message is now complete.
  922.  
  923. If the time-to-live field is non-zero, then the appropriate
  924. ptopoConnEntry is found or created, based on the data elements included
  925. in the PDP message. If the indicated entry is dynamic (i.e.,
  926. ptopoConnIsStatic is true), then the current sysUpTime value is stored
  927. in the ptopoConnLastVerifyTime field for the entry.
  928.  
  929. If a ptopoConnEntry was added then the ptopoConnTabInserts counter is
  930. incremented.
  931.  
  932. If a ptopoConnEntry of one type was replaced with an entry of a
  933. different type, then the ptopoConnTabReplaces counter is incremented.
  934.  
  935. If any ptopoConnEntry was added or deleted, or if information other than
  936. the ptopoConnLastVerifyTime changed for any entry due to the processing
  937. of this PDP message, then the ptopoLastChangeTime object is set with the
  938.  
  939.  
  940.  
  941.  
  942.  
  943. Bierman/McCloghrie         Expires March 1998                  [Page 16]
  944.  
  945.  
  946.  
  947.  
  948.  
  949. Draft               PTOPO Discovery Protocol and MIB      September 1997
  950.  
  951.  
  952. current sysUpTime, and a ptopoConfigChange trap event is generated. (See
  953. the PTOPO MIB for information on ptopoConfigChange trap generation.)
  954.  
  955.  
  956. 4.5.5.  Interface Shutdown Procedure
  957.  
  958. A special procedure exists for the case in which a PDP agent knows a
  959. particular port is about to become non-operational.
  960.  
  961.  
  962. 4.5.5.1.  PDP Shutdown Transmission
  963.  
  964. In the event an interface, currently configured with PDP message
  965. transmission enabled, either becomes disabled for PDP activity, or the
  966. interface is administratively disabled, a final PDP message is
  967. transmitted with a time to live value of zero (before the interface is
  968. disabled). This message is only sent if pdpOperStatus is enabled and no
  969. pdpSuppressEntry exists for the indicated local interface.
  970.  
  971. In the event the pdpOperStatus is transitioning to the disabled state,
  972. then this shutdown procedure should be executed for all local
  973. interfaces.
  974.  
  975.  
  976. 4.5.5.2.  PDP Shutdown Reception
  977.  
  978. After reception of a valid PDP message with a time-to-live value equal
  979. to zero, the PDP Agent must remove all information in the PTOPO MIB
  980. learned from the particular PDP agent, which is associated with the
  981. indicated remote connection endpoint.
  982.  
  983. If any entries are found, the ptopoConnTabDeletes counter is incremented
  984. for each deleted entry.
  985.  
  986. This procedure is only followed if pdpOperStatus is in the enabled state
  987. and no pdpSuppressEntry exists for the local interface on which the PDP
  988. message was received.
  989.  
  990.  
  991. 5.  PTOPO Discovery Protocol MIB
  992.  
  993. This section defines the MIB used to configure PDP agent behavior.
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002. Bierman/McCloghrie         Expires March 1998                  [Page 17]
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1009.  
  1010.  
  1011. 5.1.  Definitions
  1012.  
  1013. PDP-MIB DEFINITIONS ::= BEGIN
  1014.  
  1015. IMPORTS
  1016.     MODULE-IDENTITY, OBJECT-TYPE, Integer32, Counter32
  1017.         FROM SNMPv2-SMI
  1018.     RowStatus
  1019.         FROM SNMPv2-TC
  1020.     MODULE-COMPLIANCE, OBJECT-GROUP
  1021.         FROM SNMPv2-CONF
  1022.     PhysicalIndex
  1023.         FROM ENTITY-MIB;
  1024.  
  1025. pdpMIB MODULE-IDENTITY
  1026.     LAST-UPDATED "9707300000Z"
  1027.     ORGANIZATION "IETF PTOPOMIB Working Group"
  1028.     CONTACT-INFO
  1029.        "PTOPOMIB WG Discussion:
  1030.         ptopo@3com.com
  1031.         Subscription:
  1032.         majordomo@3com.com
  1033.           msg body: [un]subscribe ptopomib
  1034.  
  1035.         Andy Bierman
  1036.         Cisco Systems Inc.
  1037.         170 West Tasman Drive
  1038.         San Jose, CA 95134
  1039.         408-527-3711
  1040.         abierman@cisco.com
  1041.  
  1042.         Keith McCloghrie
  1043.         Cisco Systems Inc.
  1044.         170 West Tasman Drive
  1045.         San Jose, CA 95134
  1046.         408-526-5260
  1047.         kzm@cisco.com"
  1048.     DESCRIPTION
  1049.             "The MIB module for managing the Physical Topology Discovery
  1050.             Protocol."
  1051.     ::= { experimental xx }
  1052.  
  1053. pdpMIBObjects   OBJECT IDENTIFIER ::= { pdpMIB 1 }
  1054.  
  1055. -- MIB groups
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061. Bierman/McCloghrie         Expires March 1998                  [Page 18]
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1068.  
  1069.  
  1070. pdpConfig    OBJECT IDENTIFIER ::= { pdpMIBObjects 1 }
  1071. pdpStats     OBJECT IDENTIFIER ::= { pdpMIBObjects 2 }
  1072.  
  1073.  
  1074. PdpPortIdType ::=  TEXTUAL-CONVENTION
  1075.     STATUS        current
  1076.     DESCRIPTION
  1077.             "The type of index value used to represent a port component.
  1078.  
  1079.             If an object of this type has a value of 'ifIndexType(1)',
  1080.             then the associated 'port ID' value represents an ifEntry,
  1081.             with the same ifIndex value.
  1082.  
  1083.             If an object of this type has a value of
  1084.             'entPhysicalIndexType(2)', then the associated 'port ID'
  1085.             value represents an entPhysicalEntry, with the same
  1086.             entPhysicalIndex value."
  1087.     SYNTAX        INTEGER  {
  1088.                      ifIndexType(1),
  1089.                      entPhysicalIndexType(2)
  1090.                   }
  1091.  
  1092. --
  1093. --  ***********************************************************
  1094. --
  1095. --                    P D P    C O N F I G
  1096. --
  1097. --  ***********************************************************
  1098. --
  1099. --   The Physical Topology Discovery Protocol Configuration Group
  1100.  
  1101. pdpAdminStatus OBJECT-TYPE
  1102.     SYNTAX      INTEGER  {
  1103.                         enabled(1),
  1104.                         disabled(2)
  1105.                 }
  1106.     MAX-ACCESS  read-write
  1107.     STATUS      current
  1108.     DESCRIPTION
  1109.             "The administratively desired status of the the local PDP
  1110.             agent.
  1111.  
  1112.             If the agent is capable of storing non-volatile
  1113.             configuration, then the value of this object must be
  1114.             restored after a re-initialization of the management
  1115.  
  1116.  
  1117.  
  1118.  
  1119.  
  1120. Bierman/McCloghrie         Expires March 1998                  [Page 19]
  1121.  
  1122.  
  1123.  
  1124.  
  1125.  
  1126. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1127.  
  1128.  
  1129.             system."
  1130.     ::= { pdpConfig 1 }
  1131.  
  1132. pdpOperStatus OBJECT-TYPE
  1133.     SYNTAX      INTEGER  {
  1134.                         enabled(1),
  1135.                         disabled(2)
  1136.                 }
  1137.     MAX-ACCESS  read-only
  1138.     STATUS      current
  1139.     DESCRIPTION
  1140.             "The current operational status of the local PDP agent."
  1141.     ::= { pdpConfig 2 }
  1142.  
  1143. pdpMessageTxInterval OBJECT-TYPE
  1144.     SYNTAX      Integer32 (5..32768)
  1145.     UNITS       "seconds"
  1146.     MAX-ACCESS  read-write
  1147.     STATUS      current
  1148.     DESCRIPTION
  1149.             "The interval at which PDP messages are transmitted on
  1150.             behalf of this PDP agent.
  1151.  
  1152.             If the agent is capable of storing non-volatile
  1153.             configuration, then the value of this object must be
  1154.             restored after a re-initialization of the management
  1155.             system."
  1156.     DEFVAL       { 60 }
  1157.     ::= { pdpConfig 3 }
  1158.  
  1159. pdpMessageTxHoldMultiplier OBJECT-TYPE
  1160.     SYNTAX      Integer32 (2..10)
  1161.     MAX-ACCESS  read-write
  1162.     STATUS      current
  1163.     DESCRIPTION
  1164.             "The time-to-live value expressed as a multiple of the
  1165.             pdpMessageTxInterval object.  The actual time-to-live value
  1166.             used in PDP messages, transmitted on behalf of this PDP
  1167.             agent, can be expressed by the following formula:
  1168.  
  1169.             TTL = min(65535, (pdpMessageTxInterval * pdpMessageTxHoldMultiplier))
  1170.  
  1171.             For example, if the value of pdpMessageTxInterval is '60',
  1172.             and the value of pdpMessageTxHoldMultiplier is '3', then the
  1173.             value '180' is encoded in the TTL field in the PDP header.
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179. Bierman/McCloghrie         Expires March 1998                  [Page 20]
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1186.  
  1187.  
  1188.             If the agent is capable of storing non-volatile
  1189.             configuration, then the value of this object must be
  1190.             restored after a re-initialization of the management
  1191.             system."
  1192.     DEFVAL        { 3 }
  1193.     ::= { pdpConfig 4 }
  1194.  
  1195. pdpTxWithChecksum OBJECT-TYPE
  1196.     SYNTAX      TruthValue
  1197.     MAX-ACCESS  read-only
  1198.     STATUS      current
  1199.     DESCRIPTION
  1200.             "This object indicates whether the optional checksum field
  1201.             is generated for the PDP messages transmitted by this PDP
  1202.             agent.
  1203.  
  1204.             If this object has the value 'true(1)', then this PDP agent
  1205.             generates a (non-zero) valid PDP checksum for each
  1206.             transmitted PDP message.  If this object has the value
  1207.             'false(2)', then this PDP agent sets the PDP checksum to
  1208.             zero in each transmitted PDP message."
  1209.     ::= { pdpConfig 5 }
  1210.  
  1211. --
  1212. -- PdpSuppressTable:
  1213. --   Disable PDP activity on individual local ports
  1214.  
  1215. pdpSuppressTable   OBJECT-TYPE
  1216.     SYNTAX      SEQUENCE OF PdpSuppressEntry
  1217.     MAX-ACCESS  not-accessible
  1218.     STATUS      current
  1219.     DESCRIPTION
  1220.             "A table controlling PDP message transmission on individual
  1221.             interfaces, ports, or backplanes."
  1222.     ::= { pdpConfig 6 }
  1223.  
  1224. pdpSuppressEntry   OBJECT-TYPE
  1225.     SYNTAX      PdpSuppressEntry
  1226.     MAX-ACCESS  not-accessible
  1227.     STATUS      current
  1228.     DESCRIPTION
  1229.             "PDP message configuration information for a particular
  1230.             port.  The port must be contained in the same chassis as the
  1231.             PDP agent. PDP messages will not be transmitted or received
  1232.             on the indicated port, even if the port is enabled.
  1233.  
  1234.  
  1235.  
  1236.  
  1237.  
  1238. Bierman/McCloghrie         Expires March 1998                  [Page 21]
  1239.  
  1240.  
  1241.  
  1242.  
  1243.  
  1244. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1245.  
  1246.  
  1247.             If the agent is capable of storing non-volatile
  1248.             configuration, then each active pdpSuppressEntry must be
  1249.             re-created after a re-initialization of the management
  1250.             system.  An agent should store enough information about the
  1251.             associated entPhysicalEntry (e.g., entPhysicalAlias) or
  1252.             ifEntry (e.g. ifAlias), to properly re-create the entry,
  1253.             even if the pdpSuppressChassisId and/or pdpSuppressPortId
  1254.             values change across a system re-initialization."
  1255.     INDEX  {
  1256.         pdpSuppressChassisId,
  1257.         pdpSuppressPortIdType,
  1258.         pdpSuppressPortId
  1259.     }
  1260.     ::= { pdpSuppressTable 1 }
  1261.  
  1262. PdpSuppressEntry ::= SEQUENCE {
  1263.       pdpSuppressChassisId       PhysicalIndex,
  1264.       pdpSuppressPortIdType      PdpPortIdType,
  1265.       pdpSuppressPortId          Integer32,
  1266.       pdpSuppressRowStatus       RowStatus
  1267. }
  1268.  
  1269. pdpSuppressChassisId  OBJECT-TYPE
  1270.     SYNTAX      PhysicalIndex
  1271.     MAX-ACCESS  not-accessible
  1272.     STATUS      current
  1273.     DESCRIPTION
  1274.             "The entPhysicalIndex value used to identify the chassis
  1275.             component associated with this entry. The associated
  1276.             entPhysicalEntry must be active, and the associated
  1277.             entPhysicalClass object must be equal to 'chassis(3)'."
  1278.     ::= { pdpSuppressEntry 1 }
  1279.  
  1280. pdpSuppressPortIdType OBJECT-TYPE
  1281.     SYNTAX        PdpPortIdType
  1282.     MAX-ACCESS    not-accessible
  1283.     STATUS        current
  1284.     DESCRIPTION
  1285.             "The type of index value contained in the associated
  1286.             pdpSuppressPortId object."
  1287.     ::= { pdpSuppressEntry 2 }
  1288.  
  1289. pdpSuppressPortId    OBJECT-TYPE
  1290.     SYNTAX      Integer32  (1..2147483647)
  1291.     MAX-ACCESS  not-accessible
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297. Bierman/McCloghrie         Expires March 1998                  [Page 22]
  1298.  
  1299.  
  1300.  
  1301.  
  1302.  
  1303. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1304.  
  1305.  
  1306.     STATUS      current
  1307.     DESCRIPTION
  1308.             "The index value used to identify the port component of this
  1309.             entry.  The type of index value depends on the
  1310.             pdpSuppressPortIdType value for this entry.
  1311.  
  1312.             If the associated pdpSuppressPortIdType is equal to
  1313.             'ifIndexType(1)', then  this pdpSuppressPortId represents an
  1314.             ifEntry with the same ifIndex value.  The associated ifEntry
  1315.             must be active, and represent a physical interface on the
  1316.             local chassis.
  1317.  
  1318.             If the associated pdpSuppressPortIdType is equal to
  1319.             'entPhysicalIndexType(2)', then this pdpSuppressPortId
  1320.             represents an entPhysicalEntry with the same
  1321.             entPhysicalIndex value.  The associated entPhysicalEntry
  1322.             must be active, and the associated entPhysicalClass object
  1323.             must be equal to 'port(10)' or 'backplane(4)'."
  1324.     ::= { pdpSuppressEntry 3 }
  1325.  
  1326. pdpSuppressRowStatus  OBJECT-TYPE
  1327.     SYNTAX        RowStatus
  1328.     MAX-ACCESS    read-create
  1329.     STATUS        current
  1330.     DESCRIPTION
  1331.             "The status of this entry."
  1332.     ::= { pdpSuppressEntry 4 }
  1333.  
  1334. --
  1335. --  ***********************************************************
  1336. --
  1337. --                   P D P    S T A T S
  1338. --
  1339. --  ***********************************************************
  1340. --
  1341. -- PDP Stats Group
  1342.  
  1343. pdpStatsTable   OBJECT-TYPE
  1344.     SYNTAX      SEQUENCE OF PdpStatsEntry
  1345.     MAX-ACCESS  not-accessible
  1346.     STATUS      current
  1347.     DESCRIPTION
  1348.             "A table containing PDP statistics for individual ports.
  1349.  
  1350.             Entries are not required to exist in this table while the
  1351.  
  1352.  
  1353.  
  1354.  
  1355.  
  1356. Bierman/McCloghrie         Expires March 1998                  [Page 23]
  1357.  
  1358.  
  1359.  
  1360.  
  1361.  
  1362. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1363.  
  1364.  
  1365.             pdpAdminStatus or pdpOperStatus objects are equal to
  1366.             'disabled(2)'.
  1367.  
  1368.             Entries are not required to exist in this table if a
  1369.             corresponding entry (with identical index values) exists in
  1370.             the pdpSuppressTable."
  1371.     ::= { pdpStats 1 }
  1372.  
  1373. pdpStatsEntry   OBJECT-TYPE
  1374.     SYNTAX      PdpStatsEntry
  1375.     MAX-ACCESS  not-accessible
  1376.     STATUS      current
  1377.     DESCRIPTION
  1378.             "PDP message statistics for a particular port.  The port
  1379.             must be contained in the same chassis as the PDP agent."
  1380.     INDEX  {
  1381.              pdpStatsChassisId,
  1382.              pdpStatsPortIdType,
  1383.              pdpStatsPortId
  1384.     }
  1385.     ::= { pdpStatsTable 1 }
  1386.  
  1387. PdpStatsEntry ::= SEQUENCE {
  1388.       pdpStatsChassisId       PhysicalIndex,
  1389.       pdpStatsPortIdType      PdpPortIdType,
  1390.       pdpStatsPortId          Integer32,
  1391.       pdpStatsInPkts          Counter32,
  1392.       pdpStatsInErrors        Counter32,
  1393.       pdpStatsOutPkts         Counter32
  1394. }
  1395.  
  1396. pdpStatsChassisId  OBJECT-TYPE
  1397.     SYNTAX      PhysicalIndex
  1398.     MAX-ACCESS  not-accessible
  1399.     STATUS      current
  1400.     DESCRIPTION
  1401.             "The entPhysicalIndex value used to identify the chassis
  1402.             component associated with this entry. The associated
  1403.             entPhysicalEntry must be active, and the associated
  1404.             entPhysicalClass object must be equal to 'chassis(3)'."
  1405.     ::= { pdpStatsEntry 1 }
  1406.  
  1407. pdpStatsPortIdType OBJECT-TYPE
  1408.     SYNTAX        PdpPortIdType
  1409.     MAX-ACCESS    not-accessible
  1410.  
  1411.  
  1412.  
  1413.  
  1414.  
  1415. Bierman/McCloghrie         Expires March 1998                  [Page 24]
  1416.  
  1417.  
  1418.  
  1419.  
  1420.  
  1421. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1422.  
  1423.  
  1424.     STATUS        current
  1425.     DESCRIPTION
  1426.             "The type of index value contained in the associated
  1427.             pdpStatsPortId object."
  1428.     ::= { pdpStatsEntry 2 }
  1429.  
  1430. pdpStatsPortId    OBJECT-TYPE
  1431.     SYNTAX      Integer32  (1..2147483647)
  1432.     MAX-ACCESS  not-accessible
  1433.     STATUS      current
  1434.     DESCRIPTION
  1435.             "The index value used to identify the port component of this
  1436.             entry.  The type of index value depends on the
  1437.             pdpStatsPortType value for this entry.
  1438.  
  1439.             If the associated pdpStatsPortIdType is equal to
  1440.             'ifIndexType(1)', then  this pdpStatsPortId represents an
  1441.             ifEntry with the same ifIndex value.  The associated ifEntry
  1442.             must be active, and represent a physical interface on the
  1443.             local chassis.
  1444.  
  1445.             If the associated pdpStatsPortIdType is equal to
  1446.             'entPhysicalIndexType(2)', then this pdpStatsPortId
  1447.             represents an entPhysicalEntry with the same
  1448.             entPhysicalIndex value.  The associated entPhysicalEntry
  1449.             must be active, and the associated entPhysicalClass object
  1450.             must be equal to 'port(10)' or 'backplane(4)'."
  1451.     ::= { pdpStatsEntry 3 }
  1452.  
  1453. pdpStatsInPkts  OBJECT-TYPE
  1454.     SYNTAX        Counter32
  1455.     MAX-ACCESS    read-only
  1456.     STATUS        current
  1457.     DESCRIPTION
  1458.             "The number of valid PDP messages received by this PDP agent
  1459.             on the indicated port, while this PDP agent is enabled."
  1460.     ::= { pdpStatsEntry 4 }
  1461.  
  1462. pdpStatsInErrors  OBJECT-TYPE
  1463.     SYNTAX        Counter32
  1464.     MAX-ACCESS    read-only
  1465.     STATUS        current
  1466.     DESCRIPTION
  1467.             "The number of invalid PDP messages received by this PDP
  1468.             agent on the indicated port, while this PDP agent is
  1469.  
  1470.  
  1471.  
  1472.  
  1473.  
  1474. Bierman/McCloghrie         Expires March 1998                  [Page 25]
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1481.  
  1482.  
  1483.             enabled. A PDP message may be invalid for several reasons,
  1484.             including:
  1485.                - invalid MAC header; length or DA fields
  1486.                - invalid PDP header; version or flags fields
  1487.                - invalid PDP VarBindList ASN.1/BER encoding
  1488.                - invalid or missing PDP VarBindList data elements"
  1489.     ::= { pdpStatsEntry 5 }
  1490.  
  1491. pdpStatsOutPkts  OBJECT-TYPE
  1492.     SYNTAX        Counter32
  1493.     MAX-ACCESS    read-only
  1494.     STATUS        current
  1495.     DESCRIPTION
  1496.             "The number of PDP messages transmitted by this PDP agent on
  1497.             the indicated port."
  1498.     ::= { pdpStatsEntry 6 }
  1499.  
  1500.  
  1501. -- conformance information
  1502. pdpConformance OBJECT IDENTIFIER ::= { pdpMIB 2 }
  1503.  
  1504. pdpCompliances OBJECT IDENTIFIER ::= { pdpConformance 1 }
  1505. pdpGroups      OBJECT IDENTIFIER ::= { pdpConformance 2 }
  1506.  
  1507. -- compliance statements
  1508.  
  1509. pdpCompliance MODULE-COMPLIANCE
  1510.    STATUS  current
  1511.     DESCRIPTION
  1512.             "The compliance statement for SNMP entities which implement
  1513.             the PDP MIB."
  1514.     MODULE  -- this module
  1515.         MANDATORY-GROUPS { pdpConfigGroup, pdpStatsGroup }
  1516.  
  1517.     ::= { pdpCompliances 1 }
  1518.  
  1519. -- MIB groupings
  1520.  
  1521. pdpConfigGroup    OBJECT-GROUP
  1522.     OBJECTS {
  1523.         pdpAdminStatus,
  1524.         pdpOperStatus,
  1525.         pdpMessageTxInterval,
  1526.         pdpMessageTxHoldMultiplier,
  1527.         pdpTxWithChecksum,
  1528.  
  1529.  
  1530.  
  1531.  
  1532.  
  1533. Bierman/McCloghrie         Expires March 1998                  [Page 26]
  1534.  
  1535.  
  1536.  
  1537.  
  1538.  
  1539. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1540.  
  1541.  
  1542.         pdpSuppressRowStatus
  1543.     }
  1544.     STATUS  current
  1545.     DESCRIPTION
  1546.             "The collection of objects which are used to configure the
  1547.             PTOPO Discovery Protocol implementation behavior.
  1548.  
  1549.             This group is mandatory for agents which implement the PTOPO
  1550.             Discovery Protocol."
  1551.     ::= { pdpGroups 1 }
  1552.  
  1553. pdpStatsGroup    OBJECT-GROUP
  1554.     OBJECTS {
  1555.         pdpStatsInPkts,
  1556.         pdpStatsInErrors,
  1557.         pdpStatsOutPkts
  1558.     }
  1559.     STATUS  current
  1560.     DESCRIPTION
  1561.             "The collection of objects which are used to represent PTOPO
  1562.             Discovery Protocol statistics.
  1563.  
  1564.             This group is mandatory for agents which implement the PTOPO
  1565.             Discovery Protocol."
  1566.     ::= { pdpGroups 2 }
  1567.  
  1568. END
  1569.  
  1570.  
  1571. 6.  Acknowledgements
  1572.  
  1573. The PTOPO Discovery Protocol is a product of the IETF PTOPOMIB Working
  1574. Group.
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.  
  1592. Bierman/McCloghrie         Expires March 1998                  [Page 27]
  1593.  
  1594.  
  1595.  
  1596.  
  1597.  
  1598. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1599.  
  1600.  
  1601. 7.  References
  1602.  
  1603. [ENTITY-EXT]
  1604.      Bierman, A., McCloghrie, K., "Entity MIB Extensions for Persistent
  1605.      Component Identification", draft-bierman-entmib-compid-00.txt,
  1606.      Cisco Systems, July 1997.
  1607.  
  1608. [PTOPO]
  1609.      Bierman, A., Kones, K., "Physical Topology MIB", draft-ietf-
  1610.      ptopomib-mib-00.txt, Cisco Systems, Bay Networks, July 1997.
  1611.  
  1612. [RFC1157]
  1613.      Case, J., M. Fedor, M. Schoffstall, J. Davin, "Simple Network
  1614.      Management Protocol", RFC 1157, SNMP Research, Performance Systems
  1615.      International, MIT Laboratory for Computer Science, May 1990.
  1616.  
  1617. [RFC1213]
  1618.      McCloghrie, K., and M. Rose, Editors, "Management Information Base
  1619.      for Network Management of TCP/IP-based internets: MIB-II", STD 17,
  1620.      RFC 1213, Hughes LAN Systems, Performance Systems International,
  1621.      March 1991.
  1622.  
  1623. [RFC1573]
  1624.      McCloghrie, K., and Kastenholtz, F., "Interfaces Group Evolution",
  1625.      RFC 1573, Hughes LAN Systems, FTP Software, January 1994.
  1626.  
  1627. [RFC1902]
  1628.      SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  1629.      S. Waldbusser, "Structure of Management Information for version 2
  1630.      of the Simple Network Management Protocol (SNMPv2)", RFC 1902,
  1631.      January 1996.
  1632.  
  1633. [RFC1903]
  1634.      SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  1635.      S. Waldbusser, "Textual Conventions for version 2 of the Simple
  1636.      Network Management Protocol (SNMPv2)", RFC 1903, January 1996.
  1637.  
  1638. [RFC1904]
  1639.      SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  1640.      S. Waldbusser, "Conformance Statements for version 2 of the Simple
  1641.      Network Management Protocol (SNMPv2)", RFC 1904, January 1996.
  1642.  
  1643. [RFC1905]
  1644.      SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and
  1645.      S. Waldbusser, "Protocol Operations for version 2 of the Simple
  1646.  
  1647.  
  1648.  
  1649.  
  1650.  
  1651. Bierman/McCloghrie         Expires March 1998                  [Page 28]
  1652.  
  1653.  
  1654.  
  1655.  
  1656.  
  1657. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1658.  
  1659.  
  1660.      Network Management Protocol (SNMPv2)", RFC 1905, January 1996.
  1661.  
  1662. [RFC2037]
  1663.      McCloghrie, K., Bierman, A., "Entity MIB using SMIv2", RFC 2037,
  1664.      Cisco Systems, October 1996.
  1665.  
  1666.  
  1667.  
  1668.  
  1669.  
  1670.  
  1671.  
  1672.  
  1673.  
  1674.  
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680.  
  1681.  
  1682.  
  1683.  
  1684.  
  1685.  
  1686.  
  1687.  
  1688.  
  1689.  
  1690.  
  1691.  
  1692.  
  1693.  
  1694.  
  1695.  
  1696.  
  1697.  
  1698.  
  1699.  
  1700.  
  1701.  
  1702.  
  1703.  
  1704.  
  1705.  
  1706.  
  1707.  
  1708.  
  1709.  
  1710. Bierman/McCloghrie         Expires March 1998                  [Page 29]
  1711.  
  1712.  
  1713.  
  1714.  
  1715.  
  1716. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1717.  
  1718.  
  1719. 8.  Security Considerations
  1720.  
  1721. This protocol and associated MIB can expose the existence of physical
  1722. components, MAC layer addresses, and network layer addresses, pertaining
  1723. to devices within a given network.  A network administrator may wish to
  1724. restrict access to this management information, using SNMP access
  1725. control mechanisms, and restrict PDP message processing to a particular
  1726. set of ports, by configuring entries in the pdpSuppressTable.
  1727.  
  1728.  
  1729. 9.  Authors' Addresses
  1730.  
  1731.      Andy Bierman
  1732.      Cisco Systems, Inc.
  1733.      170 West Tasman Drive
  1734.      San Jose, CA 95134
  1735.      Phone: 408-527-3711
  1736.      Email: abierman@cisco.com
  1737.  
  1738.      Keith McCloghrie
  1739.      Cisco Systems, Inc.
  1740.      170 West Tasman Drive
  1741.      San Jose, CA 95134
  1742.      Phone: 408-526-5260
  1743.      Email: kzm@cisco.com
  1744.  
  1745.  
  1746.  
  1747.  
  1748.  
  1749.  
  1750.  
  1751.  
  1752.  
  1753.  
  1754.  
  1755.  
  1756.  
  1757.  
  1758.  
  1759.  
  1760.  
  1761.  
  1762.  
  1763.  
  1764.  
  1765.  
  1766.  
  1767.  
  1768.  
  1769. Bierman/McCloghrie         Expires March 1998                  [Page 30]
  1770.  
  1771.  
  1772.  
  1773.  
  1774.  
  1775. Draft               PTOPO Discovery Protocol and MIB      September 1997
  1776.  
  1777.  
  1778. Table of Contents
  1779.  
  1780.  
  1781. 1 Introduction ....................................................    1
  1782. 2 The SNMP Network Management Framework ...........................    2
  1783. 2.1 Object Definitions ............................................    2
  1784. 3 Overview ........................................................    2
  1785. 3.1 Terms .........................................................    3
  1786. 3.2 Persistent Identifiers ........................................    3
  1787. 3.3 Relationship to the Physical Topology MIB .....................    3
  1788. 3.4 Relationship to Entity MIB ....................................    3
  1789. 3.5 Relationship to Interfaces MIB ................................    4
  1790. 4 PTOPO Discovery Protocol ........................................    4
  1791. 4.1 Frame Encapsulation ...........................................    4
  1792. 4.2 PDP Forwarding ................................................    5
  1793. 4.3 PDP Message Format ............................................    5
  1794. 4.3.1 PDP Header Format ...........................................    5
  1795. 4.3.2 PDP PDU Encoding ............................................    7
  1796. 4.4 PDP Data MIB ..................................................    8
  1797. 4.4.1 Definitions .................................................    8
  1798. 4.5 Protocol Operation ............................................   12
  1799. 4.5.1 Protocol Initialization .....................................   13
  1800. 4.5.2 Message Encoding ............................................   13
  1801. 4.5.2.1 Header Fields .............................................   13
  1802. 4.5.2.2 VarBindList ...............................................   13
  1803. 4.5.2.3 Checksum ..................................................   14
  1804. 4.5.3 Message Transmission ........................................   14
  1805. 4.5.4 Received Message Processing .................................   15
  1806. 4.5.4.1 Header Fields .............................................   15
  1807. 4.5.4.2 Checksum ..................................................   15
  1808. 4.5.4.3 VarBindList ...............................................   16
  1809. 4.5.4.4 PTOPO MIB Update ..........................................   16
  1810. 4.5.5 Interface Shutdown Procedure ................................   17
  1811. 4.5.5.1 PDP Shutdown Transmission .................................   17
  1812. 4.5.5.2 PDP Shutdown Reception ....................................   17
  1813. 5 PTOPO Discovery Protocol MIB ....................................   17
  1814. 5.1 Definitions ...................................................   18
  1815. 6 Acknowledgements ................................................   27
  1816. 7 References ......................................................   28
  1817. 8 Security Considerations .........................................   30
  1818. 9 Authors' Addresses ..............................................   30
  1819.  
  1820.  
  1821.  
  1822.  
  1823.  
  1824.  
  1825.  
  1826.  
  1827.  
  1828. Bierman/McCloghrie         Expires March 1998                  [Page 31]
  1829.  
  1830.