module ieee802-ethernet-link-oam {

    yang-version 1.1;

    namespace
      "urn:ieee:std:802.3:yang:ieee802-ethernet-link-oam";

    prefix ieee802-link-oam;

    import ietf-yang-types {
      prefix yang;
      reference
        "IETF RFC 6991";


    }
    import iana-if-type {
      prefix ianaift;
      reference
        "http://www.iana.org/assignments/yang-parameters/
        iana-if-type@2018-07-03.yang";


    }
    import ietf-interfaces {
      prefix if;
      reference
        "IETF RFC 8343";


    }

    organization
      "IEEE 802.3 Ethernet Working Group
     Web URL: http://www.ieee802.org/3/";

    contact
      "Web URL: http://www.ieee802.org/3/";

    description
      "This module contains a collection of YANG definitions
     for managing the Ethernet Link OAM feature defined by IEEE
     802.3. It provides functionality roughly equivalent to that of
     the DOT3-OAM-MIB defined in IETF RFC 4878.";

    revision "2019-06-21" {
      description "Initial revision.";
      reference
        "IEEE Std 802.3-2018, unless dated explicitly";

    }


    feature uni-directional-link-fault {
      description
        "This feature means the device supports Uni Directional Link
       Fault detection.";
      reference
        "IEEE Std 802.3, 57.1.2:a, 30.3.6.1.6 aOAMLocalConfiguration and
        30.3.6.1.7 aOAMRemoteConfiguration";

    }

    feature remote-loopback-initiate {
      description
        "This feature means the device supports being the initiator 
       of remote loopback.";
      reference
        "IEEE Std 802.3, 57.1.2:b, 30.3.6.1.6 aOAMLocalConfiguration";

    }

    feature remote-loopback-respond {
      description
        "This feature means the device supports responding to remote 
       loopback control OAMPDUs received from the peer";
      reference
        "IEEE Std 802.3, 57.1.2:b, 30.3.6.1.7 aOAMRemoteConfiguration";

    }

    feature link-monitoring-local {
      description
        "This feature means the device monitors the link at the local 
       side and can generate Link Event OAMPDUs to the peer device.";
      reference
        "IEEE Std 802.3, 57.1.2:c:1, 30.3.6.1.6 aOAMLocalConfiguration, 
        and 30.3.6.1.7 aOAMRemoteConfiguration";

    }

    feature link-monitoring-remote {
      description
        "This feature means the device can process Link Event OAMPDUs 
       received from the peer device and report itself about this 
       event on its own management interface.";
      reference
        "IEEE Std 802.3, 57.1.2:c:1, 30.3.6.1.6 aOAMLocalConfiguration, 
        and 30.3.6.1.7 aOAMRemoteConfiguration";

    }

    feature remote-mib-retrieval-initiate {
      description
        "This feature means the device supports data retrieval from 
       the peer device. I.e. the device can send Variable Requests 
       OAMPDUs to the peer side and process the received Variable 
       Response OAMPDUs.";
      reference
        "IEEE Std 802.3, 57.1.2:c:2, 30.3.6.1.6 aOAMLocalConfiguration, 
        and 30.3.6.1.7 aOAMRemoteConfiguration";

    }

    feature remote-mib-retrieval-respond {
      description
        "This feature means the device allows the peer device to 
       retrieve data from the managed device. I.e. the device can 
       process received Variable Requests OAMPDUs and respond with 
       Variable Response OAMPDUs.";
      reference
        "IEEE Std 802.3, 57.1.2:c:2, 30.3.6.1.6 aOAMLocalConfiguration, 
        and 30.3.6.1.7 aOAMRemoteConfiguration";

    }

    typedef threshold-event-enum {
      type enumeration {
        enum "symbol-period-event" {
          value 1;
          description
            "Errored symbol period event.";
        }
        enum "frame-period-event" {
          value 2;
          description
            "Errored frame period event.";
        }
        enum "frame-event" {
          value 3;
          description "Errored frame event";
        }
        enum "frame-seconds-event" {
          value 4;
          description
            "Errored frame seconds event.";
        }
      }
      description
        "Enumeration of the valid threshold event types.";
      reference
        "IEEE Std 802.3, 57.5.3";

    }

    identity event-type {
      description
        "Base identity for all Link OAM event types.";
    }

    identity threshold-event-type {
      base event-type;
      description
        "Event type for a Link Monitoring threshold event.";
    }

    identity link-fault-event {
      base event-type;
      description
        "Event type for a uni-directional link fault event.";
      reference
        "IEEE Std 802.3, 57.2.10.1";

    }

    identity dying-gasp-event {
      base event-type;
      description
        "Event type for a dying gasp event.";
      reference
        "IEEE Std 802.3, 57.2.10.1";

    }

    identity critical-event {
      base event-type;
      description
        "Event type for a critical event.";
      reference
        "IEEE Std 802.3, 57.2.10.1";

    }

    typedef mode {
      type enumeration {
        enum "passive" {
          value 0;
          description
            "Ethernet Link OAM Passive mode.";
        }
        enum "active" {
          value 1;
          description
            "Ethernet Link OAM Active mode.";
        }
      }
      description
        "Enumeration of the valid modes in which Link OAM may run.";
      reference
        "IEEE Std 802.3, 57.2.9 and 30.3.6.1.3.";

    }

    typedef event-location {
      type enumeration {
        enum "event-location-local" {
          value 1;
          description "A local event.";
        }
        enum "event-location-remote" {
          value 2;
          description "A remote event.";
        }
      }
      description
        "The location of the event that caused a log entry.";
    }

    typedef loopback-status {
      type enumeration {
        enum "none" {
          value 1;
          description
            "Loopback is not being performed.";
        }
        enum "initiating" {
          value 2;
          description
            "Initiating master loopback.";
        }
        enum "master-loopback" {
          value 3;
          description
            "In master loopback mode.";
        }
        enum "terminating" {
          value 4;
          description
            "Terminating master loopback mode.";
        }
        enum "local-loopback" {
          value 5;
          description
            "In slave loopback mode.";
        }
        enum "unknown" {
          value 6;
          description
            "Parser and multiplexer combination unexpected.";
        }
      }
      description
        "The loopback mode of an OAM interface.";
      reference
        "IEEE Std 802.3, 57.2.11";

    }

    typedef operational-state {
      type enumeration {
        enum "disabled" {
          value 1;
          description
            "IEEE Std 802.3 OAM is disabled.";
        }
        enum "link-fault" {
          value 2;
          description
            "IEEE Std 802.3 OAM has encountered a link fault.";
        }
        enum "passive-wait" {
          value 3;
          description
            "Passive OAM entity waiting to see if peer is
           OAM capable.";
        }
        enum "active-send-local" {
          value 4;
          description
            "Active OAM entity trying to determine if peer
           is OAM capable.";
        }
        enum "send-local-and-remote" {
          value 5;
          description
            "OAM discovered peer but still to accept or
           reject peer configuration.";
        }
        enum "send-local-and-remote-ok" {
          value 6;
          description
            "OAM peering is allowed by local device.";
        }
        enum "peering-locally-rejected" {
          value 7;
          description
            "OAM peering rejected by local device.";
        }
        enum "peering-remotely-rejected" {
          value 8;
          description
            "OAM peering rejected by remote device.";
        }
        enum "operational" {
          value 9;
          description
            "IEEE Std 802.3 OAM is operational.";
        }
        enum "operational-half-duplex" {
          value 10;
          description
            "IEEE Std 802.3 OAM is operating in half-duplex mode.";
        }
      }
      description
        "Operational state of an interface.";
      reference
        "IETF RFC 4878, dot3OamOperStatus; IEEE Std 802.3, 30.3.6.1.4,
        30.3.6.1.10, and 30.3.6.1.11";

    }

    typedef vendor-oui {
      type string {
        length "6";
      }
      description
        "24-bit Organizationally Unique Identifier.";
      reference
        "IEEE Std 802-2014, Clause 9";

    }

    typedef admin-state {
      type enumeration {
        enum "enabled" {
          value 1;
          description
            "IEEE Std 802.3, Clause 57 OAM is in the 
           enabled admin state.";
        }
        enum "disabled" {
          value 2;
          description
            "IEEE Std 802.3, Clause 57 OAM is in the 
           disabled admin state.";
        }
      }
      description
        "Admin state of the OAM function on an interface.";
      reference
        "IEEE Std 802.3, 30.3.6.1.2 and 30.3.6.2";

    }
  }  // module ieee802-ethernet-link-oam