Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All
     

    Related Documentation

     

    Monitoring Subscriber Information

    Purpose

    Display active subscribers on the router. If you specify a username, the router displays only the users that match the username. When you issue the show subscribers command in the default virtual router, all users are displayed. When you issue the show subscribers command in a nondefault virtual router, only those users attached to that virtual router are displayed. The following list describes keywords that you can issue with the show subscribers command:

    • You can specify the domain, interface, port, profile, slot, username, or virtual-router keyword on all routers to filter the results. If you do not specify a keyword, all active users are displayed.
    • When you use the interface keyword to display detailed subscriber information by interface, you must also specify the atm, ethernet, or lag keyword, an interface specifier, and, optionally, a subinterface specifier.
    • When you use the username keyword to display detailed subscriber information using the subscriber username, you must specify the complete username with the domain name (if available) regardless of the status of the strip domain feature on a virtual router or AAA domain map.
    • If you specify the lag keyword, the output displays active subscribers for the specified LAG interface. By default, the aaa intf-desc-format include sub-intf enable command includes the subinterface and S-VLAN ID in the LAG interface ID. Use the aaa intf-desc-format include sub-intf disable command to exclude the subinterface and S-VLAN ID from the LAG interface ID.
    • The output displayed in the Interface field depends on the configuration of two commands at the time the subscriber logs in: aaa intf-desc-format include sub-intf and aaa intf-desc-format include adapter (for the E120 and E320 Broadband Services routers).
      • When you issue the aaa intf-desc-format include sub-intf disable command, the subinterface is stripped from the subscriber’s interface field at login and is not displayed in the output. In the default state, or when you issue the aaa intf-desc-format include sub-intf enable command, the subinterface is included in the subscriber’s interface field at login and is displayed in the output.
      • When you issue the aaa intf-desc-format include adapter disable command, the adapter is stripped from the subscriber’s interface field at login and is not displayed in the output. In the default state, or when you issue the aaa intf-desc-format include adapter enable command, the adapter is included in the subscriber’s interface field at login and is displayed in the output.
      • Even when the subinterface has been stripped from the subscriber’s interface field, you can still include the subinterface specifier in the show subscribers interface command. Even though the subinterface itself is not displayed, only subscribers on the specified subinterface are displayed.
      • The preceding considerations do not apply when you issue the summary keyword. The output displayed in the Interface field of summary versions is not affected by the state of either the aaa intf-desc-format include sub-intf command or the aaa intf-desc-format include adapter command when the subscriber logs in.
    • You can issue the ipv6 keyword to display all IPv6 subscribers or include the IPv6 prefix to limit the display to only IPv6 subscribers on a specific network.
    • You can issue the icr-partition keyword to display active subscribers for a particular ICR partition configured on a chassis.

      Note: If you attempt to bring up tunneled subscribers on ACI-based VLAN subinterfaces on LAC devices with subscriber groups that are based on S-VLAN IDs (using the ip vrrp vrid icr-partition group svlan command on S-VLAN subinterfaces), the VLAN subinterface does not come up and a log message to denote its down state is not generated. If you attempt to bring up tunneled subscribers on ACI-based VLAN subinterfaces on LAC devices with subscriber groups that are based on VLAN IDs (using the ip vrrp vrid icr-partition group vlan command on VLAN subinterfaces), the subscribers over tunnels are brought up. However, on the LAC device, the subscribers are logged in outside of the ICR partition.

      This behavior is expected when attempts are made to log in tunneled subscribers over ACI-based VLAN subinterfaces configured with ICR partitions with VLAN-based grouping or S-VLAN-based grouping.

    • You can use the profile keyword to list subscribers who share the same profile.
    • You can specify the summary keyword to display only summary information about active subscribers.
    • In the Interface field in the output of the show subscribers command, for subscribers that are logged in to the router over VLAN interfaces configured on the LAG bundle using protocols such as DHCP or PPPoE, the logged-in subscriber name is displayed against the LAG bundle on the member interface where the user session is established. The subscriber sessions are displayed for the corresponding major interfaces, such as Ethernet, only if the subscribers are logged in over VLAN subinterfaces configured over major interfaces.

    Action

    To display general subscriber information:

    host1# show subscribers
    
                                 Subscriber List
                                 ----------------
                                                               Virtual
          User Name           Type         Addr|Endpt           Router
    -----------------------   -----   --------------------   ------------
    fred                      tst     10.10.65.86/radius     default  
    bert                      tst     192.168.10.3/user      default
          User Name                      Interface                          
    -----------------------   -------------------------------- 
    fred                      atm 2/1.42:100.104                   
    bert                      FastEthernet 5/2.4                   
          User Name               Login Time           Circuit Id      
    -----------------------   -------------------   ---------------- 
    fred                      06/05/12 10:58:42     atm 5/1.3
    bert                      06/05/12 10:59:08      
         User Name               Remote Id      
    -----------------------   ----------------
    fred           
    bert                      (800) 555-1212 
    

    To display detailed information about subscribers on the specified interface:

    host1# show subscribers interface ethernet 5/2                             
                                    Subscriber List
                                    ---------------
                                                                Virtual
           User Name           Type         Addr|Endpt           Router
    ------------------------   -----   --------------------   ------------
    bert                       tst     192.168.10.3/user      default
           User Name                      Interface
    ------------------------   --------------------------------
    bert                       FastEthernet 5/2.4
           User Name               Login Time           Circuit Id     
    ------------------------   -------------------   ----------------
    bert                       06/05/12 10:59:08
           User Name              Remote Id      
    -----------------------    ----------------
    bert                      (800) 555-0000 
    

    To display detailed information about subscribers on the specified LAG interface:

    host1# show subscribers interface lag lag2.1:1-1
    Subscriber List --------------- User Name Type Addr|Endpt Router ------------- ----- ----------- --------- 4101DHCPCLIENT@CT.NET ip 2.0.0.3/user default User Name Interface ------------------------ ------------ 4101DHCPCLIENT@CT.NET lag lag2.1:1-1 User Name Login Time Circuit Id ------------------------ ------------------- ---------------- 4101DHCPCLIENT@CT.NET 09/10/29 02:07:51 User Name Remote Id ------------------------ ---------------- 4101DHCPCLIENT@CT.NET

    To display detailed information about subscribers on the specified slot:

    host1# show subscribers slot 5
                                 Subscriber List
                                 ---------------
                                                                Virtual
           User Name           Type         Addr|Endpt           Router
    ------------------------   -----   --------------------   ------------
    fred                       tst     10.10.65.86/radius     default 
           User Name                      Interface
    ------------------------   --------------------------------
    fred                       atm 5/1.42:100.104 
           User Name               Login Time           Circuit Id     
    ------------------------   -------------------   ----------------
    fred                       06/05/12 10:58:42     atm 5/1.3
           User Name              Remote Id      
    -----------------------    ----------------   
    fred                                  
    

    To display detailed information about subscribers who share the same profile:

    host1# show subscribers profile aaa
                                 Subscriber List
                                 ---------------
                                                                Virtual
           User Name           Type         Addr|Endpt           Router
    ------------------------   -----   --------------------   ------------
    user                       ppp     20.10.10.3/local       default
    user                       ppp     20.10.10.8/local       default
           User Name                      Interface
    ------------------------   --------------------------------
    user                       FastEthernet 1/5
    user                       FastEthernet 1/5
           User Name               Login Time           Circuit Id
    ------------------------   -------------------   ----------------
    user                       12/08/21 11:36:05
    user                       12/08/22 16:34:53
           User Name              Remote Id             Profile Name
    ------------------------   ----------------   ------------------------
    user                                          aaa
    user                                          aaa

    To display the number of subscribers who share the same profile:

    host1# show subscribers summary profile
    
              Profile Name             Count
    --------------------------------   ------
    aa                                 2
    aaa                                2
    aab                                2
    Total Subscribers : 6 (chassis-wide total)
    Peak  Subscribers : 6 (chassis-wide total)

    To display the number of subscribers on each virtual router, as well as the total and peak subscribers for the chassis:

    host1#show subscribers summary 
      Virtual
       Router      Subscribers     Ppp       Ip      Tnl     Total
    ------------   ------------   ------   ------   ------   ------
    default        1              1        0        0        1
    Total Subscribers : 10 (chassis-wide total)
    Peak  Subscribers : 15 (chassis-wide total)

    To display the number of subscribers on each port:

    host1#show subscribers summary port
    Interface      Count
    ------------   ------
    3/1            5
    2/1            5
    Total Subscribers : 10 (chassis-wide total)
    Peak  Subscribers : 15 (chassis-wide total) 

    To display the number of subscribers by domain name:

    host1#show subscribers summary domain
              Domain Name              Count
    --------------------------------   ------
    abc.com                            5
    iii.com                            5
    Total Subscribers : 10 (chassis-wide total)
    Peak  Subscribers : 15 (chassis-wide total) 

    To display the number of subscribers by interface:

    host1#show subscribers summary interface
    
    Interface         		      Count
    --------------------   		-----
    ATM 3/2.1            		    1
    ETHERNET 5/2.1  		          2
    LAG lag1.100    		          1
    Total Subscribers: 4 (chassis-wide total)
    Peak Subscribers:  8 (chassis-wide total)
    

    To display the number of subscribers by slot:

    host1#show subscribers summary slot
      Slot     Count
    --------   -----
    3          1
    5          4
    Total Subscribers : 5 (chassis-wide total)
    Peak  Subscribers : 8 (chassis-wide total)

    To display the number of subscribers by ICR partition:

    host1#show subscribers summary icr-partition
             ICR-Partition (location-id)               Count
    --------------------------------------------      --------
    3/0.1.4              			                        5
    3/0.2.5              			                        5
    Total Subscribers: 10 (chassis-wide total)
    Peak Subscribers: 15 (chassis-wide total)
    

    To display the number of subscribers that are logged in on top of a LAG bundle:

    host1#show subscribers summary lag 
         Interface         Count 
    --------------------   ------
    LAG OLT                6     
    Total Subscribers : 6 (chassis-wide total)
    Peak  Subscribers : 6 (chassis-wide total)
    

    Meaning

    Table 1 lists the show subscribers command output fields.

    Table 1: show subscribers Output Fields

    Field Name

    Field Description

    User Name

    Name of the subscriber

    Note: The complete username with the domain name (if available) is displayed regardless of the status of the strip domain feature on a virtual router or AAA domain map.

    Type

    Type of subscriber: atm, ip, ipsec, ppp, tnl (tunnel), or tst (test)

    Addr | Endpt

    IP or IPv6 address and source of the address: l2tp, local, dhcp, radius, or user. For local, dhcp, radius, and user endpoints, the address is that of the user. When the endpoint is l2tp, the address is that of the LNS.

    Virtual Router

    Name of the virtual router context

    Interface

    Interface specifier over which the subscriber is connected

    Login Time

    Date, in YY/MM/DD format, and time the subscriber logged in

    Circuit Id

    User circuit ID value specified by PPPoE

    Remote Id

    User remote ID value specified by PPPoE

    Total Subscribers

    Number of active subscribers, chassis-wide

    Peak Subscribers

    Maximum value that is displayed in the Total Subscriber field during the time the router has been active, chassis-wide

    Subscribers

    Number of subscribers; the sum of the Ppp and Ip fields

    Ppp

    Number of PPPoA and PPPoE users, combined

    Ip

    Number of DHCP and IP subscriber manager users, combined

    Tnl

    Number of users tunneled to an LNS

    Total

    Total number of users per virtual router; the sum of the Ppp, Ip, and Tnl fields

    Domain Name

    Domain name used by the subscriber

    ICR-Partition (location-id)

    A unique identifier for each ICR partition on a chassis. Note that this ID is different from the partition name, which is configured using the ip vrrp vrid icr-partition partitionName command.

    Count

    Number of subscribers

    Slot

    Number of slot in the chassis

     

    Related Documentation

     

    Published: 2014-08-20