idnits 2.17.1 draft-ietf-hubmib-efm-mib-04.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 15. -- Found old boilerplate from RFC 3978, Section 5.5 on line 2738. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 2702. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 2709. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 2715. ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 1 longer page, the longest (page 5) being 60 lines 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 RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 277 has weird spacing: '...ficInfo dot3...' == Line 282 has weird spacing: '...ationTx dot3O...' == Line 283 has weird spacing: '...ationRx dot3O...' == Line 297 has weird spacing: '...dConfig dot...' == Line 303 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.) -- Couldn't find a document date in the document -- date freshness check skipped. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC2586' is defined on line 2621, but no explicit reference was found in the text == Unused Reference: 'RFC3636' is defined on line 2644, but no explicit reference was found in the text -- Possible downref: Non-RFC (?) normative reference: ref. '802-2001' -- Obsolete informational reference (is this intentional?): RFC 3636 (Obsoleted by RFC 4836) Summary: 3 errors (**), 0 flaws (~~), 13 warnings (==), 9 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Ethernet Interfaces and Hub MIB WG 2 Internet Draft Matt Squire 3 Document: draft-ietf-hubmib-efm-mib-04.txt Hatteras Networks 4 Expires: September 2006 March, 2006 6 Definitions and Managed Objects for OAM Functions on Ethernet Like 7 Interfaces 8 draft-ietf-hubmib-efm-mib-04.txt 10 Status of this Memo 12 By submitting this Internet-Draft, each author represents that any 13 applicable patent or other IPR claims of which he or she is aware 14 have been or will be disclosed, and any of which he or she becomes 15 aware will be disclosed, in accordance with Section 6 of BCP 79. 17 Internet-Drafts are working documents of the Internet Engineering 18 Task Force (IETF), its areas, and its working groups. Note that 19 other groups may also distribute working documents as Internet- 20 Drafts. 22 Internet-Drafts are draft documents valid for a maximum of six months 23 and may be updated, replaced, or obsoleted by other documents at any 24 time. It is inappropriate to use Internet-Drafts as reference 25 material or to cite them other than as "work in progress." 27 The list of current Internet-Drafts can be accessed at 28 http://www.ietf.org/ietf/1id-abstracts.txt 30 The list of Internet-Draft Shadow Directories can be accessed at 31 http://www.ietf.org/shadow.html. 33 This Internet-Draft will expire in September, 2006. 35 Abstract 37 This document defines objects for managing Operations, 38 Administration, and Maintenance (OAM) capabilities on Ethernet like 39 interfaces conformant to the Ethernet OAM functionality defined in 40 [802.3ah]. The Ethernet OAM functionality is complementary to SNMP 41 management in that it is focused on a small set of link-specific 42 functions for directly connected Ethernet interfaces. This document 43 defines objects for controlling those link OAM functions, and for 44 providing results and status of the OAM functions to management 45 entities. 47 Conventions used in this document 49 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 50 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 51 document are to be interpreted as described in RFC 2119 [RFC2119]. 53 Table of Contents 55 1. Introduction...................................................2 56 2. The Internet-Standard Management Framework.....................2 57 3. Overview.......................................................3 58 3.1 Remote fault indication....................................4 59 3.2 Link monitoring............................................4 60 3.3 Remote loopback............................................5 61 3.4 Ethernet OAM Protocol Data Units...........................5 62 4. Relation to the Other MIB Modules..............................5 63 4.1 Relation to other SNMP MIB Modules.........................5 64 4.2 Relation to other EFM MIB Modules..........................5 65 4.3 Mapping of IEEE 802.3ah Managed Objects....................6 66 5. MIB Structure..................................................7 67 6. MIB Definition.................................................8 68 7. Security Considerations.......................................52 69 8. IANA Considerations...........................................53 70 9. References....................................................54 71 9.1 Normative References......................................54 72 9.2 Informative References....................................55 73 10. Acknowledgments..............................................55 74 11. Author's Address.............................................56 75 12. Intellectual Property Statement..............................56 76 13. Copyright Statement..........................................57 78 1. 79 Introduction 81 The IEEE 802.3ah Ethernet in the First Mile (EFM) task force added 82 new management capabilities to Ethernet like interfaces. These 83 management capabilities were introduced to provide some basic OAM 84 function on Ethernet media. The defined functionality includes 85 discovery, error signaling, loopback, and link monitoring. This memo 86 defines a portion of the Management Information Base (MIB) for use 87 with network management protocols in the Internet community to manage 88 these new Ethernet interface capabilities. 90 2. 91 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. 106 Overview 108 Ethernet networks have evolved over the past 30 years from simple 109 LANs to a variety of other applications, including wide area 110 networks. To address some of these emerging markets, the IEEE 111 802.3ah task force defined additional clauses in [802.3ah] for the 112 IEEE 802.3 standard [802.3-2002] to better address Ethernet 113 deployments in the public access network. Although Ethernet access 114 deployments were the primary motivation for the task force activity, 115 the results of the task force are not strictly limited to that 116 application. 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 OAM 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. 159 3.1 160 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 179 Link monitoring 181 Ethernet OAM includes event signaling capability so that one end of 182 an Ethernet link can indicate the occurrence of certain important 183 events to the other end of the link. This happens via layer two 184 protocols. This document defines methods for incorporating the 185 occurrence of these layer two events, both at the local end and far 186 end of the link, into the SNMP management framework. 188 Ethernet OAM also includes mechanisms for one Ethernet station to 189 query another directly connected Ethernet station about the status of 190 its Ethernet interface variables and status. This document does not 191 include mechanisms for controlling how one Ethernet endpoint may use 192 this functionality to query the status or statistics of a peer 193 Ethernet entity. 195 3.3 196 Remote loopback 198 Remote loopback is a link state where the peer Ethernet entity echoes 199 every received packet (without modifications) back onto the link. 200 Remote loopback is intrusive in that the other end of the link is not 201 forwarding traffic from higher layers out over the link. This 202 document defines objects controlling loopback operation and reading 203 the status of the loopback state. 205 3.4 206 Ethernet OAM Protocol Data Units 208 An Ethernet OAM protocol data unit is a valid Ethernet frame with a 209 destination MAC address equal to the reserved MAC address for Slow 210 Protocols (See 43B of [802.3ah], a lengthOrType field equal to the 211 reserved type for Slow Protocols, and a Slow Protocols subtype equal 212 to that of the subtype reserved for Ethernet OAM. 214 OAMPDU is used throughout this document as an abbreviation for 215 Ethernet OAM protocol data unit. OAMPDUs are the mechanism two 216 directly connected Ethernet interfaces exchange OAM information. 218 4. 219 Relation to the Other MIB Modules 221 The definitions presented here are based on Clauses 30 and 57 of 222 [802.3ah]. Note that these clauses describe many of these variables 223 and their effects on the MAC layer. In some cases there is a one-to 224 one relationship between an object in this document and an object in 225 the Clause 30 MIB of [802.3ah]. In other cases, the objects of this 226 document reflect a more complex entity and are reflected by more than 227 one object in the Clause 30 MIB of [802.3ah]. 229 4.1 230 Relation to other SNMP MIB Modules 232 The objects defined in this document manage OAM functionality 233 introduced in [802.3ah] These objects do not overlap with the 234 interfaces MIB [RFC2863], the Ethernet like interfaces MIB [RFC3635], 235 or any other MIB currently used to manage various aspects of an 236 Ethernet interface. The objects defined here are defined for 237 Ethernet like interfaces only and use the same ifIndex as the 238 associated Ethernet interface. Ethernet OAM can be implemented on 239 any Ethernet like interface. 241 4.2 242 Relation to other EFM MIB Modules 243 The Ethernet OAM functionality and MIB Module is independent of the 244 other functionality and MIB Modules derived from [802.3ah] for copper 245 [802.3ah-copper] and EPON [802.3ah-epon]. Ethernet OAM may be 246 implemented (or not) on the new EFM interface types, just as it can 247 on any other Ethernet interface. 249 4.3 250 Mapping of IEEE 802.3ah Managed Objects 252 This section contains the mapping between managed objects defined in 253 [802.3ah] Clause 30, and managed objects defined in this document. 255 IEEE 802.3 Managed Object Corresponding SNMP object 257 oOAM 258 .aOAMID IF-MIB ifIndex 259 .aOAMAdminState dot3OamAdminState 260 .aOAMMode dot3OamMode 261 .aOAMDiscoveryState dot3OamOperStatus 262 .aOAMRemoteMACAddress dot3OamPeerMacAddress 263 .aOAMLocalConfiguration dot3OamFunctionsSupported 264 .aOAMRemoteConfiguration dot3OamPeerFunctionsSupported, 265 dot3OamPeerMode 266 .aOAMLocalPDUConfiguration dot3OamMaxOamPduSize 267 .aOAMRemotePDUConfiguration dot3OamPeerMaxOamPduSize 268 .aOAMLocalFlagsField dot3OamOperStatus, 269 dot3OamEventLogEntry 270 .aOAMRemoteFlagsField dot3OamOperStatus, 271 dot3OamEventLogEntry 272 .aOAMLocalRevision dot3OamConfigRevision 273 .aOAMRemoteRevision dot3OamPeerConfigRevision 274 .aOAMLocalState dot3OamLoopbackStatus 275 .aOAMRemoteState dot3OamLoopbackStatus 276 .aOAMRemoteVendorOUI dot3OamPeerVendorOui 277 .aOAMRemoteVendorSpecificInfo dot3OamPeerVendorInfo 278 .aOAMUnsupportedCodesTx dot3OamUnsupportedCodesTx 279 .aOAMUnsupportedCodesRx dot3OamUnsupportedCodesRx 280 .aOAMInformationTx dot3OamInformationTx 281 .aOAMInformationRx dot3OamInformationRx 282 .aOAMUniqueEventNotificationTx dot3OamUniqueEventNotificationTx 283 .aOAMUniqueEventNotificationRx dot3OamUniqueEventNotificationRx 284 .aOAMDuplicateEventNotificationTx 285 dot3OamDuplicateEventNotificationTx 286 .aOAMDuplicateEventNotificationRx 287 dot3OamDuplicateEventNotificationRx 288 .aOAMLoopbackControlTx dot3OamLoopbackControlTx 289 .aOAMLoopbackControlRx dot3OamLoopbackControlRx 290 .aOAMVariableRequestTx dot3OamVariableRequestTx 291 .aOAMVariableRequestRx dot3OamVariableRequestRx 292 .aOAMVariableResponseTx dot3OamVariableResponseTx 293 .aOAMVariableResponseRx dot3OamVariableResponseRx 294 .aOAMOrganizationSpecificTx dot3OamOrgSpecificTx 295 .aOAMOrganizationSpecificRx dot3OamOrgSpecificTx 297 .aOAMLocalErrSymPeriodConfig dot3OamErrSymPeriodWindow, 298 dot3OamErrSymPeriodThreshold 299 .aOAMLocalErrSymPeriodEvent dot3OamEventLogEntry 300 .aOAMLocalErrFrameConfig dot3OamErrFrameWindow, 301 dot3OamErrFrameThreshold 302 .aOAMLocalErrFrameEvent dot3OamEventLogEntry 303 .aOAMLocalErrFramePeriodConfig dot3OamErrFramePeriodWindow, 304 dot3OamErrFramePeriodThreshold 305 .aOAMLocalErrFramePeriodEvent dot3OamEventLogEntry 306 .aOAMLocalErrFrameSecsSummaryConfig 307 dot3OamErrFrameSecsSummaryWindow, 308 dot3OamErrFrameSecssummaryThreshold 309 .aOAMLocalErrFrameSecsSummaryEvent 310 dot3OamEventLogEntry 311 .aOAMRemoteErrSymPeriodEvent dot3OamEventLogEntry 312 .aOAMRemoteErrFrameEvent dot3OamEventLogEntry 313 .aOAMRemoteErrFramePeriodEvent dot3OamEventLogEntry 314 .aOAMRemoteErrFrameSecsSummaryEvent 315 dot3OamEventLogEntry 316 .aFramesLostDueToOAmError dot3OamFramesLostDueToOam 317 .acOAMAdminControl dot3OamAdminState 319 There are no IEEE 802.3ah managed objects that are not reflected in 320 this MIB Module in some manner. 322 5. 323 MIB Structure 325 The Ethernet OAM MIB objects of this memo focus on the OAM 326 capabilities introduced in [802.3ah]. The MIB objects are 327 partitioned into six different MIB groups. 329 The dot3OamTable group manages the primary OAM objects of the 330 Ethernet interface. This group controls the state and status of OAM 331 as well as the mode in which it operates. 333 The dot3OamPeerTable maintains the current information on the status 334 and configuration of the peer OAM entity on the Ethernet interface. 335 Managed information includes the capabilities and function available 336 on the peer OAM entity. 338 The dot3OamLoopbackTable manages the loopback function introduced in 339 [802.3ah]. This table controls enabling and disabling loopback, as 340 well as indicating the loopback status of Ethernet OAM on this 341 interface. 343 The dot3OamStatsTable maintains statistics on the number and type of 344 Ethernet OAM frames being transmitted and received on the Ethernet 345 interface. 347 The dot3OamEventConfigTable defines the objects for managing the 348 event notification capability available in Ethernet OAM. With 349 Ethernet OAM, one device may send notifications to its peer devices 350 whenever an important event happens on the local device. This table 351 provides management of which events result in notifications via 352 Ethernet OAM notifications and/or via SNMP notifications. 354 The dot3OamEventLogTable manages the current status of local and 355 remote events detected via Ethernet OAM. This table is updated 356 whenever local events are detected by Ethernet OAM or whenever 357 Ethernet OAM Event Notifications are received from the peer OAM 358 entity. 360 There are also a set of notifications (dot3OamNotifications) that 361 define alert conditions to management. The [802.3ah] Event 362 Notifications can each be implemented independently of any other, and 363 therefore each has their own conformance group. 365 6. 366 MIB Definition 368 DOT3-OAM-MIB DEFINITIONS ::= BEGIN 370 IMPORTS 371 MODULE-IDENTITY, mib-2, OBJECT-TYPE, Counter32, Unsigned32, 372 Integer32, NOTIFICATION-TYPE 373 FROM SNMPv2-SMI 374 TEXTUAL-CONVENTION, MacAddress, TimeStamp, TruthValue 375 FROM SNMPv2-TC 376 CounterBasedGauge64 377 FROM HCNUM-TC 378 ifIndex 379 FROM IF-MIB 380 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP 381 FROM SNMPv2-CONF; 383 dot3OamMIB MODULE-IDENTITY 384 LAST-UPDATED "200603050000Z" -- March 5,2006" 385 ORGANIZATION 386 "IETF Ethernet Interfaces and Hub MIB Working Group" 387 CONTACT-INFO 388 "WG Charter: 389 http://www.ietf.org/html.charters/hubmib-charter.html 391 Mailing lists: 392 General Discussion: hubmib@ietf.org 393 To Subscribe: hubmib-requests@ietf.org 394 In Body: subscribe your_email_address 395 Chair: Dan Romascanu, Avaya 396 Tel: +972-3-645-8414 397 Email: dromasca at avaya dot com 398 Editor: Matt Squire 399 Hatteras Networks 400 Tel: +1-919-991-5460 401 Fax: +1-919-991-0743 402 E-mail: msquire at hatterasnetworks dot com 403 " 404 DESCRIPTION 405 "The MIB module for managing the new Ethernet OAM features 406 introduced by the Ethernet in the First Mile task force (IEEE 407 802.3ah). The functionality presented here is based on IEEE 408 802.3ah [802.3ah], released in October, 2004. [802.3ah] was 409 prepared as an addendum to the standing version of IEEE 802.3 410 [802.3-2002] at the time. Since then, [802.3ah] has been 411 merged into the base IEEE 802.3 specification in [802.3-2005]. 413 In particular, this MIB focuses on the new OAM functions 414 introduced in Clause 57 of [802.3ah]. The OAM functionality 415 of Clause 57 is controlled by new management attributes 416 introduced in Clause 30 of [802.3ah]. The OAM functions are 417 not specific to any particular Ethernet physical layer, and 418 can be generically applied to any Ethernet interface of 419 [802.3-2002]. 421 An Ethernet OAM protocol data unit is a valid Ethernet frame 422 with a destination MAC address equal to the reserved MAC 423 address for Slow Protocols (See 43B of [802.3ah]), a 424 lengthOrType field equal to the reserved type for Slow 425 Protocols, and a Slow Protocols subtype equal to that of the 426 subtype reserved for Ethernet OAM. OAMPDU is used throughout 427 this document as an abbreviation for Ethernet OAM protocol 428 data unit. 430 The following reference is used throughout this MIB module: 432 [802.3ah] refers to: 433 IEEE Std 802.3ah-2004: 'Draft amendment to - 434 Information technology - Telecommunications and 435 information exchange between systems - Local and 436 metropolitan are networks - Specific requirements - Part 437 3: Carrier sense multiple access with collision detection 438 (CSMA/CD) access method and physical layer specifications 439 - Media Access Control Parameters, Physical Layers and 440 Management Parameters for subscriber access networks', 441 October 2004. 443 [802.3-2002] refers to: 444 IEEE Std 802.3-2002: 445 'Information technology - Telecommunications and 446 information exchange between systems - Local and 447 metropolitan are networks - Specific requirements - Part 448 3: Carrier sense multiple access with collision detection 449 (CSMA/CD) access method and physical layer specifications 450 - Media Access Control Parameters, Physical Layers and 451 Management Parameters for subscriber access networks', 452 March 2002. 454 [802.3-2005] refers to: 455 IEEE Std 802.3-2002: 456 'Information technology - Telecommunications and 457 information exchange between systems - Local and 458 metropolitan are networks - Specific requirements - Part 459 3: Carrier sense multiple access with collision detection 460 (CSMA/CD) access method and physical layer specifications 461 - Media Access Control Parameters, Physical Layers and 462 Management Parameters for subscriber access networks', 463 December 2005. 465 [802-2001] refers to: 466 'IEEE Standard for LAN/MAN (Local Area 467 Network/Metropolitan Area Network): Overview and 468 Architecture', IEEE 802, June 2001. 470 Copyright (c) The Internet Society (2006). This version of 471 this MIB module is part of RFC XXXX; See the RFC itself for 472 full legal notices. " 473 -- RFC Editor: Update XXXX to appropriate RFC number 474 -- RFC Editor: Remove these notes 476 REVISION "200603050000Z" -- March 5, 2006" 477 DESCRIPTION "Initial version, published as RFC XXXX." 478 -- RFC Editor: Update XXXX to appropriate RFC number 479 -- RFC Editor: Remove these notes 481 ::= { mib-2 XXX } 482 -- RFC Editor: Replace value with IANA assigned number 483 -- RFC Editor: Remove these notes 485 -- 486 -- Sections of the Ethernet OAM MIB 487 -- 488 dot3OamNotifications OBJECT IDENTIFIER ::= { dot3OamMIB 0 } 489 dot3OamObjects OBJECT IDENTIFIER ::= { dot3OamMIB 1 } 490 dot3OamConformance OBJECT IDENTIFIER ::= { dot3OamMIB 2 } 492 -- 493 -- Textual conventions for OAM MIB 494 -- 495 Dot3Oui ::= TEXTUAL-CONVENTION 496 STATUS current 497 DESCRIPTION 498 "24-bit Organizationally Unique Identifier. Information on 499 OUIs can be found in IEEE 802-2001 [802-2001] Clause 9." 500 SYNTAX OCTET STRING(SIZE(3)) 502 -- *************************************************************** 503 -- 504 -- Ethernet OAM Control group 505 -- 507 dot3OamTable OBJECT-TYPE 508 SYNTAX SEQUENCE OF Dot3OamEntry 509 MAX-ACCESS not-accessible 510 STATUS current 511 DESCRIPTION 512 "This table contains the primary controls and status for the 513 OAM capabilities of an Ethernet like interface. There will be 514 one row in this table for each Ethernet like interface in the 515 system that supports the OAM functions defined in [802.3ah]. 516 " 517 ::= { dot3OamObjects 1 } 519 dot3OamEntry OBJECT-TYPE 520 SYNTAX Dot3OamEntry 521 MAX-ACCESS not-accessible 522 STATUS current 523 DESCRIPTION 524 "An entry in the table, containing information on the Ethernet 525 OAM function for a single Ethernet like interface. Entries in 526 the table are created automatically for each interface 527 supporting Ethernet OAM. The status of the row entry can be 528 determined from dot3OamOperStatus. 530 A dot3OamEntry is indexed in the dot3OamTable by the ifIndex 531 object of the Interfaces MIB. 532 " 533 INDEX { ifIndex } 534 ::= { dot3OamTable 1 } 536 Dot3OamEntry ::= 537 SEQUENCE { 538 dot3OamAdminState INTEGER, 539 dot3OamOperStatus INTEGER, 540 dot3OamMode INTEGER, 541 dot3OamMaxOamPduSize Unsigned32, 542 dot3OamConfigRevision Unsigned32, 543 dot3OamFunctionsSupported BITS 544 } 546 dot3OamAdminState OBJECT-TYPE 547 SYNTAX INTEGER { 548 disabled(1), 549 enabled(2) 550 } 551 MAX-ACCESS read-write 552 STATUS current 553 DESCRIPTION 554 "This object is used to provision the default administrative 555 OAM mode for this interface. This object represents the 556 desired state of OAM for this interface. 558 The dot3OamAdminState always starts in the disabled(1) state 559 until an explicit management action or configuration 560 information retained by the system causes a transition to the 561 enabled(2) state. When enabled(2), Ethernet OAM will attempt 562 to operate over this interface. 563 " 564 REFERENCE "[802.3ah], 30.3.6.1.2" 565 ::= { dot3OamEntry 1 } 567 dot3OamOperStatus OBJECT-TYPE 568 SYNTAX INTEGER { 569 disabled(1), 570 linkFault(2), 571 passiveWait(3), 572 activeSendLocal(4), 573 sendLocalAndRemote(5), 574 sendLocalAndRemoteOk(6), 575 oamPeeringLocallyRejected(7), 576 oamPeeringRemotelyRejected(8), 577 operational(9), 578 nonOperHalfDuplex(10) 579 } 580 MAX-ACCESS read-only 581 STATUS current 582 DESCRIPTION 583 "At initialization and failure conditions, two OAM entities on 584 the same full-duplex Ethernet link begin a discovery phase to 585 determine what OAM capabilities may be used on that link. The 586 progress of this initialization is controlled by the OAM 587 sublayer. 589 This value is always disabled(1) if OAM is disabled on this 590 interface via the dot3OamAdminState. 592 If the link has detected a fault and is transmitting OAMPDUs 593 with a link fault indication, the value is linkFault(2). Also, 594 if the interface is not operational (ifOperStatus is not 595 up(1)), linkFault(2) is returned. Note that the object 596 ifOperStatus may not be up(1) as a result of link failure or 597 administrative action (ifAdminState being down(2) or 598 testing(3)). 600 The passiveWait(3) state is returned only by OAM entities in 601 passive mode (dot3OamMode) and reflects the state in which the 602 OAM entity is waiting to see if the peer device is OAM 603 capable. The activeSendLocal(4) value is used by active mode 604 devices (dot3OamMode) and reflects the OAM entity actively 605 trying to discover whether the peer has OAM capability but has 606 not yet made that determination. 608 The state sendLocalAndRemote(5) reflects that the local OAM 609 entity has discovered the peer but has not yet accepted or 610 rejected the configuration of the peer. The local device can, 611 for whatever reason, decide that the peer device is 612 unacceptable and decline OAM peering. If the local OAM entity 613 rejects the peer OAM entity, the state becomes 614 oamPeeringLocallyRejected(7). If the OAM peering is allowed 615 by the local device, the state moves to 616 sendLocalAndRemoteOk(6). Note that both the 617 sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states 618 fall within the state SEND_LOCAL_REMOTE of the Discovery state 619 diagram [802.3ah, Figure 57-5], with the difference being 620 whether the local OAM client has actively rejected the peering 621 or has just not indicated any decision yet. Whether a peering 622 decision has been made is indicated via the local flags field 623 in the OAMPDU (reflected in the aOAMLocalFlagsField of 624 30.3.6.1.10). 626 If the remote OAM entity rejects the peering, the state 627 becomes oamPeeringRemotelyRejected(8). Note that both the 628 sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8) 629 states fall within the state SEND_LOCAL_REMOTE_OK of the 630 Discovery state diagram [802.3ah, Figure 57-5], with the 631 difference being whether the remote OAM client has rejected 632 the peering or has just not yet decided. This is indicated 633 via the remote flags field in the OAM PDU (reflected in the 634 aOAMRemoteFlagsField of 30.3.6.1.11). 636 When the local OAM entity learns that both it and the remote 637 OAM entity have accepted the peering, the state moves to 638 operational(9) corresponding to the SEND_ANY state of the 639 Discovery state diagram [802.3ah, Figure 57-5]. 641 Since Ethernet OAM functions are not designed to work 642 completely over half-duplex interfaces, the value 643 nonOperHalfDuplex(10) is returned whenever Ethernet OAM is 644 enabled (dot3OamAdminState is enabled(1)) but the interface is 645 in half-duplex operation. 646 " 647 REFERENCE "[802.3ah], 30.3.6.1.4, 30.3.6.1.10, 30.3.6.1.11" 648 ::= { dot3OamEntry 2 } 650 dot3OamMode OBJECT-TYPE 651 SYNTAX INTEGER { 652 active(1), 653 passive(2) 654 } 655 MAX-ACCESS read-write 656 STATUS current 657 DESCRIPTION 658 "This object configures the mode of OAM operation for this 659 Ethernet like interface. OAM on Ethernet interfaces may be in 660 'active' mode or 'passive' mode. These two modes differ in 661 that active mode provides additional capabilities to initiate 662 monitoring activities with the remote OAM peer entity, while 663 passive mode generally waits for the peer to initiate OAM 664 actions with it. As an example, an active OAM entity can put 665 the remote OAM entity in a loopback state, where a passive OAM 666 entity cannot. 668 The default value of dot3OamMode is dependent on the type of 669 system on which this Ethernet like interface resides. The 670 default value should be 'active(1)' unless it is known that 671 this system should take on a subservient role to the other 672 device connected over this interface. 674 Changing this value results in incrementing the configuration 675 revision field of locally generated OAMPDUs (30.3.6.1.12) and 676 potentially re-doing the OAM discovery process if the 677 dot3OamOperStatus was already operational(9). 678 " 679 REFERENCE "[802.3ah], 30.3.6.1.3" 680 ::= { dot3OamEntry 3 } 682 dot3OamMaxOamPduSize OBJECT-TYPE 683 SYNTAX Unsigned32 (64..1518) 684 UNITS "octets" 685 MAX-ACCESS read-only 686 STATUS current 687 DESCRIPTION 688 "The largest OAMPDU that the OAM entity supports. OAM 689 entities exchange maximum OAMPDU sizes and negotiate to use 690 the smaller of the two maximum OAMPDU sizes between the peers. 691 This value is determined by the local implementation. 692 " 693 REFERENCE "[802.3ah], 30.3.6.1.8" 694 ::= { dot3OamEntry 4 } 696 dot3OamConfigRevision OBJECT-TYPE 697 SYNTAX Unsigned32(0..65535) 698 MAX-ACCESS read-only 699 STATUS current 700 DESCRIPTION 701 "The configuration revision of the OAM entity as reflected in 702 the latest OAMPDU sent by the OAM entity. The config revision 703 is used by OAM entities to indicate configuration changes have 704 occurred which might require the peer OAM entity to 705 re-evaluate whether OAM peering is allowed. 706 " 707 REFERENCE "[802.3ah], 30.3.6.1.12" 708 ::= { dot3OamEntry 5 } 710 dot3OamFunctionsSupported OBJECT-TYPE 711 SYNTAX BITS { 712 unidirectionalSupport (0), 713 loopbackSupport(1), 714 eventSupport(2), 715 variableSupport(3) 716 } 717 MAX-ACCESS read-only 718 STATUS current 719 DESCRIPTION 720 "The OAM functions supported on this Ethernet like interface. 721 OAM consists of separate functional sets beyond the basic 722 discovery process which is always required. These functional 723 groups can be supported independently by any implementation. 724 These values are communicated to the peer via the local 725 configuration field of Information OAMPDUs. 727 Setting 'unidirectionalSupport(0)' indicates that the OAM 728 entity supports the transmission of OAMPDUs on links that are 729 operating in unidirectional mode (traffic flowing in one 730 direction only). Setting 'loopbackSupport(1)' indicates the 731 OAM entity can initiate and respond to loopback commands. 732 Setting 'eventSupport(2)' indicates the OAM entity can send 733 and receive Event Notification OAMPDUs. Setting 734 'variableSupport(3)' indicates the OAM entity can send and 735 receive Variable Request and Response OAMPDUs. 736 " 737 REFERENCE "[802.3ah], 30.3.6.1.6" 738 ::= { dot3OamEntry 6 } 740 -- *************************************************************** 741 -- 742 -- Ethernet OAM Peer group 743 -- 745 dot3OamPeerTable OBJECT-TYPE 746 SYNTAX SEQUENCE OF Dot3OamPeerEntry 747 MAX-ACCESS not-accessible 748 STATUS current 749 DESCRIPTION 750 "This table contains information about the OAM peer for a 751 particular Ethernet like interface. OAM entities communicate 752 with a single OAM peer entity on Ethernet links on which OAM 753 is enabled and operating properly. There is one entry in this 754 table for each entry in the dot3OamTable for which information 755 on the peer OAM entity is available. 756 " 757 ::= { dot3OamObjects 2 } 759 dot3OamPeerEntry OBJECT-TYPE 760 SYNTAX Dot3OamPeerEntry 761 MAX-ACCESS not-accessible 762 STATUS current 763 DESCRIPTION 764 "An entry in the table, containing information on the peer OAM 765 entity for a single Ethernet like interface. 767 Note that there is at most one OAM peer for each Ethernet like 768 interface. Entries are automatically created when information 769 about the OAM peer entity becomes available, and automatically 770 deleted when the OAM peer entity is no longer in 771 communication. Peer information is not available when 772 dot3OamOperStatus is disabled(1), linkFault(2), 773 passiveWait(3), activeSendLocal(4). or nonOperHalfDuplex(10)). 774 " 775 INDEX { ifIndex } 776 ::= { dot3OamPeerTable 1 } 778 Dot3OamPeerEntry ::= 779 SEQUENCE { 780 dot3OamPeerMacAddress MacAddress, 781 dot3OamPeerVendorOui Dot3Oui, 782 dot3OamPeerVendorInfo Unsigned32, 783 dot3OamPeerMode INTEGER, 784 dot3OamPeerMaxOamPduSize Unsigned32, 785 dot3OamPeerConfigRevision Unsigned32, 786 dot3OamPeerFunctionsSupported BITS 787 } 789 dot3OamPeerMacAddress OBJECT-TYPE 790 SYNTAX MacAddress 791 MAX-ACCESS read-only 792 STATUS current 793 DESCRIPTION 794 "The MAC address of the peer OAM entity. The MAC address is 795 derived from the most recently received OAMPDU. 796 " 797 REFERENCE "[802.3ah], 30.3.6.1.5." 798 ::= { dot3OamPeerEntry 1 } 800 dot3OamPeerVendorOui OBJECT-TYPE 801 SYNTAX Dot3Oui 802 MAX-ACCESS read-only 803 STATUS current 804 DESCRIPTION 805 "The OUI of the OAM peer as reflected in the latest 806 Information OAMPDU received with a Local Information TLV. The 807 OUI can be used to identify the vendor of the remote OAM 808 entity. This value is initialized to zero before any Local 809 Information TLV is received. 810 " 811 REFERENCE "[802.3ah], 30.3.6.1.16." 812 ::= { dot3OamPeerEntry 2 } 814 dot3OamPeerVendorInfo OBJECT-TYPE 815 SYNTAX Unsigned32 816 MAX-ACCESS read-only 817 STATUS current 818 DESCRIPTION 819 "The Vendor Info of the OAM peer as reflected in the latest 820 Information OAMPDU received with a Local Information TLV. The 821 vendor information field is within the Local Information TLV, 822 and can be used to determine additional information about the 823 peer entity. The format of the vendor information is 824 unspecified within the 32-bit field. This value is 825 initialized to zero before any Local Information TLV is 826 received. 827 " 828 REFERENCE "[802.3ah], 30.3.6.1.17." 829 ::= { dot3OamPeerEntry 3 } 831 dot3OamPeerMode OBJECT-TYPE 832 SYNTAX INTEGER { 833 active(1), 834 passive(2), 835 unknown(3) 836 } 837 MAX-ACCESS read-only 838 STATUS current 839 DESCRIPTION 840 "The mode of the OAM peer as reflected in the latest 841 Information OAMPDU received with a Local Information TLV. The 842 mode of the peer can be determined from the Configuration 843 field in the Local Information TLV of the last Information 844 OAMPDU received from the peer. The value is unknown(3) 845 whenever no Local Information TLV has been received. The 846 values of active(1) and passive(2) are returned when a Local 847 Information TLV has been received indicating the peer is in 848 active or passive mode, respectively. 849 " 850 REFERENCE "[802.3ah], 30.3.6.1.7." 851 ::= { dot3OamPeerEntry 4 } 853 dot3OamPeerMaxOamPduSize OBJECT-TYPE 854 SYNTAX Unsigned32 (0..1518) 855 UNITS "octets" 856 MAX-ACCESS read-only 857 STATUS current 858 DESCRIPTION 859 "The maximum size of OAMPDU supported by the peer as reflected 860 in the latest Information OAMPDU received with a Local 861 Information TLV. Ethernet OAM on this interface must not use 862 OAMPDUs that exceed this size. The maximum OAMPDU size can be 863 determined from the PDU Configuration field of the Local 864 Information TLV of the last Information OAMPDU received from 865 the peer. A value of zero is returned if no Local Information 866 TLV has been received. Otherwise, the value of the OAM peer's 867 maximum OAMPDU size is returned in this value. 869 Note that the values 1..63 are invalid sizes for Ethernet 870 frames and should never appear. 871 " 872 REFERENCE "[802.3ah], 30.3.6.1.9." 873 ::= { dot3OamPeerEntry 5 } 875 dot3OamPeerConfigRevision OBJECT-TYPE 876 SYNTAX Unsigned32(0..65535) 877 MAX-ACCESS read-only 878 STATUS current 879 DESCRIPTION 880 "The configuration revision of the OAM peer as reflected in 881 the latest OAMPDU. This attribute is changed by the peer 882 whenever it has a local configuration change for Ethernet OAM 883 this interface. The configuration revision can be determined 884 from the Revision field of the Local Information TLV of the 885 most recently received Information OAMPDU with a Local 886 Information TLV. A value of zero is returned if no Local 887 Information TLV has been received. 888 " 889 REFERENCE "[802.3ah], 30.3.6.1.13." 890 ::= { dot3OamPeerEntry 6 } 892 dot3OamPeerFunctionsSupported OBJECT-TYPE 893 SYNTAX BITS { 894 unidirectionalSupport (0), 895 loopbackSupport(1), 896 eventSupport(2), 897 variableSupport(3) 898 } 899 MAX-ACCESS read-only 900 STATUS current 901 DESCRIPTION 902 "The OAM functions supported on this Ethernet like interface. 903 OAM consists of separate functionality sets above the basic 904 discovery process. This value indicates the capabilities of 905 the peer OAM entity with respect to these functions. This 906 value is initialized so all bits are clear. 908 If unidirectionalSupport(0) is set, then the peer OAM entity 909 supports sending OAM frames on Ethernet interfaces when the 910 receive path is known to be inoperable. If 911 loopbackSupport(1) is set, then the peer OAM entity can send 912 and receive OAM loopback commands. If eventSupport(2) is set, 913 then the peer OAM entity can send and receive event OAMPDUs to 914 signal various error conditions. If variableSupport(3) is set, 915 then the peer OAM entity can send and receive variable 916 requests to monitor attribute value as described in Clause 57 917 of [802.3ah]. 919 The capabilities of the OAM peer can be determined from the 920 configuration field of the Local Information TLV of the most 921 recently received Information OAMPDU with a Local Information 922 TLV. All zeros are returned if no Local Information TLV has 923 yet been received. 924 " 925 REFERENCE "[802.3ah], REFERENCE 30.3.6.1.7." 926 ::= { dot3OamPeerEntry 7 } 928 -- *************************************************************** 929 -- 930 -- Ethernet OAM Loopback group 931 -- 933 dot3OamLoopbackTable OBJECT-TYPE 934 SYNTAX SEQUENCE OF Dot3OamLoopbackEntry 935 MAX-ACCESS not-accessible 936 STATUS current 937 DESCRIPTION 938 "This table contains controls for the loopback state of the 939 local link as well as indicating the status of the loopback 940 function. There is one entry in this table for each entry in 941 dot3OamTable that supports loopback functionality (where 942 dot3OamFunctionsSupported includes the loopbackSupport bit 943 set). 945 Loopback can be used to place the remote OAM entity in a state 946 where every received frame (except OAMPDUs) is echoed back 947 over the same interface on which they were received. In this 948 state, at the remote entity, 'normal' traffic is disabled as 949 only the looped back frames are transmitted on the interface. 950 Loopback is thus an intrusive operation that prohibits normal 951 data flow and should be used accordingly. " 952 ::= { dot3OamObjects 3 } 954 dot3OamLoopbackEntry OBJECT-TYPE 955 SYNTAX Dot3OamLoopbackEntry 956 MAX-ACCESS not-accessible 957 STATUS current 958 DESCRIPTION 959 "An entry in the table, containing information on the loopback 960 status for a single Ethernet like interface. Entries in the 961 table are automatically created whenever the local OAM entity 962 supports loopback capabilities. The loopback status on the 963 interface can be determined from the dot3OamLoopbackStatus 964 object. 965 " 966 INDEX { ifIndex } 967 ::= { dot3OamLoopbackTable 1 } 969 Dot3OamLoopbackEntry ::= 970 SEQUENCE { 971 dot3OamLoopbackStatus INTEGER, 972 dot3OamLoopbackIgnoreRx INTEGER 973 } 975 dot3OamLoopbackStatus OBJECT-TYPE 976 SYNTAX INTEGER { 977 -- all values, except where noted, can be read 978 -- but cannot be written 979 noLoopback (1), 981 -- initiatingLoopback can be read or written 982 initiatingLoopback (2), 983 remoteLoopback (3), 985 -- terminatingLoopback can be read or written 986 terminatingLoopback (4), 987 localLoopback (5), 988 unknown (6) 989 } 990 MAX-ACCESS read-write 991 STATUS current 992 DESCRIPTION 993 "The loopback status of the OAM entity. This status is 994 determined by a combination of the local parser and 995 multiplexer states, the remote parser and multiplexer states, 996 as well as by the actions of the local OAM client. When 997 operating in normal mode with no loopback in progress, the 998 status reads noLoopback(1). 1000 The values initiatingLooopback(2) and terminatingLoopback(4) 1001 can be read or written. The other values can only be read - 1002 they can never be written. Writing initiatingLoopback causes 1003 the local OAM entity to start the loopback process with its 1004 peer. This value can only be written when the status is 1005 noLoopback(1). Writing the value initiatingLoopback(2) in any 1006 other state has no effect. When in remoteLoopback(3), writing 1007 terminatingLoopback(4) causes the local OAM entity to initiate 1008 the termination of the loopback state. Writing 1009 terminatingLoopack(4) in any other state has no effect. 1010 If the OAM client initiates a looopback and has sent an 1011 Loopback OAMPDU and is waiting for a response, where the local 1012 parser and multiplexer states are DISCARD (see [802.3ah, 1013 57.2.11.1]), the status is 'initiatingLoopback'. In this 1014 case, the local OAM entity has yet to receive any 1015 acknowledgement that the remote OAM entity has received its 1016 loopback command request. 1018 If the local OAM client knows that the remote OAM entity is in 1019 loopback mode (via the remote state information as described 1020 in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is 1021 remoteLoopback(3). If the local OAM client is in the process 1022 of terminating the remote loopback [802.3ah, 57.2.11.3, 1023 30.3.6.1.14], with its local multiplexer and parser states in 1024 DISCARD, the status is terminatingLoopback(4). If the remote 1025 OAM client has put the local OAM entity in loopback mode as 1026 indicated by its local parser state, the status is 1027 localLoopback(5). 1029 The unknown(6) status indicates the parser and multiplexer 1030 combination is unexpected. This status may be returned if the 1031 OAM loopback is in a transition state but should not persist. 1033 The values of this attribute correspond to the following 1034 values of the local and remote parser and multiplexer states. 1036 value LclPrsr LclMux RmtPrsr RmtMux 1037 noLoopback FWD FWD FWD FWD 1038 initLoopback DISCARD DISCARD FWD FWD 1039 rmtLoopback DISCARD FWD LPBK DISCARD 1040 tmtngLoopback DISCARD DISCARD LPBK DISCARD 1041 lclLoopback LPBK DISCARD DISCARD FWD 1042 unknown *** any other combination *** 1043 " 1044 REFERENCE "[802.3ah], REFERENCE 57.2.11, 30.3.61.14, 1045 30.3.6.1.15" 1046 ::= { dot3OamLoopbackEntry 1 } 1048 dot3OamLoopbackIgnoreRx OBJECT-TYPE 1049 SYNTAX INTEGER { ignore(1), process(2) } 1050 MAX-ACCESS read-write 1051 STATUS current 1052 DESCRIPTION 1053 "Since OAM loopback is a disruptive operation (user traffic 1054 does not pass), this attribute provides a mechanism to provide 1055 controls over whether received OAM loopback commands are 1056 processed or ignored. When the value is ignore(1), received 1057 loopback commands are ignored. When the value is process(2), 1058 OAM loopback commands are processed. The default value is to 1059 ignore loopback commands (ignore(1)). 1061 " 1062 REFERENCE "[802.3ah], REFERENCE 57.2.11, 30.3.61.14, 1063 30.3.6.1.15" 1064 ::= { dot3OamLoopbackEntry 2 } 1066 -- *************************************************************** 1067 -- 1068 -- Ethernet OAM Statistics group 1069 -- 1071 dot3OamStatsTable OBJECT-TYPE 1072 SYNTAX SEQUENCE OF Dot3OamStatsEntry 1073 MAX-ACCESS not-accessible 1074 STATUS current 1075 DESCRIPTION 1076 "This table contains statistics for the OAM function on a 1077 particular Ethernet like interface. There is an entry in the 1078 table for every entry in the dot3OamTable. 1080 The counters in this table are defined as 32-bit entries to 1081 match the counter size as defined in [802.3ah]. Given the OAM 1082 protocol is a slow protocol, the counters increment at a slow 1083 rate. 1084 " 1085 ::= { dot3OamObjects 4 } 1087 dot3OamStatsEntry OBJECT-TYPE 1088 SYNTAX Dot3OamStatsEntry 1089 MAX-ACCESS not-accessible 1090 STATUS current 1091 DESCRIPTION 1092 "An entry in the table, containing statistics information on 1093 the Ethernet OAM function for a single Ethernet like 1094 interface. Entries are automatically created for every entry 1095 in the dot3OamTable. Counters are maintained across 1096 transitions in dot3OamOperStatus. 1097 " 1098 INDEX { ifIndex } 1099 ::= { dot3OamStatsTable 1 } 1101 Dot3OamStatsEntry ::= 1102 SEQUENCE { 1103 dot3OamInformationTx Counter32, 1104 dot3OamInformationRx Counter32, 1105 dot3OamUniqueEventNotificationTx Counter32, 1106 dot3OamUniqueEventNotificationRx Counter32, 1107 dot3OamDuplicateEventNotificationTx Counter32, 1108 dot3OamDuplicateEventNotificationRx Counter32, 1109 dot3OamLoopbackControlTx Counter32, 1110 dot3OamLoopbackControlRx Counter32, 1111 dot3OamVariableRequestTx Counter32, 1112 dot3OamVariableRequestRx Counter32, 1113 dot3OamVariableResponseTx Counter32, 1114 dot3OamVariableResponseRx Counter32, 1115 dot3OamOrgSpecificTx Counter32, 1116 dot3OamOrgSpecificRx Counter32, 1117 dot3OamUnsupportedCodesTx Counter32, 1118 dot3OamUnsupportedCodesRx Counter32, 1119 dot3OamFramesLostDueToOam Counter32 1120 } 1122 dot3OamInformationTx OBJECT-TYPE 1123 SYNTAX Counter32 1124 UNITS "frames" 1125 MAX-ACCESS read-only 1126 STATUS current 1127 DESCRIPTION 1128 "A count of the number of Information OAMPDUs transmitted on 1129 this interface. 1131 Discontinuities of this counter can occur at re-initialization 1132 of the management system, and at other times as indicated by 1133 the value of the ifCounterDiscontinuityTime. " 1134 REFERENCE "[802.3ah], 30.3.6.1.20." 1135 ::= { dot3OamStatsEntry 1 } 1137 dot3OamInformationRx OBJECT-TYPE 1138 SYNTAX Counter32 1139 UNITS "frames" 1140 MAX-ACCESS read-only 1141 STATUS current 1142 DESCRIPTION 1143 "A count of the number of Information OAMPDUs received on this 1144 interface. 1146 Discontinuities of this counter can occur at re-initialization 1147 of the management system, and at other times as indicated by 1148 the value of the ifCounterDiscontinuityTime. 1149 " 1150 REFERENCE "[802.3ah], 30.3.6.1.21." 1151 ::= { dot3OamStatsEntry 2 } 1153 dot3OamUniqueEventNotificationTx OBJECT-TYPE 1154 SYNTAX Counter32 1155 UNITS "frames" 1156 MAX-ACCESS read-only 1157 STATUS current 1158 DESCRIPTION 1159 "A count of the number of unique Event OAMPDUs transmitted on 1160 this interface. Event notifications may be sent in duplicate 1161 to increase the probability of successfully being received, 1162 given the possibility that a frame may be lost in transit. 1163 Duplicate Event Notification transmissions are counted by 1164 dot3OamDuplicateEventNotificationTx. 1166 A unique Event Notification OAMPDU is indicated as an Event 1167 Notification OAMPDU with a Sequence Number field that is 1168 distinct from the previously transmitted Event Notification 1169 OAMPDU Sequence Number. 1171 Discontinuities of this counter can occur at re-initialization 1172 of the management system, and at other times as indicated by 1173 the value of the ifCounterDiscontinuityTime. 1174 " 1175 REFERENCE "[802.3ah], 30.3.6.1.22." 1176 ::= { dot3OamStatsEntry 3 } 1178 dot3OamUniqueEventNotificationRx OBJECT-TYPE 1179 SYNTAX Counter32 1180 UNITS "frames" 1181 MAX-ACCESS read-only 1182 STATUS current 1183 DESCRIPTION 1184 "A count of the number of unique Event OAMPDUs received on 1185 this interface. Event notification OAMPDUs may be sent in 1186 duplicate to increase the probability of successfully being 1187 received, given the possibility that a frame may be lost in 1188 transit. Duplicate Event Notification receptions are counted 1189 by dot3OamDuplicateEventNotificationRx. 1191 A unique Event Notification OAMPDU is indicated as an Event 1192 Notification OAMPDU with a Sequence Number field that is 1193 distinct from the previously received Event Notification 1194 OAMPDU Sequence Number. 1196 Discontinuities of this counter can occur at re-initialization 1197 of the management system, and at other times as indicated by 1198 the value of the ifCounterDiscontinuityTime. 1199 " 1200 REFERENCE "[802.3ah], 30.3.6.1.24." 1201 ::= { dot3OamStatsEntry 4 } 1203 dot3OamDuplicateEventNotificationTx OBJECT-TYPE 1204 SYNTAX Counter32 1205 UNITS "frames" 1206 MAX-ACCESS read-only 1207 STATUS current 1208 DESCRIPTION 1209 "A count of the number of duplicate Event OAMPDUs transmitted 1210 on this interface. Event notification OAMPDUs may be sent in 1211 duplicate to increase the probability of successfully being 1212 received, given the possibility that a frame may be lost in 1213 transit. 1215 A duplicate Event Notification OAMPDU is indicated as an Event 1216 Notification OAMPDU with a Sequence Number field that is 1217 identical to the previously transmitted Event Notification 1218 OAMPDU Sequence Number. 1220 Discontinuities of this counter can occur at re-initialization 1221 of the management system, and at other times as indicated by 1222 the value of the ifCounterDiscontinuityTime. 1223 " 1224 REFERENCE "[802.3ah], 30.3.6.1.23." 1225 ::= { dot3OamStatsEntry 5 } 1227 dot3OamDuplicateEventNotificationRx OBJECT-TYPE 1228 SYNTAX Counter32 1229 UNITS "frames" 1230 MAX-ACCESS read-only 1231 STATUS current 1232 DESCRIPTION 1233 "A count of the number of duplicate Event OAMPDUs received on 1234 this interface. Event notification OAMPDUs may be sent in 1235 duplicate to increase the probability of successfully being 1236 received, given the possibility that a frame may be lost in 1237 transit. 1239 A duplicate Event Notification OAMPDU is indicated as an Event 1240 Notification OAMPDU with a Sequence Number field that is 1241 identical to the previously received Event Notification OAMPDU 1242 Sequence Number. 1244 Discontinuities of this counter can occur at re-initialization 1245 of the management system, and at other times as indicated by 1246 the value of the ifCounterDiscontinuityTime. 1247 " 1248 REFERENCE "[802.3ah], 30.3.6.1.25." 1249 ::= { dot3OamStatsEntry 6 } 1251 dot3OamLoopbackControlTx OBJECT-TYPE 1252 SYNTAX Counter32 1253 UNITS "frames" 1254 MAX-ACCESS read-only 1255 STATUS current 1256 DESCRIPTION 1257 "A count of the number of Loopback Control OAMPDUs transmitted 1258 on this interface. 1260 Discontinuities of this counter can occur at re-initialization 1261 of the management system, and at other times as indicated by 1262 the value of the ifCounterDiscontinuityTime. 1263 " 1264 REFERENCE "[802.3ah], 30.3.6.1.26." 1265 ::= { dot3OamStatsEntry 7 } 1267 dot3OamLoopbackControlRx OBJECT-TYPE 1268 SYNTAX Counter32 1269 UNITS "frames" 1270 MAX-ACCESS read-only 1271 STATUS current 1272 DESCRIPTION 1273 "A count of the number of Loopback Control OAMPDUs received 1274 on this interface. 1276 Discontinuities of this counter can occur at re-initialization 1277 of the management system, and at other times as indicated by 1278 the value of the ifCounterDiscontinuityTime. 1279 " 1280 REFERENCE "[802.3ah], 30.3.6.1.27." 1281 ::= { dot3OamStatsEntry 8 } 1283 dot3OamVariableRequestTx OBJECT-TYPE 1284 SYNTAX Counter32 1285 UNITS "frames" 1286 MAX-ACCESS read-only 1287 STATUS current 1288 DESCRIPTION 1289 "A count of the number of Variable Request OAMPDUs transmitted 1290 on this interface. 1292 Discontinuities of this counter can occur at re-initialization 1293 of the management system, and at other times as indicated by 1294 the value of the ifCounterDiscontinuityTime. 1295 " 1296 REFERENCE "[802.3ah], 30.3.6.1.28." 1297 ::= { dot3OamStatsEntry 9 } 1299 dot3OamVariableRequestRx OBJECT-TYPE 1300 SYNTAX Counter32 1301 UNITS "frames" 1302 MAX-ACCESS read-only 1303 STATUS current 1304 DESCRIPTION 1305 "A count of the number of Variable Request OAMPDUs received on 1306 this interface. 1308 Discontinuities of this counter can occur at re-initialization 1309 of the management system, and at other times as indicated by 1310 the value of the ifCounterDiscontinuityTime. 1311 " 1312 REFERENCE "[802.3ah], 30.3.6.1.29." 1313 ::= { dot3OamStatsEntry 10 } 1315 dot3OamVariableResponseTx OBJECT-TYPE 1316 SYNTAX Counter32 1317 UNITS "frames" 1318 MAX-ACCESS read-only 1319 STATUS current 1320 DESCRIPTION 1321 "A count of the number of Variable Response OAMPDUs 1322 transmitted on this interface. 1324 Discontinuities of this counter can occur at re-initialization 1325 of the management system, and at other times as indicated by 1326 the value of the ifCounterDiscontinuityTime. 1327 " 1328 REFERENCE "[802.3ah], 30.3.6.1.30." 1329 ::= { dot3OamStatsEntry 11 } 1331 dot3OamVariableResponseRx OBJECT-TYPE 1332 SYNTAX Counter32 1333 UNITS "frames" 1334 MAX-ACCESS read-only 1335 STATUS current 1336 DESCRIPTION 1337 "A count of the number of Variable Response OAMPDUs received 1338 on this interface. 1340 Discontinuities of this counter can occur at re-initialization 1341 of the management system, and at other times as indicated by 1342 the value of the ifCounterDiscontinuityTime. 1343 " 1344 REFERENCE "[802.3ah], 30.3.6.1.31." 1345 ::= { dot3OamStatsEntry 12 } 1347 dot3OamOrgSpecificTx OBJECT-TYPE 1348 SYNTAX Counter32 1349 UNITS "frames" 1350 MAX-ACCESS read-only 1351 STATUS current 1352 DESCRIPTION 1353 "A count of the number of Organization Specific OAMPDUs 1354 transmitted on this interface. 1356 Discontinuities of this counter can occur at re-initialization 1357 of the management system, and at other times as indicated by 1358 the value of the ifCounterDiscontinuityTime. 1359 " 1360 REFERENCE "[802.3ah], 30.3.6.1.32." 1361 ::= { dot3OamStatsEntry 13 } 1363 dot3OamOrgSpecificRx OBJECT-TYPE 1364 SYNTAX Counter32 1365 UNITS "frames" 1366 MAX-ACCESS read-only 1367 STATUS current 1368 DESCRIPTION 1369 "A count of the number of Organization Specific OAMPDUs 1370 received on this interface. 1372 Discontinuities of this counter can occur at re-initialization 1373 of the management system, and at other times as indicated by 1374 the value of the ifCounterDiscontinuityTime. 1375 " 1376 REFERENCE "[802.3ah], 30.3.6.1.33." 1377 ::= { dot3OamStatsEntry 14 } 1379 dot3OamUnsupportedCodesTx OBJECT-TYPE 1380 SYNTAX Counter32 1381 UNITS "frames" 1382 MAX-ACCESS read-only 1383 STATUS current 1384 DESCRIPTION 1385 "A count of the number of OAMPDUs transmitted on this 1386 interface with an unsupported op-code. 1388 Discontinuities of this counter can occur at re-initialization 1389 of the management system, and at other times as indicated by 1390 the value of the ifCounterDiscontinuityTime. 1391 " 1392 REFERENCE "[802.3ah], 30.3.6.1.18." 1393 ::= { dot3OamStatsEntry 15 } 1395 dot3OamUnsupportedCodesRx OBJECT-TYPE 1396 SYNTAX Counter32 1397 UNITS "frames" 1398 MAX-ACCESS read-only 1399 STATUS current 1400 DESCRIPTION 1401 "A count of the number of OAMPDUs received on this interface 1402 with an unsupported op-code. 1404 Discontinuities of this counter can occur at re-initialization 1405 of the management system, and at other times as indicated by 1406 the value of the ifCounterDiscontinuityTime. 1407 " 1408 REFERENCE "[802.3ah], 30.3.6.1.19." 1409 ::= { dot3OamStatsEntry 16 } 1411 dot3OamFramesLostDueToOam OBJECT-TYPE 1412 SYNTAX Counter32 1413 UNITS "frames" 1414 MAX-ACCESS read-only 1415 STATUS current 1416 DESCRIPTION 1417 "A count of the number of frames that were dropped by the OAM 1418 multiplexer. Since the OAM multiplexer has multiple inputs 1419 and a single output, there may be cases where frames are 1420 dropped due to transmit resource contention. This counter is 1421 incremented whenever a frame is dropped by the OAM layer. 1422 Note that any Ethernet frame, not just OAMPDUs, may be dropped 1423 by the OAM layer. This can occur when an OAMPDU takes 1424 precedence over a 'normal' frame resulting in the 'normal' 1425 frame being dropped. 1427 When this counter is incremented, no other counters in this 1428 MIB are incremented. 1430 Discontinuities of this counter can occur at re-initialization 1431 of the management system, and at other times as indicated by 1432 the value of the ifCounterDiscontinuityTime. 1433 " 1434 REFERENCE "[802.3ah], 30.3.6.1.46." 1435 ::= { dot3OamStatsEntry 17 } 1437 -- *************************************************************** 1438 -- 1439 -- Ethernet OAM Event Configuration group 1440 -- 1442 dot3OamEventConfigTable OBJECT-TYPE 1443 SYNTAX SEQUENCE OF Dot3OamEventConfigEntry 1444 MAX-ACCESS not-accessible 1445 STATUS current 1446 DESCRIPTION 1447 "Ethernet OAM includes the ability to generate and receive 1448 Event Notification OAMPDUs to indicate various link problems. 1449 This table contains the mechanisms to enable Event 1450 Notifications and configure the thresholds to generate the 1451 standard Ethernet OAM events. There is one entry in the table 1452 for every entry in dot3OamTable that supports OAM events 1453 (where dot3OamFunctionsSupported includes the eventSupport 1454 bit set). The values in the table are maintained across 1455 changes to dot3OamOperStatus. 1457 The standard threshold crossing events are: 1458 - Errored Symbol Period Event. Generated when the number of 1459 symbol errors exceeds a threshold within a given window 1460 defined by a number of symbols (for example, 1,000 symbols 1461 out of 1,000,000 had errors). 1462 - Errored Frame Period Event. Generated when the number of 1463 frame errors exceeds a threshold within a given window 1464 defined by a number of frames (for example, 10 frames out 1465 of 1000 had errors). 1466 - Errored Frame Event. Generated when the number of frame 1467 errors exceeds a threshold within a given window defined 1468 by a period of time (for example, 10 frames in 1 second 1469 had errors). 1470 - Errored Frame Seconds Summary Event. Generated when the 1471 number of errored frame seconds exceeds a threshold within 1472 a given time period (for example, 10 errored frame seconds 1473 within the last 100 seconds). An errored frame second is 1474 defined as a 1 second interval which had >0 frame errors. 1475 There are other events (dying gasp, critical events) that are 1476 not threshold crossing events but which can be 1477 enabled/disabled via this table. 1478 " 1479 ::= { dot3OamObjects 5 } 1481 dot3OamEventConfigEntry OBJECT-TYPE 1482 SYNTAX Dot3OamEventConfigEntry 1483 MAX-ACCESS not-accessible 1484 STATUS current 1485 DESCRIPTION 1486 "Entries are automatically created and deleted from this 1487 table, and exist whenever the OAM entity supports Ethernet OAM 1488 events (as indicated by the eventSupport bit in 1489 dot3OamFunctionsSuppported). Values in the table are 1490 maintained across changes to the value of dot3OamOperStatus. 1492 Event configuration controls when the local management entity 1493 sends Event Notification OAMPDUs to its OAM peer, and when 1494 certain event flags are set or cleared in OAMPDUs. 1495 " 1496 INDEX { ifIndex } 1497 ::= { dot3OamEventConfigTable 1 } 1499 Dot3OamEventConfigEntry ::= 1500 SEQUENCE { 1501 dot3OamErrSymPeriodWindowHi Unsigned32, 1502 dot3OamErrSymPeriodWindowLo Unsigned32, 1503 dot3OamErrSymPeriodThresholdHi Unsigned32, 1504 dot3OamErrSymPeriodThresholdLo Unsigned32, 1505 dot3OamErrSymPeriodEvNotifEnable TruthValue, 1506 dot3OamErrFramePeriodWindow Unsigned32, 1507 dot3OamErrFramePeriodThreshold Unsigned32, 1508 dot3OamErrFramePeriodEvNotifEnable TruthValue, 1509 dot3OamErrFrameWindow Unsigned32, 1510 dot3OamErrFrameThreshold Unsigned32, 1511 dot3OamErrFrameEvNotifEnable TruthValue, 1512 dot3OamErrFrameSecsSummaryWindow Integer32, 1513 dot3OamErrFrameSecsSummaryThreshold Integer32, 1514 dot3OamErrFrameSecsEvNotifEnable TruthValue, 1515 dot3OamDyingGaspEnable TruthValue, 1516 dot3OamCriticalEventEnable TruthValue 1517 } 1519 dot3OamErrSymPeriodWindowHi OBJECT-TYPE 1520 SYNTAX Unsigned32 1521 UNITS "2^32 symbols" 1522 MAX-ACCESS read-write 1523 STATUS current 1524 DESCRIPTION 1525 "The two objects dot3OamErrSymPeriodWindowHi and 1526 dot3OamErrSymPeriodLo together form an unsigned 64-bit 1527 integer representing the number of symbols over which this 1528 threshold event is defined. This is defined as 1530 dot3OamErrSymPeriodWindow = ((2^32)*dot3OamErrSymPeriodWindowHi) 1531 + dot3OamErrSymPeriodWindowLo 1533 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1534 window of dot3OamErrSymPeriodWindow symbols, an Event 1535 Notification OAMPDU should be generated with an Errored Symbol 1536 Period Event TLV indicating the threshold has been crossed in 1537 this window. 1539 The default value for dot3OamErrSymPeriodWindow is the number 1540 of symbols in one second for the underlying physical layer. 1541 " 1542 REFERENCE "[802.3ah], 30.3.6.1.34" 1543 ::= { dot3OamEventConfigEntry 1 } 1545 dot3OamErrSymPeriodWindowLo OBJECT-TYPE 1546 SYNTAX Unsigned32 1547 UNITS "symbols" 1548 MAX-ACCESS read-write 1549 STATUS current 1550 DESCRIPTION 1551 "The two objects dot3OamErrSymPeriodWindowHi and 1552 dot3OamErrSymPeriodWindowLo together form an unsigned 64-bit 1553 integer representing the number of symbols over which this 1554 threshold event is defined. This is defined as 1556 dot3OamErrSymPeriodWindow = ((2^32)*dot3OamErrSymPeriodWindowHi) 1557 + dot3OamErrSymPeriodWindowLo 1559 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1560 window of dot3OamErrSymPeriodWindow symbols, an Event 1561 Notification OAMPDU should be generated with an Errored Symbol 1562 Period Event TLV indicating the threshold has been crossed in 1563 this window. 1565 The default value for dot3OamErrSymPeriodWindow is the number 1566 of symbols in one second for the underlying physical layer. 1567 " 1568 REFERENCE "[802.3ah], 30.3.6.1.34" 1569 ::= { dot3OamEventConfigEntry 2 } 1571 dot3OamErrSymPeriodThresholdHi OBJECT-TYPE 1572 SYNTAX Unsigned32 1573 UNITS "2^32 symbols" 1574 MAX-ACCESS read-write 1575 STATUS current 1576 DESCRIPTION 1577 "The two objects dot3OamErrSymPeriodThresholdHi and 1578 dot3OamErrSymPeriodThresholdLo together form an unsigned 1579 64-bit integer representing the number of symbol errors that 1580 must occur within a given window to cause this event. 1582 This is defined as 1584 dot3OamErrSymPeriodThreshold = 1585 ((2^32) * dot3OamErrSymPeriodThresholdHi) 1586 + dot3OamErrSymPeriodThresholdLo 1588 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1589 window of dot3OamErrSymPeriodWindow symbols, an Event 1590 Notification OAMPDU should be generated with an Errored Symbol 1591 Period Event TLV indicating the threshold has been crossed in 1592 this window. 1594 The default value for dot3OamErrSymPeriodThreshold is one 1595 symbol errors. If the threshold value is zero, then an Event 1596 Notification OAMPDU is sent periodically (at the end of every 1597 window). This can be used as an asynchronous notification to 1598 the peer OAM entity of the statistics related to this 1599 threshold crossing alarm. 1600 " 1601 REFERENCE "[802.3ah], 30.3.6.1.34" 1602 ::= { dot3OamEventConfigEntry 3 } 1604 dot3OamErrSymPeriodThresholdLo OBJECT-TYPE 1605 SYNTAX Unsigned32 1606 UNITS "symbols" 1607 MAX-ACCESS read-write 1608 STATUS current 1609 DESCRIPTION 1610 "The two objects dot3OamErrSymPeriodThresholdHi and 1611 dot3OamErrSymPeriodThresholdLo together form an unsigned 1612 64-bit integer representing the number of symbol errors that 1613 must occur within a given window to cause this event. 1615 This is defined as 1617 dot3OamErrSymPeriodThreshold = 1618 ((2^32) * dot3OamErrSymPeriodThresholdHi) 1619 + dot3OamErrSymPeriodThresholdLo 1621 If dot3OamErrSymPeriodThreshold symbol errors occur within a 1622 window of dot3OamErrSymPeriodWindow symbols, an Event 1623 Notification OAMPDU should be generated with an Errored Symbol 1624 Period Event TLV indicating the threshold has been crossed in 1625 this window. 1627 The default value for dot3OamErrSymPeriodThreshold is one 1628 symbol error. If the threshold value is zero, then an Event 1629 Notification OAMPDU is sent periodically (at the end of every 1630 window). This can be used as an asynchronous notification to 1631 the peer OAM entity of the statistics related to this 1632 threshold crossing alarm. 1633 " 1634 REFERENCE "[802.3ah], 30.3.6.1.34" 1635 ::= { dot3OamEventConfigEntry 4 } 1637 dot3OamErrSymPeriodEvNotifEnable OBJECT-TYPE 1638 SYNTAX TruthValue 1639 MAX-ACCESS read-write 1640 STATUS current 1641 DESCRIPTION 1642 "If true, the OAM entity should send an Event Notification 1643 OAMPDU when an Errored Symbol Period Event occurs. 1645 By default, this object should have the value true for 1646 Ethernet like interfaces that support OAM. If the OAM layer 1647 does not support event notifications (as indicated via the 1648 dot3OamFunctionsSupported attribute), this value is ignored. 1649 " 1650 ::= { dot3OamEventConfigEntry 5 } 1652 dot3OamErrFramePeriodWindow OBJECT-TYPE 1653 SYNTAX Unsigned32 1654 UNITS "frames" 1655 MAX-ACCESS read-write 1656 STATUS current 1657 DESCRIPTION 1658 "The number of frames over which the threshold is defined. 1659 The default value of the window is the number of minimum size 1660 Ethernet frames that can be received over the physical layer 1661 in one second. 1663 If dot3OamErrFramePeriodThreshold frame errors occur within a 1664 window of dot3OamErrFramePeriodWindow frames, an Event 1665 Notification OAMPDU should be generated with an Errored Frame 1666 Period Event TLV indicating the threshold has been crossed in 1667 this window. 1668 " 1669 REFERENCE "[802.3ah], 30.3.6.1.38" 1670 ::= { dot3OamEventConfigEntry 6 } 1672 dot3OamErrFramePeriodThreshold OBJECT-TYPE 1673 SYNTAX Unsigned32 1674 UNITS "frames" 1675 MAX-ACCESS read-write 1676 STATUS current 1677 DESCRIPTION 1678 "The number of frame errors that must occur for this event to 1679 be triggered. The default value is one frame error. If the 1680 threshold value is zero, then an Event Notification OAMPDU is 1681 sent periodically (at the end of every window). This can be 1682 used as an asynchronous notification to the peer OAM entity of 1683 the statistics related to this threshold crossing alarm. 1685 If dot3OamErrFramePeriodThreshold frame errors occur within a 1686 window of dot3OamErrFramePeriodWindow frames, an Event 1687 Notification OAMPDU should be generated with an Errored Frame 1688 Period Event TLV indicating the threshold has been crossed in 1689 this window. 1690 " 1691 REFERENCE "[802.3ah], 30.3.6.1.38" 1692 ::= { dot3OamEventConfigEntry 7 } 1694 dot3OamErrFramePeriodEvNotifEnable OBJECT-TYPE 1695 SYNTAX TruthValue 1696 MAX-ACCESS read-write 1697 STATUS current 1698 DESCRIPTION 1699 "If true, the OAM entity should send an Event Notification 1700 OAMPDU when an Errored Frame Period Event occurs. 1702 By default, this object should have the value true for 1703 Ethernet like interfaces that support OAM. If the OAM layer 1704 does not support event notifications (as indicated via the 1705 dot3OamFunctionsSupported attribute), this value is ignored. 1706 " 1707 ::= { dot3OamEventConfigEntry 8 } 1709 dot3OamErrFrameWindow OBJECT-TYPE 1710 SYNTAX Unsigned32 1711 UNITS "tenths of a second" 1712 MAX-ACCESS read-write 1713 STATUS current 1714 DESCRIPTION 1715 "The amount of time (in 100ms increments) over which the 1716 threshold is defined. The default value is 10 (1 second). 1718 If dot3OamErrFrameThreshold frame errors occur within a window 1719 of dot3OamErrFrameWindow seconds (measured in tenths of 1720 seconds), an Event Notification OAMPDU should be generated 1721 with an Errored Frame Event TLV indicating the threshold has 1722 been crossed in this window. 1723 " 1724 REFERENCE "[802.3ah], 30.3.6.1.36" 1725 ::= { dot3OamEventConfigEntry 9 } 1727 dot3OamErrFrameThreshold OBJECT-TYPE 1728 SYNTAX Unsigned32 1729 UNITS "frames" 1730 MAX-ACCESS read-write 1731 STATUS current 1732 DESCRIPTION 1733 "The number of frame errors that must occur for this event to 1734 be triggered. The default value is one frame error. If the 1735 threshold value is zero, then an Event Notification OAMPDU is 1736 sent periodically (at the end of every window). This can be 1737 used as an asynchronous notification to the peer OAM entity of 1738 the statistics related to this threshold crossing alarm. 1740 If dot3OamErrFrameThreshold frame errors occur within a window 1741 of dot3OamErrFrameWindow (in tenths of seconds), an Event 1742 Notification OAMPDU should be generated with an Errored Frame 1743 Event TLV indicating the threshold has been crossed in this 1744 window. 1745 " 1746 REFERENCE "[802.3ah], 30.3.6.1.36" 1747 ::= { dot3OamEventConfigEntry 10 } 1749 dot3OamErrFrameEvNotifEnable OBJECT-TYPE 1750 SYNTAX TruthValue 1751 MAX-ACCESS read-write 1752 STATUS current 1753 DESCRIPTION 1754 "If true, the OAM entity should send an Event Notification 1755 OAMPDU when an Errored Frame Event occurs. 1757 By default, this object should have the value true for 1758 Ethernet like interfaces that support OAM. If the OAM layer 1759 does not support event notifications (as indicated via the 1760 dot3OamFunctionsSupported attribute), this value is ignored. 1761 " 1762 ::= { dot3OamEventConfigEntry 11 } 1764 dot3OamErrFrameSecsSummaryWindow OBJECT-TYPE 1765 SYNTAX Integer32 (100..9000) 1766 UNITS "tenths of a second" 1767 MAX-ACCESS read-write 1768 STATUS current 1769 DESCRIPTION 1770 "The amount of time (in 100ms intervals) over which the 1771 threshold is defined. The default value is 100 (10 seconds). 1773 If dot3OamErrFrameSecsSummaryThreshold frame errors occur 1774 within a window of dot3OamErrFrameSecsSummaryWindow (in tenths 1775 of seconds), an Event Notification OAMPDU should be generated 1776 with an Errored Frame Seconds Summary Event TLV indicating the 1777 threshold has been crossed in this window. 1778 " 1779 REFERENCE "[802.3ah], 30.3.6.1.40" 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 ::= { dot3OamEventConfigEntry 13 } 1805 dot3OamErrFrameSecsEvNotifEnable OBJECT-TYPE 1806 SYNTAX TruthValue 1807 MAX-ACCESS read-write 1808 STATUS current 1809 DESCRIPTION 1810 "If true, the local OAM entity should send an Event 1811 Notification OAMPDU when an Errored Frame Seconds Event 1812 occurs. 1814 By default, this object should have the value true for 1815 Ethernet like interfaces that support OAM. If the OAM layer 1816 does not support event notifications (as indicated via the 1817 dot3OamFunctionsSupported attribute), this value is ignored. 1818 " 1819 ::= { dot3OamEventConfigEntry 14 } 1821 dot3OamDyingGaspEnable OBJECT-TYPE 1822 SYNTAX TruthValue 1823 MAX-ACCESS read-write 1824 STATUS current 1825 DESCRIPTION 1826 "If true, the local OAM entity should attempt to indicate a 1827 dying gasp via the OAMPDU flags field to its peer OAM entity 1828 when a dying gasp event occurs. The exact definition of a 1829 dying gasp event is implementation dependent. If the system 1830 does not support dying gasp capability, setting this object 1831 has no effect, and reading the object should always result in 1832 'false'. 1834 By default, this object should have the value true for 1835 Ethernet like interfaces that support OAM. If the OAM layer 1836 does not support event notifications (as indicated via the 1837 dot3OamFunctionsSupported attribute), this value is ignored. 1838 " 1840 ::= { dot3OamEventConfigEntry 15 } 1842 dot3OamCriticalEventEnable OBJECT-TYPE 1843 SYNTAX TruthValue 1844 MAX-ACCESS read-write 1845 STATUS current 1846 DESCRIPTION 1847 "If true, the local OAM entity should attempt to indicate a 1848 critical event via the OAMPDU flags to its peer OAM entity 1849 when a critical event occurs. The exact definition of a 1850 critical event is implementation dependent. If the system 1851 does not support critical event capability, setting this 1852 object has no effect, and reading the object should always 1853 result in 'false'. 1855 By default, this object should have the value true for 1856 Ethernet like interfaces that support OAM. If the OAM layer 1857 does not support event notifications (as indicated via the 1858 dot3OamFunctionsSupported attribute), this value is ignored. 1859 " 1860 ::= { dot3OamEventConfigEntry 16 } 1862 -- ************************************************************** 1863 -- 1864 -- Ethernet OAM Event Log group 1865 -- 1867 dot3OamEventLogTable OBJECT-TYPE 1868 SYNTAX SEQUENCE OF Dot3OamEventLogEntry 1869 MAX-ACCESS not-accessible 1870 STATUS current 1871 DESCRIPTION 1872 "This table records a history of the events that have occurred 1873 at the Ethernet OAM level. These events can include locally 1874 detected events, which may result in locally generated 1875 OAMPDUs, and remotely detected events, which are detected by 1876 the OAM peer entity and signaled to the local entity via 1877 Ethernet OAM. Ethernet OAM events can be signaled by Event 1878 Notification OAMPDUs or by the flags field in any OAMPDU. 1880 This table contains both threshold crossing events and 1881 non-threshold crossing events. The parameters for the 1882 threshold window, threshold value, and actual value 1883 (dot3OamEventLogWindowXX, dot3OamEventLogThresholdXX, 1884 dot3OamEventLogValue) are only applicable to threshold 1885 crossing events, and are returned as all F's (2^32 - 1) for 1886 non-threshold crossing events. 1888 Entries in the table are automatically created when such 1889 events are detected. The size of the table is implementation 1890 dependent. When the table reaches its maximum size, older 1891 entries are automatically deleted to make room for newer 1892 entries. 1893 " 1894 ::= { dot3OamObjects 6 } 1896 dot3OamEventLogEntry OBJECT-TYPE 1897 SYNTAX Dot3OamEventLogEntry 1898 MAX-ACCESS not-accessible 1899 STATUS current 1900 DESCRIPTION 1901 "An entry in the dot3OamEventLogTable. Entries are 1902 automatically created whenever Ethernet OAM events occur at 1903 the local OAM entity, and when Event Notification OAMPDUs are 1904 received at the local OAM entity (indicating events have 1905 occurred at the peer OAM entity). The size of the table is 1906 implementation dependent, but when the table becomes full, 1907 older events are automatically deleted to make room for newer 1908 events. The table index dot3OamEventLogIndex increments for 1909 each new entry, and when the maximum value is reached the 1910 value restarts at zero. 1911 " 1912 INDEX { ifIndex, dot3OamEventLogIndex } 1913 ::= { dot3OamEventLogTable 1 } 1915 Dot3OamEventLogEntry ::= 1916 SEQUENCE { 1917 dot3OamEventLogIndex Unsigned32, 1918 dot3OamEventLogTimestamp TimeStamp, 1919 dot3OamEventLogOui Dot3Oui, 1920 dot3OamEventLogType Unsigned32, 1921 dot3OamEventLogLocation INTEGER, 1922 dot3OamEventLogWindowHi Unsigned32, 1923 dot3OamEventLogWindowLo Unsigned32, 1924 dot3OamEventLogThresholdHi Unsigned32, 1925 dot3OamEventLogThresholdLo Unsigned32, 1926 dot3OamEventLogValue CounterBasedGauge64, 1927 dot3OamEventLogRunningTotal CounterBasedGauge64, 1928 dot3OamEventLogEventTotal Unsigned32 1929 } 1931 dot3OamEventLogIndex OBJECT-TYPE 1932 SYNTAX Unsigned32 1933 MAX-ACCESS not-accessible 1934 STATUS current 1935 DESCRIPTION 1936 "An arbitrary integer for identifying individual events 1937 within the event log. " 1938 ::= { dot3OamEventLogEntry 1 } 1940 dot3OamEventLogTimestamp OBJECT-TYPE 1941 SYNTAX TimeStamp 1942 MAX-ACCESS read-only 1943 STATUS current 1944 DESCRIPTION 1945 "The value of sysUpTime at the time of the logged event. For 1946 locally generated events, the time of the event can be 1947 accurately retrieved from sysUpTime. For remotely generated 1948 events, the time of the event is indicated by the reception of 1949 the Event Notification OAMPDU indicating the event occurred on 1950 the peer. A system may attempt to adjust the timestamp value 1951 to more accurately reflect the time of the event at the peer 1952 OAM entity by using other information, such as that found in 1953 the timestamp found of the Event Notification TLVs, which 1954 provides an indication of the relative time between events at 1955 the peer entity. " 1956 ::= { dot3OamEventLogEntry 2 } 1958 dot3OamEventLogOui OBJECT-TYPE 1959 SYNTAX Dot3Oui 1960 MAX-ACCESS read-only 1961 STATUS current 1962 DESCRIPTION 1963 "The OUI of the entity defining the object type. All IEEE 1964 802.3 defined events (as appearing in [802.3ah] except for the 1965 Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of 1966 0x0180C2. Organizations defining their own Event Notification 1967 TLVs include their OUI in the Event Notification TLV which 1968 gets reflected here. " 1969 ::= { dot3OamEventLogEntry 3 } 1971 dot3OamEventLogType OBJECT-TYPE 1972 SYNTAX Unsigned32 1973 MAX-ACCESS read-only 1974 STATUS current 1975 DESCRIPTION 1976 "The type of event that generated this entry in the event log. 1978 When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following 1979 event types are defined: 1980 erroredSymbolEvent(1), 1981 erroredFramePeriodEvent (2), 1982 erroredFrameEvent(3), 1983 erroredFrameSecondsEvent(4), 1984 linkFault(256), 1985 dyingGaspEvent(257), 1986 criticalLinkEvent(258) 1987 The first four are considered threshold crossing events as 1988 they are generated when a metric exceeds a given value within 1989 a specified window. The other three are not threshold 1990 crossing events. 1992 When the OUI is not 71874 (0x0180C2 in hex), then some other 1993 organization has defined the event space. If event subtyping 1994 is known to the implementation, it may be reflected here. 1995 Otherwise, this value should return all Fs (2^32 - 1). 1996 " 1997 REFERENCE "[802.3ah], 30.3.6.1.10 and 57.5.3." 1998 ::= { dot3OamEventLogEntry 4 } 2000 dot3OamEventLogLocation OBJECT-TYPE 2001 SYNTAX INTEGER { local(1), remote(2) } 2002 MAX-ACCESS read-only 2003 STATUS current 2004 DESCRIPTION 2005 "Whether this event occurred locally (local(1)), or was 2006 received from the OAM peer via Ethernet OAM (remote(2)). 2007 " 2008 ::= { dot3OamEventLogEntry 5 } 2010 dot3OamEventLogWindowHi OBJECT-TYPE 2011 SYNTAX Unsigned32 2012 MAX-ACCESS read-only 2013 STATUS current 2014 DESCRIPTION 2015 "If the event represents a threshold crossing event, the two 2016 objects dot3OamEventWindowHi and dot3OamEventWindowLo form an 2017 unsigned 64-bit integer yielding the window over which the 2018 value was measured for the threshold crossing event (for 2019 example, 5, when 11 occurrences happened in 5 seconds while 2020 the threshold was 10). The two objects are combined as: 2022 dot3OamEventLogWindow = ((2^32) * dot3OamEventLogWindowHi) 2023 + dot3OamEventLogWindowLo 2025 Otherwise, this value is returned as all F's (2^32 - 1) and 2026 adds no useful information. 2027 " 2028 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2029 ::= { dot3OamEventLogEntry 6 } 2031 dot3OamEventLogWindowLo OBJECT-TYPE 2032 SYNTAX Unsigned32 2033 MAX-ACCESS read-only 2034 STATUS current 2035 DESCRIPTION 2036 "If the event represents a threshold crossing event, the two 2037 objects dot3OamEventWindowHi and dot3OamEventWindowLo form an 2038 unsigned 64-bit integer yielding the window over which the 2039 value was measured for the threshold crossing event (for 2040 example, 5, when 11 occurrences happened in 5 seconds while 2041 the threshold was 10). The two objects are combined as: 2043 dot3OamEventLogWindow = ((2^32) * dot3OamEventLogWindowHi) 2044 + dot3OamEventLogWindowLo 2046 Otherwise, this value is returned as all F's (2^32 - 1) and 2047 adds no useful information. 2048 " 2049 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2050 ::= { dot3OamEventLogEntry 7 } 2052 dot3OamEventLogThresholdHi OBJECT-TYPE 2053 SYNTAX Unsigned32 2054 MAX-ACCESS read-only 2055 STATUS current 2056 DESCRIPTION 2057 "If the event represents a threshold crossing event, the two 2058 objects dot3OamEventThresholdHi and dot3OamEventThresholdLo 2059 form an unsigned 64-bit integer yielding the value that was 2060 crossed for the threshold crossing event (for example, 10, 2061 when 11 occurrences happened in 5 seconds while the threshold 2062 was 10). The two objects are combined as: 2064 dot3OamEventLogThreshold = ((2^32) * dot3OamEventLogThresholdHi) 2065 + dot3OamEventLogThresholdLo 2067 Otherwise, this value is returned as all F's (2^32 -1) and 2068 adds no useful information. 2069 " 2070 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2071 ::= { dot3OamEventLogEntry 8 } 2073 dot3OamEventLogThresholdLo OBJECT-TYPE 2074 SYNTAX Unsigned32 2075 MAX-ACCESS read-only 2076 STATUS current 2077 DESCRIPTION 2078 "If the event represents a threshold crossing event, the two 2079 objects dot3OamEventThresholdHi and dot3OamEventThresholdLo 2080 form an unsigned 64-bit integer yielding the value that was 2081 crossed for the threshold crossing event (for example, 10, 2082 when 11 occurrences happened in 5 seconds while the threshold 2083 was 10). The two objects are combined as: 2085 dot3OamEventLogThreshold = ((2^32) * dot3OamEventLogThresholdHi) 2086 + dot3OamEventLogThresholdLo 2088 Otherwise, this value is returned as all F's (2^32 - 1) and 2089 adds no useful information. 2090 " 2091 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2092 ::= { dot3OamEventLogEntry 9 } 2094 dot3OamEventLogValue OBJECT-TYPE 2095 SYNTAX CounterBasedGauge64 2096 MAX-ACCESS read-only 2097 STATUS current 2098 DESCRIPTION 2099 "If the event represents a threshold crossing event, this 2100 value indicates the value of the parameter within the given 2101 window that generated this event (for example, 11, when 11 2102 occurrences happened in 5 seconds while the threshold was 10). 2104 Otherwise, this value is returned as all F's 2105 (2^64 - 1) and adds no useful information. 2106 " 2107 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2108 ::= { dot3OamEventLogEntry 10 } 2110 dot3OamEventLogRunningTotal OBJECT-TYPE 2111 SYNTAX CounterBasedGauge64 2112 MAX-ACCESS read-only 2113 STATUS current 2114 DESCRIPTION 2115 "Each Event Notification TLV contains a running total of the 2116 number of times an event has occurred, as well as the number 2117 of times an Event Notification for the event has been 2118 transmitted. For non-threshold crossing events, the number of 2119 events (dot3OamLogRunningTotal) and the number of resultant 2120 Event Notifications (dot3OamLogEventTotal) should be 2121 identical. 2123 For threshold crossing events, since multiple occurrences may 2124 be required to cross the threshold, these values are likely 2125 different. This value represents the total number of times 2126 this event has happened since the last reset (for example, 2127 3253, when 3253 symbol errors have occurred since the last 2128 reset, which has resulted in 51 symbol error threshold 2129 crossing events since the last reset). 2131 " 2132 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2133 ::= { dot3OamEventLogEntry 11 } 2135 dot3OamEventLogEventTotal OBJECT-TYPE 2136 SYNTAX Unsigned32 2137 MAX-ACCESS read-only 2138 STATUS current 2139 DESCRIPTION 2140 "Each Event Notification TLV contains a running total of the 2141 number of times an event has occurred, as well as the number 2142 of times an Event Notification for the event has been 2143 transmitted. For non-threshold crossing events, the number of 2144 events (dot3OamLogRunningTotal) and the number of resultant 2145 Event Notifications (dot3OamLogEventTotal) should be 2146 identical. 2148 For threshold crossing events, since multiple occurrences may 2149 be required to cross the threshold, these values are likely 2150 different. This value represents the total number of times 2151 one or more of these occurrences have resulted in an Event 2152 Notification (for example, 51 when 3253 symbol errors have 2153 occurred since the last reset, which has resulted in 51 symbol 2154 error threshold crossing events since the last reset). 2155 " 2156 REFERENCE "[802.3ah], 30.3.6.1.37 and 57.5.3.2." 2157 ::= { dot3OamEventLogEntry 12 } 2159 -- *************************************************************** 2160 -- 2161 -- Ethernet OAM Notifications 2162 -- 2164 dot3OamThresholdEvent NOTIFICATION-TYPE 2165 OBJECTS { dot3OamEventLogTimestamp, 2166 dot3OamEventLogOui, 2167 dot3OamEventLogType, 2168 dot3OamEventLogLocation, 2169 dot3OamEventLogWindowHi, 2170 dot3OamEventLogWindowLo, 2171 dot3OamEventLogThresholdHi, 2172 dot3OamEventLogThresholdLo, 2173 dot3OamEventLogValue, 2174 dot3OamEventLogRunningTotal, 2175 dot3OamEventLogEventTotal 2176 } 2177 STATUS current 2178 DESCRIPTION 2179 "A dot3OamThresholdEvent notification is sent when a local or 2180 remote threshold crossing event is detected. A local 2181 threshold crossing event is detected by the local entity, 2182 while a remote threshold crossing event is detected by the 2183 reception of an Ethernet OAM Event Notification OAMPDU 2184 indicating a threshold event. 2186 This notification should not be sent more than once per 2187 second. 2189 The OAM entity can be derived from extracting the ifIndex from 2190 the variable bindings. The objects in the notification 2191 correspond to the values in a row instance of in the 2192 dot3OamEventLogTable. 2194 The management entity should periodically check 2195 dot3OamEventLogTable to detect any missed events." 2196 ::= { dot3OamNotifications 1 } 2198 dot3OamNonThresholdEvent NOTIFICATION-TYPE 2199 OBJECTS { dot3OamEventLogTimestamp, 2200 dot3OamEventLogOui, 2201 dot3OamEventLogType, 2202 dot3OamEventLogLocation, 2203 dot3OamEventLogEventTotal 2204 } 2205 STATUS current 2206 DESCRIPTION 2207 "A dot3OamNonThresholdEvent notification is sent when a local 2208 or remote non-threshold crossing event is detected. A local 2209 event is detected by the local entity, while a remote event is 2210 detected by the reception of an Ethernet OAM Event 2211 Notification OAMPDU indicating a non-threshold crossing event. 2213 This notification should not be sent more than once per 2214 second. 2216 The OAM entity can be derived from extracting the ifIndex from 2217 the variable bindings. The objects in the notification 2218 correspond to the values in a row instance of the 2219 dot3OamEventLogTable. 2221 The management entity should periodically check 2222 dot3OamEventLogTable to detect any missed events." 2223 ::= { dot3OamNotifications 2 } 2225 -- *************************************************************** 2226 -- 2227 -- Ethernet OAM Compliance group 2228 -- 2230 dot3OamGroups OBJECT IDENTIFIER ::= { dot3OamConformance 1 } 2231 dot3OamCompliances OBJECT IDENTIFIER ::= { dot3OamConformance 2 } 2233 -- Compliance statements 2235 dot3OamCompliance MODULE-COMPLIANCE 2236 STATUS current 2237 DESCRIPTION "The compliance statement for managed entities 2238 supporting OAM on Ethernet like interfaces. 2239 " 2240 MODULE -- this module 2241 MANDATORY-GROUPS { dot3OamControlGroup, 2242 dot3OamPeerGroup, 2243 dot3OamStatsBaseGroup 2244 } 2246 GROUP dot3OamLoopbackGroup 2247 DESCRIPTION 2248 "This group is mandatory for all IEEE 802.3 OAM 2249 implementations that support loopback functionality. " 2251 GROUP dot3OamErrSymbolPeriodEventGroup 2252 DESCRIPTION 2253 "This group is mandatory for all IEEE 802.3 OAM 2254 implementations that support event functionality. " 2256 GROUP dot3OamErrFramePeriodEventGroup 2257 DESCRIPTION 2258 "This group is mandatory for all IEEE 802.3 OAM 2259 implementations that support event functionality. " 2261 GROUP dot3OamErrFrameEventGroup 2262 DESCRIPTION 2263 "This group is mandatory for all IEEE 802.3 OAM 2264 implementations that support event functionality. " 2266 GROUP dot3OamErrFrameSecsSummaryEventGroup 2267 DESCRIPTION 2268 "This group is mandatory for all IEEE 802.3 OAM 2269 implementations that support event functionality. " 2271 GROUP dot3OamFlagEventGroup 2272 DESCRIPTION 2273 "This group is optional for all IEEE 802.3 OAM 2274 implementations. The ability to send critical events or dying 2275 gasp events is not required in any system." 2277 GROUP dot3OamEventLogGroup 2278 DESCRIPTION 2279 "This group is optional for all IEEE 802.3 OAM 2280 implementations. Entries in this table are dependent on what 2281 event functionality is supported in the local OAM 2282 implementation. At least one type of event must be supported 2283 for entries to appear in this table. " 2285 GROUP dot3OamNotificationGroup 2286 DESCRIPTION 2287 "This group is optional for all IEEE 802.3 OAM 2288 implementations. Since the information in the notifications 2289 is dependent on the dot3OamEventLogTable, that table must be 2290 implemented for notifications. " 2292 ::= { dot3OamCompliances 1} 2294 dot3OamControlGroup OBJECT-GROUP 2295 OBJECTS { dot3OamAdminState, 2296 dot3OamOperStatus, 2297 dot3OamMode, 2298 dot3OamMaxOamPduSize, 2299 dot3OamConfigRevision, 2300 dot3OamFunctionsSupported 2301 } 2302 STATUS current 2303 DESCRIPTION 2304 "A collection of objects providing the abilities, 2305 configuration, and status of an Ethernet OAM entity. " 2306 ::= { dot3OamGroups 1 } 2308 dot3OamPeerGroup OBJECT-GROUP 2309 OBJECTS { dot3OamPeerMacAddress, 2310 dot3OamPeerVendorOui, 2311 dot3OamPeerVendorInfo, 2312 dot3OamPeerMode, 2313 dot3OamPeerFunctionsSupported, 2314 dot3OamPeerMaxOamPduSize, 2315 dot3OamPeerConfigRevision 2316 } 2317 STATUS current 2318 DESCRIPTION 2319 "A collection of objects providing the abilities, 2320 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 receive 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. " 2360 ::= { dot3OamGroups 4 } 2362 dot3OamErrSymbolPeriodEventGroup OBJECT-GROUP 2363 OBJECTS { dot3OamErrSymPeriodWindowHi, 2364 dot3OamErrSymPeriodWindowLo, 2365 dot3OamErrSymPeriodThresholdHi, 2366 dot3OamErrSymPeriodThresholdLo, 2367 dot3OamErrSymPeriodEvNotifEnable 2368 } 2369 STATUS current 2370 DESCRIPTION 2371 "A collection of objects for configuring the thresholds for an 2372 Errored Symbol Period Event. 2374 Each [802.3ah] defined Event Notification TLV has its own 2375 conformance group because each event can be implemented 2376 independently of any other. " 2377 ::= { dot3OamGroups 5 } 2379 dot3OamErrFramePeriodEventGroup OBJECT-GROUP 2380 OBJECTS { dot3OamErrFramePeriodWindow, 2381 dot3OamErrFramePeriodThreshold, 2382 dot3OamErrFramePeriodEvNotifEnable 2383 } 2384 STATUS current 2385 DESCRIPTION 2386 "A collection of objects for configuring the thresholds for an 2387 Errored Frame Period Event. 2389 Each [802.3ah] defined Event Notification TLV has its own 2390 conformance group because each event can be implemented 2391 independently of any other. " 2392 ::= { dot3OamGroups 6 } 2394 dot3OamErrFrameEventGroup OBJECT-GROUP 2395 OBJECTS { dot3OamErrFrameWindow, 2396 dot3OamErrFrameThreshold, 2397 dot3OamErrFrameEvNotifEnable 2398 } 2399 STATUS current 2400 DESCRIPTION 2401 "A collection of objects for configuring the thresholds for an 2402 Errored Frame Event. 2404 Each [802.3ah] defined Event Notification TLV has its own 2405 conformance group because each event can be implemented 2406 independently of any other. " 2407 ::= { dot3OamGroups 7 } 2409 dot3OamErrFrameSecsSummaryEventGroup OBJECT-GROUP 2410 OBJECTS { dot3OamErrFrameSecsSummaryWindow, 2411 dot3OamErrFrameSecsSummaryThreshold, 2412 dot3OamErrFrameSecsEvNotifEnable 2413 } 2414 STATUS current 2415 DESCRIPTION 2416 "A collection of objects for configuring the thresholds for an 2417 Errored Frame Seconds Summary Event. 2419 Each [802.3ah] defined Event Notification TLV has its own 2420 conformance group because each event can be implemented 2421 independently of any other. " 2422 ::= { dot3OamGroups 8 } 2424 dot3OamFlagEventGroup OBJECT-GROUP 2425 OBJECTS { dot3OamDyingGaspEnable, 2426 dot3OamCriticalEventEnable 2427 } 2428 STATUS current 2429 DESCRIPTION 2430 "A collection of objects for configuring the sending OAMPDUs 2431 with the critical event flag or dying gasp flag enabled. " 2432 ::= { dot3OamGroups 9 } 2434 dot3OamEventLogGroup OBJECT-GROUP 2435 OBJECTS { dot3OamEventLogTimestamp, 2436 dot3OamEventLogOui, 2437 dot3OamEventLogType, 2438 dot3OamEventLogLocation, 2439 dot3OamEventLogWindowHi, 2440 dot3OamEventLogWindowLo, 2441 dot3OamEventLogThresholdHi, 2442 dot3OamEventLogThresholdLo, 2443 dot3OamEventLogValue, 2444 dot3OamEventLogRunningTotal, 2445 dot3OamEventLogEventTotal 2446 } 2447 STATUS current 2448 DESCRIPTION 2449 "A collection of objects for configuring the thresholds for an 2450 Errored Frame Seconds Summary Event and maintaining the event 2451 information. " 2452 ::= { dot3OamGroups 10 } 2454 dot3OamNotificationGroup NOTIFICATION-GROUP 2455 NOTIFICATIONS { 2456 dot3OamThresholdEvent, 2457 dot3OamNonThresholdEvent 2458 } 2459 STATUS current 2460 DESCRIPTION 2461 "A collection of notifications used by Ethernet OAM to signal 2462 to a management entity that local or remote events have 2463 occurred 2464 on a specified Ethernet link. " 2465 ::= { dot3OamGroups 11 } 2467 END 2469 7. 2470 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 authorization mechanisms. It should be used in environments where 2478 either this interface information is not considered sensitive, or 2479 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 obtainable via OAM events is also available via 2524 OAM Variable Requests. Access to this information via either OAM 2525 events or Variable Requests is controlled by the dot3OamAdminState 2526 and dot3OamMode objects. As mentioned previously, inadequate 2527 protection of these variables can result in access to link 2528 information and 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. 2550 IANA Considerations 2552 The Ethernet OAM MIB requires the allocation of a single object 2553 identifier for its MODULE-IDENTITY under the MIB-2 tree. 2555 The MIB module in this document uses the following IANA-assigned 2556 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 2558 Descriptor OBJECT IDENTIFIER 2559 ---------- ----------------- 2560 dot3OamMIB { mib-2 XXX } 2562 Editor's Note (to be removed prior to publication): the IANA is 2563 requested to assign a value for "XXX" under the 'mib-2' subtree and 2564 to record the assignment in the SMI Numbers registry. When the 2565 assignment has been made, the RFC Editor is asked to replace "XXX" 2566 (here and in the MIB module) with the assigned value and to remove 2567 this note. 2569 9. 2570 References 2572 9.1 2573 Normative References 2575 [802.3ah] Institute of Electrical and Electronic Engineers, IEEE Std 2576 802.3ah-2004, "Part 3: Carrier Sense Multiple Access with Collision 2577 Detection (CSMA/CD) Access Method and Physical Layer Specifications - 2578 Amendment: Media Access Control Parameters, Physical Layers and 2579 Management Parameters for Subscriber Access Networks", October 2004. 2581 [802.3-2002] Institute of Electrical and Electronic Engineers, IEEE 2582 Std 802.3-2003, "IEEE Standard for Carrier Sense Multiple Access with 2583 Collision Detection (CSMA/CD) Access Method and Physical Layer 2584 Specifications - Draft amendment to - Information technology - 2585 Telecommunications and information exchange between systems - Local 2586 and metropolitan area networks - Specific requirements - Part 3: 2587 Carrier sense multiple access with collision detection (CSMA/CD) 2588 access method and physical layer specifications - Media Access 2589 Control Parameters, Physical Layers and Management Parameters", March 2590 2002. 2592 [802.3-2005] Institute of Electrical and Electronic Engineers, IEEE 2593 Std 802.3-2005, "IEEE Standard for Carrier Sense Multiple Access with 2594 Collision Detection (CSMA/CD) Access Method and Physical Layer 2595 Specifications - Draft amendment to - Information technology - 2596 Telecommunications and information exchange between systems - Local 2597 and metropolitan area networks - Specific requirements - Part 3: 2598 Carrier sense multiple access with collision detection (CSMA/CD) 2599 access method and physical layer specifications - Media Access 2600 Control Parameters, Physical Layers and Management Parameters", 2601 December 2005. 2603 [802-2001] Institute of Electrical and Electronic Engineers, IEEE 2604 Std 802-2001, "Standard for Local and Metropolitan Area Networks: 2605 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 Management 2612 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. 2614 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 2615 McCloghrie, K., Rose, M. and S. Waldbusser, "Textual Conventions for 2616 SMIv2", STD 58, RFC 2579, April 1999. 2618 [RFC2580] McCloghrie, K., Perkins, D. and J. Schoenwaelder, 2619 "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. 2621 [RFC2586] Bierman, A., McCloghrie, K., Presuhn, R., "Textual 2622 Conventions for Additional High Capacity Data Types", RFC 2856, June 2623 2000. 2625 [RFC2863] McCloghrie, K., Kastenholz, F., "The Interfaces Group 2626 MIB", RFC 2863, June 2000. 2628 9.2 2629 Informative References 2631 [802.3ah-copper] Beili, Ed, "Ethernet in the First Mile Copper 2632 (EFMCu) Interfaces MIB", draft-ietf-hubmib-efm-cu-05.txt, March 2006. 2634 [802.3ah-epon] Khermosh, Lior, "Managed Object of EPON", draft-ietf- 2635 hubmib-efm-epon-mib-04.txt, February 2006. 2637 [RFC3410] Case, J., Mundy, R., Partain, D., Stewart, B., 2638 "Introduction and Applicability Statements for Internet Standard 2639 Management Framework", RFC 3410, December 2003. 2641 [RFC3635] Flick, J., "Definitions of Managed Objects for the 2642 Ethernet like Interface Types", RFC 3635, September 2003. 2644 [RFC3636] Flick, J., "Definitions of Managed Objects for IEEE 802.3 2645 Medium Attachment Units (MAUs)", RFC 3636, September 2003. 2647 10. 2648 Acknowledgments 2650 The author is grateful to all of the participants in the IEEE 802.3ah 2651 EFM (Ethernet in the First Mile) taskforce. In particular, the 2652 strong leadership and dedication of the following individuals is 2653 noted: 2655 Kevin Daines (Editor, IEEE 802.3ah OAM clauses) 2656 Ben Brown (Editor, IEEE 802.3ah Logic clauses) 2657 David Law (Editor, IEEE 802.3ah Management clauses) 2658 Scott Simon (Editor, IEEE 802.3ah Clause 45) 2659 Howard Frazier (Chair, IEEE 802.3ah) 2660 Hugh Barass (Vice-Chair, IEEE 802.3ah) 2661 Wael Diab (Editor, IEEE 802.3ah) 2663 Additionally, certain devoted attendees and contributors to the IEEE 2664 802.3ah OAM sub-taskforce deserve recognition. Although there were 2665 many contributors, the following individuals contributed heavily over 2666 a long period of time. 2668 Brian Arnold 2669 Brad Booth 2670 Al Braga 2671 Floyd Gerhardt 2672 Bob Grow 2673 Eric Lynskey 2674 David Martin 2675 John Messenger 2676 Dan Romascanu (Chair, IETF HUBMIB WG) 2677 Jonathan Thatcher 2678 Geoff Thompson 2680 11. 2681 Author's Address 2683 Note: Author's email address is spelled out to help protect against 2684 email address harvesting programs. 2686 Matt Squire 2687 Hatteras Networks 2688 639 Davis Drive, Suite 200 2689 Phone: +1-919-991-5460 2690 Email: msquire at hatterasnetworks dot com 2692 12. 2693 Intellectual Property Statement 2695 The IETF takes no position regarding the validity or scope of any 2696 Intellectual Property Rights or other rights that might be claimed to 2697 pertain to the implementation or use of the technology described in 2698 this document or the extent to which any license under such rights 2699 might or might not be available; nor does it represent that it has 2700 made any independent effort to identify any such rights. Information 2701 on the procedures with respect to rights in RFC documents can be 2702 found in BCP 78 and BCP 79. 2704 Copies of IPR disclosures made to the IETF Secretariat and any 2705 assurances of licenses to be made available, or the result of an 2706 attempt made to obtain a general license or permission for the use of 2707 such proprietary rights by implementers or users of this 2708 specification can be obtained from the IETF on-line IPR repository at 2709 http://www.ietf.org/ipr. 2711 The IETF invites any interested party to bring to its attention any 2712 copyrights, patents or patent applications, or other proprietary 2713 rights that may cover technology that may be required to implement 2714 this standard. Please address the information to the IETF at 2715 ietf-ipr@ietf.org. 2717 The IETF has been notified of intellectual property rights claimed in 2718 regard to some or all of the specification contained in this 2719 document. For more information consult the online list of claimed 2720 rights. 2722 13. 2723 Copyright Statement 2725 Copyright (C) The Internet Society (2006). 2727 This document is subject to the rights, licenses and restrictions 2728 contained in BCP 78, and except as set forth therein, the authors 2729 retain all their rights. 2731 This document and the information contained herein are provided 2732 on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE 2733 REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND 2734 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, 2735 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT 2736 THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR 2737 ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A 2738 PARTICULAR PURPOSE. 2740 Acknowledgement 2742 Funding for the RFC Editor function is currently provided by the 2743 Internet Society.