Subscriber and Session Redundancy Commands

This module describes the Cisco IOS XR software commands used to configure the subscriber and session redundancy commands for Broadband Network Gateway (BNG) on the Cisco ASR 9000 Series Router. For details regarding the related configurations, refer to the Cisco ASR 9000 Series Aggregation Services Router Broadband Network Gateway Configuration Guide.

To use commands of this module, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using any command, contact your AAA administrator for assistance.

access-tracking (BNG)

To configure object tracking for detecting access connectivity for the specific Subscriber Redundancy Group (SRG) or Session Redundancy Group (SERG), use the access-tracking command in the respective group configuration mode.

To remove the object tracking configuration, use the no form of this command.

access-tracking access-tracking-obj

Syntax Description

access-tracking-obj

Access tracking object for the specific SRG.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Session redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

Object tracking feature allows correlation of the role of BNG SRG/SERG with the role or status of the underlying access-interface, and it is the key for automatic switchovers and for handling failure scenarios.

You must configure the track object first and then configure that track object under the SRG/SERG which holds that particular interface. This ensures that SRG/SERG primary or subordinate role follows the underlying access role.

Advertisement of the summary route for the subscriber address/subnet pool can be also controlled through the same access-tracking object (See example section). This ensures that the subscriber summary route (or routes) is activated only when the underlying access is up or active and only then it is re-distributed into core routing. The subordinate does not advertise the route into the core.

For details on configuring track object, see System Management Configuration Guide for Cisco ASR 9000 Series Routers.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure object tracking for detecting access connectivity for the specific SRG in MC-LAG scenario:

Configuring the track object: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# track mclag-be1
RP/0/RSP0/CPU0:router(config-track)# type line-protocol state
RP/0/RSP0/CPU0:router(config-track-line-prot)# interface Bundle-Ether1

Configuring that track object under the SRG which holds that particular interface: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# access-tracking mc-lag-be1

Configuring access-tracking - Routing: 


router static
 address-family ipv4 unicast
  200.0.0.0/16 Null0 track mc-lag-be1
address-family ipv6 unicast
  20::/64 Null0 track mc-lag-be1



router isis 1
 address-family ipv4 unicast
  redistribute static
 address-family ipv6 unicast
  redistribute static

accounting interim variation

To introduce a random delay between successive interim accounting messages of sessions or services in BNG, use the accounting interim variation command in subscriber manager configuration mode. To remove this random delay, use the no form of this command.

accounting interim variation value

Syntax Description

value

Interim timeout randomization value, in percentage.

The range is from 0 to 50. By default, this value is zero (0), which means there is no interim timeout randomization.

Command Default

By default, randomization is disabled.

Command Modes

Subscriber manager configuration

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

Follow these usage guidelines while applying randomization:

  • Randomization cannot be applied for too small interim timeouts (that is, for timeouts less than 2 minutes).

  • If interim timeout is T seconds, the value x is selected from an interval [L, T]. By default, L is 100 percent of T (that is, 0% variance from T).

  • The maximum value of T- L is 900 seconds (that is, 15 minutes).

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure a random delay of 50% variance between successive interim accounting messages of sessions or services: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber manager
RP/0/RSP0/CPU0:router(config-subscriber-manager)# accounting interim variation 50

bng-interface (subscriber)

To set the interface that need to be used as bng identifier, use the bng-interface command in the subscriber configuration mode.

bng-interface interface-name

Syntax Description

interface-name

Specifies the interface that will be set as the bng-identifier. The IPv4/IPv6 address of this interface is used as the bng IP address.

Command Default

None

Command Modes

Subscriber configuration

Command History

Release Modification
Release 6.5.1

This command was introduced.

Usage Guidelines

None

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to set the bng-identfier interface. 


RP/0/RSP0/CPU0:router(configure)# subscriber
RP/0/RSP0/CPU0:router(config-subscriber)# bng-interface Loopback8

Related Commands

Command Description

http-enrichment parameter-list

 Enables http header enrichment feature for BNG subscribers. 

http-enrichment parameter-list (subscriber)

 Configures the primary list of all the parameters for http-enrichment. 

clear session-redundancy

To clear the sessions for an SERG use the clear session-redundancy command in EXEC mode mode.

clearsession-redundancy [ group name [ interface interface-type interface-name interface-id ] ]

Syntax Description

interface-id

Identifier value for the access interface mapped to the subordinate SERG.

Command Default

None

Command Modes

Privileged Executive mode

Command History

Release Modification

Release 6.2.1

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

execute

Examples

This example shows how to clear the subscriber sessions for an SERG.


RP/0/RSP0/CPU0:router# clear session-redundancy group 1

clear subscriber session

To clear the subscriber sessions in BNG, use the clear subscriber session command in EXEC mode mode.

clear subscriber session { all | debug { subscriber-label } | identifier { access-interface interface-type interface-instance [ {ipv4 | ipv6 IANA} ip-address] | interface interface-type interface-instance } } [ location node-id]

Syntax Description

all

Clears all subscriber sessions.

debug subscriber-label

Clears debug tracking of unique subscriber session.

identifier

Clears the subscriber session information based on the identifier(s) you select.

access-interface

Clears the subscriber session based on the access interface name.

interface-type

Specifies the interface type whose subscriber sessions you want to delete.

interface-instance

Specifies either a physical interface instance or a virtual interface instance that you want to delete.

The details of the interface instance are as follows:

  • Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation.

    • rack: Chassis number of the rack.

    • slot: Physical slot number of the modular services card or line card.

    • module: Module number. A physical layer interface module (PLIM) is always 0.

    • port: Physical port number of the interface.

    Note

     

    In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0. Example: interface MgmtEth0/RP1/CPU0/0.

  • Virtual interface instance. Number range varies depending on interface type.
ipv4

Clears the DHCP IPv4 subscriber session information specific to an interface and IPv4 network-address/prefix.

ipv6 IANA

Clears the DHCP IPv6 subscriber session information specific to an interface and IPv6 address/prefix.
location

Clears the subscriber session information of a specific location.

node-id

Specifies the node whose subscriber sessions you want to delete. The node-id argument is entered in the rack/slot/module notation.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 6.4.1

This command was modified to include the option to clear DHCP IPv6 IANA subscriber sessions on an access-interface.

Release 4.2.0

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

execute

Examples

This example shows how to clear all the subscriber sessions in a particular node location: 


RP/0/RSP0/CPU0:router# clear subscriber session all location 0/RSP0/CPU0

This example shows how to clear DHCP IPv6 subscriber sessions on a particular access-interface: 


RP/0/RSP0/CPU0:router# clear subscriber session identifier access-interface bundle-ether 1.1 ipv6 IANA 2001:DB8:1::1

Related Commands

Command Description

show subscriber session

Displays the subscriber management session information.  

clear subscriber manager

To clear the subscriber managment internal manager information, use the clear subscriber manager command in EXEC mode.

clear subscriber manager service-profile service-name service-name

Syntax Description

service-profile

Indicates the sububscriber management service profile information.
service-name service-name

Indicates the service name.

Command Default

None

Command Modes

EXEC

Command History

Release Modification
Release 6.3.3

This command was introduced.

Usage Guidelines

The user has to clear the service profile cache from the radius download. To do this, use the show subscriber database configuration brief service-profile command to view the state of service in the "In Use By Subscriber" field. If the entry is “False”, then use the clear subscriber manager service-profile service-name service-namecommand to clear the service profile cache. If the entry is “True”, then it indicates that the subscriber session is already in use and therefore the service profile cache must not be cleared.

Task ID

Task ID Operation

network

execute

Examples

This example shows how to clear the subscriber sessions.


RP/0/RSP0/CPU0:router# clear subscriber manager service-profile service-name group1

clear subscriber srg

To clear the subscriber redundancy Group (SRG) subordinate and primary sessions use the clear subscriber srg command in EXEC mode mode.

clear subscriber srg { master | slave } session { all | afi { dual-partial-up | dual-up | in-progress | ipv4-only | ipv6-only | lac } | identifier { access-interface interface-type interface-instance [ ipv4 | ipv6 IANA ] ipadress | interface interface-type interface-instance } | mac-address mac-address | subscriber-label id } [ location node-id ]

Syntax Description

master

Clears the subscriber management SRG primary information.

slave

Clears the subscriber management SRG subordinate information.

all

Clears all SRG primary or subordinate sessions.

afi

Clears SRG primary or subordinate sessions based on the specified address-family.

You can clear the SRG primary or subordinate sessions based on the following keywords:

  • dual-partial-up : Clears the dual stack subscriber sessions (IPv4 and IPv6) that are partially established.

  • dual-up : Clears the dual stack subscriber sessions (IPv4 + IPv6) that are fully established.

  • in-progress : Clears the subscriber sessions that are in progress.

  • ipv4-only: Clears the established single stack IPv4 subscriber.

  • ipv6-only: Clears the established single stack IPv6 subscriber sessions.

  • lac: Clears the L2TP subscriber sessions.

identifier

Clears the SRG primary or subordinate sessions based on one or more identifiers you select.

access-interface

Clears the SRG primary or subordinate sessions based on the access interface name.

interface-type interface-instance

Specifies the interface type whose SRG primary or subordinate sessions you want to delete.

The details of the interface instance are as follows:

  • Physical interface instance. Naming notation is rack/slot/module/port and a slash between values is required as part of the notation

    • Rack: Chassis number of the rack

    • slot: Physical slot number of the modular services card or line card

    • module: Module number. A physical layer interface module (PLIM) is always 0.

    • port: Physical port number of the interface

    Note

     

    In references to a Management Ethernet interface located on a route processor card, the physical slot number is alphanumeric (RP0 or RP1) and the module is CPU0. Example: interface MgmtEth0/RP1/CPU0/0.

  • Virtual interface instance. Number range varies depending on interface type.

ipv4

Clears the DHCP IPv4 SRG primary or subordinate sessions specific to an interface and IPv4 network-address/prefix.

ipv6 IANA

Clears the DHCP IPv6 SRG primary or subordinate sessions specific to an interface and IPv6 address/length.

location node-id

Clears the SRG primary or subordinate sessions of a specific location.

The node-id argument is entered in the rack/slot/module notation.

mac-address

Clears the SRG primary or subordinate sessions based on the MAC address specified.

subscriber-label

Clears the SRG primary or subordinate sessions based on the subscriber session ID

Command Default

None

Command Modes

Privileged Executive mode

Command History

Release Modification
Release 6.5.2

This command was introduced.

Usage Guidelines

The command clear subscriber srg master session is equivalent to clear subscriber session.

Subscriber sessions should always be in sync between the SRG primary and subordinate. Don't clear all the SRG subscriber sessions manually. In an exceptional situation, follow the recommended steps for safe clearing of all SRG subscriber sessions using the clear subscriber srg slave session all command. For the recommended steps, see Setting up BNG Subscriber Redundancy Group of the BNG Geo Redundancy chapter in the Cisco ASR 9000 Series Aggregation Services Router Broadband Network Gateway Configuration Guide.

Task ID

Task ID Operation

network

execute

Examples

This example shows how to clear the SRG subordinate session based on identifier:


Router# clear subscriber srg slave session identifier access-interface bundle-ether 1
 ipv4 192.1.1.1/24 location 0/0/1

This example shows how to clear the SRG subordinate session based on subscriber-label:


Router# clear subscriber srg slave session subscriber-label 1 location 0/0/1

This example shows how to clear the SRG subordinate session based on address family.


Router# clear subscriber srg slave session afi dual-partial-up location 0/0/1

This example shows how to clear all subscriber sessions manually for SRG subordinate sessions at the global configuration:


RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0(config)# interface Hu0/0/0/1
RP/0/RSP0/CPU0(config-if)# shutdown

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy disable
RP/0/RSP0/CPU0:router#clear subscriber srg slave session all

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy

RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0(config)# interface Hu0/0/0/1
RP/0/RSP0/CPU0(config-if)# no shutdown

This example shows how to clear all subscriber sessions manually for SRG master sessions at the global configuration:


RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy switchover group 1

RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0(config)# interface Hu0/0/0/1
RP/0/RSP0/CPU0(config-if)# shutdown

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# disable

RP/0/RSP0/CPU0:router#clear subscriber srg master session all

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy

RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0(config)# interface Hu0/0/0/1
RP/0/RSP0/CPU0(config-if)# no shutdown

This example shows how to clear all subscriber sessions manually for SRG subordinate sessions at the group level configuration:


RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0(config)# interface Hu0/0/0/1
RP/0/RSP0/CPU0(config-if)# shutdown

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy group 1 disable
RP/0/RSP0/CPU0:router#clear subscriber srg slave session all

RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy group 1

RP/0/RSP0/CPU0# configure
RP/0/RSP0/CPU0(config)# interface Hu0/0/0/1
RP/0/RSP0/CPU0(config-if)# no shutdown

core-tracking

To configure an additional object for track connectivity to the core network (such as RADIUS or DHCP servers), and to initiate automatic switchover in the event of a BNG connectivity loss even while access is up or active, use the core-tracking command in subscriber redundancy group configuration mode. To remove the object tracking configuration, use the no form of this command.

core-tracking core-tracking-obj

Syntax Description

core-tracking-obj

Core tracking object for the specific SRG.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

This is an optional command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure object tracking for detecting core connectivity for the specific SRG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# core-tracking route-to-radius

disable (BNG)

To disable BNG geo redundancy feature across all subscriber redundancy groups (SRGs) or session redundancy groups (SERG), use the disable command in the respective group configuration mode.

To disable a specific SRG/SERG, use the disable command in the respective group configuration mode. To remove the disable configuration, use the no prefix for this command.

disable

This command has no keywords or arguments.

Command Default

None

Command Modes

subscriber redundancy

subscriber redundancy group

session redundancy

session redundancy group

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to disable geo redundancy feature for all SRGs: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# disable

This example shows how to disable a specific SRG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# disable

Examples

This example shows how to disable geo redundancy feature for all SERGs: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# disable

This example shows how to disable a specific SERG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# disable

enable-fast-switchover

To enable traffic between peer-to-peer subscriber redundancy groups in BNG, use the enable-fast-switchover command in subscriber redundancy group configuration mode. To disable this feature, use the no form of this command.

enable-fast-switchover

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Command History

Release Modification
Release 6.1.2

This command was introduced.

Usage Guidelines

The enable-fast-switchover command must be configured prior to configuring state-control-route . If state-control-route is already configured, you must remove that configuration and re-configure it after enable-fast-switchover is configured.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to enable traffic between peer-to-peer subscriber redundancy groups in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy group 110
RP/0/RSP0/CPU0:router(config-subscr-red-group)# enable-fast-switchover

hold-timer (BNG)

To configure the duration for which the dynamic switchover is suspended after a role change in BNG geo redundancy feature scenario, use the hold-timer command in subscriber/session redundancy configuration mode. To configure hold timer for a specific subscriber redundancy group (SRG) or a session redundancy group (SERG), use this command in the respective group configuration mode.

To remove the hold timer configuration, use the no prefix for this command.

hold-timer hold-timer

Syntax Description

hold-timer

Hold timer value, in minutes.

The range is from 1 to 65535.

Command Default

By default, the hold-time is zero. That is, back to back switchovers are allowed.

Command Modes

Subscriber redundancy

Subscriber redundancy group

Session redundancy

Session redundancy group

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

This is an optional command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure hold-timer across all SERGs, in BNG geo redundancy feature scenario: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# hold-timer 15

This example shows how to configure hold-timer for a specific SERG, in BNG geo redundancy feature scenario: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# hold-timer 20

holdtimer-default-disable

To disable the default hold timer configuration, use the holdtimer-default-disable command in subscriber redundancy configuration mode. To disable the default hold timer for a specific subscriber redundancy group (SRG), use this command in the respective group configuration mode.

To enable the default hold timer configuration, use the no prefix for this command.

holdtimer-default-disable

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Subscriber redundancy

Subscriber redundancy group

Command History

Release Modification
Release 7.2.1

This command was introduced for SRG.

Usage Guidelines

This is an optional command.

If you have not configured the hold timer, using the hold-timer command, by default the system configures the hold timer based on the system and group load to specify the duration for which the dynamic switchover is suspended after a role change in BNG geo redundancy feature scenario.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to disable the default hold timer:


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# holdtimer-default-disable

This example shows how to disable the default hold timer for a group:


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# holdtimer-default-disable

http-enrichment parameter-list

To enable the enrichment of the HTTP GET request header with the parameters specified and proxying of the enriched HTTP request, use the http-enrichment parameter-list action under the respective class-map in the policy-map configuration mode.

http-enrichment parameter-list {bng-interface | | hostname | | subscriber-ip | | subscriber-mac}

Syntax Description

bng-interface

Specifies that the IPv4/IPv6 address of the interface that is configured as the BNG interface will be added as part of the enrichment header. If IPv4 address is not configured for the BNG interface it will be set as 0.0.0.0 and if IPv6 address is not configured it will be set as 0::0.

hostname

Specifies that the hostname of the router will be added as enrichment header.
subscriber-ip

Specifies that the subscriber's IPv4 and IPv6 address will be added as enrichment header.

subscriber-mac

Specifies that the subscriber's MAC address will be added as enrichment header.

Command Default

None

Command Modes

Policy-map configuration

Command History

Release Modification
Release 6.5.1

This command was introduced.

Usage Guidelines

This command supports the setting of all possible combinations of the defined parameters, that is,15 combinations with 4 parameters. For any changes required in the parameter list, the user will have to configure a new parameter-list. This will override the previously configured parameter-list.

Task ID

Task ID Operation

qos

read, write

Examples

This example shows how to configure a PBR based policy-map with http-enrichment enabled on one of the classes. 


RP/0/RSP0/CPU0:router(configure)# policy-map type pbr http-enrichment-policy
RP/0/RSP0/CPU0:router(config-pmap)# class type traffic open-garden-class
RP/0/RSP0/CPU0:router(config-pmap-c)# transmit
RP/0/RSP0/CPU0:router(config-pmap-c)# exit
RP/0/RSP0/CPU0:router(config-pmap)# class type traffic http-enrich-class1
RP/0/RSP0/CPU0:router(config-pmap-c)# http-enrichment parameter-list subscriber-mac hostname bng-interface
RP/0/RSP0/CPU0:router(config-pmap-c)# exit
RP/0/RSP0/CPU0:router(config-pmap)# class class-default
RP/0/RSP0/CPU0:router(config-pmap-c)# drop

Related Commands

Command Description

http-enrichment parameter-list (subscriber)

 Configures the primary list of all the parameters for http-enrichment. 

bng-interface (subscriber)

 Specifies the interface that is the bng identifier. 

http-enrichment parameter-list (subscriber)

To configure the primary list of all the parameters that are needed for http enrichment across all class-map http-enrichment actions, use the http-enrichment parameter-list command in the subscriber configuration mode.

http-enrichment parameter-list {bng-interface | | hostname | | subscriber-ip | | subscriber-mac}

Syntax Description

bng-interface

Specifies that the IPv4/IPv6 address of the interface that is configured as the BNG interface will be added as part of the enrichment header. If IPv4 address is not configured for the BNG interface it will be set as 0.0.0.0 and if IPv6 address is not configured it will be set as 0::0.

hostname

Specifies that the hostname of the router will be added as enrichment header.
subscriber-ip

Specifies that the subscriber's IPv4 and IPv6 address will be added as enrichment header.

subscriber-mac

Specifies that the subscriber's MAC address will be added as enrichment header.

Command Default

None

Command Modes

Subscriber configuration

Command History

Release Modification
Release 6.5.1

This command was introduced.

Usage Guidelines

This command supports the setting of all possible combinations of the defined parameters, that is,15 combinations with 4 parameters. For any changes required in the parameter list, the user will have to configure a new parameter-list. This will override the previously configured parameter-list.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure the primary-list of http-enrichment parameters that are used in http-enrichment actions configured across all class-maps. 


RP/0/RSP0/CPU0:router(configure)# subscriber
RP/0/RSP0/CPU0:router(config-subscriber)# http-enrichment parameter-list subscriber-mac hostname bng-interface

Related Commands

Command Description

http-enrichment parameter-list

 Enables http header enrichment feature for BNG subscribers. 

bng-interface (subscriber)

 Specifies the interface that is the bng identifier. 

interface-list (BNG)

To configure the interface list (mapping list of all access ports) that are part of a specific subscriber redundancy group (SRG) or a session redundancy group (SERG), use the interface-list command in the respective group configuration mode. To remove the interface list configuration, use the no form of this command.

interface-list [interface interface-type interface-name {id interface-id | sub-if-range sub-if-start-range sub-if-end-range id-range id-start-range id-end-range}]

Syntax Description

id

Specifies the mapping identifier of the interface-list.

The identifier for particular interface must be same on both primary and subordinate nodes.

interface-id

Identifier value for the interface to be mapped on to the subordinate SRG/SERG.

sub-if-range

Specifies the range of sub-interfaces to be added for the given interface.

sub-if-start-range

Start value of sub-interface range.

The range is from 0 to 2147483647.

sub-if-end-range

End value of sub-interface range.

The range is from 0 to 2147483647.

id-range

Specifies the range of interface-list identifiers.

id-start-range

Start ID of the interface to be mapped on to the SRG/SERG peer.

The range is from 1 to 65535.

id-end-range

End ID of the interface to be mapped on to the SRG/SERG peer.

The range is from 1 to 65535.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

Because BNG works only on sub-interfaces, it is required to configure sub-interfaces under SRG/SERG; not the entire bundle or port.

Sub-interfaces on physical ports spanning different line cards (LC), or mix of physical port sub-interfaces and bundle (or other virtual interfaces like Pseudowire Headend) sub-interfaces is not allowed.

One access sub-interface can belong to only one SRG/SERG.

Because the scope of mapping ID is only within a particular SRG/SERG, same ID can be used in a different SRG/SERG.

The ID assigned to sub-interfaces within an SRG/SERG is used for correlation or mapping of sub-interface pairings across the peer routers. This allows for pairing of different interface or port numbers or types across routers.

Access interfaces can also be explicitly configured even if those sub-interfaces are not existing. Those interfaces become operational under the SRG/SERG when they are actually created.

Removal or modification (for example, change of mapping ID) of sub-interfaces in SRG/SERG during runtime has the same effect of disabling redundancy on them. This results in corresponding sessions getting cleared on the subordinate side.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to assign one or more access sub-interface under a subscriber redundancy group (SRG) in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# interface-list 
RP/0/RSP0/CPU0:router(config-subscr-red-grp-intf)# interface Bundle-Ether1.10 id 210
RP/0/RSP0/CPU0:router(config-subscr-red-grp-intf)# interface Bundle-Ether1.11 id 211

This example shows how to assign one or more access sub-interface (as a range) under an SRG in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# interface-list 
RP/0/RSP0/CPU0:router(config-subscr-red-grp-intf)# interface Bundle-Ether1 sub-if-range 1 9 id-range 201 209

Examples

This example shows how to assign one or more access sub-interface under a session redundancy group (SERG) in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# interface-list 
RP/0/RSP0/CPU0:router(config-session-red-grp-intf)# interface Bundle-Ether1.10 id 210
RP/0/RSP0/CPU0:router(config-session-red-grp-intf)# interface Bundle-Ether1.11 id 211

This example shows how to assign one or more access sub-interface (as a range) under an SERG in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# interface-list 
RP/0/RSP0/CPU0:router(config-session-red-grp-intf)# interface Bundle-Ether1 sub-if-range 1 9 id-range 201 209

peer (BNG)

To configure the peer router for a subscriber redundancy group (SRG) or session redundancy group (SERG) in BNG, use the peer command in the respective group configuration mode.

To remove the peer router configuration, use the no prefix for this command.

peer peer-ip

Syntax Description

peer-ip

The peer IPv4 or IPv6 address that is used to establish channel to the peering router in the SRG/SERG.

Command Default

None

Command Modes

Subscriber redundancy group configuration

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

The IPv4 or global IPv6 address of the source-interface configured on the peer router must be configured using this command. You must ensure that the configured addresses are reachable from the respective peer routers.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure a peer router for a subscriber redundancy group (SRG) in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# peer 1.1.1.2

Examples

This example shows how to configure a peer router for a session redundancy group (SERG) in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# peer 1.1.1.2

preferred-role (BNG)

To configure the initial role preference as primary or subordinate, in a BNG geo redundancy feature scenario, use the preferred-role command in subscriber redundancy group (SRG) or a session redundancy group (SERG). To configure the initial role for a specific group, use this command in the respective group configuration mode.

To remove the preferred role configuration, use the no prefix for this command.

preferred-role {master | slave}

Syntax Description

master

Specifies the preferred role as primary.

slave

Specifies the preferred role as subordinate.

Command Default

None

Command Modes

Subscriber redundancy

Subscriber redundancy group

Session redundancy

Session redundancy group

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

This is an optional command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure preferred role across all SRGs as primary using the master keyword in BNG geo redundancy feature scenario: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# preferred-role master

This example shows how to configure preferred role for a specific SRG as subordinate using the slave keyword, in BNG geo redundancy feature scenario: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# preferred-role slave

Examples

This example shows how to configure preferred role across all SERGs as primary using the master keyword, in BNG geo redundancy feature scenario: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# preferred-role master

This example shows how to configure preferred role for a specific SERG as subordinate using the slave keyword, in BNG geo redundancy feature scenario: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# group 1
RP/0/RSP0/CPU0:router(config-session-red-group)# preferred-role slave

peer route-disable

To disable the route on geo redundancy hot-standby peer, so that the subscriber routes are not installed in the RIB even when the subscriber sessions are brought up on the standby peer, use the peer route-disable command in subscriber redundancy group configuration mode. To disable this feature, use the no form of this command.

peer route-disable

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Command History

Release Modification
Release 5.3.3

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to disable the route on geo redundancy hot-standby peer in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy group 110
RP/0/RSP0/CPU0:router(config-subscr-red-group)# peer route-disable

revertive-timer (BNG)

To set the auto-revertive timer in BNG to regain the primary role after a failover, use the revertive-timer in subscriber redundancy or subscriber redundancy group configuration mode. To disable the timer, use the no form of this command.

revertive-timer timer-value maximum max-value

Syntax Description

timer-value

Specifies the timer value in minutes. The range is from 1 to 65535.

This value is doubled every time access tracking goes down after the first instance of auto-revert to the primary role. When the timer-value exceeds the max-value limit, it is reset to the originally configured value.

max-value

Specifies the maximum value until which the timer-value doubles for each instance of access down.

Command Default

None

Command Modes

Subscriber redundancy

Subscriber redundancy group

Session redundancy

Session redundancy group

Command History

Release Modification
Release 6.1.2

This command was introduced for SRG..

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

The recommended value of max-value is 4 x timer-value .

If auto-revertive timer is configured at both subscriber redundancy level and at subscriber redundancy group level, the group level configuration takes precedence over the other.

Revertive-timer should not be running in a primary node. If it does, it is an error condition.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to set the auto-revertive timer in BNG to 20 minutes. In this example, if the access goes down again after the first switch back to primary role, the timer runs for 40 minutes (that is, double the previous value). This repeats until it exceeds the max-value of 80 minutes. Once it exceeds 80 minutes, the timer value is reset to 20 minutes. 


RP/0/RSP0/CPU0:router(config-subscr-red)#auto-revertive 20 max-value 80

Examples

This example shows how to set the auto-revertive timer in BNG to 20 minutes. In this example, if the access goes down again after the first switch back to primary role, the timer runs for 40 minutes (that is, double the previous value). This repeats until it exceeds the max-value of 80 minutes. Once it exceeds 80 minutes, the timer value is reset to 20 minutes. 


RP/0/RSP0/CPU0:router(config-session-red)#auto-revertive 20 max-value 80

source-interface (BNG)

To configure the interface whose IP address must be used for peering with other routers in BNG geo redundancy scenario, use the source-interface command in subscriber redundancy group (SRG) or session redundancy group (SERG) configuration mode.

To remove this configuration, use the no prefix for this command.

source-interface interface-type interface-name

Syntax Description

interface-type

Type of the source interface.

interface-name

Name of the source interface.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Session redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

It is recommended to use a loopback address that is advertised from the router for peer and the interface must have IPv4 or IPv6 (or both) global address depending on which one is to be used for peering.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure source interface in subscriber redundancy sub-mode: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# source-interface loopback0

Examples

This example shows how to configure source interface in session redundancy sub-mode: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)# source-interface loopback0

session redundancy

To enable session redundancy feature globally in BNG and to enter the session redundancy configuration sub mode, use the session redundancy command in Global Configuration mode. To remove the configurations for session redundancy feature in BNG, use the no form of this command.

session redundancy

This command has no keywords or arguments.

Command Default

None

Command Modes

Global configuration.

Command History

Release Modification
Release 6.2.1

This command was introduced.

Usage Guidelines

The option slave-mode is not supported in BNG geo redundancy. The default redundancy mode is hot-standby.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to enter session redundancy sub mode to configure session redundancy options: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy
RP/0/RSP0/CPU0:router(config-session-red)#

session redundancy group

To configure session redundancy group (SERG) in BNG, use the session redundancy group command in Global Configuration mode. To remove the session redundancy group configuration, use the no form of this command.

session redundancy group group-id [description line]

Syntax Description

group-id

Group identifier name that needs to be configured on the BNG pair routers.

description

Specifies the description for the specific SERG.

line

Description for the specific SERG, in words.

Command Default

None

Command Modes

Global configuration.

Command History

Release Modification
Release 6.2.1

This command was introduced.

Usage Guidelines

For successful peering between the BNG pair routers, the same group-id must be configured on both the routers.

You can configure multiple groups (with unique IDs) for peering with the same peer router or across different peer routers.

The SERG does not get activated until the first access-interface is assigned under it.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure a session redundancy group (SERG) in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# session redundancy group 1
RP/0/RSP0/CPU0:router(config-session-red-group)#

session redundancy switchover

To execute session redundancy switchover in BNG, use the session redundancy switchover command in EXEC mode.

session redundancy switchover [group group-num | location node-id] [force]

Syntax Description

group

Specifies the session redundancy group (SERG) number to be switched over.

group-num

The SERG number.

The range is from 1 to 999.

location

Specifies a particular location to be switched over.

force

Specifies a forced switchover.

Command Default

None

Command Modes

Exec.

Command History

Release Modification
Release 6.2.1

This command was introduced.

Usage Guidelines

The session redundancy activate command is currently not supported.

In most cases, the switchovers are triggered automatically by changes in the underlying access interfaces or due to other failures. This command is used for planned maintenance events or for exceptional cases where implementation of access-tracking is not possible or desired. It can be used to initiate switchover for all groups on the router, or on a particular location or for a specific SERG.

Switchover is triggered from the subordinate only when you choose the force option. The use of this option on either primary or subordinate overrides any negotiation or arbitration rules.

Even for manual (or admin-triggered) switchovers, it is highly recommended to initiate triggers through operations on the underlying access, to ensure consistency between the BNG and access roles or status. When switchover happens, logs that indicate the reason of the switchover, are generated on the system console and reported on a per SERG basis on both peering routers. After the switchover, you must check the SERG details on both peering routers to ensure consistency and to ensure that session service is not interrupted.

You must ensure consistency between the roles of the underlying access interfaces (active-standby or up-down) and the BNG SERG role (primary or subordinate). Failing this, the traffic may get disrupted especially when a proper access-tracking is not used.

To ensure network and service stability, it is recommended not to perform back to back switchovers (even though the feature allows it). After a reload, you must ensure sufficient stabilization time for any router or line card (LC) recovery and sync. Until then it must only be in subordinate or standby mode (through a hold-time or pre-empt mechanism in the underlying access). Depending on the integration aspects with RADIUS or PCRF, accounting updates may be sent from both primary and subordinate after the switchover. Therefore, it is recommended to give sufficient time for these operations to complete and stabilize.

Task ID

Task ID Operation

network

read, write

Examples

This example shows how to initiate session redundancy switchover for a particular SERG: 


RP/0/RSP0/CPU0:router# session redundancy switchover group 210

session redundancy synchronize

To initiate or verify synchronization or consistency between sessions on the primary and subordinate routers in a session redundancy scenario in BNG, use the session redundancy synchronize command in EXEC mode.

session redundancy synchronize [group group-num | location node-id]

Syntax Description

group

Specifies the session redundancy group (SERG) number to be synchronized.

group-num

The SERG number.

The range is from 1 to 999.

location

Specifies a particular location to be synchronized.

Command Default

None

Command Modes

Exec.

Command History

Release Modification
Release 6.2.1

This command was introduced.

Usage Guidelines

Synchronization may be required in these scenarios:

  • When errors are detected between primary and subordinate due to transient resource constraints.

  • To fix inconsistencies or errors when the BNG or the SERG configuration is changed on primary or subordinate.

  • Prior to performing a planned or admin-initiated maintenance activity.

You can initiate synchronization for all groups on the router, or on a particular location or for a specific SERG. This command can be issued on either primary or subordinate (recommendation is to give on primary first, and then on the subordinate only if it is still required).

Logs are generated on the router console to indicate the status of synchronization. However, it may take further time for any session inconsistency to be resolved and it must be verified using show session session command, or by checking the service status of the concerned session.

Task ID

Task ID Operation

network

read, write

Examples

This example shows how to initiate session redundancy synchronization for a particular SERG: 


RP/0/RSP0/CPU0:router# session redundancy synchronize group 210

state-control-route

To control the route advertisement to the core network, based on the role of the subscriber redundancy group (SRG), use the state-control-route command in subscriber redundancy group configuration mode. To disable this feature, use the no form of this command.

state-control-route {ipv4 ipv4-address | ipv6 {iana | iapd} ipv6-address} [vrf vrf-name] [tag tag-value] no state-control-route {ipv4 ipv4-address | ipv6 {iana | iapd} ipv6-address} [vrf vrf-name] [tag tag-value]

Syntax Description

tag tag-value

Specifies the option to filter out summary routes to be redistributed through the routing protocol, to get advertised to the core.

vrf vrf-name

Specifies the option to add summary route for a specific VRF, for a subscriber.

See Usage Guidelines section for more details.

Command Default

Disabled

Command Modes

Subscriber redundancy group

Command History

Release Modification
Release 6.1.2

This command was introduced.

Release 6.3.1

Added the support for vrf option, as part of the support for multiple state control route for each subscriber redundancy group (SRG).

Usage Guidelines

The route-policy with the respective tag (that is, tag 1 in this example) must be already defined, before configuring the state-control-route command.

The vrf vrf-name option helps to add state control routes in VRF routing table. If the vrf option is not specified, then the routes are added in the default VRF, that is, global routing table.

A maximum of 30 state control routes can be added in each subscriber redundancy group (SRG), with a limit of 10 state control routes for each route type. That is, user can have a maximum 10 IPv4 routes, 10 IANA routes and 10 IAPD routes in each SRG. In these 30 routes, user can have routes in either the default or the non-default VRF.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to filter out the summary routes to be advertised to the core: 


RP/0/RSP0/CPU0:router(config-subscr-red-group)#state-control-route ipv4 192.0.2.0/9 tag 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)#state-control-route ipv6 iana 2001:DB8::/32 tag 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)#state-control-route ipv6 iapd 2001:DB8:1::1/32 tag 1

This example shows how to add multiple summary routes for each SRG: 


RP/0/RSP0/CPU0:router(config-subscr-red-group)#state-control-route ipv4 192.0.2.0/9 vrf vrf-name tag 1

subscriber arp scale-mode-enable

To prevent default ARP entry creations (mainly in deployment scenarios where the unnumbered subscriber access-interfaces inherit all the attributes, including the secondary IP addresses, from the associated loopback interface) per subscriber interface, use the subscriber arp scale-mode-enable command in Global Configuration mode. To disable this feature, use the no form of this command.

subscriber arp scale-mode-enable

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Global Configuration

Command History

Release Modification

Release 5.3.3

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

aaa

read, write

Examples

This example shows how to prevents default ARP entry creations per subscriber interface in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber arp scale-mode-enable

subscriber arp uncond-proxy-arp-enable

To enable unconditional proxy ARP responses in BNG so as to allow communication with static IP addresses, use the subscriber arp uncond-proxy-arp-enable command in Global Configuration mode. To disable unconditional proxy ARP responses in BNG, use the no form of this command.

subscriber arp uncond-proxy-arp-enable

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Global Configuration mode

Command History

Release Modification

Release 6.2.1

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to enable unconditional proxy ARP responses in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber arp uncond-proxy-arp-enable

subscriber database

Due to the occurrence of multiple events on the line cards, subscriber feature programming time varies. Sometimes, the line card is too busy in processing local events. This results in a large backlog for subscriber control plane activities. The backpressure-level parameter in subscriber database policy blocks new subscribers from coming up, if the XR infrastructure is not able to complete the operations in a timely fashion. Whereas, the batch-control parameter defines how long the system has to wait before generating the batches.

subscriber database [ backpressure-level | batch-control]

Syntax Description

backpressure-level

Higher level, aggressive back pressure mechanism. Values range from 0-3 seconds. Default is 2 seconds.

0-Disable. Does not perform adaptive handling of slow hardware.

1-Stops new subscriber programming, if the average time of hardware programming exceeds 37 seconds. Resumes after it drops to 29 seconds.

2-Stops new subscriber programming, if the average time of hardware programming exceeds 23 seconds. Resumes after it drops to 19 seconds.

3-Stops new subscriber programming, if the average time of hardware programming exceeds 17 seconds. Resumes after it drops to 13 seconds

batch-control

Higher level, better batching, more delay.

Starting from Release 7.4.1, the following values are supported:

Values range from 0-4. Default is 0.

  • 0-Disable. Subscribers are processed in batches of 50ms.

  • 1-Subscribers are processed in batches of 100ms.

  • 2-Subscribers are processed in batches of 200ms.

  • 3-Subscribers are processed in batches of 400ms.

  • 4-Subscribers are processed in batches of 650ms.

Note

 

The following are the values supported, prior to Release 7.4.1:

Values range from 0-4. Default is 4.

  • 0-Disable. Subscribers are processed in batches of 75ms.

  • 1-Subscribers are processed in batches of 150ms.

  • 2-Subscribers are processed in batches of 300ms.

  • 3-Subscribers are processed in batches of 600ms.

  • 4-Subscribers are processed in batches of 1000ms.

Command Default

2 for subscriber database backpressure-level and 4 for subscriber database batch-control.

Command Modes

config

Command History

Release Modification

Release 6.6.3

This command was introduced.

Release 7.4.1

The value for the batch-control keyword was modified.

Usage Guidelines


Note

Do not modify the default values unless explicitly suggested by Cisco TAC.

Examples

RP/0/RSP0/CPU0:router(config)#subscriber database ?
  backpressure-level  backpressure level
  batch-control       batching performance control
RP/0/RSP0/CPU0:router(config)#subscriber database batch-control ?
  <0-4>  higher level, better batching, more delay. <0 - disable>
RP/0/RSP0/CPU0:router(config)#subscriber database batch-control 0
RP/0/RSP0/CPU0:router(config)#commit

subscriber featurette dhcp-renew-author

To enable AAA authorization during subscriber session lease renewal, use the subscriber featurette dhcp-renew-author command in Global Configuration mode. To disable this feature, use the no form of this command.

subscriber featurette dhcp-renew-author

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Global Configuration

Command History

Release Modification

Release 6.4.1

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

aaa

read, write

Examples

This example shows how to enable AAA authorization during DHCP renew or rebind event in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber featurette dhcp-renew-author
RP/0/RSP0/CPU0:router(config-subscriber)# commit

subscriber featurette identity-change

To enable identity change for DHCP Remote-Id parameter, thereby allowing modification of the subscriber service, use the subscriber featurette identity-change command in Global Configuration mode. To disable this feature, use the no form of this command.

subscriber featurette identity-change

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Global Configuration

Command History

Release Modification

Release 6.2.1

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

aaa

read, write

Examples

This example shows how to enable identity change for DHCP Remote-Id parameter to allow modification of the subscriber service in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber featurette identity-change

subscriber redundancy

To enable subscriber redundancy feature globally in BNG and to enter the subscriber redundancy configuration sub mode, use the subscriber redundancy command in Global Configuration mode. To remove the configurations for subscriber redundancy feature in BNG, use the no form of this command.

subscriber redundancy

This command has no keywords or arguments.

Command Default

None

Command Modes

Global Configuration mode

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

The option slave-mode is not supported in BNG geo redundancy. The default redundancy mode is hot-standby.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to enter subscriber redundancy sub mode to configure subscriber redundancy options: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)#

subscriber redundancy group

To configure subscriber redundancy group (SRG) in BNG, use the subscriber redundancy group command in Global Configuration mode. To remove the subscriber redundancy group configuration, use the no form of this command.

subscriber redundancy group group-id [description line]

Syntax Description

group-id

Group identifier name that needs to be configured on the BNG pair routers.

description

Specifies the description for the specific SRG.

line

Description for the specific SRG, in words.

Command Default

None

Command Modes

Global Configuration mode

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

For successful peering between the BNG pair routers, the same group-id must be configured on both the routers.

You can configure multiple groups (with unique IDs) for peering with the same peer router or across different peer routers.

The SRG does not get activated until the first access-interface is assigned under it.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure a subscriber redundancy group (SRG) in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)#

subscriber redundancy switchover

To execute subscriber redundancy switchover in BNG, use the subscriber redundancy switchover command in EXEC mode.

subscriber redundancy switchover [group group-num | location node-id] [force]

Syntax Description

group

Specifies the subscriber redundancy group (SRG) number to be switched over.

group-num

The SRG number.

The range is from 1 to 999.

location

Specifies a particular location to be switched over.

force

Specifies a forced switchover.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

The subscriber redundancy activate command is currently not supported.

In most cases, the switchovers are triggered automatically by changes in the underlying access interfaces or due to other failures. This command is used for planned maintenance events or for exceptional cases where implementation of access-tracking is not possible or desired. It can be used to initiate switchover for all groups on the router, or on a particular location or for a specific SRG.

Switchover is triggered from the subordinate only when you choose the force option. The use of this option on either primary or subordinate overrides any negotiation or arbitration rules.

Even for manual (or admin-triggered) switchovers, it is highly recommended to initiate triggers through operations on the underlying access, to ensure consistency between the BNG and access roles or status. When switchover happens, logs that indicate the reason of the switchover, are generated on the system console and reported on a per SRG basis on both peering routers. After the switchover, you must check the SRG details on both peering routers to ensure consistency and to ensure that subscriber service is not interrupted.

You must ensure consistency between the roles of the underlying access interfaces (active-standby or up-down) and the BNG SRG role (primary or subordinate). Failing this, the traffic may get disrupted especially when a proper access-tracking is not used.

To ensure network and service stability, it is recommended not to perform back to back switchovers (even though the feature allows it). After a reload, you must ensure sufficient stabilization time for any router or line card (LC) recovery and sync. Until then it must only be in subordinate or standby mode (through a hold-time or pre-empt mechanism in the underlying access). Depending on the integration aspects with RADIUS or PCRF, accounting updates may be sent from both primary and subordinate after the switchover. Therefore, it is recommended to give sufficient time for these operations to complete and stabilize.

Task ID

Task ID Operation

network

read, write

Examples

This example shows how to initiate subscriber redundancy switchover for a particular SRG: 


RP/0/RSP0/CPU0:router# subscriber redundancy switchover group 210

Related Commands

Command Description

subscriber redundancy synchronize

Initiates subscriber redundancy synchronization in BNG.  

subscriber redundancy synchronize

To initiate or verify synchronization or consistency between sessions on the primary and subordinate routers in a subscriber redundancy scenario in BNG, use the subscriber redundancy synchronize command in EXEC mode.

subscriber redundancy synchronize [group group-num | location node-id]

Syntax Description

group

Specifies the subscriber redundancy group (SRG) number to be synchronized.

group-num

The SRG number.

The range is from 1 to 999.

location

Specifies a particular location to be synchronized.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

Synchronization may be required in these scenarios:

  • When errors are detected between primary and subordinate due to transient resource constraints.

  • To fix inconsistencies or errors when the BNG or the SRG configuration is changed on primary or subordinate.

  • Prior to performing a planned or admin-initiated maintenance activity.

You can initiate synchronization for all groups on the router, or on a particular location or for a specific SRG. This command can be issued on either primary or subordinate (recommendation is to give on primary first, and then on the subordinate if it is still required).

Logs are generated on the router console to indicate the status of synchronization. However, it may take further time for any session inconsistency to be resolved and it must be verified using show subscriber session command, or by checking the service status of the concerned subscriber.

Task ID

Task ID Operation

network

read, write

Examples

This example shows how to initiate subscriber redundancy synchronization for a particular SRG: 


RP/0/RSP0/CPU0:router# subscriber redundancy synchronize group 210

Related Commands

Command Description

subscriber redundancy switchover

Executes subscriber redundancy switchover in BNG.  

subscriber session limit

To configure a limit for subscriber sessions, use the subscriber session limit command in Global Configuration mode. To remove the session limit for subscribers, use the no form of this command.

subscriber session limit session_limit

Syntax Description

session_limit

Limit for subscriber sessions.

The range is from 1 to 200000.

Command Default

None

Command Modes

Global Configuration mode

Command History

Release Modification
Release 5.1.1

This command was introduced.

Release 5.2.0

The session_limit was made an optional parameter for the no form of this command.

Usage Guidelines

This command does not limit the number of un-authenticated sessions on the router, until the overall session count reaches session_limit . If a new session comes up after router reached the session_limit , then the long-lived un-authenticated subscriber session is deleted. The new session can be an authenticated or un-authenticated session.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure a limit for subscriber sessions: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber session limit 100000

This example shows how to remove the subscriber sessions limit configuration: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# no subscriber session limit

Related Commands

Command Description

show subscriber session

Displays the subscriber management session information.  

tracking-disable (BNG)

To disable the use of tracking objects status for automatic switchovers in BNG geo redundancy, use the tracking-disable command in subscriber redundancy group (SRG) or session redundancy group (SERG) configuration mode.

To re-enable the use of tracking objects status for automatic switchovers, use the no prefix for this command.

tracking-disable

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Session redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced for SRG.

Release 6.2.1

This command was introduced for SERG.

Usage Guidelines

This is an optional command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to temporarily disable the use of tracking objects status for automatic switchovers in BNG geo redundancy: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# tracking-disable

virtual-mac

To configure the virtual MAC explicitly for a specific subscriber redundancy group(SRG), while BNG being in primary redundancy mode, use the virtual-mac command in subscriber redundancy group configuration sub-mode. To remove this configuration, use the no form of this command.

virtual-mac virtual-mac

Syntax Description

virtual-mac

Virtual MAC address.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

The usage guidelines of this command remain the same as that for virtual-mac-prefix command.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure virtual MAC explicitly for an SRG in a subscriber redundancy feature scenario in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-gr)# virtual-mac 0001.0002.0001

Related Commands

Command Description

virtual-mac-prefix

Configures the gateway MAC (for the subscribers) used by BNG while being in primary redundancy mode.  

virtual-mac-disable

To disable the inheritance of the virtual MAC prefix for a specific subscriber redundancy group (SRG), use the virtual-mac-prefix command in subscriber redundancy group configuration mode. To re-enable the inheritance of the virtual MAC prefix, use the no form of this command.

virtual-mac-disable

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Subscriber redundancy group configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

The virtual MAC configuration must be done before any subscriber session is set up because any change in this configuration affects the gateway MAC as seen by the CPE devices causing service disruption of existing sessions.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to disable the inheritance of the virtual MAC prefix for a specific subscriber redundancy group in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# group 1
RP/0/RSP0/CPU0:router(config-subscr-red-group)# virtual-mac-disable

virtual-mac-prefix

To configure the gateway MAC (for the subscribers) used by BNG while being in primary redundancy mode, use the virtual-mac-prefix command in subscriber redundancy configuration mode. To remove this configuration, use the no form of this command.

virtual-mac-prefix virtual-mac

Syntax Description

virtual-mac

Virtual mac prefix address.

Command Default

None

Command Modes

Subscriber redundancy configuration.

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

The virtual MAC configuration must be done before any subscriber session is set up because any change in this configuration affects the gateway MAC as seen by the CPE devices causing service disruption of existing sessions.

The virtual MAC configuration is required for access protocols such as MST-AG, G.8032 and so on, where interface MAC is not same for the two peering routers.

The easiest way to provision virtual MAC is to select a locally-administered unicast MAC prefix (the last four digits must be zero (0)) and configure it on all redundant BNGs. This ensures that each subscriber redundancy group (SRG) gets its own vMAC, which is offset by the group ID, automatically.

The virtual MAC can alternatively be configured for a specific SRG by using virtual-mac command in subscriber redundancy group configuration sub-mode.

Task ID

Task ID Operation

config-services

read, write

Examples

This example shows how to configure virtual MAC prefix in a subscriber redundancy feature scenario in BNG: 


RP/0/RSP0/CPU0:router# configure
RP/0/RSP0/CPU0:router(config)# subscriber redundancy
RP/0/RSP0/CPU0:router(config-subscr-red)# virtual-mac-prefix 0001.0002.0000

Related Commands

Command Description

virtual-mac

Configures the virtual MAC explicitly for a specific subscriber redundancy group (SRG), while BNG being in primary redundancy mode.  

show sessionmon license

To display the subscriber session statistics required for BNG Smart Licensing, use the show sessionmon license command in the EXEC mode.

show sessionmon license [detail] statistics

Syntax Description

statistics

Displays the peak hour session statistics.

detail

(Optional) Displays the detailed session statistics that include current statistics along with the peak hour statistics.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 6.1.2

This command was introduced.

Usage Guidelines

One license is required for every group of 8000 subscribers or a fraction of it. For example, two licenses are required for 9000 subscribers.

The license is consumed based on the peak count, and not on the current count.

Task ID

Task ID Operation

network

read

Examples

This is a sample output of the show sessionmon license statistics command for non-Geo redundancy sessions. Here, two A9K-BNG-LIC-8K licenses are triggered for active sessions, as the session count is more than 8000. 


Router#show sessionmon license statistics
Mon Mar 21 18:34:10.726 IST
 
                                 Active     Standby 
                                 =====      =======
            Peak (24 hours)      8001         0

This is a sample output of the show sessionmon license detail statistics command for non-Geo redundancy sessions. Here, one A9K-BNG-LIC-8K license is triggered for active sessions, as the session count is less than 8000. 


Router#show sessionmon license detail statistics
Thu Jun 23 11:58:36.089 IST

                                 Active     Standby 
                                 =====      =======
            Current              1000         0
            Peak (24 hours)      1500         0

This is a sample output of the show sessionmon license detail statistics command for Geo redundancy sessions. Here, six A9K-BNG-LIC-8K licenses are triggered for active sessions and two A9K-BNG-ADV-8K licenses are triggered for standby sessions. 


Router#show sessionmon license detail statistics
Thu Jun 23 11:58:36.089 IST
 nodename = node0_0_CPU0
 ------------

                                 Active      Standby 
                                 =====       =======
            Current              36000       12200
            Peak (24 hours)      42000       14300 

 nodename = node0_1_CPU0
 ------------ 
 - - 
 - -

Field

Description

Active

Number of active session on the router.

Standby

Number of standby session on the router.

Current

Current session count.

Peak (24 hours)

Peak number of session within a 24 hour time frame.

show subscriber database

To display the configuration details of subscriber database, use the show subscriber database command in the EXEC mode.

show subscriber database {association | configuration | connection | interface | session {state | subscriber-label label} | statistics | summary}

Syntax Description

association

Displays the association between subscriber sessions and dynamic templates.

configuration

Displays the configuration database information.

connection

Displays subscriber client connection identifiers.

interface

Displays the mapping between subscriber labels and interface handles.

statistics

Displays the show subscriber database statistics information.

summary

Displays the show subscriber database summary counts.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Release 5.3.0

A new output field, Template Interface Id , was added to show subscriber database session subscriber-label command, to indicate whether the subscriber uses templates or not.

Usage Guidelines

If the Template Interface Id field displays a value of 0x00000000, it indicates that the subscriber is not using templates. If that field displays a non-zero value (for example, 0x00802c80), it indicates that the subscriber is using template with that particular interface-handle value.

Task ID

Task ID Operation

network

read

Examples

The sample output of the show subscriber database command is: 


RP/0/RSP0/CPU0:router# show subscriber database association

Mon Jun 14 16:24:50.432 EDT
Object Name: TEMPL1
  Object Type: IP-SUBSCRIBER-TEMPLATE
  Feature Name: IPV4
    Attribute Name: ipv4/unnumbered
                    reference count : 1
                    sysDb pathname  : /cfg/gl/dynamic-templates/ipsubscriber/TEMPL1/ipv4/unnumbered
                    datatype        : string
                    length          : 10
                    value           : Loopback0

Object Name: TEMPL2
  Object Type: IP-SUBSCRIBER-TEMPLATE
  Feature Name: IPV4
    Attribute Name: ipv4/mtu 
                    reference count : 1
                    sysDb pathname  : /cfg/gl/dynamic-templates/ipsubscriber/ss/ipv4/mtu
                    datatype        : uint32
                    length          : 4
                    value           : 1500
  Feature Name: QoS
    Attribute Name: qos/service_policy_in/qos_policy
                    reference count : 1
                    sysDb pathname  : /cfg/gl/dynamic-templates/ipsubscriber/ss/qos/service_policy_in/:qos_policy
                    datatype        : packed
                    length          : 20
                    value           : packed
                                          AB CD 43 21 02 00 04 00 
  00 00 00 03 00 00 03 00 
                                      00 06 00 00
  Feature Name: 'RSI'
    Attribute Name: rsi/vrf
                    reference count : 1
                    sysDb pathname  : /cfg/gl/dynamic-templates/ipsubscriber/ss/rsi/vrf
                    datatype        : 3
                    length          : 5
                    value           : blue

RP/0/RSP0/CPU0:router# show subscriber database connection

Tue Jun 15 11:00:19.650 EDT

Client Connection Identifier:  0x0
=====================================
    ref_count        = 3
    req_count        = 0
    bpi_reg_count    = 0
    spi_reconciled   = TRUE
    bpi_reconciled   = FALSE
    client_restarted = FALSE
    client_name      = template-mgr
    timer_running    = FALSE

    spi_cb_info:  N/A


    Persistent Information:
        in_use                    = TRUE
        forced_full_resync        = FALSE
        client_flags              = TMPL_PROD
        state                     = SUBDB_CLIENT_FULL
        instance_no               = 0
        num_bpi_regs              = 0
        num_send_drop_bpi_msg     = 0
        num_send_drop_spi_msg     = 0
        num_recv_drop_bpi_msg     = 0
        num_recv_drop_spi_msg     = 0
        num_sent_bpi_msg          = 0
        num_sent_spi_msg          = 0
        num_recv_bpi_msg          = 0
        num_recv_spi_msg          = 0
        num_sent_pulse            = 0

    SPI AIPC Information:
        conn_present              = 0
        tx_attempt_count          = 0
        tx_count                  = 0
        rx_count                  = 0
        notify_connect_count      = 0
        notify_queue_high_count   = 0
        notify_queue_low_count    = 0
        notify_queue_full_count   = 0
        notify_data_waiting_count = 0
        notify_error_count        = 0
        notify_close_count        = 0
        notify_sendstatus_count   = 0
        notify_open_count         = 0
        pulse_data_waiting_count  = 0
        queue_full                = 0
        queue_full_drop           = 0
       outstanding_buffers       = 0
        overflow_queue_size       = 0
        cumulative_overflow_msgs  = 0
        hwm_overflow_msgs         = 0
    BPI AIPC Information:
        conn_present              = 1
        tx_attempt_count          = 0
        tx_count                  = 0
        rx_count                  = 1
        notify_connect_count      = 0
        notify_queue_high_count   = 0
        notify_queue_low_count    = 0
        notify_data_waiting_count = 1
        notify_error_count        = 0
        notify_close_count        = 0
        notify_sendstatus_count   = 0
        notify_open_count         = 1
        queue_full                = 0
        queue_full_drop           = 0
        outstanding_buffers       = 0
        overflow_queue_size       = 0
        cumulative_overflow_msgs  = 0
        hwm_overflow_msgs         = 0
    Feature Information (number of entries = 3):
    ---------------------------------------------------
     ***Feature Name***     = RSI
        Connection ID       = 0x1
        Session type        = SUBDB_SESSION_LABEL_TYPE_IP_SUB_INBAND
        Activate Required   = FALSE
        Config Set ID       = 1
        Registration Handle = 0x1
        whichevent[0]       = SUBDB_CB_EVENT_NONE
        whichevent[1]       = SUBDB_CB_EVENT_ALL
        Feature State       = SUBDB_FEATURE_REGISTERED

     ***Feature Name***     = RSI
        Connection ID       = 0x1
        Session type        = SUBDB_SESSION_LABEL_TYPE_PPPOE_SUB
        Activate Required   = FALSE
        Config Set ID       = 1
        Registration Handle = 0x2
        whichevent[0]       = SUBDB_CB_EVENT_NONE
        whichevent[1]       = SUBDB_CB_EVENT_ALL
        Feature State       = SUBDB_FEATURE_REGISTERED

     ***Feature Name***     = RSI
        Connection ID       = 0x1
        Session type        = SUBDB_SESSION_LABEL_TYPE_IP_SUB_DHCP
        Activate Required   = FALSE
        Config Set ID       = 1
        Registration Handle = 0x3
        whichevent[0]       = SUBDB_CB_EVENT_NONE
        whichevent[1]       = SUBDB_CB_EVENT_ALL
        Feature State       = SUBDB_FEATURE_REGISTERED

Client Connection Identifier:  0x2
=====================================
    ref_count        = 2
    req_count        = 0
    bpi_reg_count    = 0
    spi_reconciled   = TRUE
    bpi_reconciled   = TRUE
    client_restarted = FALSE
    client_name      = iedge SVM
    timer_running    = FALSE

    spi_cb_info:
        SUBDB_SPI_CB_PROD_ALL_DONE          = SUBDB_CB_EVENT_NONE
        SUBDB_SPI_CB_SESSION_PROD_DONE      = SUBDB_CB_EVENT_ALL
        SUBDB_SPI_CB_SESSION_ACTIVATED      = SUBDB_CB_EVENT_NONE
        SUBDB_SPI_CB_SESSION_CREATED        = SUBDB_CB_EVENT_NONE
        SUBDB_SPI_CB_SESSION_DESTROYED      = SUBDB_CB_EVENT_NONE
        SUBDB_SPI_CB_SESSION_ASSOCIATED     = SUBDB_CB_EVENT_ALL
        SUBDB_SPI_CB_SESSION_UNASSOCIATED   = SUBDB_CB_EVENT_ALL
        SUBDB_SPI_CB_SESSION_CONFIG_CHANGED = SUBDB_CB_EVENT_ALL
        SUBDB_SPI_CB_TEMPLATE_INSTALLED     = SUBDB_CB_EVENT_ALL
        SUBDB_SPI_CB_TEMPLATE_UNINSTALLED   = SUBDB_CB_EVENT_ALL
        SUBDB_SPI_CB_OBJECT_AGEOUT          = SUBDB_CB_EVENT_ALL


    Persistent Information:
        in_use                    = TRUE
        forced_full_resync        = FALSE
        client_flags              = TMPL_PROD, SESS_PROD
        state                     = SUBDB_CLIENT_FULL
        instance_no               = 1
        num_bpi_regs              = 0
        num_send_drop_bpi_msg     = 0
        num_send_drop_spi_msg     = 0
        num_recv_drop_bpi_msg     = 0
        num_recv_drop_spi_msg     = 0
        num_sent_bpi_msg          = 0
        num_sent_spi_msg          = 0
        num_recv_bpi_msg          = 0
        num_recv_spi_msg          = 1
        num_sent_pulse            = 0

    SPI AIPC Information:
        conn_present              = 1
        tx_attempt_count          = 0
        tx_count                  = 0
        rx_count                  = 2
        notify_connect_count      = 0
        notify_queue_high_count   = 0
        notify_queue_low_count    = 0
        notify_queue_full_count   = 0
        notify_data_waiting_count = 2
        notify_error_count        = 0
        notify_close_count        = 0
        notify_sendstatus_count   = 0
        notify_open_count         = 1
        pulse_data_waiting_count  = 0
        queue_full                = 0
        queue_full_drop           = 0
        outstanding_buffers       = 0
        overflow_queue_size       = 0
        cumulative_overflow_msgs  = 0
        hwm_overflow_msgs         = 0
    BPI AIPC Information:
        conn_present              = 0
        tx_attempt_count          = 0
        tx_count                  = 0
        rx_count                  = 0
        notify_connect_count      = 0
        notify_queue_high_count   = 0
        notify_queue_low_count    = 0
        notify_data_waiting_count = 0
        notify_error_count        = 0
        notify_close_count        = 0
        notify_sendstatus_count   = 0
        notify_open_count         = 0
        queue_full                = 0
        queue_full_drop           = 0
        outstanding_buffers       = 0
        overflow_queue_size       = 0
        cumulative_overflow_msgs  = 0
        hwm_overflow_msgs         = 0
    Feature Information (number of entries = 0):
    ---------------------------------------------------

RP/0/RSP0/CPU0:router# show subscriber database interface
Tue Jun 15 09:05:53.769 EDT
Interface	Ifhandle		Session ID:
Gi0/2/0/0.ip1	0x1000040		0x4000000
Gi0/2/0/0.ip2	0x1000060		0x4000082

RP/0/RSP0/CPU0:router# show subscriber database statistics

Tue Jun 15 09:05:53.769 EDT
3 wrapping entries (2048 possible, 0 filtered, 3 total)
Jun 15 06:49:40.123 subdb/common 0/0/CPU0 t4004322208 Process client ID '2' with connection event 'RESTARTED'
Jun 15 06:49:40.125 subdb/common 0/0/CPU0 t4153857728 Process SPI END RECONCILE msg for client '2 [ring index '0']
Jun 15 06:49:40.125 subdb/common 0/0/CPU0 t4004322208 Process client ID '2' with connection event 'RECONCILED'
This is a sample output of the show subscriber database session subscriber-label command, with subscriber templates enabled: 

RP/0/RSP0/CPU0:router# show subscriber database session subscriber-label 0x42
Fri Nov  7 16:14:20.683 IST

Subscriber Object Information 
---------------------------------------------------------------
Subscriber Label:                                         0x00000042
Session State:                                            CFG_DONE
Activate Request Identifier:                              26
Transaction Identifier (PD or PAD):                       None
PD Request Identifier:                                    15
PD Request Options:                                       0x00000003
Config Changed Due to Template Change:                    FALSE
Destroy Request Received:                                 NO
Destroy Request Identifier:                               0
Creator of Connection Gone:                               FALSE
Number of Pending BPI Request Sent:                       0
Current Apply Level for the Added/Modified Feature Tree:  None
Current Apply Level for the Deleted Feature Tree:         None
Delete Notification Done:                                 TRUE
Add/Modify Notification Done:                             TRUE
Need to be rolled back:                                   FALSE
Rollback in progress:                                     FALSE
Server restart apply:                                     FALSE
Rollback performed:                                       FALSE
Replication pending:                                      FALSE
Activate timer running:                                   FALSE
Apply timer running:                                      FALSE
Event queue size:                                         0
Restart Vector:                                           0x00000000
Template Interface Id:                                    0x00802c80 

Add/Modify Level Tree (Number of Levels = 0):
----------------------------------------------

Delete Level Tree (Number of Levels = 0):
----------------------------------------------

show subscriber database template

To display the template interface handle and template session information of a subscriber session, use the show subscriber database template command in the EXEC mode.

show subscriber database template [parent-if-handle if-handle | parent-if-name interface-type interface-name] [location node-id]

Syntax Description

parent-if-handle

(Optional) Specifies parent interface handle.

if-handle

Hex value of parent interface handle. The range is from 0 to ffffffff.

parent-if-name

(Optional) Specifies the parent interface name.

interface-type

Specifies the interface type.

interface-name
location

(Optional) Displays the node location by interface.

node-id

Displays the fully qualified location specification of an interface.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 5.3.0

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

read

Examples

This is a sample output of the show subscriber database template command: 

RP/0/RSP0/CPU0:router# show subscribber database template

Location 0/RSP0/CPU0
--------------------------------
Interface                         Tmpl-Ifhandle  Tmpl-Sub-Label  Session Count
--------------------------------  -------------  --------------  -------------
Bundle-Ether121.104.tmpl2          0x00000c60     0xfc000012       1                  <<<<<<<<  check  here
Bundle-Ether121.104.tmpl1          0x00000c20
Bundle-Ether121.104.tmpl3          0x00000ca0
Bundle-Ether121.104.tmpl4          0x00000ce0
Bundle-Ether121.104.tmpl5          0x00000d20
Bundle-Ether121.104.tmpl6          0x00000d60
Bundle-Ether121.104.tmpl7          0x00000da0
Bundle-Ether121.104.tmpl8          0x00000de0
Bundle-Ether121.104.tmpl9          0x00000e20
Bundle-Ether121.104.tmpl10         0x00000e60
This is a sample output of the show subscriber database template parent-if-handle command: 


RP/0/RSP0/CPU0:router# show subscriber database template parent-if-handle 0x1d80
                      
Fri Nov  7 15:41:02.982 IST
Location 0/1/CPU0
--------------------------------
Interface                         Tmpl-Ifhandle  Tmpl-Sub-Label  Session Count
--------------------------------  -------------  --------------  -------------
Bundle-Ether1.1.tmpl11             0x00802c80     0xfc000001       1 
Bundle-Ether1.1.tmpl12             0x00802d80
Bundle-Ether1.1.tmpl13             0x00802e80
Bundle-Ether1.1.tmpl14             0x00802f80
Bundle-Ether1.1.tmpl15             0x00803080
This is a sample output of the show subscriber database template parent-if-name command: 


RP/0/RSP0/CPU0:router# show subscriber database template parent-if-name Bundle-Ether1.1
                      
Fri Nov  7 15:41:14.363 IST
Location 0/1/CPU0
--------------------------------
Interface                         Tmpl-Ifhandle  Tmpl-Sub-Label  Session Count
--------------------------------  -------------  --------------  -------------
Bundle-Ether1.1.tmpl11             0x00802c80     0xfc000001       1 
Bundle-Ether1.1.tmpl12             0x00802d80
Bundle-Ether1.1.tmpl13             0x00802e80
Bundle-Ether1.1.tmpl14             0x00802f80
Bundle-Ether1.1.tmpl15             0x00803080

Related Commands

Command Description

show subscriber database

Displays the configuration details of subscriber database.  

show ipsubscriber template-interface

Displays the template information for the IP subscriber interfaces.  

show subscriber feature accounting

To display the feature accounting information of the subscriber, use the show subscriber feature accounting command in the EXEC mode.

show subscriber feature accounting ma {statistics debug [location location] | subscriber-label subscriber-id | summary [location location] | trace {all | error | event}}

Syntax Description

ma

Displays the subscriber accounting feature management agent information.

statistics

Displays the accounting feature statistics.

debug

Displays the debug statistics.

location

Specifies the location of the node.

location

Fully qualified location name.

subscriber-label

Specifies the unique subscriber ID.

subscriber-id

ID of the subscriber, in hexadecimal.

summary

Displays the summary data.

trace

Displays the accounting feature ltrace data.

all

Displays trace of all errors and events.

error

Displays trace of errors.

event

Displays trace of events.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Release 5.1

The show command output was extended to display session Idle Timeout feature information.

Release 5.3.0

The show command output was extended to display the prepaid feature information.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

read

Examples

This is the sample output of the show subscriber feature accounting command in the EXEC mode mode: 


RP/0/RSP0/CPU0:router# show subscriber feature accounting ma subscriber-label 0x40
Subscriber Label: 0x40         Interface: Gi0/0/0/0.pppoe1

  Feature:  Session Accounting      Method-list: default

  Feature:  Session Idle Timeout
    Timeout value:         200 seconds
    Threshold value:       3 minutes per packet
    Timeout direction:     both

This table describes the significant fields displayed in the show subscriber feature accounting command output :

Field Description
Timeout value Specifies the timeout value configured for that particular subscriber session.
Threshold value Specifies the threshold value configured for that particular subscriber session, to decide on the duration of the session inactivity.
Timeout direction: both Specifies that both the ingress and egress traffic is considered for the determination of the idle time for that particular subscriber session.
This is a sample output of the show subscriber feature accounting command, with the DIAMETER prepaid feature configured: 

RP/0/RSP0/CPU0:router# show subscriber feature accounting ma subscriber-label 0x42

Subscriber Label: 0x42         Interface: Gi0/0/0/0.pppoe3

Feature:  Session Accounting      Method-list: default
Periodic interval: 3000

Feature:  Service Accounting
Service-ID: 0x4000004      Method-list: default    Periodic interval: 6000

Flow Label: 0x4     Direction: Both Ingress and Egress
Feature:  Prepaid   Prepaid-Config: foo4

FSM-Type         FSM-State              Threshold
-------------------------------------------------
Volume FSM   NEW-QUOTA-ARRIVED           0
Time FSM     NOT-ACTIVE                  60

Quota-type   : Input-Volume        Output-Volume       Bi-Directional-Volume
-----------------------------------------------------------------------------
New-Arrived  : 0                   0                   600
New-Used     : 0                   0                   0
Total-arrived: 0                   0                   1200
Total-Used   : 0                   0                   0
Pre-Tariff   : 0                   0                   0
Post-Tariff  : 0                   0                   0
num is a[0] is 0num is a[1] is 0num is a[2] is 57num is a[3] is 1918
Waiting for Volume Quota update: 57 seconds.

Time(in seconds): Quota-Time       Validity-Time    Holding-Time     Tariff-Time
-------------------------------------------------------------------------------
New-Arrived     : 0                2000             66               0
Total           : 0                2000             66               0
Expiry in       : 0                1918             0                0
State           : DISABLED         ENABLED          DISABLED         DISABLED

Related Commands

Command Description

show subscriber database

Displays the configuration details of subscriber database.  

show subscriber manager statistics

Displays the subscriber management internal manager information.  

show subscriber running-config

Displays the subscriber running configuration derived from dynamic template.  

show subscriber session

Displays the subscriber management session information.  

show subscriber manager sadb

To display the database information of the subscriber management feature attribute, use the show subscriber manager sadb command in the EXEC mode mode.

show subscriber manager sadb [location location]

Syntax Description

location

Specifies the location of the node.

location

Fully qualified location name.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

read

Examples

This is the sample output of the show subscriber manager sadb command: 


RP/0/RSP0/CPU0:routershow subscriber manager sadb
Mon Apr  8 10:02:24.274 IST

Sublabel: 0x00000095 Node_ID: 00000000 Signature: 0xabcdef12 Version: 1 Rev: 9
Length: 168

Attribute list: 135469872
1:  outer-vlan-id   len=  4  10(a)
2:  port-type       len=  4  Virtual IP over VLAN
3:  static-session  len=  1  true
4:  parent-if-handle len=  4  1664(680)
5:  string-session-id len=  8  00000049
6:  interface       len=  8  0/0/1/10
7:  username        len=  6  BNG:10
8:  if-handle       len=  4  1664(680)
9:  vrf-id          len=  4  0(0)
10:  ipv4-session-state len=  1  true

Related Commands

Command Description
show subscriber session Displays the subscriber management session information.  
ipsubscriber interface Enables interface based static session in BNG.  

show subscriber manager statistics

To display the subscriber management internal manager information, use the show subscriber manager statistics command in the EXEC mode mode.

show subscriber manager statistics {AAA COA | HA | PPSM | PRE | SVM | debug | performance | summary}

Syntax Description

AAA

Displays the Authentication, Authorization, Accounting Coordinator statistics.

HA

Displays the High Availability statistics.

PPSM

Displays the Policy Plane Session Manager statistics.

PRE

Displays the Policy Rule Engine statistics.

SVM

Displays the Service Manager statistics.

debug

Displays the debug statistics.

performance

Displays the performance statistics.

summary

Displays the summary statistics.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Release 5.2.0

The output of show subscriber manager statistics command was modified to track the statistics for singleton and multiple-service CoA requests separately for show subscriber manager statistics AAA COA [ location <> ] , to display the Multi-Service field for show subscriber manager statistics AAA COA, show subscriber manager statistics PRE event, and show subscriber manager statistics PRE action total location <> commands, and to display MA-CoA RB Success and MA-CoA RB Failure fields for show subscriber manager statistics SVM events location <> command.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

read

Examples

This is the sample output of the show subscriber manager statistics command in the EXEC mode mode: 


RP/0/RSP0/CPU0:router# show subscriber manager statistics summary total

The show subscriber manager statistics output is as follows: 


Wed Jan 23 09:57:41.855 GMT

[ IEDGE SUMMARY STATISTICS ]

 Location: 0/0/CPU0

IEDGE SUMMARY
=============
Control Policy errors
  Subscriber control policy not applied on interface = 0
  No class match in Start Request                    = 0

Attribute format warnings
  NAS Port                                           = 0
  NAS Port id                                        = 0
  Destination station id                             = 0
  Calling station id                                 = 0
  User Name                                          = 0

User Profile Statistics
  User Profile Install                               = 0
  User Profile Install errors                        = 0
  User Profile Removes                               = 0
  User Profile Errors                                = 0

Session Disconnect Flow Control
  Inflight                                           = 0
  Queued                                             = 0

 Location: 0/1/CPU0

IEDGE SUMMARY
=============
Control Policy errors
  Subscriber control policy not applied on interface = 0
  No class match in Start Request                    = 0

Attribute format warnings
  NAS Port                                           = 72
  NAS Port id                                        = 0
  Destination station id                             = 72
  Calling station id                                 = 72
  User Name                                          = 0

User Profile Statistics
  User Profile Install                               = 0
  User Profile Install errors                        = 0
  User Profile Removes                               = 0
  User Profile Errors                                = 0

Session Disconnect Flow Control
  Inflight                                           = 0
  Queued                                             = 0

This table describes the significant fields shown in the display.

Table 1. show subscriber manager statistics Field Descriptions

Field

Description

Control Policy errors

Specifies the errors in the control policy.

Attribute format warnings

Specifies the attribute format warnings.

User Profile Statistics

Specifies the user profile statistics.

Session Disconnect Flow Control

Specifies the session disconnect flow control.

These are the sample outputs for the show subscriber manager statistics command with multi-action CoA enabled, in EXEC mode mode: 


RP/0/0/CPU0server:# show subscriber manager statistics AAA COA

Wed Jun 27 10:08:37.331 EDT

[ CHANGE OF AUTHORIZATION STATISTICS ]

 Location: 0/0/CPU0

CoA Requests:
                 Type     Received        Acked        NAKed
                 ====     ========        =====        =====
        Account Logon            0            0            0
       Account Logoff            0            0            0
       Account Update            0            0            0
           Disconnect            0            0            0
 Single Service Logon            0            0            0
Single Service Logoff            0            0            0
     Multiple Service           10           10            0

Errors:
  None

RP/0/0/CPU0:server#

In the above show output, see the Multiple Service row to fetch information on how many MA-CoA requests were issued, the number of MA-CoA requests acknowledged, and the number of MA-CoA requests that were not acknowledged. 


RP/0/0/CPU0server:#show subscriber manager statistics PRE event

Wed Jun 27 11:00:27.029 EDT

[ EVENT STATISTICS ]

 Location: 0/0/CPU0

Events executed         Success Fail    Pending
===============         ======= ====    =======
3                       2       1       0

Detail Statistics
========================
Type                            Total   Success Fail    Pending
====                            =====   ======= ====    =======
Session-Start                   1       1       0       0      
Session-Update                  0       0       0       0      
Session-Up                      0       0       0       0      
Session-Down                    0       0       0       0      
Session-Disconnect              0       0       0       0      
Session-Disconnect Request      0       0       0       0      
Session-Force-Kill              0       0       0       0      
Session-Restart                 0       0       0       0      
Session-Activate                1       1       0       0      
Service-Start                   0       0       0       0      
Service-Stop                    0       0       0       0      
Multi-Service                   0       0       0       0      
Account-Logon                   0       0       0       0      
Account-Logoff                  0       0       0       0      
Account-Update                  0       0       0       0      
Flow-Start                      0       0       0       0      
Flow-Stop                       0       0       0       0      
Accounting-Start                0       0       0       0      
Accounting-Stop                 0       0       0       0      
Accounting-Update               0       0       0       0      
Absolute-Timeout                0       0       0       0      
Idle-Timeout                    0       0       0       0      
Idle-Awake                      0       0       0       0      
Timer-Expiry                    0       0       0       0      
Keepalive-Success               0       0       0       0      
Keepalive-Failure               0       0       0       0      
Link-status up                  0       0       0       0      
Link-status down                0       0       0       0      
Credit-Exhausted                0       0       0       0      
Quota-Depleted                  0       0       0       0      
Threshold_Reached               0       0       0       0      
Prepaid-start                   0       0       0       0      
Prepaid reauthorize             0       0       0       0      
Prepaid idle-timeout            0       0       0       0      
Prepaid accounting-start        0       0       0       0      
Prepaid accounting-stop         0       0       0       0      
Session-Deactivate-request      0       0       0       0      
Author Failure                  0       0       0       0      
Author No Response              0       0       0       0      
Authen Failure                  1       0       1       0      
Authen No Response              0       0       0       0      
Exception                       0       0       0       0  

RP/0/0/CPU0:server#

In the above show output, see the Multi-Service and Exception rows to fetch debug information related to MA-CoA requests. 


RP/0/RSP0/CPU0server:# show subscriber manager statistics PRE action total location 0/RSP0/CPU0 

[14:09:22.543 UTC Thu Feb 13 2014] +++


[ PRE ACTION STATISTICS ]

Actions executed        Success Fail    Pending
================        ======= ====    =======
5               5       0       0

Detail Statistics
========================
Type                   			 			Total   Success Fail    Pending
====                    						=====   ======= ====    =======
authenticate                    0       0       0       0
unauthenticate                  0       0       0       0
authorize                       0       0       0       0
accounting start                0       0       0       0
accounting stop                 0       0       0       0
accounting update               0       0       0       0
set-timer                       0       0       0       0
stop-timer                      0       0       0       0
disconnect                      0       0       0       0
collect                         0       0       0       0
quota-replenish                 0       0       0       0
prepaid                         0       0       0       0
proxy                           0       0       0       0
activate                        0       0       0       0
deactivate                      0       0       0       0
multi-service                   5       5       0       0
inline policy                   0       0       0       0
session-update                  0       0       0       0
session-up                      0       0       0       0
session-down                    0       0       0       0
session-idle                    0       0       0       0
apply user profile              0       0       0       0
query ANCP                      0       0       0       0
monitor                         0       0       0       0

In the above show output, see the multi-service row to fetch debug information related to MA-CoA requests. 


RP/0/RSP0/CPU0server:#show subscriber manager statistics SVM events location 0/RSP0/CPU0  
[14:09:23.571 UTC Thu Feb 13 2014] +++

[ IEDGE SVM EVENT STATISTICS ]

 Location:

SVM INTERNAL EVENT COUNTERS (125):
            EVT                   COUNT
       Sess Create invocations        0
      Sess Create (bad client)        0
             Sess Create (DUP)        0
             Sess Create (BAD)        0
           Sess Create (ASYNC)        0
       Sess Create (BAD STATE)        0
             SVMB (uB) Creates        1
             SVMB (uB) Removes        0
             SVMS (SB) Creates       14
             SVMS (SB) Removes       10
             SVMA (AS) Creates       14
             SVMA (AS) Removes        0
          SVM KEY Creates/Dups       43
               SVM KEY Removes       25
             Apply invocations        0
          Apply (bad argument)        0
             Apply (no memory)        0
        Apply (missing create)        0
          Apply (create error)        0
           Apply (assoc error)        0
             Apply (call back)       34
       Apply (call back error)        0
            Apply (successful)       24
           Unapply invocations        0
        Unapply (bad argument)        0
             Unapply (no svmb)        0
             Unapply (no svma)        0
Unapply rejected (wrong state)        0
                Unapply failed        0
       Unapply (unassoc error)       25
           Unapply (call back)       15
     Unapply (call back error)        0
           Replace invocations        0
        Replace (bad argument)        0
      Replace (Duplicate data)        0
                Replace failed        0
        User Profile before PM        0
     User Profile PM callbacks        0
      User Profile invocations        0
User Profile Recon invocations        0
           User Profile Merges        0
           User Profile Applys        0
         User Profile Unapplys        0
 Prod All Done Post Instl proc        0
          User Profile Removes        0
       User Profile Uninstalls        0
        User Profile Clean ups        0
   User Profile Install errors        0
     User Profile Assoc errors        0
           User Profile Errors        0
  User Prof Apply during recon        0
 User Prof Remove during recon        0
       Remove sess invocations        0
           Remove sess missing        0
            Remove sess failed        0
         Prod Done invocations        5
           Prod Done (no svmb)        0
           Prod Done (bad arg)        0
         Prod Done (bad state)        0
            Prod Done (failed)        0
        Prod Done (not needed)        0
         Prod Done (real call)        5
          Prod Done (SubDB CB)       11
          Prod Done (GENED CB)        0
          Prod Done (COMPL CB)       11
          Prod Done (ERROR CB)        0
     Prod Done (BAD REASON CB)        0
  Prod Done(SubDB CB) on recon        0
  Prod Done(GENED CB) on recon        0
  Prod Done(COMPL CB) on recon        0
     Prod All Done invocations        0
    Prod All Done Bad Rtn Code        0
       Prod All Done Callbacks        0
   Prod All Done NULL Callback        0
  Prod All Done Callback Error        0
            PAD Calls on recon        0
        PAD Callbacks on recon        0
     PAD Callback err on recon        0
          HA Session callbacks        5
        HA Session CB bad args        0
      HA Session CB no session        0
          HA Session CB all OK        5
    HA Session CB User Profile        0
HA Sess CB NULL flat attr list        0
    HA Session CB NULL UP name        0
    HA Session CB PQOS present        0
       HA Session CR callbacks        1
        HA Session CR bad args        0
        HA Session CR no label        0
       HA Session CR too short        0
        HA Session CR bad size        0
      HA Session CR data in OK        1
          HA Session CR all OK        1
              HA SP ADD enters       10
            HA SP ADD bad size        0
           HA SP ADD no memory        0
          HA SP ADD write fail        0
              HA SP ADD all OK       10
               HA SP GET enter        0
               HA SP GET error        0
            HA SP DELETE enter       10
        HA SP DELETE bad param        0
            HA SP DELETE error        0
           HA SP DELETE all OK       10
          HA SP Restart enters        1
      HA SP Restart next error        0
      HA SP Restart records OK        4
    HA SP Rest OK, CLI on Host        4
     HA SP Rest OK, SP on Host        0
   HA SP Rest OK, SP on Server        0
                Utility Error1        0
                Utility Error2        0
                Utility Error3        0
                Utility Error4        0
                Utility Error5        0
                Utility Error6        0
                Utility Error7        0
                Utility Error8        0
                Utility Error9        0
               Utility Error10        0
               Utility Error11        0
             MA-CoA RB Success        5
             MA-CoA RB Failure        0
             Subdb Recon Begin        1
               Subdb Recon End        1

In the above show output, see the MA-CoA RB Success and MA-CoA RB Failure rows to fetch debug information related to MA-CoA rollback success and failures. 


RP/0/0/CPU0:# show subscriber manager statistics perf non-zero

Tue Jun  3 13:14:34.547 IST

[ IEDGE PERFORMANCE DATA ]

                          Type       Ave(ms)   StdDev(ms)    Min(ms)    Max(ms)    Count  
                          ====       =======   ==========    =======    =======    ===== 




RP/0/0/CPU0:# show subscriber manager statistics performance

Tue Jun  3 13:14:34.547 IST

[ IEDGE PERFORMANCE DATA ]

                         Type       Ave(ms)   StdDev(ms)    Min(ms)    Max(ms) 
                          ====       =======   ==========    =======    ======= 

Transactions:

      Absolute-timeout request         0.0         0.0        0.0        0.0    
           Account logon event         0.0         0.0        0.0        0.0    
          Account logoff event         0.0         0.0        0.0        0.0    
          Account update event         0.0         0.0        0.0        0.0    
            Accounting request         0.0         0.0        0.0        0.0    
       Authentication continue         0.0         0.0        0.0        0.0    
      Session Activate request         0.0         0.0        0.0        0.0    
                  Bind request         0.0         0.0        0.0        0.0    
           Flow disconnect ack         0.0         0.0        0.0        0.0    
         Flow disconnect event         0.0         0.0        0.0        0.0    
       Flow disconnect request         0.0         0.0        0.0        0.0    
            Flow start request         0.0         0.0        0.0        0.0    
          Idle Timeout request         0.0         0.0        0.0        0.0    
      Identity release request         0.0         0.0        0.0        0.0    
        Session update request         0.0         0.0        0.0        0.0    
      Keepalive status request         0.0         0.0        0.0        0.0    
           Link status request         0.0         0.0        0.0        0.0    
               Prepaid request         0.0         0.0        0.0        0.0    
           Service start event         0.0         0.0        0.0        0.0    
            Service stop event         0.0         0.0        0.0        0.0    
        Session disconnect ack         0.0         0.0        0.0        0.0    
      Session disconnect event         0.0         0.0        0.0        0.0    
    Session disconnect request         0.0         0.0        0.0        0.0    
            Session kill event         0.0         0.0        0.0        0.0    
         Session start request         0.0         0.0        0.0        0.0    
            Timer expiry event         0.0         0.0        0.0        0.0    
    Session deactivate request         0.0         0.0        0.0        0.0    
   Passthru Accounting request         0.0         0.0        0.0        0.0    
      Author no response event         0.0         0.0        0.0        0.0    
           Author failed event         0.0         0.0        0.0        0.0    
      Authen no response event         0.0         0.0        0.0        0.0    
           Authen failed event         0.0         0.0        0.0        0.0    
 Session Up and Update request         0.0         0.0        0.0        0.0    
          Session Down request         0.0         0.0        0.0        0.0    
     Session State AF Register         0.0         0.0        0.0        0.0    
           Session info update         0.0         0.0        0.0        0.0    
        Mobility Failure event         0.0         0.0        0.0        0.0    
				Session disconnect queuing         0.0         0.0        0.0        0.0

show subscriber redundancy group

To display the operational summary (including the active subscriber sessions under each subscriber redundancy group (SRG) and the transient sessions awaiting synchronization to the peer) of all the configured SRGs, use the show subscriber redundancy group command in the EXEC mode mode.

show subscriber redundancy group [group-id [session | tunnel]] [location node-id]

Syntax Description

group

Displays the summary information of all SRGs.

group-id

Displays the detailed information of a specific SRG.

session

Displays the key information about the sessions active under the SRG.

tunnel

Displays the tunnel information specific to each SRG group.

Command Default

None

Command Modes

EXEC

Command History

Release Modification
Release 5.3.2

This command was modified to add the new keyword, tunnel .

Release 5.2.2

This command was introduced.

Usage Guidelines

The details listed under the show subscriber redundancy group command for a specific SRG include:

  • Various applied operational parameters.

  • Details of tracking objects registered on the SRG and their status. This shows if it is configured or not, if it is set in the SRG but unknown because the tracking object is not configured and shows the current status of object as reported.

  • Details about the peer that include the status of connection and info (for example, its tracking status and roles) that it provided to this router in the previous negotiation, the timestamp of last negotiation and the time when the peer went up or down.

  • Details about switchover that include the last role change along with the reason, number of switchovers and information regarding hold-timer (whether the timer is currently running and if running, the remaining time).

  • The active subscriber session statistics and any pending updates or deletions to be sent to the peer.

  • The session entries that experienced failures in synchronization with the peer. Generally, this may be seen on the subordinate where provisioning failed due to configuration mismatch or due to some other resource constraints.

  • The number and list of active access sub-interfaces under the SRG.

The retry mechanisms of the subscriber redundancy feature take care of recovery from transient errors. Also, logs with more details on the specific errors are generated for persistent synchronization errors.

Task ID

Task ID Operation

network

read

Examples

This is a sample output of the show subscriber redundancy group command: 


RP/0/RSP0/CPU0:router#show subscriber redundancy group

Subscriber Redundancy Agent Group Summary

Flags    : E - Enabled, D - Disabled, M - Preferred Master, S - Preferred Slave
           H - Hot Mode, W - Warm Mode, T - Object Tracking Enabled

P/S      : Peer Status
           I - Initialize, Y - Retry, X - Cleanup, T - Connecting
           L - Listening, R- Registered, C - Connected, E - Established

I/F Count: Interface Count
SS Count : Subscriber Session Count

-----------------------------------------------------------------------------------------
Node Name | Group ID | Role | Flags | Peer Address | P/S | I/F Count | SS Count | Sync 
                                                                                  Pending
-----------------------------------------------------------------------------------------
0/RSP0/CPU0  210  			Master   EMHT   	11::2          E        1        8000       0
0/RSP0/CPU0  410  			Slave    EMHT   	1.1.1.2        E        1        8000       0

Session Summary Count(Master/Slave/Total): 8000/8000/16000

This table describes the significant fields shown in the display:

Field

Description

Initialize

Initial state when some configuration is incomplete or SRG is disabled.

Connecting or Listening or Registering

During the process of TCP connection establishment between client and server.

Connected or Established

TCP connection is done and moves to steady state after role negotiation.

Retry or Cleanup

Transient error conditions.

This is a sample output of the show subscriber redundancy group command that displays the key information about the sessions active under the SRG: 


RP/0/RSP0/CPU0:router#show subscriber redundancy group 210

Subscriber Redundancy Group ID: 210
  Description : <<not-configured>>

  Status              : Enabled
  Init-Role           : Master
  Negotiated-Role     : Master               Current-Role : Master

  Slave-mode          : Hot                     Hold Time : 15

  Virtual MAC Address : 0000.0000.2020
  L2TP Source Address : <<not-configured>>

  Core-Tracking       : <<not-configured>>
    Status            : n/a
  Access-Tracking     : vlan210
    Status            : Up
  Tracking Status     : Enabled

Peer:
    11::2                                          Status : Established
    Role(Init/Neg/Cur): Slave/Slave/Slave
    Tracking Status   : Down

    Last Neg-Time     : 2014 Sep 12 07:12:11
    Last Up-Time      : 2014 Sep 11 14:47:55
    Last Down-Time    : 2014 Sep 11 14:26:45

 Switchover:
    Last Switchover   : 2014 Sep 12 07:12:11       Reason : Object Tracking Status Change
    Switchover Count  : 4
    Hold Time         : Not-Running

 Subscriber Session Statistics:
    Count             : 8000               Slave-Upd-Fail : 0
    Pending Update    : 0                  Pending Delete : 0
    Tunnel Count      : 0

Interface Count     : 1
    Bundle-Ether1.10                       Map-ID         : 210

This table describes the significant fields shown in the display:

Field

Description

Init-role

Specifies if primary-subordinate preference is set.

Negotiated-role

Specifies the desired role during previous and next role negotiation exchange.

Current-role

Specifies the current role assumed.

This is a sample output of the show subscriber redundancy group session command: 


RP/0/RSP0/CPU0:routershow subscriber redundancy group 210 session

Subscriber Redundancy Agent Group Session
------------------------------------------------------------------------------
 Parent Interface              |   MAC Address  | In/Out VLAN | PPPoE/L2TP ID
------------------------------------------------------------------------------
 Bundle-Ether1.10                0000.680b.0102   0/210          0/0
 Bundle-Ether1.10                0000.680b.0103   0/210          0/0
 Bundle-Ether1.10                0000.680b.0104   0/210          0/0
 Bundle-Ether1.10                0000.680b.0105   0/210          0/0
 Bundle-Ether1.10                0000.680b.0106   0/210          0/0
 Bundle-Ether1.10                0000.680b.0107   0/210          0/0
 Bundle-Ether1.10                0000.680b.0108   0/210          0/0
 Bundle-Ether1.10                0000.680b.0109   0/210          0/0
 Bundle-Ether1.10                0000.680b.010a   0/210          0/0
 Bundle-Ether1.10                0000.680b.010b   0/210          0/0
 Bundle-Ether1.10                0000.680b.010c   0/210          0/0
 Bundle-Ether1.10                0000.680b.010d   0/210          0/0
 Bundle-Ether1.10                0000.680b.010e   0/210          0/0
 Bundle-Ether1.10                0000.680b.010f   0/210          0/0
 Bundle-Ether1.10                0000.680b.0110   0/210          0/0

This is a sample output of the show subscriber redundancy group command that displays the tunnel information: 


RP/0/RSP0/CPU0:router show subscriber redundancy group 1 tunnel

Subscriber Redundancy Agent Group Tunnel
 Operational: SA-SRGA, L2-L2TP
       Flags: U-Update, D-Delete, S-InSync, F-TxListFail, T-Dirty
-------------------------------------
 L2TP TID      |  Operational Flag
-------------------------------------
 4557              M--   SA{S} L2{S}

Related Commands

Command Description

show subscriber redundancy summary

Displays the global status of BNG geo redundancy feature.  

show subscriber redundancy summary

To display the global status of BNG geo redundancy feature, use the show subscriber redundancy summary command in the EXEC mode mode.

show subscriber redundancy summary [group | interface]

Syntax Description

group

Displays the subscriber redundancy summary of all configured SRGs.

interface

Displays the subscriber redundancy summary of all access sub-interfaces configured under SRGs.

Command Default

None

Command Modes

EXEC

Command History

Release Modification
Release 5.2.2

This command was introduced.

Usage Guidelines

The details listed under this output of this command include, the IPv4 and IPv6 addresses from the source-interface that is used for peering by this router, and the snapshot of the active subscriber redundancy groups, interfaces and their roles.

The details listed under show subscriber redundancy summary group output also include the attributes or settings of the SRGs in operation and their roles. The output also indicates the RP or LC where the control plane for the SRG is being hosted for troubleshooting purposes.

The details listed under show subscriber redundancy summary interface output also include the mapping group, ID and role of the SRGs.

Task ID

Task ID Operation

network

read

Examples

This is a sample output of the show subscriber redundancy summary command: 


RP/0/RSP0/CPU0:router#show subscriber redundancy summary

Subscriber Redundancy Summary

  Status        : Enabled                     Process State: Active
  Preferred-Role: None
  Slave-Mode    : <<not-configured>>          Hold Time    : 0

Source Interface: GigabitEthernet0/1/0/1
  VRF Name      : default
    IPv4 Address: 1.1.1.1
    IPv6 Address: 11::1

Group Statistics:
  Count         : 10                         Disabled     : 0
  Master        : 5                          Slave        : 5

Interface Statistics:
  Count         : 12
  Master        : 6                          Slave        : 6

This is a sample output of the show subscriber redundancy summary group command: 


RP/0/RSP0/CPU0:router#show subscriber redundancy summary group

Subscriber Redundancy Group Summary
Options: E - Enabled, D - Disabled
         M - Preferred Master, S - Preferred Slave
         H - Hot Mode, W - Warm Mode
         T - Object Tracking Enabled
-------------------------------------------------------------------------
ID | Role | Virtual MAC Addr | Peer Address | I/F Count | Options | Node
-------------------------------------------------------------------------
210  Master  0001.0002.00D2   11::2             2    EM-T    0/RSP0/CPU0
211  Master  0001.0002.00D3   11::2             1    EM-T    0/RSP0/CPU0
212  Master  0001.0002.00D4   11::2             1    EM-T    0/RSP0/CPU0
213  Master  0001.0002.00D5   11::2             1    EM-T    0/RSP0/CPU0
214  Master  0001.0002.00D6   11::2             1    EM-T    0/RSP0/CPU0
410  Slave   0001.0002.019A   1.1.1.2           2    EM-T    0/RSP0/CPU0
411  Slave   0001.0002.019B   1.1.1.2           1    EM-T    0/RSP0/CPU0
412  Slave   0001.0002.019C   1.1.1.2           1    EM-T    0/RSP0/CPU0
413  Slave   0001.0002.019D   1.1.1.2           1    EM-T    0/RSP0/CPU0
414  Slave   0001.0002.019E   1.1.1.2           1    EM-T    0/RSP0/CPU0

This is a sample output of the show subscriber redundancy interface command: 


RP/0/RSP0/CPU0:router#show subscriber redundancy interface

Subscriber Redundancy Interface Summary
Status: E - Exists, F - Forward Reference
-----------------------------------------------------------
 Interface Name      | Status | Group ID | Map ID |  Role
-----------------------------------------------------------
 Bundle-Ether1.1       E        210        210       Master
 Bundle-Ether1.10      E        210        210       Master
 Bundle-Ether1.11      E        211        211       Master
 Bundle-Ether1.12      E        212        212       Master
 Bundle-Ether1.13      E        213        213       Master
 Bundle-Ether1.14      E        214        214       Master
 Bundle-Ether3.1       E        410        410       Slave
 Bundle-Ether3.10      E        410        410       Slave
 Bundle-Ether3.11      E        411        411       Slave
 Bundle-Ether3.12      E        412        412       Slave
 Bundle-Ether3.13      E        413        413       Slave
 Bundle-Ether3.14      E        414        414       Slave

Related Commands

Command Description

show subscriber redundancy group

Displays the operational summary of subscriber redundancy groups.  

show subscriber running-config

To display the subscriber running configuration derived from dynamic template, use the show subscriber running-config command in EXEC mode.

show subscriber running-config {location | subscriber-label}

Syntax Description

location

Displays subscriber database running configuration information for all sessions at specified location.

subscriber-label

Allows to enter a hex value subscriber-value that ranges between 0X0-0xffffffff.

|

Specifies the output modifiers.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID Operation

network

read

Examples

This is a sample output of the show subscriber running-config command: 


RP/0/RSP0/CPU0:router# show subscriber running-config

Tue Jun 15 09:05:53.769 EDT
Session ID: 0x4000000
dynamic-template
 type ipsubscriber TEMPL1
  ipv4 unnumbered Loopback0
 !
!
dynamic-template
 type ipsubscriber TEMPL2
  service-policy input qos_policy
  vrf blue
  ipv4 mtu 1500
 !
!
Session ID: 0x4000082
dynamic-template
 type ipsubscriber TEMPL1
  ipv4 unnumbered Loopback0
 !
!
dynamic-template
 type ipsubscriber TEMPL2
  service-policy input qos_policy
  vrf blue
  ipv4 mtu 1500
 !
!

show subscriber session

To display the subscriber management session information, use the show subscriber session command in the EXEC mode mode.

show subscriber session {all [detail | summary | username] internal [location node-id] | debug | filter | subscriber-label session-id}

Syntax Description

all

Displays all subscriber sessions.

debug

Displays unique subscriber session selected for debugging.

filter

Displays the search results of the subscriber session database based on the filter criteria.

subscriber-label

Displays the unique ID of the subscriber session.

session-id

Hex value of subscriber session ID. The range is from 0 to ffffffff.

Command Default

None

Command Modes

EXEC mode

Command History

Release Modification

Release 4.2.0

This command was introduced.

Release 4.3.1

Added example output for show subscriber session all detail command to display service accounting feature information.

Release 5.2.0

The output of show subscriber session all username command was modified to display the fields, Username , Interface , State and Subscriber IP Addr , instead of Type , Interface , State and Username

Usage Guidelines

For interface-based static sessions in the BNG, the value of Type field in the show ipsubscriber session command output is displayed as IP: Static.

Task ID

Task ID Operation

network

read

config-services

read

Examples

These are some of the options for the show subscriber session command in the EXEC mode: 


RP/0/RSP0/CPU0:router# show subscriber session all
RP/0/RSP0/CPU0:router# show subscriber session all summary location 0/1/CPU0
RP/0/RSP0/CPU0:router# show subscriber session filter vrf vrf1 location 0/1/CPU0
RP/0/RSP0/CPU0:router# show subscriber session subscriber-label 40

This is the sample output of the show subscriber session all command: 


Wed Jan 23 10:20:58.344 GMT
Codes: IN - Initialize, CN - Connecting, CD - Connected, AC - Activated,
       ID - Idle, DN - Disconnecting, ED - End

Type         Interface                State     Subscriber IP Addr / Prefix
                                                LNS Address (Vrf)
--------------------------------------------------------------------------------
PPPoE:PTA    Gi0/1/0/0.pppoe1         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe2         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe3         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe1       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe2       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe3       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe1       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe2       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe3       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe1       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe2       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe3       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe4         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe5         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe6         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe4       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe5       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe6       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe4       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe5       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe6       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe4       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe5       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe6       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe7         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe8         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe9         AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe7       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe8       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe9       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe7       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe8       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe9       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe7       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe8       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe9       AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe10        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe11        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe12        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe10      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe11      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe12      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe10      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe11      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe12      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe10      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe11      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe12      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe13        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe14        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe15        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe13      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe14      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe15      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe13      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe14      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe15      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe13      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe14      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe15      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe16        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe17        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.pppoe18        AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe16      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe17      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.1.pppoe18      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe16      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe17      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.2.pppoe18      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe16      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe17      AC        100.0.0.1 (default)
PPPoE:PTA    Gi0/1/0/0.3.pppoe18      AC        100.0.0.1 (default)

This table describes the significant fields shown in the display.

Table 2. show subscriber session Field Descriptions

Field

Description

Type

Specifies the subscriber session type.

Interface

Specifies the interface type.

State

Specifies the states of the subscriber session such as initiate, connecting, connected, activated, disconnected, idle, end.

Subscriber IP Addr / Prefix LNS Address (Vrf)

Specifies the IP address of the subscriber interface.

This is the sample output for the show subscriber session command in EXEC mode: 


RP/0/0/CPU0:server#show subscriber session all detail internal location$
[14:09:18.244 UTC Thu Mar21 13 2019] +++
Interface:                 Bundle-Ether2.111.ip1
Circuit ID:               Unknown
Remote ID:                Unknown
Type:                     IP: DHCP-trigger
IPv4 State:               Up, Thu Mar 21 17:26:42 2019
IPv4 Address:             95.1.10.133, VRF: vrf1
IPv4 Up helpers:          0x00000040 {IPSUB}
IPv4 Up requestors:       0x00000040 {IPSUB}
Mac Address:              0000.0201.8d8f
Account-Session Id:       00000001
Nas-Port:                 Unknown
User name:                0000.0201.8d8f
Formatted User name:      unknown
Client User name:         unknown
Outer VLAN ID:            11
Inner VLAN ID:            10
Subscriber Label:         0x00000040
Created:                  Thu Mar 21 17:26:40 2019
State:                    Activated
Authentication:           unauthenticated
Authorization:            authorized
Ifhandle:                 0x00000b20
Session History ID:       1
Access-interface:         Bundle-Ether2.111
SRG Flags:                0x00404000(M)
Policy Executed:
          
Session Accounting:       
  Acct-Session-Id:          00000001
  Method-list:              default
  Accounting started:       Thu Mar 21 18:30:43 2019
  Interim accounting:       On, interval 10 mins
    Last successful update: Fri Mar 22 09:28:36 2019
    Next update in:         00:00:01 (dhms)
    Last update sent:       Fri Mar 22 09:28:36 2019
    Updates sent:           40
    Updates accepted:       40
    Updates rejected:       0
    Update send failures:   55
Service Accounting:         TurboAcctSvc
  Acct-Session-Id:          00017701
  Method-list:              ACCT
  Accounting started:       Thu Mar 21 18:31:24 2019
  Interim accounting:       On, interval 10 mins
    Last successful update: Never
    Next update in:         00:08:36 (dhms)
    Last update sent:       Fri Mar 22 10:07:11 2019
    Updates sent:           43
    Updates accepted:       0
    Updates rejected:       43
    Update send failures:   53
Last COA request received: unavailable
User Profile received from AAA:
Attribute List: 0x1500ddf0
1:  ip-vrf          len=  4  value= vrf1
2:  addr-pool       len=  9  value= pool-vrf1
3:  ipv6-enable     len=  4  value= 1(1)
Services:
  Name        : GEO_IP_2-vrf1
  Service-ID  : 0x400001d
  Type        : Multi Template
  Status      : Applied
-------------------------
  Name        : TurboAcctSvc
  Service-ID  : 0x4000011
  Type        : Multi Template
  Status      : Applied
-------------------------
[Event History]
   Mar 21 17:26:42.432 SUBDB produce done
   Mar 21 17:26:42.432 IPv4 Up

In the following table, the descriptions for different SRG flags is provided:

SRG Flags

SRG Flag Values

Description

IEDGE_SRG_FLAG_NONE

0x00000000

SRG function is not supported.

IEDGE_SRG_MASTER_DEL_PENDING

0x00000001

Deletion is pending for SRG Primary Subscriber.

IEDGE_SRG_MASTER_EOMS_INTF_PENDING

0x00000002

EOMS is pending.

IEDGE_SRG_MASTER_EOMS_INTF_RECEIVED

0x00000004

EOMS is received.

IEDGE_SRG_MASTER_EOMS_DEL_PENDING

0x00000008

EOMS is pending because there is delayed delete send for the session.

IEDGE_SRG_SENT_TO_TXLIST

0x00000010

Session is sent over txlist successfully.

IEDGE_SRG_DONT_SEND_TO_TXLIST

0x00000020

Don't send this session over txlist.

IEDGE_SRG_ENCODE_DONE_IN_TXLIST

0x00000040

Encode callback is completed for this session in txlist.

IEDGE_SRG_SKIP_INTF_ROLE_CHECK

0x00000080

Skip INTF-ROLE-CHECK to push data over txlist.

IEDGE_SRG_TXLIST_ENFORCE_REPOSITION

0x00000100

Reposition entry in txlist.

IEDGE_SRG_SLAVE_SEND_NACK

0x00000200

SRG-SUBORDINATE has send NACK before delete.

IEDGE_SRG_OPCODE_FLAG_NONE

0x00000400

No SRG sync.

IEDGE_SRG_OPCODE_FLAG_UPDATE

0x00000800

OPCODE flag is created or updated.

IEDGE_SRG_OPCODE_FLAG_DELETE

0x00001000

OPCODE flag is deleted.

IEDGE_SRG_STATE_FLAG_NONE

0x00002000

SRG state is none.

IEDGE_SRG_STATE_FLAG_MASTER

0x00004000

SRG State Primary flags.

IEDGE_SRG_STATE_FLAG_MASTER_IN_TXLIST

0x00008000

State Primary flags in the txlist.

IEDGE_SRG_STATE_FLAG_SLAVE

0x00010000

SRG State Subordinate flags.

IEDGE_SRG_ROLE_CHANGE

0x00020000

SRG role change flags.

IEDGE_SRG_FC_STATE_INFLIGHT

0x00040000

SRG flow control flags.

IEDGE_SRG_STATE_FLAG_INVALID

0x00080000

SRG State flag is invalid.

IEDGE_SRG_STATE_FLAG_SESSION_RESTORE

0x00100000

SRG State Session Restore flag.

  • IEDGE_NONSRG_INTERIM_ACCT_TRIGGER

  • IEDGE_NONSRG_SESSION_ESTABLISHED

  • IEDGE_NONSRG_IPV4_ADDR_SET

  • IEDGE_NONSRG_IPV6_ADDR_SET

  • IEDGE_NONSRG_IPV6_PD_SET

  • IEDGE_NONSRG_IPV6_PREFIX_SET

  • 0x00200000

  • 0x0400000

  • 0x00800000

  • 0x01000000

  • 0x02000000

  • 0x04000000

This is set per subscriber when the first AF comes up. Make sure to set this once in the life cycle of subscriber.

This is the sample output of the show subscriber session all username command: 


RP/0/0/CPU0:server#show subscriber session all username 
Thu Mar 13 16:25:21.861 IST
Codes: IN - Initialize, CN - Connecting, CD - Connected, AC - Activated,
       ID - Idle, DN - Disconnecting, ED - End
 
Username             Interface              State  Subscriber IP Addr / Prefix                      
                                                     LNS Address (Vrf)                      
--------------------------------------------------------------------------------
basic@cisco.com      Gi0/0/0/0.pppoe1         AC        10.0.0.2 (default)           
basic@cisco.com      Gi0/0/0/0.pppoe2         AC        10.0.0.3 (default)           
basic@cisco.com      Gi0/0/0/0.pppoe3         AC        10.0.0.1 (default)           
basic@cisco.com      Gi0/0/0/0.1.pppoe1       AC        10.0.0.4 (default)

This example shows the detailed information about all the subscriber sessions including service accounting information. 


RP/0/RSP0/CPU0:router# show subscriber session all detail

Interface:                Bundle-Ether12.125.ip643
Circuit ID:               Unknown
Remote ID:                00066c9ced63ef20
Type:                     IP: DHCP-trigger
IPv6 State:               Up, Fri Feb  8 16:42:57 2013
IPv6 Address:             2001:2::b246, VRF: default
Delegated IPv6 Prefix:    3000:2:0:8546::/64, VRF: default
IPv6 Interface ID:        0004007d000c (30 30 30 34 30 30 37 64 30 30 30 63)
Mac Address:              0010.6401.0102
Account-Session Id:       00008ad2
Nas-Port:                 Unknown
User name:                0010.6401.0102
Outer VLAN ID:            125
Subscriber Label:         0x00000046
Created:                  Fri Feb  8 16:42:57 2013
State:                    Activated
Authentication:           unauthenticated
Access-interface:         Bundle-Ether12.125
Policy Executed:
policy-map type control subscriber BNG-Test
  event Session-Start match-first [at Fri Feb  8 16:42:57 2013]
    class type control subscriber PPPoE do-until-failure [Failed]
    class type control subscriber IPoE-DS do-until-failure [Succeeded]
      1 activate dynamic-template IPoE [Succeeded]
      10 authorize aaa list default [Succeeded]
      15 activate dynamic-template test-svc1 [Succeeded]
      16 activate dynamic-template test-svc2 [Succeeded]
Session Accounting:
  Acct-Session-Id:          00008ad2
  Method-list:              default
  Accounting started:       Fri Feb  8 16:43:27 2013
  Interim accounting:       Off
Service Accounting:         AcctTurbo1G
  Acct-Session-Id:          00008ad3
  Method-list:              default
  Accounting started:       Fri Feb  8 16:43:27 2013
  Interim accounting:       On, interval 2 mins
    Last successful update: Never
    Next update in:         00:01:48 (dhms)
Service Accounting:         test-svc3
  Acct-Session-Id:          00008ad4
  Method-list:              default
  Accounting started:       Fri Feb  8 16:43:27 2013
  Interim accounting:       On, interval 2 mins
    Last successful update: Never
    Next update in:         00:01:48 (dhms)
Service Accounting:         svcAcct
  Acct-Session-Id:          00008ad5
  Method-list:              default
  Accounting started:       Fri Feb  8 16:43:27 2013
  Interim accounting:       Off
Service Accounting:         test-svc1
  Acct-Session-Id:          00008ad6
  Method-list:              default
  Accounting started:       Fri Feb  8 16:43:27 2013
  Interim accounting:       On, interval 2 mins
    Last successful update: Never
    Next update in:         00:01:48 (dhms)
Service Accounting:         test-svc2
  Acct-Session-Id:          00008ad7
  Method-list:              default
  Accounting started:       Fri Feb  8 16:43:27 2013
  Interim accounting:       On, interval 2 mins
    Last successful update: Never
    Next update in:         00:01:48 (dhms)
Last COA request received: unavailable

This sample output of show subscriber session all command, displays the active IPv4 or IPv6 client sessions for a dual-stack configuration. 


RP/0/RSP0/CPU0:router# show subscriber session all

Tue Jan 29   12:49:25.237 UTC

Codes: IN -   Initialize, CN - Connecting, CD - Connected, AC - Activated,

       ID - Idle, DN - Disconnecting, ED -   End

Type         Interface               State     Subscriber IP Addr / Prefix

                                                 LNS Address (Vrf)                            

--------------------------------------------------------------------------------

IP:DHCP     BE1.10.ip22             AC       10.10.10.10 (default)

                                                 2001::2 (default)

This sample output of show subscriber session all detail command, displays the detailed information of the active IPv4 or IPv6 client sessions for a dual-stack configuration. 


RP/0/RSP0/CPU0:router# show subscriber session all detail

Tue Jan 29   12:49:27.752 UTC

Interface:               Bundle-Ether1.10.ip22

Circuit ID:               Unknown

Remote ID:               Unknown

Type:                     IP: DHCP-trigger

IPv4 State:               Up, Tue Jan 29 12:46:32 2013

IPv4   Address:             10.10.10.10, VRF:   default

IPv6 State:               Up, Tue Jan 29 12:46:42 2013

IPv6   Address:            2001::2, VRF: default

IPv6 Interface   ID:       ..d..... (02 00 64 ff fe 01   01 02)

Mac   Address:             0000.6401.0102

Account-Session   Id:       0000001c

Nas-Port:                 Unknown

User name:               0000.6401.0102

Outer VLAN ID:           10

Subscriber   Label:         0x00000055

Created:                 Tue Jan 29 12:46:32 2013

State:                   Activated

Authentication:           unauthenticated

Access-interface:         Bundle-Ether1.10

Policy Executed:

policy-map type   control subscriber pm-src-mac

event Session-Start match-all [at Tue Jan   29 12:46:32 2013]

   class type control subscriber   dual_stack_class_map do-all [Succeeded]

     1 activate dynamic-template   Dual_stack_IPoE [Succeeded]

     2 authorize aaa list default   [Succeeded]

Session   Accounting:      

Acct-Session-Id:         0000001c

Method-list:             default

Accounting started:       Tue Jan 29 12:46:32 2013

Interim accounting:       On, interval 1 mins

   Last successful update: Tue Jan 29   12:48:34 2013

   Next update in:         00:00:06 (dhms)

Last COA request   received: unavailable

show subscriber session filter

To show the search results of the subscriber sessions database based on the filter criteria, use the show subscriber session filter command in the EXEC mode.

show subscriber session filter [ interface type interface-path-id | ipv4-address ipv4_address | ipv6-address IANA ipv6_address | mac-address mac_address | state subscriber_state | username user_name | vrf vrf_name] [ detail | location]

Syntax Description

interface

Filters on local subscriber interface name.
ipv4-address

Filters on subscriber IPv4 address.
ipv6-address IANA

Filters on subscriber IPv6 IANA address.
mac-address

Filters on subscriber MAC address.
state

Filters on subscriber session state.
username

Filters on user name.
vrf

Filters on subscriber within a particular vrf.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 6.4.1

This command was modified to include an option to display the output for DHCP IPv6 IANA subscriber sessions.

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the dynamic-template command to enter dynamic template configuration mode.

Task ID

Task ID Operation

network

read

config-services

read

Examples


RP/0/RSP0/CPU0:router# show subscriber session filter interface Bundle-ether100.10 0/1/0/3
RP/0/RSP0/CPU0:router# show subscriber session filter ipv4-address 5.5.5.5 detail location 0/1/CPU0
RP/0/RSP0/CPU0:router# show subscriber session filter mac-address 56.56.5
RP/0/RSP0/CPU0:router# show subscriber session filter username user1
RP/0/RSP0/CPU0:router# show subscriber session filter state t1
RP/0/RSP0/CPU0:router# show subscriber session filter vrf vrf1

This example shows a sample output of DHCP IPv6 IANA subscriber session details on a particular access-interface: 


RP/0/RSP0/CPU0:router# show subscriber session filter ipv6-address IANA 2001:DB8:1::1 detail
Fri Mar  9 13:56:26.710 EDT
Interface:                Bundle-Ether512.10.ip10
Circuit ID:               Unknown
Remote ID:                Unknown
Type:                     IP: DHCP-trigger
IPv6 State:               Up, Fri Mar  9 13:55:42 2018
IPv6 Address:             2001:DB8:1::1, VRF: default
IPv6 Interface ID:        ."...... (12 22 c0 ff fe a8 00 2e)
Mac Address:              A.B.C
Account-Session Id:       0000000a
Nas-Port:                 Unknown
User name:                unknown
Formatted User name:      unknown
Client User name:         unknown
Outer VLAN ID:            10
Subscriber Label:         0x00000248
Created:                  Fri Mar  9 13:55:42 2018
State:                    Activated
Authentication:           unauthenticated
Authorization:            unauthorized
Access-interface:         Bundle-Ether512.10
Policy Executed: 
policy-map type control subscriber pm-ipoe-httpe
  event Session-Start match-first [at Fri Mar  9 13:55:42 2018]
    class type control subscriber httpeCL do-until-failure [Succeeded]
      1 activate dynamic-template tmp1-dtmp1-1 [Succeeded]
      2 activate dynamic-template httpr-service-pldt [Succeeded]
Session Accounting: disabled
Last COA request received: unavailable

Related Commands

Command

Description

class-map type control subscriber

Enables the class-map.

policy-map type control subscriber

Enables the policy-map.

event

Enables the event in the policy-map.

show subscriber session

Displays the subscriber management session information.

show subscriber session history

To show the search results from the Unified Session History (USH) database for the subscriber sessions based on the key type, use the show subscriber session history command in the EXEC mode.

show subscriber session history [ subscriber-mac mac-address | analytics | subscriber-ifhandle if-handle | subscriber-label subscriber-label | [ subscriber-ip IPv4-address | vrf vrf-name] | [ subscriber-ipv6 IPv6-address | vrf vrf-name] ] [ disconnected | errored | location]

Syntax Description

subscriber-mac

Displays the event history for the specified subscriber MAC address.
analytics

Displays USH data analytics.
subscriber-ifhandle

Displays the event history for the specified subscriber interface handle.
subscriber-label

Displays the event history for the specified subscriber label.
subscriber-ip

Displays the event history for the specified subscriber IPv4 address.
subscriber-ipv6

Displays the event history for the specified subscriber IPv6 address.
vrf

Displays the event history for the specified subscriber within a particular vrf.
disconnected

Displays the event history for the successfully disconnected session.
errored

Displays the event history of an errored session.

Command Default

None

Command Modes

EXEC

Command History

Release Modification

Release 6.5.1

This command was introduced.

Usage Guidelines

None

Task ID

Task ID Operation

network

read

config-services

read

Examples


RP/0/RSP0/CPU0:router# show subscriber session history subscriber-mac 0020.9400.000c
RP/0/RSP0/CPU0:router# show subscriber session history subscriber-mac 0010.9400.0094 disconnected
RP/0/RSP0/CPU0:router# show subscriber session history subscriber-mac 0020.9400.000c errored

This example shows a sample output of the event history of an active subscriber which has the specified subscriber MAC address: 


RP/0/RSP0/CPU0:router# show subscriber session history subscriber-mac 0020.9400.000c
oper/ush/&&/key path  mac/0020.9400.000c/0

          STAF event history

Subscriber state: Active

SubscriberMAC:0020.9400.000c

ifhandle: 0x0000cba0

sublabel: 0x00000052

ipv4 Address:192.168.1.42

ipv6 Address: No IPv6 address

vrf:0x60000000 (default)

Time stamp               comp_name       event

----------------------------------------------------------------
11/07/2018 16:34:52:743135       dhcp            Discover pkt procsd

11/07/2018 16:34:52:743135       iedge           IPv4 Start

11/07/2018 16:34:52:747135       aaa             Radiusd recieved Authorization request

11/07/2018 16:34:52:748134       aaa             Radiusd successfully built Access-Request packet

11/07/2018 16:34:52:750134       aaa             Radiusd Successfully sent packet and started timout handler

11/07/2018 16:34:52:753134       aaa             Radiusd recieved Access-Accept

11/07/2018 16:34:52:753134       aaa             Decode radius packet success

11/07/2018 16:34:52:753134       aaa             Radiusd sending reply back to client 

11/07/2018 16:34:52:759133       dhcp            Session Created     - Init state

11/07/2018 16:34:52:760133       dhcp            IP allocated        - Init state
11/07/2018 16:34:52:764132       dhcp            Request pkt procsd  - Post Offer sent

11/07/2018 16:34:52:764132       ipsub           IPSub intf creation started

11/07/2018 16:34:52:764132       ipsub           IPSub init callback from Ifmg

11/07/2018 16:34:52:764132       ipsub           IPSub session start event to iEdge

11/07/2018 16:34:52:764132       ipsub           IPSub init to Ifmgr

11/07/2018 16:34:52:884114       ipsub           IPSub received VRF details

11/07/2018 16:34:52:951103       iedge           SUBDB produce done

11/07/2018 16:34:52:976099       ipsub           IPSub RIB details added

11/07/2018 16:34:53:078084       ipsub           IPSub session up

11/07/2018 16:34:53:079084       iedge           IPv4 Up

11/07/2018 16:34:53:079084       dhcp            Session DPM success

This example shows a sample output of the event history of a successfully disconnected subscriber which has the specified subscriber MAC address: 


RP/0/RSP0/CPU0:router# show subscriber session history subscriber-mac 0010.9400.0094 disconnected
oper/ush/&&/key path  mac/0010.9400.0094/0
STAF event history
Subscriber state: Successfully disconnected 
SubscriberMAC:0010.9400.0094
ifhandle: 0x00000260
sublabel: 0x000025d7
ipv4 Address:200.0.0.29 
ipv6 Address: 
vrf:0x60000000 (default)
Time stamp                       comp_name       event 
---------------------------------------------------------------- 
05/12/2016 12:45:35:328697       dhcp            Discover pkt procsd
05/12/2016 12:45:35:328697       iedge           IPv4 Start
05/12/2016 12:45:38:412225       ipsub           IPSub session up
05/12/2016 12:45:38:417224       iedge           IPv4 Up
05/12/2016 12:45:38:422223       iedge           SUBDB produce done
06/12/2016 07:07:12:330971       dhcp            Lease expired for client

This example shows a sample output of the event history of an errored subscriber session which has the specified subscriber MAC address: 


RP/0/RSP0/CPU0:router# show subscriber session history subscriber-mac 0020.9400.000c errored

/oper/ush/&&/key path  mac/0020.9400.000c/2

          STAF event history

Subscriber state: Errored 

SubscriberMAC:0020.9400.000c

ifhandle: 0x00000000

sublabel: 0x00000051

ipv4 Address: No IPv4 address

ipv6 Address: No IPv6 address

Time stamp               comp_name       event 

---------------------------------------------------------------- 

11/07/2018 16:32:28:386225       dhcp            Discover pkt procsd

11/07/2018 16:32:28:386225       iedge           IPv4 Start

11/07/2018 16:32:28:389225       aaa             Radiusd recieved Authorization request

11/07/2018 16:32:28:391224       aaa             Radiusd successfully built Access-Request packet

11/07/2018 16:32:28:392224       aaa             Radiusd Successfully sent packet and started timout handler

11/07/2018 16:32:33:783399       aaa             Radiusd Successfully sent packet and started timout handler

11/07/2018 16:32:38:790633       aaa             Radiusd Successfully sent packet and started timout handler

11/07/2018 16:32:43:801866       aaa             Radiusd Successfully sent packet and started timout handler

11/07/2018 16:32:48:808100       aaa             Radius packet sending failed  Reason: 'RADIUS' detected the 'fatal' condition 'No server information is available’

11/07/2018 16:32:48:808100       iedge           policy rule failed  Reason: 'AAA_BASE' detected the 'fatal' condition 'Invalid state (aaa base lib error)’

11/07/2018 16:32:48:809100       iedge           Disconnect session