Interface

Keys

Leafs

Children

Enum Classes

class Interfaces.Interface

Bases: Entity

Class Hierarchy : Interfaces Interface

This class represents configuration data.

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 the

/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.

name(key)

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 the device-specific name of the interface. The ‘config false’ list /interfaces-state/interface contains the currently existing interfaces on the device. If a client tries to create configuration for a system-controlled interface that is not present in the /interfaces-state/interface list, the server MAY reject the request if the implementation does not support pre-provisioning of interfaces or if the name refers to an interface that can never exist in the system. A NETCONF server MUST reply with an rpc-error with the error-tag ‘invalid-value’ in this case. If the device supports pre-provisioning of interface configuration, the ‘pre-provisioning’ feature is advertised. If the device allows arbitrarily named user-controlled interfaces, the ‘arbitrary-names’ feature is advertised. When a configured user-controlled interface is created by the system, it is instantiated with the same name in the /interface-state/interface list

type: str

description

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

type: str

type

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

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

enabled

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

type: bool

default value: true

Controls whether linkUp/linkDown SNMP notifications should be generated for this interface. If this node is not configured, the value ‘enabled’ is operationally used by the server for interfaces that do not operate on top of any other interface (i.e., there are no ‘lower-layer-if’ entries), and ‘disabled’ otherwise

type: LinkUpDownTrapEnable

ipv4

Parameters for the IPv4 address family

type: Ipv4

presence node: True

ipv6

Parameters for the IPv6 address family

type: Ipv6

presence node: True

diffserv_target_entry

policy target for inbound or outbound direction

type: list of DiffservTargetEntry