show pppoe lockout vlan-identifier

Syntax

Description

Display information about the lockout condition or lockout grace period for all PPPoE subscriber sessions associated with the specified VLAN encapsulation type identifiers. Because the lockout condition persists even in the absence of an underlying interface or after automatic removal of the VLAN or VLAN demux interface, using the show pppoe lockout vlan-identifier command enables you to display the lockout condition for PPPoE clients by specifying VLAN identifying characteristics instead of the underlying interface name.

The following characteristics comprise the VLAN encapsulation type identifier:

Device name (physical interface or aggregated Ethernet bundle)
Stacked VLAN (S-VLAN) ID (also known as the outer tag)
VLAN ID (also known as the inner tag)

You can configure PPPoE subscriber session lockout, also known as PPPoE short-cycle protection, for VLAN, VLAN demux, and PPPoE-over-ATM dynamic subscriber interfaces.

Options

device-name

Name of the Ethernet physical interface or aggregated Ethernet bundle associated with the PPPoE client for which you want to display lockout information.

svlan-identifier

(Optional) A valid S-VLAN identifier associated with the PPPoE client for which you want to display lockout information.

Range: 1 through 4094

vlan-identifier

(Optional) A valid VLAN identifier associated with the PPPoE client for which you want to display lockout information.

Range: 1 through 4094

Required Privilege Level

view

Output Fields

Table 1 lists the output fields for the show pppoe lockout vlan-identifier command. Output fields are listed in the approximate order in which they appear.

Table 1: show pppoe lockout vlan-identifier Output Fields
Field Name	Field Description
`underlying-interface-name`	Name of the PPPoE underlying logical interface. If no associated underlying interface exists, the underlying interface name is not displayed. Instead, the command output displays only the encapsulation type identifier.
`Index`	Index number of the logical interface, which reflects its initialization sequence. If no associated underlying interface exists, the index number is not displayed. Instead, the command output displays only the encapsulation type identifier.
`Device`	Name of the Ethernet physical interface or aggregated Ethernet bundle.
`SVLAN`	Stacked VLAN ID, also known as the outer tag.
`VLAN`	VLAN ID, also know as the inner tag.
`Short Cycle Protection`	State of PPPoE short-cycle protection, also known as PPPoE subscriber session lockout, on the underlying interface: `circuit-id`—Filters PPPoE client sessions by their agent circuit identifier (ACI) value when configured for short-cycle protection. `mac-address`—Filters PPPoE client sessions by their unique media access control (MAC) address when configured for short-cycle protection . `off`—Short-cycle protection not configured for PPPoE client sessions.
`Lockout Time (seconds)`	PPPoE lockout time range, the number of PPPoE clients in lockout condition, and the number of PPPoE clients in a lockout grace period: `Min`—Minimum lockout time, in seconds, configured on the PPPoE underlying interface. `Max`—Maximum lockout time, in seconds, configured on the PPPoE underlying interface. `Total clients in lockout`—Number of PPPoE clients currently undergoing lockout. `Total clients in lockout grace period`—Number of PPPoE clients currently in a lockout grace period. A lockout grace period occurs when the time between lockout events is greater than either 15 minutes or the maximum lockout time.
`Client Address`	MAC source address or agent circuit identifier (ACI) value of the PPPoE client.
`Current`	Current lockout time, in seconds; displays `0` (zero) if the PPPoE client is not undergoing lockout.
`Elapsed`	Time elapsed into the lockout period, in seconds; displays `0` (zero) if the PPPoE client is not undergoing lockout.
`Next`	Lockout time, in seconds, that the router uses for the next lockout event; displays a nonzero value if the PPPoE client is currently in a lockout grace period.

Sample Output

show pppoe lockout vlan-identifier device-name vlan-id (Single-Tagged VLAN on Aggregated Ethernet Bundle)
show pppoe lockout vlan-identifier device-name svlan-id vlan-id (Dual-Tagged VLAN on Gigabit Ethernet Interface)
show pppoe lockout vlan-identifier device-name (Untagged VLAN on Aggregated Ethernet Bundle)