Feature Specifications For The Pppoe Relay Feature
Feature Specifications For The Pppoe Relay Feature
Feature Specifications For The Pppoe Relay Feature
The PPPoE Relay feature enables an L2TP access concentrator (LAC) to relay active discovery and
service selection functionality for PPP over Ethernet (PPPoE), over a Layer 2 Tunneling Protocol (L2TP)
control channel, to an L2TP network server (LNS) or tunnel switch (multihop node). The relay
functionality of this feature allows the LNS or tunnel switch to advertise the services it offers to the
client, thereby providing end-to-end control of services between the LNS and a PPPoE client.
Finding Support Information for Platforms and Cisco IOS Software Images
Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image
support. Access Cisco Feature Navigator at http://www.cisco.com/go/fn. You must have an account on
Cisco.com. If you do not have an account or have forgotten your username or password, click Cancel at
the login dialog box and follow the instructions that appear.
Contents
• Prerequisites for Using PPPoE Relay, page 2
• Information About PPPoE Relay, page 2
• How to Configure PPPoE Relay, page 2
• Configuration Examples for PPPoE Relay, page 7
• Additional References, page 12
• Command Reference, page 13
Corporate Headquarters:
Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA
Cisco IOS Release: Multiple releases (see the Feature History table)
2
PPPoE Relay
How to Configure PPPoE Relay
SUMMARY STEPS
1. enable
2. configure terminal
3. subscriber profile profile-name
4. service relay pppoe vpdn group vpdn-group-name
5. exit
DETAILED STEPS
Example:
Router# configure terminal
Step 3 subscriber profile profile-name Configures the subscriber profile name and begins
subscriber profile configuration mode.
Example: • profile-name—Is referenced from a PPPoE profile
Router(config)# subscriber profile profile-1 configured by the bba-group pppoe global
configuration command, so that all the PPPoE sessions
using the PPPoE profile defined by the bba-group
pppoe command would be treated according to the
defined subscriber profile.
Step 4 service relay pppoe vpdn group vpdn-group-name Provides PPPoE relay service using a VPDN L2TP tunnel
for the relay. The VPDN group name specified is used to
obtain outgoing L2TP tunnel information.
Example:
Router(config-sss-profile)# service relay pppoe • See the “RADIUS Subscriber Profile Entry for the
vpdn group Group-A LAC” section for the equivalent RADIUS profile
entry.
Cisco IOS Release: Multiple releases (see the Feature History table)
3
PPPoE Relay
How to Configure PPPoE Relay
What to Do Next
Configure the LNS side of the configuration by performing the tasks described in the “Configuring the
LNS (or Multihop Node) to Respond to Relayed PAD Messages” section.
Configuring the LNS (or Multihop Node) to Respond to Relayed PAD Messages
On the router that responds to relayed PAD messages, you must configure a PPPoE group and attach it
to a VPDN group that accepts dial in calls for L2TP. The relayed PAD messages will be passed from the
VPDN L2TP tunnel and session to the PPPoE broadband group for receiving the PAD responses.
SUMMARY STEPS
1. enable
2. configure terminal
3. vpdn-group vpdn-group-name
4. accept-dialin
5. protocol l2tp
6. virtual-template template-name
7. exit
8. terminate-from hostname host-name
9. relay pppoe bba-group pppoe-bba-group-name
10. exit
DETAILED STEPS
Example:
Router# configure terminal
Step 3 vpdn-group vpdn-group-name Creates a VPDN group and enters VPDN group
configuration mode.
Example:
Router(config)# vpdn-group Group-A
Step 4 accept-dialin Configures the LNS to accept tunneled PPP
connections from a LAC and creates an
accept-dialin VPDN subgroup.
Example:
Router(config-vpdn)# accept-dialin
Cisco IOS Release: Multiple releases (see the Feature History table)
4
PPPoE Relay
How to Configure PPPoE Relay
Example:
Router(config-vpdn-req-in)# protocol l2tp
Step 6 virtual-template template-number Specifies which virtual template will be used to
clone virtual access interfaces.
Example:
Router(config-vpdn-req-in)# virtual-template 2
Step 7 exit Exits to VPDN group configuration mode.
Example:
Router(config-vpdn-req-in)# exit
Step 8 terminate-from hostname host-name Specifies the LAC host name that will be required
when the VPDN tunnel is accepted.
Example:
Router(config-vpdn)# terminate-from hostname LAC-1
Step 9 relay pppoe bba-group pppoe-bba-group-name Specifies the PPPoE BBA group that will respond
to the PAD messages.
Example: • The PPPoE BBA group name is defined with
Router(config-vpdn)# relay pppoe bba-group group-2 the bba-group pppoe group-name global
configuration command.
• See the “RADIUS VPDN Group User Profile
Entry for the LNS” section for the equivalent
RADIUS profile entry.
Step 10 exit Exits to global configuration mode.
Example:
Router(config-vpdn)# exit
Cisco IOS Release: Multiple releases (see the Feature History table)
5
PPPoE Relay
How to Configure PPPoE Relay
SUMMARY STEPS
1. enable
2. show pppoe session
3. show pppoe relay context all
4. clear pppoe relay context
DETAILED STEPS
Troubleshooting Tips
Use the following privileged EXEC commands to help you troubleshoot the PPPoE Relay feature:
• debug ppp forwarding
• debug ppp negotiation
• debug pppoe events
• debug pppoe packets
• debug vpdn l2x-events
• debug vpdn l2x-packets
Cisco IOS Release: Multiple releases (see the Feature History table)
6
PPPoE Relay
Configuration Examples for PPPoE Relay
Cisco IOS Release: Multiple releases (see the Feature History table)
7
PPPoE Relay
Configuration Examples for PPPoE Relay
Cisco IOS Release: Multiple releases (see the Feature History table)
8
PPPoE Relay
Configuration Examples for PPPoE Relay
virtual-template 2
terminate-from hostname User2-lac-domain
local name User3-lns-domain
relay pppoe group group_1
!
!
interface Loopback0
no ip address
!
!
interface Loopback123
ip address 10.23.3.2 255.255.255.0
!
!
interface FastEthernet0/0
ip address 10.0.195.133 255.255.255.0
duplex auto
speed auto
no cdp enable
!
!
interface Virtual-Template2
mtu 1492
ip unnumbered Loopback123
ip access-group virtual-access3#234 in
ppp mtu adaptive
ppp authentication chap
ppp chap hostname User3-lns-domain
!
!
ip default-gateway 10.0.195.1
ip classless
ip route 0.0.0.0 0.0.0.0 10.0.195.1
!
!
bba-group pppoe group_1
virtual-template 2
!
Cisco IOS Release: Multiple releases (see the Feature History table)
9
PPPoE Relay
Configuration Examples for PPPoE Relay
Cisco IOS Release: Multiple releases (see the Feature History table)
10
PPPoE Relay
Configuration Examples for PPPoE Relay
RADIUS VPDN Group User Profile Entry for the LNS: Example
The following is an example of a typical RADIUS subscriber profile entry for an LNS:
cisco.com Password = "password"
Tunnel-Type = L2TP,
Tunnel-Server-Endpoint = .....,
Tunnel-Client-Auth-ID = "client-id",
Tunnel-Server-Auth-ID = "server-id",
Cisco:Cisco-Avpair = "vpdn:l2tp-tunnel-password=password",
Cisco:Cisco-Avpair = "vpdn:l2tp-nosession-timeout=never",
Cisco:Cisco-Avpair = "vpdn:relay-pppoe-bba-group=group-name"
Tunnel-Assignment-Id = assignment-id
Cisco IOS Release: Multiple releases (see the Feature History table)
11
PPPoE Relay
Additional References
Additional References
The following sections provide referenced related to the PPPoE Relay feature.
Related Documents
Related Topic Document Title
VPDN tunnels Cisco IOS Dial Technologies Configuration Guide; refer to the
“Configuring Virtual Private Networks” chapter in the “Virtual
Templates, Profiles, and Networks” part
VPDN tunnel commands Cisco IOS Dial Technologies Command Reference
Tunnel switching L2TP Tunnel Switching feature module
PPPoE broadband groups Cisco IOS Wide-Area Networking Configuration Guide; refer to the
chapters in the “Broadband Access” part
PPPoE broadband commands Cisco IOS Wide-Area Networking Command Reference
Standards
Standards Title
None —
Cisco IOS Release: Multiple releases (see the Feature History table)
12
PPPoE Relay
Command Reference
MIBs
MIBs MIBs Link
None To locate and download MIBs for selected platforms, Cisco IOS
releases, and feature sets, use Cisco MIB Locator found at the following
URL:
http://www.cisco.com/go/mibs
RFCs
RFCs Title
RFC 2516 “Method for Transmitting PPP Over Ethernet (PPPoE)”
L2TP Active Discovery Relay for PPPoE Network Working Group Internet-Draft, L2TP Active Discovery Relay
for PPPoE, which can be seen at
http://www.ietf.org/internet-drafts/draft-dasilva-l2tp-relaysvc-06.txt
Technical Assistance
Description Link
Technical Assistance Center (TAC) home page, http://www.cisco.com/public/support/tac/home.shtml
containing 30,000 pages of searchable technical
content, including links to products, technologies,
solutions, technical tips, and tools. Registered
Cisco.com users can log in from this page to access
even more content.
Command Reference
This section documents new commands. All other commands used with this feature are documented in
the Cisco IOS Release 12.3T command reference publications.
New Commands
• clear pppoe relay context
• relay pppoe bba-group
• service relay
• show pppoe relay context all
• show pppoe session
Cisco IOS Release: Multiple releases (see the Feature History table)
13
PPPoE Relay
clear pppoe relay context
Usage Guidelines Use this command to clear relay contexts created for relaying PAD messages.
Examples The following example clears all PPPoE relay contexts created for relaying PAD messages:
Router# clear pppoe relay context all
Cisco IOS Release: Multiple releases (see the Feature History table)
14
PPPoE Relay
relay pppoe bba-group
Usage Guidelines On the router that responds to relayed PAD messages, this command configures a PPPoE group and
attaches it to a virtual private dial-up network (VPDN) group that accepts dial-in calls for Layer 2 Tunnel
Protocol (L2TP). The relayed PAD messages will be passed from the VPDN L2TP tunnel or session to
the PPPoE broadband group for receiving the PAD response.
Examples The following partial example shows how to configure a tunnel switch (or L2TP network server) to
respond to PAD messages. The relay pppoe bba-group command configures PPPoE “group-1”, which
is attached to accept dial-in VPDN group “Group-A”.
.
.
.
vpdn-group Group-A
! Configure an L2TP tunnel for PPPoE Relay
accept-dialin
protocol l2tp
.
.
.
terminate-from hostname LAC-1
relay pppoe bba-group group-1
.
.
.
! Configure the PPPoE group to respond to the relayed PAD messages
bba-group pppoe group-1
Cisco IOS Release: Multiple releases (see the Feature History table)
15
PPPoE Relay
relay pppoe bba-group
Cisco IOS Release: Multiple releases (see the Feature History table)
16
PPPoE Relay
service relay
service relay
To enable relay of PPPoE Active Discovery (PAD) messages over a Layer 2 Tunnel Protocol (L2TP)
tunnel, use the service relay command in subscriber profile configuration mode. To disable message
relay, use the no form of this command.
Syntax Description pppoe Provides relay service using PPP over Ethernet (PPPoE) using a virtual
private dialup network (VPDN) L2TP tunnel for the relay.
vpdn group Provides VPDN service by obtaining the configuration from a predefined
vpdn-group-name VPDN group.
Usage Guidelines The service relay command is configured as part of a subscriber profile. The subscriber profile name is
obtained based on the authorization key specified in the service profile PPPoE broadband access (BBA)
group configuration command. See the “Examples” section for clarification.
Examples The following example configures the group named Sample1.net to contain outgoing tunnel information
for the relay of PAD messages over an L2TP tunnel:
subscriber profile profile-1
! Configure profile for PPPoE Relay
service relay pppoe vpdn group Sample1.net
!
bba-group pppoe group-1
virtual-template 1
service profile profile-1
Cisco IOS Release: Multiple releases (see the Feature History table)
17
PPPoE Relay
service relay
Command Description
service profile Assigns a subscriber profile to a PPPoE profile.
subscriber profile Defines the SSS policy for searches of a subscriber profile database.
Cisco IOS Release: Multiple releases (see the Feature History table)
18
PPPoE Relay
show pppoe relay context all
Usage Guidelines Use this command to display relay contexts created for relaying PAD messages.
Examples The following is sample output from the show pppoe relay context all command:
Router# show pppoe relay context all
Table 1 describes the significant fields shown in the show pppoe relay context all command output.
Field Description
Total PPPoE relay contexts PPPoE relay contexts created for relaying PAD messages.
UID Unique identifier for the relay context.
ID PPPoE session identifier for the relay context.
Subscriber-profile Name of the subscriber profile that is used by the PPPoE group
associated with the relay context.
State Shows the state of the relay context, which will be one of the
following:
• INVALID—Not valid.
• RELFWD—PPPoE relay context was forwarded.
• REQ_RELAY—Relay has been requested.
Cisco IOS Release: Multiple releases (see the Feature History table)
19
PPPoE Relay
show pppoe relay context all
Cisco IOS Release: Multiple releases (see the Feature History table)
20
PPPoE Relay
show pppoe session
Syntax Description all (Optional) Displays detailed information about the PPP over Ethernet
(PPPoE) session.
packets (Optional) Displays packet statistics for the PPPoE session.
Examples The following is sample output for the show pppoe session command:
Router# show pppoe session
Table 2 describes the significant fields shown in the show pppoe session command output.
Cisco IOS Release: Multiple releases (see the Feature History table)
21
PPPoE Relay
show pppoe session
Field Description
State Displays the state of the session, which will be one of the following:
• FORWARDED
• FORWARDING
• LCP_NEGOTIATION
• LOCALLY_TERMINATED
• PPP_START
• PTA_BINDING
• RELFWD (a PPPoE session was forwarded for which the Active
discovery messages were relayed)
• SHUTTING_DOWN
• VACCESS_REQUESTED
Uniq ID Unique identifier for the PPPoE session.
PPPoE SID PPPoE session identifier.
RemMAC Remote MAC address.
LocMAC Local MAC address.
Port Port type and number.
VT Virtual template interface.
VA Virtual access interface.
CCVP, the Cisco logo, and Welcome to the Human Network are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn is
a service mark of Cisco Systems, Inc.; and Access Registrar, Aironet, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, Cisco, the Cisco
Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity,
Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS,
iPhone, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, LightStream, Linksys, MeetingPlace, MGX, Networkers,
Networking Academy, Network Registrar, PIX, ProConnect, ScriptShare, SMARTnet, StackWise, The Fastest Way to Increase Your Internet Quotient,
and TransPath are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a
partnership relationship between Cisco and any other company. (0711R)
Cisco IOS Release: Multiple releases (see the Feature History table)
22