close

keyboard_arrow_left

Table of Contents Expand all

list Table of Contents

English

show pppoe lockout

date_range 19-Nov-23

arrow_backward

arrow_forward

Syntax

content_copy zoom_out_map
show pppoe lockout
<underlying-interface-name>

Description

Display summary information about PPPoE clients currently undergoing lockout or currently in a lockout grace period on all PPPoE underlying logical interfaces or on a specified PPPoE underlying logical interface. You can configure PPPoE subscriber session lockout, also known as short-cycle protection, for VLAN, VLAN demux, and PPPoE-over-ATM dynamic subscriber interfaces.

Options

none	Display information about the lockout condition and the lockout grace period for PPPoE clients on all PPPoE underlying logical interfaces.
`underlying-interface-name`	(Optional) Name of the PPPoE underlying logical interface. If you do not specify an underlying interface, the router iteratively displays output for all existing clients undergoing lockout per PPPoE underlying logical interface.

Required Privilege Level

view

Output Fields

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

Table 1: show pppoe lockout Output Fields
Field Name	Field Description
`underlying-interface-name`	Name of the PPPoE underlying logical interface.
`Index`	Index number of the logical interface, which reflects its initialization sequence.
`Device`	Name of the 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.
`VPI`	Virtual path identifier value for the PPPoE client.
`VCI`	Virtual circuit identifier value for the PPPoE client.
`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 Enabling short-cycle protection temporarily prevents (locks out) a failed or short-lived (short-cycle) PPPoE subscriber session from reconnecting to the router for a default or configurable period of time.
`Lockout Time (seconds)`	Displays the 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 idenfiier (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 (ACI-Based Short-Cycle Protection)
show pppoe lockout (MAC Address-Based Short-Cycle Protection)
show pppoe lockout (Short-Cycle Protection Not Configured)