Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Juniper BNG CUPS CLI Operational Commands

This topic provides an overview of show commands, including syntax, option descriptions, and sample output.

show firewall

Syntax

Description

When running the show firewall command on the BNG CUPS Controller, the output displays only the filter names and the associated BNG User Plane. No counters or other information appears. To see the counters or the log or syslog output, you must run the show firewall command on the appropriate BNG User Plane.

Options

filter filter-name

(Optional) Name of a configured filter.

filter regex regular-expression

(Optional) Regular expression that matches the names of a subset of filters.

terse

(Optional) Display firewall filter names and BNG User Plane names.

user-plane user-plane-name Displays the firewall filters for the listed BNG User Plane.

Required Privilege Level

view

Output Fields

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

Table 1: show firewall Output Fields

Field Name

Field Description

Filter

Name of a filter that has been configured with the filter statement at the [edit firewall] hierarchy level

User Plane BNG User Plane name

Sample Output

show firewall terse

show firewall terse (user-plane)

show firewall templates-in-use

Syntax

Description

Display the names of configured filter templates that are currently in use by dynamic subscribers and the number of times each template is referenced.

Options

user-plane user-plane-name (Optional) Displays the configured filter templates for a specific BNG User Plane.

Required Privilege Level

root

Output Fields

Table 2 lists the output fields for the show firewall templates-in-use command. Output fields are listed in the approximate order in which they appear.

Table 2: show firewall templates-in-use Output Fields

Field Name

Field Description

Filter Template

Name of a filter that has been configured using the filter statement at either the [edit firewall] or [edit dynamic-profiles profile-name firewall] hierarchy and is being used as a template for dynamic subscriber filtering

User Plane

BNG User Plane name

Reference Count

Number of times the filter has been referenced by subscribers accessing the network

Sample Output

show firewall templates-in-use

show firewall templates-in-use user-plane

show igmp group

Syntax

Description

Display Internet Group Management Protocol (IGMP) group membership information. This command runs on BNG User Planes.

Required Privilege Level

view

Output Fields

Table 3 describes the output fields for the show igmp group command. Output fields are listed in the approximate order in which they appear.

Table 3: show igmp group Output Fields

Field Name

Field Description

Interface

Name of the interface that received the IGMP membership report. A name of local indicates that the local routing device joined the group itself.

Group

Group address.

Group Mode

Mode the SSM group is operating in: Include or Exclude.

Source

Source address.

Source timeout

Time remaining until the group traffic is no longer forwarded. The timer is refreshed when a listener in include mode sends a report. A group in exclude mode or configured as a static group displays a zero timer.

Last reported by

Address of the host that last reported membership in this group.

Timeout

Time remaining until the group membership is removed.

Group timeout

Time remaining until a group in exclude mode moves to include mode. The timer is refreshed when a listener in exclude mode sends a report. A group in include mode or configured as a static group displays a zero timer.

Type

Type of group membership:

  • Dynamic—Host reported the membership.

  • Static—Membership is configured.

Sample Output

show igmp group

Release Information

Statement introduced in Juniper BNG CUPS Release 22.4R1.

show igmp interface

Syntax

Description

Displays information about Internet Group Management Protocol (IGMP)-enabled interfaces on BNG User Planes.

Options

none

When you run this command on the BNG CUPS Controller, the output displays standard information about all IGMP-enabled interfaces on all BNG User Planes associated to the BNG CUPS Controller.

When you run this command on a BNG User Plane, the output displays standard information about all IGMP-enabled interfaces on the BNG User Plane.

user-plane user-plane-name

(Optional) Displays information about the IGMP-enabled interfaces on the specified BNG User Plane.

Required Privilege Level

view

Output Fields

Table 4 describes the output fields for the show igmp interface command. Output fields are listed in the approximate order in which they appear.

Table 4: show igmp interface Output Fields

Field Name

Field Description

Interface

Name of the interface.

Querier

Address of the routing device that has been elected to send membership queries.

State

State of the interface: Up or Down.

Timeout

How long until the IGMP querier is declared to be unreachable, in seconds.

Version

IGMP version being used on the interface: 1 , 2 , or 3.

Groups

Number of groups on the interface.

Group threshold

Configured threshold at which a warning message is generated.

This threshold is based on a percentage of groups received on the interface. If the number of groups received reaches the configured threshold, the device generates a warning message.

Group log-interval

Time (in seconds) between consecutive log messages.

Immediate Leave

State of the immediate leave option:

  • On—Indicates that the router removes a host from the multicast group as soon as the router receives a leave group message from a host associated with the interface.

  • Off—Indicates that after receiving a leave group message, instead of removing a host from the multicast group immediately, the router sends a group query to determine if another receiver responds.

Promiscuous Mode

State of the promiscuous mode option:

  • On—Indicates that the router can accept IGMP reports from subnetworks that are not associated with its interfaces.

  • Off—Indicates that the router can accept IGMP reports only from subnetworks that are associated with its interfaces.

Distributed

State of IGMP, which, by default, takes place on the Routing Engine for MX Series routers but can be distributed to the Packet Forwarding Engine to provide faster processing of join and leave events.

  • On—distributed IGMP is enabled.

Passive

State of the passive mode option:

  • On—Indicates that the router can run IGMP on the interface but not send or receive control traffic such as IGMP reports, queries, and leaves.

  • Off—Indicates that the router can run IGMP on the interface and send or receive control traffic such as IGMP reports, queries, and leaves.

The passive statement enables you to selectively activate up to two out of a possible three available query or control traffic options. When enabled, the following options appear after the on state declaration:

  • send-general-query—The interface sends general queries.

  • send-group-query—The interface sends group-specific and group-source-specific queries.

  • allow-receive—The interface receives control traffic.

User plane The BNG User Plane to which the interface belongs.

Configured Parameters

Information configured by the user:

  • IGMP Query Interval—Interval (in seconds) at which this router sends membership queries when it is the querier.

  • IGMP Query Response Interval—Time (in seconds) that the router waits for a report in response to a general query.

  • IGMP Last Member Query Interval—Time (in seconds) that the router waits for a report in response to a group-specific query.

  • IGMP Robustness Count—Number of times the router retries a query.

Derived Parameters

Derived information:

  • IGMP Membership Timeout—Timeout period (in seconds) for group membership. If no report is received for these groups before the timeout expires, the group membership is removed.

  • IGMP Other Querier Present Timeout—Time (in seconds) that the router waits for the IGMP querier to send a query.

Sample Output

show igmp interface

Release Information

Statement introduced in Juniper BNG CUPS Release 22.4R1.

show igmp statistics

Syntax

Description

Display Internet Group Management Protocol (IGMP) statistics.

By default, Junos OS multicast devices collect statistics of received and transmitted IGMP control messages that reflect currently active multicast group subscribers.

Some devices also automatically maintain continuous IGMP statistics globally on the device in addition to the default active subscriber statistics—these are persistent, continuous statistics of received and transmitted IGMP control packets that account for both past and current multicast group subscriptions processed on the device. With continuous statistics, you can see the total count of IGMP control packets the device processed since the last device reboot or clear igmp statistics continuous command. The device collects and displays continuous statistics only for the fields shown in the IGMP packet statistics output section of this command, and does not display the IGMP Global statistics section.

Devices that support continuous statistics maintain this information in a shared database and copy it to the backup Routing Engine at a configurable interval to avoid too much processing overhead on the Routing Engine. These actions preserve statistics counts across the following events or operations (which doesn’t happen for the default active subscriber statistics):

  • Routing daemon restart

  • Graceful Routing Engine switchover (GRES)

  • In-service software upgrade (ISSU)

  • Line card reboot

You can change the default interval (300 seconds) using the cont-stats-collection-interval configuration statement at the [edit routing-options multicast] hierarchy level.

You can display either the default currently active subscriber statistics or continuous subscriber statistics (if supported), but not both at the same time. Include the continuous option to display continuous statistics, otherwise the command displays the statistics only for active subscribers.

Run the clear igmp statistics command to clear the currently active subscriber statistics. On devices that support continuous statistics, run the clear command with the continuous option to clear all continuous statistics. You must run these commands separately to clear both types of statistics because the device maintains and clears the two types of statistics separately.

Note:

The show igmp statistics command runs on BNG User Planes.

Options

none

Display IGMP statistics for all interfaces. These statistics represent currently active subscribers.

brief | detail

(Optional) Display the specified level of output.

continuous

(Optional) Display continuous IGMP statistics that account for both past and current multicast group subscribers instead of the default statistics that only reflect currently active subscribers.

Required Privilege Level

view

Output Fields

Table 5 describes the output fields for the show igmp statistics command. Output fields are listed in the approximate order in which they appear.

Table 5: show igmp statistics Output Fields

Field Name

Field Description

IGMP packet statistics

Heading for IGMP packet statistics for all interfaces or for the specified interface name.

Note:

Shows currently active subscriber statistics in this section by default, or when the command includes the continuous option, shows continuous, persistent statistics that account for all IGMP control packets processed on the device.

IGMP Message type

Summary of IGMP statistics:

  • Membership Query—Number of membership queries sent and received.

  • V1 Membership Report—Number of version 1 membership reports sent and received.

  • DVMRP—Number of DVMRP messages sent or received.

  • PIM V1—Number of PIM version 1 messages sent or received.

  • Cisco Trace—Number of Cisco trace messages sent or received.

  • V2 Membership Report—Number of version 2 membership reports sent or received.

  • Group Leave—Number of group leave messages sent or received.

  • Mtrace Response—Number of Mtrace response messages sent or received.

  • Mtrace Request—Number of Mtrace request messages sent or received.

  • Domain Wide Report—Number of domain-wide reports sent or received.

  • V3 Membership Report—Number of version 3 membership reports sent or received.

  • Other Unknown types—Number of unknown message types received.

  • IGMP v3 unsupported type—Number of messages received with unknown and unsupported IGMP version 3 message types.

  • IGMP v3 source required for SSM—Number of IGMP version 3 messages received that contained no source.

  • IGMP v3 mode not applicable for SSM—Number of IGMP version 3 messages received that did not contain a mode applicable for source-specific multicast (SSM). Beginning with certain releases, this type includes records received for groups in the SSM range of addresses and in which the mode is MODE_IS_EXCLUDE or CHANGE_TO_EXCLUDE_MODE. This includes records with a non-empty source list.

Received

Number of messages received.

Sent

Number of messages sent.

Rx errors

Number of received packets that contained errors.

Max Rx rate (pps)

Maximum number of IGMP packets received during 1 second interval.

IGMP Global Statistics

Summary of IGMP statistics for all interfaces.

Note:

These statistics are not supported or displayed with the continuous option.

  • Bad Length—Number of messages received with length errors so severe that further classification could not occur.

  • Bad Checksum—Number of messages received with a bad IP checksum. No further classification was performed.

  • Bad Receive If—Number of messages received on an interface not enabled for IGMP.

  • Rx non-local—Number of messages received from senders that are not local.

  • Timed out—Number of groups that timed out as a result of not receiving an explicit leave message.

  • Rejected Report—Number of reports dropped because of the IGMP group policy.

  • Total Interfaces—Number of interfaces configured to support IGMP.

Sample Output

show igmp statistics

show igmp statistics continuous

Release Information

Statement introduced in Juniper BNG CUPS Release 22.4R1.

show mld group

Syntax

Description

Display information about Multicast Listener Discovery (MLD) group membership. This command runs on BNG User Planes.

Required Privilege Level

view

Output Fields

Table 6 describes the output fields for the show mld group command. Output fields are listed in the approximate order in which they appear.

Table 6: show mld group Output Fields

Field Name

Field Description

Interface

Name of the interface that received the MLD membership report; local means that the local router joined the group itself.

Group

Group address.

Source

Source address.

Group Mode

Mode the SSM group is operating in: Include or Exclude.

Last reported by

Address of the host that last reported membership in this group.

Source timeout

Time remaining until the group traffic is no longer forwarded. The timer is refreshed when a listener in include mode sends a report. A group in exclude mode or configured as a static group displays a zero timer.

Timeout

Time remaining until the group membership is removed.

Group timeout

Time remaining until a group in exclude mode moves to include mode. The timer is refreshed when a listener in exclude mode sends a report. A group in include mode or configured as a static group displays a zero timer.

Type

Type of group membership:

  • Dynamic—Host reported the membership.

  • Static—Membership is configured.

Sample Output

show mld group

Release Information

Statement introduced in Juniper BNG CUPS Release 22.4R1.

show mld interface

Syntax

Description

Displays information about multipoint Listener Discovery (MLD)-enabled interfaces.

Options

none

When you run this command on the BNG CUPS Controller, the output displays standard information about all MLD-enabled interfaces on all BNG User Planes associated to the BNG CUPS Controller.

When you run this command on a BNG User Plane, the output displays standard information about all MLD-enabled interfaces on the BNG User Plane.

user-plane user-plane-name

(Optional) Displays information about the MLD-enabled interfaces on the specified BNG User Plane.

Required Privilege Level

view

Output Fields

Table 7 describes the output fields for the show mld interface command. Output fields are listed in the approximate order in which they appear.

Table 7: show mld interface Output Fields

Field Name

Field Description

Interface

Name of the interface.

Querier

Address of the router that has been elected to send membership queries.

State

State of the interface: Up or Down.

Timeout

How long until the MLD querier is declared to be unreachable, in seconds.

Version

MLD version being used on the interface: 1 or 2.

Groups

Number of groups on the interface.

Passive

State of the passive mode option:

  • On—Indicates that the router can run IGMP or MLD on the interface but not send or receive control traffic such as IGMP or MLD reports, queries, and leaves.

  • Off—Indicates that the router can run IGMP or MLD on the interface and send or receive control traffic such as IGMP or MLD reports, queries, and leaves.

The passive statement enables you to selectively activate up to two out of a possible three available query or control traffic options. When enabled, the following options appear after the on state declaration:

  • send-general-query—The interface sends general queries.

  • send-group-query—The interface sends group-specific and group-source-specific queries.

  • allow-receive—The interface receives control traffic

Group threshold

Configured threshold at which a warning message is generated.

This threshold is based on a percentage of groups received on the interface. If the number of groups received reaches the configured threshold, the device generates a warning message.

Group log-interval

Time (in seconds) between consecutive log messages.

Immediate Leave

State of the immediate leave option:

  • On—Indicates that the router removes a host from the multicast group as soon as the router receives a multicast listener done message from a host associated with the interface.

  • Off—Indicates that after receiving a multicast listener done message, instead of removing a host from the multicast group immediately, the router sends a group query to determine if another receiver responds.

Distributed

State of MLD, which, by default, takes place on the Routing Engine for MX Series routers but can be distributed to the Packet Forwarding Engine to provide faster processing of join and leave events.

  • On—distributed MLD is enabled.

Promiscuous Mode

State of the promiscuous mode option:

  • On—Indicates that the router can accept MLD reports from subnetworks that are not associated with its interfaces.

  • Off—Indicates that the router can accept MLD reports only from subnetworks that are associated with its interfaces.

User plane The BNG User Plane to which the interface belongs.

Configured Parameters

Information configured by the user.

  • MLD Query Interval (.1 secs)—Interval at which this router sends membership queries when it is the querier.

  • MLD Query Response Interval (.1 secs)—Time that the router waits for a report in response to a general query.

  • MLD Last Member Query Interval (.1 secs)—Time that the router waits for a report in response to a group-specific query.

  • MLD Robustness Count—Number of times the router retries a query.

Derived Parameters

Derived information.

  • MLD Membership Timeout (.1 secs)—Timeout period for group membership. If no report is received for these groups before the timeout expires, the group membership will be removed.

  • MLD Other Querier Present Timeout (.1 secs)—Time that the router waits for the IGMP querier to send a query.

Sample Output

show mld interface

Release Information

Statement introduced in Juniper BNG CUPS Release 22.4R1.

show mld statistics

Syntax

Description

Display information about Multicast Listener Discovery (MLD) statistics.

By default, Junos OS multicast devices collect statistics of received and transmitted MLD control messages that reflect currently active multicast group subscribers.

Some devices also automatically maintain continuous MLD statistics globally on the device in addition to the default active subscriber statistics—these are persistent, continuous statistics of received and transmitted MLD control packets that account for both past and current multicast group subscriptions processed on the device. With continuous statistics, you can see the total count of MLD control packets the device processed since the last device reboot or clear mld statistics continuous command. The device collects and displays continuous statistics only for the fields shown in the MLD packet statistics... output section of this command, and does not display the MLD Global statistics section.

Devices that support continuous statistics maintain this information in a shared database and copy it to the backup Routing Engine at a configurable interval to avoid too much processing overhead on the Routing Engine. These actions preserve statistics counts across the following events or operations (which doesn’t happen for the default active subscriber statistics):

  • Routing daemon restart

  • Graceful Routing Engine switchover (GRES)

  • In-service software upgrade (ISSU)

  • Line card reboot

You can change the default interval (300 seconds) using the cont-stats-collection-interval configuration statement at the [edit routing-options multicast] hierarchy level.

You can display either the default currently active subscriber statistics or continuous subscriber statistics (if supported), but not both at the same time. Include the continuous option to display continuous statistics, otherwise the command displays the statistics only for currently active subscribers.

Run the clear mld statistics command to clear the currently active subscriber statistics. On devices that support continuous statistics, run the clear command with the continuous option to clear all continuous statistics. You must run these commands separately to clear both types of statistics because the device maintains and clears the two types of statistics separately.

Note:

The show mld statistics command runs on BNG User Planes.

Options

none

Display MLD statistics for all interfaces. These statistics represent currently active subscribers.

continuous

(Optional) Display continuous MLD statistics that account for both past and current multicast group subscribers instead of the default statistics that only reflect currently active subscribers. This option is not available with the interface option for interface-specific statistics.

Required Privilege Level

view

Output Fields

Table 8 describes the output fields for the show mld statistics command. Output fields are listed in the approximate order in which they appear.

Table 8: show mld statistics Output Fields

Field Name

Field Description

MLD Packet Statistics...

Heading for MLD packet statistics for all interfaces or for the specified interface name.

Note:

Shows currently active subscriber statistics in this section by default, or when the command includes the continuous option, shows continuous, persistent statistics that account for all MLD control packets processed on the device.

Received

Number of received packets.

Sent

Number of transmitted packets.

Rx errors

Number of received packets that contained errors.

MLD Message type

Summary of MLD statistics.

  • Listener Query (v1/v2)—Number of membership queries sent and received.

  • Listener Report (v1)—Number of version 1 membership reports sent and received.

  • Listener Done (v1/v2)—Number of Listener Done messages sent and received.

  • Listener Report (v2)—Number of version 2 membership reports sent and received.

  • Other Unknown types—Number of unknown message types received.

  • MLD v2 source required for SSM—Number of MLD version 2 messages received that contained no source.

  • MLD v2 mode not applicable for SSM—Number of MLD version 2 messages received that did not contain a mode applicable for source-specific multicast (SSM).

MLD Global Statistics

Summary of MLD statistics for all interfaces.

Note:

These statistics are not supported or displayed with the continuous option.

  • Bad Length—Number of messages received with length errors so severe that further classification could not occur.

  • Bad Checksum—Number of messages received with an invalid IP checksum. No further classification was performed.

  • Bad Receive If—Number of messages received on an interface not enabled for MLD.

  • Rx non-local—Number of messages received from nonlocal senders.

  • Timed out—Number of groups that timed out as a result of not receiving an explicit leave message.

  • Rejected Report—Number of reports dropped because of the MLD group policy.

  • Total Interfaces—Number of interfaces configured to support IGMP.

Sample Output

show mld statistics

show mld statistics continuous

Release Information

Statement introduced in Juniper BNG CUPS Release 22.4R1.

show network-access address-assignment address-pool-manager status

Syntax

Description

Displays the status of Juniper Address Pool Manager (APM).

Required Privilege Level

root

Output Fields

Table 9 lists the output fields for the show network-access address-assignment address-pool-manager status command. Output fields are listed in alphabetical order.

Table 9: show network-access address-assignment address-pool-manager status Output Fields

Field Name

Field Description

Address Pool Manager IP address for APM
Status Connection status of APM
Pool Count Number of pools
Connect Timestamp Time at which APM first connected to BNG CUPS Controller
Security Connection status: secured or not secured

Sample Output

show network-access address-assignment address-pool-manager status

show network-access address-assignment domain

Syntax

Description

Displays the state of each pool domain (dynamic linked address pool) connected to APM and a count of the transmitted alarms for a specified routing instance.

Options

name domain-name | domain-profile (Optional) Displays information depending on which of the following variables are entered:
  • Empty—A summary of all domains for the routing instance that is entered.

  • domain-name—Displays the pool structure of the pool domain.

  • domain-profile—Displays the domains that were created from the domain profile.

routing-instance routing-instance-name (Optional) Designate the routing instance to use. If left empty, the default routing instance is used.

Required Privilege Level

root

Output Fields

Table 10 lists the output fields for the show network-access address-assignment domain command. Output fields are listed in alphabetical order.

Table 10: show network-access address-assignment domain Output Fields

Field Name

Field Description

Domain Name Name of the pool domain.
Head Name of the domain’s pool head.
Pool Count Number of pools.
Addresses Total number of addresses in the pool domain.
Free Number of addresses in the pool domain that are available for allocation.
Apportion The number of apportion alarms. The alarm occurs when the number of free addresses falls below the apportion threshold.
Reclaim The number of reclaim alarms. The alarm occurs when the number of free addresses for the pool domain on the BNG CUPS Controller rises above the reclaim threshold.
Abatement The number of abatement alarms. An the alarm occurs when either of the following conditions changes, causing APM to disregard the original alarm:
  • The number of free addresses rises above the reclaim threshold.

  • The number of free addresses falls below the apportion threshold.

Pool Drain The number of pool drain alarms. The alarm occurs when a pool is completely drained.
Pool Name Name of the pool.
Prefix Subnetwork allocated to the address pool.
Used

The number of addresses being used.

State State of the pool domain.

Sample Output

show network-access address-assignment domain

show network-access address-assignment domain name (using domain profile)

show network-access address-assignment domain name

show network-access address-assignment domain-state

Syntax

Description

Displays the alarm state (outstanding alarms) for each pool domain.

Options

routing-instance routing-instance-name (Optional) Designate the routing instance to use. If left empty, the default routing instance is used.

Required Privilege Level

root

Output Fields

Table 11 lists the output fields for the show network-access address-assignment domain-state command. Output fields are listed in alphabetical order.

Table 11: show network-access address-assignment domain-state Output Fields

Field Name

Field Description

Domain Name Name of the pool domain.
Alarm Name of the alarm.
  • reclaim—When the number of free addresses for the pool domain on BNG CUPS Controller rises above the reclaim threshold.

  • apportion—When the number of free addresses falls below the apportion threshold.

  • pool-drained—When a pool is completely drained.

  • abatement—BNG CUPS Controller sends an abatement alarm when either of the following conditions changes, causing APM to disregard the original alarm.

    • The number of free addresses rises above the reclaim threshold.

    • The number of free addresses falls below the apportion threshold.

Age How long an alarm has been outstanding.
Logins Whether logins are enabled.
State State of the pool domain.

Sample Output

show network-access address-assignment domain

show network-access address-assignment domain name (using domain profile)

show network-access address-assignment domain name

show system subscriber-management control-plane

Syntax

Description

Displays statistics for the specified option. This command runs on the BNG CUPS Controller.

Options

associations (Optional) Displays information about the BNG User Planes that are associated to the BNG CUPS Controller.
bbe-instances (Optional) Displays the dynamically created instances of the BBE Infrastructure daemon. There is one for each BNG User Plane.
cpm (Optional) Displays information about the control plane manager process.
services (Optional) Displays the health of services and the endpoints they manage. See show system subscriber-management control-plane services.
user-plane (Optional) Displays information about the associated BNG User Plane.

Required Privilege Level

root

Output Fields

Table 12 lists the output fields for the show system subscriber-management control-plane command.

Table 12: show system subscriber-management control-plane Output Fields

Field Name

Field Description

Transport The IP address, protocol, and port number of the BNG CUPS Controller.
Attached clients The number of clients attached to the BNG CUPS Controller.
UP Events The number of associations, disassociations, and association updates that have occurred with all associated BNG User Planes.
BBE Instance Events: The number of times that the BBE instance was created, deleted, or restarted.
UP Name Name of the BNG User Plane that the BNG CUPS Controller is associated with.
ID ID of the BNG User Planes that the BNG CUPS Controller is associated with.
Address BNG User Plane IP address.
Assoc Time The amount of time that the BNG CUPS Controller is associated to the listed BNG User Plane.
Assoc-updates The number of times that an association has been updated.
Client-name The name of the BNG CUPS Controller that is associated to the BNG User Plane.
Status Displays whether the BNG CUPS Controller is attached to or detached from the client.
State Displays either the health of the service or the status of the BNG User Plane's connection.
Last Heartbeat Time The time when the client's last heartbeat was recorded.
PID The process identifier number.
UP-Id The BNG User Plane's ID number.
CPRi Ports The CPRi ports used by the BBE instance.
UPTIME How long the the BBE instance is up.
Flapped How many times the service went from down to up.

Sample Output

show system subscriber-management control-plane cpm

show system subscriber-management control-plane associations

show system subscriber-management control-plane bbe-instances

show system subscriber-management control-plane user-plane

show system subscriber-management control-plane user-plane endpoint (specific endpoint of a BNG User Plane)

show system subscriber-management control-plane services

Syntax

Description

Displays the health of services and the endpoints they manage. Using the information in this command, you can determine the overall health of the BNG CUPS Controller and the BNG User Planes. This command runs on the BNG CUPS Controller.

Note:

Services are also referred to as endpoint clients.

Options

services all | service-name Specify one of the following:
  • all—Lists information for all services.

  • service-name—Lists information for the designated service.

Required Privilege Level

root

Output Fields

Table 13 lists the output fields for the show system subscriber-management control-plane services command.

Table 13: show system subscriber-management control-plane services Output Fields

Field Name

Field Description

Services

The service for which information is being reported.

Status

Whether the service is up or down.

State

Operational state of the service. All services should be in the Ready state.

Endpoints

The total number of connections the endpoint's service hosts.

Healthy Endpoints

The total number of healthy endpoints.

Restarted

Number of times the service has been restarted.

Last cupm msg rx

Last message received from the control plane manager or the user plane manager.

Last cupm msg tx

Last message sent to the control plane manager or the user plane manager.

Last updated

When the information was last collected.

Flapped

How many times the service went from down to up.

Sample Output

show system subscriber-management control-plane services

show system subscriber-management control-plane services service

show system subscriber-management control-plane services service

show system subscriber-management load-balancing group

Syntax

Description

Displays information for the load-balancing groups.

Options

Empty

If you do not enter a load-balancing group name, all load-balancing groups are listed.

group group-name

(Optional) Displays information about the listed load-balancing group.

Required Privilege Level

root

Output Fields

Table 15 lists the output fields for the show system subscriber-management load-balancing group command.

Table 14: show system subscriber-management load-balancing group Output Fields

Field Name

Field Description

Group Name

The name of the load-balancing group.

UP Name

The name of the BNG User Plane with which the load-balancing group is associated.

Logical-Port

BNG User Plane logical port.

Usage

The logical port's current load, represented as a percentage.

Computed weight

Current computed weight.

Max weight

Configured maximum weight.

Sample Output

show system subscriber-management load-balancing group

show system subscriber-management user-plane

Syntax

Description

Displays statistics for the specified option. This command runs on the BNG User Plane.

Options

associations

(Optional) Displays the BNG CUPS Controller that is associated to the BNG User Plane.

clients

(Optional) Displays information about each client that interacts with the user plane manager.

control-plane

(Optional) Displays information about the associated BNG CUPS Controller.

services

(Optional) Displays information about the BNG User Plane services.

upm

(Optional) Displays summary information about the user plan manager.

Required Privilege Level

root

Output Fields

Table 15 lists the output fields for the show system subscriber-management user-plane command.

Table 15: show system subscriber-management user-plane Output Fields

Field Name

Field Description

User-plane name

The name of the BNG User Plane.

Control-plane

The name, IP address, port, and protocol of the BNG CUPS Controller with which the BNG User Plane is associated.

Attached clients

The number of clients attached to the BNG User Plane.

CP Events

The number of associations, disassociations, and association updates that have occurred to the associated BNG CUPS Controller.

CP Name

Name of the BNG CUPS Controller with which the BNG User Plane is associated.

Address

IP address of the BNG CUPS Controller that the BNG User Plane is associated with.

Assoc Time

The time at which the BNG User Plane started its association with the BNG CUPS Controller.

Assoc-updates

The number of times the association has been updated.

Client-name

Name of the BNG User Plane client.

Status

  • When referring to a client, displays whether the BNG User Plane is attached to the client.

  • When referring to a service, displays whether the service is up.

Last Heartbeat Time

The time when the client's last heartbeat was recorded.

Services

The service for which information is being reported.

State

Health state of the BNG User Plane. If the state is not Healthy, new subscribers will not come up on the BNG User Plane.

Endpoints

The total number of endpoints associated with the service.

Healthy Endpoints

The number of healthy endpoints.

Sample Output

show system subscriber-management user-plane upm

show system subscriber-management user-plane associations

show system subscriber-management user-plane clients

show system subscriber-management user-plane services

show system subscriber-management user-plane control-plane endpoints

Syntax

Description

Displays the status of endpoints for BNG User Planes. You use this command to track the health of the BNG User Planes by using the health of all endpoints for the BNG User Planes. This command runs on the BNG User Plane.

Options

None

Lists the state and flapped count for all endpoints.

control-plane control-plane-name

The BNG CUPS Controller with which the BNG User Planes are associated.

endpoint

Specify one of the following:

  • all—Lists information for all endpoints.

  • endpoint-name—Lists information for the designated endpoint.

Required Privilege Level

root

Output Fields

Table 16 lists the output fields for the show system subscriber-management user-plane control-plane endpoint command.

Table 16: show system subscriber-management user-plane control-plane endpoint Output Fields

Field Name

Field Description

UP id

The BNG User Plane's ID number.

Ip Address

The BNG CUPS Controller's IP address.

Endpoints

The endpoints associated with the BNG User Plane.

Flapped

How many times the service went from down to up.

State

The state of the service, either connected or disconnected.

Status

Indicates if the BNG CUPS Controller and BNG User Plane are connected.

Security

Indicates if security is enabled.

Last updated

The time since the information was last collected.

Heartbeat failure

Number of heartbeat failures.

Invalid packets

Number of invalid Packet Forwarding Control Protocol messages received.

HeartbeatResp

Number of Packet Forwarding Control Protocol heartbeat response messages received.
AssociationSetupRespAck Number of successful Packet Forwarding Control Protocol association setup response messages received.

Transmit errors

Number of Packet Forwarding Control Protocol messages that failed to send.

Max Retranmissions

The total number of Packet Forwarding Control Protocol request messages that were retransmitted the maximum number of times.

Retranmissions

Number of retransmitted Packet Forwarding Control Protocol messages.

HeartbeatReq

Number of Packet Forwarding Control Protocol heartbeat request messages sent.

AssociationSetupReq

Number of Packet Forwarding Control Protocol association setup request messages sent.
Pkts count Number of packets received.
Pkts dropped Number of received packet that were dropped.
Pkts client rx Number of received client packets, such as dhcp, dhcpv6,or ppp.
Pkts terminated locally Number of received packets that terminated locally, such as echo packets for heartbeat keepalive.
Pkts aggr rx Total of both client packets plus locally terminated packets received.
Client packets up to cp Number of client packets sent from the BNG User Plane to the BNG CUPS Controller, such as dhcp, dhcpv6, or ppp.
Aggr packets up to cp Total of both locally injected packets plus client packets sent from the BNG User Plane to the BNG CUPS Controller.
Aggr packets up to cp fail Total of both locally injected packets plus client packets that failed when sent from the BNG User Plane to the BNG CUPS Controller.
Pkts injected locally to cp Number of locally injected packets sent from the BNG User Plane to the BNG CUPS Controller, such as echo packets for heartbeat keepalives.
Pkts fwd to kernel Number of packets forwarded to the Packet Forwarding Engine.
Pkts fwd to kernel fail Number of failed packets forwarded to the Packet Forwarding Engine.
Last local seq num tx The last local echo packet sequence number sent.
Last local seq num rx The last local echo packet sequence number received.
Last remote seq num rx The last remote echo packet sequence number received.
Total local echo pkts rx The total number of local echo packets transmitted.
Total remote echo pkts rx The total number of remote echo packets received.
Num of echo pkts lost Number of missing or lost echo packets.
Chain Length Number of nodes in a statesync chain.
Unique Id Unique identifier assigned to each unique object in the statesync chain.
Sequence No. Sequence number assigned to each statesync node.

Sample Output

show system subscriber-management user-plane control-plane endpoint (all)

show system subscriber-management user-plane control-plane endpoint

show system subscriber-management user-plane control-plane

show system subscriber-management placement-cluster

Syntax

Description

Shows the BNG User Plane's steering cluster information for all clusters or specific clusters.

Options

cluster cluster-name (Optional) Displays the BNG User Plane steering for the specified cluster. If a cluster name is not specified, then all clusters are displayed.
service-group service-group-name (Optional) Displays the service group. If a service group name is not specified, then all service groups are displayed.

Required Privilege Level

root

Output Fields

Table 17 lists the output fields for the show subscriber-management placement-cluster command. Output fields are listed in alphabetical order.

Table 17: show system subscriber-management placement-cluster Output Fields

Field Name

Field Description

Cluster

The name of the cluster that services the access node where the subscriber's services are terminated

Service-group

The name of the service group

UP Name

The name of the BNG User Plane

UP Id

The BNG User Plane identifier

Sample Output

show system subscriber-management placement-cluster cluster (All)

show system subscriber-management placement-cluster cluster

show system subscriber-management placement-cluster service-group

show system subscriber-management placement-cluster service-group

show user-plane subscribers

Syntax

Description

Displays information for BNG User Plane subscribers.

Options

None

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

all

(Optional) Displays summary information by state, client type, and LS:RI.

detail | extensive | terse

(Optional) Displays the specified level of output.

count

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

id session-id

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

interface

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

mac-address

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

physical-address-name

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

pic

(Optional) Displays a count of subscribers by PIC number and total number of subscribers.

port

(Optional) Displays a count of subscribers by port number and total number of subscribers.

routing-instance

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

slot

(Optional) Displays a count of subscribers by Flexible PIC Concentrator (FPC) slot number and total number of subscribers.

stacked-vlan-id

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

summary

(Optional) Displays summary information for subscribers.

vlan-id

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

Required Privilege Level

view

Output Fields

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

Table 18: show user-plane subscribers Output Fields

Field Name

Field Description

Interface

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

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

IP Address/VLAN ID

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

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

LS:RI

Logical system and routing instance associated with the subscriber.

Type

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

IP Address

Subscriber IPv4 address.

Logical System

Logical system associated with the subscriber.

Routing Instance

Routing instance associated with the subscriber.

Interface

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

Interface Type

Whether the subscriber interface is Static or Dynamic.

Underlying Interface

Name of the underlying interface for the subscriber session.

MAC Address

MAC address associated with the subscriber.

State

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

PFE Flow ID

Forwarding flow identifier.

VLAN ID

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

Session ID

ID number for a subscriber session.

Service Sessions

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

Service Session ID

ID number for a subscriber service session.

Service Session Name

Service session profile name.

IPv4 Input Filter Name

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

IPv4 Output Filter Name

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

Service Activation Time

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

Accounting Interval Service

How often statistics are collected for the accounting profile.

Dynamic Configuration

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

Subscribers by State

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

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

  • Configured—Number of configured subscribers.

  • Active—Number of active subscribers.

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

  • Terminated—Number of terminated subscribers.

  • Total—Total number of subscribers for all states.

Subscribers by Client Type

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

Subscribers by LS:RI

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

Sample Output

show user-plane subscribers

show user-plane subscribers (DHCP)

show user-plane subscribers count

show user-plane subscribers detail

show user-plane subscribers detail (DHCP)

show user-plane subscribers extensive

show user-plane subscribers id

show user-plane subscribers interface

show user-plane subscribers routing-instance

show user-plane subscribers vlan-id

show user-plane subscribers summary

show user-plane subscribers summary slot

show user-plane subscribers stacked-vlan-id

show user-plane subscribers terse

request network-access aaa address-assignment domain-profile

Syntax

Description

Enable or disable logins for existing domains created from the domain profile and to control the creation of new domains from the domain profile.

Options

ri-name routing-instance-name

Specify the routing instance name.

profile-name profile-name

Specify the name of the profile.

[enable-login | disable-login]

Specify the desired action.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback only if an error occurs.

request network-access aaa address-assignment user-plane

Syntax

Description

Enable or disable logins for subscribers originating from the specified BNG User Plane. When you use this command, you effectively enable or disable logins for existing domains associated with the BNG User Plane. You also control the creation of new domains for the BNG User Plane.

Options

user-plane user-plane-name Specify the BNG User Plane name.
[enable-login | disable-login] Specify the desired action.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback only if an error occurs.

restart bbe-cpm-daemon

Syntax

Description

Restarts the Control Plane Manager daemon.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request. This command runs on the BNG CUPS Controller.

Sample Output

restart bbe-cpm-daemon

restart bbe-stats-daemon

Syntax

Description

Restarts the Enhanced Session Management Statistics daemon.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request. This command runs on the BNG CUPS Controller.

Sample Output

restart bbe-stats-daemon

restart bbe-stats-svcsd

Syntax

Description

Restarts the Statistics Services daemon.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request. This command runs on the BNG User Planes.

Sample Output

restart bbe-stats-svcsd

restart bbe-upm-daemon

Syntax

Description

Restarts the User Plane Manager daemon. This command runs on the BNG CUPS Controller.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart bbe-upm-daemon

restart bbe-upsf-daemon

Syntax

Description

Restarts the User Plane Selection Function daemon. This command runs on the BNG CUPS Controller.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart bbe-upsf-daemon

restart cp-smg-server

Syntax

Description

Restarts the Enhanced Session Management BNG CUPS Controller process. This command runs on the BNG CUPS Controller.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart cp-smg-server

restart replication-client-process

Syntax

Description

Restarts the Replication Client Process. A BNG User Plane hosts the Replication Client Process daemon and the Replication Server Process daemon. These daemons replicate the state between the BNG CUPS Controller and the BNG User Plane and the routing engines. This command runs on the BNG CUPS Controller.

Avoid using this command unless Juniper Networks Technical Assistance Center (JTAC) directs you to use it.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart replication-client-process

restart replication-server-process

Syntax

Description

Restarts the Replication Server Process. A BNG User Plane hosts the Replication Client Process daemon and the Replication Server Process daemon. These daemons replicate the state between the BNG CUPS Controller and the BNG User Plane and the routing engines. This command runs on the BNG CUPS Controller.

Avoid using this command unless Juniper Networks Technical Assistance Center (JTAC) directs you to use it.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart replication-server-process

restart up-helper-service

Syntax

Description

Restarts the Enhanced BBE Helper BNG User Plane process. This command runs on the BNG User Plane.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart up-helper-service

restart up-smg-server

Syntax

Description

Restarts the Enhanced Session Management BNG User Plane process. This command runs on the BNG CUPS Controller.

Options

This command does not have any options.

Required Privilege Level

root

Output Fields

When you enter this command, you receive feedback on the status of your request.

Sample Output

restart up-smg-server