PppoL2tpv3ServerBlockConfig Object

Description:

PPPoL2TPv3 server block configuration settings.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: PppMsgOption, PppoxServerIpv6PeerPool

Automatically-created children: PppoxServerIpv4PeerPool

Result children (automatically created): PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoeClientBlockResults, PppoePortResults, PppoeServerBlockResults, PppoL2tpSessionResults, PppoL2tpv2SessionResults, PppoL2tpv3SessionResults, PppServerBlockResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	Relates the MPLS control plane binding result to PppoL2tpv3ServerBlockConfig object.
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary convergence config.
ResultChild (ResultChild)	PppClientBlockResults, PppoaClientBlockResults, PppoaServerBlockResults, PppoeClientBlockResults, PppoePortResults, PppoeServerBlockResults, PppServerBlockResults, 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).

PppoL2tpv3ServerBlockConfig 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 by 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)

ChapReplyTimeout

Timeout wait period for peer to send CHAP response.

Type: u16

Default: 3

Range: 1 - 65535

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

EnableEchoRequest

Enable echo requests.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable transmission of echo requests.
FALSE	Disable transmission of echo requests.

EnableForceServerConnectMode

Whether to allow the server to be forced into CONNECTED state without having all of its sessions connected.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Allow the server to be forced into CONNECTED state without having all of its sessions connected.
FALSE	Do not allow the server to be forced into CONNECTED state.

EnableMagicNum

Enable or disable Magic Number negotiation.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable Magic Number negotiation.
FALSE	Disable Magic Number negotiation.

EnableMpls

For PPPoPOS, enable MPLS option.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable the MPLS option.
FALSE	Disable the 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

EnableSecondaryDns

Enable Secondary DNS

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable Secondary DNS
FALSE	Disable Secondary DNS

ExpectedPeerMruSize

Expected peer MRU size

Type: u16

Default: 1492

Range: 128 - 65535

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	Do not 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

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

MaxChapRequestChallengeAttempts

Maximum CHAP challenge attempts.

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

MruSize

Local maximum receive unit (MRU) transmit 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

PapPeerRequestTimeout

Timeout wait period for PAP request Rx from peer.

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

Type of PPP session.

Type: enum

Default: UNDEFINED

Possible Values:

Value	Description
UNDEFINED	Nothing has been configured on the port.
PPPOPOS	PPPoPOS.
PPPOE	PPPoE with no VLAN.
PPPOEVLAN	PPPoE with a single 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.

SecondaryDns

Secondary DNS

Type: ip

Default: null

ServerInactivityTimer

Number of seconds to wait before the server is forced into a connected state. Timer begins when the maximum number of unconnected sessions is met. It is reset upon receipt of a packet on the server (excluding keepalives). When the timer expires, the server is put into the connected state.

Type: u16

Default: 30

Range: 1 - 65535

UnconnectedSessionThreshold

Maximum number of unconnected sessions allowed before a PPPoX server is forced into connected state.

Type: u16

Default: 0

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

PppoL2tpv3ServerBlockConfig Read-Only Attributes

Read-Only Attribute

Description

BlockState

State of the PPPoL2TPv2 server block.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	Emulation is not configured.
IDLE	Emulation is not running.
CONNECTING	Sessions are available.
CONNECTED	All sessions on the server are bound.
DISCONNECTING	Sessions are 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.