org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces

Interface Interface

All Superinterfaces:

Augmentable<Interface>, BindingObject, ChildOf<Interfaces>, DataContainer, DataObject, Identifiable<InterfaceKey>

public interface Interface
extends ChildOf<Interfaces>, Augmentable<Interface>, Identifiable<InterfaceKey>

The list of configured interfaces on the device. The operational state of an interface is available in the /interfaces-state/interface list. If the configuration of a system-controlled interface cannot be used by the system (e.g., the interface hardware present does not match the interface type), then the configuration is not applied to the system-controlled interface shown in /interfaces-state/interface list. If the configuration of a user-controlled interface cannot be used by the system, the configured interface is not instantiated in the /interfaces-state/interface list.

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

 list interface {
   key name;
   leaf name {
     type string;
   }
   leaf description {
     type string;
   }
   leaf type {
     type identityref {
       base interface-type;
     }
   }
   leaf enabled {
     type boolean;
     default true;
   }
   leaf link-up-down-trap-enable {
     if-feature if-mib;
     type enumeration {
       enum enabled {
         value 1;
       }
       enum disabled {
         value 2;
       }
     }
   }
 }
 

The schema path to identify an instance is ietf-interfaces/interfaces/interface

To create instances of this class use InterfaceBuilder.

See Also:

InterfaceBuilder, InterfaceKey

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Interface.LinkUpDownTrapEnable

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable String	getDescription() A textual description of the interface.A server implementation MAY map this leaf to the ifAliasMIB object.
@Nullable Interface.LinkUpDownTrapEnable	getLinkUpDownTrapEnable() Controls whether linkUp/linkDown SNMP notificationsshould be generated for this interface.If this node is not configured, the value 'enabled' isoperationally used by the server for interfaces that donot operate on top of any other interface (i.e., there areno 'lower-layer-if' entries), and 'disabled' otherwise.
@Nullable String	getName() The name of the interface.A device MAY restrict the allowed values for this leaf,possibly depending on the type of the interface.For system-controlled interfaces, this leaf is thedevice-specific name of the interface.
@Nullable Class<? extends InterfaceType>	getType() The type of the interface.When an interface entry is created, a server MAYinitialize the type leaf with a valid value, e.g., if itis possible to derive the type from the name of theinterface.If a client tries to set the type of an interface to avalue that can never be used by the system, e.g., if thetype is not supported or if the type does not match thename of the interface, the server MUST reject the request.A NETCONF server MUST reply with an rpc-error with theerror-tag 'invalid-value' in this case.
@Nullable Boolean	isEnabled() This leaf contains the configured, desired state of theinterface.Systems that implement the IF-MIB use the value of thisleaf in the 'running' datastore to setIF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntryhas been initialized, as described in RFC 2863.Changes in this leaf in the 'running' datastore arereflected in ifAdminStatus, but if ifAdminStatus ischanged over SNMP, this leaf is not affected.
InterfaceKey	key() Returns an unique key for the object.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Field Detail

QNAME

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

Method Detail

getName

@Nullable String getName()

The name of the interface.A device MAY restrict the allowed values for this leaf,possibly depending on the type of the interface.For system-controlled interfaces, this leaf is thedevice-specific name of the interface. The 'config false'list /interfaces-state/interface contains the currentlyexisting interfaces on the device.If a client tries to create configuration for asystem-controlled interface that is not present in the/interfaces-state/interface list, the server MAY rejectthe request if the implementation does not supportpre-provisioning of interfaces or if the name refers toan interface that can never exist in the system. ANETCONF server MUST reply with an rpc-error with theerror-tag 'invalid-value' in this case.If the device supports pre-provisioning of interfaceconfiguration, the 'pre-provisioning' feature isadvertised.If the device allows arbitrarily named user-controlledinterfaces, the 'arbitrary-names' feature is advertised.When a configured user-controlled interface is created bythe system, it is instantiated with the same name in the/interface-state/interface list.

Returns:

java.lang.String name, or null if not present

getDescription

@Nullable String getDescription()

A textual description of the interface.A server implementation MAY map this leaf to the ifAliasMIB object. Such an implementation needs to use somemechanism to handle the differences in size and charactersallowed between this leaf and ifAlias. The definition ofsuch a mechanism is outside the scope of this document.Since ifAlias is defined to be stored in non-volatilestorage, the MIB implementation MUST map ifAlias to thevalue of 'description' in the persistently storeddatastore.Specifically, if the device supports ':startup', whenifAlias is read the device MUST return the value of'description' in the 'startup' datastore, and when it iswritten, it MUST be written to the 'running' and 'startup'datastores. Note that it is up to the implementation todecide whether to modify this single leaf in 'startup' orperform an implicit copy-config from 'running' to'startup'.If the device does not support ':startup', ifAlias MUSTbe mapped to the 'description' leaf in the 'running'datastore.

Returns:

java.lang.String description, or null if not present

getType

@Nullable Class<? extends InterfaceType> getType()

The type of the interface.When an interface entry is created, a server MAYinitialize the type leaf with a valid value, e.g., if itis possible to derive the type from the name of theinterface.If a client tries to set the type of an interface to avalue that can never be used by the system, e.g., if thetype is not supported or if the type does not match thename of the interface, the server MUST reject the request.A NETCONF server MUST reply with an rpc-error with theerror-tag 'invalid-value' in this case.

Returns:

java.lang.Class type, or null if not present

isEnabled

@Nullable Boolean isEnabled()

This leaf contains the configured, desired state of theinterface.Systems that implement the IF-MIB use the value of thisleaf in the 'running' datastore to setIF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntryhas been initialized, as described in RFC 2863.Changes in this leaf in the 'running' datastore arereflected in ifAdminStatus, but if ifAdminStatus ischanged over SNMP, this leaf is not affected.

Returns:

java.lang.Boolean enabled, or null if not present

getLinkUpDownTrapEnable

@Nullable Interface.LinkUpDownTrapEnable getLinkUpDownTrapEnable()

Controls whether linkUp/linkDown SNMP notificationsshould be generated for this interface.If this node is not configured, the value 'enabled' isoperationally used by the server for interfaces that donot operate on top of any other interface (i.e., there areno 'lower-layer-if' entries), and 'disabled' otherwise.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface.LinkUpDownTrapEnable linkUpDownTrapEnable, or null if not present

key

InterfaceKey key()

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<InterfaceKey>

Returns:

Key for the object