PppoeIf Object


Description:

PPPoE interface object.

Parents: EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Children: GroupIf, MplsGeneralizedPwBindInfo, MplsIpv4MultiLayerStaticBindInfo, MplsIpv4PrefixBindInfo, MplsIpv4VpnBindInfo, MplsIpv6MultiLayerStaticBindInfo, MplsIpv6PrefixBindInfo, MplsIpv6VpnBindInfo, MplsRsvpTunnelBindInfo, MplsRsvpTunnelSrcDstBindInfo, MplsSrBindInfo, MplsTpStaticLspBindInfo, MplsTpStaticPseudoWireBindInfo, MplsVcBindInfo, MplsVplsBindInfo, Rfc4814EthIIIfDecorator

Relations:

Side name
(Type)
Relative Description
GroupIf
(AffiliatedGroupIf)

GroupIf

Affiliated group interface.

DstBoundTo
(DstBinding)

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies destination endpoints bound to StreamBlock.

EncapsulationSource
(Encapsulation)

PathDescriptor

Specifies the encapsulation.

NetworkLink
(LinkSrc)

CustomLink, CustomLink, DualStackLiteLink, DualStackLiteLink, EoamLink, EoamLink, EthernetBridgeLink, EthernetBridgeLink, EvpnCeToPeLink, EvpnCeToPeLink, IpForwardingLink, IpForwardingLink, Ipv6RapidDeploymentLink, Ipv6RapidDeploymentLink, ItagServiceLink, ItagServiceLink, L2GreTunnelLink, L2GreTunnelLink, L2tpv3ForwardingLink, L2tpv3ForwardingLink, MplsForwardingLink, MplsForwardingLink, MplsHierarchicalLink, MplsHierarchicalLink, MplsIpv4VpnCeToPeLink, MplsIpv4VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsIpv6VpnCeToPeLink, MplsL2VpnPeToPLink, MplsL2VpnPeToPLink, MplsL3VpnPeToPLink, MplsL3VpnPeToPLink, MVpnGreCeToPeLink, MVpnGreCeToPeLink, MVpnGrePeToPLink, MVpnGrePeToPLink, OtvEdgeDeviceLink, OtvEdgeDeviceLink, StationToScompLink, StationToScompLink, VifToVicLink, VifToVicLink, VlanSwitchLink, VlanSwitchLink, VplsBgpCeToPeLink, VplsBgpCeToPeLink, VplsLdpCeToPeLink, VplsLdpCeToPeLink, VsiToStationLink, VsiToStationLink, VxlanGpeLink, VxlanGpeLink, VxlanVmToVtepLink, VxlanVmToVtepLink

Link source.

MemberOfVpn
(MemberOfVpn)

EthernetVpnSiteInfo, VpnIdGroup, VpnSiteInfo6Pe, VpnSiteInfoMplsTpStatic, VpnSiteInfoRfc2547, VpnSiteInfoRfc4659, VpnSiteInfoVplsBgp, VpnSiteInfoVplsLdp

Do not use, to be removed

MulticastExpectedRxPorts
(MulticastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as multicast traffic by any of the ports connected through this relation.

OptionallyStackedUnder
(OptionallyStackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies an optionally-selected lower interface in the stack. Selection is controlled by protocol implementations which decide based on other criteria whether they should include the target interface in their stack.

OtvEdgeDeviceConfig
(OtvTopLevelIf)

OtvEdgeDeviceConfig

Otv top level private interface.

PrimaryIfSource
(PrimaryIf)

EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Specifies if a top-level interface is facing the DUT.

RelayBlockConfig
(RelayIf)

Dhcpv4BlockConfig, Dhcpv4BlockConfig

Config to relay agent interface.


(ResolvesInterface)

BgpRouterConfig, IsisRouterConfig, LdpRouterConfig, LispRouterConfig, Ospfv2RouterConfig, Ospfv3RouterConfig, RsvpIngressTunnelParams, RsvpRouterConfig

Use this to link the traffic binding interfaces and traffic binding resolver.

SrcBoundTo
(SrcBinding)

PathDescriptor, StreamBlock, TrafficDescriptor

Specifies the source endpoint bound to StreamBlock.

StackedOn
(StackedOnEndpoint)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies network endpoint stacking.

TopLevelIfSource
(TopLevelIf)

EmulatedDevice, ExternalDevice, ExternalDevicePort, Host, Port, Router, SUT

Specifies the top-level interface in the interface stack.

L2tpv2UdpConfig
(UdpSrcCustomIf)

L2tpv2BlockConfig

Config to Udp source custom interface.

UnicastExpectedRxPorts
(UnicastExpectedRxPorts)

Port

Traffic sent to this end point is expected to be received as unicast traffic by any of the ports connected through this relation.

UsesIfSource
(UsesIf)

AncpAccessNodeConfig, AppPerfClientConfig, AppPerfServerConfig, AutosarTimeSyncConfig, BfdRouterConfig, BridgePortConfig, CifsClientProtocolConfig, CifsServerProtocolConfig, CoapServerConfig, CuspProtocolConfig, Dhcpv4BlockConfig, Dhcpv4ServerConfig, Dhcpv6BlockConfig, Dhcpv6PdBlockConfig, Dhcpv6ServerConfig, Dot1xSupplicantBlockConfig, DpgClientProtocolConfig, DpgServerProtocolConfig, DualStackLiteConfig, EcpriProtocolConfig, EoamNodeConfig, FcEPortConfig, FcFPortConfig, FcHostConfig, FcoeHostConfig, FcoeVePortConfig, FcoeVfPortConfig, FtpClientProtocolConfig, FtpServerProtocolConfig, HttpClientProtocolConfig, HttpServerProtocolConfig, Ieee1588v2ClockConfig, Ieee80211AccessPointConfig, Ieee80211ClientConfig, Ieee8021asClockConfig, IgmpHostConfig, IgmpRouterConfig, IperfClientProtocolConfig, IperfServerProtocolConfig, Ipv6RapidDeploymentConfig, L2tpv2BlockConfig, L2tpv3BlockConfig, LacpPortConfig, LagBfdPortConfig, LinkOamRouterConfig, LispRouterConfig, LldpNodeConfig, LspPingProtocolConfig, MacsecSupplicantBlockConfig, MldHostConfig, MldRouterConfig, MplsTpConfig, MplsTpOamNodeConfig, MsdpProtocolConfig, NetconfClientConfig, NetconfProtocolConfig, NtpClientConfig, OamFlexeClientConfig, OpenflowControllerProtocolConfig, OpflexDeviceConfig, OseSwitchConfig, Ospfv2RouterConfig, Ospfv3RouterConfig, OtvEdgeDeviceConfig, OtvSiteDeviceConfig, OvsdbServerConfig, PacketChannel, PcepProtocolConfig, PimRouterConfig, PppoaClientBlockConfig, PppoaServerBlockConfig, PppoeClientBlockConfig, PppoeServerBlockConfig, PppoL2tpv2ClientBlockConfig, PppoL2tpv2ServerBlockConfig, PppoL2tpv3ClientBlockConfig, PppoL2tpv3ServerBlockConfig, PppProtocolConfig, RawTcpClientProtocolConfig, RawTcpServerProtocolConfig, RipRouterConfig, RoEBlockConfig, SaaDeviceConfig, SipUaProtocolConfig, SrpConfig, Srv6OamProtocolConfig, StorageWorkerConfig, SyncEthDeviceConfig, TrillRbridgeConfig, TwampClientConfig, TwampServerConfig, VdpStationConfig, VicAdapterConfig, VideoClientProtocolConfig, VideoServerProtocolConfig, VifConfig, VsiBlockConfig, VxlanVtepConfig, XmppvJClientConfig

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

PppoeIf Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
IfCountPerLowerIf

Number of interfaces in this interface object.

Type: u32

Default: 1

IfRecycleCount

How many to times to increment the PPPoE session ID before returning to the starting value. See SessionId for more information.

Type: u32

Default: 0

IsLoopbackIf

Whether this is a loopback interface.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

This is a loopback interface.

FALSE

This is not a loopback interface.

IsRange

Whether to use a combination of attributes to generate a range of session IDs, or to use the SessionIdList attribute to specify the session IDs.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Use a combination of attributes to generate a range of session IDs. The attributes are SessionId, SessionIdStep, SessionIdRepeatCount, and IfRecycleCount. See SessionId for more information.

FALSE

Use the SessionIdList attribute to specify the session IDs.

PeerMacAddrList

Peer MAC address list.

Type: mac

Default: 0

SessionId

PPPoE session ID. You can generate more than one PPPoE session ID by using SessionIdRepeatCount, SessionIdStep, and IfRecycleCount. If you do that, then this attribute is the starting session ID.

To use this attribute, the IsRange attribute must be TRUE.

Example: SessionId = 1, SessionIdStep = 1, IfRecycleCount = 2, SessionIdRepeatCount = 0. Generated values will be 1, 2, 1, 2, 1, 2, and so on.

Example: SessionId = 1, SessionIdStep = 1, IfRecycleCount = 2, SessionIdRepeatCount = 1. Generated values will be 1, 1, 2, 2, 1, 1, 2, 2, 1, 1, 2, 2, and so on.

Type: u16

Default: 0

Range: 0 - 65535

SessionIdList

A Tcl list of session IDs. To use this attribute, the IsRange attribute must be FALSE.

Type: u16

Default: 0

SessionIdRepeatCount

How many times to repeat the same PPPoE session ID before incrementing it. See SessionId for more information.

Type: u16

Default: 0

SessionIdStep

PPPoE session ID step value. See SessionId for more information.

Type: s16

Default: 1

SessionResolver

Session resolver.

Type: string

Default: default

PppoeIf Read-Only Attributes

Read-Only Attribute Description
EffectiveBlockCount

Block count for this interface.

Type: u32

Default: 1

IfState

State of this interface.

Type: enum

Default: DISABLED

Possible Values:

Value Description
READY

Ready.

DISABLED

Disabled.

DELETING

Deleting.

PARTIALLY_READY

Partially ready.

PeerMacAddr

Peer MAC address.

Type: mac

Default: 00:00:00:00:00:00

SessionResolveState

Session resolve state.

Type: enum

Default: RESOLVE_NEEDED

Possible Values:

Value Description
RESOLVE_DONE

Resolve is done.

RESOLVE_NEEDED

Resolve is needed.

RESOLVE_FAILED

Resolve failed.

RESOLVE_IN_PROGRESS

Resolve is in progress.

RESOLVE_PARTIALLY_DONE

Resolve is partially done.