Layer2_5.Pppoe.Client Class Reference

A PPPoE client which allows you to setup Layer3 connectivity. More...

Methods
	Description.Get
	Returns a textual description of the object.
	Parent.Get
	Returns the parent object.
	Ppp.Get
	Returns the associated PPP Protocol object. More...
	ServiceName.Get
	This method will return the Requested Service Name for the PPPoE client. More...
	ServiceName.Set serviceName
	This method will set the Requested Service Name for the PPPoE client. More...
	SessionId.Get
	This method will return the PPPoE SessionID of the last started PPPoE Session. More...
	Start.Async
	Starts the PPPoE client. More...
	Start
	This will Start the PPPoE client. More...
	Status.Get
	Returns the current status of the PPPoE connection. More...
	Terminate
	This will Terminate the PPPoE client. More...

Class overview

A PPPoE client which allows you to setup Layer3 connectivity.

PPP over Ethernet (PPPoE) provides the ability to connect a network of hosts over a simple bridging access device to a remote Access Concentrator.

The client implements the PPPoE protocol as per RFC2516 .

The associated PPP Protocol has support for multiple authentication protocols. Layer3 connectivity includes IPv4 and IPv6 .

Since

2.5.0

Definition at line 5663 of file api.tcl.

Method documentation

Layer2_5.Pppoe.Client::Ppp.Get

Returns the associated PPP Protocol object.

Returns the PPP ( Point-to-Point ) Protocol which is transmitted over Ethernet ( PPPoE ). Through this object, you can configure the AuthProtocol.

Returns

The PPP Protocol object associated with our PPPoE client.

Example

set Layer2_5PPPoE [ $myByteBlowerPort Layer2_5.PPPoE.Add ]

Returns:

ByteBlowerObject_1382435068_9 

$Layer2_5PPPoE Ppp.Get

Returns:

ByteBlowerObject_1382435068_13 

Definition at line 5687 of file api.tcl.

Layer2_5.Pppoe.Client::ServiceName.Get

This method will return the Requested Service Name for the PPPoE client.

Returns

PPPoE Service Name which the client requests.

Example

set Layer2_5PPPoE [ $myByteBlowerPort Layer2_5.PPPoE.Add ]

Returns:

ByteBlowerObject_1382435068_9 

$Layer2_5PPPoE ServiceName.Get

Returns:

PPPoEService 

Definition at line 5699 of file api.tcl.

Layer2_5.Pppoe.Client::ServiceName.Set			serviceName

This method will set the Requested Service Name for the PPPoE client.

Parameters

serviceName

PPPoE Service Name which the client requests.

Example

set Layer2_5PPPoE [ $myByteBlowerPort Layer2_5.PPPoE.Add ]

Returns:

ByteBlowerObject_1382435068_9 

$Layer2_5PPPoE ServiceName.Set "PPPoEService"

Definition at line 5711 of file api.tcl.

Layer2_5.Pppoe.Client::SessionId.Get

This method will return the PPPoE SessionID of the last started PPPoE Session.

Returns

0 if No session started yet, else the PPPoE SessionID of the last started session.

Definition at line 5719 of file api.tcl.

Layer2_5.Pppoe.Client::Start

This will Start the PPPoE client.

This method will start the PPPoE session, setup PPP, authenticate using the configured authentication protocol and setup the currently configured network control protocols.

Exceptions

SessionUnavailable	When something unexpectedly happened during PPPoE session initiation.
LinkEstablishmentTimeout	When PPP network layer was not configured within reasonable timeout.

Returns

PPPoE Session ID

Example

set Layer2_5PPPoE [ $myByteBlowerPort Layer2_5.PPPoE.Add ]

Returns:

ByteBlowerObject_1382435068_9 

$Layer2_5PPPoE Start

Returns:

123 

Definition at line 5745 of file api.tcl.

Layer2_5.Pppoe.Client::Start.Async

Starts the PPPoE client.

This call will initiate the start of the PPPoE client but will not wait for the result.

Definition at line 5727 of file api.tcl.

Layer2_5.Pppoe.Client::Status.Get

Returns the current status of the PPPoE connection.

Possible states are:

Initial

PPPoE not yet started

Discovering

PPPoE discovery message sent

Requesting

PPPoE request sent

SessionActive

PPPoE session is active

Terminated

PPPoE session has been terminated

Returns

Current PPPoE Status

Example

set Layer2_5PPPoE [ $myByteBlowerPort Layer2_5.PPPoE.Add ]

Returns:

ByteBlowerObject_1382435068_9 

// Configure the PPPoE and start

$Layer2_5PPPoE Status.Get

Returns:

Session_active 

Definition at line 5759 of file api.tcl.

Layer2_5.Pppoe.Client::Terminate

This will Terminate the PPPoE client.

Termination will properly terminate all PPPoE and PPP related protocols, from higher-layers to lower-layers, starting from the network control protocol (i.e. IPCP or IPv6CP ).

Definition at line 5767 of file api.tcl.