Juniper BNG User Plane CLI Configuration Statements
This topic provides an overview of configuration commands, including syntax and option descriptions, that you use with a Juniper router performing the role of a Juniper BNG User Plane.
A Juniper router that is performing the role of a BNG User Plane can be configured and managed like any standalone Junos OS router (see Junos CLI Reference).
Be aware that most of the configurations related to subscriber management are not applicable. This is because for Juniper BNG CUPS, subscriber management configurations are performed on the Juniper BNG CUPS Controller.
This topic focuses on configurations relevant to the following for a BNG User Plane:
-
Establishing the role of a BNG User Plane
-
Establishing communication with the BNG CUPS Controller
For any additional configurations that must be align with the configuration on the BNG CUPS Controller, see Juniper BNG CUPS Controller CLI Configuration Statements.
captive-portal-content-delivery
Syntax
captive-portal-content-delivery {
profile name
dynamic;
}
traceoptions {
file <filename> <files number> <match match> <size size> <(world-readable | no-world-readable)>;
flag name;
no-remote-trace no-remote-trace;
}
}
Hierarchy Level
[edit services]
Description
Configure the HTTP redirect service by specifying the location to which a
subscriber's initial Web browser session is redirected, enabling initial
provisioning and service selection for the subscriber. Use the statement at the
[edit services] hierarchy level for dynamic CPCD.
Options
profile
profile-name |
Configure the service profile for HTTP redirect services, also known as Captive Portal and Content Delivery (CPCD) services. The profile contains rules or rule sets that specify the details of the service. The CPCD service profile is included in a service set that applies the service to a service interface. |
dynamic |
Indicate that the service is a dynamic, converged service. |
traceoptions |
Define tracing operations for captive portal content delivery processes. |
Required Privilege Level
services—To view this statement in the configuration.
services–control—To add this statement to the configuration.
Release Information
Command introduced in Juniper BNG CUPS Release 23.1R1.
no-usage-report
Syntax
no-usage-report;
Hierarchy Level
[edit system services resource-monitor]
Description
Disable subscriber physical interface usage reporting to the BNG CUPS Controller. This command runs on the BNG User Planes.
Required Privilege Level
system—To view this statement in the configuration.
system-control—To add this statement to the configuration.
oversubscription-limit
Syntax
oversubscription-limit limit;
Hierarchy Level
[edit system services resource-monitor subscribers-limit client-type any fpc slot-number]
Description
Configure the maximum number of warm-enhanced oversubscribed subscribers on the
backup BNG User Plane. As a backup BNG User Plane, if the
oversubscription-limit is reached, the subsequent
subscribers are logged out.
The oversubscription limit cannot be configured unless the
subscriber-limit
limit is configured.
Options
| limit |
Number of oversubscription subscribers allowed (1 through 256000). |
Required Privilege Level
system—To view this statement in the configuration.
system-control—To add this statement to the configuration.
policy-options
Syntax
policy-options
policy-statement policy-name {
term term-name {
from {
family family-name;
match-conditions;
policy subroutine-policy-name;
prefix-list prefix-list-name;
prefix-list-filter prefix-list-name match-type <actions>;
route-filter destination-prefix match-type <actions>;
source-address-filter source-prefix match-type <actions>;
}
to {
match-conditions;
policy subroutine-policy-name;
}
then actions;
}
}
Hierarchy Level
[edit]
Description
Configure options such as application maps for DCBX application protocol exchange and policy statements. This command runs on the BNG User Planes.
Required Privilege Level
storage—To view this statement in the configuration.storage-control—To add this statement to the configuration.
Release Information
Statement introduced in Juniper BNG CUPS Release 22.4R1.
policy-statement
Syntax
policy-statement policy-name {
term term-name {
from {
as-path-neighbors (as-list | as-list-group);
as-path-origins (as-list | as-list-group);
as-path-transits (as-list | as-list-group);
as-path-unique-count count (equal | orhigher | orlower);
as-path-calc-length count (equal | orhigher | orlower);
family family-name;
match-conditions;
policy subroutine-policy-name;
prefix-list prefix-list-name;
prefix-list-filter prefix-list-name match-type <actions>;
programmed;
protocol protocol-name;
route-filter destination-prefix match-type <actions>;
validation-database-instance {
database <database-name> state (valid|invalid|unknown);
state (valid|invalid|unknown);
}
source-address-filter source-prefix match-type <actions>;
tag value;
traffic-engineering;
}
to {
match-conditions;
policy subroutine-policy-name;
}
then actions;
}
then {
advertise-locator;
aggregate-bandwidth;
dynamic-tunnel-attributes dynamic-tunnel-attributes;
limit-bandwidth limit-bandwidth;
multipath-resolve;
no-entropy-label-capability;
prefix-attribute-flags;
prefix-segment {
index index;
node-segment;
}
priority (high | medium | low);
resolution-map map-name;
set-down-bit
}
}
Hierarchy Level
[edit policy-options]
Description
Define a routing policy, including subroutine policies. This command runs on the BNG User Planes.
A term is a named structure in which match conditions and actions are defined. Routing policies are made up of one or more terms. Each routing policy term is identified by a term name. The name can contain letters, numbers, and hyphens (-) and can be up to 255 characters long. To include spaces in the name, enclose the entire name in double quotation marks.
Each term contains a set of match conditions and a set of actions:
-
Match conditions are criteria that a route must match before the actions can be applied. If a route matches all criteria, one or more actions are applied to the route.
-
Actions specify whether to accept or reject the route, control how a series of policies are evaluated, and manipulate the characteristics associated with a route.
Generally, a router compares a route against the match conditions of each term in
a routing policy, starting with the first and moving through the terms in the
order in which they are defined, until a match is made and an explicitly
configured or default action of accept or
reject is taken. If none of the terms in the policy match
the route, the router compares the route against the next policy, and so on,
until either an action is taken or the default policy is evaluated.
If none of the match conditions of each term evaluates to true, the final action
is executed. The final action is defined in an unnamed term. Additionally, you
can define a default action (either accept or
reject) that overrides any action intrinsic to the
protocol.
The order of match conditions in a term is not relevant, because a route must match all match conditions in a term for an action to be taken.
To list the routing policies under the [edit policy-options]
hierarchy level by
policy-statement policy-name in
alphabetical order, enter the show policy-options configuration
command.
The statements are explained separately.
Options
actions—(Optional) One or more actions to
take if the conditions match.
family family-name—(Optional) Specify an
address family protocol. Specify inet for IPv4. Specify
inet6 for 128-bit IPv6, and to enable interpretation of
IPv6 router filter addresses. For IS-IS traffic, specify iso.
For IPv4 multicast VPN traffic, specify inet-mvpn. For IPv6
multicast VPN traffic, specify inet6-mvpn. For
multicast-distribution-tree (MDT) IPv4 traffic, specify
inet-mdt. For BGP route target VPN traffic, specify
route-target. For traffic engineering, specify
traffic-engineering.
When family is not specified, the routing device or routing
instance uses the address family or families carried by BGP. If
multiprotocol BGP (MP-BGP) is enabled, the policy defaults to the protocol
family or families carried in the network layer reachability information
(NLRI) as configured in the family statement for BGP. If MP-BGP is not
enabled, the policy uses the default BGP address family unicast IPv4.
from—(Optional) Match a route based on its source address.
as-path-neighbors (as-list | as-list-group)—Compares the AS that
originated the route. Evaluates if the right most AS number on the AS path
belongs to the as-list or as-list-group
specified in the as-path-origins configuration statement. In
the case where the route has been aggregated, and the location of the
originating AS contains an AS-set, the as-path-origins operator
evaluates to true if any AS contained in the AS-set belongs to the
as-list or as-list-group specified in the
as-path-origins configuration statement.
as-path-origins (as-list | as-list-group)—Compares the neighbor
AS in the AS path. Evaluates if the first AS number on the AS path matches the
as-list or as-list-group specified in the
as-path-neighbors configuration statement. If the
neighboring AS location happens to be an AS-set, the
as-path-neighbors operator evaluates to true if any AS
contained in the AS-set belongs to the as-list or
as-list-group specified in the
as-path-neighbors configuration statement.
as-path-transits (as-list | as-list-group)—Compares any AS in
the AS-Path. Evaluates when any AS belongs to the as-list or
as-list-group specified in the
as-path-transit configuration statement. In the case of
AS-set, the as-path-transit operator compares all the ASes in
the AS-set.
as-path-calc-length count (equal | orhigher |
orlower)—(Optional) Specify a number from 0 through 1024 to filter
routes based on the number of calculated autonomous systems (ASs) in the AS
path.
-
ASs in a sequence count as 1.
-
AS sets count as 1.
-
BGP confederation segments count as 0.
as-path-unique-count count (equal | orhigher |
orlower)—(Optional) Specify a number from 0 through 1024 to filter
routes based on the total number of unique non-BGP confederation autonomous
systems (ASs) in the AS path.
Duplicate AS numbers are ignored for the count.
advertise-locator—(Optional) Enable IS-IS to summarize and
advertise locator prefixes.
Range: 0-255
aggregate-bandwidth—(Optional) Enable BGP to advertise aggregate
outbound link bandwidth for load balancing.
dynamic-tunnel-attributes
dynamic-tunnel-attributes—(Optional) Choose a
set of defined dynamic tunnel attributes for forwarding traffic over V4oV6
tunnels.
match-conditions—(Optional in
from statement; required in to statement)
One or more conditions to use to make a match. The qualifiers are described in
Routing Policy Match Conditions.
multipath-resolve
multipath-resolve–(Optional) Enable the use of all
paths for resolution over the specified prefix.
limit-bandwidth limit-bandwidth—(Optional)
Specify the limit for advertised aggregate outbound link bandwidth for load
balancing.
-
Range: 0 through 4,294,967,295 bytes
no-entropy-label-capability—(Optional) Disable the entropy label
capability advertisement at egress or transit routes specified in the
policy.
priority (high | medium | low)—(Optional) Configure the priority
for an IS-IS route to change the default order in which the routes are installed
in the routing table, in the event of a network topology change.
policy subroutine-policy-name—Use another
policy as a match condition within this policy. The name identifying the
subroutine policy can contain letters, numbers, and hyphens (-) and can be up to
255 characters long. To include spaces in the name, enclose it in quotation
marks (“ ”). Policy names cannot take the form __.*-internal__,
as this form is reserved. For information about how to configure subroutines,
see Understanding Policy Subroutines in Routing Policy Match
Conditions.
policy-name—Name that identifies the policy.
The name can contain letters, numbers, and hyphens (-) and can be up to
255 characters long. To include spaces in the name, enclose it in quotation
marks (“ ”).
prefix-list prefix-list-name—Name of a list
of IPv4 or IPv6 prefixes.
prefix-list-filter prefix-list-name—Name of a
prefix list to evaluate using qualifiers;
match-type is the type of match, and
actions is the action to take if the
prefixes match.
programmed—(Optional) Allow policy matches for routes injected
by JET APIs.
protocol protocol-name—Name of the protocol
used to control traffic engineering database import at the originating
point.
You can specify options to match label IS-IS and label OSPF routes using the
l-isis and l-ospf options, respectively.
The isis options matches all IS-IS routes, excluding labelled
IS-IS routes. The ospf option matches all OSPF routes,
including OSPFv2, OSPFv3 and labelled OSPF routes.
resolution-map—(Optional) Set resolution map modes. A given
resolution-map can be shared across multiple policy-statements.
route-filter
destination-prefix match-type
<actions>—(Optional) List of routes on
which to perform an immediate match;
destination-prefix is the IPv4 or
IPv6 route prefix to match, match-type is
the type of match (see Configuring Route Lists), and
actions is the action to take if the
destination-prefix matches.
source-address-filter
source-prefix match-type
<actions>—(Optional) Unicast source
addresses in multiprotocol BGP (MBGP) and Multicast Source Discovery Protocol
(MSDP) environments on which to perform an immediate match.
source-prefix is the IPv4 or IPv6
route prefix to match, match-type is the
type of match (see Configuring Route Lists), and
actions is the action to take if the
source-prefix matches.
tag value—(Optional) A numeric value that
identifies a route. You can tag certain routes to prioritize them over other
routes. In the event of a network topology change, Junos OS updates these routes
in the routing table before updating other routes with lower priority. You can
also tag some routes to identify and reject them based on your requirement.
term term-name—Name that identifies the term.
The term name must be unique in the policy. It can contain letters, numbers, and
hyphens (-) and can be up to 64 characters long. To include spaces in the name,
enclose the entire name in quotation marks (“ ”). A policy statement can include
multiple terms. We recommend that you name all terms. However, you do have the
option to include an unnamed term which must be the final term in the policy. To
configure an unnamed term, omit the term statement when
defining match conditions and actions.
to—(Optional) Match a route based on its destination address or
the protocols into which the route is being advertised.
then—(Optional) Actions to take on matching routes. The actions
are described in Configuring Flow Control Actions and Configuring Actions That Manipulate Route Characteristics.
set-down-bit—(Optional) Configure this option to aggregate
leaked locator routes using routing policies.
validation-database-instance—(Optional) Name to identify a
validation-state with database name.database-name
<database-name>—(Optional) Route Validation Database name to
be looked at. state (valid|invalid|unknown)—(Optional) Name to
identify a validation-state
Required Privilege Level
routing—To view this statement in the configuration.
routing-control—To add this statement to the configuration.
Release Information
Statement introduced in Juniper BNG CUPS Release 22.4R1.
query-interval
Syntax
query-interval seconds;
Hierarchy Level
[edit protocols igmp]
{edit protocols mld]Description
Specify how often the querier routing device sends general host-query messages. This command runs on the BNG User Planes.
Options
seconds—Time interval.
-
Range: 1 through 1024
-
Default: 125 seconds
Required Privilege Level
routing—To view this statement in the configuration.
routing-control—To add this statement to the configuration.
Release Information
Statement introduced in Juniper BNG CUPS Release 22.4R1.
query-last-member-interval
Syntax
query-last-member-interval seconds;
Hierarchy Level
[edit protocols igmp]
[edit protocols mld]
Description
Specify how often the querier routing device sends group-specific query messages. This command runs on the BNG User Planes.
Options
seconds—Time interval, in fractions of a second or seconds.
-
Range: 0.1 through 0.9, then in 1-second intervals 1 through 1024
-
Default: 1 second
Required Privilege Level
routing—To view this statement in the configuration.
routing-control—To add this statement to the configuration.
Release Information
Statement introduced in Juniper BNG CUPS Release 22.4R1.
query-response-interval
Syntax
query-response-interval seconds;
Hierarchy Level
[edit protocols igmp]
[edit protocols mld]
Description
Specify how long the querier routing device waits to receive a response to a host-query message from a host. This command runs on the BNG User Planes.
Options
seconds—The query response interval must be less than the query interval.
-
Range: 1 through 1024
-
Default: 10 seconds
Required Privilege Level
routing—To view this statement in the configuration.
routing-control—To add this statement to the configuration.
Release Information
Statement introduced in Juniper BNG CUPS Release 22.4R1.
robust-count
Syntax
robust-count number;
Hierarchy Level
[edit protocols igmp]
{edit protocols mld]Description
Tune the expected packet loss on a subnet. This factor is used to calculate the group member interval, other querier present interval, and last-member query count. This command runs on the BNG User Planes.
Options
number—Robustness variable.
-
Range: 2 through 10
-
Default: 2
Required Privilege Level
routing—To view this statement in the configuration.
routing-control—To add this statement to the configuration.
Release Information
Statement introduced in Juniper BNG CUPS Release 22.4R1.
routing-instance
Syntax
routing-instance routing-instance-name}
Hierarchy Level
[edit system services subscriber-management mode user-plane user-plane-name user-plane-name transport]
Description
(Optional) Designate the routing instance for the BNG User Plane to communicate with the BNG CUPS Controller. If not specified, the default routing instance is used by the BNG User Plane to communicate with the BNG CUPS Controller.
Options
routing-instance-name |
The name of the routing instance to use. |
Required Privilege Level
root—To view this statement in the configuration.
root—To add this statement to the configuration.
selection-function
Syntax
selection-function {
cluster cluster-name, cluster-name;
service-group service-group-name, service-group-name;
}
Hierarchy Level
[edit system services subscriber-management mode user-plane]
Description
Sets the clusters in which the BNG User Plane is a member. Also, you can set the service class that the BNG User Plane supports within each cluster.
Options
cluster cluster-name |
The name or names of the cluster to which the BNG User Plane belongs. You can enter one or more names. |
service-group
service-group-names |
The names of the service classes that the BNG User Plane supports within each cluster. You can enter one or more names. |
Required Privilege Level
root—To view this statement in the configuration.
root—To add this statement to the configuration.
user-plane
Syntax
user-plane {
user-plane-name bng-user-plane-name;
transport {
inet ip-address | inet6 <varname>ip-address</varname>
}
control-plane {
bng-controller-name bng-cups-controller-name;
transport {
inet ip-address | inet6 ip-address;
}
}
pfcp {
retransmission-timer seconds;
retries number;
heartbeat-interval seconds;
}
selection-function {
cluster cluster-name, cluster-name;
service-group service-group-name, service-group-name;
}Hierarchy Level
[edit system services subscriber-management enable mode]
Description
Sets the system to take on the role of a BNG User Plane.
Options
user-plane-name
bng-user-plane-name |
The user-plane-name attribute is described in the following:
|
transport (user-plane) |
The transport stanza is a mandatory stanza that defines the source address from which the BNG User Plane initiates associations.
|
bng-controller-name
bng-cups-controller-name |
The Note:
The name that is entered here for the
|
transport (control-plane) |
Defines the IPv4 or IPv6 address and port number of the BNG CUPS Controller with which the BNG User Plane attempts to make an association. The address family that you choose must match the family in the BNG User Plane's transport stanza.
|
pfcp |
Specify the Packet Forwarding Control Protocol protocol attributes for the control plane manager and any other daemons using Packet Forwarding Control Protocol to communicate with their peer.
|