public interface Interface extends ChildOf<Interfaces>, Augmentable<Interface>, Identifiable<InterfaceKey>
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; } } } leaf admin-status { if-feature if-mib; type enumeration { enum up { value 1; } enum down { value 2; } enum testing { value 3; } } config false; } 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; } } config false; } leaf last-change { type yang:date-and-time; config false; } leaf if-index { if-feature if-mib; type int32 { range 1..2147483647; } config false; } leaf phys-address { type yang:phys-address; config false; } leaf-list higher-layer-if { type interface-ref; config false; } leaf-list lower-layer-if { type interface-ref; config false; } leaf speed { type yang:gauge64; units bits/second; config false; } container statistics { config false; leaf discontinuity-time { type yang:date-and-time; } leaf in-octets { type yang:counter64; } leaf in-unicast-pkts { type yang:counter64; } leaf in-broadcast-pkts { type yang:counter64; } leaf in-multicast-pkts { type yang:counter64; } leaf in-discards { type yang:counter32; } leaf in-errors { type yang:counter32; } leaf in-unknown-protos { type yang:counter32; } leaf out-octets { type yang:counter64; } leaf out-unicast-pkts { type yang:counter64; } leaf out-broadcast-pkts { type yang:counter64; } leaf out-multicast-pkts { type yang:counter64; } leaf out-discards { type yang:counter32; } leaf out-errors { type yang:counter32; } } }The schema path to identify an instance is ietf-interfaces/interfaces/interface
To create instances of this class use InterfaceBuilder
.
InterfaceBuilder
,
InterfaceKey
Modifier and Type | Interface and Description |
---|---|
static class |
Interface.AdminStatus |
static class |
Interface.LinkUpDownTrapEnable |
static class |
Interface.OperStatus |
Modifier and Type | Field and Description |
---|---|
static org.opendaylight.yangtools.yang.common.QName |
QNAME |
Modifier and Type | Method and Description |
---|---|
@Nullable Interface.AdminStatus |
getAdminStatus()
The desired state of the interface.This leaf has the same read semantics as
ifAdminStatus.
|
@Nullable String |
getDescription()
A textual description of the interface.A server implementation MAY map this leaf
to the ifAliasMIB object.
|
@Nullable List<String> |
getHigherLayerIf()
A list of references to interfaces layered on top of thisinterface.
|
@Nullable Integer |
getIfIndex()
The ifIndex value for the ifEntry represented by thisinterface.
|
@Nullable DateAndTime |
getLastChange()
The time the interface entered its current operationalstate.
|
@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 List<String> |
getLowerLayerIf()
A list of references to interfaces layered underneath thisinterface.
|
@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.If a client
tries to create configuration for asystem-controlled interface that is not
present in theoperational state, the server MAY reject the request ifthe
implementation does not support pre-provisioning ofinterfaces or if the name
refers to an interface that cannever exist in the system.
|
@Nullable Interface.OperStatus |
getOperStatus()
The current operational state of the interface.This leaf has the same semantics
as ifOperStatus.
|
@Nullable PhysAddress |
getPhysAddress()
The interface's address at its protocol sub-layer.
|
@Nullable Gauge64 |
getSpeed()
An estimate of the interface's current bandwidth in bitsper second.
|
@Nullable Statistics |
getStatistics()
A collection of interface-related statistics objects.
|
@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 intended configuration to
setIF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntryhas been initialized,
as described in RFC 2863.Changes in this leaf in the intended configuration
arereflected in ifAdminStatus.
|
InterfaceKey |
key()
Returns an unique key for the object.
|
getImplementedInterface
augmentation
@Nullable String getName()
java.lang.String
name
, or null
if not present@Nullable String getDescription()
java.lang.String
description
, or null
if not present@Nullable Class<? extends InterfaceType> getType()
java.lang.Class
type
, or null
if not present@Nullable Boolean isEnabled()
java.lang.Boolean
enabled
, or null
if not present@Nullable Interface.LinkUpDownTrapEnable getLinkUpDownTrapEnable()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.Interface.LinkUpDownTrapEnable
linkUpDownTrapEnable
, or null
if not present@Nullable Interface.AdminStatus getAdminStatus()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.Interface.AdminStatus
adminStatus
, or null
if not present@Nullable Interface.OperStatus getOperStatus()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces.Interface.OperStatus
operStatus
, or null
if not present@Nullable DateAndTime getLastChange()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime
lastChange
, or null
if not present@Nullable Integer getIfIndex()
java.lang.Integer
ifIndex
, or null
if not present@Nullable PhysAddress getPhysAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress
physAddress
, or null
if not present@Nullable List<String> getHigherLayerIf()
java.util.List
higherLayerIf
, or null
if not present@Nullable List<String> getLowerLayerIf()
java.util.List
lowerLayerIf
, or null
if not present@Nullable Gauge64 getSpeed()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Gauge64
speed
, or null
if not present@Nullable Statistics getStatistics()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.interfaces._interface.Statistics
statistics
, or null
if not presentInterfaceKey key()
Identifiable
key
in interface Identifiable<InterfaceKey>
Copyright © 2019 OpenDaylight. All rights reserved.