1
2-- *****************************************************************
3-- Descriptions of managed objects for CISCO IEEE 802.3ah OAM MIB.
4--
5-- December 2006, Bibek Das
6--
7-- Copyright (c) 2006-2007 by cisco Systems, Inc.
8-- All rights reserved.
9-- *****************************************************************
10--
11-- CISCO-DOT3-OAM-MIB
12--
13-- This mib is based on draft-ietf-hubmib-efm-mib-04.txt.
14-- In the future, this mib may be removed entirely, or re-implemented
15-- on short notice in favor of more standard or generic MIBs.
16-- Application developers should not depend on long-term access to
17-- this MIB.
18-- The intent is to eventually update to DOT3-OAM-MIB,
19-- once the final approved version of
20-- draft-ietf-hubmib-efm-mib-04.txt is available,
21-- and remove this CISCO-DOT3-OAM-MIB in its entirety.
22
23CISCO-DOT3-OAM-MIB DEFINITIONS ::= BEGIN
24
25IMPORTS
26    MODULE-IDENTITY,  OBJECT-TYPE, Counter32, Unsigned32,
27      Integer32, NOTIFICATION-TYPE
28      FROM SNMPv2-SMI
29    TEXTUAL-CONVENTION, MacAddress, TimeStamp, TruthValue
30      FROM SNMPv2-TC
31    CounterBasedGauge64
32      FROM HCNUM-TC
33    ifIndex
34      FROM IF-MIB
35    ciscoExperiment
36                FROM CISCO-SMI
37    MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
38      FROM SNMPv2-CONF;
39
40
41    cdot3OamMIB MODULE-IDENTITY
42      LAST-UPDATED "200605310000Z"  -- 31 May 2006 12:00:00 EST
43      ORGANIZATION "Cisco Systems, Inc"
44      CONTACT-INFO
45          "        Cisco Systems
46                   Customer Service
47
48           Postal: 170 W Tasman Drive
49                   San Jose, CA 95134
50                   USA
51
52           Tel:    +1 800 553-NETS
53           Email:  cs-ethermibs@cisco.com"
54DESCRIPTION
55    "The MIB module for managing the new Ethernet OAM features
56    introduced by the Ethernet in the First Mile task force (IEEE
57    802.3ah).  The functionality presented here is based on IEEE
58    802.3ah [802.3ah], released in October, 2004.  [802.3ah] was
59    prepared as an addendum to the standing version of IEEE 802.3
60    [802.3-2002] at the time.  Since then, [802.3ah] has been
61    merged into the base IEEE 802.3 specification in [802.3-2005].
62
63    In particular, this MIB focuses on the new OAM functions
64    introduced in Clause 57 of [802.3ah].  The OAM functionality
65    of Clause 57 is controlled by new management attributes
66    introduced in Clause 30 of [802.3ah].  The OAM functions are
67    not specific to any particular Ethernet physical layer, and
68    can be generically applied to any Ethernet interface of
69    [802.3-2002].
70
71    An Ethernet OAM protocol data unit is a valid Ethernet frame
72    with a destination MAC address equal to the reserved MAC
73    address for Slow Protocols (See 43B of [802.3ah]), a
74    lengthOrType field equal to the reserved type for Slow
75    Protocols, and a Slow Protocols subtype equal to that of the
76    subtype reserved for Ethernet OAM.  OAMPDU is used throughout
77    this document as an abbreviation for Ethernet OAM protocol
78    data unit.
79
80    The following reference is used throughout this MIB module:
81
82      [802.3ah] refers to:
83        IEEE Std 802.3ah-2004: 'Draft amendment to -
84        Information technology - Telecommunications and
85        information exchange between systems - Local and
86        metropolitan are networks - Specific requirements - Part
87        3: Carrier sense multiple access with collision detection
88        (CSMA/CD) access method and physical layer specifications
89        - Media Access Control Parameters, Physical Layers and
90        Management Parameters for subscriber access networks',
91        October 2004.
92
93      [802.3-2002] refers to:
94        IEEE Std 802.3-2002:
95        'Information technology - Telecommunications and
96        information exchange between systems - Local and
97        metropolitan are networks - Specific requirements - Part
98        3: Carrier sense multiple access with collision detection
99        (CSMA/CD) access method and physical layer specifications
100        - Media Access Control Parameters, Physical Layers and
101        Management Parameters for subscriber access networks',
102        March 2002.
103
104      [802.3-2005] refers to:
105        IEEE Std 802.3-2002:
106        'Information technology - Telecommunications and
107        information exchange between systems - Local and
108        metropolitan are networks - Specific requirements - Part
109        3: Carrier sense multiple access with collision detection
110        (CSMA/CD) access method and physical layer specifications
111        - Media Access Control Parameters, Physical Layers and
112        Management Parameters for subscriber access networks',
113        December 2005.
114
115      [802-2001] refers to:
116        'IEEE Standard for LAN/MAN (Local Area
117        Network/Metropolitan Area Network): Overview and
118        Architecture', IEEE 802, June 2001."
119
120
121        REVISION    "200605310000Z"  -- 31 May 2006 12:00:00 EST
122        DESCRIPTION "Initial version."
123        ::= { ciscoExperiment 136 }
124
125-- Sections of the Ethernet OAM MIB
126
127cdot3OamNotifications OBJECT IDENTIFIER ::= { cdot3OamMIB 0 }
128cdot3OamObjects       OBJECT IDENTIFIER ::= { cdot3OamMIB 1 }
129cdot3OamConformance   OBJECT IDENTIFIER ::= { cdot3OamMIB 2 }
130
131--
132-- Textual conventions for OAM MIB
133--
134Cdot3Oui ::= TEXTUAL-CONVENTION
135  STATUS       current
136  DESCRIPTION
137    "24-bit Organizationally Unique Identifier.  Information on
138    OUIs can be found in IEEE 802-2001 [802-2001] Clause 9."
139  SYNTAX       OCTET STRING(SIZE(3))
140
141
142-- ***************************************************************
143--
144-- Ethernet OAM Control group
145--
146
147
148cdot3OamTable OBJECT-TYPE
149  SYNTAX      SEQUENCE OF Cdot3OamEntry
150  MAX-ACCESS  not-accessible
151  STATUS      current
152  DESCRIPTION
153    "This table contains the primary controls and status for the
154    OAM capabilities of an Ethernet like interface.  There will be
155    one row in this table for each Ethernet like interface in the
156    system that supports the OAM functions defined in [802.3ah].
157    "
158  ::= { cdot3OamObjects 1 }
159
160cdot3OamEntry OBJECT-TYPE
161  SYNTAX     Cdot3OamEntry
162  MAX-ACCESS not-accessible
163  STATUS     current
164  DESCRIPTION
165    "An entry in the table, containing information on the Ethernet
166    OAM function for a single Ethernet like interface. Entries in
167    the table are created automatically for each interface
168    supporting Ethernet OAM. The status of the row entry can be
169    determined from cdot3OamOperStatus.
170
171    A cdot3OamEntry is indexed in the cdot3OamTable by the ifIndex
172    object of the Interfaces MIB.
173    "
174  INDEX       { ifIndex }
175  ::= { cdot3OamTable 1 }
176
177Cdot3OamEntry ::=
178  SEQUENCE {
179    cdot3OamAdminState                  INTEGER,
180    cdot3OamOperStatus                  INTEGER,
181    cdot3OamMode                        INTEGER,
182    cdot3OamMaxOamPduSize               Unsigned32,
183    cdot3OamConfigRevision              Unsigned32,
184    cdot3OamFunctionsSupported          BITS
185  }
186
187
188cdot3OamAdminState OBJECT-TYPE
189  SYNTAX      INTEGER {
190                disabled(1),
191                enabled(2)
192              }
193  MAX-ACCESS  read-write
194  STATUS      current
195  DESCRIPTION
196    "This object is used to provision the default administrative
197    OAM mode for this interface.  This object represents the
198    desired state of OAM for this interface.
199
200    The cdot3OamAdminState always starts in the disabled(1) state
201    until an explicit management action or configuration
202    information retained by the system causes a transition to the
203    enabled(2) state.   When enabled(2), Ethernet OAM will attempt
204    to operate over this interface.
205    "
206  REFERENCE   "[802.3ah], 30.3.6.1.2"
207  ::= { cdot3OamEntry 1 }
208
209cdot3OamOperStatus OBJECT-TYPE
210  SYNTAX      INTEGER {
211                disabled(1),
212                linkFault(2),
213                passiveWait(3),
214                activeSendLocal(4),
215                sendLocalAndRemote(5),
216                sendLocalAndRemoteOk(6),
217                oamPeeringLocallyRejected(7),
218                oamPeeringRemotelyRejected(8),
219                operational(9),
220                nonOperHalfDuplex(10)
221              }
222  MAX-ACCESS  read-only
223  STATUS      current
224  DESCRIPTION
225    "At initialization and failure conditions, two OAM entities on
226    the same full-duplex Ethernet link begin a discovery phase to
227    determine what OAM capabilities may be used on that link.  The
228    progress of this initialization is controlled by the OAM
229    sublayer.
230
231    This value is always disabled(1) if OAM is disabled on this
232    interface via the cdot3OamAdminState.
233
234    If the link has detected a fault and is transmitting OAMPDUs
235    with a link fault indication, the value is linkFault(2). Also,
236    if the interface is not operational (ifOperStatus is not
237    up(1)), linkFault(2) is returned.  Note that the object
238    ifOperStatus may not be up(1) as a result of link failure or
239    administrative action (ifAdminState being down(2) or
240    testing(3)).
241
242    The passiveWait(3) state is returned only by OAM entities in
243    passive mode (cdot3OamMode) and reflects the state in which the
244    OAM entity is waiting to see if the peer device is OAM
245    capable.  The activeSendLocal(4) value is used by active mode
246    devices (cdot3OamMode) and reflects the OAM entity actively
247    trying to discover whether the peer has OAM capability but has
248    not yet made that determination.
249
250    The state sendLocalAndRemote(5) reflects that the local OAM
251    entity has discovered the peer but has not yet accepted or
252    rejected the configuration of the peer.  The local device can,
253    for whatever reason, decide that the peer device is
254    unacceptable and decline OAM peering.  If the local OAM entity
255    rejects the peer OAM entity, the state becomes
256    oamPeeringLocallyRejected(7).  If the OAM peering is allowed
257    by the local device, the state moves to
258    sendLocalAndRemoteOk(6).  Note that both the
259    sendLocalAndRemote(5) and oamPeeringLocallyRejected(7) states
260    fall within the state SEND_LOCAL_REMOTE of the Discovery state
261    diagram [802.3ah, Figure 57-5], with the difference being
262    whether the local OAM client has actively rejected the peering
263    or has just not indicated any decision yet.  Whether a peering
264    decision has been made is indicated via the local flags field
265    in the OAMPDU (reflected in the aOAMLocalFlagsField of
266    30.3.6.1.10).
267
268    If the remote OAM entity rejects the peering, the state
269    becomes oamPeeringRemotelyRejected(8).  Note that both the
270    sendLocalAndRemoteOk(6) and oamPeeringRemotelyRejected(8)
271    states fall within the state SEND_LOCAL_REMOTE_OK of the
272    Discovery state diagram [802.3ah, Figure 57-5], with the
273    difference being whether the remote OAM client has rejected
274    the peering or has just not yet decided.  This is indicated
275    via the remote flags field in the OAM PDU (reflected in the
276    aOAMRemoteFlagsField of 30.3.6.1.11).
277
278    When the local OAM entity learns that both it and the remote
279    OAM entity have accepted the peering, the state moves to
280    operational(9) corresponding to the SEND_ANY state of the
281    Discovery state diagram [802.3ah, Figure 57-5].
282
283    Since Ethernet OAM functions are not designed to work
284    completely over half-duplex interfaces, the value
285    nonOperHalfDuplex(10) is returned whenever Ethernet OAM is
286    enabled (cdot3OamAdminState is enabled(1)) but the interface is
287    in half-duplex operation.
288    "
289  REFERENCE   "[802.3ah], 30.3.6.1.4, 30.3.6.1.10, 30.3.6.1.11"
290  ::= { cdot3OamEntry 2 }
291
292cdot3OamMode OBJECT-TYPE
293  SYNTAX      INTEGER {
294                active(1),
295                passive(2)
296              }
297  MAX-ACCESS  read-write
298  STATUS      current
299  DESCRIPTION
300    "This object configures the mode of OAM operation for this
301    Ethernet like interface.  OAM on Ethernet interfaces may be in
302    'active' mode or 'passive' mode.  These two modes differ in
303    that active mode provides additional capabilities to initiate
304    monitoring activities with the remote OAM peer entity, while
305    passive mode generally waits for the peer to initiate OAM
306    actions with it.  As an example, an active OAM entity can put
307    the remote OAM entity in a loopback state, where a passive OAM
308    entity cannot.
309
310    The default value of cdot3OamMode is dependent on the type of
311    system on which this Ethernet like interface resides.  The
312    default value should be 'active(1)' unless it is known that
313    this system should take on a subservient role to the other
314    device connected over this interface.
315
316    Changing this value results in incrementing the configuration
317    revision field of locally generated OAMPDUs (30.3.6.1.12) and
318    potentially re-doing the OAM discovery process if the
319    cdot3OamOperStatus was already operational(9).
320    "
321  REFERENCE   "[802.3ah], 30.3.6.1.3"
322  ::= { cdot3OamEntry 3 }
323
324cdot3OamMaxOamPduSize OBJECT-TYPE
325  SYNTAX      Unsigned32 (64..1518)
326  UNITS       "octets"
327  MAX-ACCESS  read-only
328  STATUS      current
329  DESCRIPTION
330    "The largest OAMPDU that the OAM entity supports.  OAM
331    entities exchange maximum OAMPDU sizes and negotiate to use
332    the smaller of the two maximum OAMPDU sizes between the peers.
333    This value is determined by the local implementation.
334    "
335  REFERENCE   "[802.3ah], 30.3.6.1.8"
336  ::= { cdot3OamEntry 4 }
337
338cdot3OamConfigRevision OBJECT-TYPE
339  SYNTAX      Unsigned32(0..65535)
340  MAX-ACCESS  read-only
341  STATUS      current
342  DESCRIPTION
343    "The configuration revision of the OAM entity as reflected in
344    the latest OAMPDU sent by the OAM entity.  The config revision
345    is used by OAM entities to indicate configuration changes have
346    occurred which might require the peer OAM entity to
347    re-evaluate whether OAM peering is allowed.
348    "
349  REFERENCE   "[802.3ah], 30.3.6.1.12"
350  ::= { cdot3OamEntry 5 }
351
352cdot3OamFunctionsSupported OBJECT-TYPE
353  SYNTAX      BITS {
354                unidirectionalSupport (0),
355                loopbackSupport(1),
356                eventSupport(2),
357                variableSupport(3)
358              }
359  MAX-ACCESS  read-only
360  STATUS      current
361  DESCRIPTION
362    "The OAM functions supported on this Ethernet like interface.
363    OAM consists of separate functional sets beyond the basic
364    discovery process which is always required.  These functional
365    groups can be supported independently by any implementation.
366    These values are communicated to the peer via the local
367    configuration field of Information OAMPDUs.
368
369    Setting 'unidirectionalSupport(0)' indicates that the OAM
370    entity supports the transmission of OAMPDUs on links that are
371    operating in unidirectional mode (traffic flowing in one
372    direction only).  Setting 'loopbackSupport(1)' indicates the
373    OAM entity can initiate and respond to loopback commands.
374    Setting 'eventSupport(2)' indicates the OAM entity can send
375    and receive Event Notification OAMPDUs. Setting
376    'variableSupport(3)' indicates the OAM entity can send and
377    receive Variable Request and Response OAMPDUs.
378    "
379  REFERENCE   "[802.3ah], 30.3.6.1.6"
380  ::= { cdot3OamEntry 6 }
381
382
383-- ***************************************************************
384--
385-- Ethernet OAM Peer group
386--
387
388
389cdot3OamPeerTable OBJECT-TYPE
390  SYNTAX      SEQUENCE OF Cdot3OamPeerEntry
391  MAX-ACCESS  not-accessible
392  STATUS      current
393  DESCRIPTION
394    "This table contains information about the OAM peer for a
395    particular Ethernet like interface. OAM entities communicate
396    with a single OAM peer entity on Ethernet links on which OAM
397    is enabled and operating properly.  There is one entry in this
398    table for each entry in the cdot3OamTable for which information
399    on the peer OAM entity is available.
400    "
401  ::= { cdot3OamObjects 2 }
402
403cdot3OamPeerEntry OBJECT-TYPE
404  SYNTAX      Cdot3OamPeerEntry
405  MAX-ACCESS  not-accessible
406  STATUS      current
407  DESCRIPTION
408    "An entry in the table, containing information on the peer OAM
409    entity for a single Ethernet like interface.
410
411    Note that there is at most one OAM peer for each Ethernet like
412    interface.  Entries are automatically created when information
413    about the OAM peer entity becomes available, and automatically
414    deleted when the OAM peer entity is no longer in
415    communication.  Peer information is not available when
416    cdot3OamOperStatus is disabled(1), linkFault(2),
417    passiveWait(3), activeSendLocal(4). or nonOperHalfDuplex(10)).
418    "
419  INDEX       { ifIndex }
420  ::= { cdot3OamPeerTable 1 }
421
422
423Cdot3OamPeerEntry ::=
424  SEQUENCE {
425    cdot3OamPeerMacAddress               MacAddress,
426    cdot3OamPeerVendorOui                Cdot3Oui,
427    cdot3OamPeerVendorInfo               Unsigned32,
428    cdot3OamPeerMode                     INTEGER,
429    cdot3OamPeerMaxOamPduSize            Unsigned32,
430    cdot3OamPeerConfigRevision           Unsigned32,
431    cdot3OamPeerFunctionsSupported       BITS
432  }
433
434
435cdot3OamPeerMacAddress OBJECT-TYPE
436  SYNTAX      MacAddress
437  MAX-ACCESS  read-only
438  STATUS      current
439  DESCRIPTION
440    "The MAC address of the peer OAM entity.  The MAC address is
441    derived from the most recently received OAMPDU.
442    "
443  REFERENCE   "[802.3ah], 30.3.6.1.5."
444  ::= { cdot3OamPeerEntry 1 }
445
446
447cdot3OamPeerVendorOui OBJECT-TYPE
448  SYNTAX      Cdot3Oui
449  MAX-ACCESS  read-only
450  STATUS      current
451  DESCRIPTION
452    "The OUI of the OAM peer as reflected in the latest
453    Information OAMPDU received with a Local Information TLV.  The
454    OUI can be used to identify the vendor of the remote OAM
455    entity.  This value is initialized to zero before any Local
456    Information TLV is received.
457    "
458  REFERENCE   "[802.3ah], 30.3.6.1.16."
459  ::= { cdot3OamPeerEntry 2 }
460
461
462cdot3OamPeerVendorInfo OBJECT-TYPE
463  SYNTAX      Unsigned32
464  MAX-ACCESS  read-only
465  STATUS      current
466  DESCRIPTION
467    "The Vendor Info of the OAM peer as reflected in the latest
468    Information OAMPDU received with a Local Information TLV.  The
469    vendor information field is within the Local Information TLV,
470    and can be used to determine additional information about the
471    peer entity.  The format of the vendor information is
472    unspecified within the 32-bit field.  This value is
473    initialized to zero before any Local Information TLV is
474    received.
475    "
476  REFERENCE   "[802.3ah], 30.3.6.1.17."
477  ::= { cdot3OamPeerEntry 3 }
478
479
480cdot3OamPeerMode OBJECT-TYPE
481  SYNTAX      INTEGER {
482                active(1),
483                passive(2),
484                unknown(3)
485              }
486  MAX-ACCESS  read-only
487  STATUS      current
488  DESCRIPTION
489    "The mode of the OAM peer as reflected in the latest
490    Information OAMPDU received with a Local Information TLV.  The
491    mode of the peer can be determined from the Configuration
492    field in the Local Information TLV of the last Information
493    OAMPDU received from the peer.  The value is unknown(3)
494    whenever no Local Information TLV has been received.  The
495    values of active(1) and passive(2) are returned when a Local
496    Information TLV has been received indicating the peer is in
497    active or passive mode, respectively.
498    "
499  REFERENCE   "[802.3ah], 30.3.6.1.7."
500  ::= { cdot3OamPeerEntry 4 }
501
502cdot3OamPeerMaxOamPduSize OBJECT-TYPE
503  SYNTAX      Unsigned32 (0..1518)
504  UNITS       "octets"
505  MAX-ACCESS  read-only
506  STATUS      current
507  DESCRIPTION
508    "The maximum size of OAMPDU supported by the peer as reflected
509    in the latest Information OAMPDU received with a Local
510    Information TLV.   Ethernet OAM on this interface must not use
511    OAMPDUs that exceed this size.  The maximum OAMPDU size can be
512    determined from the PDU Configuration field of the Local
513    Information TLV of the last Information OAMPDU received from
514    the peer.  A value of zero is returned if no Local Information
515    TLV has been received.  Otherwise, the value of the OAM peer's
516    maximum OAMPDU size is returned in this value.
517    Note that the values 1..63 are invalid sizes for Ethernet
518    frames and should never appear.
519    "
520  REFERENCE   "[802.3ah], 30.3.6.1.9."
521  ::= { cdot3OamPeerEntry 5 }
522
523
524cdot3OamPeerConfigRevision OBJECT-TYPE
525  SYNTAX      Unsigned32(0..65535)
526  MAX-ACCESS  read-only
527  STATUS      current
528  DESCRIPTION
529    "The configuration revision of the OAM peer as reflected in
530    the latest OAMPDU.  This attribute is changed by the peer
531    whenever it has a local configuration change for Ethernet OAM
532    this interface.  The configuration revision can be determined
533    from the Revision field of the Local Information TLV of the
534    most recently received Information OAMPDU with a Local
535    Information TLV. A value of zero is returned if no Local
536    Information TLV has been received.
537  "
538  REFERENCE   "[802.3ah], 30.3.6.1.13."
539  ::= { cdot3OamPeerEntry 6 }
540
541
542cdot3OamPeerFunctionsSupported OBJECT-TYPE
543  SYNTAX      BITS {
544                unidirectionalSupport (0),
545                loopbackSupport(1),
546                eventSupport(2),
547                variableSupport(3)
548              }
549  MAX-ACCESS  read-only
550  STATUS      current
551  DESCRIPTION
552    "The OAM functions supported on this Ethernet like interface.
553    OAM consists of separate functionality sets above the basic
554    discovery process.  This value indicates the capabilities of
555    the peer OAM entity with respect to these functions.  This
556    value is initialized so all bits are clear.
557
558    If unidirectionalSupport(0) is set, then the peer OAM entity
559    supports sending OAM frames on Ethernet interfaces when the
560    receive path is known to be inoperable.   If
561    loopbackSupport(1) is set, then the peer OAM entity can send
562    and receive OAM loopback commands.  If eventSupport(2) is set,
563    then the peer OAM entity can send and receive event OAMPDUs to
564    signal various error conditions. If variableSupport(3) is set,
565    then the peer OAM entity can send and receive variable
566    requests to monitor attribute value as described in Clause 57
567    of [802.3ah].
568
569    The capabilities of the OAM peer can be determined from the
570    configuration field of the Local Information TLV of the most
571    recently received Information OAMPDU with a Local Information
572    TLV.  All zeros are returned if no Local Information TLV has
573    yet been received.
574    "
575  REFERENCE   "[802.3ah], REFERENCE 30.3.6.1.7."
576  ::= { cdot3OamPeerEntry 7 }
577
578
579-- ***************************************************************
580--
581-- Ethernet OAM Loopback group
582--
583
584
585cdot3OamLoopbackTable OBJECT-TYPE
586  SYNTAX      SEQUENCE OF Cdot3OamLoopbackEntry
587  MAX-ACCESS  not-accessible
588  STATUS      current
589  DESCRIPTION
590    "This table contains controls for the loopback state of the
591    local link as well as indicating the status of the loopback
592    function.  There is one entry in this table for each entry in
593    cdot3OamTable that supports loopback functionality (where
594    cdot3OamFunctionsSupported includes the loopbackSupport bit
595    set).
596
597    Loopback can be used to place the remote OAM entity in a state
598    where every received frame (except OAMPDUs) is echoed back
599    over the same interface on which they were received.   In this
600    state, at the remote entity, 'normal' traffic is disabled as
601    only the looped back frames are transmitted on the interface.
602    Loopback is thus an intrusive operation that prohibits normal
603    data flow and should be used accordingly.  "
604  ::= { cdot3OamObjects 3 }
605
606
607cdot3OamLoopbackEntry OBJECT-TYPE
608  SYNTAX      Cdot3OamLoopbackEntry
609  MAX-ACCESS  not-accessible
610  STATUS      current
611  DESCRIPTION
612    "An entry in the table, containing information on the loopback
613    status for a single Ethernet like interface.  Entries in the
614    table are automatically created whenever the local OAM entity
615    supports loopback capabilities.  The loopback status on the
616    interface can be determined from the cdot3OamLoopbackStatus
617    object.
618    "
619  INDEX       { ifIndex }
620  ::= { cdot3OamLoopbackTable 1 }
621
622Cdot3OamLoopbackEntry ::=
623  SEQUENCE {
624    cdot3OamLoopbackStatus             INTEGER,
625    cdot3OamLoopbackIgnoreRx           INTEGER
626  }
627
628cdot3OamLoopbackStatus OBJECT-TYPE
629  SYNTAX      INTEGER {
630                -- all values, except where noted, can be read
631                -- but cannot be written
632                noLoopback (1),
633
634                -- initiatingLoopback can be read or written
635                initiatingLoopback (2),
636                remoteLoopback (3),
637
638                -- terminatingLoopback can be read or written
639                terminatingLoopback (4),
640                localLoopback (5),
641                unknown (6)
642              }
643  MAX-ACCESS  read-write
644  STATUS      current
645  DESCRIPTION
646    "The loopback status of the OAM entity.  This status is
647    determined by a combination of the local parser and
648    multiplexer states, the remote parser and multiplexer states,
649    as well as by the actions of the local OAM client.  When
650    operating in normal mode with no loopback in progress, the
651    status reads noLoopback(1).
652
653    The values initiatingLooopback(2) and terminatingLoopback(4)
654    can be read or written.  The other values can only be read -
655    they can never be written.  Writing initiatingLoopback causes
656    the local OAM entity to start the loopback process with its
657    peer.  This value can only be written when the status is
658    noLoopback(1).  Writing the value initiatingLoopback(2) in any
659    other state has no effect.  When in remoteLoopback(3), writing
660    terminatingLoopback(4) causes the local OAM entity to initiate
661    the termination of the loopback state.  Writing
662    terminatingLoopack(4) in any other state has no effect.
663    If the OAM client initiates a looopback and has sent an
664    Loopback OAMPDU and is waiting for a response, where the local
665    parser and multiplexer states are DISCARD (see [802.3ah,
666    57.2.11.1]), the status is 'initiatingLoopback'.  In this
667    case, the local OAM entity has yet to receive any
668    acknowledgement that the remote OAM entity has received its
669    loopback command request.
670
671    If the local OAM client knows that the remote OAM entity is in
672    loopback mode (via the remote state information as described
673    in [802.3ah, 57.2.11.1, 30.3.6.1.15]), the status is
674    remoteLoopback(3).  If the local OAM client is in the process
675    of terminating the remote loopback [802.3ah, 57.2.11.3,
676    30.3.6.1.14], with its local multiplexer and parser states in
677    DISCARD, the status is terminatingLoopback(4).  If the remote
678    OAM client has put the local OAM entity in loopback mode as
679    indicated by its local parser state, the status is
680    localLoopback(5).
681
682    The unknown(6) status indicates the parser and multiplexer
683    combination is unexpected.  This status may be returned if the
684    OAM loopback is in a transition state but should not persist.
685
686    The values of this attribute correspond to the following
687    values of the local and remote parser and multiplexer states.
688
689      value            LclPrsr   LclMux    RmtPrsr   RmtMux
690      noLoopback         FWD       FWD       FWD       FWD
691      initLoopback     DISCARD   DISCARD     FWD       FWD
692      rmtLoopback      DISCARD     FWD      LPBK    DISCARD
693      tmtngLoopback    DISCARD   DISCARD    LPBK    DISCARD
694      lclLoopback        LPBK    DISCARD   DISCARD     FWD
695      unknown            ***   any other combination   ***
696    "
697  REFERENCE   "[802.3ah], REFERENCE 57.2.11, 30.3.61.14,
698    30.3.6.1.15"
699  ::= { cdot3OamLoopbackEntry 1 }
700
701cdot3OamLoopbackIgnoreRx OBJECT-TYPE
702  SYNTAX      INTEGER { ignore(1), process(2) }
703  MAX-ACCESS  read-write
704  STATUS      current
705  DESCRIPTION
706    "Since OAM loopback is a disruptive operation (user traffic
707    does not pass), this attribute provides a mechanism to provide
708    controls over whether received OAM loopback commands are
709    processed or ignored.  When the value is ignore(1), received
710    loopback commands are ignored.  When the value is process(2),
711    OAM loopback commands are processed.  The default value is to
712    ignore loopback commands (ignore(1)).
713    "
714  REFERENCE   "[802.3ah], REFERENCE 57.2.11, 30.3.61.14,
715    30.3.6.1.15"
716  ::= { cdot3OamLoopbackEntry 2 }
717
718
719-- ***************************************************************
720--
721-- Ethernet OAM Statistics group
722--
723
724
725cdot3OamStatsTable OBJECT-TYPE
726  SYNTAX      SEQUENCE OF Cdot3OamStatsEntry
727  MAX-ACCESS  not-accessible
728  STATUS      current
729  DESCRIPTION
730    "This table contains statistics for the OAM function on a
731    particular Ethernet like interface. There is an entry in the
732    table for every entry in the cdot3OamTable.
733
734    The counters in this table are defined as 32-bit entries to
735    match the counter size as defined in [802.3ah].  Given the OAM
736    protocol is a slow protocol, the counters increment at a slow
737    rate.
738    "
739  ::= { cdot3OamObjects 4 }
740
741cdot3OamStatsEntry OBJECT-TYPE
742  SYNTAX      Cdot3OamStatsEntry
743  MAX-ACCESS  not-accessible
744  STATUS      current
745  DESCRIPTION
746    "An entry in the table, containing statistics information on
747    the Ethernet OAM function for a single Ethernet like
748    interface.  Entries are automatically created for every entry
749    in the cdot3OamTable.  Counters are maintained across
750    transitions in cdot3OamOperStatus.
751    "
752  INDEX       { ifIndex }
753  ::= { cdot3OamStatsTable 1 }
754
755Cdot3OamStatsEntry ::=
756  SEQUENCE {
757            cdot3OamInformationTx                Counter32,
758            cdot3OamInformationRx                Counter32,
759            cdot3OamUniqueEventNotificationTx    Counter32,
760            cdot3OamUniqueEventNotificationRx    Counter32,
761            cdot3OamDuplicateEventNotificationTx Counter32,
762            cdot3OamDuplicateEventNotificationRx Counter32,
763            cdot3OamLoopbackControlTx            Counter32,
764            cdot3OamLoopbackControlRx            Counter32,
765            cdot3OamVariableRequestTx            Counter32,
766            cdot3OamVariableRequestRx            Counter32,
767            cdot3OamVariableResponseTx           Counter32,
768            cdot3OamVariableResponseRx           Counter32,
769            cdot3OamOrgSpecificTx                Counter32,
770            cdot3OamOrgSpecificRx                Counter32,
771            cdot3OamUnsupportedCodesTx           Counter32,
772            cdot3OamUnsupportedCodesRx           Counter32,
773            cdot3OamFramesLostDueToOam           Counter32
774           }
775
776
777cdot3OamInformationTx OBJECT-TYPE
778  SYNTAX      Counter32
779  UNITS       "frames"
780  MAX-ACCESS  read-only
781  STATUS      current
782  DESCRIPTION
783    "A count of the number of Information OAMPDUs transmitted on
784    this interface.
785
786    Discontinuities of this counter can occur at re-initialization
787    of the management system, and at other times as indicated by
788    the value of the ifCounterDiscontinuityTime.  "
789  REFERENCE   "[802.3ah], 30.3.6.1.20."
790  ::= { cdot3OamStatsEntry 1 }
791
792cdot3OamInformationRx OBJECT-TYPE
793  SYNTAX      Counter32
794  UNITS       "frames"
795  MAX-ACCESS  read-only
796  STATUS      current
797  DESCRIPTION
798    "A count of the number of Information OAMPDUs received on this
799    interface.
800
801    Discontinuities of this counter can occur at re-initialization
802    of the management system, and at other times as indicated by
803    the value of the ifCounterDiscontinuityTime.
804    "
805  REFERENCE   "[802.3ah], 30.3.6.1.21."
806  ::= { cdot3OamStatsEntry 2 }
807
808cdot3OamUniqueEventNotificationTx OBJECT-TYPE
809  SYNTAX      Counter32
810  UNITS       "frames"
811  MAX-ACCESS  read-only
812  STATUS      current
813  DESCRIPTION
814    "A count of the number of unique Event OAMPDUs transmitted on
815    this interface.  Event notifications may be sent in duplicate
816    to increase the probability of successfully being received,
817    given the possibility that a frame may be lost in transit.
818    Duplicate Event Notification transmissions are counted by
819    cdot3OamDuplicateEventNotificationTx.
820
821    A unique Event Notification OAMPDU is indicated as an Event
822    Notification OAMPDU with a Sequence Number field that is
823    distinct from the previously transmitted Event Notification
824    OAMPDU Sequence Number.
825
826    Discontinuities of this counter can occur at re-initialization
827    of the management system, and at other times as indicated by
828    the value of the ifCounterDiscontinuityTime.
829    "
830  REFERENCE   "[802.3ah], 30.3.6.1.22."
831  ::= { cdot3OamStatsEntry 3 }
832
833cdot3OamUniqueEventNotificationRx OBJECT-TYPE
834  SYNTAX      Counter32
835  UNITS       "frames"
836  MAX-ACCESS  read-only
837  STATUS      current
838  DESCRIPTION
839    "A count of the number of unique Event OAMPDUs received on
840    this interface.  Event notification OAMPDUs may be sent in
841    duplicate to increase the probability of successfully being
842    received, given the possibility that a frame may be lost in
843    transit.  Duplicate Event Notification receptions are counted
844    by cdot3OamDuplicateEventNotificationRx.
845
846    A unique Event Notification OAMPDU is indicated as an Event
847    Notification OAMPDU with a Sequence Number field that is
848    distinct from the previously received Event Notification
849    OAMPDU Sequence Number.
850
851    Discontinuities of this counter can occur at re-initialization
852    of the management system, and at other times as indicated by
853    the value of the ifCounterDiscontinuityTime.
854    "
855  REFERENCE   "[802.3ah], 30.3.6.1.24."
856  ::= { cdot3OamStatsEntry 4 }
857
858cdot3OamDuplicateEventNotificationTx OBJECT-TYPE
859  SYNTAX      Counter32
860  UNITS       "frames"
861  MAX-ACCESS  read-only
862  STATUS      current
863  DESCRIPTION
864    "A count of the number of duplicate Event OAMPDUs transmitted
865    on this interface.  Event notification OAMPDUs may be sent in
866    duplicate to increase the probability of successfully being
867    received, given the possibility that a frame may be lost in
868    transit.
869
870    A duplicate Event Notification OAMPDU is indicated as an Event
871    Notification OAMPDU with a Sequence Number field that is
872    identical to the previously transmitted Event Notification
873    OAMPDU Sequence Number.
874
875    Discontinuities of this counter can occur at re-initialization
876    of the management system, and at other times as indicated by
877    the value of the ifCounterDiscontinuityTime.
878    "
879  REFERENCE   "[802.3ah], 30.3.6.1.23."
880  ::= { cdot3OamStatsEntry 5 }
881
882cdot3OamDuplicateEventNotificationRx OBJECT-TYPE
883  SYNTAX      Counter32
884  UNITS       "frames"
885  MAX-ACCESS  read-only
886  STATUS      current
887  DESCRIPTION
888    "A count of the number of duplicate Event OAMPDUs received on
889    this interface.  Event notification OAMPDUs may be sent in
890    duplicate to increase the probability of successfully being
891    received, given the possibility that a frame may be lost in
892    transit.
893
894    A duplicate Event Notification OAMPDU is indicated as an Event
895    Notification OAMPDU with a Sequence Number field that is
896    identical to the previously received Event Notification OAMPDU
897    Sequence Number.
898
899    Discontinuities of this counter can occur at re-initialization
900    of the management system, and at other times as indicated by
901    the value of the ifCounterDiscontinuityTime.
902    "
903  REFERENCE   "[802.3ah], 30.3.6.1.25."
904  ::= { cdot3OamStatsEntry 6 }
905
906cdot3OamLoopbackControlTx OBJECT-TYPE
907  SYNTAX      Counter32
908  UNITS       "frames"
909  MAX-ACCESS  read-only
910  STATUS      current
911  DESCRIPTION
912    "A count of the number of Loopback Control OAMPDUs transmitted
913    on this interface.
914
915    Discontinuities of this counter can occur at re-initialization
916    of the management system, and at other times as indicated by
917    the value of the ifCounterDiscontinuityTime.
918    "
919  REFERENCE   "[802.3ah], 30.3.6.1.26."
920  ::= { cdot3OamStatsEntry 7 }
921
922cdot3OamLoopbackControlRx OBJECT-TYPE
923  SYNTAX      Counter32
924  UNITS       "frames"
925  MAX-ACCESS  read-only
926  STATUS      current
927  DESCRIPTION
928    "A count of the number of Loopback Control OAMPDUs received
929    on this interface.
930
931    Discontinuities of this counter can occur at re-initialization
932    of the management system, and at other times as indicated by
933    the value of the ifCounterDiscontinuityTime.
934    "
935  REFERENCE   "[802.3ah], 30.3.6.1.27."
936  ::= { cdot3OamStatsEntry 8 }
937
938cdot3OamVariableRequestTx OBJECT-TYPE
939  SYNTAX      Counter32
940  UNITS       "frames"
941  MAX-ACCESS  read-only
942  STATUS      current
943  DESCRIPTION
944    "A count of the number of Variable Request OAMPDUs transmitted
945    on this interface.
946
947    Discontinuities of this counter can occur at re-initialization
948    of the management system, and at other times as indicated by
949    the value of the ifCounterDiscontinuityTime.
950    "
951  REFERENCE   "[802.3ah], 30.3.6.1.28."
952  ::= { cdot3OamStatsEntry 9 }
953
954cdot3OamVariableRequestRx OBJECT-TYPE
955  SYNTAX      Counter32
956  UNITS       "frames"
957  MAX-ACCESS  read-only
958  STATUS      current
959  DESCRIPTION
960    "A count of the number of Variable Request OAMPDUs received on
961    this interface.
962
963    Discontinuities of this counter can occur at re-initialization
964    of the management system, and at other times as indicated by
965    the value of the ifCounterDiscontinuityTime.
966    "
967  REFERENCE   "[802.3ah], 30.3.6.1.29."
968  ::= { cdot3OamStatsEntry 10 }
969
970cdot3OamVariableResponseTx OBJECT-TYPE
971  SYNTAX      Counter32
972  UNITS       "frames"
973  MAX-ACCESS  read-only
974  STATUS      current
975  DESCRIPTION
976    "A count of the number of Variable Response OAMPDUs
977    transmitted on this interface.
978
979    Discontinuities of this counter can occur at re-initialization
980    of the management system, and at other times as indicated by
981    the value of the ifCounterDiscontinuityTime.
982    "
983  REFERENCE   "[802.3ah], 30.3.6.1.30."
984  ::= { cdot3OamStatsEntry 11 }
985
986cdot3OamVariableResponseRx OBJECT-TYPE
987  SYNTAX      Counter32
988  UNITS       "frames"
989  MAX-ACCESS  read-only
990  STATUS      current
991  DESCRIPTION
992    "A count of the number of Variable Response OAMPDUs received
993    on this interface.
994
995    Discontinuities of this counter can occur at re-initialization
996    of the management system, and at other times as indicated by
997    the value of the ifCounterDiscontinuityTime.
998    "
999  REFERENCE   "[802.3ah], 30.3.6.1.31."
1000  ::= { cdot3OamStatsEntry 12 }
1001
1002 cdot3OamOrgSpecificTx OBJECT-TYPE
1003  SYNTAX      Counter32
1004  UNITS       "frames"
1005  MAX-ACCESS  read-only
1006  STATUS      current
1007  DESCRIPTION
1008    "A count of the number of Organization Specific OAMPDUs
1009    transmitted on this interface.
1010
1011    Discontinuities of this counter can occur at re-initialization
1012    of the management system, and at other times as indicated by
1013    the value of the ifCounterDiscontinuityTime.
1014    "
1015  REFERENCE   "[802.3ah], 30.3.6.1.32."
1016  ::= { cdot3OamStatsEntry 13 }
1017
1018cdot3OamOrgSpecificRx OBJECT-TYPE
1019  SYNTAX      Counter32
1020  UNITS       "frames"
1021  MAX-ACCESS  read-only
1022  STATUS      current
1023  DESCRIPTION
1024    "A count of the number of Organization Specific OAMPDUs
1025    received on this interface.
1026
1027    Discontinuities of this counter can occur at re-initialization
1028    of the management system, and at other times as indicated by
1029    the value of the ifCounterDiscontinuityTime.
1030    "
1031  REFERENCE   "[802.3ah], 30.3.6.1.33."
1032  ::= { cdot3OamStatsEntry 14 }
1033
1034cdot3OamUnsupportedCodesTx OBJECT-TYPE
1035  SYNTAX      Counter32
1036  UNITS       "frames"
1037  MAX-ACCESS  read-only
1038  STATUS      current
1039  DESCRIPTION
1040    "A count of the number of OAMPDUs transmitted on this
1041    interface with an unsupported op-code.
1042
1043    Discontinuities of this counter can occur at re-initialization
1044    of the management system, and at other times as indicated by
1045    the value of the ifCounterDiscontinuityTime.
1046    "
1047  REFERENCE   "[802.3ah], 30.3.6.1.18."
1048  ::= { cdot3OamStatsEntry 15 }
1049
1050cdot3OamUnsupportedCodesRx OBJECT-TYPE
1051  SYNTAX      Counter32
1052  UNITS       "frames"
1053  MAX-ACCESS  read-only
1054  STATUS      current
1055  DESCRIPTION
1056    "A count of the number of OAMPDUs received on this interface
1057    with an unsupported op-code.
1058
1059    Discontinuities of this counter can occur at re-initialization
1060    of the management system, and at other times as indicated by
1061    the value of the ifCounterDiscontinuityTime.
1062    "
1063  REFERENCE   "[802.3ah], 30.3.6.1.19."
1064  ::= { cdot3OamStatsEntry 16 }
1065
1066cdot3OamFramesLostDueToOam OBJECT-TYPE
1067  SYNTAX      Counter32
1068  UNITS       "frames"
1069  MAX-ACCESS  read-only
1070  STATUS      current
1071  DESCRIPTION
1072    "A count of the number of frames that were dropped by the OAM
1073    multiplexer.  Since the OAM multiplexer has multiple inputs
1074    and a single output, there may be cases where frames are
1075    dropped due to transmit resource contention.  This counter is
1076    incremented whenever a frame is dropped by the OAM layer.
1077    Note that any Ethernet frame, not just OAMPDUs, may be dropped
1078    by the OAM layer.  This can occur when an OAMPDU takes
1079    precedence over a 'normal' frame resulting in the 'normal'
1080    frame being dropped.
1081
1082    When this counter is incremented, no other counters in this
1083    MIB are incremented.
1084
1085    Discontinuities of this counter can occur at re-initialization
1086    of the management system, and at other times as indicated by
1087    the value of the ifCounterDiscontinuityTime.
1088    "
1089  REFERENCE   "[802.3ah], 30.3.6.1.46."
1090  ::= { cdot3OamStatsEntry 17 }
1091
1092
1093-- ***************************************************************
1094--
1095-- Ethernet OAM Event Configuration group
1096--
1097
1098
1099cdot3OamEventConfigTable OBJECT-TYPE
1100  SYNTAX     SEQUENCE OF Cdot3OamEventConfigEntry
1101  MAX-ACCESS not-accessible
1102  STATUS     current
1103  DESCRIPTION
1104    "Ethernet OAM includes the ability to generate and receive
1105    Event Notification OAMPDUs to indicate various link problems.
1106    This table contains the mechanisms to enable Event
1107    Notifications and configure the thresholds to generate the
1108    standard Ethernet OAM events.  There is one entry in the table
1109    for every entry in cdot3OamTable that supports OAM events
1110    (where cdot3OamFunctionsSupported includes the eventSupport
1111    bit set). The values in the table are maintained across
1112    changes to cdot3OamOperStatus.
1113
1114    The standard threshold crossing events are:
1115      - Errored Symbol Period Event.  Generated when the number of
1116        symbol errors exceeds a threshold within a given window
1117        defined by a number of symbols (for example, 1,000 symbols
1118        out of 1,000,000 had errors).
1119      - Errored Frame Period Event.  Generated when the number of
1120        frame errors exceeds a threshold within a given window
1121        defined by a number of frames (for example, 10 frames out
1122        of 1000 had errors).
1123      - Errored Frame Event.  Generated when the number of frame
1124        errors exceeds a threshold within a given window defined
1125        by a period of time (for example, 10 frames in 1 second
1126        had errors).
1127      - Errored Frame Seconds Summary Event.  Generated when the
1128        number of errored frame seconds exceeds a threshold within
1129        a given time period (for example, 10 errored frame seconds
1130        within the last 100 seconds).  An errored frame second is
1131        defined as a 1 second interval which had >0 frame errors.
1132    There are other events (dying gasp, critical events) that are
1133    not threshold crossing events but which can be
1134    enabled/disabled via this table.
1135    "
1136  ::= { cdot3OamObjects 5 }
1137
1138cdot3OamEventConfigEntry OBJECT-TYPE
1139  SYNTAX      Cdot3OamEventConfigEntry
1140  MAX-ACCESS  not-accessible
1141  STATUS      current
1142  DESCRIPTION
1143    "Entries are automatically created and deleted from this
1144    table, and exist whenever the OAM entity supports Ethernet OAM
1145    events (as indicated by the eventSupport bit in
1146    cdot3OamFunctionsSuppported).  Values in the table are
1147    maintained across changes to the value of cdot3OamOperStatus.
1148
1149    Event configuration controls when the local management entity
1150    sends Event Notification OAMPDUs to its OAM peer, and when
1151    certain event flags are set or cleared in OAMPDUs.
1152    "
1153  INDEX       { ifIndex }
1154  ::= { cdot3OamEventConfigTable 1 }
1155
1156Cdot3OamEventConfigEntry ::=
1157  SEQUENCE {
1158            cdot3OamErrSymPeriodWindowHi        Unsigned32,
1159            cdot3OamErrSymPeriodWindowLo        Unsigned32,
1160            cdot3OamErrSymPeriodThresholdHi     Unsigned32,
1161            cdot3OamErrSymPeriodThresholdLo     Unsigned32,
1162            cdot3OamErrSymPeriodEvNotifEnable   TruthValue,
1163            cdot3OamErrFramePeriodWindow        Unsigned32,
1164            cdot3OamErrFramePeriodThreshold     Unsigned32,
1165            cdot3OamErrFramePeriodEvNotifEnable TruthValue,
1166            cdot3OamErrFrameWindow              Unsigned32,
1167            cdot3OamErrFrameThreshold           Unsigned32,
1168            cdot3OamErrFrameEvNotifEnable       TruthValue,
1169            cdot3OamErrFrameSecsSummaryWindow   Integer32,
1170            cdot3OamErrFrameSecsSummaryThreshold Integer32,
1171            cdot3OamErrFrameSecsEvNotifEnable   TruthValue,
1172            cdot3OamDyingGaspEnable             TruthValue,
1173            cdot3OamCriticalEventEnable         TruthValue
1174          }
1175
1176cdot3OamErrSymPeriodWindowHi OBJECT-TYPE
1177  SYNTAX      Unsigned32
1178  UNITS       "2^32 symbols"
1179  MAX-ACCESS  read-write
1180  STATUS      current
1181  DESCRIPTION
1182    "The two objects cdot3OamErrSymPeriodWindowHi and
1183    cdot3OamErrSymPeriodLo together form an unsigned 64-bit
1184    integer representing the number of symbols over which this
1185    threshold event is defined.  This is defined as
1186
1187  cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)
1188                                    + cdot3OamErrSymPeriodWindowLo
1189
1190    If cdot3OamErrSymPeriodThreshold symbol errors occur within a
1191    window of cdot3OamErrSymPeriodWindow symbols, an Event
1192    Notification OAMPDU should be generated with an Errored Symbol
1193    Period Event TLV indicating the threshold has been crossed in
1194    this window.
1195
1196    The default value for cdot3OamErrSymPeriodWindow is the number
1197    of symbols in one second for the underlying physical layer.
1198    "
1199  REFERENCE   "[802.3ah], 30.3.6.1.34"
1200  ::= { cdot3OamEventConfigEntry 1 }
1201
1202cdot3OamErrSymPeriodWindowLo OBJECT-TYPE
1203  SYNTAX      Unsigned32
1204  UNITS       "symbols"
1205  MAX-ACCESS  read-write
1206  STATUS      current
1207  DESCRIPTION
1208    "The two objects cdot3OamErrSymPeriodWindowHi and
1209    cdot3OamErrSymPeriodWindowLo together form an unsigned 64-bit
1210    integer representing the number of symbols over which this
1211    threshold event is defined.  This is defined as
1212
1213  cdot3OamErrSymPeriodWindow = ((2^32)*cdot3OamErrSymPeriodWindowHi)
1214                                    + cdot3OamErrSymPeriodWindowLo
1215
1216    If cdot3OamErrSymPeriodThreshold symbol errors occur within a
1217    window of cdot3OamErrSymPeriodWindow symbols, an Event
1218    Notification OAMPDU should be generated with an Errored Symbol
1219    Period Event TLV indicating the threshold has been crossed in
1220    this window.
1221
1222    The default value for cdot3OamErrSymPeriodWindow is the number
1223    of symbols in one second for the underlying physical layer.
1224    "
1225  REFERENCE   "[802.3ah], 30.3.6.1.34"
1226  ::= { cdot3OamEventConfigEntry 2 }
1227
1228cdot3OamErrSymPeriodThresholdHi OBJECT-TYPE
1229  SYNTAX      Unsigned32
1230  UNITS       "2^32 symbols"
1231  MAX-ACCESS  read-write
1232  STATUS      current
1233  DESCRIPTION
1234    "The two objects cdot3OamErrSymPeriodThresholdHi and
1235    cdot3OamErrSymPeriodThresholdLo together form an unsigned
1236    64-bit integer representing the number of symbol errors that
1237    must occur within a given window to cause this event.
1238
1239    This is defined as
1240
1241      cdot3OamErrSymPeriodThreshold =
1242                        ((2^32) * cdot3OamErrSymPeriodThresholdHi)
1243                                + cdot3OamErrSymPeriodThresholdLo
1244
1245    If cdot3OamErrSymPeriodThreshold symbol errors occur within a
1246    window of cdot3OamErrSymPeriodWindow symbols, an Event
1247    Notification OAMPDU should be generated with an Errored Symbol
1248    Period Event TLV indicating the threshold has been crossed in
1249    this window.
1250
1251    The default value for cdot3OamErrSymPeriodThreshold is one
1252    symbol errors.  If the threshold value is zero, then an Event
1253    Notification OAMPDU is sent periodically (at the end of every
1254    window).  This can be used as an asynchronous notification to
1255    the peer OAM entity of the statistics related to this
1256    threshold crossing alarm.
1257    "
1258  REFERENCE   "[802.3ah], 30.3.6.1.34"
1259  ::= { cdot3OamEventConfigEntry 3 }
1260
1261cdot3OamErrSymPeriodThresholdLo OBJECT-TYPE
1262  SYNTAX      Unsigned32
1263  UNITS       "symbols"
1264  MAX-ACCESS  read-write
1265  STATUS      current
1266  DESCRIPTION
1267    "The two objects cdot3OamErrSymPeriodThresholdHi and
1268    cdot3OamErrSymPeriodThresholdLo together form an unsigned
1269    64-bit integer representing the number of symbol errors that
1270    must occur within a given window to cause this event.
1271
1272    This is defined as
1273
1274      cdot3OamErrSymPeriodThreshold =
1275                        ((2^32) * cdot3OamErrSymPeriodThresholdHi)
1276                                + cdot3OamErrSymPeriodThresholdLo
1277
1278    If cdot3OamErrSymPeriodThreshold symbol errors occur within a
1279    window of cdot3OamErrSymPeriodWindow symbols, an Event
1280    Notification OAMPDU should be generated with an Errored Symbol
1281    Period Event TLV indicating the threshold has been crossed in
1282    this window.
1283
1284    The default value for cdot3OamErrSymPeriodThreshold is one
1285    symbol error. If the threshold value is zero, then an Event
1286    Notification OAMPDU is sent periodically (at the end of every
1287    window).  This can be used as an asynchronous notification to
1288    the peer OAM entity of the statistics related to this
1289    threshold crossing alarm.
1290    "
1291  REFERENCE   "[802.3ah], 30.3.6.1.34"
1292  ::= { cdot3OamEventConfigEntry 4 }
1293
1294cdot3OamErrSymPeriodEvNotifEnable OBJECT-TYPE
1295  SYNTAX      TruthValue
1296  MAX-ACCESS  read-write
1297  STATUS      current
1298  DESCRIPTION
1299    "If true, the OAM entity should send an Event Notification
1300    OAMPDU when an Errored Symbol Period Event occurs.
1301    By default, this object should have the value true for
1302    Ethernet like interfaces that support OAM.  If the OAM layer
1303    does not support event notifications (as indicated via the
1304    cdot3OamFunctionsSupported attribute), this value is ignored.
1305    "
1306  ::= { cdot3OamEventConfigEntry 5 }
1307
1308cdot3OamErrFramePeriodWindow OBJECT-TYPE
1309  SYNTAX      Unsigned32
1310  UNITS       "frames"
1311  MAX-ACCESS  read-write
1312  STATUS      current
1313  DESCRIPTION
1314    "The number of frames over which the threshold is defined.
1315    The default value of the window is the number of minimum size
1316    Ethernet frames that can be received over the physical layer
1317    in one second.
1318
1319    If cdot3OamErrFramePeriodThreshold frame errors occur within a
1320    window of cdot3OamErrFramePeriodWindow frames, an Event
1321    Notification OAMPDU should be generated with an Errored Frame
1322    Period Event TLV indicating the threshold has been crossed in
1323    this window.
1324    "
1325  REFERENCE   "[802.3ah], 30.3.6.1.38"
1326  ::= { cdot3OamEventConfigEntry 6 }
1327
1328cdot3OamErrFramePeriodThreshold OBJECT-TYPE
1329  SYNTAX      Unsigned32
1330  UNITS       "frames"
1331  MAX-ACCESS  read-write
1332  STATUS      current
1333  DESCRIPTION
1334    "The number of frame errors that must occur for this event to
1335    be triggered.  The default value is one frame error.  If the
1336    threshold value is zero, then an Event Notification OAMPDU is
1337    sent periodically (at the end of every window).  This can be
1338    used as an asynchronous notification to the peer OAM entity of
1339    the statistics related to this threshold crossing alarm.
1340
1341    If cdot3OamErrFramePeriodThreshold frame errors occur within a
1342    window of cdot3OamErrFramePeriodWindow frames, an Event
1343    Notification OAMPDU should be generated with an Errored Frame
1344    Period Event TLV indicating the threshold has been crossed in
1345    this window.
1346    "
1347  REFERENCE   "[802.3ah], 30.3.6.1.38"
1348  ::= { cdot3OamEventConfigEntry 7 }
1349
1350cdot3OamErrFramePeriodEvNotifEnable OBJECT-TYPE
1351  SYNTAX      TruthValue
1352  MAX-ACCESS  read-write
1353  STATUS      current
1354  DESCRIPTION
1355    "If true, the OAM entity should send an Event Notification
1356    OAMPDU when an Errored Frame Period Event occurs.
1357
1358    By default, this object should have the value true for
1359    Ethernet like interfaces that support OAM.  If the OAM layer
1360    does not support event notifications (as indicated via the
1361    cdot3OamFunctionsSupported attribute), this value is ignored.
1362    "
1363  ::= { cdot3OamEventConfigEntry 8 }
1364
1365
1366cdot3OamErrFrameWindow OBJECT-TYPE
1367  SYNTAX      Unsigned32
1368  UNITS       "tenths of a second"
1369  MAX-ACCESS  read-write
1370  STATUS      current
1371  DESCRIPTION
1372    "The amount of time (in 100ms increments) over which the
1373    threshold is defined.  The default value is 10 (1 second).
1374
1375    If cdot3OamErrFrameThreshold frame errors occur within a window
1376    of cdot3OamErrFrameWindow seconds (measured in tenths of
1377    seconds), an Event Notification OAMPDU should be generated
1378    with an Errored Frame Event TLV indicating the threshold has
1379    been crossed in this window.
1380    "
1381  REFERENCE   "[802.3ah], 30.3.6.1.36"
1382  ::= { cdot3OamEventConfigEntry 9 }
1383
1384
1385cdot3OamErrFrameThreshold OBJECT-TYPE
1386  SYNTAX      Unsigned32
1387  UNITS       "frames"
1388  MAX-ACCESS  read-write
1389  STATUS      current
1390  DESCRIPTION
1391    "The number of frame errors that must occur for this event to
1392    be triggered.  The default value is one frame error. If the
1393    threshold value is zero, then an Event Notification OAMPDU is
1394    sent periodically (at the end of every window).  This can be
1395    used as an asynchronous notification to the peer OAM entity of
1396    the statistics related to this threshold crossing alarm.
1397
1398    If cdot3OamErrFrameThreshold frame errors occur within a window
1399    of cdot3OamErrFrameWindow (in tenths of seconds), an Event
1400    Notification OAMPDU should be generated with an Errored Frame
1401    Event TLV indicating the threshold has been crossed in this
1402    window.
1403    "
1404  REFERENCE   "[802.3ah], 30.3.6.1.36"
1405  ::= { cdot3OamEventConfigEntry 10 }
1406
1407cdot3OamErrFrameEvNotifEnable OBJECT-TYPE
1408  SYNTAX      TruthValue
1409  MAX-ACCESS  read-write
1410  STATUS      current
1411  DESCRIPTION
1412    "If true, the OAM entity should send an Event Notification
1413    OAMPDU when an Errored Frame Event occurs.
1414
1415    By default, this object should have the value true for
1416    Ethernet like interfaces that support OAM.  If the OAM layer
1417    does not support event notifications (as indicated via the
1418    cdot3OamFunctionsSupported attribute), this value is ignored.
1419    "
1420  ::= { cdot3OamEventConfigEntry 11 }
1421
1422cdot3OamErrFrameSecsSummaryWindow OBJECT-TYPE
1423  SYNTAX      Integer32 (100..9000)
1424  UNITS       "tenths of a second"
1425  MAX-ACCESS  read-write
1426  STATUS      current
1427  DESCRIPTION
1428    "The amount of time (in 100ms intervals) over which the
1429    threshold is defined.  The default value is 100 (10 seconds).
1430
1431    If cdot3OamErrFrameSecsSummaryThreshold frame errors occur
1432    within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths
1433    of seconds), an Event Notification OAMPDU should be generated
1434    with an Errored Frame Seconds Summary Event TLV indicating the
1435    threshold has been crossed in this window.
1436    "
1437  REFERENCE   "[802.3ah], 30.3.6.1.40"
1438  ::= { cdot3OamEventConfigEntry 12 }
1439
1440cdot3OamErrFrameSecsSummaryThreshold OBJECT-TYPE
1441  SYNTAX      Integer32 (1..900)
1442  UNITS       "errored frame seconds"
1443  MAX-ACCESS  read-write
1444  STATUS      current
1445  DESCRIPTION
1446    "The number of errored frame seconds that must occur for this
1447    event to be triggered.  The default value is one errored frame
1448    second. If the threshold value is zero, then an Event
1449    Notification OAMPDU is sent periodically (at the end of every
1450    window).  This can be used as an asynchronous notification to
1451    the peer OAM entity of the statistics related to this
1452    threshold crossing alarm.
1453
1454    If cdot3OamErrFrameSecsSummaryThreshold frame errors occur
1455    within a window of cdot3OamErrFrameSecsSummaryWindow (in tenths
1456    of seconds), an Event Notification OAMPDU should be generated
1457    with an Errored Frame Seconds Summary Event TLV indicating the
1458    threshold has been crossed in this window.
1459    "
1460  REFERENCE   "[802.3ah], 30.3.6.1.40"
1461  ::= { cdot3OamEventConfigEntry 13 }
1462
1463cdot3OamErrFrameSecsEvNotifEnable OBJECT-TYPE
1464  SYNTAX      TruthValue
1465  MAX-ACCESS  read-write
1466  STATUS      current
1467  DESCRIPTION
1468    "If true, the local OAM entity should send an Event
1469    Notification OAMPDU when an Errored Frame Seconds Event
1470    occurs.
1471
1472    By default, this object should have the value true for
1473    Ethernet like interfaces that support OAM.  If the OAM layer
1474    does not support event notifications (as indicated via the
1475    cdot3OamFunctionsSupported attribute), this value is ignored.
1476    "
1477  ::= { cdot3OamEventConfigEntry 14 }
1478
1479cdot3OamDyingGaspEnable OBJECT-TYPE
1480  SYNTAX      TruthValue
1481  MAX-ACCESS  read-write
1482  STATUS      current
1483  DESCRIPTION
1484    "If true, the local OAM entity should attempt to indicate a
1485    dying gasp via the OAMPDU flags field to its peer OAM entity
1486    when a dying gasp event occurs.  The exact definition of a
1487    dying gasp event is implementation dependent.  If the system
1488    does not support dying gasp capability, setting this object
1489    has no effect, and reading the object should always result in
1490    'false'.
1491
1492    By default, this object should have the value true for
1493    Ethernet like interfaces that support OAM.  If the OAM layer
1494    does not support event notifications (as indicated via the
1495    cdot3OamFunctionsSupported attribute), this value is ignored.
1496    "
1497  ::= { cdot3OamEventConfigEntry 15 }
1498
1499cdot3OamCriticalEventEnable OBJECT-TYPE
1500  SYNTAX      TruthValue
1501  MAX-ACCESS  read-write
1502  STATUS      current
1503  DESCRIPTION
1504    "If true, the local OAM entity should attempt to indicate a
1505    critical event via the OAMPDU flags to its peer OAM entity
1506    when a critical event occurs.   The exact definition of a
1507    critical event is implementation dependent.  If the system
1508    does not support critical event capability, setting this
1509    object has no effect, and reading the object should always
1510    result in 'false'.
1511
1512    By default, this object should have the value true for
1513    Ethernet like interfaces that support OAM.  If the OAM layer
1514    does not support event notifications (as indicated via the
1515    cdot3OamFunctionsSupported attribute), this value is ignored.
1516    "
1517  ::= { cdot3OamEventConfigEntry 16 }
1518
1519
1520-- **************************************************************
1521--
1522-- Ethernet OAM Event Log group
1523--
1524
1525
1526cdot3OamEventLogTable OBJECT-TYPE
1527  SYNTAX       SEQUENCE OF Cdot3OamEventLogEntry
1528  MAX-ACCESS   not-accessible
1529  STATUS       current
1530  DESCRIPTION
1531    "This table records a history of the events that have occurred
1532    at the Ethernet OAM level.  These events can include locally
1533    detected events, which may result in locally generated
1534    OAMPDUs, and remotely detected events, which are detected by
1535    the OAM peer entity and signaled to the local entity via
1536    Ethernet OAM.  Ethernet OAM events can be signaled by Event
1537    Notification OAMPDUs or by the flags field in any OAMPDU.
1538
1539    This table contains both threshold crossing events and
1540    non-threshold crossing events.  The parameters for the
1541    threshold window, threshold value, and actual value
1542    (cdot3OamEventLogWindowXX, cdot3OamEventLogThresholdXX,
1543    cdot3OamEventLogValue) are only applicable to threshold
1544    crossing events, and are returned as all F's (2^32 - 1) for
1545    non-threshold crossing events.
1546    Entries in the table are automatically created when such
1547    events are detected.  The size of the table is implementation
1548    dependent.  When the table reaches its maximum size, older
1549    entries are automatically deleted to make room for newer
1550    entries.
1551    "
1552    ::= { cdot3OamObjects 6 }
1553
1554cdot3OamEventLogEntry OBJECT-TYPE
1555  SYNTAX      Cdot3OamEventLogEntry
1556  MAX-ACCESS  not-accessible
1557  STATUS      current
1558  DESCRIPTION
1559    "An entry in the cdot3OamEventLogTable.  Entries are
1560    automatically created whenever Ethernet OAM events occur at
1561    the local OAM entity, and when Event Notification OAMPDUs are
1562    received at the local OAM entity (indicating events have
1563    occurred at the peer OAM entity).  The size of the table is
1564    implementation dependent, but when the table becomes full,
1565    older events are automatically deleted to make room for newer
1566    events.  The table index cdot3OamEventLogIndex increments for
1567    each new entry, and when the maximum value is reached the
1568    value restarts at zero.
1569    "
1570  INDEX       { ifIndex, cdot3OamEventLogIndex }
1571  ::= { cdot3OamEventLogTable 1 }
1572
1573Cdot3OamEventLogEntry ::=
1574  SEQUENCE {
1575    cdot3OamEventLogIndex                Unsigned32,
1576    cdot3OamEventLogTimestamp            TimeStamp,
1577    cdot3OamEventLogOui                  Cdot3Oui,
1578    cdot3OamEventLogType                 Unsigned32,
1579    cdot3OamEventLogLocation             INTEGER,
1580    cdot3OamEventLogWindowHi             Unsigned32,
1581    cdot3OamEventLogWindowLo             Unsigned32,
1582    cdot3OamEventLogThresholdHi          Unsigned32,
1583    cdot3OamEventLogThresholdLo          Unsigned32,
1584    cdot3OamEventLogValue                CounterBasedGauge64,
1585    cdot3OamEventLogRunningTotal         CounterBasedGauge64,
1586    cdot3OamEventLogEventTotal           Unsigned32
1587  }
1588
1589cdot3OamEventLogIndex       OBJECT-TYPE
1590  SYNTAX      Unsigned32
1591  MAX-ACCESS  not-accessible
1592  STATUS      current
1593  DESCRIPTION
1594    "An arbitrary integer for identifying individual events
1595    within the event log.  "
1596  ::= { cdot3OamEventLogEntry 1 }
1597
1598cdot3OamEventLogTimestamp  OBJECT-TYPE
1599  SYNTAX      TimeStamp
1600  MAX-ACCESS  read-only
1601  STATUS      current
1602  DESCRIPTION
1603    "The value of sysUpTime at the time of the logged event.  For
1604    locally generated events, the time of the event can be
1605    accurately retrieved from sysUpTime.  For remotely generated
1606    events, the time of the event is indicated by the reception of
1607    the Event Notification OAMPDU indicating the event occurred on
1608    the peer.  A system may attempt to adjust the timestamp value
1609    to more accurately reflect the time of the event at the peer
1610    OAM entity by using other information, such as that found in
1611    the timestamp found of the Event Notification TLVs, which
1612    provides an indication of the relative time between events at
1613    the peer entity.  "
1614  ::= { cdot3OamEventLogEntry 2 }
1615
1616cdot3OamEventLogOui  OBJECT-TYPE
1617  SYNTAX      Cdot3Oui
1618  MAX-ACCESS  read-only
1619  STATUS      current
1620  DESCRIPTION
1621    "The OUI of the entity defining the object type.  All IEEE
1622    802.3 defined events (as appearing in [802.3ah] except for the
1623    Organizationally Unique Event TLVs) use the IEEE 802.3 OUI of
1624    0x0180C2.  Organizations defining their own Event Notification
1625    TLVs include their OUI in the Event Notification TLV which
1626    gets reflected here.  "
1627  ::= { cdot3OamEventLogEntry 3 }
1628
1629
1630cdot3OamEventLogType      OBJECT-TYPE
1631  SYNTAX      Unsigned32
1632  MAX-ACCESS  read-only
1633  STATUS      current
1634  DESCRIPTION
1635    "The type of event that generated this entry in the event log.
1636
1637    When the OUI is the IEEE 802.3 OUI of 0x0180C2, the following
1638    event types are defined:
1639        erroredSymbolEvent(1),
1640        erroredFramePeriodEvent (2),
1641        erroredFrameEvent(3),
1642        erroredFrameSecondsEvent(4),
1643        linkFault(256),
1644        dyingGaspEvent(257),
1645        criticalLinkEvent(258)
1646    The first four are considered threshold crossing events as
1647    they are generated when a metric exceeds a given value within
1648    a specified window.  The other three are not threshold
1649    crossing events.
1650
1651    When the OUI is not 71874 (0x0180C2 in hex), then some other
1652    organization has defined the event space.  If event subtyping
1653    is known to the implementation, it may be reflected here.
1654    Otherwise, this value should return all Fs (2^32 - 1).
1655    "
1656  REFERENCE   "[802.3ah], 30.3.6.1.10 and 57.5.3."
1657  ::= { cdot3OamEventLogEntry 4 }
1658
1659cdot3OamEventLogLocation OBJECT-TYPE
1660  SYNTAX      INTEGER { local(1), remote(2) }
1661  MAX-ACCESS  read-only
1662  STATUS      current
1663  DESCRIPTION
1664    "Whether this event occurred locally (local(1)), or was
1665    received from the OAM peer via Ethernet OAM (remote(2)).
1666    "
1667  ::= { cdot3OamEventLogEntry 5 }
1668
1669cdot3OamEventLogWindowHi      OBJECT-TYPE
1670  SYNTAX      Unsigned32
1671  MAX-ACCESS  read-only
1672  STATUS      current
1673  DESCRIPTION
1674    "If the event represents a threshold crossing event, the two
1675    objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an
1676    unsigned 64-bit integer yielding the window over which the
1677    value was measured for the threshold crossing event (for
1678    example, 5, when 11 occurrences happened in 5 seconds while
1679    the threshold was 10).   The two objects are combined as:
1680
1681    cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)
1682                                    + cdot3OamEventLogWindowLo
1683
1684
1685    Otherwise, this value is returned as all F's (2^32 - 1) and
1686    adds no useful information.
1687    "
1688  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1689  ::= { cdot3OamEventLogEntry 6 }
1690
1691cdot3OamEventLogWindowLo      OBJECT-TYPE
1692  SYNTAX      Unsigned32
1693  MAX-ACCESS  read-only
1694  STATUS      current
1695  DESCRIPTION
1696    "If the event represents a threshold crossing event, the two
1697    objects cdot3OamEventWindowHi and cdot3OamEventWindowLo form an
1698    unsigned 64-bit integer yielding the window over which the
1699    value was measured for the threshold crossing event (for
1700    example, 5, when 11 occurrences happened in 5 seconds while
1701    the threshold was 10).   The two objects are combined as:
1702
1703    cdot3OamEventLogWindow = ((2^32) * cdot3OamEventLogWindowHi)
1704                                    + cdot3OamEventLogWindowLo
1705
1706    Otherwise, this value is returned as all F's (2^32 - 1) and
1707    adds no useful information.
1708    "
1709  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1710  ::= { cdot3OamEventLogEntry 7 }
1711
1712cdot3OamEventLogThresholdHi      OBJECT-TYPE
1713  SYNTAX      Unsigned32
1714  MAX-ACCESS  read-only
1715  STATUS      current
1716  DESCRIPTION
1717    "If the event represents a threshold crossing event, the two
1718    objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo
1719    form an unsigned 64-bit integer yielding the value that was
1720    crossed for the threshold crossing event (for example, 10,
1721    when 11 occurrences happened in 5 seconds while the threshold
1722    was 10).  The two objects are combined as:
1723
1724  cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)
1725                                     + cdot3OamEventLogThresholdLo
1726
1727    Otherwise, this value is returned as all F's (2^32 -1) and
1728    adds no useful information.
1729    "
1730  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1731  ::= { cdot3OamEventLogEntry 8 }
1732
1733cdot3OamEventLogThresholdLo      OBJECT-TYPE
1734  SYNTAX      Unsigned32
1735  MAX-ACCESS  read-only
1736  STATUS      current
1737  DESCRIPTION
1738    "If the event represents a threshold crossing event, the two
1739    objects cdot3OamEventThresholdHi and cdot3OamEventThresholdLo
1740    form an unsigned 64-bit integer yielding the value that was
1741    crossed for the threshold crossing event (for example, 10,
1742    when 11 occurrences happened in 5 seconds while the threshold
1743    was 10).  The two objects are combined as:
1744
1745  cdot3OamEventLogThreshold = ((2^32) * cdot3OamEventLogThresholdHi)
1746                                     + cdot3OamEventLogThresholdLo
1747
1748    Otherwise, this value is returned as all F's (2^32 - 1) and
1749    adds no useful information.
1750    "
1751  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1752  ::= { cdot3OamEventLogEntry 9 }
1753
1754cdot3OamEventLogValue      OBJECT-TYPE
1755  SYNTAX      CounterBasedGauge64
1756  MAX-ACCESS  read-only
1757  STATUS      current
1758  DESCRIPTION
1759    "If the event represents a threshold crossing event, this
1760    value indicates the value of the parameter within the given
1761    window that generated this event (for example, 11, when 11
1762    occurrences happened in 5 seconds while the threshold was 10).
1763
1764    Otherwise, this value is returned as all F's
1765    (2^64 - 1) and adds no useful information.
1766    "
1767  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1768  ::= { cdot3OamEventLogEntry 10 }
1769
1770cdot3OamEventLogRunningTotal      OBJECT-TYPE
1771  SYNTAX      CounterBasedGauge64
1772  MAX-ACCESS  read-only
1773  STATUS      current
1774  DESCRIPTION
1775    "Each Event Notification TLV contains a running total of the
1776    number of times an event has occurred, as well as the number
1777    of times an Event Notification for the event has been
1778    transmitted.  For non-threshold crossing events, the number of
1779    events (cdot3OamLogRunningTotal) and the number of resultant
1780    Event Notifications (cdot3OamLogEventTotal) should be
1781    identical.
1782
1783    For threshold crossing events, since multiple occurrences may
1784    be required to cross the threshold, these values are likely
1785    different.  This value represents the total number of times
1786    this event has happened since the last reset (for example,
1787    3253, when 3253 symbol errors have occurred since the last
1788    reset, which has resulted in 51 symbol error threshold
1789    crossing events since the last reset).
1790    "
1791  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1792  ::= { cdot3OamEventLogEntry 11 }
1793
1794cdot3OamEventLogEventTotal      OBJECT-TYPE
1795  SYNTAX      Unsigned32
1796  MAX-ACCESS  read-only
1797  STATUS      current
1798  DESCRIPTION
1799    "Each Event Notification TLV contains a running total of the
1800    number of times an event has occurred, as well as the number
1801    of times an Event Notification for the event has been
1802    transmitted.  For non-threshold crossing events, the number of
1803    events (cdot3OamLogRunningTotal) and the number of resultant
1804    Event Notifications (cdot3OamLogEventTotal) should be
1805    identical.
1806
1807    For threshold crossing events, since multiple occurrences may
1808    be required to cross the threshold, these values are likely
1809    different.  This value represents the total number of times
1810    one or more of these occurrences have resulted in an Event
1811    Notification (for example, 51 when 3253 symbol errors have
1812    occurred since the last reset, which has resulted in 51 symbol
1813    error threshold crossing events since the last reset).
1814    "
1815  REFERENCE   "[802.3ah], 30.3.6.1.37 and 57.5.3.2."
1816  ::= { cdot3OamEventLogEntry 12 }
1817
1818
1819-- ***************************************************************
1820--
1821-- Ethernet OAM Notifications
1822--
1823
1824
1825cdot3OamThresholdEvent NOTIFICATION-TYPE
1826  OBJECTS { cdot3OamEventLogTimestamp,
1827            cdot3OamEventLogOui,
1828            cdot3OamEventLogType,
1829            cdot3OamEventLogLocation,
1830            cdot3OamEventLogWindowHi,
1831            cdot3OamEventLogWindowLo,
1832            cdot3OamEventLogThresholdHi,
1833            cdot3OamEventLogThresholdLo,
1834            cdot3OamEventLogValue,
1835            cdot3OamEventLogRunningTotal,
1836            cdot3OamEventLogEventTotal
1837          }
1838  STATUS  current
1839
1840  DESCRIPTION
1841    "A cdot3OamThresholdEvent notification is sent when a local or
1842    remote threshold crossing event is detected.  A local
1843    threshold crossing event is detected by the local entity,
1844    while a remote threshold crossing event is detected by the
1845    reception of an Ethernet OAM Event Notification OAMPDU
1846    indicating a threshold event.
1847
1848    This notification should not be sent more than once per
1849    second.
1850
1851    The OAM entity can be derived from extracting the ifIndex from
1852    the variable bindings.  The objects in the notification
1853    correspond to the values in a row instance of in the
1854    cdot3OamEventLogTable.
1855
1856    The management entity should periodically check
1857    cdot3OamEventLogTable to detect any missed events."
1858 ::= { cdot3OamNotifications 1 }
1859
1860
1861cdot3OamNonThresholdEvent NOTIFICATION-TYPE
1862  OBJECTS { cdot3OamEventLogTimestamp,
1863            cdot3OamEventLogOui,
1864            cdot3OamEventLogType,
1865            cdot3OamEventLogLocation,
1866            cdot3OamEventLogEventTotal
1867          }
1868  STATUS  current
1869  DESCRIPTION
1870    "A cdot3OamNonThresholdEvent notification is sent when a local
1871    or remote non-threshold crossing event is detected.  A local
1872    event is detected by the local entity, while a remote event is
1873    detected by the reception of an Ethernet OAM Event
1874    Notification OAMPDU indicating a non-threshold crossing event.
1875
1876    This notification should not be sent more than once per
1877    second.
1878
1879    The OAM entity can be derived from extracting the ifIndex from
1880    the variable bindings.  The objects in the notification
1881    correspond to the values in a row instance of the
1882    cdot3OamEventLogTable.
1883
1884    The management entity should periodically check
1885    cdot3OamEventLogTable to detect any missed events."
1886 ::= { cdot3OamNotifications 2 }
1887
1888
1889-- ***************************************************************
1890--
1891-- Ethernet OAM Compliance group
1892--
1893
1894
1895cdot3OamGroups OBJECT IDENTIFIER ::= { cdot3OamConformance 1 }
1896cdot3OamCompliances OBJECT IDENTIFIER ::= { cdot3OamConformance 2 }
1897
1898-- Compliance statements
1899
1900cdot3OamCompliance MODULE-COMPLIANCE
1901  STATUS          current
1902  DESCRIPTION "The compliance statement for managed entities
1903               supporting OAM on Ethernet like interfaces.
1904               "
1905  MODULE   -- this module
1906      MANDATORY-GROUPS { cdot3OamControlGroup,
1907                         cdot3OamPeerGroup,
1908                         cdot3OamStatsBaseGroup
1909                       }
1910
1911  GROUP       cdot3OamLoopbackGroup
1912  DESCRIPTION
1913    "This group is mandatory for all IEEE 802.3 OAM
1914    implementations that support loopback functionality. "
1915
1916  GROUP       cdot3OamErrSymbolPeriodEventGroup
1917  DESCRIPTION
1918    "This group is mandatory for all IEEE 802.3 OAM
1919    implementations that support event functionality. "
1920
1921  GROUP       cdot3OamErrFramePeriodEventGroup
1922  DESCRIPTION
1923    "This group is mandatory for all IEEE 802.3 OAM
1924    implementations that support event functionality. "
1925
1926  GROUP       cdot3OamErrFrameEventGroup
1927  DESCRIPTION
1928    "This group is mandatory for all IEEE 802.3 OAM
1929    implementations that support event functionality. "
1930
1931  GROUP       cdot3OamErrFrameSecsSummaryEventGroup
1932  DESCRIPTION
1933    "This group is mandatory for all IEEE 802.3 OAM
1934    implementations that support event functionality. "
1935
1936  GROUP        cdot3OamFlagEventGroup
1937  DESCRIPTION
1938    "This group is optional for all IEEE 802.3 OAM
1939    implementations.  The ability to send critical events or dying
1940    gasp events is not required in any system."
1941
1942  GROUP       cdot3OamEventLogGroup
1943  DESCRIPTION
1944    "This group is optional for all IEEE 802.3 OAM
1945    implementations. Entries in this table are dependent on what
1946    event functionality is supported in the local OAM
1947    implementation.  At least one type of event must be supported
1948    for entries to appear in this table. "
1949
1950  GROUP       cdot3OamNotificationGroup
1951  DESCRIPTION
1952    "This group is optional for all IEEE 802.3 OAM
1953    implementations.  Since the information in the notifications
1954    is dependent on the cdot3OamEventLogTable, that table must be
1955    implemented for notifications.  "
1956
1957  ::= { cdot3OamCompliances 1}
1958
1959
1960cdot3OamControlGroup OBJECT-GROUP
1961   OBJECTS     {   cdot3OamAdminState,
1962                   cdot3OamOperStatus,
1963                   cdot3OamMode,
1964                   cdot3OamMaxOamPduSize,
1965                   cdot3OamConfigRevision,
1966                   cdot3OamFunctionsSupported
1967               }
1968   STATUS      current
1969   DESCRIPTION
1970     "A collection of objects providing the abilities,
1971     configuration, and status of an Ethernet OAM entity.  "
1972   ::= { cdot3OamGroups 1 }
1973
1974cdot3OamPeerGroup OBJECT-GROUP
1975   OBJECTS     {   cdot3OamPeerMacAddress,
1976                   cdot3OamPeerVendorOui,
1977                   cdot3OamPeerVendorInfo,
1978                   cdot3OamPeerMode,
1979                   cdot3OamPeerFunctionsSupported,
1980                   cdot3OamPeerMaxOamPduSize,
1981                   cdot3OamPeerConfigRevision
1982               }
1983   STATUS      current
1984   DESCRIPTION
1985     "A collection of objects providing the abilities,
1986     configuration, and status of a peer Ethernet OAM entity.  "
1987   ::= { cdot3OamGroups 2 }
1988
1989cdot3OamStatsBaseGroup OBJECT-GROUP
1990   OBJECTS     {   cdot3OamInformationTx,
1991                   cdot3OamInformationRx,
1992                   cdot3OamUniqueEventNotificationTx,
1993                   cdot3OamUniqueEventNotificationRx,
1994                   cdot3OamDuplicateEventNotificationTx,
1995                   cdot3OamDuplicateEventNotificationRx,
1996                   cdot3OamLoopbackControlTx,
1997                   cdot3OamLoopbackControlRx,
1998                   cdot3OamVariableRequestTx,
1999                   cdot3OamVariableRequestRx,
2000                   cdot3OamVariableResponseTx,
2001                   cdot3OamVariableResponseRx,
2002                   cdot3OamOrgSpecificTx,
2003                   cdot3OamOrgSpecificRx,
2004                   cdot3OamUnsupportedCodesTx,
2005                   cdot3OamUnsupportedCodesRx,
2006                   cdot3OamFramesLostDueToOam
2007               }
2008   STATUS      current
2009   DESCRIPTION
2010     "A collection of objects providing the statistics for the
2011     number of various transmit and receive events for OAM on an
2012     Ethernet like interface.  Note that all of these counters must
2013     be supported even if the related function (as described in
2014     cdot3OamFunctionsSupported) is not supported.  "
2015   ::= { cdot3OamGroups 3 }
2016
2017cdot3OamLoopbackGroup OBJECT-GROUP
2018   OBJECTS     {   cdot3OamLoopbackStatus,
2019                   cdot3OamLoopbackIgnoreRx
2020               }
2021   STATUS      current
2022   DESCRIPTION
2023     "A collection of objects for controlling the OAM remote
2024     loopback function.  "
2025   ::= { cdot3OamGroups 4 }
2026
2027cdot3OamErrSymbolPeriodEventGroup OBJECT-GROUP
2028   OBJECTS     {   cdot3OamErrSymPeriodWindowHi,
2029                   cdot3OamErrSymPeriodWindowLo,
2030                   cdot3OamErrSymPeriodThresholdHi,
2031                   cdot3OamErrSymPeriodThresholdLo,
2032                   cdot3OamErrSymPeriodEvNotifEnable
2033               }
2034   STATUS      current
2035   DESCRIPTION
2036     "A collection of objects for configuring the thresholds for an
2037     Errored Symbol Period Event.
2038
2039     Each [802.3ah] defined Event Notification TLV has its own
2040     conformance group because each event can be implemented
2041     independently of any other.  "
2042   ::= { cdot3OamGroups 5 }
2043
2044cdot3OamErrFramePeriodEventGroup OBJECT-GROUP
2045   OBJECTS     {   cdot3OamErrFramePeriodWindow,
2046                   cdot3OamErrFramePeriodThreshold,
2047                   cdot3OamErrFramePeriodEvNotifEnable
2048               }
2049   STATUS      current
2050   DESCRIPTION
2051     "A collection of objects for configuring the thresholds for an
2052     Errored Frame Period Event.
2053
2054     Each [802.3ah] defined Event Notification TLV has its own
2055     conformance group because each event can be implemented
2056     independently of any other.  "
2057   ::= { cdot3OamGroups 6 }
2058
2059cdot3OamErrFrameEventGroup OBJECT-GROUP
2060   OBJECTS     {   cdot3OamErrFrameWindow,
2061                   cdot3OamErrFrameThreshold,
2062                   cdot3OamErrFrameEvNotifEnable
2063               }
2064   STATUS      current
2065   DESCRIPTION
2066     "A collection of objects for configuring the thresholds for an
2067     Errored Frame Event.
2068
2069     Each [802.3ah] defined Event Notification TLV has its own
2070     conformance group because each event can be implemented
2071     independently of any other.  "
2072   ::= { cdot3OamGroups 7 }
2073
2074cdot3OamErrFrameSecsSummaryEventGroup OBJECT-GROUP
2075   OBJECTS     {   cdot3OamErrFrameSecsSummaryWindow,
2076                   cdot3OamErrFrameSecsSummaryThreshold,
2077                   cdot3OamErrFrameSecsEvNotifEnable
2078               }
2079   STATUS      current
2080   DESCRIPTION
2081     "A collection of objects for configuring the thresholds for an
2082     Errored Frame Seconds Summary Event.
2083
2084     Each [802.3ah] defined Event Notification TLV has its own
2085     conformance group because each event can be implemented
2086     independently of any other.  "
2087   ::= { cdot3OamGroups 8 }
2088
2089cdot3OamFlagEventGroup OBJECT-GROUP
2090   OBJECTS     {   cdot3OamDyingGaspEnable,
2091                   cdot3OamCriticalEventEnable
2092               }
2093   STATUS      current
2094   DESCRIPTION
2095     "A collection of objects for configuring the sending OAMPDUs
2096     with the critical event flag or dying gasp flag enabled.  "
2097   ::= { cdot3OamGroups 9 }
2098
2099cdot3OamEventLogGroup OBJECT-GROUP
2100  OBJECTS {  cdot3OamEventLogTimestamp,
2101             cdot3OamEventLogOui,
2102             cdot3OamEventLogType,
2103             cdot3OamEventLogLocation,
2104             cdot3OamEventLogWindowHi,
2105             cdot3OamEventLogWindowLo,
2106             cdot3OamEventLogThresholdHi,
2107             cdot3OamEventLogThresholdLo,
2108             cdot3OamEventLogValue,
2109             cdot3OamEventLogRunningTotal,
2110             cdot3OamEventLogEventTotal
2111           }
2112  STATUS      current
2113  DESCRIPTION
2114     "A collection of objects for configuring the thresholds for an
2115     Errored Frame Seconds Summary Event and maintaining the event
2116     information.  "
2117   ::= { cdot3OamGroups 10 }
2118
2119cdot3OamNotificationGroup NOTIFICATION-GROUP
2120  NOTIFICATIONS {
2121              cdot3OamThresholdEvent,
2122              cdot3OamNonThresholdEvent
2123                }
2124  STATUS      current
2125  DESCRIPTION
2126    "A collection of notifications used by Ethernet OAM to signal
2127    to a management entity that local or remote events have
2128    occurred on a specified Ethernet link. "
2129  ::= { cdot3OamGroups 11 }
2130
2131
2132END
2133
2134
2135