L2tpv2If Object

Description:

Layer 2 Tunneling Protocol interface.

Writable Attributes
Read-Only Attributes

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

L2tpv2If Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

IfCountPerLowerIf

Number of interfaces in this interface object.

Type: u32

Default: 1

IfRecycleCount

How many times to increment the item before returning to the starting value. The item to increment can be LocalSessionId, LocalTunnelId, RemoteIpv4Addr, and UdpSrcPort.

Example: LocalSessionId = 1, LocalSessionIdRepeatCount = 0, LocalSessionIdStep = 1, IfRecycleCount = 3. The generated values for LocalSessionId will be 1, 2, 3, 1, 2, 3, and so on. It works in a similar manner for other items.

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 items, or to use an nList attribute to specify the items. The items are LocalSessionId, LocalTunnelId, RemoteIpv4Addr, and UdpSrcPort.

Type: bool

Default: TRUE

Possible Values:

Value

Description

TRUE

Generate a range of items using a combination of attributes. These attributes are in 4 sets as follows:

Set 1: LocalSessionId, LocalSessionIdRepeatCount, LocalSessionIdStep, IfRecycleCount.

Set 2: LocalTunnelId, LocalTunnelIdRepeatCount, LocalTunnelIdStep, IfRecycleCount.

Set 3: RemoteIpv4Addr, RemoteIpv4AddrRepeatCount, RemoteIpv4AddrStep, RemoteIpv4AddrStepMask, IfRecycleCount.

Set 4: UdpSrcPort, UdpSrcPortRepeatCount, UdpSrcPortStep, IfRecycleCount.

FALSE

Use one of the nList attributes to specify the items. The nList attributes are LocalSessionIdList, LocalTunnelIdList, RemoteIpv4AddrList, and UdpSrcPortList.

LocalSessionId

L2TP local session ID. You can generate more than one local session ID by using combinations of LocalSessionId, LocalSessionIdRepeatCount, LocalSessionIdStep, and IfRecycleCount. If you do that, then LocalSessionId is the starting local session ID.

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

Type: u16

Default: 0

LocalSessionIdList

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

Type: u16

Default: 0

LocalSessionIdRepeatCount

How many times to repeat the same L2TP local session ID before incrementing it. See IsRange for more information.

Type: u32

Default: 0

LocalSessionIdStep

Step value for the L2TP local session ID (LocalSessionId). See IsRange for more information.

Type: s16

Default: 1

LocalTunnelId

L2TP local tunnel ID. You can generate more than one local tunnel ID by using combinations of LocalTunnelId, LocalTunnelIdRepeatCount, LocalTunnelIdStep, and IfRecycleCount. If you do that, then LocalTunnelId is the starting local tunnel ID.

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

Type: u16

Default: 0

LocalTunnelIdList

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

Type: u16

Default: 0

LocalTunnelIdRepeatCount

How many times to repeat the same L2TP local tunnel ID before incrementing it. See IsRange for more information.

Type: u32

Default: 0

LocalTunnelIdStep

L2TP local tunnel ID step value. See IsRange for more information.

Type: s16

Default: 1

RemoteIpv4Addr

IPv4 address of the L2TP remote system. You can generate more than one remote IPv4 address by using combinations of RemoteIpv4Addr, RemoteIpv4AddrRepeatCount, RemoteIpv4AddrStep, RemoteIpv4AddrStepMask, and IfRecycleCount. If you do that, then RemoteIpv4Addr is the starting remote IPv4 address.

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

Type: ip

Default: 192.85.1.3

RemoteIpv4AddrList

A Tcl list of IPv4 addresses of L2TP remote systems. To use this attribute, the IsRange attribute must be FALSE.

Type: ip

Default: 0

RemoteIpv4AddrRepeatCount

How many times to repeat the same L2TP remote IPv4 address before incrementing it. See IsRange for more information.

Type: u32

Default: 0

RemoteIpv4AddrStep

L2TP remote IPv4 address step value. See IsRange for more information.

Type: ip

Default: 0.0.0.1

RemoteIpv4AddrStepMask

L2TP remote IPv4 address step mask. This indicates which parts of the IPv4 address will change when incremented. See IsRange for more information.

Type: ip

Default: 0.0.0.255

RemoteIpv6Addr

Remove IPv6 address.

Type: ipv6

Default: 2000::2

RemoteIpv6AddrList

Remove IPv6 address list.

Type: ipv6

Default: 0

RemoteIpv6AddrRepeatCount

Remove IPv6 address stutter.

Type: u32

Default: 0

RemoteIpv6AddrStep

Remove IPv6 address step.

Type: ipv6

Default: 0000::1

RemoteIpv6AddrStepMask

Remove IPv6 address step mask.

Type: ipv6

Default: FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF

RemoteSessionIdList

A Tcl list of L2TP remote session IDs.

Type: u16

Default: 0

RemoteTunnelIdList

A Tcl list of L2TP remote tunnel IDs.

Type: u16

Default: 0

TunnelSessionResolver

Protocol that resolves L2tpv2 tunnel parameters. Spirent TestCenter sets this automatically when L2tpv2 testing is configured.

Type: string

Default: default

UdpChecksumEnabled

Whether to use a checksum on UDP packets.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use a checksum.
FALSE	Do not use a checksum.

UdpControlPlaneChecksumEnabled

Whether to use a checksum on UDP Control Plane packets.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use a checksum.
FALSE	Do not use a checksum.

UdpDstPortList

A Tcl list of L2TP UDP destination ports.

Type: u16

Default: 1701

UdpSrcPort

UDP source port used in L2TP. You can generate more than one UDP source port by using combinations of UdpSrcPort, UdpSrcPortRepeatCount, UdpSrcPortStep, and IfRecycleCount. If you do that, then UdpSrcPort is the starting UDP source port.

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

Type: u16

Default: 1701

UdpSrcPortList

A Tcl list of L2TP UDP source ports. To use this attribute, the IsRange attribute must be FALSE.

Type: u16

Default: 1701

UdpSrcPortRepeatCount

How many times to repeat the same L2TP UDP source port before incrementing it. See IsRange for more information.

Type: u32

Default: 0

UdpSrcPortStep

L2TP UDP source port step value. See IsRange for more information.

Type: s16

Default: 1

UseLength

Do not use this attribute.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Do not use.
FALSE	Do not use.

UseOffset

Do not use this attribute.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Do not use.
FALSE	Do not use.

UsePriority

Do not use this attribute.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Do not use.
FALSE	Do not use.

UseSeq

Do not use this attribute.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Do not use.
FALSE	Do not use.

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

TunnelSessionResolveState

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