Interface

Keys

Leafs

Children

Enum Classes

class InterfacesState.Interface

Bases: Entity

Class Hierarchy : InterfacesState Interface

This class represents state data.

The list of interfaces on the device.

System-controlled interfaces created by the system are

always present in this list, whether they are configured or

not.

name(key)

The name of the interface. A server implementation MAY map this leaf to the ifName MIB object. Such an implementation needs to use some mechanism to handle the differences in size and characters allowed between this leaf and ifName. The definition of such a mechanism is outside the scope of this document

type: str

config: False

type

The type of the interface

type: one of the below values:

IanaInterfaceType

VoiceFXO

AtmVciEndPt

PropBWAp2Mp

PropDocsWirelessDownstream

V11

SoftwareLoopback

Hdlc

VoiceFGDOS

FastEtherFX

DvbTdm

Nfas

IfPwType

L2vlan

Adsl2plus

Ieee802154

VoiceFXS

DvbRcsMacLayer

Idsl

Infiniband

DdnX25

WwanPP2

DocsCableUpstream

Ethernet3Mbit

DigitalPowerline

H323Proxy

Gtp

IpOverAtm

AluEpon

Imt

IpSwitch

Msdsl

DvbRccMacLayer

SmdsDxi

VoiceOverAtm

Arap

FastEther

Mpc

Linegroup

Hippi

Rpr

Ds1FDL

SonetVT

VoiceEncap

Ss7SigLink

Arcnet

ActelisMetaLOOP

Qllc

Rfc877x25

MpegTransport

X25mlp

VirtualTg

HostPad

StarLan

Iso88025Dtr

Ibm370parChan

Adsl2

OtnOtu

PropWirelessP2P

Interleave

Isup

Regular1822

Gr303RDT

PropDocsWirelessMaclayer

Async

RadioMAC

OpticalChannelGroup

SixToFour

PropDocsWirelessUpstream

Q2931

Fddi

PropCnls

Aal2

DvbAsiOut

AluELP

CiscoISLvlan

DocsCableUpstreamRfPort

Aal5

FrDlciEndPt

HippiInterface

L3ipvlan

Miox25

Hssi

AtmVirtual

AluGponOnu

Rfc1483

Cnr

SipSig

Myrinet

Dlsw

GigabitEthernet

X25ple

Lmp

OpticalTransport

Sdlc

VoiceEM

X86Laps

G9982

Iso88022llc

DvbAsiIn

Bgppolicyaccounting

AluEponOnu

MfSigLink

Dcn

AtmDxi

VoiceOverFrameRelay

Gfp

SonetOverheadChannel

VmwareVirtualNic

FcipLink

IpOverClaw

Coffee

Radsl

Vdsl2

Rs232

E1

ReachDSL

VoiceOverCable

Tr008

VoiceOverIp

Atm

Ds3

Ds0

Ds1

Srp

DocsCableDownstream

DvbRcsTdma

G9983

Plc

FrameRelayMPI

Mvl

PropMultiplexor

VoiceDID

CompositeLink

Proteon10Mbit

Atmbond

Frf16MfrBundle

CctEmul

MplsTunnel

Gpon

Vdsl

Pos

Ieee8023adLag

DocsCableMaclayer

DocsCableMCmtsDownstream

Ppp

FrameRelay

Eplrs

VmwareNicTeam

CableDownstreamRfPort

MacSecUncontrolledIF

Iso88023Csmacd

Usb

AtmFuni

TeLink

Pon622

Econet

Tdlc

Ds0Bundle

Fast

Ieee1394

CblVectaStar

Rsrb

FrameRelayInterconnect

Isdns

PppMultilinkBundle

Aflane8025

Lapb

Aflane8023

Lapd

Isdnu

Lapf

CapwapWtpVirtualRadio

IfVfiType

X25huntGroup

Para

MacSecControlledIF

Iso88024TokenBus

LocalTalk

Hyperchannel

MediaMailOverIp

IfGsn

CapwapDot11Profile

L3ipxvlan

AtmSubInterface

PrimaryISDN

Proteon80Mbit

Iso88026Man

DigitalWrapperOverheadChannel

DocsCableUpstreamChannel

OpticalChannel

EthernetCsmacd

Bits

Tunnel

Hdsl2

FrameRelayService

Mpls

Ieee80211

Ieee80212

MocaVersion1

Sonet

Escon

AluEponLogicalLink

G703at2mb

Ultra

DvbRccDownstream

SipTg

SmdsIcip

Bridge

AtmLogical

PropPointToPointSerial

V35

V36

V37

Ip

Gr303IDT

BasicISDN

G703at64k

ArcnetPlus

Pip

Dtm

Slip

Hiperlan2

Adsl

Ieee80216WMAN

AtmIma

Isdn

CapwapDot11Bss

Sip

PdnEtherLoop2

VoiceEBS

IpForward

Iso88025CRFPInt

PropVirtual

WwanPP

Other

Pon155

Qam

OtnOdu

Iso88025Fiber

Channel

VoiceEMFGD

AluGponPhysicalUni

A12MppSwitch

Ilan

PdnEtherLoop1

X213

SonetPath

VoiceFGDEANA

Iso88025TokenRing

PropAtm

AluEponPhysicalUni

StackToStack

FrForward

Homepna

Sdsl

VirtualIpAddress

Bsc

AtmRadio

AviciOpticalEther

G9981

FibreChannel

Shdsl

Eon

H323Gatekeeper

Hdh1822

DvbRccUpstream

Nsip

TranspHdlc

TermPad

IpOverCdlc

Ces

Modem

mandatory: True

config: False

admin_status

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

type: AdminStatus

mandatory: True

config: False

oper_status

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

type: OperStatus

mandatory: True

config: False

last_change

The time the interface entered its current operational state. If the current state was entered prior to the last re-initialization of the local network management subsystem, then this node is not present

type: str

pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2})

config: False

if_index

The ifIndex value for the ifEntry represented by this interface

type: int

range: 1..2147483647

mandatory: True

config: False

phys_address

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

type: str

pattern: ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?

config: False

higher_layer_if

A list of references to interfaces layered on top of this interface

type: list of str

refers to: name

config: False

lower_layer_if

A list of references to interfaces layered underneath this interface

type: list of str

refers to: name

config: False

speed

An estimate of the interface’s current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this node should contain the nominal bandwidth. For interfaces that have no concept of bandwidth, this node is not present

type: int

range: 0..18446744073709551615

config: False

units: bits/second

statistics

A collection of interface-related statistics objects

type: Statistics

config: False

routing_instance

The name of the routing instance to which the interface is assigned

type: str

config: False

ipv4

Interface-specific parameters for the IPv4 address family

type: Ipv4

presence node: True

config: False

ipv6

Parameters for the IPv6 address family

type: Ipv6

presence node: True

config: False

diffserv_target_entry

policy target for inbound or outbound direction

type: list of DiffservTargetEntry

config: False