PppoeClientBlockConfig Object


Description:

PPPoE client block configuration settings.

Parents: EmulatedDevice

Children: Ipv4NetworkBlock, Ipv6NetworkBlock, PppMsgOption, VendorSpecificDslfTag

Result children (automatically created): PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoeClientBlockResults, PppoeoaSessionResults, PppoePortResults, PppoeServerBlockResults, PppoeSessionResults, PppServerBlockResults

Relations:

Side name
(Type)
Relative Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

Relates the MPLS control plane binding result to PppoeClientBlockConfig object.

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

Primary convergence config.

ResultChild
(ResultChild)

PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoeClientBlockResults, PppoeClientBlockResults, PppoePortResults, PppoeServerBlockResults, PppServerBlockResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

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

PppoeClientBlockConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Authentication

Type of authentication to use.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

No authentication.

AUTO

Sessions are authenticated using the protocol specified by the DUT (PAP or CHAP).

CHAP_MD5

Sessions are authenticated using CHAP.

PAP

Sessions are authenticated using PAP.

AuthenticationFilePath

The file path of imported authentication list.

Type: inputFilePath

Default: "" (empty string)

AutoCalculateMru

Enable automatically calculate MRU(Spirent TestCenter negotiate the MRU in LCP).

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable automatically calculate MRU(Spirent TestCenter negotiate the MRU in LCP).

FALSE

Disable automatically calculate MRU(Spirent TestCenter negotiate the MRU in LCP).

AutoRetryCount

Maximum number of automatic retry attempts.

Type: u16

Default: 65535

Range: 1 - 65535

ChapAckTimeout

Timeout wait period for the server to send an ACK to a challenge response.

Type: u16

Default: 3

Range: 1 - 65535

ChapChalRequestTimeout

Timeout wait period for the server to send a CHAP challenge.

Type: u16

Default: 3

Range: 1 - 65535

CircuitId

Enabled for DSL-type relay agents only. The circuit ID can be used to encode a local identifier for the circuit that received a PPP packet from a client, destined for the access concentrator. Use wildcard characters to make each circuit ID unique:

@s - Session index associated with the PPPoX client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the PPPoX client.

@x - Custom step setup in (start,count,step,zeropadding,stutter) format.

start - starting value.

count - number of values to generate.

step - amount to increment the start value when the start value must be stepped.

zeropadding - length the value should be padded to by prepending 0's.

stutter - number of times a value should be repeated before applying the step.

@@ - This must be used to include the textual "@" symbol in the string.

Type: string

Default: circuit @s

Range: 0 - 255 characters

ConnectRate

Maximum rate in the number of session per second at which session will be connected for a PPPoX device block.

Type: u16

Default: 100

Range: 1 - 1000

DisconnectRate

Maximum rate in the number of sessions per second at which sessions will be disconnected for a PPPoX device block.

Type: u16

Default: 100

Range: 1 - 1000

EchoRequestGenFreq

Interval in seconds between sending out consecutive echo requests.

Type: u16

Default: 10

Range: 0 - 65535

EnableAddressAndControlField

Always Enable Address and Control field

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable address and control field

FALSE

Disable address and control field

EnableAutoFillIpv6

Enables Auto Fill for the IPv6 address through transmission/receipt of RS/RA messages to the DUT.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable Auto Fill for the IPv6 address (use RA/RS messages).

FALSE

Disable Auto Fill for the IPv6 address (use the link-local address).

EnableAutoRetry

Enable or disable automatic retry to connect failed PPP sessions.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable automatic retry.

FALSE

Disable automatic retry.

EnableEchoRequest

Enable echo requests.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable transmission of echo requests.

FALSE

Disable transmission of echo requests.

EnableIgnoreFromServerClientIpAddr

Enable ignore from server client IP address

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable ignore from server client IP address

FALSE

Disable ignore from server client IP address

EnableMagicNum

Enable Magic Number negotiation.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable Magic Number negotiation.

FALSE

Disable Magic Number negotiation.

EnableMaxPayloadTag

Enables the PPP-Max-Payload-Tag (see RFC 4638).

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable the PPP-Max-Payload tag.

FALSE

Disable the PPP-Max-Payload tag.

EnableMpls

For PPPoPOS, enable MPLS option.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable MPLS option.

FALSE

Disable MPLS option.

EnableMruNegotiation

Enable or disable MRU negotiation.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable MRU negotiation.

FALSE

Disable MRU negotiation.

EnableNcpTermination

Terminate the session from NCP.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Terminate the session from NCP.

FALSE

Don't terminate the session from NCP.

EnableOsi

For PPPoPOS, enable OSI NLCP option.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable OSI NLCP option.

FALSE

Disable OSI NLCP option.

EnablePasswdValidation

Enable password validation

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable password validation

FALSE

Disable password validation

EnablePrimaryDns

Enable Primary DNS

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable Primary DNS

FALSE

Disable Primary DNS

EnableRelayAgent

Enable or disable the relay agent.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable the relay agent.

FALSE

Disable the relay agent.

EnableSecondaryDns

Enable Secondary DNS

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable Secondary DNS

FALSE

Disable Secondary DNS

EnableSessionAutoRetry

Enable session auto retry.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable session auto retry.

FALSE

Disable session auto retry.

EnableSpecifiedClientIpAddr

Allow or forbid users to specify IP addresses of PPP clients through emulated device interface.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Allow users to specify IP addresses of PPP clients through emulated device interface.

FALSE

PPP clients request the peer to provide the IP Addresses.

ExpectedPeerMruSize

Expected peer MRU size

Type: u16

Default: 1492

Range: 128 - 65535

IncludeRelayAgentInPadi

Include the relay agent tags in transmitted PADI messages.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Include relay agent tags in PADI message.

FALSE

Do not include relay agent tags in PADI message.

IncludeRelayAgentInPadr

Include the relay agent tags in transmitted PADR messages.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Include relay agent tags in PADR message.

FALSE

Do not include relay agent tags in PADR message.

IncludeTxChapId

Include or exclude the Identifier field of the Challenge message.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Include the Identifier field.

FALSE

Don't include the Identifier field.

IpcpEncap

Enable IPv6CP or IPv4CP. Must have at least one enabled.

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

Enable IPv4 addressing.

IPV6

Enable IPv6 addressing.

IPV4V6

Enable IPv4 and IPv6 addressing on the same PPP link.

LcpConfigRequestMaxAttempts

Maximum number of configure requests that can be sent, without acknowledgment, before a session fails.

Type: u16

Default: 10

Range: 1 - 65535

LcpConfigRequestTimeout

Timeout value in seconds for acknowledgment of a configure request.

Type: u16

Default: 3

Range: 1 - 65535

LcpDelay

Maximal amount of time STC will wait before transmitting the first LCP packet. The delay will be overridden (and LCP will begin) if an LCP packet is received before the delay expires.

Type: u32

Default: 0

LcpTermRequestMaxAttempts

Maximum number of terminate requests that can be sent, without acknowledgment, before a session fails.

Type: u16

Default: 10

Range: 1 - 65535

LcpTermRequestTimeout

Timeout value in seconds for acknowledgment of a terminate request.

Type: u16

Default: 3

Range: 1 - 65535

MaxChapRequestReplyAttempts

Maximum CHAP response attempts by the client.

Type: u16

Default: 10

Range: 1 - 65535

MaxEchoRequestAttempts

Number of consecutive, unanswered echo requests to send before failing the subscriber session.

Type: u16

Default: 1

Range: 0 - 65535

MaxNaks

Maximum Negative-Acknowledgments allowed during LCP and NCP configuration/negotiation.

Type: u16

Default: 5

Range: 1 - 65535

MaxPapRequestAttempts

Maximum PAP request attempts by the client.

Type: u16

Default: 10

Range: 1 - 65535

MaxPayloadBytes

Maximum number of PPP payload bytes the client can transmit and receive. This value will be used in the PPP-Max-Payload tag in PPPoE Active Discovery Initialized (PADI) and PPPoE Active Discovery Request (PADR) messages.

Type: u16

Default: 1500

Range: 0 - 65535

MruSize

Local maximum receive unit (MRU) size in bytes.

Type: u16

Default: 1492

Range: 128 - 65535

NcpConfigRequestMaxAttempts

Maximum number of NCP Configure-Requests that can be sent, without acknowledgment, before a session fails.

Type: u16

Default: 10

Range: 1 - 65535

NcpConfigRequestTimeout

Timeout value in seconds for acknowledgment of an NCP Configure-Request.

Type: u16

Default: 3

Range: 1 - 65535

PadiMaxAttempts

Maximum number of PADI packets that can be sent, without acknowledgment, before a session fails.

Type: u16

Default: 10

Range: 1 - 65535

PadiTimeout

Timeout value in seconds for acknowledgment of a PADI packet.

Type: u16

Default: 3

Range: 1 - 65535

PadrMaxAttempts

Maximum number of PADR packets that can be sent, without acknowledgment, before a session fails.

Type: u16

Default: 10

Range: 1 - 65535

PadrTimeout

Timeout value in seconds for acknowledgment of a PADR packet.

Type: u16

Default: 3

Range: 1 - 65535

PapRequestTimeout

PAP Request timeout in seconds.

Type: u16

Default: 3

Range: 1 - 65535

Password

Password for authenticated PPP sessions. Use wildcard characters to make each password unique:

@s - Session index associated with the PPPoX client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the PPPoX client.

@x - Custom step setup in (start,count,step,zeropadding,stutter) format.

start - starting value.

count - number of values to generate.

step - amount to increment the start value when the start value must be stepped.

zeropadding - length the value should be padded to by prepending 0's.

stutter - number of times a value should be repeated before applying the step.

@@ - This must be used to include the textual "@" symbol in the string.

Type: string

Default: spirent

Range: 1 - 64 characters

PrimaryDns

Primary DNS

Type: ip

Default: null

Protocol

Select the type of PPP session.

Type: enum

Default: UNDEFINED

Possible Values:

Value Description
UNDEFINED

Nothing has been configured on the port.

PPPOPOS

PPPoPOS.

PPPOE

PPPoE no VLAN.

PPPOEVLAN

PPPoE with one VLAN.

PPPOESVLAN

PPPoE with more than one VLAN.

PPPOL2TPV2

PPPoL2TPv2 (Deprecated).

PPPOEOA

PPP over Ethernet over ATM.

PPPOA

PPP over ATM.

PPPOL2TPV3

PPPoL2TPv3 (Deprecated).

PPPOL2TP

PPP over L2TP.

RAMOFlag

M and O flags for Router Advertisement.

Type: enum

Default: NODHCP

Possible Values:

Value Description
NODHCP

M=0 and O=0.

REQUIRECONFIG

M=0 and O=1.

REQUIREDHCP

M=1.

RelayAgentMacAddr

Enabled for RFC 2516-type relay agents only. The Relay Agent MAC address is the MAC address of the next hop from the subscriber client group to the access concentrator.

Type: mac

Default: 00-00-00-00-00-00

RelayAgentMacAddrStep

Increment value to create Relay Agent Destination MAC Address.

Type: mac

Default: 00-00-00-00-00-01

RelayAgentType

Select the type of relay agent.

Type: enum

Default: RFC_2516

Possible Values:

Value Description
RFC_2516

Use the RFC 2516-type relay agent.

DSL_FORUM

Use the DSL-type relay agent.

RemoteOrSessionId

Remote ID or session ID depending on the relay agent type. Use wildcard characters to make each ID unique:

@s - Session index associated with the PPPoX client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the PPPoX client.

@x - Custom step setup in (start,count,step,zeropadding,stutter) format.

start - starting value.

count - number of values to generate.

step - amount to increment the start value when the start value must be stepped.

zeropadding - length the value should be padded to by prepending 0's.

stutter - number of times a value should be repeated before applying the step.

@@ - This must be used to include the textual "@" symbol in the string.

Type: string

Default: remote @m-@p-@b

Range: 0 - 255 characters

SecondaryDns

Secondary DNS

Type: ip

Default: null

ServiceName

Service that will be connected per RFC 2516. If the cell is left blank, any service is acceptable.

Type: string

Default: "" (empty string)

Range: 0 - 255 characters

TotalClients

Number of clients.

Type: u32

Default: 65535

Range: 0 - 65535

UseAuthenticationList

Use imported authentication list file or not.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use imported authentication list file.

FALSE

Don't use imported authentication list file.

UsePartialBlockState

Flag indicating partial block state as being used.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use partial block state.

FALSE

Do not use partial block state.

Username

User name for authenticated PPP sessions. Use wildcard characters to make each user name unique:

@s - Session index associated with the PPPoX client.

@b - Block (host/router) index.

@p - Port name.

@m - MAC address of the PPPoX client.

@x - Custom step setup in (start,count,step,zeropadding,stutter) format.

start - starting value.

count - number of values to generate.

step - amount to increment the start value when the start value must be stepped.

zeropadding - length the value should be padded to by prepending 0's.

stutter - number of times a value should be repeated before applying the step.

@@ - This must be used to include the textual "@" symbol in the string.

Type: string

Default: spirent

Range: 1 - 64 characters

PppoeClientBlockConfig Read-Only Attributes

Read-Only Attribute Description
BlockState

Block state of the PPPoE client block.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

Emulation is not configured or running.

IDLE

Sessions are down.

CONNECTING

At least one session is connecting.

CONNECTED

At least one session is connected.

DISCONNECTING

At least one session is disconnecting.

TERMINATING

Sessions are terminating.

Ipv4CpBlockState

IPv4 NCP block state.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

The NCP block is disabled.

IDLE

The NCP block is idle.

CONNECTING

The NCP block is connecting.

CONNECTED

The NCP block is connected.

DISCONNECTING

The NCP block is disconnecting.

TERMINATING

The NCP block is being terminated.

Ipv6CpBlockState

IPv6 NCP block state.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

The NCP block is disabled.

IDLE

The NCP block is idle.

CONNECTING

The NCP block is connecting.

CONNECTED

The NCP block is connected.

DISCONNECTING

The NCP block is disconnecting.

TERMINATING

The NCP block is being terminated.

IsServer

Whether this node is a server or not.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

This node is a server.

FALSE

This node is not a server.