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

Interface EthernetInterfaceState

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
State
@Generated("mdsal-binding-generator") public interface EthernetInterfaceState extends org.opendaylight.yangtools.yang.binding.DataObject
Grouping for defining Ethernet-specific operational state

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

 grouping ethernet-interface-state {
   leaf hw-mac-address {
     type oc-yang:mac-address;
   }
   leaf negotiated-duplex-mode {
     type enumeration {
       enum FULL {
       }
       enum HALF {
       }
     }
   }
   leaf negotiated-port-speed {
     type identityref {
       base ETHERNET_SPEED;
     }
   }
   container counters {
     uses ethernet-interface-state-counters;
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

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

    • getHwMacAddress

      MacAddress getHwMacAddress()
      Return hwMacAddress, or null if it is not present. 
           
         Represenets the 'burned-in', or system-assigned, MAC address for the Ethernet
         interface.
      Returns:
      MacAddress hwMacAddress, or null if it is not present.

    • requireHwMacAddress

      default @NonNull MacAddress requireHwMacAddress()
      Return hwMacAddress, guaranteed to be non-null. 
           
         Represenets the 'burned-in', or system-assigned, MAC address for the Ethernet
         interface.
      Returns:
      MacAddress hwMacAddress, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if hwMacAddress is not present

    • getNegotiatedDuplexMode

      EthernetInterfaceState.NegotiatedDuplexMode getNegotiatedDuplexMode()
      Return negotiatedDuplexMode, or null if it is not present. 
           
         When auto-negotiate is set to TRUE, and the interface has completed
         auto-negotiation with the remote peer, this value shows the duplex mode that has
         been negotiated.
      Returns:
      NegotiatedDuplexMode negotiatedDuplexMode, or null if it is not present.

    • requireNegotiatedDuplexMode

      default @NonNull EthernetInterfaceState.NegotiatedDuplexMode requireNegotiatedDuplexMode()
      Return negotiatedDuplexMode, guaranteed to be non-null. 
           
         When auto-negotiate is set to TRUE, and the interface has completed
         auto-negotiation with the remote peer, this value shows the duplex mode that has
         been negotiated.
      Returns:
      NegotiatedDuplexMode negotiatedDuplexMode, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if negotiatedDuplexMode is not present

    • getNegotiatedPortSpeed

      ETHERNETSPEED getNegotiatedPortSpeed()
      Return negotiatedPortSpeed, or null if it is not present. 
           
         When auto-negotiate is set to TRUE, and the interface has completed
         auto-negotiation with the remote peer, this value shows the interface speed that
         has been negotiated.
      Returns:
      ETHERNETSPEED negotiatedPortSpeed, or null if it is not present.

    • requireNegotiatedPortSpeed

      default @NonNull ETHERNETSPEED requireNegotiatedPortSpeed()
      Return negotiatedPortSpeed, guaranteed to be non-null. 
           
         When auto-negotiate is set to TRUE, and the interface has completed
         auto-negotiation with the remote peer, this value shows the interface speed that
         has been negotiated.
      Returns:
      ETHERNETSPEED negotiatedPortSpeed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if negotiatedPortSpeed is not present

    • getCounters

      Counters getCounters()
      Return counters, or null if it is not present. 
           
         Ethernet interface counters
      Returns:
      Counters counters, or null if it is not present.

    • nonnullCounters

      @NonNull Counters nonnullCounters()
      Return counters, or an empty instance if it is not present.
      Returns:
      Counters counters, or an empty instance if it is not present.