Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev210406

Interface InterfaceCommonConfig

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:

Config, Config, InterfacePhysConfig, State, State, SubinterfacesConfig

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

Configuration data data nodes common to physical interfaces and subinterfaces

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

 grouping interface-common-config {
   leaf description {
     type string;
   }
   leaf enabled {
     type boolean;
     default true;
   }
 }
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return description, or null if it is not present.
Boolean	getEnabled()	Return enabled, or null if it is not present.
Class<? extends InterfaceCommonConfig>	implementedInterface()
default @NonNull String	requireDescription()	Return description, guaranteed to be non-null.
default @NonNull Boolean	requireEnabled()	Return enabled, guaranteed to be non-null.

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 InterfaceCommonConfig> 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

getDescription

String getDescription()

Return description, or null if it is not present.

     
         A textual description of the interface. A server implementation MAY map this
         leaf to the ifAlias MIB object. Such an implementation needs to use some
         mechanism to handle the differences in size and characters allowed between this
         leaf and ifAlias. The definition of such a mechanism is outside the scope of
         this document. Since ifAlias is defined to be stored in non-volatile storage,
         the MIB implementation MUST map ifAlias to the value of 'description' in the
         persistently stored datastore. Specifically, if the device supports ':startup',
         when ifAlias is read the device MUST return the value of 'description' in the
         'startup' datastore, and when it is written, it MUST be written to the 'running'
         and 'startup' datastores. Note that it is up to the implementation to decide
         whether to modify this single leaf in 'startup' or perform an implicit
         copy-config from 'running' to 'startup'. If the device does not support
         ':startup', ifAlias MUST be mapped to the 'description' leaf in the 'running'
         datastore.
     
 

Returns:

String description, or null if it is not present.

requireDescription

default @NonNull String requireDescription()

Return description, guaranteed to be non-null.

     
         A textual description of the interface. A server implementation MAY map this
         leaf to the ifAlias MIB object. Such an implementation needs to use some
         mechanism to handle the differences in size and characters allowed between this
         leaf and ifAlias. The definition of such a mechanism is outside the scope of
         this document. Since ifAlias is defined to be stored in non-volatile storage,
         the MIB implementation MUST map ifAlias to the value of 'description' in the
         persistently stored datastore. Specifically, if the device supports ':startup',
         when ifAlias is read the device MUST return the value of 'description' in the
         'startup' datastore, and when it is written, it MUST be written to the 'running'
         and 'startup' datastores. Note that it is up to the implementation to decide
         whether to modify this single leaf in 'startup' or perform an implicit
         copy-config from 'running' to 'startup'. If the device does not support
         ':startup', ifAlias MUST be mapped to the 'description' leaf in the 'running'
         datastore.
     
 

Returns:

String description, guaranteed to be non-null.

Throws:

NoSuchElementException - if description is not present

getEnabled

Boolean getEnabled()

Return enabled, or null if it is not present.

     
         This leaf contains the configured, desired state of the interface. Systems that
         implement the IF-MIB use the value of this leaf in the 'running' datastore to
         set IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry has been
         initialized, as described in RFC 2863. Changes in this leaf in the 'running'
         datastore are reflected in ifAdminStatus, but if ifAdminStatus is changed over
         SNMP, this leaf is not affected.
     
 

Returns:

Boolean enabled, or null if it is not present.

requireEnabled

default @NonNull Boolean requireEnabled()

Return enabled, guaranteed to be non-null.

     
         This leaf contains the configured, desired state of the interface. Systems that
         implement the IF-MIB use the value of this leaf in the 'running' datastore to
         set IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry has been
         initialized, as described in RFC 2863. Changes in this leaf in the 'running'
         datastore are reflected in ifAdminStatus, but if ifAdminStatus is changed over
         SNMP, this leaf is not affected.
     
 

Returns:

Boolean enabled, guaranteed to be non-null.

Throws:

NoSuchElementException - if enabled is not present