Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.ethernet.rev210609

Interface EthernetInterfaceStateCounters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Counters
    @Generated("mdsal-binding-generator")
public interface EthernetInterfaceStateCounters
extends org.opendaylight.yangtools.yang.binding.DataObject
    Ethernet-specific counters and statistics

    This class represents the following YANG schema fragment defined in module openconfig-if-ethernet 

     grouping ethernet-interface-state-counters {
   leaf in-mac-control-frames {
     type oc-yang:counter64;
   }
   leaf in-mac-pause-frames {
     type oc-yang:counter64;
   }
   leaf in-oversize-frames {
     type oc-yang:counter64;
   }
   leaf in-undersize-frames {
     type oc-yang:counter64;
   }
   leaf in-jabber-frames {
     type oc-yang:counter64;
   }
   leaf in-fragment-frames {
     type oc-yang:counter64;
   }
   leaf in-8021q-frames {
     type oc-yang:counter64;
   }
   leaf in-crc-errors {
     type oc-yang:counter64;
   }
   leaf in-block-errors {
     type oc-yang:counter64;
   }
   leaf in-carrier-errors {
     type oc-yang:counter64;
   }
   leaf in-interrupted-tx {
     type oc-yang:counter64;
   }
   leaf in-late-collision {
     type oc-yang:counter64;
   }
   leaf in-mac-errors-rx {
     type oc-yang:counter64;
   }
   leaf in-single-collision {
     type oc-yang:counter64;
   }
   leaf in-symbol-error {
     type oc-yang:counter64;
   }
   leaf in-maxsize-exceeded {
     type oc-yang:counter64;
   }
   leaf out-mac-control-frames {
     type oc-yang:counter64;
   }
   leaf out-mac-pause-frames {
     type oc-yang:counter64;
   }
   leaf out-8021q-frames {
     type oc-yang:counter64;
   }
   leaf out-mac-errors-tx {
     type oc-yang:counter64;
   }
 }
    The schema path to identify an instance is openconfig-if-ethernetethernet-interface-state-counters

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        Class<? extends EthernetInterfaceStateCounters> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getInMacControlFrames

        Counter64 getInMacControlFrames()
        Return inMacControlFrames, or null if it is not present. 
             
         MAC layer control frames received on the interface
        Returns:
        Counter64 inMacControlFrames, or null if it is not present.

      • requireInMacControlFrames

        default @NonNull Counter64 requireInMacControlFrames()
        Return inMacControlFrames, guaranteed to be non-null. 
             
         MAC layer control frames received on the interface
        Returns:
        Counter64 inMacControlFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inMacControlFrames is not present

      • getInMacPauseFrames

        Counter64 getInMacPauseFrames()
        Return inMacPauseFrames, or null if it is not present. 
             
         MAC layer PAUSE frames received on the interface
        Returns:
        Counter64 inMacPauseFrames, or null if it is not present.

      • requireInMacPauseFrames

        default @NonNull Counter64 requireInMacPauseFrames()
        Return inMacPauseFrames, guaranteed to be non-null. 
             
         MAC layer PAUSE frames received on the interface
        Returns:
        Counter64 inMacPauseFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inMacPauseFrames is not present

      • getInOversizeFrames

        Counter64 getInOversizeFrames()
        Return inOversizeFrames, or null if it is not present. 
             
         The total number of frames received that were longer than 1518 octets (excluding
         framing bits, but including FCS octets) and were otherwise well formed.
        Returns:
        Counter64 inOversizeFrames, or null if it is not present.

      • requireInOversizeFrames

        default @NonNull Counter64 requireInOversizeFrames()
        Return inOversizeFrames, guaranteed to be non-null. 
             
         The total number of frames received that were longer than 1518 octets (excluding
         framing bits, but including FCS octets) and were otherwise well formed.
        Returns:
        Counter64 inOversizeFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inOversizeFrames is not present

      • getInUndersizeFrames

        Counter64 getInUndersizeFrames()
        Return inUndersizeFrames, or null if it is not present. 
             
         The total number of frames received that were less than 64 octets long
         (excluding framing bits, but including FCS octets) and were otherwise well
         formed.
        Returns:
        Counter64 inUndersizeFrames, or null if it is not present.

      • requireInUndersizeFrames

        default @NonNull Counter64 requireInUndersizeFrames()
        Return inUndersizeFrames, guaranteed to be non-null. 
             
         The total number of frames received that were less than 64 octets long
         (excluding framing bits, but including FCS octets) and were otherwise well
         formed.
        Returns:
        Counter64 inUndersizeFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inUndersizeFrames is not present

      • getInJabberFrames

        Counter64 getInJabberFrames()
        Return inJabberFrames, or null if it is not present. 
             
         Number of jabber frames received on the interface. Jabber frames are typically
         defined as oversize frames which also have a bad CRC. Implementations may use
         slightly different definitions of what constitutes a jabber frame. Often
         indicative of a NIC hardware problem.
        Returns:
        Counter64 inJabberFrames, or null if it is not present.

      • requireInJabberFrames

        default @NonNull Counter64 requireInJabberFrames()
        Return inJabberFrames, guaranteed to be non-null. 
             
         Number of jabber frames received on the interface. Jabber frames are typically
         defined as oversize frames which also have a bad CRC. Implementations may use
         slightly different definitions of what constitutes a jabber frame. Often
         indicative of a NIC hardware problem.
        Returns:
        Counter64 inJabberFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inJabberFrames is not present

      • getInFragmentFrames

        Counter64 getInFragmentFrames()
        Return inFragmentFrames, or null if it is not present. 
             
         The total number of frames received that were less than 64 octets in length
         (excluding framing bits but including FCS octets) and had either a bad Frame
         Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS
         with a non-integral number of octets (Alignment Error).
        Returns:
        Counter64 inFragmentFrames, or null if it is not present.

      • requireInFragmentFrames

        default @NonNull Counter64 requireInFragmentFrames()
        Return inFragmentFrames, guaranteed to be non-null. 
             
         The total number of frames received that were less than 64 octets in length
         (excluding framing bits but including FCS octets) and had either a bad Frame
         Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS
         with a non-integral number of octets (Alignment Error).
        Returns:
        Counter64 inFragmentFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inFragmentFrames is not present

      • getIn8021qFrames

        Counter64 getIn8021qFrames()
        Return in8021qFrames, or null if it is not present. 
             
         Number of 802.1q tagged frames received on the interface
        Returns:
        Counter64 in8021qFrames, or null if it is not present.

      • requireIn8021qFrames

        default @NonNull Counter64 requireIn8021qFrames()
        Return in8021qFrames, guaranteed to be non-null. 
             
         Number of 802.1q tagged frames received on the interface
        Returns:
        Counter64 in8021qFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if in8021qFrames is not present

      • getInCrcErrors

        Counter64 getInCrcErrors()
        Return inCrcErrors, or null if it is not present. 
             
         The total number of frames received that had a length (excluding framing bits,
         but including FCS octets) of between 64 and 1518 octets, inclusive, but had
         either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS
         Error) or a bad FCS with a non-integral number of octets (Alignment Error)
        Returns:
        Counter64 inCrcErrors, or null if it is not present.

      • requireInCrcErrors

        default @NonNull Counter64 requireInCrcErrors()
        Return inCrcErrors, guaranteed to be non-null. 
             
         The total number of frames received that had a length (excluding framing bits,
         but including FCS octets) of between 64 and 1518 octets, inclusive, but had
         either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS
         Error) or a bad FCS with a non-integral number of octets (Alignment Error)
        Returns:
        Counter64 inCrcErrors, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inCrcErrors is not present

      • getInBlockErrors

        Counter64 getInBlockErrors()
        Return inBlockErrors, or null if it is not present. 
             
         The number of received errored blocks. Error detection codes are capable of
         detecting whether one or more errors have occurred in a given sequence of bits –
         the block. It is normally not possible to determine the exact number of errored
         bits within the block
        Returns:
        Counter64 inBlockErrors, or null if it is not present.

      • requireInBlockErrors

        default @NonNull Counter64 requireInBlockErrors()
        Return inBlockErrors, guaranteed to be non-null. 
             
         The number of received errored blocks. Error detection codes are capable of
         detecting whether one or more errors have occurred in a given sequence of bits –
         the block. It is normally not possible to determine the exact number of errored
         bits within the block
        Returns:
        Counter64 inBlockErrors, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inBlockErrors is not present

      • getInCarrierErrors

        Counter64 getInCarrierErrors()
        Return inCarrierErrors, or null if it is not present. 
             
         The number of received errored frames due to a carrier issue. The value refers
         to MIB counter for dot3StatsCarrierSenseErrors oid=1.3.6.1.2.1.10.7.2.1.11
        Returns:
        Counter64 inCarrierErrors, or null if it is not present.

      • requireInCarrierErrors

        default @NonNull Counter64 requireInCarrierErrors()
        Return inCarrierErrors, guaranteed to be non-null. 
             
         The number of received errored frames due to a carrier issue. The value refers
         to MIB counter for dot3StatsCarrierSenseErrors oid=1.3.6.1.2.1.10.7.2.1.11
        Returns:
        Counter64 inCarrierErrors, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inCarrierErrors is not present

      • getInInterruptedTx

        Counter64 getInInterruptedTx()
        Return inInterruptedTx, or null if it is not present. 
             
         The number of received errored frames due to interrupted transmission issue. The
         value refers to MIB counter for dot3StatsDeferredTransmissions
         oid=1.3.6.1.2.1.10.7.2.1.7
        Returns:
        Counter64 inInterruptedTx, or null if it is not present.

      • requireInInterruptedTx

        default @NonNull Counter64 requireInInterruptedTx()
        Return inInterruptedTx, guaranteed to be non-null. 
             
         The number of received errored frames due to interrupted transmission issue. The
         value refers to MIB counter for dot3StatsDeferredTransmissions
         oid=1.3.6.1.2.1.10.7.2.1.7
        Returns:
        Counter64 inInterruptedTx, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inInterruptedTx is not present

      • getInLateCollision

        Counter64 getInLateCollision()
        Return inLateCollision, or null if it is not present. 
             
         The number of received errored frames due to late collision issue. The value
         refers to MIB counter for dot3StatsLateCollisions oid=1.3.6.1.2.1.10.7.2.1.8
        Returns:
        Counter64 inLateCollision, or null if it is not present.

      • requireInLateCollision

        default @NonNull Counter64 requireInLateCollision()
        Return inLateCollision, guaranteed to be non-null. 
             
         The number of received errored frames due to late collision issue. The value
         refers to MIB counter for dot3StatsLateCollisions oid=1.3.6.1.2.1.10.7.2.1.8
        Returns:
        Counter64 inLateCollision, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inLateCollision is not present

      • getInMacErrorsRx

        Counter64 getInMacErrorsRx()
        Return inMacErrorsRx, or null if it is not present. 
             
         The number of received errored frames due to MAC errors received. The value
         refers to MIB counter for dot3StatsInternalMacReceiveErrors
         oid=1.3.6.1.2.1.10.7.2.1.16
        Returns:
        Counter64 inMacErrorsRx, or null if it is not present.

      • requireInMacErrorsRx

        default @NonNull Counter64 requireInMacErrorsRx()
        Return inMacErrorsRx, guaranteed to be non-null. 
             
         The number of received errored frames due to MAC errors received. The value
         refers to MIB counter for dot3StatsInternalMacReceiveErrors
         oid=1.3.6.1.2.1.10.7.2.1.16
        Returns:
        Counter64 inMacErrorsRx, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inMacErrorsRx is not present

      • getInSingleCollision

        Counter64 getInSingleCollision()
        Return inSingleCollision, or null if it is not present. 
             
         The number of received errored frames due to single collision issue. The value
         refers to MIB counter for dot3StatsSingleCollisionFrames
         oid=1.3.6.1.2.1.10.7.2.1.4
        Returns:
        Counter64 inSingleCollision, or null if it is not present.

      • requireInSingleCollision

        default @NonNull Counter64 requireInSingleCollision()
        Return inSingleCollision, guaranteed to be non-null. 
             
         The number of received errored frames due to single collision issue. The value
         refers to MIB counter for dot3StatsSingleCollisionFrames
         oid=1.3.6.1.2.1.10.7.2.1.4
        Returns:
        Counter64 inSingleCollision, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inSingleCollision is not present

      • getInSymbolError

        Counter64 getInSymbolError()
        Return inSymbolError, or null if it is not present. 
             
         The number of received errored frames due to symbol error. The value refers to
         MIB counter for in-symbol-error oid=1.3.6.1.2.1.10.7.2.1.18
        Returns:
        Counter64 inSymbolError, or null if it is not present.

      • requireInSymbolError

        default @NonNull Counter64 requireInSymbolError()
        Return inSymbolError, guaranteed to be non-null. 
             
         The number of received errored frames due to symbol error. The value refers to
         MIB counter for in-symbol-error oid=1.3.6.1.2.1.10.7.2.1.18
        Returns:
        Counter64 inSymbolError, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inSymbolError is not present

      • getInMaxsizeExceeded

        Counter64 getInMaxsizeExceeded()
        Return inMaxsizeExceeded, or null if it is not present. 
             
         The total number frames received that are well-formed but dropped due to
         exceeding the maximum frame size on the interface (e.g., MTU or MRU)
        Returns:
        Counter64 inMaxsizeExceeded, or null if it is not present.

      • requireInMaxsizeExceeded

        default @NonNull Counter64 requireInMaxsizeExceeded()
        Return inMaxsizeExceeded, guaranteed to be non-null. 
             
         The total number frames received that are well-formed but dropped due to
         exceeding the maximum frame size on the interface (e.g., MTU or MRU)
        Returns:
        Counter64 inMaxsizeExceeded, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inMaxsizeExceeded is not present

      • getOutMacControlFrames

        Counter64 getOutMacControlFrames()
        Return outMacControlFrames, or null if it is not present. 
             
         MAC layer control frames sent on the interface
        Returns:
        Counter64 outMacControlFrames, or null if it is not present.

      • requireOutMacControlFrames

        default @NonNull Counter64 requireOutMacControlFrames()
        Return outMacControlFrames, guaranteed to be non-null. 
             
         MAC layer control frames sent on the interface
        Returns:
        Counter64 outMacControlFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outMacControlFrames is not present

      • getOutMacPauseFrames

        Counter64 getOutMacPauseFrames()
        Return outMacPauseFrames, or null if it is not present. 
             
         MAC layer PAUSE frames sent on the interface
        Returns:
        Counter64 outMacPauseFrames, or null if it is not present.

      • requireOutMacPauseFrames

        default @NonNull Counter64 requireOutMacPauseFrames()
        Return outMacPauseFrames, guaranteed to be non-null. 
             
         MAC layer PAUSE frames sent on the interface
        Returns:
        Counter64 outMacPauseFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outMacPauseFrames is not present

      • getOut8021qFrames

        Counter64 getOut8021qFrames()
        Return out8021qFrames, or null if it is not present. 
             
         Number of 802.1q tagged frames sent on the interface
        Returns:
        Counter64 out8021qFrames, or null if it is not present.

      • requireOut8021qFrames

        default @NonNull Counter64 requireOut8021qFrames()
        Return out8021qFrames, guaranteed to be non-null. 
             
         Number of 802.1q tagged frames sent on the interface
        Returns:
        Counter64 out8021qFrames, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if out8021qFrames is not present

      • getOutMacErrorsTx

        Counter64 getOutMacErrorsTx()
        Return outMacErrorsTx, or null if it is not present. 
             
         The number of sent errored frames due to MAC errors transmitted. The value
         refers to MIB counter for dot3StatsInternalMacTransmitErrors
         oid=1.3.6.1.2.1.10.7.2.1.10
        Returns:
        Counter64 outMacErrorsTx, or null if it is not present.

      • requireOutMacErrorsTx

        default @NonNull Counter64 requireOutMacErrorsTx()
        Return outMacErrorsTx, guaranteed to be non-null. 
             
         The number of sent errored frames due to MAC errors transmitted. The value
         refers to MIB counter for dot3StatsInternalMacTransmitErrors
         oid=1.3.6.1.2.1.10.7.2.1.10
        Returns:
        Counter64 outMacErrorsTx, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outMacErrorsTx is not present