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

Interface Interface

All Superinterfaces:

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

Deprecated.

@Deprecated
public interface Interface
extends ChildOf<InterfacesState>, Augmentable<Interface>, Identifiable<InterfaceKey>

The list of interfaces on the device. System-controlled interfaces created by the system are always present in this list, whether or not they are configured.

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

 list interface {
   key name;
   status deprecated;
   leaf name {
     type string;
     status deprecated;
   }
   leaf type {
     type identityref {
       base interface-type;
     }
     status deprecated;
   }
   leaf admin-status {
     if-feature if-mib;
     type enumeration {
       enum up {
         value 1;
       }
       enum down {
         value 2;
       }
       enum testing {
         value 3;
       }
     }
     status deprecated;
   }
   leaf oper-status {
     type enumeration {
       enum up {
         value 1;
       }
       enum down {
         value 2;
       }
       enum testing {
         value 3;
       }
       enum unknown {
         value 4;
       }
       enum dormant {
         value 5;
       }
       enum not-present {
         value 6;
       }
       enum lower-layer-down {
         value 7;
       }
     }
     status deprecated;
   }
   leaf last-change {
     type yang:date-and-time;
     status deprecated;
   }
   leaf if-index {
     if-feature if-mib;
     type int32 {
       range 1..2147483647;
     }
     status deprecated;
   }
   leaf phys-address {
     type yang:phys-address;
     status deprecated;
   }
   leaf-list higher-layer-if {
     type interface-state-ref;
     status deprecated;
   }
   leaf-list lower-layer-if {
     type interface-state-ref;
     status deprecated;
   }
   leaf speed {
     type yang:gauge64;
     units bits/second;
     status deprecated;
   }
   container statistics {
     status deprecated;
     leaf discontinuity-time {
       type yang:date-and-time;
       status deprecated;
     }
     leaf in-octets {
       type yang:counter64;
       status deprecated;
     }
     leaf in-unicast-pkts {
       type yang:counter64;
       status deprecated;
     }
     leaf in-broadcast-pkts {
       type yang:counter64;
       status deprecated;
     }
     leaf in-multicast-pkts {
       type yang:counter64;
       status deprecated;
     }
     leaf in-discards {
       type yang:counter32;
       status deprecated;
     }
     leaf in-errors {
       type yang:counter32;
       status deprecated;
     }
     leaf in-unknown-protos {
       type yang:counter32;
       status deprecated;
     }
     leaf out-octets {
       type yang:counter64;
       status deprecated;
     }
     leaf out-unicast-pkts {
       type yang:counter64;
       status deprecated;
     }
     leaf out-broadcast-pkts {
       type yang:counter64;
       status deprecated;
     }
     leaf out-multicast-pkts {
       type yang:counter64;
       status deprecated;
     }
     leaf out-discards {
       type yang:counter32;
       status deprecated;
     }
     leaf out-errors {
       type yang:counter32;
       status deprecated;
     }
   }
 }
 

The schema path to identify an instance is ietf-interfaces/interfaces-state/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.AdminStatus Deprecated.
static class	Interface.OperStatus Deprecated.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
@Nullable Interface.AdminStatus	getAdminStatus() Deprecated.
@Nullable List<String>	getHigherLayerIf() Deprecated.
@Nullable Integer	getIfIndex() Deprecated.
@Nullable DateAndTime	getLastChange() Deprecated.
@Nullable List<String>	getLowerLayerIf() Deprecated.
@Nullable String	getName() Deprecated.
@Nullable Interface.OperStatus	getOperStatus() Deprecated.
@Nullable PhysAddress	getPhysAddress() Deprecated.
@Nullable Gauge64	getSpeed() Deprecated.
@Nullable Statistics	getStatistics() Deprecated.
@Nullable Class<? extends InterfaceType>	getType() Deprecated.
InterfaceKey	key() Deprecated. 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

Deprecated.

Method Detail

getName

@Deprecated
@Nullable String getName()

Deprecated.

The name of the interface.A server implementation MAY map this leaf to the ifNameMIB object. Such an implementation needs to use somemechanism to handle the differences in size and charactersallowed between this leaf and ifName. The definition ofsuch a mechanism is outside the scope of this document.

Returns:

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

getType

@Deprecated
@Nullable Class<? extends InterfaceType> getType()

Deprecated.

The type of the interface.

Returns:

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

getAdminStatus

@Deprecated
@Nullable Interface.AdminStatus getAdminStatus()

Deprecated.

The desired state of the interface.This leaf has the same read semantics as ifAdminStatus.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.state.Interface.AdminStatus adminStatus, or null if not present

getOperStatus

@Deprecated
@Nullable Interface.OperStatus getOperStatus()

Deprecated.

The current operational state of the interface.This leaf has the same semantics as ifOperStatus.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.state.Interface.OperStatus operStatus, or null if not present

getLastChange

@Deprecated
@Nullable DateAndTime getLastChange()

Deprecated.

The time the interface entered its current operationalstate. If the current state was entered prior to thelast re-initialization of the local network managementsubsystem, then this node is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime lastChange, or null if not present

getIfIndex

@Deprecated
@Nullable Integer getIfIndex()

Deprecated.

The ifIndex value for the ifEntry represented by thisinterface.

Returns:

java.lang.Integer ifIndex, or null if not present

getPhysAddress

@Deprecated
@Nullable PhysAddress getPhysAddress()

Deprecated.

The interface's address at its protocol sub-layer. Forexample, for an 802.x interface, this object normallycontains a Media Access Control (MAC) address. Theinterface's media-specific modules must define the bitand byte ordering and the format of the value of thisobject. For interfaces that do not have such an address(e.g., a serial line), this node is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress physAddress, or null if not present

getHigherLayerIf

@Deprecated
@Nullable List<String> getHigherLayerIf()

Deprecated.

A list of references to interfaces layered on top of thisinterface.

Returns:

java.util.List higherLayerIf, or null if not present

getLowerLayerIf

@Deprecated
@Nullable List<String> getLowerLayerIf()

Deprecated.

A list of references to interfaces layered underneath thisinterface.

Returns:

java.util.List lowerLayerIf, or null if not present

getSpeed

@Deprecated
@Nullable Gauge64 getSpeed()

Deprecated.

An estimate of the interface's current bandwidth in bitsper second. For interfaces that do not vary inbandwidth or for those where no accurate estimation canbe made, this node should contain the nominal bandwidth.For interfaces that have no concept of bandwidth, thisnode is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64 speed, or null if not present

getStatistics

@Deprecated
@Nullable Statistics getStatistics()

Deprecated.

A collection of interface-related statistics objects.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.state._interface.Statistics statistics, or null if not present

key

InterfaceKey key()

Deprecated.

Description copied from interface: Identifiable

Returns an unique key for the object.

Specified by:

key in interface Identifiable<InterfaceKey>

Returns:

Key for the object