- play_arrow Overview
- play_arrow Juniper BNG CUPS CLI Configuration Statements
- play_arrow Juniper BNG CUPS CLI Operational Statements
- play_arrow Junos OS CLI Configuration Statements
- Firewall Filter Match Conditions for IPv4 Traffic
- Firewall Filter Match Conditions for IPv6 Traffic
- Firewall Filter Nonterminating Actions
- Firewall Filter Terminating Actions
- aaa-options (Access Profile)
- access-profile-name (Duplicate Accounting)
- accounting-profile
- accounting (Access Profile)
- action
- address
- address-assignment (Address-Assignment Pools)
- adf (Dynamic Firewalls)
- adjustment-control-profiles
- aggregate
- ancp (Adjustment Control Profiles)
- application (Adjustment Control Profiles)
- auto-configure (Demux)
- auto-configure
- bandwidth-limit (Hierarchical Policer)
- bandwidth-limit (Policer)
- bandwidth-percent
- burst-size-limit (Hierarchical Policer)
- captive-portal-content-delivery (Captive Portal Content Delivery)
- classifiers (CoS)
- chassis (Subscriber Limits)
- client-type (Subscriber Limits)
- color-aware
- color-blind
- committed-burst-size
- committed-information-rate
- destination-profile
- device-count (Pseudowire Subscriber Interfaces)
- drop-profiles
- dynamic-profiles
- dynamic-profile (Demux)
- dynamic-profile (DHCP Local Server)
- dynamic-profile (DHCP Relay Agent)
- dynamic-profile (Domain Map)
- dynamic-profile (Dynamic PPPoE)
- dynamic-profile (Stacked VLAN)
- dynamic-profile (Static Subscribers)
- dynamic-profile (VLAN)
- dynamic-profile-options
- dhcp-local-server
- dhcp-relay
- dhcp-service
- dhcp-tags (Adjustment Control Profiles)
- excess-burst-size
- fail-filter (Dynamic Profiles)
- family (Dynamic Firewalls)
- family (Firewall Filter)
- firewall (Dynamic Firewalls)
- filter (Dynamic Profiles Filter Attachment)
- filter (Dynamic Profiles Filter Creation)
- filter (Firewall Filters)
- filter-specific
- fpc (Subscriber Limits)
- from
- group-profile (Access)
- hierarchical-policer
- high-threshold (Resource Monitor)
- if-exceeding (Hierarchical Policer)
- input (Dynamic Service Sets)
- interfaces (Static and Dynamic Subscribers)
- interface-set (Dynamic Profiles)
- interface-shared
- interface-specific (Firewall Filters)
- logical-bandwidth-policer
- logical-interface-fpc-redundancy
- logical-interface-policer
- loss-priority (Firewall Filter)
- loss-priority high then discard (Three-Color Policer)
- map (Domain Map)
- minimum-links (Interfaces)
- no-load-throttle (Resource Monitor)
- no-throttle (Resource Monitor)
- output (Dynamic Service Sets)
- packet-burst (Hierarchical Policer)
- packet-burst (Policer)
- peak-burst-size
- peak-information-rate
- physical-interface-policer
- pic (Subscriber Limits)
- policer (Configuring)
- policy-options (Dynamic Profiles)
- port (Subscriber Limits)
- ppp (Group Profile)
- ppp (Profile)
- ppp-over-ether
- ppp-options
- ppp-options (Dynamic PPP)
- ppp-options (L2TP)
- pppoe-tags (Adjustment Control Profiles)
- pppoe-underlying-options (Static and Dynamic Subscribers)
- pps-limit (Hierarchical Policer)
- pps-limit (Policer)
- prefix-list
- premium (Hierarchical Policer)
- pseudowire-service (Pseudowire Subscriber Interfaces)
- radius-coa (Adjustment Control Profiles)
- rebalance-periodic
- rebalance-subscriber-granularity
- redundancy-group (Chassis - MX Series)
- redundancy-group (Redundant Tunnel)
- resource-monitor
- retry (RADIUS Server)
- rewrite-rules (CoS)
- routing-instances
- routing-instances (Dynamic Profiles)
- secret (RADIUS Server)
- service (Dynamic Service Sets)
- service-filter (Dynamic Service Sets)
- service-interface (Services Interfaces)
- service-set (Dynamic Service Sets)
- service-set-options
- services (Captive Portal Content Delivery)
- shared-bandwidth-policer (Configuring)
- shared-name
- shmlog (Shared Memory Log)
- schedulers (CoS)
- scheduler-maps (For Most Interface Types)
- single-rate
- smg-service (Enhanced Subscriber Management)
- stacked-vlan-ranges
- statistics (Access Profile)
- subscriber (Access Profile)
- subscribers-limit (Resource Monitor)
- targeted-distribution
- targeted-distribution (Dynamic Demux Interfaces over Aggregated Ethernet)
- targeted-distribution (Static Interfaces over Aggregated Ethernet)
- targeted-options
- targeted-options (PS Interface)
- term (Captive Portal Content Delivery)
- term (Dynamic Profiles)
- term (Firewall Filter)
- terminate-code
- then (Captive Portal Content Delivery)
- then (Policer Action)
- three-color-policer (Applying)
- three-color-policer (Configuring)
- timeout (RADIUS Server)
- traceoptions (Protocols PPP Service)
- traceoptions (Resource Monitor)
- traffic-control-profiles
- two-rate
- update-interval
- variables (Dynamic Service Profiles)
- play_arrow Junos OS CLI Operational Commands
- clear dhcp relay binding
- clear dhcp relay lockout-entries
- clear dhcp relay statistics
- clear dhcp server binding
- clear dhcp server lockout-entries
- clear dhcp server statistics
- clear dhcpv6 relay binding
- clear dhcpv6 relay lockout-entries
- clear dhcpv6 relay statistics
- clear dhcpv6 server binding
- clear dhcpv6 server lockout-entries
- clear dhcpv6 server statistics
- clear network-access aaa statistics
- clear network-access aaa subscriber
- clear pppoe lockout
- clear pppoe lockout vlan-identifier
- clear pppoe statistics
- clear services l2tp destination
- clear services l2tp destination lockout
- clear services l2tp session
- clear services l2tp session statistics
- clear services l2tp tunnel
- clear services l2tp tunnel statistics
- clear system subscriber-management statistics
- request dhcp server reconfigure
- request dhcpv6 server reconfigure
- request interface rebalance
- request network-access aaa accounting
- request network-access aaa replay pending-accounting-stops
- request network-access aaa subscriber modify session-id
- request network-access aaa subscriber set session-id
- show accounting pending-accounting-stops
- show class-of-service classifier
- show class-of-service drop-profile
- show class-of-service interface
- show class-of-service interface-set
- show class-of-service rewrite-rule
- show class-of-service traffic-control-profile
- show dhcp relay binding
- show dhcp relay lockout-entries
- show dhcp relay statistics
- show dhcp server binding
- show dhcp server lockout-entries
- show dhcp server statistics
- show dhcpv6 relay binding
- show dhcpv6 relay lockout-entries
- show dhcpv6 relay statistics
- show dhcpv6 server binding
- show dhcpv6 server lockout-entries
- show dhcpv6 server statistics
- show dynamic-profile session
- show interfaces extensive demux0
- show interfaces interface-set
- show interfaces targeting
- show interfaces terse
- show network-access aaa accounting
- show network-access aaa radius-servers
- show network-access aaa statistics
- show network-access aaa statistics authentication
- show network-access aaa statistics pending-accounting-stops
- show network-access aaa statistics preauthentication
- show network-access aaa statistics re-authentication
- show network-access aaa terminate-code
- show network-access aaa subscribers
- show network-access aaa subscribers session-id
- show ppp interface
- show ppp address-pool
- show ppp statistics
- show ppp summary
- show services captive-portal-content-delivery
- show services l2tp client
- show services l2tp destination
- show services l2tp destination lockout
- show services l2tp session
- show services l2tp session-limit-group
- show services l2tp summary
- show services l2tp tunnel
- show services l2tp tunnel-group
- show services l2tp tunnel-switch destination
- show services l2tp tunnel-switch session
- show services l2tp tunnel-switch summary
- show services l2tp tunnel-switch tunnel
- show system license (View)
- show system resource-monitor fpc
- show system resource-monitor subscribers-limit
- show system resource-monitor-summary
- show system subscriber-management resiliency
- test aaa authd-lite user
- test aaa dhcp user
- test aaa ppp user
How to Use the Juniper BNG CUPS Controller Utility Commands
SUMMARY After you have installed Juniper BNG CUPS Controller (BNG CUPS Controller), you can perform numerous administrative functions.
Access Juniper BNG CUPS Controller Utility Commands
You can use the BNG CUPS Controller utility script (dbng
) to administer
the application and to access the CLI that you use for configuring operations. The BNG
CUPS Controller installation places the utility script in
/usr/local/bin.
The dbng
utility script performs the tasks you need to do to manage BNG
CUPS but masks the complexity of the kubectl
command.
This masking of the kubectl
commands simplifies your administrative
duties.
The dbng
utility script uses the Kubernetes kubectl
utility commands to do the following:
- Create and delete objects.
- Conduct interactive sessions with pod containers.
- Display the status of the BNG CUPS Controller objects.
Table 1
lists the commands that you can invoke with the dbng
utility script and
describes the action that each command initiates.
Command Name | Action |
---|---|
| Clean up unneeded releases and Docker cache. To run this command, you need sudo root privileges. This command offers the following options:
|
| Gives you access to the CLI that you can use to configure BNG CUPS Controller features. This command offers the following options:
|
| Displays the available contexts for control with BNG CUPS Controller. This command offers the following options:
|
| Deploys a new control plane instance (CPi) pod. To run this command, you need sudo root privileges. This command offers the following options:
|
| Removes a control plane instance (CPi) pod. To run this command, you need sudo root privileges. This command offers the following options:
|
| Displays the IP addresses of every service with an external IP address. This command offers the following options:
|
| Links a cluster to a specific software version. To run this command, you need sudo root privileges. This command offers the following options:
|
| Renames a context. Does not effect the currently running BNG CUPS Controller on the cluster. To run this command, you need sudo root privileges. This command offers the following options:
|
| Restarts a specific BNG CUPS Controller service. To run
this command, you need sudo root privileges. This command offers the following options:
|
| Upgrade a BNG CUPS Controller service. To run this command, you need sudo root privileges. This command offers the following options:
|
| Sets up the BNG CUPS Controller application as part of the installation process. To run this command, you need sudo root privileges. This command offers the following options:
|
| Connects you to a running microservice. This command offers the following options:
|
| Starts a specific BNG CUPS Controller service. To run this command, you need sudo root privileges. This command offers the following option:
|
| Displays the current status of the BNG CUPS Controller services. This command offers the following options:
|
| Stop all BNG CUPS Controller services. To run this command, you need sudo root privileges. This command offers the following option:
|
| Provides the status of the storage drivers for BNG CUPS Controller. This command offers the following options:
|
| Unlink components associated with the context. To run this command, you need sudo root privileges. This command offers the following options:
|
| Displays the version of the following:
This command offers the following options:
|
Use the following general syntax to issue a command:
For a short option:
content_copy zoom_out_map$ dbng command-name -option
For a long option:
content_copy zoom_out_map$ dbng command-name ––option
To display a list of available commands with a brief description, use either the
h
or help
option:
$ dbng -h
$ dbng --help
To display the options for a specific command:
$ dbng command-name -h
Start or Stop BNG CUPS Controller Services
Use the dbng
utility script to start or stop all BNG CUPS Controller
services.
To start all BNG CUPS Controller services:
content_copy zoom_out_map$ sudo -E dbng rollout --context context-name
To stop all BNG CUPS Controller services:
content_copy zoom_out_map$ sudo -E dbng stop --context context-name
Check the Status of BNG CUPS Controller Services
Use the dbng status
utility script to check the status of each BNG CUPS
Controller service (functional component) listed inTable 2. The status shows whether a service is running, has exited, or has not
started. It also displays the service name on the Kubernetes pod. You can compare uptime
for the services to quickly see whether any service has been restarted.
Service | Description |
---|---|
cpi-label | The BNG CUPS Controller instance service—Implements the
subscriber management control plane, which includes control plane protocols;
authentication, authorization, and accounting (AAA); and supporting
infrastructure. The label is defined by you, when you run
the |
scache | The state cache service—Provides an on-cluster backing
storage for subscriber service states generated by the cp
service. Use this service for state recovery in the event of a restart of the
cp service. |
To check the status of controller services, display the service status:
$ dbng status
For example:
user@host $ dbng status --detail --context context-name MICROSERVICE POD STATE RESTARTS UPTIME NODE scache scache-pod-7f646d56dc-w88sg Running 0 0:00:38.959603 example-1.juniper.net
Juniper BNG CUPS Logging
Juniper BNG CUPS uses the Broadband Edge (BBE) Event Collection and Visualization application for logging purposes.
BBE Event Collection and Visualization collects syslog events and records them in a time-series database. You can view the recorded events through the BBE Event Collection and Visualization Dashboard. The BBE Event Collection and Visualization Dashboard is a GUI-based visualization tool that enables you to view recorded events according to a defined filter, which can be within a specific time range. The Dashboard also provides powerful search and visualization tools through which you can correlate recoded events from multiple sources. To install BBE Event Collection and Visualization, see Broadband Edge Event Collection and Visualization Installation Guide.
Uninstall and Remove BNG CUPS Controller
Use the dbng
utility script to uninstall the BNG CUPS Controller
configuration. The unlink
command reverts the actions you performed when
setting up BNG CUPS Controller. This script returns BNG CUPS Controller to the state it
was in immediately after you installed the application but before you did any setup
configuration.
To uninstall BNG CUPS Controller:
How to Access BNG CUPS Controller Configuration and Operational Commands
- Access the BNG CUPS Controller CLI
- Access and Use CLI Configuration Statements
- Access and Use CLI Operational Commands
Access the BNG CUPS Controller CLI
You use the BNG CUPS Controller command-line interface (CLI) to configure BNG CUPS Controller and to monitor its operations. This section describes how to access the CLI.
To access the BNG CUPS Controller CLI prompt:
Access and Use CLI Configuration Statements
You use configuration statements to configure, set, manage, and monitor BNG CUPS Controller properties.
To configure BNG CUPS Controller components:
Access and Use CLI Operational Commands
You use operational commands to display the current status of Juniper BNG CUPS. You enter operational commands to monitor and to troubleshoot the BNG CUPS Controller and the BNG User Planes.
To monitor BNG CUPS Controller, view BNG CUPS Controller configuration and statistics, or run certain operations manually: