Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

show user-plane subscribers

Syntax

Description

Displays information for the BNG User Plane subscribers.

Options

None

Displays information by interface, IP address or VLAN ID, and LS:RI.

detail | extensive | terse

(Optional) Displays the specified level of output.

accounting-statistics

Displays subscriber accounting statistics. If you do not configure the statement, the CLI displays a value of 0 for the accounting statistics.

address ip-address

(Optional) Display subscribers whose IP address matches the specified address. You must specify the IPv4 or IPv6 address prefix without a netmask (for example, 192.0.2.0). If you specify the IP address as a prefix with a netmask (for example, 192.0.2.0/32), the router displays a message that the IP address is invalid and rejects the command.

client-type client-type

(Optional) Display subscribers whose client type matches one of the following client types:

  • dhcp—Dynamic Host Configuration Protocol (DHCP) clients only.

  • dotlx—802.1X clients only.

  • essm—Extensible Subscribers Services Manager (ESSM) clients only.

  • fixed-wireless-access—Fixed wireless access clients only.

  • fwauth—FwAuth (authenticated across a firewall) clients only.

  • l2tp—Layer 2 Tunneling Protocol (L2TP) clients only.

  • mlppp—Multilink Point-to-Point Protocol (MLPPP) clients only.

  • ppp—Point-to-Point Protocol (PPP) clients only.

  • pppoe—Point-to-Point Protocol over Ethernet (PPPoE) clients only.

  • static—Static clients only.

  • vlan—VLAN clients only.

  • vlan-oob—VLAN out-of-band (triggered by by Access Node Control Protocol or ANCP) clients only.

  • vpls-pw—Virtual private LAN service (VPLS) pseudowire clients only.

  • xauth—Extended Authentication (XAuth) clients only.

count

(Optional) Displays the count of total subscribers and active subscribers for any specified option.

id subscriber-id

(Optional) Displays a subscriber of a session with an ID matching the specific subscriber ID.

interface interface-name

(Optional) Displays subscribers with an interface that matches the specified interface.

license-usage

(Optional) Displays the license usage for the last 48 hours.

mac-address mac-address

(Optional) Displays subscribers with a MAC address that matches the specified MAC address.

physical-interface physical-interface-name

(Optional) Displays subscribers whose physical interface matches the specified physical interface.

routing-instance routing-instance-name

(Optional) Displays subscribers with a routing instance that matches the specified routing instance.

stacked-vlan-id stacked-vlan-id

(Optional) Displays subscribers with a stacked VLAN ID that matches the specified stacked VLAN ID.

subscriber-state subscriber-state

(Optional) Display subscribers whose subscriber state matches the specified subscriber state (ACTIVE, CONFIGURED, INIT, TERMINATED, or TERMINATING).

summary

(Optional) Displays summary information for subscribers.

vlan-id vlan-id

(Optional) Displays subscribers that have a VLAN ID that matches the specified VLAN ID, regardless of whether the subscriber uses a single-tagged or double-tagged VLAN. For subscribers using a double-tagged VLAN, this option displays subscribers where the inner VLAN tag matches the specified VLAN ID. To display only subscribers where the specified value matches only double-tagged VLANs, use the stacked-vlan-id stacked-vlan-id option to match the outer VLAN tag.

Note:

Because of display limitations, logical system and routing instance output values are truncated when necessary.

Required Privilege Level

view

Output Fields

Table 1 lists the output fields for the show user-plane subscribers command. Output fields are listed in the approximate order in which they appear.

Table 1: show user-plane subscribers Output Fields

Field Name

Field Description

Interface

Interface associated with the subscriber. The router or switch displays subscribers with interfaces that match or begin with the specified interface.

The asterisk (*) character indicates a continuation of addresses for the same session.

IP Address/VLAN ID

Subscriber IP address or VLAN ID associated with the subscriber in the form tpid.vlan-id.

No IP address or VLAN ID is assigned to a Layer 2 Tunneling Protocol (L2TP) tunnel-switched session. For these subscriber sessions the value is Tunnel-switched.

LS:RI

Logical system and routing instance associated with the subscriber.

Type

Subscriber client type (DHCP, L2TP, PPP, PPPoE, and VLAN).

IP Address

Subscriber IPv4 address.

Logical System

Logical system associated with the subscriber.

Routing Instance

Routing instance associated with the subscriber.

Interface

Name of the enhanced subscriber management logical interface, in the form demux0.nnnn (for example, demux0.3221225472), to which access-internal and framed subscriber routes are mapped.

Interface Type

Whether the subscriber interface is Static or Dynamic.

Underlying Interface

Name of the underlying interface for the subscriber session.

MAC Address

MAC address associated with the subscriber.

State

Current state of the subscriber session (Init, Configured, Active, Terminating, Tunneled).

PFE Flow ID

Forwarding flow identifier.

VLAN ID

VLAN ID associated with the subscriber in the form tpid.vlan-id.

Session ID

ID number for a subscriber session.

Service Sessions

Number of service sessions (that is, a service that is activated using RADIUS CoA) associated with the subscribers.

Service Session ID

ID number for a subscriber service session.

Service Session Name

Service session profile name.

IPv4 Input Filter Name

Name assigned to the IPv4 input filter (client or service session).

IPv4 Output Filter Name

Name assigned to the IPv4 output filter (client or service session).

Service Activation Time

Time at which the first family in this service became active.

Accounting Interval Service

How often statistics are collected for the accounting profile.

Dynamic Configuration

Values for variables that are passed into the dynamic profile from RADIUS.

Subscribers by State

Number of subscribers summarized by state. The summary information includes the following:

  • Init—Number of subscribers currently in the initialization state.

  • Configured—Number of configured subscribers.

  • Active—Number of active subscribers.

  • Terminating—Number of subscribers in the process of being terminated.

  • Terminated—Number of terminated subscribers.

  • Total—Total number of subscribers for all states.

Subscribers by Client Type

Number of subscribers, summarized by client type. Client types can include DHCP, L2TP, PPP, PPPoE, and VLAN. Also displays the total number of subscribers for all client types.

Subscribers by LS:RI

Number of subscribers, summarized by logical system:routing instance (LS:RI) combination. Also displays the total number of subscribers for all LS:RI combinations.

Redundancy Service Id

The redundancy service ID number.

Sample Output

show user-plane subscribers

show user-plane subscribers count

show user-plane subscribers detail

show user-plane subscribers client-type (PPPoE)

show user-plane subscribers client-type (DHCP)

show user-plane subscribers extensive

show user-plane subscribers interface interface-name extensive