All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: Config, State

@Generated("mdsal-binding-generator")
public interface EthernetInterfaceConfig
extends org.opendaylight.yangtools.yang.binding.DataObject

Configuration items for Ethernet interfaces

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

 grouping ethernet-interface-config {
   leaf mac-address {
     type oc-yang:mac-address;
   }
   leaf auto-negotiate {
     type boolean;
     default true;
   }
   leaf standalone-link-training {
     type boolean;
     default false;
   }
   leaf duplex-mode {
     type enumeration {
       enum FULL {
       }
       enum HALF {
       }
     }
   }
   leaf port-speed {
     type identityref {
       base ETHERNET_SPEED;
     }
   }
   leaf enable-flow-control {
     type boolean;
     default false;
   }
 }

The schema path to identify an instance is openconfig-if-ethernetethernet-interface-config

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class EthernetInterfaceConfig.DuplexMode

Field Summary

Fields
Modifier and Type Field Description

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Boolean`	`getAutoNegotiate()`	Return autoNegotiate, or `null` if it is not present.
`EthernetInterfaceConfig.DuplexMode`	`getDuplexMode()`	Return duplexMode, or `null` if it is not present.
`Boolean`	`getEnableFlowControl()`	Return enableFlowControl, or `null` if it is not present.
`MacAddress`	`getMacAddress()`	Return macAddress, or `null` if it is not present.
`Class<? extends ETHERNETSPEED>`	`getPortSpeed()`	Return portSpeed, or `null` if it is not present.
`Boolean`	`getStandaloneLinkTraining()`	Return standaloneLinkTraining, or `null` if it is not present.
`Class<? extends EthernetInterfaceConfig>`	`implementedInterface()`
`default @NonNull Boolean`	`requireAutoNegotiate()`	Return autoNegotiate, guaranteed to be non-null.
`default @NonNull EthernetInterfaceConfig.DuplexMode`	`requireDuplexMode()`	Return duplexMode, guaranteed to be non-null.
`default @NonNull Boolean`	`requireEnableFlowControl()`	Return enableFlowControl, guaranteed to be non-null.
`default @NonNull MacAddress`	`requireMacAddress()`	Return macAddress, guaranteed to be non-null.
`default @NonNull Class<? extends ETHERNETSPEED>`	`requirePortSpeed()`	Return portSpeed, guaranteed to be non-null.
`default @NonNull Boolean`	`requireStandaloneLinkTraining()`	Return standaloneLinkTraining, guaranteed to be non-null.

Field Detail

QNAME

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

Method Detail

implementedInterface
```
Class<? extends EthernetInterfaceConfig> implementedInterface()
```
Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

getMacAddress

MacAddress getMacAddress()

Return macAddress, or null if it is not present.

     
         Assigns a MAC address to the Ethernet interface. If not specified, the
         corresponding operational state leaf is expected to show the system-assigned MAC
         address.

Returns:: MacAddress macAddress, or null if it is not present.

requireMacAddress

default @NonNull MacAddress requireMacAddress()

Return macAddress, guaranteed to be non-null.

     
         Assigns a MAC address to the Ethernet interface. If not specified, the
         corresponding operational state leaf is expected to show the system-assigned MAC
         address.

Returns:: MacAddress macAddress, guaranteed to be non-null.
Throws:: NoSuchElementException - if macAddress is not present

getAutoNegotiate

Boolean getAutoNegotiate()

Return autoNegotiate, or null if it is not present.

     
         Set to TRUE to request the interface to auto-negotiate transmission parameters
         with its peer interface. When set to FALSE, the transmission parameters are
         specified manually.

Returns:: Boolean autoNegotiate, or null if it is not present.

requireAutoNegotiate

default @NonNull Boolean requireAutoNegotiate()

Return autoNegotiate, guaranteed to be non-null.

     
         Set to TRUE to request the interface to auto-negotiate transmission parameters
         with its peer interface. When set to FALSE, the transmission parameters are
         specified manually.

Returns:: Boolean autoNegotiate, guaranteed to be non-null.
Throws:: NoSuchElementException - if autoNegotiate is not present

getStandaloneLinkTraining

Boolean getStandaloneLinkTraining()

Return standaloneLinkTraining, or null if it is not present.

     
         Link training is automatic tuning of the SerDes transmit and receive parameters
         to ensure an optimal connection over copper links. It is normally run as part of
         the auto negotiation sequence as specified in IEEE 802.3 Clause 73. Standalone
         link training is used when full auto negotiation is not desired on an Ethernet
         link but link training is needed. It is configured by setting the
         standalone-link-training leaf to TRUE and augo-negotiate leaf to FALSE. Note: If
         auto-negotiate is true, then the value of standalone link training leaf will be
         ignored.

Returns:: Boolean standaloneLinkTraining, or null if it is not present.

requireStandaloneLinkTraining

default @NonNull Boolean requireStandaloneLinkTraining()

Return standaloneLinkTraining, guaranteed to be non-null.

     
         Link training is automatic tuning of the SerDes transmit and receive parameters
         to ensure an optimal connection over copper links. It is normally run as part of
         the auto negotiation sequence as specified in IEEE 802.3 Clause 73. Standalone
         link training is used when full auto negotiation is not desired on an Ethernet
         link but link training is needed. It is configured by setting the
         standalone-link-training leaf to TRUE and augo-negotiate leaf to FALSE. Note: If
         auto-negotiate is true, then the value of standalone link training leaf will be
         ignored.

Returns:: Boolean standaloneLinkTraining, guaranteed to be non-null.
Throws:: NoSuchElementException - if standaloneLinkTraining is not present

getDuplexMode

EthernetInterfaceConfig.DuplexMode getDuplexMode()

Return duplexMode, or null if it is not present.

     
         When auto-negotiate is TRUE, this optionally sets the duplex mode that will be
         advertised to the peer. If unspecified, the interface should negotiate the
         duplex mode directly (typically full-duplex). When auto-negotiate is FALSE, this
         sets the duplex mode on the interface directly.

Returns:: DuplexMode duplexMode, or null if it is not present.

requireDuplexMode

default @NonNull EthernetInterfaceConfig.DuplexMode requireDuplexMode()

Return duplexMode, guaranteed to be non-null.

     
         When auto-negotiate is TRUE, this optionally sets the duplex mode that will be
         advertised to the peer. If unspecified, the interface should negotiate the
         duplex mode directly (typically full-duplex). When auto-negotiate is FALSE, this
         sets the duplex mode on the interface directly.

Returns:: DuplexMode duplexMode, guaranteed to be non-null.
Throws:: NoSuchElementException - if duplexMode is not present

getPortSpeed

Class<? extends ETHERNETSPEED> getPortSpeed()

Return portSpeed, or null if it is not present.

     
         When auto-negotiate is TRUE, this optionally sets the port-speed mode that will
         be advertised to the peer for negotiation. If unspecified, it is expected that
         the interface will select the highest speed available based on negotiation. When
         auto-negotiate is set to FALSE, sets the link speed to a fixed value --
         supported values are defined by ETHERNET_SPEED identities

Returns:: Class<? extends ETHERNETSPEED> portSpeed, or null if it is not present.

requirePortSpeed

default @NonNull Class<? extends ETHERNETSPEED> requirePortSpeed()

Return portSpeed, guaranteed to be non-null.

     
         When auto-negotiate is TRUE, this optionally sets the port-speed mode that will
         be advertised to the peer for negotiation. If unspecified, it is expected that
         the interface will select the highest speed available based on negotiation. When
         auto-negotiate is set to FALSE, sets the link speed to a fixed value --
         supported values are defined by ETHERNET_SPEED identities

Returns:: Class<? extends ETHERNETSPEED> portSpeed, guaranteed to be non-null.
Throws:: NoSuchElementException - if portSpeed is not present

getEnableFlowControl

Boolean getEnableFlowControl()

Return enableFlowControl, or null if it is not present.

     
         Enable or disable flow control for this interface. Ethernet flow control is a
         mechanism by which a receiver may send PAUSE frames to a sender to stop
         transmission for a specified time. This setting should override auto-negotiated
         flow control settings. If left unspecified, and auto-negotiate is TRUE, flow
         control mode is negotiated with the peer interface.

Returns:: Boolean enableFlowControl, or null if it is not present.

requireEnableFlowControl

default @NonNull Boolean requireEnableFlowControl()

Return enableFlowControl, guaranteed to be non-null.

     
         Enable or disable flow control for this interface. Ethernet flow control is a
         mechanism by which a receiver may send PAUSE frames to a sender to stop
         transmission for a specified time. This setting should override auto-negotiated
         flow control settings. If left unspecified, and auto-negotiate is TRUE, flow
         control mode is negotiated with the peer interface.

Returns:: Boolean enableFlowControl, guaranteed to be non-null.
Throws:: NoSuchElementException - if enableFlowControl is not present

Interface EthernetInterfaceConfig

Nested Class Summary

Field Summary