Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Juniper BNG User Plane CLI Operational Commands

This topic provides an overview of clear, request, restart, and show commands, including syntax, option descriptions, and sample output. You use these commands with Juniper BNG User Planes.

restart bbe-cpcdd-dbng

Syntax

Description

Restarts the captive portal content delivery process for the routing engine.

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-cpcdd-dbng

restart bbe-upm-daemon

Syntax

Description

Restarts the BNG User 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.

Sample Output

restart bbe-upm-daemon

restart gtp-proxy-service

Syntax

Description

Restarts the BNG User Plane's GPRS tunneling protocol (GTP) proxy service.

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 gtp-proxy-service

restart pfcp-proxy-service

Syntax

Description

Restarts the BNG User Plane's Packet Forwarding Control Protocol (PFCP) proxy service.

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 pfcp-proxy-service

restart subscriber-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 subscriber-helper-service

restart subscriber-statistics-service

Syntax

Description

Restarts the statistics service daemon for the BNG CUPS Controller. 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 subscriber-statistics-service

restart up-smg-service

Syntax

Description

Restarts the enhanced session management 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-smg-service

restart upm-service

Syntax

Description

Restarts the BNG User Plane manager. 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 upm-service

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 1 describes the output fields for the show igmp group command. Output fields are listed in the approximate order in which they appear.

Table 1: 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

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 2 describes the output fields for the show igmp statistics command. Output fields are listed in the approximate order in which they appear.

Table 2: 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

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 3 describes the output fields for the show mld group command. Output fields are listed in the approximate order in which they appear.

Table 3: 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

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 4 describes the output fields for the show mld statistics command. Output fields are listed in the approximate order in which they appear.

Table 4: 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

show system subscriber-management arp

Syntax

Description

Displays IPv4 to MAC address bindings (Address Resolution Protocol).

Options

none

Displays the entries in the ARP table.

address ip-address

(Optional) Displays information about ARP for the specified IPv4 address.

interface interface-name

(Optional) Displays information about ARP for the specified interface.

Required Privilege Level

view

Output Fields

Table 5 lists the output fields for the show system subscriber-management arp command. Output fields are listed in the approximate order in which they appear.

Table 5: show system subscriber-management arp Output Fields

Field Name

Field Description

MAC Address

Media access control (MAC) address that corresponds to the IP address.

Address

IP address that corresponds to the hostname.

Name

Host name.

interface

Interface name.

Flags

Indicates how mappings between IP and MAC addresses are defined:

  • permanent—Static mapping. The ARP entry never times out.

  • Blank.

Sample Output

show system subscriber-management arp

show system subscriber-management arp address ip-address

show system subscriber-management arp interface interface-name

show system subscriber-management ipv6-neighbors

Syntax

Description

Displays IPv6 to MAC address bindings (neighbor cache).

Options

none

Displays the entries in the IPv6 table.

address ip-address

(Optional) Display information about IPv6 for the specified IPv6 address.

interface interface-name

(Optional) Display information about IPv6 for the specified interface.

Required Privilege Level

view

Output Fields

Table 6 lists the output fields for the show system subscriber-management ipv6-neighbors command. Output fields are listed in the approximate order in which they appear.

Table 6: show system subscriber-management ipv6-neighbors Output Fields

Field Name

Field Description

IPv6 Address

The IPv6 address.

Linklayer Address

Link-layer address.

State

State of the link:

  • up

  • down

  • incomplete

  • reachable

  • stale

  • unreachable

Exp

Number of seconds until the entry expires. It will be zero for permanent entries.

Rtr

Whether the neighbor is a routing, device (yes or no).

Secure

Whether this entry was created using the Secure Neighbor Discovery (SEND) protocol.

interface

Interface name.

Sample Output

show system subscriber-management ipv6-neighbors

show system subscriber-management ipv6-neighbors address ip-address

show system subscriber-management ipv6-neighbors interface interface-name

show system subscriber-management routing-instance

Syntax

Description

Displays the state of the routing instances. The state of the routing instance can be either connected or isolated.

Options

routing-instance-name

(Optional) Displays the state of the specified routing instance.

Required Privilege Level

view

Output Fields

Table 7 lists the output fields for the show system subscriber-management routing-instance command. Output fields are listed in the approximate order in which they appear.

Table 7: show system subscriber-management routing-instance Output Fields

Field Name

Field Description

Routing Intance Name

Name of the routing instance.

State

The state of the routing instance. The state can be either connected or isolated.

Sample Output

show system subscriber-management routing-instance

show system subscriber-management routing-instance

show system subscriber-management user-plane

Syntax

Description

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

Options

associations

Displays the BNG CUPS Controller that is associated to the BNG User Plane. Lists information about the BNG CUPS Controller association including the control plane instance name, its address, state, the time the association was formed and the number of times the association was updated.

clients

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

control-plane bng-cups-controller-name endpoint endpoint-name

Options:

  • bng-cups-controller-name—Displays information about all endpoints related to the BNG CUPS Controller association.

  • endpoint endpoint-name—Displays details about a specific endpoint related to the BNG CUPS Controller association, along with its statistics.

services

Displays a list of BNG User Plane services.

Option:

  • service service-name—Displays details of the specific service.

upm Displays summary information about the user plan manager.

Required Privilege Level

root

Output Fields

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

Table 8: 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 that the BNG User Plane is associated to.

Attached clients

The number of clients attach 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 that the BNG User Plane is associated with.

Address

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

Assoc Time

The time that 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

The status of the service (either up or down).

Last Heartbeat Time

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

Services

The services that information is being reported for.

State (associations)

The state of the BNG CUPS Controller that the BNG User Plane is associated to. The state can be the following:

  • configured

  • ready

  • connected

  • disconnecting

  • connected-pause

State (control-plane control-plane-name)

The state of the endpoint CUPS Controller that the BNG User Plane is associated to. The state can be the following:

  • init

  • configured

  • ready

  • connected

  • timed out

  • disconnecting

  • disconnected

  • warminit

  • connected-pause

  • connected-switched

State (services)

The state of the BNG User Plane services. The state can be the following:

  • starting

  • initialized

  • reconciling

  • reconciled

  • ready

  • terminating

  • purging-db

  • fatal-error

State (services service sevice-name)

The state of the endpoint that is managed by the service. The state can be the following:

  • disabled

  • disconnected

  • connected

  • timed-out

  • resyncing

  • synchronized

  • reconciled

  • reconciling

  • connected(backPressureOn)

Endpoints (control-plane)

The list of endpoints related BG CUPS Controller association service.

Endpoints (services)

The number of endpoints managed by the service.

Restarted

The number of times that the service has been restarted.

Last Updated

The last time the service or endpoint state was refreshed by the system.

Healthy-Endpoints

The number of healthy endpoints.

Flapped

The number of times the endpoint has transitioned from a connected state.

Sample Output

show system subscriber-management user-plane associations

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

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

show system subscriber-management user-plane services

show system subscriber-management user-plane services service service-name

show system subscriber-management user-plane upm

show user-plane firewall filter

Syntax

Description

Displays statistics about configured firewall filters on the BNG User Plane.

Options

none

Displays statistics about configured firewall filters.

counter counter-name

(Optional) Name of a filter counter.

filter filter-name

(Optional) Displays firewall filter information for the specified configured filter.

log

(Optional) Displays log entries for firewall filters.

prefix-action-stats

(Optional) Display prefix action statistics for firewall filters.

terse

(Optional) Displays firewall filter names only.

Required Privilege Level

view

Output Fields

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

Table 9: show user-plane firewall filter Output Fields

Field Name

Field Description

Filter

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

When an interface-specific filter is displayed, the name of the filter is followed by the full interface name and by either -i for an input filter or -o for an output filter.

When dynamic filters are displayed, the name of the filter is followed by the full interface name and by either -in for an input filter or -out for an output filter. When a logical system–specific filter is displayed, the name of the filter is prefixed with two underscore (__) characters and the name of the logical system (for example, __ls1/filter1).

Counters

Display filter counter information:

  • Name—Name of a filter counter that has been configured with the counter firewall filter action.

  • Bytes—Number of bytes that match the filter term under which the counter action is specified.

  • Packets—Number of packets that matched the filter term under which the counter action is specified.

Policers

Display policer information:

  • Name—Name of policer.

  • Bytes—Number of bytes that match the filter term under which the policer action is specified. This is only the number out-of-specification (out-of-spec) byte counts, not all the bytes in all packets policed by the policer.

  • Packets—Number of packets that matched the filter term under which the policer action is specified. This is only the number of out-of-specification (out-of-spec) packet counts, not all packets policed by the policer.

Sample Output

show user-plane firewall

show user-plane firewall filter

show user-plane firewall filter filter-name counter

show user-plane firewall terse

show user-plane 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-name Display the configured filter templates for the specified BNG User Plane.

Required Privilege Level

view

Output Fields

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

Table 10: show user-plane 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 user-plane firewall templates-in-use up-name up-example-1