Cisco ASR 9000 Series Aggregation Services Router Broadband Network Gateway Command Reference, Release 4.2.x
PPPoE Commands
Downloads: This chapterpdf (PDF - 1.34MB) The complete bookPDF (PDF - 3.59MB) | Feedback

PPPoE Commands

PPPoE Commands

This module describes the Cisco IOS XR software commands used to configure the PPPoE commands for Broadband Network Gateway (BNG) on the Cisco ASR 9000 Series Router. For details regarding the related configurations, refer to the Cisco ASR 9000 Series Aggregation Services Router Broadband Network Gateway Configuration Guide.

pppoe bba-group

To add configuration for a particular BBA-Group and to enter the BBA-Group submode, use the pppoe bba-group command in global configuration mode. To disable this feature, use the no form of this command.

pppoe bba-group bba-group name { ac | name | new_name | control-packets | priority | priority_bits | service | { name | new_name | selection | disable } | sessions | { access-interface | circuit-id | mac | mac-iwf | { access-interface | pair | limit } | max | { access-interface | limit | throttle } } | limit | session_limit | tag | { ppp-max-payload | { deny | minimum | minimum_payload } } }

no pppoe bba-group

Syntax Description

bba-group-name

Specifies the bba group name.

ac

Enables modification of the access concentrator configuration.

name

Indicates the name change to include in the AC tag.

new_name

Specifies the new name.

control-packets

Enables change of control-packets configuration.

priority

Sets the priority to use in PPPoE and PPP control packets.

priority_bits

Specifies the priority bits for outgoing PPPoE and PPP control packets. This ranges between 0 and 7, where 0 indicates highest priority and 7 indicates the lowest.

service

Enables modification of service configuration.

name

Configures the service name.

new_name

Specifies the new service name.

selection

Specifies the selection of unrequested service names.

disable

Disables the advertising of unrequested service names.

sessions

Enables modification of sessions configuration.

access-interface

Limits PPPoE sessions on any one access interface.

circuit-id

Limits PPPoE sessions with any one circuit-id.

mac

Limits or throttles PPPoE sessions from any one mac-address.

mac-iwf

Limits or throttles IWF PPPoE sessions from any one mac-address.

max

Sets a per-card session limit.

limit

Specifies the action of limiting the PPPoE sessions for various attributes.

session_limit

Specifies the access-interface session limit. The value ranges from 1 to 65535.

tag

Enables modification of tag configuration.

ppp-max-payload

Modifies the ppp-max-payload configuration and allows to configure minimum and maximum payloads.

deny

Ignores the ppp-max-payload tag.

minimum

Configures the minimum payload.

minimum_payload

Specifies the value of the minimum payload. The value ranges from 500 to 2000.

Command Default

None

Command Modes

Global configuration mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

BBA-Groups are configured globally (these are essentially configuration templates), containing the PPPoE configuration settings.

When this configuration changes to use a different BBAGroup, then all existing PPPoE sessions running under the interface are terminated.

Task ID

Task ID Operation

ppp

read, write

Examples

This is an example of configuring the pppoe bba-group command in global configuration mode:

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# pppoe bba-group bba1
RP/0/RSP0/CPU0:router(config-bbagroup)# ac name red
RP/0/RSP0/CPU0:router(config-bbagroup)# service name blue
RP/0/RSP0/CPU0:router(config-bbagroup)# service selection disable
RP/0/RSP0/CPU0:router(config-bbagroup)# sessions max limit 45
RP/0/RSP0/CPU0:router(config-bbagroup)# tag ppp-max-payload minimum 689 maximum 788

Related Commands

Command

Description

pppoe enable bba-group

Enables PPPoE on an interface.

pppoe enable bba-group

To enable pppoe on an interface, use the pppoe enable bba-group command in interface configuration mode. To disable the pppoe on the interface, use the no form of this command.

pppoe enable bba-group bba-group name

no pppoe enable bba-group

Syntax Description

bba-group name

Specifies the name of the bba-group.

Command Default

If no BBA-Group is specified, then the default configuration options are used, else the BBA-Group's configuration is used on this interface.

Command Modes

Interface configuration

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When this configuration changes to use a different BBAGroup, then all existing PPPoE sessions running under the interface are terminated.

Task ID

Task ID Operation

ppp

read, write

Examples

This is an example of configuring the pppoe enable bba-group command in interface configuration mode:

RP/0/RSP0/CPU0:router#configure
RP/0/RSP0/CPU0:router(config)#interface Bundle-Ether100.10
RP/0/RSP0/CPU0:router(config-if)# pppoe enable bba-group bba1

Related Commands

Command

Description

pppoe bba-group

Enables you to add configuration for a particular bba-group.

show pppoe interfaces

To display a summary of the protocol state for the specified PPPoE interface filtered by circuit-id, remote-id, interface or location, use the show pppoe interfaces command in the EXEC mode.

show pppoe interfaces { circuit-id | circuit_id | remote-id | remote_id | access-interface | type | interface-path-id | location | node | all }

Syntax Description

circuit-id

Shows information for a given circuit-id.

circuit_id

Specifies the circuit-id to show data for.

remote-id

Show information for a given remote-id.

remote_id

Specifies the remote-id to show data for.

access-interface

Shows PPPoE status for all sessions on a single access interface.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

location

Shows PPPoE status for all sessions at a location.

node

Specifies the fully qualified location specification.

all

Shows PPPoE status for all sessions.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

ppp

read

Examples

This is a sample output of the show pppoe interfaces command:

RP/0/RSP0/CPU0:router# show pppoe interfaces Loopback1
Loopback1 is Complete
Session id: 1
Access interface: Loopback1
BBA-Group: blue
Local MAC address: aabb.cc00.8301
Remote MAC address: aabb.cc00.8201
Tags:
Service-Name: service1
Max-Payload: 1500
IWF
Circuit-ID: circuit1
Remote-ID: remote1

show pppoe limits

To show the PPPoE session limit information, use the show pppoe limits command in the EXEC mode.

show pppoe limits [active] [ access-interface type interface-path-id | bba-group bba-group-name | | location node ]

Syntax Description

active

Shows only those throttles that are currently blocking packets.

access-interface

Shows PPPoE status for all sessions on a single access interface.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

bba-group

Shows throttles for all interfaces with a given bba-group.

bba_group_name

Specifies the bba-group to show throttle for.

location

Shows PPPoE status for all sessions at a location.

node

Specifies the fully qualified location specification.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

ppp

read

Examples

This is a sample output of the show pppoe limits command:

RP/0/RSP0/CPU0:router# show pppoe limits active access-interfaces loopback 45
BBA-Group TEST
--------------
Card session limit information:
Maximum session limit: 50 sessions
Warning threshold: 40 sessions
State #Sessions
----- ---------
Block 50
Access-interface session limits not configured.
MAC session limits not configured.
MAC-IWF session limits not configured.
Circuit-ID session limit information:
Maximum session limit: 50 sessions
Warning threshold: 40 sessions
Circuit-ID State #Sessions
---------- ----- ---------
circuit_id1 Block 50
circuit_id_field_which_can_be_up_to_sixty_four_chars_long Warn 45
circuit_id2 OK 32
circuit_id,/[]* OK 1
BBA-Group TEST2
---------------
Card session limits not configured.
Access-interfaces session limit information:
Maximum session limit: 50 sessions
Warning threshold: 40 sessions
Access-Interface State #Sessions
---------------- ----- ---------
GE0/1/0/0/0 Block 50
GE0/1/0/0/1 Warn 45
GE0/1/0/0/2 OK 32
GE0/1/0/0/0.12 OK 1
MAC session limits not configured.
MAC-IWF session limits not configured.
Circuit-ID session limits not configured.

Related Commands

Command

Description

show pppoe throttles

Shows the throttle information for the PPPoE sessions.  

show pppoe interfaces

Shows a summary of the protocol state for the specified PPPoE interface filtered by circuit-id, remote-id, interface, or location.  

show pppoe statistics

Shows the counters for packets received and sent by the PPPoE sessions.  

show pppoe summary

Shows summary information of the PPPoE sessions.  

show pppoe statistics

To show the counters for packets received and sent by the PPPoE sessions, use the show pppoe statistics command in the EXEC mode.

show pppoe statistics { access-interface | type | interface-path-id | internal | { location | node } | location | node }

Syntax Description

access-interface

Shows PPPoE status for all sessions on a single access interface.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

internal

Shows internal PPPoE statistics.

location

Shows PPPoE status for all sessions at a location.

node

Specifies the fully qualified location specification.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

ppp

read

Examples

This is the sample output of the show pppoe statistics command:

RP/0/RSP0/CPU0:router# show pppoe statistics access-interfaces Loopback 156

Packets Sent Received Dropped
----------------------------------------------------------------
PADI 0 3723 18
PADO 3182 0 0
PADR 0 1732 93
PADS (success) 1601 0 0
PADS (error) 38 0 0
PADT 158 552 9
Session-stage 0 18 17
Other 0 2 2
----- ----- -----
TOTAL 3979 6063 139

RP/0/RSP0/CPU0:router# show pppoe statistics location 0/2/cpu0

Packets Sent Received Dropped
----------------------------------------------------------------
PADI 0 3723 18
PADO 3182 0 0
PADR 0 1732 93
PADS (success) 1601 0 0
PADS (error) 38 0 0
PADT 158 552 9
Session-stage 0 18 17
Other 0 2 2
----- ----- -----
TOTAL 3979 6063 139
Packet Error Count
-------------------------------------------------------
No interface handle 1
No packet payload 1
No packet mac-address 1
Invalid version-type value 3
Bad packet length 7
Unknown interface 11
PADO receive
ed 1
PADS received 1
Unknown packet type received 1
Unexpected Session-ID in packet 1
No Service-Name Tag 11
PADT for unknown session 13
PADT with wrong peer-mac 7
PADT before PADS sent 1
Session-stage packet for unknown session 13
Session-stage packet with wrong mac 19
Session-stage packet with no error 1
Tag too short 1
Bad tag-length field 1
Multiple Service-Name tags 1
Multiple Max-Payload tags 1
Invalid Max-Payload tag 1
Multiple Vendor-specific tags 1
Unexpected AC-Name tag 1
Unexpected error tags 3
Unknown tag received 1
No IANA code in vendor tag 1
Invalid IANA code in vendor tag 1
Vendor tag too short 1
Bad vendor tag length field 1
Multiple Host-Uniq tags 1
Multiple Circuit-ID tags 1
Multiple Remote-ID tags 1
Invalid DSL tag 1
Multiple of the same DSL tag 1
Invalid IWF tag 1
Multiple IWF tags 1
Unknown vendor-tag 11
No space left in packet 1
Duplicate Host-Uniq tag received 1
Packet too long 1
-----
TOTAL 140

show pppoe summary

To show the summary information for the PPPoE sessions, use the show pppoe summary command in the EXEC mode.

show pppoe summary { per-access-interface | total } { location | node }

Syntax Description

per-access-interface

Summarizes PPPoE sessions running on each access-interface.

total

Shows the overall summary information of access-interfaces and sessions.

location

Shows PPPoE status for all sessions at a location.

node

Specifies the fully qualified location specification.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

ppp

read

Examples

This is the sample output of the show pppoe summary command:

RP/0/RSP0/CPU0:router# show pppoe summary per-access-interfaces location 0/1/cpu0

COMPLETE: Complete PPPoE Sessions
INCOMPLETE: PPPoE sessions being brought up or torn down
Interface BBA-Group READY TOTAL COMPLETE INCOMPLETE
-------------------------------------------------------------------------------
Fa0/1/0/0 blue Y 20 18 2
Fa0/1/0/1.1 red Y 128000 100010 27990
Fa0/1/0/1.2 green N 0 0 0
----------------------------------
TOTAL 2 128020 100028 27992
RP/0/0/CPU0:demo#show pppoe summary total location 0/5/cpu0
==============================
Configured Access Interfaces
==============================
Ready 300
Not-Ready 15
-----------------------------
TOTAL 315
==============================
PPPoE Sessions
==============================
Complete 3812
Incomplete 302
-----------------------------
TOTAL 4114
==============================
Flow Control
==============================
Limit 1000
In Flight 12
Dropped 212
Disconnected 6
Successful 1021

show pppoe throttles

To show the throttle information for the PPPoE sessions, use the show pppoe throttles command in the EXEC mode.

show pppoe throttles [active] [ access-interface type interface-path-id | | bba-group bba-group-name | | location node ]

Syntax Description

active

Shows only those throttles that are currently blocking packets.

access-interface

Shows PPPoE status for all sessions on a single access interface.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

bba-group

Shows throttles for all interfaces with a given bba-group.

bba_group_name

Specifies the bba-group name.

location

Shows PPPoE status for all sessions at a location.

node

Specifies the fully qualified location specification.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

ppp

read

Examples

This is the sample output of the show pppoe throttles command:

RP/0/RSP0/CPU0:router# show pppoe throttles location 0/2/cpu0

BBA-Group TEST
--------------
MAC throttle information:
Max packets per request period: 5
Request period duration: 20s
Blocking period duration: 5s
Time Since
MAC Address State left reset PADI PADR
----------- ----- ---- ----- ---- ----
aabb.ccdd.1123 Idle 30s 16s 0 0
7582.1352.e29a Monitor 3s 20s 5 5
7582.1352.e29a Block 4s 17s 6 5
MAC Access-interface throttle information:
Max packets per request period: 5
Request period duration: 20s
Blocking period duration: 5s
Time Since
Access-Int MAC Address State left reset PADI PADR
---------- ----------- ----- ---- ----- ---- ----
GE0/1/0/0 aabb.ccdd.1123 Idle 30s 16s 0 0
GE0/1/0/0 7582.1352.e29a Monitor 3s 20s 5 5
GE0/1/0/0 7582.1352.e29a Block 4s 17s 6 5
MAC IWF throttle information:
Max packets per request period: 5
Request period duration: 20s
Blocking period duration: 5s
Time Since
MAC Address State left reset PADI PADR
----------- ----- ---- ----- ---- ----
aabb.ccdd.1123 Idle 30s 16s 0 0
7582.1352.e29a Mon 3s 20s 5 5
7582.1352.e29a Block 4s 17s 6 5
BBA-Group TEST2
--------------
MAC throttling is not configured.
MAC Access-interface throttling is not configured.
MAC IWF throttling is not configured.

Related Commands

Command

Description

show pppoe limits

Shows the PPPoE session limit information.  

show pppoe interfaces

Shows a summary of the protocol state for the specified PPPoE interface filtered by circuit-id, remote-id, interface, or location.  

show pppoe statistics

Shows the counters for packets received and sent by the PPPoE sessions.  

show pppoe summary

Shows summary information of the PPPoE sessions.