idnits 2.17.1 draft-ietf-hubmib-efm-mib-06.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 16. -- Found old boilerplate from RFC 3978, Section 5.5, updated by RFC 4748 on line 2733. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 2698. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 2705. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 2711. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- == There are 5 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust Copyright Line does not match the current year == Line 272 has weird spacing: '...ficInfo dot3...' == Line 277 has weird spacing: '...ationTx dot3O...' == Line 278 has weird spacing: '...ationRx dot3O...' == Line 292 has weird spacing: '...dConfig dot...' == Line 298 has weird spacing: '...dConfig dot3O...' == (3 more instances...) == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (February 2007) is 6277 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Possible downref: Non-RFC (?) normative reference: ref. '802-2001' Summary: 1 error (**), 0 flaws (~~), 9 warnings (==), 8 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 INTERNET-DRAFT Matt Squire 3 Document: draft-ietf-hubmib-efm-mib-06.txt Hatteras Networks 4 Intended status: Proposed standard 5 Expires: August 2007 February 2007 7 Definitions and Managed Objects for OAM Functions on Ethernet Like 8 Interfaces 9 draft-ietf-hubmib-efm-mib-06.txt 11 Status of this Memo 13 By submitting this Internet-Draft, each author represents that any 14 applicable patent or other IPR claims of which he or she is aware 15 have been or will be disclosed, and any of which he or she becomes 16 aware will be disclosed, in accordance with Section 6 of BCP 79. 18 Internet-Drafts are working documents of the Internet Engineering 19 Task Force (IETF), its areas, and its working groups. Note that 20 other groups may also distribute working documents as Internet- 21 Drafts. 23 Internet-Drafts are draft documents valid for a maximum of six months 24 and may be updated, replaced, or obsoleted by other documents at any 25 time. It is inappropriate to use Internet-Drafts as reference 26 material or to cite them other than as "work in progress." 28 The list of current Internet-Drafts can be accessed at 29 http://www.ietf.org/ietf/1id-abstracts.txt 31 The list of Internet-Draft Shadow Directories can be accessed at 32 http://www.ietf.org/shadow.html. 34 This Internet-Draft will expire in August, 2007. 36 Abstract 38 This document defines objects for managing Operations, 39 Administration, and Maintenance (OAM) capabilities on Ethernet like 40 interfaces conformant to the Ethernet OAM functionality defined in 41 the Ethernet in the First Mile (EFM) clauses of the Ethernet 42 standards. The Ethernet OAM functionality is complementary to SNMP 43 management in that it is focused on a small set of link-specific 44 functions for directly connected Ethernet interfaces. This document 45 defines objects for controlling those link OAM functions, and for 46 providing results and status of the OAM functions to management 47 entities. 49 Conventions used in this document 51 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 52 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 53 document are to be interpreted as described in RFC 2119 [RFC2119]. 55 Table of Contents 57 1. Introduction...................................................2 58 2. The Internet-Standard Management Framework.....................2 59 3. Overview.......................................................3 60 3.1 Remote fault indication....................................4 61 3.2 Link monitoring............................................4 62 3.3 Remote loopback............................................5 63 3.4 Ethernet OAM Protocol Data Units...........................5 64 4. Relation to the Other MIB Modules..............................5 65 4.1 Relation to other MIB Modules..............................5 66 4.2 Relation to other EFM MIB Modules..........................6 67 4.3 Mapping of IEEE 802.3ah Managed Objects....................6 68 5. MIB Structure..................................................7 69 6. MIB Definition.................................................8 70 7. Security Considerations.......................................54 71 8. IANA Considerations...........................................56 72 9. References....................................................56 73 9.1 Normative References......................................56 74 9.2 Informative References....................................57 75 10. Acknowledgments..............................................58 76 11. Author's Address.............................................58 77 12. Intellectual Property Statement..............................59 78 13. Copyright Statement..........................................59 80 1. Introduction 82 The IEEE 802.3ah Ethernet in the First Mile (EFM) task force added 83 new management capabilities to Ethernet like interfaces. These 84 management capabilities were introduced to provide some basic OA 85 function on Ethernet media. The defined functionality includes 86 discovery, error signaling, loopback, and link monitoring. This memo 87 defines a portion of the Management Information Base (MIB) for use 88 with network management protocols in the Internet community to manage 89 these new Ethernet interface capabilities. 91 2. The Internet-Standard Management Framework 92 For a detailed overview of the documents that describe the current 93 Internet-Standard Management Framework, please refer to section 7 of 94 RFC 3410 [RFC3410]. 96 Managed objects are accessed via a virtual information store, termed 97 the Management Information Base or MIB. MIB objects are generally 98 accessed through the Simple Network Management Protocol (SNMP). 99 Objects in the MIB are defined using the mechanisms defined in the 100 Structure of Management Information (SMI). This memo specifies a MIB 101 module that is compliant to the SMIv2, which is described in STD 58, 102 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 103 [RFC2580]. 105 3. Overview 107 Ethernet networks have evolved over the past 30 years from simple 108 LANs to a variety of other applications, including wide area 109 networks. To address some of these emerging markets, the IEEE 110 802.3ah task force defined additional clauses in [802.3ah] for the 111 IEEE 802.3 standard [802.3-2002] to better address Ethernet 112 deployments in the public access network. Although Ethernet access 113 deployments were the primary motivation for the task force activity, 114 the results of the task force are not strictly limited to that 115 application. Ethernet OAM can be implemented on Ethernet links that 116 are not EFM. 118 The Ethernet in the First Mile (EFM) task force was focused on four 119 somewhat independent objectives to better address Ethernet access 120 deployments: optics, copper, Ethernet passive optical networks 121 (Ethernet PON, or EPON), and operations, administration, and 122 maintenance (OAM). The optics sub-taskforce developed new optical 123 physical layers that better served the long-reach outside plant 124 networks typically found in the access network, including developing 125 physical layers that operate up to 20Km and supporting the 126 environmental conditions of access deployments. The copper sub 127 taskforce developed two new physical layers that run Ethernet 128 natively over existing twisted pair wires that have been supporting 129 voice services for decades. The EPON sub-taskforce developed a new 130 point-to-multipoint Ethernet physical layer, utilizing Ethernet 131 framing natively over a time-division multiple-access (TDMA) 132 infrastructure. The OAM sub-taskforce introduced some basic 133 management functionality into an Ethernet link to better monitor and 134 maintain Ethernet networks in geographically disparate networks. 136 This document defines the management objects necessary to integrate 137 Ethernet OAM functionality into the SNMP management framework. 139 Ethernet OAM is composed of a core set of functions, and a set of 140 optional functional groups. The mandatory functions include 141 discovery operations (determining if the other end of the link is OA 142 capable, and what OAM functions it supports), state machine 143 implementation, and some critical event flows. The optional 144 functional groups are for (a) link events, (b) remote loopback, and 145 (c) variable retrieval and response. Each optional functional group 146 is controlled by a separate MIB table(s). 148 Ethernet OAM is complementary with SNMP management in that it 149 provides some basic management functions at layer two, rather than 150 using layer three and above as required by SNMP over an IP 151 infrastructure. Ethernet OAM provides single-hop functionality in 152 that it works only between two directly connected Ethernet stations. 153 SNMP can be used to manage the Ethernet OAM interactions of one 154 Ethernet station with another. 156 Ethernet OAM has three functional objectives which are detailed in 157 the next three sections. The definition of a basic Ethernet OA 158 protocol data unit is given in Section 3.4. 160 3.1 Remote fault indication 162 Remote fault indication provides a mechanism for one end of an 163 Ethernet link to signal the other end that the receive path is non 164 operational. Some Ethernet physical layers offer mechanisms to 165 signal this condition at the physical layer. Ethernet OAM added a 166 mechanism so that some Ethernet physical layers can operate in 167 unidirectional mode, allowing frames to be transmitted in one 168 direction even when the other direction is non-operational. 169 Traditionally, Ethernet PHYs do not allow frame transmission in one 170 direction if the other direction is not operational. Using this 171 mode, Ethernet OAM allows frame-based signaling of remote fault 172 conditions while still not allowing higher layer applications to be 173 aware of the unidirectional capability. This document includes 174 mechanisms for capturing that fault information and reflecting such 175 information in objects and notifications within the SNMP management 176 framework. 178 3.2 Link monitoring 180 Ethernet OAM includes event signaling capability so that one end of 181 an Ethernet link can indicate the occurrence of certain important 182 events to the other end of the link. This happens via layer two 183 protocols. This document defines methods for incorporating the 184 occurrence of these layer two events, both at the local end and far 185 end of the link, into the SNMP management framework. 187 Ethernet OAM also includes mechanisms for one Ethernet station to 188 query another directly connected Ethernet station about the status of 189 its Ethernet interface variables and status. This document does not 190 include mechanisms for controlling how one Ethernet endpoint may use 191 this functionality to query the status or statistics of a peer 192 Ethernet entity. 194 3.3 Remote loopback 196 Remote loopback is a link state where the peer Ethernet entity echoes 197 every received packet (without modifications) back onto the link. 198 Remote loopback is intrusive in that the other end of the link is not 199 forwarding traffic from higher layers out over the link. This 200 document defines objects controlling loopback operation and reading 201 the status of the loopback state. 203 3.4 Ethernet OAM Protocol Data Units 205 An Ethernet OAM protocol data unit is a valid Ethernet frame with a 206 destination MAC address equal to the reserved MAC address for Slow 207 Protocols (See 43B of [802.3ah]), a lengthOrType field equal to the 208 reserved type for Slow Protocols, and a Slow Protocols subtype equal 209 to that of the subtype reserved for Ethernet OAM. 211 OAMPDU is used throughout this document as an abbreviation for 212 Ethernet OAM protocol data unit. OAMPDUs are the mechanism by which 213 two directly connected Ethernet interfaces to exchange OA 214 information. 216 4. Relation to the Other MIB Modules 218 The definitions presented here are based on Clauses 30 and 57 of 219 [802.3ah]. Note that these clauses describe many of these variables 220 and their effects on the MAC layer. In some cases there is a one-to 221 one relationship between an object in this document and an object in 222 the Clause 30 MIB of [802.3ah]. In other cases, the objects of this 223 document reflect a more complex entity and are reflected by more than 224 one object in the Clause 30 MIB of [802.3ah]. 226 4.1 Relation to other MIB Modules 228 The objects defined in this document manage OAM functionality 229 introduced in [802.3ah] These objects do not overlap with the 230 interfaces MIB [RFC2863], the Ethernet like interfaces MIB [RFC3635], 231 or any other MIB currently used to manage various aspects of an 232 Ethernet interface. The objects defined here are defined for 233 Ethernet like interfaces only and use the same ifIndex as the 234 associated Ethernet interface. Ethernet OAM can be implemented on 235 any Ethernet like interface. 237 4.2 Relation to other EFM MIB Modules 239 The Ethernet OAM functionality and MIB Module is independent of the 240 other functionality and MIB Modules derived from [802.3ah] for copper 241 [802.3ah-copper] and EPON [802.3ah-epon]. Ethernet OAM may be 242 implemented (or not) on the new EFM interface types, just as it can 243 on any other Ethernet interface. 245 4.3 Mapping of IEEE 802.3ah Managed Objects 247 This section contains the mapping between managed objects defined in 248 [802.3ah] Clause 30, and managed objects defined in this document. 250 IEEE 802.3 Managed Object Corresponding SNMP object 252 oOA 253 .aOAMID IF-MIB ifIndex 254 .aOAMAdminState dot3OamAdminState 255 .aOAMMode dot3OamMode 256 .aOAMDiscoveryState dot3OamOperStatus 257 .aOAMRemoteMACAddress dot3OamPeerMacAddress 258 .aOAMLocalConfiguration dot3OamFunctionsSupported 259 .aOAMRemoteConfiguration dot3OamPeerFunctionsSupported, 260 dot3OamPeerMode 261 .aOAMLocalPDUConfiguration dot3OamMaxOamPduSize 262 .aOAMRemotePDUConfiguration dot3OamPeerMaxOamPduSize 263 .aOAMLocalFlagsField dot3OamOperStatus, 264 dot3OamEventLogEntry 265 .aOAMRemoteFlagsField dot3OamOperStatus, 266 dot3OamEventLogEntry 267 .aOAMLocalRevision dot3OamConfigRevision 268 .aOAMRemoteRevision dot3OamPeerConfigRevision 269 .aOAMLocalState dot3OamLoopbackStatus 270 .aOAMRemoteState dot3OamLoopbackStatus 271 .aOAMRemoteVendorOUI dot3OamPeerVendorOui 272 .aOAMRemoteVendorSpecificInfo dot3OamPeerVendorInfo 273 .aOAMUnsupportedCodesTx dot3OamUnsupportedCodesTx 274 .aOAMUnsupportedCodesRx dot3OamUnsupportedCodesRx 275 .aOAMInformationTx dot3OamInformationTx 276 .aOAMInformationRx dot3OamInformationRx 277 .aOAMUniqueEventNotificationTx dot3OamUniqueEventNotificationTx 278 .aOAMUniqueEventNotificationRx dot3OamUniqueEventNotificationRx 279 .aOAMDuplicateEventNotificationTx 280 dot3OamDuplicateEventNotificationTx 281 .aOAMDuplicateEventNotificationRx 282 dot3OamDuplicateEventNotificationRx 283 .aOAMLoopbackControlTx dot3OamLoopbackControlTx 284 .aOAMLoopbackControlRx dot3OamLoopbackControlRx 285 .aOAMVariableRequestTx dot3OamVariableRequestTx 286 .aOAMVariableRequestRx dot3OamVariableRequestRx 287 .aOAMVariableResponseTx dot3OamVariableResponseTx 288 .aOAMVariableResponseRx dot3OamVariableResponseRx 289 .aOAMOrganizationSpecificTx dot3OamOrgSpecificTx 290 .aOAMOrganizationSpecificRx dot3OamOrgSpecificTx 292 .aOAMLocalErrSymPeriodConfig dot3OamErrSymPeriodWindow, 293 dot3OamErrSymPeriodThreshold 294 .aOAMLocalErrSymPeriodEvent dot3OamEventLogEntry 295 .aOAMLocalErrFrameConfig dot3OamErrFrameWindow, 296 dot3OamErrFrameThreshold 297 .aOAMLocalErrFrameEvent dot3OamEventLogEntry 298 .aOAMLocalErrFramePeriodConfig dot3OamErrFramePeriodWindow, 299 dot3OamErrFramePeriodThreshold 300 .aOAMLocalErrFramePeriodEvent dot3OamEventLogEntry 301 .aOAMLocalErrFrameSecsSummaryConfig 302 dot3OamErrFrameSecsSummaryWindow, 303 dot3OamErrFrameSecssummaryThreshold 304 .aOAMLocalErrFrameSecsSummaryEvent 305 dot3OamEventLogEntry 306 .aOAMRemoteErrSymPeriodEvent dot3OamEventLogEntry 307 .aOAMRemoteErrFrameEvent dot3OamEventLogEntry 308 .aOAMRemoteErrFramePeriodEvent dot3OamEventLogEntry 309 .aOAMRemoteErrFrameSecsSummaryEvent 310 dot3OamEventLogEntry 311 .aFramesLostDueToOAmError dot3OamFramesLostDueToOam 312 .acOAMAdminControl dot3OamAdminState 314 There are no IEEE 802.3ah managed objects that are not reflected in 315 this MIB Module in some manner. 317 5. MIB Structure 319 The Ethernet OAM MIB objects of this memo focus on the OA 320 capabilities introduced in [802.3ah]. The MIB objects are 321 partitioned into six different MIB groups. 323 The dot3OamTable group manages the primary OAM objects of the 324 Ethernet interface. This group controls the state and status of OA 325 as well as the mode in which it operates. 327 The dot3OamPeerTable maintains the current information on the status 328 and configuration of the peer OAM entity on the Ethernet interface. 329 Managed information includes the capabilities and function available 330 on the peer OAM entity. 332 The dot3OamLoopbackTable manages the loopback function introduced in 333 [802.3ah]. This table controls enabling and disabling loopback, as 334 well as indicating the loopback status of Ethernet OAM on this 335 interface. 337 The dot3OamStatsTable maintains statistics on the number and type of 338 Ethernet OAM frames being transmitted and received on the Ethernet 339 interface. 341 The dot3OamEventConfigTable defines the objects for managing the 342 event notification capability available in Ethernet OAM. With 343 Ethernet OAM, one device may send notifications to its peer devices 344 whenever an important event happens on the local device. This table 345 provides management of which events result in notifications via 346 Ethernet OAM notifications and/or via SNMP notifications. 348 The dot3OamEventLogTable manages the current status of local and 349 remote events detected via Ethernet OAM. This table is updated 350 whenever local events are detected by Ethernet OAM or whenever 351 Ethernet OAM Event Notifications are received from the peer OA 352 entity. 354 There are two notifications defined to report Ethernet OAM events 355 (one for threshold crossing events, one for non-threshold crossing 356 events). Both notifications are contained within the same 357 conformance group. 359 6. MIB Definition 361 DOT3-OAM-MIB DEFINITIONS ::= BEGIN 363 IMPORTS 364 MODULE-IDENTITY, mib-2, OBJECT-TYPE, Counter32, Unsigned32, 365 Integer32, NOTIFICATION-TYPE 366 FROM SNMPv2-SMI 367 -- from [RFC2578] 368 TEXTUAL-CONVENTION, MacAddress, TimeStamp, TruthValue 369 FROM SNMPv2-TC 370 -- from [RFC2579] 371 CounterBasedGauge64 372 FROM HCNUM-TC 373 -- from [RFC2856] 374 ifIndex 375 FROM IF-MIB 376 -- from [RFC2863] 377 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP 378 FROM SNMPv2-CONF; 379 -- from [RFC2580] 381 dot3OamMIB MODULE-IDENTITY 382 LAST-UPDATED "200702140000Z" -- February 14,2007" 383 ORGANIZATION 384 "IETF Ethernet Interfaces and Hub MIB Working Group" 385 CONTACT-INFO 386 "WG Charter: 387 http://www.ietf.org/html.charters/hubmib-charter.html 388 Mailing lists: 389 General Discussion: hubmib@ietf.org 390 To Subscribe: hubmib-requests@ietf.org 391 In Body: subscribe your_email_address 392 Chair: Bert Wijnen 393 Alcatel-Lucent 394 Email: bwijnen at alcatel-lucent dot com 395 Editor: Matt Squire 396 Hatteras Networks 397 E-mail: msquire at hatterasnetworks dot com 398 " 399 DESCRIPTION 400 "The MIB module for managing the new Ethernet OAM features 401 introduced by the Ethernet in the First Mile task force (IEEE 402 802.3ah). The functionality presented here is based on IEEE 403 802.3ah [802.3ah], released in October, 2004. [802.3ah] was 404 prepared as an addendum to the standing version of IEEE 802.3 405 [802.3-2002] at the time. Since then, [802.3ah] has been 406 merged into the base IEEE 802.3 specification in [802.3-2005]. 408 In particular, this MIB focuses on the new OAM functions 409 introduced in Clause 57 of [802.3ah]. The OAM functionality 410 of Clause 57 is controlled by new management attributes 411 introduced in Clause 30 of [802.3ah]. The OAM functions are 412 not specific to any particular Ethernet physical layer, and 413 can be generically applied to any Ethernet interface of 414 [802.3-2002]. 416 An Ethernet OAM protocol data unit is a valid Ethernet frame 417 with a destination MAC address equal to the reserved MAC 418 address for Slow Protocols (See 43B of [802.3ah]), a 419 lengthOrType field equal to the reserved type for Slow 420 Protocols, and a Slow Protocols subtype equal to that of the 421 subtype reserved for Ethernet OAM. OAMPDU is used throughout 422 this document as an abbreviation for Ethernet OAM protocol 423 data unit. 425 The following reference is used throughout this MIB module: 427 [802.3ah] refers to: 428 IEEE Std 802.3ah-2004: 'Draft amendment to - 429 Information technology - Telecommunications and 430 information exchange between systems - Local and 431 metropolitan are networks - Specific requirements - Part 432 3: Carrier sense multiple access with collision detection 433 (CSMA/CD) access method and physical layer specifications 434 - Media Access Control Parameters, Physical Layers and 435 Management Parameters for subscriber access networks', 436 October 2004. 438 [802.3-2002] refers to: 439 IEEE Std 802.3-2002: 440 'Information technology - Telecommunications and 441 information exchange between systems - Local and 442 metropolitan are networks - Specific requirements - Part 443 3: Carrier sense multiple access with collision detection 444 (CSMA/CD) access method and physical layer specifications 445 - Media Access Control Parameters, Physical Layers and 446 Management Parameters for subscriber access networks', 447 March 2002. 449 [802.3-2005] refers to: 450 IEEE Std 802.3-2005: 451 'Information technology - Telecommunications and 452 information exchange between systems - Local and 453 metropolitan are networks - Specific requirements - Part 454 3: Carrier sense multiple access with collision detection 455 (CSMA/CD) access method and physical layer specifications 456 - Media Access Control Parameters, Physical Layers and 457 Management Parameters for subscriber access networks', 458 December 2005. 460 [802-2001] refers to: 461 'IEEE Standard for LAN/MAN (Local Area 462 Network/Metropolitan Area Network): Overview and 463 Architecture', IEEE 802, June 2001. 465 Copyright (c) The IETF Trust (2007). This version of 466 this MIB module is part of RFC XXXX; See the RFC itself for 467 full legal notices. " 468 -- RFC Editor: Update XXXX to appropriate RFC number 469 -- RFC Editor: Remove these notes 471 REVISION "200702140000Z" -- February 14, 2007" 472 DESCRIPTION "Initial version, published as RFC XXXX." 473 -- RFC Editor: Update XXXX to appropriate RFC number 474 -- RFC Editor: Remove these notes 476 ::= { mib-2 XXX } 477 -- RFC Editor: Replace value with IANA assigned number 478 -- RFC Editor: Remove these notes 480 -- 481 -- Sections of the Ethernet OAM MIB 482 -- 483 dot3OamNotifications OBJECT IDENTIFIER ::= { dot3OamMIB 0 } 484 dot3OamObjects OBJECT IDENTIFIER ::= { dot3OamMIB 1 } 485 dot3OamConformance OBJECT IDENTIFIER ::= { dot3OamMIB 2 } 487 -- 488 -- Textual conventions for OAM MIB 489 -- 490 EightOTwoOui ::= TEXTUAL-CONVENTION 491 STATUS current 492 DESCRIPTION 493 "24-bit Organizationally Unique Identifier. Information on 494 OUIs can be found in IEEE 802-2001 [802-2001] Clause 9." 495 SYNTAX OCTET STRING(SIZE(3)) 497 -- *************************************************************** 498 -- 499 -- Ethernet OAM Control group 500 -- 502 dot3OamTable OBJECT-TYPE 503 SYNTAX SEQUENCE OF Dot3OamEntry 504 MAX-ACCESS not-accessible 505 STATUS current 506 DESCRIPTION 507 "This table contains the primary controls and status for the 508 OAM capabilities of an Ethernet like interface. There will be 509 one row in this table for each Ethernet like interface in the 510 system that supports the OAM functions defined in [802.3ah]. 511 " 512 ::= { dot3OamObjects 1 } 514 dot3OamEntry OBJECT-TYPE 515 SYNTAX Dot3OamEntry 516 MAX-ACCESS not-accessible 517 STATUS current 518 DESCRIPTION 519 "An entry in the table, containing information on the Ethernet 520 OAM function for a single Ethernet like interface. Entries in 521 the table are created automatically for each interface 522 supporting Ethernet OAM. The status of the row entry can be 523 determined from dot3OamOperStatus. 525 A dot3OamEntry is indexed in the dot3OamTable by the ifIndex 526 object of the Interfaces MIB. 527 " 528 INDEX { ifIndex } 529 ::= { dot3OamTable 1 } 531 Dot3OamEntry ::= 532 SEQUENCE { 533 dot3OamAdminState INTEGER, 534 dot3OamOperStatus INTEGER, 535 dot3OamMode INTEGER, 536 dot3OamMaxOamPduSize Unsigned32, 537 dot3OamConfigRevision Unsigned32, 538 dot3OamFunctionsSupported BITS 539 } 541 dot3OamAdminState OBJECT-TYPE 542 SYNTAX INTEGER { 543 enabled(1), 544 disabled(2) 545 } 546 MAX-ACCESS read-write 547 STATUS current 548 DESCRIPTION 549 "This object is used to provision the default administrative 550 OAM mode for this interface. This object represents the 551 desired state of OAM for this interface. 553 The dot3OamAdminState always starts in the disabled(2) state 554 until an explicit management action or configuration 555 information retained by the system causes a transition to the 556 enabled(1) state. When enabled(1), Ethernet OAM will attempt 557 to operate over this interface. 558 " 559 REFERENCE "[802.3ah], 30.3.6.1.2" 560 ::= { dot3OamEntry 1 } 562 dot3OamOperStatus OBJECT-TYPE 563 SYNTAX INTEGER { 564 disabled(1), 565 linkFault(2), 566 passiveWait(3), 567 activeSendLocal(4), 568 sendLocalAndRemote(5), 569 sendLocalAndRemoteOk(6), 570 oamPeeringLocallyRejected(7), 571 oamPeeringRemotelyRejected(8), 572 operational(9), 573 nonOperHalfDuplex(10) 574 } 575 MAX-ACCESS read-only 576 STATUS current 577 DESCRIPTION 578 "At initialization and failure conditions, two OAM entities on 579 the same full-duplex Ethernet link begin a discovery phase to 580 determine what OAM capabilities may be used on that link. The 581 progress of this initialization is controlled by the OA 582 sublayer. 584 This value is always disabled(1) if OAM is disabled on this 585 interface via the dot3OamAdminState. 587 If the link has detected a fault and is transmitting OAMPDUs 588 with a link fault indication, the value is linkFault(2). Also, 589 if the interface is not operational (ifOperStatus is not 590 up(1)), linkFault(2) is returned. Note that the object 591 ifOperStatus may not be up(1) as a result of link failure or 592 administrative action (ifAdminState being down(2) or 593 testing(3)). 595 The passiveWait(3) state is returned only by OAM entities in 596 passive mode (dot3OamMode) and reflects the state in which the 597 OAM entity is waiting to see if the peer device is OA 598 capable. The activeSendLocal(4) value is used by active mode 599 devices (dot3OamMode) and reflects the OAM entity actively 600 trying to discover whether the peer has OAM capability but has 601 not yet made that determination. 603 The state sendLocalAndRemote(5) reflects that the local OA 604 entity has discovered the peer but has not yet accepted or 605 rejected the configuration of the peer. The local device can, 606 for whatever reason, decide that the peer device is 607 unacceptable and decline OAM peering. If the local OAM entity 608 rejects the peer OAM entity, the state becomes 609 oamPeeringLocallyRejected(7). If the OAM peering is allowed 610 by the local device, the state moves to 611 sendLocalAndRemoteOk(6). Note that both the 612 sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states 613 fall within the state SEND_LOCAL_REMOTE of the Discovery state 614 diagram [802.3ah, Figure 57-5], with the difference being 615 whether the local OAM client has actively rejected the peering 616 or has just not indicated any decision yet. Whether a peering 617 decision has been made is indicated via the local flags field 618 in the OAMPDU (reflected in the aOAMLocalFlagsField of 619 30.3.6.1.10). 621 If the remote OAM entity rejects the peering, the state 622 becomes oamPeeringRemotelyRejected(8). Note that both the 623 sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8) 624 states fall within the state SEND_LOCAL_REMOTE_OK of the 625 Discovery state diagram [802.3ah, Figure 57-5], with the 626 difference being whether the remote OAM client has rejected 627 the peering or has just not yet decided. This is indicated 628 via the remote flags field in the OAM PDU (reflected in the 629 aOAMRemoteFlagsField of 30.3.6.1.11). 631 When the local OAM entity learns that both it and the remote 632 OAM entity have accepted the peering, the state moves to 633 operational(9) corresponding to the SEND_ANY state of the 634 Discovery state diagram [802.3ah, Figure 57-5]. 636 Since Ethernet OAM functions are not designed to work 637 completely over half-duplex interfaces, the value 638 nonOperHalfDuplex(10) is returned whenever Ethernet OAM is 639 enabled (dot3OamAdminState is enabled(1)) but the interface is 640 in half-duplex operation. 641 " 642 REFERENCE "[802.3ah], 30.3.6.1.4, 30.3.6.1.10, 30.3.6.1.11" 643 ::= { dot3OamEntry 2 } 645 dot3OamMode OBJECT-TYPE 646 SYNTAX INTEGER { 647 passive(1), 648 active(2) 649 } 650 MAX-ACCESS read-write 651 STATUS current 652 DESCRIPTION 653 "This object configures the mode of OAM operation for this 654 Ethernet like interface. OAM on Ethernet interfaces may be in 655 'active' mode or 'passive' mode. These two modes differ in 656 that active mode provides additional capabilities to initiate 657 monitoring activities with the remote OAM peer entity, while 658 passive mode generally waits for the peer to initiate OA 659 actions with it. As an example, an active OAM entity can put 660 the remote OAM entity in a loopback state, where a passive OA 661 entity cannot. 663 The default value of dot3OamMode is dependent on the type of 664 system on which this Ethernet like interface resides. The 665 default value should be 'active(2)' unless it is known that 666 this system should take on a subservient role to the other 667 device connected over this interface. 669 Changing this value results in incrementing the configuration 670 revision field of locally generated OAMPDUs (30.3.6.1.12) and 671 potentially re-doing the OAM discovery process if the 672 dot3OamOperStatus was already operational(9). 673 " 674 REFERENCE "[802.3ah], 30.3.6.1.3" 675 ::= { dot3OamEntry 3 } 677 dot3OamMaxOamPduSize OBJECT-TYPE 678 SYNTAX Unsigned32 (64..1518) 679 UNITS "octets" 680 MAX-ACCESS read-only 681 STATUS current 682 DESCRIPTION 683 "The largest OAMPDU that the OAM entity supports. OA 684 entities exchange maximum OAMPDU sizes and negotiate to use 685 the smaller of the two maximum OAMPDU sizes between the peers. 686 This value is determined by the local implementation. 687 " 688 REFERENCE "[802.3ah], 30.3.6.1.8" 689 ::= { dot3OamEntry 4 } 691 dot3OamConfigRevision OBJECT-TYPE 692 SYNTAX Unsigned32(0..65535) 693 MAX-ACCESS read-only 694 STATUS current 695 DESCRIPTION 696 "The configuration revision of the OAM entity as reflected in 697 the latest OAMPDU sent by the OAM entity. The config revision 698 is used by OAM entities to indicate configuration changes have 699 occurred which might require the peer OAM entity to 700 re-evaluate whether OAM peering is allowed. 701 " 702 REFERENCE "[802.3ah], 30.3.6.1.12" 703 ::= { dot3OamEntry 5 } 705 dot3OamFunctionsSupported OBJECT-TYPE 706 SYNTAX BITS { 707 unidirectionalSupport (0), 708 loopbackSupport(1), 709 eventSupport(2), 710 variableSupport(3) 711 } 712 MAX-ACCESS read-only 713 STATUS current 714 DESCRIPTION 715 "The OAM functions supported on this Ethernet like interface. 716 OAM consists of separate functional sets beyond the basic 717 discovery process which is always required. These functional 718 groups can be supported independently by any implementation. 719 These values are communicated to the peer via the local 720 configuration field of Information OAMPDUs. 722 Setting 'unidirectionalSupport(0)' indicates that the OA 723 entity supports the transmission of OAMPDUs on links that are 724 operating in undirectional mode (traffic flowing in one 725 direction only). Setting 'loopbackSupport(1)' indicates the 726 OAM entity can initiate and respond to loopback commands. 727 Setting 'eventSupport(2)' indicates the OAM entity can send 728 and receive Event Notification OAMPDUs. Setting 729 'variableSupport(3)' indicates the OAM entity can send and 730 receive Variable Request and Response OAMPDUs. 731 " 732 REFERENCE "[802.3ah], 30.3.6.1.6" 733 ::= { dot3OamEntry 6 } 735 -- *************************************************************** 736 -- 737 -- Ethernet OAM Peer group 738 -- 740 dot3OamPeerTable OBJECT-TYPE 741 SYNTAX SEQUENCE OF Dot3OamPeerEntry 742 MAX-ACCESS not-accessible 743 STATUS current 744 DESCRIPTION 745 "This table contains information about the OAM peer for a 746 particular Ethernet like interface. OAM entities communicate 747 with a single OAM peer entity on Ethernet links on which OA 748 is enabled and operating properly. There is one entry in this 749 table for each entry in the dot3OamTable for which information 750 on the peer OAM entity is available. 751 " 752 ::= { dot3OamObjects 2 } 754 dot3OamPeerEntry OBJECT-TYPE 755 SYNTAX Dot3OamPeerEntry 756 MAX-ACCESS not-accessible 757 STATUS current 758 DESCRIPTION 759 "An entry in the table, containing information on the peer OA 760 entity for a single Ethernet like interface. 762 Note that there is at most one OAM peer for each Ethernet like 763 interface. Entries are automatically created when information 764 about the OAM peer entity becomes available, and automatically 765 deleted when the OAM peer entity is no longer in 766 communication. Peer information is not available when 767 dot3OamOperStatus is disabled(1), linkFault(2), 768 passiveWait(3), activeSendLocal(4), or nonOperHalfDuplex(10). 769 " 770 INDEX { ifIndex } 771 ::= { dot3OamPeerTable 1 } 773 Dot3OamPeerEntry ::= 774 SEQUENCE { 775 dot3OamPeerMacAddress MacAddress, 776 dot3OamPeerVendorOui EightOTwoOui, 777 dot3OamPeerVendorInfo Unsigned32, 778 dot3OamPeerMode INTEGER, 779 dot3OamPeerMaxOamPduSize Unsigned32, 780 dot3OamPeerConfigRevision Unsigned32, 781 dot3OamPeerFunctionsSupported BITS 782 } 784 dot3OamPeerMacAddress OBJECT-TYPE 785 SYNTAX MacAddress 786 MAX-ACCESS read-only 787 STATUS current 788 DESCRIPTION 789 "The MAC address of the peer OAM entity. The MAC address is 790 derived from the most recently received OAMPDU. 791 " 792 REFERENCE "[802.3ah], 30.3.6.1.5." 793 ::= { dot3OamPeerEntry 1 } 795 dot3OamPeerVendorOui OBJECT-TYPE 796 SYNTAX EightOTwoOui 797 MAX-ACCESS read-only 798 STATUS current 799 DESCRIPTION 800 "The OUI of the OAM peer as reflected in the latest 801 Information OAMPDU received with a Local Information TLV. The 802 OUI can be used to identify the vendor of the remote OA 803 entity. This value is initialized to three octets of zero 804 before any Local Information TLV is received. 805 " 806 REFERENCE "[802.3ah], 30.3.6.1.16." 807 ::= { dot3OamPeerEntry 2 } 809 dot3OamPeerVendorInfo OBJECT-TYPE 810 SYNTAX Unsigned32 811 MAX-ACCESS read-only 812 STATUS current 813 DESCRIPTION 814 "The Vendor Info of the OAM peer as reflected in the latest 815 Information OAMPDU received with a Local Information TLV. 816 The semantics of the vendor information field is proprietary 817 and specific to the vendor (identified by the 818 dot3OamPeerVendorOui). This information could, for example, 819 be used to identify a specific product or product family. 820 This value is initialized to zero before any Local 821 Information TLV is received. 822 " 823 REFERENCE "[802.3ah], 30.3.6.1.17." 824 ::= { dot3OamPeerEntry 3 } 826 dot3OamPeerMode OBJECT-TYPE 827 SYNTAX INTEGER { 828 passive(1), 829 active(2), 830 unknown(3) 831 } 832 MAX-ACCESS read-only 833 STATUS current 834 DESCRIPTION 835 "The mode of the OAM peer as reflected in the latest 836 Information OAMPDU received with a Local Information TLV. The 837 mode of the peer can be determined from the Configuration 838 field in the Local Information TLV of the last Information 839 OAMPDU received from the peer. The value is unknown(3) 840 whenever no Local Information TLV has been received. The 841 values of active(2) and passive(1) are returned when a Local 842 Information TLV has been received indicating the peer is in 843 active or passive mode, respectively. 844 " 845 REFERENCE "[802.3ah], 30.3.6.1.7." 846 ::= { dot3OamPeerEntry 4 } 848 dot3OamPeerMaxOamPduSize OBJECT-TYPE 849 SYNTAX Unsigned32 (0 | 64..1518) 850 UNITS "octets" 851 MAX-ACCESS read-only 852 STATUS current 853 DESCRIPTION 854 "The maximum size of OAMPDU supported by the peer as reflected 855 in the latest Information OAMPDU received with a Local 856 Information TLV. Ethernet OAM on this interface must not use 857 OAMPDUs that exceed this size. The maximum OAMPDU size can be 858 determined from the PDU Configuration field of the Local 859 Information TLV of the last Information OAMPDU received from 860 the peer. A value of zero is returned if no Local Information 861 TLV has been received. Otherwise, the value of the OAM peer's 862 maximum OAMPDU size is returned in this value. 863 " 864 REFERENCE "[802.3ah], 30.3.6.1.9." 865 ::= { dot3OamPeerEntry 5 } 867 dot3OamPeerConfigRevision OBJECT-TYPE 868 SYNTAX Unsigned32(0..65535) 869 MAX-ACCESS read-only 870 STATUS current 871 DESCRIPTION 872 "The configuration revision of the OAM peer as reflected in 873 the latest OAMPDU. This attribute is changed by the peer 874 whenever it has a local configuration change for Ethernet OA 875 this interface. The configuration revision can be determined 876 from the Revision field of the Local Information TLV of the 877 most recently received Information OAMPDU with a Local 878 Information TLV. A value of zero is returned if no Local 879 Information TLV has been received. 880 " 881 REFERENCE "[802.3ah], 30.3.6.1.13." 882 ::= { dot3OamPeerEntry 6 } 884 dot3OamPeerFunctionsSupported OBJECT-TYPE 885 SYNTAX BITS { 886 unidirectionalSupport (0), 887 loopbackSupport(1), 888 eventSupport(2), 889 variableSupport(3) 890 } 891 MAX-ACCESS read-only 892 STATUS current 893 DESCRIPTION 894 "The OAM functions supported on this Ethernet like interface. 895 OAM consists of separate functionality sets above the basic 896 discovery process. This value indicates the capabilities of 897 the peer OAM entity with respect to these functions. This 898 value is initialized so all bits are clear. 900 If unidirectionalSupport(0) is set, then the peer OAM entity 901 supports sending OAM frames on Ethernet interfaces when the 902 receive path is known to be inoperable. If 903 loopbackSupport(1) is set, then the peer OAM entity can send 904 and receive OAM loopback commands. If eventSupport(2) is set, 905 then the peer OAM entity can send and receive event OAMPDUs to 906 signal various error conditions. If variableSupport(3) is set, 907 then the peer OAM entity can send and receive variable 908 requests to monitor attribute value as described in Clause 57 909 of [802.3ah]. 911 The capabilities of the OAM peer can be determined from the 912 configuration field of the Local Information TLV of the most 913 recently received Information OAMPDU with a Local Information 914 TLV. All zeros are returned if no Local Information TLV has 915 yet been received. 916 " 917 REFERENCE "[802.3ah], REFERENCE 30.3.6.1.7." 918 ::= { dot3OamPeerEntry 7 } 920 -- *************************************************************** 921 -- 922 -- Ethernet OAM Loopback group 923 -- 925 dot3OamLoopbackTable OBJECT-TYPE 926 SYNTAX SEQUENCE OF Dot3OamLoopbackEntry 927 MAX-ACCESS not-accessible 928 STATUS current 929 DESCRIPTION 930 "This table contains controls for the loopback state of the 931 local link as well as indicating the status of the loopback 932 function. There is one entry in this table for each entry in 933 dot3OamTable that supports loopback functionality (where 934 dot3OamFunctionsSupported includes the loopbackSupport bit 935 set). 937 Loopback can be used to place the remote OAM entity in a state 938 where every received frame (except OAMPDUs) are echoed back 939 over the same interface on which they were received. In this 940 state, at the remote entity, 'normal' traffic is disabled as 941 only the looped back frames are transmitted on the interface. 942 Loopback is thus an intrusive operation that prohibits normal 943 data flow and should be used accordingly. " 944 ::= { dot3OamObjects 3 } 946 dot3OamLoopbackEntry OBJECT-TYPE 947 SYNTAX Dot3OamLoopbackEntry 948 MAX-ACCESS not-accessible 949 STATUS current 950 DESCRIPTION 951 "An entry in the table, containing information on the loopback 952 status for a single Ethernet like interface. Entries in the 953 table are automatically created whenever the local OAM entity 954 supports loopback capabilities. The loopback status on the 955 interface can be determined from the dot3OamLoopbackStatus 956 object. 957 " 958 INDEX { ifIndex } 959 ::= { dot3OamLoopbackTable 1 } 961 Dot3OamLoopbackEntry ::= 962 SEQUENCE { 963 dot3OamLoopbackStatus INTEGER, 964 dot3OamLoopbackIgnoreRx INTEGER 965 } 967 dot3OamLoopbackStatus OBJECT-TYPE 968 SYNTAX INTEGER { 969 -- all values, except where noted, can be read 970 -- but cannot be written 971 noLoopback (1), 973 -- initiatingLoopback can be read or written 974 initiatingLoopback (2), 975 remoteLoopback (3), 977 -- terminatingLoopback can be read or written 978 terminatingLoopback (4), 979 localLoopback (5), 980 unknown (6) 981 } 982 MAX-ACCESS read-write 983 STATUS current 984 DESCRIPTION 985 "The loopback status of the OAM entity. This status is 986 determined by a combination of the local parser and 987 multiplexer states, the remote parser and multiplexer states, 988 as well as by the actions of the local OAM client. When 989 operating in normal mode with no loopback in progress, the 990 status reads noLoopback(1). 992 The values initiatingLoopback(2) and terminatingLoopback(4) 993 can be read or written. The other values can only be read - 994 they can never be written. Writing initiatingLoopback causes 995 the local OAM entity to start the loopback process with its 996 peer. This value can only be written when the status is 997 noLoopback(1). Writing the value initiatingLoopback(2) in any 998 other state has no effect. When in remoteLoopback(3), writing 999 terminatingLoopback(4) causes the local OAM entity to initiate 1000 the termination of the loopback state. Writing 1001 terminatingLoopack(4) in any other state has no effect. 1003 If the OAM client initiates a loopback and has sent an 1004 Loopback OAMPDU and is waiting for a response, where the local 1005 parser and multiplexer states are DISCARD (see [802.3ah, 1006 57.2.11.1]), the status is 'initiatingLoopback'. In this 1007 case, the local OAM entity has yet to receive any 1008 acknowledgement that the remote OAM entity has received its 1009 loopback command request. 1011 If the local OAM client knows that the remote OAM entity is in 1012 loopback mode (via the remote state information as described 1013 in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is 1014 remoteLoopback(3). If the local OAM client is in the process 1015 of terminating the remote loopback [802.3ah, 57.2.11.3, 1016 30.3.6.1.14], with its local multiplexer and parser states in 1017 DISCARD, the status is terminatingLoopback(4). If the remote 1018 OAM client has put the local OAM entity in loopback mode as 1019 indicated by its local parser state, the status is 1020 localLoopback(5). 1022 The unknown(6) status indicates the parser and multiplexer 1023 combination is unexpected. This status may be returned if the 1024 OAM loopback is in a transition state but should not persist. 1026 The values of this attribute correspond to the following 1027 values of the local and remote parser and multiplexer states. 1029 value LclPrsr LclMux RmtPrsr RmtMux 1030 noLoopback FWD FWD FWD FWD 1031 initLoopback DISCARD DISCARD FWD FWD 1032 rmtLoopback DISCARD FWD LPBK DISCARD 1033 tmtngLoopback DISCARD DISCARD LPBK DISCARD 1034 lclLoopback LPBK DISCARD DISCARD FWD 1035 unknown *** any other combination *** 1036 " 1037 REFERENCE "[802.3ah], REFERENCE 57.2.11, 30.3.61.14, 1038 30.3.6.1.15" 1039 ::= { dot3OamLoopbackEntry 1 } 1041 dot3OamLoopbackIgnoreRx OBJECT-TYPE 1042 SYNTAX INTEGER { ignore(1), process(2) } 1043 MAX-ACCESS read-write 1044 STATUS current 1045 DESCRIPTION 1046 "Since OAM loopback is a distruptive operation (user traffic 1047 does not pass), this attribute provides a mechanism to provide 1048 controls over whether received OAM loopback commands are 1049 processed or ignored. When the value is ignore(1), received 1050 loopback commands are ignored. When the value is process(2), 1051 OAM loopback commands are processed. The default value is to 1052 ignore loopback commands (ignore(1)). 1053 " 1054 REFERENCE "[802.3ah], REFERENCE 57.2.11, 30.3.61.14, 1055 30.3.6.1.15" 1057 ::= { dot3OamLoopbackEntry 2 } 1059 -- *************************************************************** 1060 -- 1061 -- Ethernet OAM Statistics group 1062 -- 1064 dot3OamStatsTable OBJECT-TYPE 1065 SYNTAX SEQUENCE OF Dot3OamStatsEntry 1066 MAX-ACCESS not-accessible 1067 STATUS current 1068 DESCRIPTION 1069 "This table contains statistics for the OAM function on a 1070 particular Ethernet like interface. There is an entry in the 1071 table for every entry in the dot3OamTable. 1073 The counters in this table are defined as 32-bit entries to 1074 match the counter size as defined in [802.3ah]. Given the OA 1075 protocol is a slow protocol, the counters increment at a slow 1076 rate. 1077 " 1078 ::= { dot3OamObjects 4 } 1080 dot3OamStatsEntry OBJECT-TYPE 1081 SYNTAX Dot3OamStatsEntry 1082 MAX-ACCESS not-accessible 1083 STATUS current 1084 DESCRIPTION 1085 "An entry in the table, containing statistics information on 1086 the Ethernet OAM function for a single Ethernet like 1087 interface. Entries are automatically created for every entry 1088 in the dot3OamTable. Counters are maintained across 1089 transitions in dot3OamOperStatus. 1090 " 1091 INDEX { ifIndex } 1092 ::= { dot3OamStatsTable 1 } 1094 Dot3OamStatsEntry ::= 1095 SEQUENCE { 1096 dot3OamInformationTx Counter32, 1097 dot3OamInformationRx Counter32, 1098 dot3OamUniqueEventNotificationTx Counter32, 1099 dot3OamUniqueEventNotificationRx Counter32, 1100 dot3OamDuplicateEventNotificationTx Counter32, 1101 dot3OamDuplicateEventNotificationRx Counter32, 1102 dot3OamLoopbackControlTx Counter32, 1103 dot3OamLoopbackControlRx Counter32, 1104 dot3OamVariableRequestTx Counter32, 1105 dot3OamVariableRequestRx Counter32, 1106 dot3OamVariableResponseTx Counter32, 1107 dot3OamVariableResponseRx Counter32, 1108 dot3OamOrgSpecificTx Counter32, 1109 dot3OamOrgSpecificRx Counter32, 1110 dot3OamUnsupportedCodesTx Counter32, 1111 dot3OamUnsupportedCodesRx Counter32, 1112 dot3OamFramesLostDueToOam Counter32 1113 } 1115 dot3OamInformationTx OBJECT-TYPE 1116 SYNTAX Counter32 1117 UNITS "frames" 1118 MAX-ACCESS read-only 1119 STATUS current 1120 DESCRIPTION 1121 "A count of the number of Information OAMPDUs transmitted on 1122 this interface. 1124 Discontinuities of this counter can occur at re-initialization 1125 of the management system, and at other times as indicated by 1126 the value of the ifCounterDiscontinuityTime. " 1127 REFERENCE "[802.3ah], 30.3.6.1.20." 1128 ::= { dot3OamStatsEntry 1 } 1130 dot3OamInformationRx OBJECT-TYPE 1131 SYNTAX Counter32 1132 UNITS "frames" 1133 MAX-ACCESS read-only 1134 STATUS current 1135 DESCRIPTION 1136 "A count of the number of Information OAMPDUs received on this 1137 interface. 1139 Discontinuities of this counter can occur at re-initialization 1140 of the management system, and at other times as indicated by 1141 the value of the ifCounterDiscontinuityTime. 1142 " 1143 REFERENCE "[802.3ah], 30.3.6.1.21." 1144 ::= { dot3OamStatsEntry 2 } 1146 dot3OamUniqueEventNotificationTx OBJECT-TYPE 1147 SYNTAX Counter32 1148 UNITS "frames" 1149 MAX-ACCESS read-only 1150 STATUS current 1151 DESCRIPTION 1152 "A count of the number of unique Event OAMPDUs transmitted on 1153 this interface. Event notifications may be sent in duplicate 1154 to increase the probability of successfully being received, 1155 given the possibility that a frame may be lost in transit. 1156 Duplicate Event Notification transmissions are counted by 1157 dot3OamDuplicateEventNotificationTx. 1159 A unique Event Notification OAMPDU is indicated as an Event 1160 Notification OAMPDU with a Sequence Number field that is 1161 distinct from the previously transmitted Event Notification 1162 OAMPDU Sequence Number. 1164 Discontinuities of this counter can occur at re-initialization 1165 of the management system, and at other times as indicated by 1166 the value of the ifCounterDiscontinuityTime. 1167 " 1168 REFERENCE "[802.3ah], 30.3.6.1.22." 1169 ::= { dot3OamStatsEntry 3 } 1171 dot3OamUniqueEventNotificationRx OBJECT-TYPE 1172 SYNTAX Counter32 1173 UNITS "frames" 1174 MAX-ACCESS read-only 1175 STATUS current 1176 DESCRIPTION 1177 "A count of the number of unique Event OAMPDUs received on 1178 this interface. Event notification OAMPDUs may be sent in 1179 duplicate to increase the probability of successfully being 1180 received, given the possibility that a frame may be lost in 1181 transit. Duplicate Event Notification receptions are counted 1182 by dot3OamDuplicateEventNotificationRx. 1184 A unique Event Notification OAMPDU is indicated as an Event 1185 Notification OAMPDU with a Sequence Number field that is 1186 distinct from the previously received Event Notification 1187 OAMPDU Sequence Number. 1189 Discontinuities of this counter can occur at re-initialization 1190 of the management system, and at other times as indicated by 1191 the value of the ifCounterDiscontinuityTime. 1192 " 1193 REFERENCE "[802.3ah], 30.3.6.1.24." 1194 ::= { dot3OamStatsEntry 4 } 1196 dot3OamDuplicateEventNotificationTx OBJECT-TYPE 1197 SYNTAX Counter32 1198 UNITS "frames" 1199 MAX-ACCESS read-only 1200 STATUS current 1201 DESCRIPTION 1202 "A count of the number of duplicate Event OAMPDUs transmitted 1203 on this interface. Event notification OAMPDUs may be sent in 1204 duplicate to increase the probability of successfully being 1205 received, given the possibility that a frame may be lost in 1206 transit. 1208 A duplicate Event Notification OAMPDU is indicated as an Event 1209 Notification OAMPDU with a Sequence Number field that is 1210 identical to the previously transmitted Event Notification 1211 OAMPDU Sequence Number. 1213 Discontinuities of this counter can occur at re-initialization 1214 of the management system, and at other times as indicated by 1215 the value of the ifCounterDiscontinuityTime. 1216 " 1217 REFERENCE "[802.3ah], 30.3.6.1.23." 1218 ::= { dot3OamStatsEntry 5 } 1220 dot3OamDuplicateEventNotificationRx OBJECT-TYPE 1221 SYNTAX Counter32 1222 UNITS "frames" 1223 MAX-ACCESS read-only 1224 STATUS current 1225 DESCRIPTION 1226 "A count of the number of duplicate Event OAMPDUs received on 1227 this interface. Event notification OAMPDUs may be sent in 1228 duplicate to increase the probability of successfully being 1229 received, given the possibility that a frame may be lost in 1230 transit. 1232 A duplicate Event Notification OAMPDU is indicated as an Event 1233 Notification OAMPDU with a Sequence Number field that is 1234 identical to the previously received Event Notification OAMPDU 1235 Sequence Number. 1237 Discontinuities of this counter can occur at re-initialization 1238 of the management system, and at other times as indicated by 1239 the value of the ifCounterDiscontinuityTime. 1240 " 1241 REFERENCE "[802.3ah], 30.3.6.1.25." 1242 ::= { dot3OamStatsEntry 6 } 1244 dot3OamLoopbackControlTx OBJECT-TYPE 1245 SYNTAX Counter32 1246 UNITS "frames" 1247 MAX-ACCESS read-only 1248 STATUS current 1249 DESCRIPTION 1250 "A count of the number of Loopback Control OAMPDUs transmitted 1251 on this interface. 1253 Discontinuities of this counter can occur at re-initialization 1254 of the management system, and at other times as indicated by 1255 the value of the ifCounterDiscontinuityTime. 1256 " 1257 REFERENCE "[802.3ah], 30.3.6.1.26." 1258 ::= { dot3OamStatsEntry 7 } 1260 dot3OamLoopbackControlRx OBJECT-TYPE 1261 SYNTAX Counter32 1262 UNITS "frames" 1263 MAX-ACCESS read-only 1264 STATUS current 1265 DESCRIPTION 1266 "A count of the number of Loopback Control OAMPDUs received 1267 on this interface. 1269 Discontinuities of this counter can occur at re-initialization 1270 of the management system, and at other times as indicated by 1271 the value of the ifCounterDiscontinuityTime. 1272 " 1273 REFERENCE "[802.3ah], 30.3.6.1.27." 1274 ::= { dot3OamStatsEntry 8 } 1276 dot3OamVariableRequestTx OBJECT-TYPE 1277 SYNTAX Counter32 1278 UNITS "frames" 1279 MAX-ACCESS read-only 1280 STATUS current 1281 DESCRIPTION 1282 "A count of the number of Variable Request OAMPDUs transmitted 1283 on this interface. 1285 Discontinuities of this counter can occur at re-initialization 1286 of the management system, and at other times as indicated by 1287 the value of the ifCounterDiscontinuityTime. 1288 " 1290 REFERENCE "[802.3ah], 30.3.6.1.28." 1291 ::= { dot3OamStatsEntry 9 } 1293 dot3OamVariableRequestRx OBJECT-TYPE 1294 SYNTAX Counter32 1295 UNITS "frames" 1296 MAX-ACCESS read-only 1297 STATUS current 1298 DESCRIPTION 1299 "A count of the number of Variable Request OAMPDUs received on 1300 this interface. 1302 Discontinuities of this counter can occur at re-initialization 1303 of the management system, and at other times as indicated by 1304 the value of the ifCounterDiscontinuityTime. 1305 " 1306 REFERENCE "[802.3ah], 30.3.6.1.29." 1307 ::= { dot3OamStatsEntry 10 } 1309 dot3OamVariableResponseTx OBJECT-TYPE 1310 SYNTAX Counter32 1311 UNITS "frames" 1312 MAX-ACCESS read-only 1313 STATUS current 1314 DESCRIPTION 1315 "A count of the number of Variable Response OAMPDUs 1316 transmitted on this interface. 1318 Discontinuities of this counter can occur at re-initialization 1319 of the management system, and at other times as indicated by 1320 the value of the ifCounterDiscontinuityTime. 1321 " 1322 REFERENCE "[802.3ah], 30.3.6.1.30." 1323 ::= { dot3OamStatsEntry 11 } 1325 dot3OamVariableResponseRx OBJECT-TYPE 1326 SYNTAX Counter32 1327 UNITS "frames" 1328 MAX-ACCESS read-only 1329 STATUS current 1330 DESCRIPTION 1331 "A count of the number of Variable Response OAMPDUs received 1332 on this interface. 1334 Discontinuities of this counter can occur at re-initialization 1335 of the management system, and at other times as indicated by 1336 the value of the ifCounterDiscontinuityTime. 1338 " 1339 REFERENCE "[802.3ah], 30.3.6.1.31." 1340 ::= { dot3OamStatsEntry 12 } 1342 dot3OamOrgSpecificTx OBJECT-TYPE 1343 SYNTAX Counter32 1344 UNITS "frames" 1345 MAX-ACCESS read-only 1346 STATUS current 1347 DESCRIPTION 1348 "A count of the number of Organization Specific OAMPDUs 1349 transmitted on this interface. 1351 Discontinuities of this counter can occur at re-initialization 1352 of the management system, and at other times as indicated by 1353 the value of the ifCounterDiscontinuityTime. 1354 " 1355 REFERENCE "[802.3ah], 30.3.6.1.32." 1356 ::= { dot3OamStatsEntry 13 } 1358 dot3OamOrgSpecificRx OBJECT-TYPE 1359 SYNTAX Counter32 1360 UNITS "frames" 1361 MAX-ACCESS read-only 1362 STATUS current 1363 DESCRIPTION 1364 "A count of the number of Organization Specific OAMPDUs 1365 received on this interface. 1367 Discontinuities of this counter can occur at re-initialization 1368 of the management system, and at other times as indicated by 1369 the value of the ifCounterDiscontinuityTime. 1370 " 1371 REFERENCE "[802.3ah], 30.3.6.1.33." 1372 ::= { dot3OamStatsEntry 14 } 1374 dot3OamUnsupportedCodesTx OBJECT-TYPE 1375 SYNTAX Counter32 1376 UNITS "frames" 1377 MAX-ACCESS read-only 1378 STATUS current 1379 DESCRIPTION 1380 "A count of the number of OAMPDUs transmitted on this 1381 interface with an unsupported op-code. 1383 Discontinuities of this counter can occur at re-initialization 1384 of the management system, and at other times as indicated by 1385 the value of the ifCounterDiscontinuityTime. 1386 " 1387 REFERENCE "[802.3ah], 30.3.6.1.18." 1388 ::= { dot3OamStatsEntry 15 } 1390 dot3OamUnsupportedCodesRx OBJECT-TYPE 1391 SYNTAX Counter32 1392 UNITS "frames" 1393 MAX-ACCESS read-only 1394 STATUS current 1395 DESCRIPTION 1396 "A count of the number of OAMPDUs received on this interface 1397 with an unsupported op-code. 1399 Discontinuities of this counter can occur at re-initialization 1400 of the management system, and at other times as indicated by 1401 the value of the ifCounterDiscontinuityTime. 1402 " 1403 REFERENCE "[802.3ah], 30.3.6.1.19." 1404 ::= { dot3OamStatsEntry 16 } 1406 dot3OamFramesLostDueToOam OBJECT-TYPE 1407 SYNTAX Counter32 1408 UNITS "frames" 1409 MAX-ACCESS read-only 1410 STATUS current 1411 DESCRIPTION 1412 "A count of the number of frames that were dropped by the OA 1413 multiplexer. Since the OAM multiplexer has multiple inputs 1414 and a single output, there may be cases where frames are 1415 dropped due to transmit resource contention. This counter is 1416 incremented whenever a frame is dropped by the OAM layer. 1417 Note that any Ethernet frame, not just OAMPDUs, may be dropped 1418 by the OAM layer. This can occur when an OAMPDU takes 1419 precedence over a 'normal' frame resulting in the 'normal' 1420 frame being dropped. 1422 When this counter is incremented, no other counters in this 1423 MIB are incremented. 1425 Discontinuities of this counter can occur at re-initialization 1426 of the management system, and at other times as indicated by 1427 the value of the ifCounterDiscontinuityTime. 1428 " 1429 REFERENCE "[802.3ah], 30.3.6.1.46." 1430 ::= { dot3OamStatsEntry 17 } 1432 -- *************************************************************** 1433 -- 1434 -- Ethernet OAM Event Configuration group 1435 -- 1437 dot3OamEventConfigTable OBJECT-TYPE 1438 SYNTAX SEQUENCE OF Dot3OamEventConfigEntry 1439 MAX-ACCESS not-accessible 1440 STATUS current 1441 DESCRIPTION 1442 "Ethernet OAM includes the ability to generate and receive 1443 Event Notification OAMPDUs to indicate various link problems. 1444 This table contains the mechanisms to enable Event 1445 Notifications and configure the thresholds to generate the 1446 standard Ethernet OAM events. There is one entry in the table 1447 for every entry in dot3OamTable that supports OAM events 1448 (where dot3OamFunctionsSupported includes the eventSupport 1449 bit set). The values in the table are maintained across 1450 changes to dot3OamOperStatus. 1452 The standard threshold crossing events are: 1453 - Errored Symbol Period Event. Generated when the number of 1454 symbol errors exceeds a threshold within a given window 1455 defined by a number of symbols (for example, 1,000 symbols 1456 out of 1,000,000 had errors). 1457 - Errored Frame Period Event. Generated when the number of 1458 frame errors exceeds a threshold within a given window 1459 defined by a number of frames (for example, 10 frames out 1460 of 1000 had errors). 1461 - Errored Frame Event. Generated when the number of frame 1462 errors exceeds a threshold within a given window defined 1463 by a period of time (for example, 10 frames in 1 second 1464 had errors). 1465 - Errored Frame Seconds Summary Event. Generated when the 1466 number of errored frame seconds exceeds a threshold within 1467 a given time period (for example, 10 errored frame seconds 1468 within the last 100 seconds). An errored frame second is 1469 defined as a 1 second interval which had >0 frame errors. 1470 There are other events (dying gasp, critical events) that are 1471 not threshold crossing events but which can be 1472 enabled/disabled via this table. 1473 " 1474 ::= { dot3OamObjects 5 } 1476 dot3OamEventConfigEntry OBJECT-TYPE 1477 SYNTAX Dot3OamEventConfigEntry 1478 MAX-ACCESS not-accessible 1479 STATUS current 1480 DESCRIPTION 1481 "Entries are automatically created and deleted from this 1482 table, and exist whenever the OAM entity supports Ethernet OA 1483 events (as indicated by the eventSupport bit in 1484 dot3OamFunctionsSuppported). Values in the table are 1485 maintained across changes to the value of dot3OamOperStatus. 1487 Event configuration controls when the local management entity 1488 sends Event Notification OAMPDUs to its OAM peer, and when 1489 certain event flags are set or cleared in OAMPDUs. 1490 " 1491 INDEX { ifIndex } 1492 ::= { dot3OamEventConfigTable 1 } 1494 Dot3OamEventConfigEntry ::= 1495 SEQUENCE { 1496 dot3OamErrSymPeriodWindowHi Unsigned32, 1497 dot3OamErrSymPeriodWindowLo Unsigned32, 1498 dot3OamErrSymPeriodThresholdHi Unsigned32, 1499 dot3OamErrSymPeriodThresholdLo Unsigned32, 1500 dot3OamErrSymPeriodEvNotifEnable TruthValue, 1501 dot3OamErrFramePeriodWindow Unsigned32, 1502 dot3OamErrFramePeriodThreshold Unsigned32, 1503 dot3OamErrFramePeriodEvNotifEnable TruthValue, 1504 dot3OamErrFrameWindow Unsigned32, 1505 dot3OamErrFrameThreshold Unsigned32, 1506 dot3OamErrFrameEvNotifEnable TruthValue, 1507 dot3OamErrFrameSecsSummaryWindow Integer32, 1508 dot3OamErrFrameSecsSummaryThreshold Integer32, 1509 dot3OamErrFrameSecsEvNotifEnable TruthValue, 1510 dot3OamDyingGaspEnable TruthValue, 1511 dot3OamCriticalEventEnable TruthValue 1512 } 1514 dot3OamErrSymPeriodWindowHi OBJECT-TYPE 1515 SYNTAX Unsigned32 1516 UNITS "2^32 symbols" 1517 MAX-ACCESS read-write 1518 STATUS current 1519 DESCRIPTION 1520 "The two objects dot3OamErrSymPeriodWindowHi and 1521 dot3OamErrSymPeriodLo together form an unsigned 64-bit 1522 integer representing the number of symbols over which this 1523 threshold event is defined. This is defined as 1525 dot3OamErrSymPeriodWindow = ((2^32)*dot3OamErrSymPeriodWindowHi) 1526 + dot3OamErrSymPeriodWindowLo 1528 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1529 window of dot3OamErrSymPeriodWindow symbols, an Event 1530 Notification OAMPDU should be generated with an Errored Symbol 1531 Period Event TLV indicating the threshold has been crossed in 1532 this window. 1534 The default value for dot3OamErrSymPeriodWindow is the number 1535 of symbols in one second for the underlying physical layer. 1536 " 1537 REFERENCE "[802.3ah], 30.3.6.1.34" 1538 ::= { dot3OamEventConfigEntry 1 } 1540 dot3OamErrSymPeriodWindowLo OBJECT-TYPE 1541 SYNTAX Unsigned32 1542 UNITS "symbols" 1543 MAX-ACCESS read-write 1544 STATUS current 1545 DESCRIPTION 1546 "The two objects dot3OamErrSymPeriodWindowHi and 1547 dot3OamErrSymPeriodWindowLo together form an unsigned 64-bit 1548 integer representing the number of symbols over which this 1549 threshold event is defined. This is defined as 1551 dot3OamErrSymPeriodWindow = ((2^32)*dot3OamErrSymPeriodWindowHi) 1552 + dot3OamErrSymPeriodWindowLo 1554 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1555 window of dot3OamErrSymPeriodWindow symbols, an Event 1556 Notification OAMPDU should be generated with an Errored Symbol 1557 Period Event TLV indicating the threshold has been crossed in 1558 this window. 1560 The default value for dot3OamErrSymPeriodWindow is the number 1561 of symbols in one second for the underlying physical layer. 1562 " 1563 REFERENCE "[802.3ah], 30.3.6.1.34" 1564 ::= { dot3OamEventConfigEntry 2 } 1566 dot3OamErrSymPeriodThresholdHi OBJECT-TYPE 1567 SYNTAX Unsigned32 1568 UNITS "2^32 symbols" 1569 MAX-ACCESS read-write 1570 STATUS current 1571 DESCRIPTION 1572 "The two objects dot3OamErrSymPeriodThresholdHi and 1573 dot3OamErrSymPeriodThresholdLo together form an unsigned 1574 64-bit integer representing the number of symbol errors that 1575 must occur within a given window to cause this event. 1577 This is defined as 1579 dot3OamErrSymPeriodThreshold = 1580 ((2^32) * dot3OamErrSymPeriodThresholdHi) 1581 + dot3OamErrSymPeriodThresholdLo 1583 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1584 window of dot3OamErrSymPeriodWindow symbols, an Event 1585 Notification OAMPDU should be generated with an Errored Symbol 1586 Period Event TLV indicating the threshold has been crossed in 1587 this window. 1589 The default value for dot3OamErrSymPeriodThreshold is one 1590 symbol errors. If the threshold value is zero, then an Event 1591 Notification OAMPDU is sent periodically (at the end of every 1592 window). This can be used as an asynchronous notification to 1593 the peer OAM entity of the statistics related to this 1594 threshold crossing alarm. 1595 " 1596 REFERENCE "[802.3ah], 30.3.6.1.34" 1597 ::= { dot3OamEventConfigEntry 3 } 1599 dot3OamErrSymPeriodThresholdLo OBJECT-TYPE 1600 SYNTAX Unsigned32 1601 UNITS "symbols" 1602 MAX-ACCESS read-write 1603 STATUS current 1604 DESCRIPTION 1605 "The two objects dot3OamErrSymPeriodThresholdHi and 1606 dot3OamErrSymPeriodThresholdLo together form an unsigned 1607 64-bit integer representing the number of symbol errors that 1608 must occur within a given window to cause this event. 1610 This is defined as 1612 dot3OamErrSymPeriodThreshold = 1613 ((2^32) * dot3OamErrSymPeriodThresholdHi) 1614 + dot3OamErrSymPeriodThresholdLo 1616 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1617 window of dot3OamErrSymPeriodWindow symbols, an Event 1618 Notification OAMPDU should be generated with an Errored Symbol 1619 Period Event TLV indicating the threshold has been crossed in 1620 this window. 1622 The default value for dot3OamErrSymPeriodThreshold is one 1623 symbol error. If the threshold value is zero, then an Event 1624 Notification OAMPDU is sent periodically (at the end of every 1625 window). This can be used as an asynchronous notification to 1626 the peer OAM entity of the statistics related to this 1627 threshold crossing alarm. 1628 " 1629 REFERENCE "[802.3ah], 30.3.6.1.34" 1630 ::= { dot3OamEventConfigEntry 4 } 1632 dot3OamErrSymPeriodEvNotifEnable OBJECT-TYPE 1633 SYNTAX TruthValue 1634 MAX-ACCESS read-write 1635 STATUS current 1636 DESCRIPTION 1637 "If true, the OAM entity should send an Event Notification 1638 OAMPDU when an Errored Symbol Period Event occurs. 1640 By default, this object should have the value true for 1641 Ethernet like interfaces that support OAM. If the OAM layer 1642 does not support event notifications (as indicated via the 1643 dot3OamFunctionsSupported attribute), this value is ignored. 1644 " 1645 ::= { dot3OamEventConfigEntry 5 } 1647 dot3OamErrFramePeriodWindow OBJECT-TYPE 1648 SYNTAX Unsigned32 1649 UNITS "frames" 1650 MAX-ACCESS read-write 1651 STATUS current 1652 DESCRIPTION 1653 "The number of frames over which the threshold is defined. 1654 The default value of the window is the number of minimum size 1655 Ethernet frames that can be received over the physical layer 1656 in one second. 1658 If dot3OamErrFramePeriodThreshold frame errors occur within a 1659 window of dot3OamErrFramePeriodWindow frames, an Event 1660 Notification OAMPDU should be generated with an Errored Frame 1661 Period Event TLV indicating the threshold has been crossed in 1662 this window. 1663 " 1664 REFERENCE "[802.3ah], 30.3.6.1.38" 1665 ::= { dot3OamEventConfigEntry 6 } 1667 dot3OamErrFramePeriodThreshold OBJECT-TYPE 1668 SYNTAX Unsigned32 1669 UNITS "frames" 1670 MAX-ACCESS read-write 1671 STATUS current 1672 DESCRIPTION 1673 "The number of frame errors that must occur for this event to 1674 be triggered. The default value is one frame error. If the 1675 threshold value is zero, then an Event Notification OAMPDU is 1676 sent periodically (at the end of every window). This can be 1677 used as an asynchronous notification to the peer OAM entity of 1678 the statistics related to this threshold crossing alarm. 1680 If dot3OamErrFramePeriodThreshold frame errors occur within a 1681 window of dot3OamErrFramePeriodWindow frames, an Event 1682 Notification OAMPDU should be generated with an Errored Frame 1683 Period Event TLV indicating the threshold has been crossed in 1684 this window. 1685 " 1686 REFERENCE "[802.3ah], 30.3.6.1.38" 1687 ::= { dot3OamEventConfigEntry 7 } 1689 dot3OamErrFramePeriodEvNotifEnable OBJECT-TYPE 1690 SYNTAX TruthValue 1691 MAX-ACCESS read-write 1692 STATUS current 1693 DESCRIPTION 1694 "If true, the OAM entity should send an Event Notification 1695 OAMPDU when an Errored Frame Period Event occurs. 1697 By default, this object should have the value true for 1698 Ethernet like interfaces that support OAM. If the OAM layer 1699 does not support event notifications (as indicated via the 1700 dot3OamFunctionsSupported attribute), this value is ignored. 1701 " 1702 ::= { dot3OamEventConfigEntry 8 } 1704 dot3OamErrFrameWindow OBJECT-TYPE 1705 SYNTAX Unsigned32 1706 UNITS "tenths of a second" 1707 MAX-ACCESS read-write 1708 STATUS current 1709 DESCRIPTION 1710 "The amount of time (in 100ms increments) over which the 1711 threshold is defined. The default value is 10 (1 second). 1713 If dot3OamErrFrameThreshold frame errors occur within a window 1714 of dot3OamErrFrameWindow seconds (measured in tenths of 1715 seconds), an Event Notification OAMPDU should be generated 1716 with an Errored Frame Event TLV indicating the threshold has 1717 been crossed in this window. 1718 " 1719 REFERENCE "[802.3ah], 30.3.6.1.36" 1720 DEFVAL { 10 } 1721 ::= { dot3OamEventConfigEntry 9 } 1723 dot3OamErrFrameThreshold OBJECT-TYPE 1724 SYNTAX Unsigned32 1725 UNITS "frames" 1726 MAX-ACCESS read-write 1727 STATUS current 1728 DESCRIPTION 1729 "The number of frame errors that must occur for this event to 1730 be triggered. The default value is one frame error. If the 1731 threshold value is zero, then an Event Notification OAMPDU is 1732 sent periodically (at the end of every window). This can be 1733 used as an asynchronous notification to the peer OAM entity of 1734 the statistics related to this threshold crossing alarm. 1736 If dot3OamErrFrameThreshold frame errors occur within a window 1737 of dot3OamErrFrameWindow (in tenths of seconds), an Event 1738 Notification OAMPDU should be generated with an Errored Frame 1739 Event TLV indicating the threshold has been crossed in this 1740 window. 1741 " 1742 REFERENCE "[802.3ah], 30.3.6.1.36" 1743 DEFVAL { 1 } 1744 ::= { dot3OamEventConfigEntry 10 } 1746 dot3OamErrFrameEvNotifEnable OBJECT-TYPE 1747 SYNTAX TruthValue 1748 MAX-ACCESS read-write 1749 STATUS current 1750 DESCRIPTION 1751 "If true, the OAM entity should send an Event Notification 1752 OAMPDU when an Errored Frame Event occurs. 1754 By default, this object should have the value true for 1755 Ethernet like interfaces that support OAM. If the OAM layer 1756 does not support event notifications (as indicated via the 1757 dot3OamFunctionsSupported attribute), this value is ignored. 1759 " 1760 DEFVAL { true } 1761 ::= { dot3OamEventConfigEntry 11 } 1763 dot3OamErrFrameSecsSummaryWindow OBJECT-TYPE 1764 SYNTAX Integer32 (100..9000) 1765 UNITS "tenths of a second" 1766 MAX-ACCESS read-write 1767 STATUS current 1768 DESCRIPTION 1769 "The amount of time (in 100ms intervals) over which the 1770 threshold is defined. The default value is 100 (10 seconds). 1772 If dot3OamErrFrameSecsSummaryThreshold frame errors occur 1773 within a window of dot3OamErrFrameSecsSummaryWindow (in tenths 1774 of seconds), an Event Notification OAMPDU should be generated 1775 with an Errored Frame Seconds Summary Event TLV indicating the 1776 threshold has been crossed in this window. 1777 " 1778 REFERENCE "[802.3ah], 30.3.6.1.40" 1779 DEFVAL { 100 } 1780 ::= { dot3OamEventConfigEntry 12 } 1782 dot3OamErrFrameSecsSummaryThreshold OBJECT-TYPE 1783 SYNTAX Integer32 (1..900) 1784 UNITS "errored frame seconds" 1785 MAX-ACCESS read-write 1786 STATUS current 1787 DESCRIPTION 1788 "The number of errored frame seconds that must occur for this 1789 event to be triggered. The default value is one errored frame 1790 second. If the threshold value is zero, then an Event 1791 Notification OAMPDU is sent periodically (at the end of every 1792 window). This can be used as an asynchronous notification to 1793 the peer OAM entity of the statistics related to this 1794 threshold crossing alarm. 1796 If dot3OamErrFrameSecsSummaryThreshold frame errors occur 1797 within a window of dot3OamErrFrameSecsSummaryWindow (in tenths 1798 of seconds), an Event Notification OAMPDU should be generated 1799 with an Errored Frame Seconds Summary Event TLV indicating the 1800 threshold has been crossed in this window. 1801 " 1802 REFERENCE "[802.3ah], 30.3.6.1.40" 1803 DEFVAL { 1 } 1804 ::= { dot3OamEventConfigEntry 13 } 1806 dot3OamErrFrameSecsEvNotifEnable OBJECT-TYPE 1807 SYNTAX TruthValue 1808 MAX-ACCESS read-write 1809 STATUS current 1810 DESCRIPTION 1811 "If true, the local OAM entity should send an Event 1812 Notification OAMPDU when an Errored Frame Seconds Event 1813 occurs. 1815 By default, this object should have the value true for 1816 Ethernet like interfaces that support OAM. If the OAM layer 1817 does not support event notifications (as indicated via the 1818 dot3OamFunctionsSupported attribute), this value is ignored. 1819 " 1820 DEFVAL { true } 1821 ::= { dot3OamEventConfigEntry 14 } 1823 dot3OamDyingGaspEnable OBJECT-TYPE 1824 SYNTAX TruthValue 1825 MAX-ACCESS read-write 1826 STATUS current 1827 DESCRIPTION 1828 "If true, the local OAM entity should attempt to indicate a 1829 dying gasp via the OAMPDU flags field to its peer OAM entity 1830 when a dying gasp event occurs. The exact definition of a 1831 dying gasp event is implementation dependent. If the system 1832 does not support dying gasp capability, setting this object 1833 has no effect, and reading the object should always result in 1834 'false'. 1836 By default, this object should have the value true for 1837 Ethernet like interfaces that support OAM. If the OAM layer 1838 does not support event notifications (as indicated via the 1839 dot3OamFunctionsSupported attribute), this value is ignored. 1840 " 1841 DEFVAL { true } 1842 ::= { dot3OamEventConfigEntry 15 } 1844 dot3OamCriticalEventEnable OBJECT-TYPE 1845 SYNTAX TruthValue 1846 MAX-ACCESS read-write 1847 STATUS current 1848 DESCRIPTION 1849 "If true, the local OAM entity should attempt to indicate a 1850 critical event via the OAMPDU flags to its peer OAM entity 1851 when a critical event occurs. The exact definition of a 1852 critical event is implementation dependent. If the system 1853 does not support critical event capability, setting this 1854 object has no effect, and reading the object should always 1855 result in 'false'. 1857 By default, this object should have the value true for 1858 Ethernet like interfaces that support OAM. If the OAM layer 1859 does not support event notifications (as indicated via the 1860 dot3OamFunctionsSupported attribute), this value is ignored. 1861 " 1862 DEFVAL { true } 1863 ::= { dot3OamEventConfigEntry 16 } 1865 -- ************************************************************** 1866 -- 1867 -- Ethernet OAM Event Log group 1868 -- 1870 dot3OamEventLogTable OBJECT-TYPE 1871 SYNTAX SEQUENCE OF Dot3OamEventLogEntry 1872 MAX-ACCESS not-accessible 1873 STATUS current 1874 DESCRIPTION 1875 "This table records a history of the events that have occurred 1876 at the Ethernet OAM level. These events can include locally 1877 detected events, which may result in locally generated 1878 OAMPDUs, and remotely detected events, which are detected by 1879 the OAM peer entity and signaled to the local entity via 1880 Ethernet OAM. Ethernet OAM events can be signaled by Event 1881 Notification OAMPDUs or by the flags field in any OAMPDU. 1883 This table contains both threshold crossing events and 1884 non-threshold crossing events. The parameters for the 1885 threshold window, threshold value, and actual value 1886 (dot3OamEventLogWindowXX, dot3OamEventLogThresholdXX, 1887 dot3OamEventLogValue) are only applicable to threshold 1888 crossing events, and are returned as all F's (2^32 - 1) for 1889 non-threshold crossing events. 1891 Entries in the table are automatically created when such 1892 events are detected. The size of the table is implementation 1893 dependent. When the table reaches its maximum size, older 1894 entries are automatically deleted to make room for newer 1895 entries. 1896 " 1897 ::= { dot3OamObjects 6 } 1899 dot3OamEventLogEntry OBJECT-TYPE 1900 SYNTAX Dot3OamEventLogEntry 1901 MAX-ACCESS not-accessible 1902 STATUS current 1903 DESCRIPTION 1904 "An entry in the dot3OamEventLogTable. Entries are 1905 automatically created whenever Ethernet OAM events occur at 1906 the local OAM entity, and when Event Notification OAMPDUs are 1907 received at the local OAM entity (indicating events have 1908 occurred at the peer OAM entity). The size of the table is 1909 implementation dependent, but when the table becomes full, 1910 older events are automatically deleted to make room for newer 1911 events. The table index dot3OamEventLogIndex increments for 1912 each new entry, and when the maximum value is reached the 1913 value restarts at zero. 1914 " 1915 INDEX { ifIndex, dot3OamEventLogIndex } 1916 ::= { dot3OamEventLogTable 1 } 1918 Dot3OamEventLogEntry ::= 1919 SEQUENCE { 1920 dot3OamEventLogIndex Unsigned32, 1921 dot3OamEventLogTimestamp TimeStamp, 1922 dot3OamEventLogOui EightOTwoOui, 1923 dot3OamEventLogType Unsigned32, 1924 dot3OamEventLogLocation INTEGER, 1925 dot3OamEventLogWindowHi Unsigned32, 1926 dot3OamEventLogWindowLo Unsigned32, 1927 dot3OamEventLogThresholdHi Unsigned32, 1928 dot3OamEventLogThresholdLo Unsigned32, 1929 dot3OamEventLogValue CounterBasedGauge64, 1930 dot3OamEventLogRunningTotal CounterBasedGauge64, 1931 dot3OamEventLogEventTotal Unsigned32 1932 } 1934 dot3OamEventLogIndex OBJECT-TYPE 1935 SYNTAX Unsigned32(1..4294967295) 1936 MAX-ACCESS not-accessible 1937 STATUS current 1938 DESCRIPTION 1939 "An arbitrary integer for identifying individual events 1940 within the event log. " 1941 ::= { dot3OamEventLogEntry 1 } 1943 dot3OamEventLogTimestamp OBJECT-TYPE 1944 SYNTAX TimeStamp 1945 MAX-ACCESS read-only 1946 STATUS current 1947 DESCRIPTION 1948 "The value of sysUpTime at the time of the logged event. For 1949 locally generated events, the time of the event can be 1950 accurately retrieved from sysUpTime. For remotely generated 1951 events, the time of the event is indicated by the reception of 1952 the Event Notification OAMPDU indicating the event occurred on 1953 the peer. A system may attempt to adjust the timestamp value 1954 to more accurately reflect the time of the event at the peer 1955 OAM entity by using other information, such as that found in 1956 the timestamp found of the Event Notification TLVs, which 1957 provides an indication of the relative time between events at 1958 the peer entity. " 1959 ::= { dot3OamEventLogEntry 2 } 1961 dot3OamEventLogOui OBJECT-TYPE 1962 SYNTAX EightOTwoOui 1963 MAX-ACCESS read-only 1964 STATUS current 1965 DESCRIPTION 1966 "The OUI of the entity defining the object type. All IEEE 1967 802.3 defined events (as appearing in [802.3ah] except for the 1968 Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of 1969 0x0180C2. Organizations defining their own Event Notification 1970 TLVs include their OUI in the Event Notification TLV which 1971 gets reflected here. " 1972 ::= { dot3OamEventLogEntry 3 } 1974 dot3OamEventLogType OBJECT-TYPE 1975 SYNTAX Unsigned32 1976 MAX-ACCESS read-only 1977 STATUS current 1978 DESCRIPTION 1979 "The type of event that generated this entry in the event log. 1980 When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following 1981 event types are defined: 1982 erroredSymbolEvent(1), 1983 erroredFramePeriodEvent (2), 1984 erroredFrameEvent(3), 1985 erroredFrameSecondsEvent(4), 1986 linkFault(256), 1987 dyingGaspEvent(257), 1988 criticalLinkEvent(258) 1989 The first four are considered threshold crossing events as 1990 they are generated when a metric exceeds a given value within 1991 a specified window. The other three are not threshold 1992 crossing events. 1994 When the OUI is not 71874 (0x0180C2 in hex), then some other 1995 organization has defined the event space. If event subtyping 1996 is known to the implementation, it may be reflected here. 1997 Otherwise, this value should return all F's (2^32 - 1). 1998 " 1999 REFERENCE "[802.3ah], 30.3.6.1.10 and 57.5.3." 2000 ::= { dot3OamEventLogEntry 4 } 2002 dot3OamEventLogLocation OBJECT-TYPE 2003 SYNTAX INTEGER { local(1), remote(2) } 2004 MAX-ACCESS read-only 2005 STATUS current 2006 DESCRIPTION 2007 "Whether this event occurred locally (local(1)), or was 2008 received from the OAM peer via Ethernet OAM (remote(2)). 2009 " 2010 ::= { dot3OamEventLogEntry 5 } 2012 dot3OamEventLogWindowHi OBJECT-TYPE 2013 SYNTAX Unsigned32 2014 MAX-ACCESS read-only 2015 STATUS current 2016 DESCRIPTION 2017 "If the event represents a threshold crossing event, the two 2018 objects dot3OamEventWindowHi and dot3OamEventWindowLo form an 2019 unsigned 64-bit integer yielding the window over which the 2020 value was measured for the threshold crossing event (for 2021 example, 5, when 11 occurrences happened in 5 seconds while 2022 the threshold was 10). The two objects are combined as: 2024 dot3OamEventLogWindow = ((2^32) * dot3OamEventLogWindowHi) 2025 + dot3OamEventLogWindowLo 2027 Otherwise, this value is returned as all F's (2^32 - 1) and 2028 adds no useful information. 2029 " 2030 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2031 ::= { dot3OamEventLogEntry 6 } 2033 dot3OamEventLogWindowLo OBJECT-TYPE 2034 SYNTAX Unsigned32 2035 MAX-ACCESS read-only 2036 STATUS current 2037 DESCRIPTION 2038 "If the event represents a threshold crossing event, the two 2039 objects dot3OamEventWindowHi and dot3OamEventWindowLo form an 2040 unsigned 64-bit integer yielding the window over which the 2041 value was measured for the threshold crossing event (for 2042 example, 5, when 11 occurrences happened in 5 seconds while 2043 the threshold was 10). The two objects are combined as: 2045 dot3OamEventLogWindow = ((2^32) * dot3OamEventLogWindowHi) 2046 + dot3OamEventLogWindowLo 2048 Otherwise, this value is returned as all F's (2^32 - 1) and 2049 adds no useful information. 2050 " 2051 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2052 ::= { dot3OamEventLogEntry 7 } 2054 dot3OamEventLogThresholdHi OBJECT-TYPE 2055 SYNTAX Unsigned32 2056 MAX-ACCESS read-only 2057 STATUS current 2058 DESCRIPTION 2059 "If the event represents a threshold crossing event, the two 2060 objects dot3OamEventThresholdHi and dot3OamEventThresholdLo 2061 form an unsigned 64-bit integer yielding the value that was 2062 crossed for the threshold crossing event (for example, 10, 2063 when 11 occurrences happened in 5 seconds while the threshold 2064 was 10). The two objects are combined as: 2066 dot3OamEventLogThreshold = ((2^32) * dot3OamEventLogThresholdHi) 2067 + dot3OamEventLogThresholdLo 2069 Otherwise, this value is returned as all F's (2^32 -1) and 2070 adds no useful information. 2071 " 2072 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2073 ::= { dot3OamEventLogEntry 8 } 2075 dot3OamEventLogThresholdLo OBJECT-TYPE 2076 SYNTAX Unsigned32 2077 MAX-ACCESS read-only 2078 STATUS current 2079 DESCRIPTION 2080 "If the event represents a threshold crossing event, the two 2081 objects dot3OamEventThresholdHi and dot3OamEventThresholdLo 2082 form an unsigned 64-bit integer yielding the value that was 2083 crossed for the threshold crossing event (for example, 10, 2084 when 11 occurrences happened in 5 seconds while the threshold 2085 was 10). The two objects are combined as: 2087 dot3OamEventLogThreshold = ((2^32) * dot3OamEventLogThresholdHi) 2088 + dot3OamEventLogThresholdLo 2090 Otherwise, this value is returned as all F's (2^32 - 1) and 2091 adds no useful information. 2092 " 2093 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2094 ::= { dot3OamEventLogEntry 9 } 2096 dot3OamEventLogValue OBJECT-TYPE 2097 SYNTAX CounterBasedGauge64 2098 MAX-ACCESS read-only 2099 STATUS current 2100 DESCRIPTION 2101 "If the event represents a threshold crossing event, this 2102 value indicates the value of the parameter within the given 2103 window that generated this event (for example, 11, when 11 2104 occurrences happened in 5 seconds while the threshold was 10). 2106 Otherwise, this value is returned as all F's 2107 (2^64 - 1) and adds no useful information. 2108 " 2109 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2110 ::= { dot3OamEventLogEntry 10 } 2112 dot3OamEventLogRunningTotal OBJECT-TYPE 2113 SYNTAX CounterBasedGauge64 2114 MAX-ACCESS read-only 2115 STATUS current 2116 DESCRIPTION 2117 "Each Event Notification TLV contains a running total of the 2118 number of times an event has occurred, as well as the number 2119 of times an Event Notification for the event has been 2120 transmitted. For non-threshold crossing events, the number of 2121 events (dot3OamLogRunningTotal) and the number of resultant 2122 Event Notifications (dot3OamLogEventTotal) should be 2123 identical. 2125 For threshold crossing events, since multiple occurrences may 2126 be required to cross the threshold, these values are likely 2127 different. This value represents the total number of times 2128 this event has happened since the last reset (for example, 2129 3253, when 3253 symbol errors have occurred since the last 2130 reset, which has resulted in 51 symbol error threshold 2131 crossing events since the last reset). 2132 " 2133 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2134 ::= { dot3OamEventLogEntry 11 } 2136 dot3OamEventLogEventTotal OBJECT-TYPE 2137 SYNTAX Unsigned32 2138 MAX-ACCESS read-only 2139 STATUS current 2140 DESCRIPTION 2141 "Each Event Notification TLV contains a running total of the 2142 number of times an event has occurred, as well as the number 2143 of times an Event Notification for the event has been 2144 transmitted. For non-threshold crossing events, the number of 2145 events (dot3OamLogRunningTotal) and the number of resultant 2146 Event Notifications (dot3OamLogEventTotal) should be 2147 identical. 2149 For threshold crossing events, since multiple occurrences may 2150 be required to cross the threshold, these values are likely 2151 different. This value represents the total number of times 2152 one or more of these occurrences have resulted in an Event 2153 Notification (for example, 51 when 3253 symbol errors have 2154 occurred since the last reset, which has resulted in 51 symbol 2155 error threshold crossing events since the last reset). 2156 " 2157 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2158 ::= { dot3OamEventLogEntry 12 } 2160 -- *************************************************************** 2161 -- 2162 -- Ethernet OAM Notifications 2163 -- 2165 dot3OamThresholdEvent NOTIFICATION-TYPE 2166 OBJECTS { dot3OamEventLogTimestamp, 2167 dot3OamEventLogOui, 2168 dot3OamEventLogType, 2169 dot3OamEventLogLocation, 2170 dot3OamEventLogWindowHi, 2171 dot3OamEventLogWindowLo, 2172 dot3OamEventLogThresholdHi, 2173 dot3OamEventLogThresholdLo, 2174 dot3OamEventLogValue, 2175 dot3OamEventLogRunningTotal, 2176 dot3OamEventLogEventTotal 2177 } 2178 STATUS current 2179 DESCRIPTION 2180 "A dot3OamThresholdEvent notification is sent when a local or 2181 remote threshold crossing event is detected. A local 2182 threshold crossing event is detected by the local entity, 2183 while a remote threshold crossing event is detected by the 2184 reception of an Ethernet OAM Event Notification OAMPDU 2185 indicating a threshold event. 2187 This notification should not be sent more than once per 2188 second. 2190 The OAM entity can be derived from extracting the ifIndex from 2191 the variable bindings. The objects in the notification 2192 correspond to the values in a row instance of in the 2193 dot3OamEventLogTable. 2195 The management entity should periodically check 2196 dot3OamEventLogTable to detect any missed events." 2197 ::= { dot3OamNotifications 1 } 2199 dot3OamNonThresholdEvent NOTIFICATION-TYPE 2200 OBJECTS { dot3OamEventLogTimestamp, 2201 dot3OamEventLogOui, 2202 dot3OamEventLogType, 2203 dot3OamEventLogLocation, 2204 dot3OamEventLogEventTotal 2205 } 2206 STATUS current 2207 DESCRIPTION 2208 "A dot3OamNonThresholdEvent notification is sent when a local 2209 or remote non-threshold crossing event is detected. A local 2210 event is detected by the local entity, while a remote event is 2211 detected by the reception of an Ethernet OAM Event 2212 Notification OAMPDU indicating a non-threshold crossing event. 2214 This notification should not be sent more than once per 2215 second. 2217 The OAM entity can be derived from extracting the ifIndex from 2218 the variable bindings. The objects in the notification 2219 correspond to the values in a row instance of the 2220 dot3OamEventLogTable. 2222 The management entity should periodically check 2223 dot3OamEventLogTable to detect any missed events." 2224 ::= { dot3OamNotifications 2 } 2226 -- *************************************************************** 2227 -- 2228 -- Ethernet OAM Compliance group 2229 -- 2231 dot3OamGroups OBJECT IDENTIFIER ::= { dot3OamConformance 1 } 2232 dot3OamCompliances OBJECT IDENTIFIER ::= { dot3OamConformance 2 } 2234 -- Compliance statements 2236 dot3OamCompliance MODULE-COMPLIANCE 2237 STATUS current 2238 DESCRIPTION "The compliance statement for managed entities 2239 supporting OAM on Ethernet like interfaces. 2240 " 2241 MODULE -- this module 2242 MANDATORY-GROUPS { dot3OamControlGroup, 2243 dot3OamPeerGroup, 2244 dot3OamStatsBaseGroup 2245 } 2247 GROUP dot3OamLoopbackGroup 2248 DESCRIPTION 2249 "This group is mandatory for all IEEE 802.3 OA 2250 implementations that support loopback functionality. " 2252 GROUP dot3OamErrSymbolPeriodEventGroup 2253 DESCRIPTION 2254 "This group is mandatory for all IEEE 802.3 OA 2255 implementations that support event functionality. " 2257 GROUP dot3OamErrFramePeriodEventGroup 2258 DESCRIPTION 2259 "This group is mandatory for all IEEE 802.3 OA 2260 implementations that support event functionality. " 2262 GROUP dot3OamErrFrameEventGroup 2263 DESCRIPTION 2264 "This group is mandatory for all IEEE 802.3 OA 2265 implementations that support event functionality. " 2267 GROUP dot3OamErrFrameSecsSummaryEventGroup 2268 DESCRIPTION 2269 "This group is mandatory for all IEEE 802.3 OA 2270 implementations that support event functionality. " 2272 GROUP dot3OamFlagEventGroup 2273 DESCRIPTION 2274 "This group is optional for all IEEE 802.3 OA 2275 implementations. The ability to send critical events or dying 2276 gasp events is not required in any system." 2278 GROUP dot3OamEventLogGroup 2279 DESCRIPTION 2280 "This group is optional for all IEEE 802.3 OA 2281 implementations. Entries in this table are dependent on what 2282 event functionality is supported in the local OA 2283 implementation. At least one type of event must be supported 2284 for entries to appear in this table. " 2286 GROUP dot3OamNotificationGroup 2287 DESCRIPTION 2288 "This group is optional for all IEEE 802.3 OA 2289 implementations. Since the information in the notifications 2290 is dependent on the dot3OamEventLogTable, that table must be 2291 implemented for notifications. " 2293 ::= { dot3OamCompliances 1} 2295 dot3OamControlGroup OBJECT-GROUP 2296 OBJECTS { dot3OamAdminState, 2297 dot3OamOperStatus, 2298 dot3OamMode, 2299 dot3OamMaxOamPduSize, 2300 dot3OamConfigRevision, 2301 dot3OamFunctionsSupported 2302 } 2303 STATUS current 2304 DESCRIPTION 2305 "A collection of objects providing the abilities, 2306 configuration, and status of an Ethernet OAM entity. " 2307 ::= { dot3OamGroups 1 } 2309 dot3OamPeerGroup OBJECT-GROUP 2310 OBJECTS { dot3OamPeerMacAddress, 2311 dot3OamPeerVendorOui, 2312 dot3OamPeerVendorInfo, 2313 dot3OamPeerMode, 2314 dot3OamPeerFunctionsSupported, 2315 dot3OamPeerMaxOamPduSize, 2316 dot3OamPeerConfigRevision 2317 } 2318 STATUS current 2319 DESCRIPTION 2320 "A collection of objects providing the abilities, 2321 configuration, and status of a peer Ethernet OAM entity. " 2322 ::= { dot3OamGroups 2 } 2324 dot3OamStatsBaseGroup OBJECT-GROUP 2325 OBJECTS { dot3OamInformationTx, 2326 dot3OamInformationRx, 2327 dot3OamUniqueEventNotificationTx, 2328 dot3OamUniqueEventNotificationRx, 2329 dot3OamDuplicateEventNotificationTx, 2330 dot3OamDuplicateEventNotificationRx, 2331 dot3OamLoopbackControlTx, 2332 dot3OamLoopbackControlRx, 2333 dot3OamVariableRequestTx, 2334 dot3OamVariableRequestRx, 2335 dot3OamVariableResponseTx, 2336 dot3OamVariableResponseRx, 2337 dot3OamOrgSpecificTx, 2338 dot3OamOrgSpecificRx, 2339 dot3OamUnsupportedCodesTx, 2340 dot3OamUnsupportedCodesRx, 2341 dot3OamFramesLostDueToOam 2342 } 2343 STATUS current 2344 DESCRIPTION 2345 "A collection of objects providing the statistics for the 2346 number of various transmit and recieve events for OAM on an 2347 Ethernet like interface. Note that all of these counters must 2348 be supported even if the related function (as described in 2349 dot3OamFunctionsSupported) is not supported. " 2350 ::= { dot3OamGroups 3 } 2352 dot3OamLoopbackGroup OBJECT-GROUP 2353 OBJECTS { dot3OamLoopbackStatus, 2354 dot3OamLoopbackIgnoreRx 2355 } 2356 STATUS current 2357 DESCRIPTION 2358 "A collection of objects for controlling the OAM remote 2359 loopback function. " 2361 ::= { dot3OamGroups 4 } 2363 dot3OamErrSymbolPeriodEventGroup OBJECT-GROUP 2364 OBJECTS { dot3OamErrSymPeriodWindowHi, 2365 dot3OamErrSymPeriodWindowLo, 2366 dot3OamErrSymPeriodThresholdHi, 2367 dot3OamErrSymPeriodThresholdLo, 2368 dot3OamErrSymPeriodEvNotifEnable 2369 } 2370 STATUS current 2371 DESCRIPTION 2372 "A collection of objects for configuring the thresholds for an 2373 Errored Symbol Period Event. 2375 Each [802.3ah] defined Event Notification TLV has its own 2376 conformance group because each event can be implemented 2377 independently of any other. " 2378 ::= { dot3OamGroups 5 } 2380 dot3OamErrFramePeriodEventGroup OBJECT-GROUP 2381 OBJECTS { dot3OamErrFramePeriodWindow, 2382 dot3OamErrFramePeriodThreshold, 2383 dot3OamErrFramePeriodEvNotifEnable 2384 } 2385 STATUS current 2386 DESCRIPTION 2387 "A collection of objects for configuring the thresholds for an 2388 Errored Frame Period Event. 2390 Each [802.3ah] defined Event Notification TLV has its own 2391 conformance group because each event can be implemented 2392 independently of any other. " 2393 ::= { dot3OamGroups 6 } 2395 dot3OamErrFrameEventGroup OBJECT-GROUP 2396 OBJECTS { dot3OamErrFrameWindow, 2397 dot3OamErrFrameThreshold, 2398 dot3OamErrFrameEvNotifEnable 2399 } 2400 STATUS current 2401 DESCRIPTION 2402 "A collection of objects for configuring the thresholds for an 2403 Errored Frame Event. 2405 Each [802.3ah] defined Event Notification TLV has its own 2406 conformance group because each event can be implemented 2407 independently of any other. " 2409 ::= { dot3OamGroups 7 } 2411 dot3OamErrFrameSecsSummaryEventGroup OBJECT-GROUP 2412 OBJECTS { dot3OamErrFrameSecsSummaryWindow, 2413 dot3OamErrFrameSecsSummaryThreshold, 2414 dot3OamErrFrameSecsEvNotifEnable 2415 } 2416 STATUS current 2417 DESCRIPTION 2418 "A collection of objects for configuring the thresholds for an 2419 Errored Frame Seconds Summary Event. 2421 Each [802.3ah] defined Event Notification TLV has its own 2422 conformance group because each event can be implemented 2423 independently of any other. " 2424 ::= { dot3OamGroups 8 } 2426 dot3OamFlagEventGroup OBJECT-GROUP 2427 OBJECTS { dot3OamDyingGaspEnable, 2428 dot3OamCriticalEventEnable 2429 } 2430 STATUS current 2431 DESCRIPTION 2432 "A collection of objects for configuring the sending OAMPDUs 2433 with the critical event flag or dying gasp flag enabled. " 2434 ::= { dot3OamGroups 9 } 2436 dot3OamEventLogGroup OBJECT-GROUP 2437 OBJECTS { dot3OamEventLogTimestamp, 2438 dot3OamEventLogOui, 2439 dot3OamEventLogType, 2440 dot3OamEventLogLocation, 2441 dot3OamEventLogWindowHi, 2442 dot3OamEventLogWindowLo, 2443 dot3OamEventLogThresholdHi, 2444 dot3OamEventLogThresholdLo, 2445 dot3OamEventLogValue, 2446 dot3OamEventLogRunningTotal, 2447 dot3OamEventLogEventTotal 2448 } 2449 STATUS current 2450 DESCRIPTION 2451 "A collection of objects for configuring the thresholds for an 2452 Errored Frame Seconds Summary Event and maintaining the event 2453 information. " 2454 ::= { dot3OamGroups 10 } 2456 dot3OamNotificationGroup NOTIFICATION-GROUP 2457 NOTIFICATIONS { 2458 dot3OamThresholdEvent, 2459 dot3OamNonThresholdEvent 2460 } 2461 STATUS current 2462 DESCRIPTION 2463 "A collection of notifications used by Ethernet OAM to signal 2464 to a management entity that local or remote events have occured 2465 on a specified Ethernet link. " 2466 ::= { dot3OamGroups 11 } 2468 END 2470 7. Security Considerations 2472 The readable objects in this module can provide information about 2473 network traffic, and therefore may be considered sensitive. In 2474 particular, OAM provides mechanisms for reading the IEEE 802.3 Clause 2475 30 MIB attributes from a link partner via a specialized layer two 2476 protocol. Unlike SNMP, IEEE P802.3ah OAM does not include encryption 2477 or authentication mechanisms. It should be used in environments 2478 where either this interface information is not considered sensitive, 2479 or where the facility terminations are protected. By default, OAM is 2480 disabled on Ethernet like interfaces and is therefore not a risk. 2482 IEEE 802.3ah OAM is designed to support deployment in access and 2483 enterprise networks. In access networks, one end of a link is the 2484 CO-side, and the other is the CPE-side, and the facilities are often 2485 protected in wiring cages or closets. In such deployments, it is 2486 often the case that the CO-side is protected from access from the CPE 2487 side. Within IEEE P802.3ah OAM, this protection from remote access 2488 is accomplished by configuring the CPE-side in passive mode using the 2489 dot3OamMode attribute. This prevents the CPE from accessing 2490 functions and information at the CO-side of the connection. In 2491 enterprise networks, read-only interface information is often 2492 considered non-sensitive. 2494 The frequency of OAM PDUs on an Ethernet interface does not adversely 2495 affect data traffic as OAM is a slow protocol with very limited 2496 bandwidth potential, and it is not required for normal link 2497 operation. And although there are a number of objects in this module 2498 with read-write or read-create MAX-ACCESS, they have limited effects 2499 on user data. 2501 The loopback capability of OAM can have potentially disruptive 2502 effects in that the when enabling remote loopback, the remote station 2503 automatically transmits all received traffic back to the local 2504 station except for OAM traffic. This completely disrupts all higher 2505 layer protocols such as bridging, IP, and SNMP. Therefore an 2506 attribute (dot3OamLoopbackIgnoreRx) was introduced to control whether 2507 the local station processes or ignores received loopback commands. 2509 The administrative state and mode are also read-write objects. 2510 Disabling OAM can interrupt management activities between peer 2511 devices, potentially causing serious problems. Setting the 2512 dot3OamMode to an undesired value can allow access to Ethernet 2513 monitoring, events, and functions that may not be acceptable in a 2514 particular deployment scenario. In addition to loopback 2515 functionality, Ethernet interface statistics and events can be 2516 accessed via the OAM protocol, which may not be desired in some 2517 circumstances. 2519 OAM event configuration also contains read-write objects. These 2520 objects control whether events are sent, and at what thresholds. 2521 Note that the frequency of event communication is limited by the 2522 frequency limits of Slow Protocols on Ethernet interfaces. Also, the 2523 information available via OAM events is also available via OA 2524 Variable Requests. Access to this information via either OAM events 2525 or Variable Requests is controlled by the dot3OamAdminState and 2526 dot3OamMode objects. As mentioned previously, inadequate protection 2527 of these variables can result in access to link information and 2528 functions. 2530 SNMP versions prior to SNMPv3 did not include adequate security. Even 2531 if the network itself is secure (for example by using IPSec), even 2532 then, there is no control as to who on the secure network is allowed 2533 to access and GET/SET (read/change/create/delete) the objects in this 2534 MIB module. 2536 It is RECOMMENDED that implementers consider the security features as 2537 provided by the SNMPv3 framework (see [RFC3410], section 8), 2538 including full support for the SNMPv3 cryptographic mechanisms (for 2539 authentication and privacy). 2541 Further, deployment of SNMP versions prior to SNMPv3 is NOT 2542 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 2543 enable cryptographic security. It is then a customer/operator 2544 responsibility to ensure that the SNMP entity giving access to an 2545 instance of this MIB module is properly configured to give access to 2546 the objects only to those principals (users) that have legitimate 2547 rights to indeed GET or SET (change/create/delete) them 2549 8. IANA Considerations 2551 The Ethernet OAM MIB requires the allocation of a single object 2552 identifier for its MODULE-IDENTITY under the MIB-2 tree. 2554 The MIB module in this document uses the following IANA-assigned 2555 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 2557 Descriptor OBJECT IDENTIFIER 2558 ---------- ----------------- 2559 dot3OamMIB { mib-2 XXX } 2561 Editor's Note (to be removed prior to publication): the IANA is 2562 requested to assign a value for "XXX" under the 'mib-2' subtree and 2563 to record the assignment in the SMI Numbers registry. When the 2564 assignment has been made, the RFC Editor is asked to replace "XXX" 2565 (here and in the MIB module) with the assigned value and to remove 2566 this note. 2568 9. References 2570 9.1 Normative References 2572 [802.3ah] Institute of Electrical and Electronic Engineers, IEEE 2573 Std 802.3ah-2004, "Part 3: Carrier Sense Multiple Access 2574 with Collision Detection (CSMA/CD) Access Method and 2575 Physical Layer Specifications - Amendment: Media Access 2576 Control Parameters, Physical Layers and Management 2577 Parameters for Subscriber Access Networks", October 2004. 2579 [802.3-2002] Institute of Electrical and Electronic Engineers, IEEE 2580 Std 802.3-2003, "IEEE Standard for Carrier Sense Multiple 2581 Access with Collision Detection (CSMA/CD) Access Method 2582 and Physical Layer Specifications - Draft amendment to - 2583 Information technology - Telecommunications and 2584 information exchange between systems - Local and 2585 metropolitan area networks - Specific requirements - Part 2586 3: Carrier sense multiple access with collision detection 2587 (CSMA/CD) access method and physical layer specifications 2588 - Media Access Control Parameters, Physical Layers and 2589 Management Parameters", March 2002. 2591 [802.3-2005] Institute of Electrical and Electronic Engineers, IEEE 2592 Std 802.3-2005, "IEEE Standard for Carrier Sense Multiple 2593 Access with Collision Detection (CSMA/CD) Access Method 2594 and Physical Layer Specifications - Draft amendment to - 2595 Information technology - Telecommunications and 2596 information exchange between systems - Local and 2597 metropolitan area networks - Specific requirements - Part 2598 3: Carrier sense multiple access with collision detection 2599 (CSMA/CD) access method and physical layer specifications 2600 - Media Access Control Parameters, Physical Layers and 2601 Management Parameters", December 2005. 2603 [802-2001] Institute of Electrical and Electronic Engineers, IEEE 2604 Std 802-2001, "Standard for Local and Metropolitan Area 2605 Networks: Architecture and Overview", March 2002. 2607 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2608 Requirement Levels", BCP 14, RFC 2119, March 1997 2610 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 2611 McCloghrie, K., Rose, M. and S. Waldbusser, "Structure of 2612 Management Information Version 2 (SMIv2)", STD 58, RFC 2613 2578, April 1999. 2615 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 2616 McCloghrie, K., Rose, M. and S. Waldbusser, "Textual 2617 Conventions for SMIv2", STD 58, RFC 2579, April 1999. 2619 [RFC2580] McCloghrie, K., Perkins, D. and J. Schoenwaelder, 2620 "Conformance Statements for SMIv2", STD 58, RFC 2580, 2621 April 1999. 2623 [RFC2856] Bierman, A., McCloghrie, K., Presuhn, R., "Textual 2624 Conventions for Additional High Capacity Data Types", RFC 2625 2856, June 2000. 2627 [RFC2863] McCloghrie, K., Kastenholz, F., "The Interfaces Group 2628 MIB", RFC 2863, June 2000. 2630 9.2 Informative References 2632 [802.3ah-copper] Beili, Ed, "Ethernet in the First Mile Copper 2633 (EFMCu) Interfaces MIB", draft-ietf-hubmib-efm-cu-05.txt, 2634 March 2006. 2636 [802.3ah-epon] Khermosh, Lior, "Managed Object of EPON", draft-ietf 2637 hubmib-efm-epon-mib-04.txt, February 2006. 2639 [RFC3410] Case, J., Mundy, R., Partain, D., Stewart, B., 2640 "Introduction and Applicability Statements for Internet 2641 Standard Management Framework", RFC 3410, December 2003. 2643 [RFC3635] Flick, J., "Definitions of Managed Objects for the 2644 Ethernet like Interface Types", RFC 3635, September 2003. 2646 10. Acknowledgments 2648 The author is grateful to all of the participants in the IEEE 802.3ah 2649 EFM (Ethernet in the First Mile) taskforce. In particular, the 2650 strong leadership and dedication of the following individuals is 2651 noted: 2653 Kevin Daines (Editor, IEEE 802.3ah OAM clauses) 2654 Ben Brown (Editor, IEEE 802.3ah Logic clauses) 2655 David Law (Editor, IEEE 802.3ah Management clauses) 2656 Scott Simon (Editor, IEEE 802.3ah Clause 45) 2657 Howard Frazier (Chair, IEEE 802.3ah) 2658 Hugh Barass (Vice-Chair, IEEE 802.3ah) 2659 Wael Diab (Editor, IEEE 802.3ah) 2661 Additionally, certain devoted attendees and contributors to the IEEE 2662 802.3ah OAM sub-taskforce deserve recognition. Although there were 2663 many contributors, the following individuals contributed heavily over 2664 a long period of time. 2666 Brian Arnold 2667 Brad Booth 2668 Al Braga 2669 Floyd Gerhardt 2670 Bob Grow 2671 Eric Lynskey 2672 David Martin 2673 John Messenger 2674 Dan Romascanu (Ex-Chair, IETF HUBMIB WG) 2675 Jonathan Thatcher 2676 Geoff Thompson 2678 11. Author's Address 2680 Note: Author's email address is spelled out to help protect against 2681 email address harvesting programs. 2683 Matt Squire 2684 Hatteras Networks 2685 529 Davis Drive 2686 Durham, NC 27713 2687 Email: msquire at hatterasnetworks dot com 2689 12. Intellectual Property Statement 2691 The IETF takes no position regarding the validity or scope of any 2692 Intellectual Property Rights or other rights that might be claimed to 2693 pertain to the implementation or use of the technology described in 2694 this document or the extent to which any license under such rights 2695 might or might not be available; nor does it represent that it has 2696 made any independent effort to identify any such rights. Information 2697 on the procedures with respect to rights in RFC documents can be 2698 found in BCP 78 and BCP 79. 2700 Copies of IPR disclosures made to the IETF Secretariat and any 2701 assurances of licenses to be made available, or the result of an 2702 attempt made to obtain a general license or permission for the use of 2703 such proprietary rights by implementers or users of this 2704 specification can be obtained from the IETF on-line IPR repository at 2705 http://www.ietf.org/ipr. 2707 The IETF invites any interested party to bring to its attention any 2708 copyrights, patents or patent applications, or other proprietary 2709 rights that may cover technology that may be required to implement 2710 this standard. Please address the information to the IETF at 2711 ietf-ipr@ietf.org. 2713 The IETF has been notified of intellectual property rights claimed in 2714 regard to some or all of the specification contained in this 2715 document. For more information consult the online list of claimed 2716 rights. 2718 13. Copyright Statement 2720 Copyright (C) The IETF Trust (2007). 2722 This document is subject to the rights, licenses and restrictions 2723 contained in BCP 78, and except as set forth therein, the authors 2724 retain all their rights. 2726 This document and the information contained herein are provided 2727 on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE 2728 REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE 2729 IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL 2730 WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY 2731 WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY 2732 RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A 2733 PARTICULAR PURPOSE. 2735 Acknowledgement 2737 Funding for the RFC Editor function is currently provided by the 2738 Internet Society.