close

keyboard_arrow_left

Table of Contents Expand all

list Table of Contents

English

show subscribers summary

date_range 19-Nov-23

arrow_backward

arrow_forward

Syntax

content_copy zoom_out_map
show subscribers summary
<all>
<detail | extensive | terse>
<count>
<physical-interface physical-interface-name>
<logical-system logical-system pic | port | routing-instance routing-instance | slot> 
<sub-system (agf | bng)>

Description

Display summary information for subscribers.

Options

none	Display summary information by state and client type for all subscribers.
all	(Optional) Display summary information by state, client type, and logical system and routing instance (LS:RI).
detail \| extensive \| terse	(Not supported on MX Series routers) (Optional) Display the specified level of output.
count	(Not supported on MX Series routers) (Optional) Display the count of total subscribers and active subscribers for any specified option.
logical-system `logical-system`	(Optional) Display subscribers whose logical system matches the specified logical system.
physical-interface `physical-interface-name`	(M120, M320, and MX Series routers only) (Optional) Display the count of subscribers whose physical interface matches the specified physical interface, by subscriber state, client type, and LS:RI.
pic	(M120, M320, and MX Series routers only) (Optional) Display the count of subscribers by PIC number and the total number of subscribers.
port	(M120, M320, and MX Series routers only) (Optional) Display the count of subscribers by port number and the total number of subscribers.
routing-instance `routing-instance`	(Optional) Display subscribers whose routing instance matches the specified routing instance.
slot	(M120, M320, and MX Series routers only) (Optional) Display the count of subscribers by Flexible PIC Concentrator (FPC) slot number and the total number of subscribers.
sub-system (agf \| bng)	(Optional) Display a count of subscribers using either the Access Gateway Function (AGF) or broadband network gateway (BNG) services. Note: The subsystem option is only available when both the AGF and BNG subscribers are logged into the router at the same time.

Note:

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

Starting from Junos OS 20.4R1 release, you need a license to use the Extensible Subscribers Services Manager (ESSM) feature.

Required Privilege Level

view

Output Fields

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

Table 1: show subscribers summary Output Fields
Field Name	Field Description	Level of Output
`Subscribers by State`	Number of subscribers summarized by state. The summary includes the following information: Init—Number of subscribers currently in the initialization state. Configured—Number of configured subscribers. Active—Number of active subscribers. Terminating—Number of subscribers currently terminating. Terminated—Number of terminated subscribers. Total—Total number of subscribers for all states.	`detail` none
`Subscribers by Client Type`	Number of subscribers summarized by client type. Client types can include DHCP, GRE, L2TP, PPP, PPPoE, STATIC-INTERFACE, VLAN, and VLAN-OOB. This field also displays the total number of subscribers for all client types (Total).	`detailextensive` none
`Subscribers by LS:RI`	Number of subscribers summarized by logical system:routing instance (LS:RI) combination. This field also displays the total number of subscribers for all the LS:RI combinations (Total).	`detail` none
`Subscribers by Connection Type`	Number of subscribers summarized by connection type, `Cross-connected` or `Terminated`.	`extensive`
`Subscribers by Sub-System`	Number of subscribers on the subsystem—AGF or BNG as well as the total number of subscriber.	All levels
`Interface`	Interface associated with the subscriber. The router or the switch displays subscribers whose interface matches or begins with the specified interface. The asterisk (*) indicates a continuation of addresses for the same session. For aggregated Ethernet interfaces, the output of the `summary (pic \| port \| slot)` options prefixes the interface name with ae0:. For pseudowire IFDs, this field displays both the pseudowire and the associated logical tunnel (LT) and the redundant logical tunnel (RLT) anchor interface. For example: ps0: lt-2/1/0 ps1: rlt0: lt-4/0/0	All levels
`Count`	Count of subscribers displayed for each PIC, port, or slot when those options are specified with the `summary` option. For an aggregated Ethernet configuration, the total subscriber count does not equal the sum of the individual PIC, port, or slot counts, because each subscriber can be in more than one aggregated Ethernet link. Multiple pseudowire interfaces can share a given logical tunnel or redundant logical tunnel anchor interface. Starting in Junos OS Release 18.1R1, the field displays subscribers per individual pseudowire interface. In earlier releases, the field displays the same number of subscribers for all the pseudowire interfaces that share the same tunnel interface as their anchor point.	`detailextensive` none
`Total Subscribers`	Total number of subscribers for all physical interfaces, all PICs, all ports, or all LS:RI slots.	`detailextensive` none
`IP Address/VLAN ID`	Subscriber IP address or VLAN ID associated with the subscriber in the form tpid.vlan-id	`terse`
`User Name`	Name of the subscriber.	`terse`
`LS:RI`	Logical system and routing instance associated with the subscriber.	`terse`

Sample Output

show subscribers summary
show subscribers summary all
show subscribers summary physical-interface
show subscribers summary physical-interface pic
show subscribers summary physical-interface port
show subscribers summary physical-interface slot
show subscribers summary pic
show subscribers summary pic (Aggregated Ethernet Interfaces)
show subscribers summary port
show subscribers summary port (Pseudowire Interfaces)
show subscribers summary port extensive
show subscribers summary slot
show subscribers summary terse
show subscribers summary (agf)
show subscribers summary sub-system agf