All Classes Namespaces Files Functions Pages
Layer2.Ppp Class Reference

Class implementing Point-to-Point Protocol (PPP) More...

Methods

 AuthProtocol.Chap.Add
 This method will add the Challenge-handshake Authentication Protocol. More...
 
 AuthProtocol.Chap.Get
 This method will return the current configured Challenge-Handshake Authentication Protocols. More...
 
 AuthProtocol.Pap.Add
 This method will add the Password Authentication Protocol. More...
 
 AuthProtocol.Pap.Get
 This method will return the current configured Password Authentication Protocols. More...
 
 Description.Get
 Returns a textual description of the object.
 
 Ncp.Ipcp.Add
 This method will add support for an IPv6 Control Protocol. More...
 
 Ncp.Ipcp.Get
 This method will return the current configured Internet Protocol Control Protocols (IPCP). More...
 
 Ncp.Ipv6cp.Add
 This method will add support for an IPv4 Control Protocol. More...
 
 Ncp.Ipv6cp.Get
 This method will return the current configured IPv6 Control Protocols (IPv6CP). More...
 
 Parent.Get
 Returns the parent object.
 

Class overview

Class implementing Point-to-Point Protocol (PPP)

The Point-to-Point Protocol (PPP) provides a standard method for transporting multi-protocol datagrams over point-to-point links. PPP is comprised of three main components:

  1. A method for encapsulating multi-protocol datagrams.
  2. A Link Control Protocol (LCP) for establishing, configuring, and testing the data-link connection.
  3. A family of Network Control Protocols (NCPs) for establishing and configuring different network-layer protocols.

The implementation is conform RFC1661.

Since
2.5.0

Definition at line 5552 of file api.tcl.

Method documentation

Layer2.Ppp::AuthProtocol.Chap.Add

This method will add the Challenge-handshake Authentication Protocol.

Returns
The Challenge-handshake Authentication Protocol object. The object type is Layer2.Ppp.Auth.Chap.

Definition at line 5560 of file api.tcl.

Layer2.Ppp::AuthProtocol.Chap.Get

This method will return the current configured Challenge-Handshake Authentication Protocols.

Returns
List of configured Challenge-Handshake Authentication Protocols.

Definition at line 5568 of file api.tcl.

Layer2.Ppp::AuthProtocol.Pap.Add

This method will add the Password Authentication Protocol.

Returns
The Password Authentication Protocol object. The object type is Layer2.Ppp.Auth.Pap.

Definition at line 5576 of file api.tcl.

Layer2.Ppp::AuthProtocol.Pap.Get

This method will return the current configured Password Authentication Protocols.

Returns
List of configured Password Authentication Protocols.

Definition at line 5584 of file api.tcl.

Layer2.Ppp::Ncp.Ipcp.Add

This method will add support for an IPv6 Control Protocol.

IPCP is the Internet Protocol Control Protocol.

Returns
The IPCP NCP object is returned. The object types is Layer2.Ppp.NetworkControl.Ipcp.
Example

Adding IPCP as Network Control Protocol

1 $myPPPObjct Ncp.Ipcp.Add

Returns:

<Layer2.Ppp.NetworkControl.Ipcp object> 

Definition at line 5603 of file api.tcl.

Layer2.Ppp::Ncp.Ipcp.Get

This method will return the current configured Internet Protocol Control Protocols (IPCP).

Returns
List of configured Internet Protocol Control Protocols. The object type is Layer2.Ppp.NetworkControl.Ipcp.
Example
1 $myPPPOject Ncp.Ipcp.Get

Returns:

<Layer2.Ppp.NetworkControl.Ipcp object>  

Definition at line 5615 of file api.tcl.

Layer2.Ppp::Ncp.Ipv6cp.Add

This method will add support for an IPv4 Control Protocol.

IPv6CP is the Internet Protocol Control Protocol for IPv6.

Returns
The IPv6CP NCP object is returned. The object type is Layer2.Ppp.NetworkControl.Ipv6cp.
Example

Adding IPv6CP as Network Control Protocol

1 $myPPPObjct Ncp.Ipv6cp.Add

Returns:

<Layer2.Ppp.NetworkControl.Ipv6cp object> 

Definition at line 5629 of file api.tcl.

Layer2.Ppp::Ncp.Ipv6cp.Get

This method will return the current configured IPv6 Control Protocols (IPv6CP).

Returns
List of configured IPv6 Control Protocols. The object type is Layer2.Ppp.NetworkControl.Ipv6cp.
Example
1 $myPPPOject Ncp.Ipv6cp.Get

Returns:

<Layer2.Ppp.NetworkControl.Ipv6cp object>  

Definition at line 5641 of file api.tcl.