router commands

configure 
router string 
aggregates 
aggregate (ipv4-prefix | ipv6-prefix) 
aggregator 
address string
as-number number
apply-groups reference
apply-groups-exclude reference
as-set boolean
blackhole 
generate-icmp boolean
community string
description string
discard-component-communities boolean
indirect (ipv4-address-no-zone | ipv6-address-no-zone)
local-preference number
policy reference
summary-only boolean
tunnel-group number
apply-groups reference
apply-groups-exclude reference
allow-bgp-to-igp-export boolean
allow-icmp-redirect boolean
allow-icmp6-redirect boolean
apply-groups reference
apply-groups-exclude reference
autonomous-system number
bfd 
seamless-bfd 
peer (ipv4-address-no-zone | ipv6-address-no-zone) 
apply-groups reference
apply-groups-exclude reference
discriminator number
bgp 
add-paths 
evpn 
receive boolean
send (number | keyword)
ipv4 
receive boolean
send (number | keyword)
ipv6 
receive boolean
send (number | keyword)
label-ipv4 
receive boolean
send (number | keyword)
label-ipv6 
receive boolean
send (number | keyword)
mcast-vpn-ipv4 
receive boolean
send number
mcast-vpn-ipv6 
receive boolean
send number
mvpn-ipv4 
receive boolean
send number
mvpn-ipv6 
receive boolean
send number
vpn-ipv4 
receive boolean
send (number | keyword)
vpn-ipv6 
receive boolean
send (number | keyword)
admin-state keyword
advertise-external 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
advertise-inactive boolean
advertise-ipv6-next-hops 
evpn boolean
ipv4 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
aggregator-id-zero boolean
apply-groups reference
apply-groups-exclude reference
asn-4-byte boolean
authentication-key string
authentication-keychain reference
backup-path 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
best-path-selection 
always-compare-med 
med-value keyword
strict-as boolean
as-path-ignore 
ipv4 boolean
ipv6 boolean
l2-vpn boolean
label-ipv4 boolean
label-ipv6 boolean
mcast-ipv4 boolean
mcast-ipv6 boolean
mvpn-ipv4 boolean
mvpn-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
compare-origin-validation-state boolean
d-path-length-ignore boolean
deterministic-med boolean
ebgp-ibgp-equal 
evpn boolean
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
ignore-nh-metric boolean
ignore-router-id 
include-internal 
mvpn-ipv4 boolean
mvpn-ipv6 boolean
origin-invalid-unusable boolean
bfd-liveness boolean
bfd-strict-mode 
advertise 
holdtime number
next-hop-reachability boolean
bgp-tunnel-metric 
prefer-aigp boolean
prefer-med boolean
value number
bgp-tunnel-preference number
block-prefix-sid boolean
client-reflect boolean
cluster 
allow-local-fallback boolean
cluster-id string
orr-location number
connect-retry number
convergence 
family keyword 
apply-groups reference
apply-groups-exclude reference
max-wait-to-advertise number
min-wait-to-advertise number
damp-peer-oscillations 
error-interval number
idle-hold-time 
initial-wait number
max-wait number
second-wait number
damping boolean
def-recv-evpn-encap keyword
default-label-preference 
ebgp number
ibgp number
default-preference 
ebgp number
ibgp number
description string
dynamic-neighbor-limit number
ebgp-default-reject-policy 
export boolean
import boolean
egress-peer-engineering 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
enforce-first-as boolean
error-handling 
legacy-mode boolean
update-fault-tolerance boolean
export 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
extended-nh-encoding 
ipv4 boolean
label-ipv4 boolean
vpn-ipv4 boolean
family 
bgp-ls boolean
evpn boolean
flow-ipv4 boolean
flow-ipv6 boolean
flow-vpn-ipv4 boolean
flow-vpn-ipv6 boolean
ipv4 boolean
ipv6 boolean
l2-vpn boolean
label-ipv4 boolean
label-ipv6 boolean
mcast-ipv4 boolean
mcast-ipv6 boolean
mcast-vpn-ipv4 boolean
mcast-vpn-ipv6 boolean
mdt-safi boolean
ms-pw boolean
mvpn-ipv4 boolean
mvpn-ipv6 boolean
route-target boolean
sr-policy-ipv4 boolean
sr-policy-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
fast-external-failover boolean
flowspec 
validate-dest-prefix boolean
validate-redirect-ip boolean
graceful-restart 
gr-notification boolean
long-lived 
advertise-stale-to-all-neighbors boolean
advertised-stale-time number
family keyword 
advertised-stale-time number
apply-groups reference
apply-groups-exclude reference
helper-override-stale-time number
forwarding-bits-set keyword
helper-override-restart-time number
helper-override-stale-time number
without-no-export boolean
restart-time number
stale-routes-time number
group string 
add-paths 
evpn 
receive boolean
send (number | keyword)
ipv4 
receive boolean
send (number | keyword)
ipv6 
receive boolean
send (number | keyword)
label-ipv4 
receive boolean
send (number | keyword)
label-ipv6 
receive boolean
send (number | keyword)
mcast-vpn-ipv4 
receive boolean
send number
mcast-vpn-ipv6 
receive boolean
send number
mvpn-ipv4 
receive boolean
send number
mvpn-ipv6 
receive boolean
send number
vpn-ipv4 
receive boolean
send (number | keyword)
vpn-ipv6 
receive boolean
send (number | keyword)
admin-state keyword
advertise-inactive boolean
advertise-ipv6-next-hops 
evpn boolean
ipv4 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
aggregator-id-zero boolean
aigp boolean
apply-groups reference
apply-groups-exclude reference
as-override boolean
asn-4-byte boolean
authentication-key string
authentication-keychain reference
bfd-liveness boolean
bfd-strict-mode 
advertise 
holdtime number
next-hop-reachability boolean
block-prefix-sid boolean
capability-negotiation boolean
client-reflect boolean
cluster 
allow-local-fallback boolean
cluster-id string
orr-location number
connect-retry number
damp-peer-oscillations 
error-interval number
idle-hold-time 
initial-wait number
max-wait number
second-wait number
damping boolean
def-recv-evpn-encap keyword
default-label-preference 
ebgp number
ibgp number
default-preference 
ebgp number
ibgp number
default-route-target boolean
description string
dynamic-neighbor 
interface string 
allowed-peer-as string
apply-groups reference
apply-groups-exclude reference
max-sessions number
match 
prefix (ipv4-prefix | ipv6-prefix) 
allowed-peer-as string
apply-groups reference
apply-groups-exclude reference
dynamic-neighbor-limit number
ebgp-default-reject-policy 
export boolean
import boolean
egress-engineering 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
egress-peer-engineering-label-unicast boolean
enforce-first-as boolean
error-handling 
update-fault-tolerance boolean
export 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
extended-nh-encoding 
ipv4 boolean
label-ipv4 boolean
vpn-ipv4 boolean
family 
bgp-ls boolean
evpn boolean
flow-ipv4 boolean
flow-ipv6 boolean
flow-vpn-ipv4 boolean
flow-vpn-ipv6 boolean
ipv4 boolean
ipv6 boolean
l2-vpn boolean
label-ipv4 boolean
label-ipv6 boolean
mcast-ipv4 boolean
mcast-ipv6 boolean
mcast-vpn-ipv4 boolean
mcast-vpn-ipv6 boolean
mdt-safi boolean
ms-pw boolean
mvpn-ipv4 boolean
mvpn-ipv6 boolean
route-target boolean
sr-policy-ipv4 boolean
sr-policy-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
fast-external-failover boolean
graceful-restart 
gr-notification boolean
long-lived 
advertise-stale-to-all-neighbors boolean
advertised-stale-time number
family keyword 
advertised-stale-time number
apply-groups reference
apply-groups-exclude reference
helper-override-stale-time number
forwarding-bits-set keyword
helper-override-restart-time number
helper-override-stale-time number
without-no-export boolean
restart-time number
stale-routes-time number
hold-time 
minimum-hold-time number
seconds number
import 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
initial-send-delay-zero boolean
keepalive number
label-preference number
link-bandwidth 
accept-from-ebgp 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
add-to-received-ebgp 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
aggregate-used-paths 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
send-to-ebgp 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
local-address (ipv4-address-no-zone | ipv6-address-no-zone | interface-name)
local-as 
as-number number
prepend-global-as boolean
private boolean
local-preference number
loop-detect keyword
loop-detect-threshold number
med-out (number | keyword)
min-route-advertisement number
monitor 
admin-state keyword
all-stations boolean
apply-groups reference
apply-groups-exclude reference
route-monitoring 
post-policy boolean
pre-policy boolean
station reference 
multihop number
multipath-eligible boolean
next-hop-self boolean
next-hop-unchanged 
evpn boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
origin-validation 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
outbound-route-filtering 
extended-community 
accept-orf boolean
send-orf 
route-target string 
passive boolean
path-mtu-discovery boolean
peer-as number
peer-ip-tracking boolean
preference number
prefix-limit keyword 
apply-groups reference
apply-groups-exclude reference
hold-excess number
idle-timeout number
log-only boolean
maximum number
post-import boolean
threshold number
remove-private 
limited boolean
replace boolean
skip-peer-as boolean
segment-routing-v6 
route-advertisement 
drop-routes-with-srv6-tlvs boolean
family keyword 
apply-groups reference
apply-groups-exclude reference
strip-srv6-tlvs boolean
selective-label-ipv4-install boolean
send-communities 
extended boolean
large boolean
standard boolean
send-default 
export-policy reference
ipv4 boolean
ipv6 boolean
split-horizon boolean
static-group boolean
tcp-mss (number | keyword)
third-party-nexthop boolean
ttl-security number
type keyword
vpn-apply-export boolean
vpn-apply-import boolean
hold-time 
minimum-hold-time number
seconds number
ibgp-multipath boolean
import 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
initial-send-delay-zero boolean
inter-as-vpn boolean
keepalive number
label-allocation 
label-ipv6 
explicit-null boolean
label-preference number
link-state-route-export boolean
link-state-route-import boolean
local-as 
as-number number
prepend-global-as boolean
private boolean
local-preference number
loop-detect keyword
loop-detect-threshold number
med-out (number | keyword)
min-route-advertisement number
monitor 
admin-state keyword
all-stations boolean
apply-groups reference
apply-groups-exclude reference
route-monitoring 
post-policy boolean
pre-policy boolean
station reference 
mp-bgp-keep boolean
multihop number
multipath 
ebgp number
family keyword 
apply-groups reference
apply-groups-exclude reference
ebgp number
ibgp number
max-paths number
restrict keyword
unequal-cost boolean
ibgp number
max-paths number
restrict keyword
unequal-cost boolean
mvpn-vrf-import-subtype-new boolean
neighbor (ipv4-address-with-zone | ipv6-address-with-zone) 
add-paths 
evpn 
receive boolean
send (number | keyword)
ipv4 
receive boolean
send (number | keyword)
ipv6 
receive boolean
send (number | keyword)
label-ipv4 
receive boolean
send (number | keyword)
label-ipv6 
receive boolean
send (number | keyword)
mcast-vpn-ipv4 
receive boolean
send number
mcast-vpn-ipv6 
receive boolean
send number
mvpn-ipv4 
receive boolean
send number
mvpn-ipv6 
receive boolean
send number
vpn-ipv4 
receive boolean
send (number | keyword)
vpn-ipv6 
receive boolean
send (number | keyword)
admin-state keyword
advertise-inactive boolean
advertise-ipv6-next-hops 
evpn boolean
ipv4 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
advertise-ldp-prefix boolean
aggregator-id-zero boolean
aigp boolean
apply-groups reference
apply-groups-exclude reference
as-override boolean
asn-4-byte boolean
authentication-key string
authentication-keychain reference
bfd-liveness boolean
bfd-strict-mode 
advertise 
holdtime number
next-hop-reachability boolean
block-prefix-sid boolean
capability-negotiation boolean
client-reflect boolean
cluster 
allow-local-fallback boolean
cluster-id string
orr-location number
connect-retry number
damp-peer-oscillations 
error-interval number
idle-hold-time 
initial-wait number
max-wait number
second-wait number
damping boolean
def-recv-evpn-encap keyword
default-label-preference 
ebgp number
ibgp number
default-preference 
ebgp number
ibgp number
default-route-target boolean
description string
ebgp-default-reject-policy 
export boolean
import boolean
egress-engineering 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
egress-peer-engineering-label-unicast boolean
enforce-first-as boolean
error-handling 
update-fault-tolerance boolean
export 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
extended-nh-encoding 
ipv4 boolean
label-ipv4 boolean
vpn-ipv4 boolean
family 
bgp-ls boolean
evpn boolean
flow-ipv4 boolean
flow-ipv6 boolean
flow-vpn-ipv4 boolean
flow-vpn-ipv6 boolean
ipv4 boolean
ipv6 boolean
l2-vpn boolean
label-ipv4 boolean
label-ipv6 boolean
mcast-ipv4 boolean
mcast-ipv6 boolean
mcast-vpn-ipv4 boolean
mcast-vpn-ipv6 boolean
mdt-safi boolean
ms-pw boolean
mvpn-ipv4 boolean
mvpn-ipv6 boolean
route-target boolean
sr-policy-ipv4 boolean
sr-policy-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
fast-external-failover boolean
graceful-restart 
gr-notification boolean
long-lived 
advertise-stale-to-all-neighbors boolean
advertised-stale-time number
family keyword 
advertised-stale-time number
apply-groups reference
apply-groups-exclude reference
helper-override-stale-time number
forwarding-bits-set keyword
helper-override-restart-time number
helper-override-stale-time number
without-no-export boolean
restart-time number
stale-routes-time number
group reference
hold-time 
minimum-hold-time number
seconds number
import 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
initial-send-delay-zero boolean
keepalive number
l2vpn-cisco-interop boolean
label-preference number
link-bandwidth 
accept-from-ebgp 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
add-to-received-ebgp 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
aggregate-used-paths 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
send-to-ebgp 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
local-address (ipv4-address-no-zone | ipv6-address-no-zone | interface-name)
local-as 
as-number number
prepend-global-as boolean
private boolean
local-preference number
loop-detect keyword
loop-detect-threshold number
med-out (number | keyword)
min-route-advertisement number
monitor 
admin-state keyword
all-stations boolean
apply-groups reference
apply-groups-exclude reference
route-monitoring 
post-policy boolean
pre-policy boolean
station reference 
multihop number
multipath-eligible boolean
next-hop-self boolean
next-hop-unchanged 
evpn boolean
label-ipv4 boolean
label-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
origin-validation 
ipv4 boolean
ipv6 boolean
label-ipv4 boolean
label-ipv6 boolean
outbound-route-filtering 
extended-community 
accept-orf boolean
send-orf 
route-target string 
passive boolean
path-mtu-discovery boolean
peer-as number
peer-creation-type keyword
peer-ip-tracking boolean
preference number
prefix-limit keyword 
apply-groups reference
apply-groups-exclude reference
hold-excess number
idle-timeout number
log-only boolean
maximum number
post-import boolean
threshold number
remove-private 
limited boolean
replace boolean
skip-peer-as boolean
segment-routing-v6 
route-advertisement 
drop-routes-with-srv6-tlvs boolean
family keyword 
apply-groups reference
apply-groups-exclude reference
strip-srv6-tlvs boolean
selective-label-ipv4-install boolean
send-communities 
extended boolean
large boolean
standard boolean
send-default 
export-policy reference
ipv4 boolean
ipv6 boolean
split-horizon boolean
tcp-mss (number | keyword)
third-party-nexthop boolean
ttl-security number
type keyword
vpn-apply-export boolean
vpn-apply-import boolean
neighbor-trust 
evpn boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
next-hop-resolution 
allow-unresolved-leaking boolean
labeled-routes 
allow-static boolean
rr-use-route-table boolean
transport-tunnel 
family keyword 
allow-flex-algo-fallback boolean
apply-groups reference
apply-groups-exclude reference
enforce-strict-tunnel-tagging boolean
resolution keyword
resolution-filter 
bgp boolean
ldp boolean
mpls-fwd-policy boolean
rib-api boolean
rsvp boolean
sr-isis boolean
sr-ospf boolean
sr-ospf3 boolean
sr-policy boolean
sr-te boolean
udp boolean
use-bgp-routes 
label-ipv6-explicit-null boolean
policy reference
shortcut-tunnel 
family keyword 
allow-flex-algo-fallback boolean
apply-groups reference
apply-groups-exclude reference
disallow-igp boolean
enforce-strict-tunnel-tagging boolean
resolution keyword
resolution-filter 
bgp boolean
ldp boolean
mpls-fwd-policy boolean
rib-api boolean
rsvp boolean
sr-isis boolean
sr-ospf boolean
sr-ospf3 boolean
sr-policy boolean
sr-te boolean
use-bgp-routes boolean
use-leaked-routes 
static boolean
vpn-family-policy reference
weighted-ecmp boolean
optimal-route-reflection 
location number 
apply-groups reference
apply-groups-exclude reference
primary-ip-address string
primary-ipv6-address string
secondary-ip-address string
secondary-ipv6-address string
tertiary-ip-address string
tertiary-ipv6-address string
spf-wait 
initial-wait number
max-wait number
second-wait number
outbound-route-filtering 
extended-community 
accept-orf boolean
send-orf 
route-target string 
override-tunnel-elc boolean
path-mtu-discovery boolean
peer-ip-tracking boolean
peer-tracking-policy reference
preference number
purge-timer number
rapid-update 
evpn boolean
l2-vpn boolean
label-ipv4 boolean
label-ipv6 boolean
mcast-vpn-ipv4 boolean
mcast-vpn-ipv6 boolean
mdt-safi boolean
mvpn-ipv4 boolean
mvpn-ipv6 boolean
vpn-ipv4 boolean
vpn-ipv6 boolean
rapid-withdrawal boolean
remove-private 
limited boolean
replace boolean
skip-peer-as boolean
rib-management 
ipv4 
leak-import 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
route-table-import 
apply-groups reference
apply-groups-exclude reference
policy-name reference
ipv6 
leak-import 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
route-table-import 
apply-groups reference
apply-groups-exclude reference
policy-name reference
label-ipv4 
leak-import 
apply-groups reference
apply-groups-exclude reference
policy (policy-expr-string | string)
route-table-import 
apply-groups reference
apply-groups-exclude reference
policy-name reference
label-ipv6 
route-table-import 
apply-groups reference
apply-groups-exclude reference
policy-name reference
route-table-install boolean
route-target-list string 
router-id string
rr-vpn-forwarding boolean
segment-routing 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
prefix-sid-range 
global 
max-index number
start-label number
segment-routing-v6 
family keyword 
add-srv6-tlvs 
locator-name reference
micro-segment-locator-name reference
apply-groups reference
apply-groups-exclude reference
ignore-received-srv6-tlvs boolean
resolution keyword
upa-trigger 
next-hop keyword
source-address string
selective-label-ip keyword
selective-label-ip-prioritization boolean
selective-label-ipv4-install boolean
send-communities 
extended boolean
large boolean
standard boolean
send-default 
export-policy reference
ipv4 boolean
ipv6 boolean
split-horizon boolean
sr-policy-import boolean
subconfed-vpn-forwarding boolean
tcp-mss number
third-party-nexthop boolean
vpn-apply-export boolean
vpn-apply-import boolean
bier 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness keyword
fast-reroute boolean
template string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
sub-domain number end number 
apply-groups reference
apply-groups-exclude reference
bfr-id number
multi-topology keyword
prefix string
class-forwarding boolean
confederation 
confed-as-num number
members number 
description string
dhcp-server 
apply-groups reference
apply-groups-exclude reference
dhcpv4 string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
description string
failover 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ignore-mclt-on-takeover boolean
maximum-client-lead-time number
partner-down-delay number
peer reference 
apply-groups reference
apply-groups-exclude reference
sync-tag string
startup-wait-time number
force-renews boolean
lease-hold 
additional-scenarios 
internal-lease-ipsec boolean
solicited-release boolean
time number
pool string 
apply-groups reference
apply-groups-exclude reference
description string
failover 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ignore-mclt-on-takeover boolean
maximum-client-lead-time number
partner-down-delay number
peer reference 
apply-groups reference
apply-groups-exclude reference
sync-tag string
startup-wait-time number
max-lease-time number
min-lease-time number
minimum-free 
absolute number
event-when-depleted boolean
percent number
nak-non-matching-subnet boolean
offer-time number
options 
option (number | keyword) 
apply-groups reference
apply-groups-exclude reference
ascii-string string
duration number
empty 
hex-string string
ipv4-address string
netbios-node-type keyword
subnet string 
address-range string end string 
apply-groups reference
apply-groups-exclude reference
failover-control-type keyword
apply-groups reference
apply-groups-exclude reference
drain boolean
exclude-addresses string end string 
maximum-declined number
minimum-free 
absolute number
event-when-depleted boolean
percent number
options 
option (number | keyword) 
apply-groups reference
apply-groups-exclude reference
ascii-string string
duration number
empty 
hex-string string
ipv4-address string
netbios-node-type keyword
pool-selection 
use-gi-address 
scope keyword
use-pool-from-client 
delimiter string
user-db reference
user-identification keyword
dhcpv6 string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
auto-provisioned boolean
defaults 
apply-groups reference
apply-groups-exclude reference
options 
option (number | keyword) 
apply-groups reference
apply-groups-exclude reference
ascii-string string
domain-string string
duration number
empty 
hex-string string
ipv6-address string
preferred-lifetime number
rebind-time number
renew-time number
valid-lifetime number
description string
failover 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ignore-mclt-on-takeover boolean
maximum-client-lead-time number
partner-down-delay number
peer reference 
apply-groups reference
apply-groups-exclude reference
sync-tag string
startup-wait-time number
ignore-rapid-commit boolean
interface-id-mapping boolean
lease-hold 
additional-scenarios 
internal-lease-ipsec boolean
solicited-release boolean
time number
lease-query boolean
pool string 
apply-groups reference
apply-groups-exclude reference
delegated-prefix 
length number
maximum number
minimum number
description string
exclude-prefix string 
failover 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ignore-mclt-on-takeover boolean
maximum-client-lead-time number
partner-down-delay number
peer reference 
apply-groups reference
apply-groups-exclude reference
sync-tag string
startup-wait-time number
options 
option (number | keyword) 
apply-groups reference
apply-groups-exclude reference
ascii-string string
domain-string string
duration number
empty 
hex-string string
ipv6-address string
prefix string 
apply-groups reference
apply-groups-exclude reference
drain boolean
failover-control-type keyword
options 
option (number | keyword) 
apply-groups reference
apply-groups-exclude reference
ascii-string string
domain-string string
duration number
empty 
hex-string string
ipv6-address string
preferred-lifetime number
prefix-length-threshold number 
absolute number
apply-groups reference
apply-groups-exclude reference
event-when-depleted boolean
percent number
prefix-type 
pd boolean
wan-host boolean
rebind-time number
renew-time number
valid-lifetime number
prefix-length-threshold number 
apply-groups reference
apply-groups-exclude reference
event-when-depleted boolean
minimum-free-percent number
pool-selection 
use-link-address 
scope keyword
use-pool-from-client 
delimiter string
server-id 
apply-groups reference
apply-groups-exclude reference
duid-enterprise 
ascii-string string
hex-string string
duid-link-local 
user-identification keyword
dns 
redirect-vprn 
service reference 
apply-groups reference
apply-groups-exclude reference
preference number
ecmp number
entropy-label boolean
fib-priority keyword
fib-telemetry boolean
firewall 
apply-groups reference
apply-groups-exclude reference
domain string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
dhcpv6-server 
name string
router-instance string
nat-group reference
prefix string 
apply-groups reference
apply-groups-exclude reference
description string
wlan-gw-group reference
flowspec 
apply-groups reference
apply-groups-exclude reference
filter-cam-type keyword
ip-filter-max-size number
ipv6-filter-max-size number
gtm 
apply-groups reference
apply-groups-exclude reference
mvpn boolean
provider-tunnel 
inclusive 
rsvp 
admin-state keyword
lsp-template reference
selective 
data-delay-interval number
data-threshold 
group-prefix (ipv4-prefix | ipv6-prefix) 
apply-groups reference
apply-groups-exclude reference
pe-threshold-add number
pe-threshold-delete number
threshold number
maximum-p2mp-spmsi number
rsvp 
admin-state keyword
lsp-template reference
gtp 
s11 
interface reference 
apn-policy reference
apply-groups reference
apply-groups-exclude reference
peer-profile-map 
prefix (ipv4-prefix | ipv6-prefix) 
apply-groups reference
apply-groups-exclude reference
peer-profile reference
upf-data-endpoint 
apply-groups reference
apply-groups-exclude reference
fpe reference
interface reference
uplink 
apn string
apply-groups reference
apply-groups-exclude reference
pdn-type keyword
peer-profile-map 
prefix (ipv4-prefix | ipv6-prefix) 
apply-groups reference
apply-groups-exclude reference
peer-profile reference
icmp-tunneling boolean
igmp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
forwarding-group-interface forwarding-service string group-interface-name reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
import-policy reference
maximum-number-group-sources number
maximum-number-groups number
maximum-number-sources number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
policy reference
query-interval number
query-last-member-interval number
query-response-interval number
query-source-address string
router-alert-check boolean
sub-hosts-only boolean
subnet-check boolean
version keyword
group-if-query-source-address string
group-interface reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
import-policy reference
maximum-number-group-sources number
maximum-number-groups number
maximum-number-sources number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
policy reference
query-interval number
query-last-member-interval number
query-response-interval number
query-source-address string
router-alert-check boolean
sub-hosts-only boolean
subnet-check boolean
version keyword
interface string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
import-policy reference
maximum-number-group-sources number
maximum-number-groups number
maximum-number-sources number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
mc-constraints 
level number 
apply-groups reference
apply-groups-exclude reference
bandwidth number
number-down number 
apply-groups reference
apply-groups-exclude reference
level number
use-lag-port-weight boolean
policy reference
query-interval number
query-last-member-interval number
query-response-interval number
redundant-mcast boolean
router-alert-check boolean
ssm-translate 
group-range start string end string 
apply-groups reference
apply-groups-exclude reference
source string 
static 
group string 
apply-groups reference
apply-groups-exclude reference
source string 
starg 
group-range start string end string step string 
apply-groups reference
apply-groups-exclude reference
source string 
starg 
subnet-check boolean
version keyword
query-interval number
query-last-member-interval number
query-response-interval number
robust-count number
ssm-translate 
group-range start string end string 
apply-groups reference
apply-groups-exclude reference
source string 
tunnel-interface 
ldp-p2mp-root reference sender-address reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
static 
group string 
apply-groups reference
apply-groups-exclude reference
source string 
starg 
rsvp-p2mp-root reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
static 
group string 
apply-groups reference
apply-groups-exclude reference
source string 
starg 
interface string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
cflowd-parameters 
sampling keyword 
apply-groups reference
apply-groups-exclude reference
direction keyword
sample-profile (keyword | number)
type keyword
cpu-protection reference
description string
dist-cpu-protection reference
egress 
filter 
ip reference
ipv6 reference
eth-cfm 
mep md-admin-name reference ma-admin-name reference mep-id number 
admin-state keyword
alarm-notification 
fng-alarm-time number
fng-reset-time number
apply-groups reference
apply-groups-exclude reference
ccm boolean
ccm-ltm-priority number
ccm-padding-size number
ccm-tlv-ignore keyword
collect-lmm-fc-stats 
fc keyword
fc-in-profile keyword
collect-lmm-stats boolean
description string
eth-test 
bit-error-threshold number
test-pattern 
crc-tlv boolean
pattern keyword
facility-fault boolean
grace 
eth-ed 
max-rx-defect-window number
priority number
rx-eth-ed boolean
tx-eth-ed boolean
eth-vsm-grace 
rx-eth-vsm-grace boolean
tx-eth-vsm-grace boolean
lbm-svc-act-responder boolean
low-priority-defect keyword
mac-address string
one-way-delay-threshold number
external-reference 
openconfig 
subinterface number
flavor keyword
gre-termination boolean
hold-time 
ipv4 
down 
init-only boolean
seconds number
up 
seconds number
ipv6 
down 
init-only boolean
seconds number
up 
seconds number
if-attribute 
admin-group reference
delay 
delay-selection keyword
dynamic 
measurement-template reference
twamp-light 
ipv4 
admin-state keyword
destination string
source string
ipv6 
admin-state keyword
destination string
source string
static number
srlg-group reference 
ingress 
destination-class-lookup boolean
filter 
ip reference
ipv6 reference
policy-accounting reference
ingress-stats boolean
ip-mtu number
ipsec 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ip-exception reference
ipsec-tunnel string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd 
bfd-designate boolean
bfd-liveness 
dest-ip string
interface string
service-name string
clear-df-bit boolean
copy-traffic-class-upon-decapsulation boolean
description string
encapsulated-ip-mtu number
icmp-generation 
frag-required 
admin-state keyword
interval number
message-count number
icmp6-generation 
packet-too-big 
admin-state keyword
interval number
message-count number
ip-mtu number
key-exchange 
dynamic 
auto-establish boolean
cert 
cert-profile reference
status-verify 
default-result keyword
primary keyword
secondary keyword
trust-anchor-profile reference
id 
fqdn string
ipv4 string
ipv6 (ipv4-address-no-zone | ipv6-address-no-zone)
ike-policy reference
ipsec-transform reference
pre-shared-key string
manual 
keys number direction keyword 
apply-groups reference
apply-groups-exclude reference
authentication-key string
encryption-key string
ipsec-transform reference
spi number
local-gateway-address-override (ipv4-address-no-zone | ipv6-address-no-zone)
max-history-key-records 
esp number
ike number
pmtu-discovery-aging number
private-sap number
private-service string
private-tcp-mss-adjust number
propagate-pmtu-v4 boolean
propagate-pmtu-v6 boolean
public-tcp-mss-adjust (number | keyword)
remote-gateway-address (ipv4-address-no-zone | ipv6-address-no-zone)
replay-window number
security-policy 
id number
strict-match boolean
ipv6-exception reference
public-sap number
tunnel-group reference
ipv4 
allow-directed-broadcasts boolean
bfd 
admin-state keyword
echo-receive number
multiplier number
receive number
transmit-interval number
type keyword
dhcp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
description string
gi-address string
option-82 
action keyword
circuit-id 
ascii-tuple 
if-name 
ifindex 
none 
port-id 
vlan-ascii-tuple 
remote-id 
ascii-string string
mac 
none 
vendor-specific-option 
client-mac-address boolean
pool-name boolean
port-id boolean
service-id boolean
string string
system-id boolean
python-policy reference
relay-plain-bootp boolean
release-include-gi-address boolean
server string
src-ip-addr keyword
trusted boolean
icmp 
mask-reply boolean
param-problem 
admin-state keyword
number number
seconds number
redirects 
admin-state keyword
number number
seconds number
ttl-expired 
admin-state keyword
number number
seconds number
unreachables 
admin-state keyword
number number
seconds number
ip-helper-address string
local-dhcp-server reference
neighbor-discovery 
learn-unsolicited boolean
limit 
log-only boolean
max-entries number
threshold number
local-proxy-arp boolean
proactive-refresh boolean
proxy-arp-policy reference
remote-proxy-arp boolean
retry-timer number
static-neighbor string 
apply-groups reference
apply-groups-exclude reference
mac-address string
static-neighbor-unnumbered 
mac-address string
timeout number
primary 
address string
apply-groups reference
apply-groups-exclude reference
broadcast keyword
gre-termination boolean
prefix-length number
track-srrp number
qos-route-lookup keyword
secondary string 
apply-groups reference
apply-groups-exclude reference
broadcast keyword
igp-inhibit boolean
prefix-length number
track-srrp number
tcp-mss number
unnumbered 
ip-address string
ip-int-name string
system 
urpf-check 
ignore-default boolean
mode keyword
vrrp number 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
backup string
bfd-liveness 
apply-groups reference
apply-groups-exclude reference
dest-ip string
interface-name string
service-name string
init-delay number
mac string
master-int-inherit boolean
message-interval number
monitor-oper-group reference
ntp-reply boolean
oper-group reference
owner boolean
passive boolean
ping-reply boolean
policy reference
preempt boolean
priority number
ssh-reply boolean
standby-forwarding boolean
telnet-reply boolean
traceroute-reply boolean
ipv6 
address string 
apply-groups reference
apply-groups-exclude reference
duplicate-address-detection boolean
eui-64 boolean
prefix-length number
primary-preference number
track-srrp number
bfd 
admin-state keyword
echo-receive number
multiplier number
receive number
transmit-interval number
type keyword
duplicate-address-detection boolean
forward-ipv4-packets boolean
icmp6 
packet-too-big 
admin-state keyword
number number
seconds number
param-problem 
admin-state keyword
number number
seconds number
redirects 
admin-state keyword
number number
seconds number
time-exceeded 
admin-state keyword
number number
seconds number
unreachables 
admin-state keyword
number number
seconds number
link-local-address 
address string
duplicate-address-detection boolean
local-dhcp-server reference
neighbor-discovery 
learn-unsolicited keyword
limit 
log-only boolean
max-entries number
threshold number
local-proxy-nd boolean
proactive-refresh keyword
proxy-nd-policy reference
reachable-time number
secure-nd 
admin-state keyword
allow-unsecured-msgs boolean
public-key-min-bits number
security-parameter number
stale-time number
static-neighbor string 
apply-groups reference
apply-groups-exclude reference
mac-address string
qos-route-lookup keyword
tcp-mss number
urpf-check 
ignore-default boolean
mode keyword
vrrp number 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
backup string
bfd-liveness 
apply-groups reference
apply-groups-exclude reference
dest-ip (ipv4-address-no-zone | ipv6-address-no-zone)
interface-name string
service-name string
init-delay number
mac string
master-int-inherit boolean
message-interval number
monitor-oper-group reference
ntp-reply boolean
oper-group reference
owner boolean
passive boolean
ping-reply boolean
policy reference
preempt boolean
priority number
standby-forwarding boolean
telnet-reply boolean
traceroute-reply boolean
lag 
link-map-profile number
per-link-hash 
class number
weight number
ldp-sync-timer 
end-of-lib boolean
seconds number
load-balancing 
flow-label-load-balancing boolean
ip-load-balancing keyword
lsr-load-balancing keyword
spi-load-balancing boolean
teid-load-balancing boolean
loopback 
mac string
mac-accounting boolean
network-domains 
network-domain reference 
port (port-and-encap | keyword)
ptp-hw-assist 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
qos 
apply-groups reference
apply-groups-exclude reference
egress-instance number
egress-port-redirect-group reference
ingress-fp-redirect-group reference
ingress-instance number
network-policy reference
strip-label boolean
tos-marking-state keyword
untrusted 
default-forwarding keyword
urpf-selected-vprns boolean
vas-if-type keyword
ipsec 
multi-chassis-shunt-interface string 
apply-groups reference
apply-groups-exclude reference
next-hop 
address (ipv4-address-no-zone | ipv6-address-no-zone)
multi-chassis-shunting-profile string 
apply-groups reference
apply-groups-exclude reference
peer reference 
apply-groups reference
apply-groups-exclude reference
multi-chassis-shunt-interface reference
security-policy number 
apply-groups reference
apply-groups-exclude reference
entry number 
apply-groups reference
apply-groups-exclude reference
local-ip 
address string
any boolean
local-ipv6 
address string
any boolean
remote-ip 
address string
any boolean
remote-ipv6 
address string
any boolean
ipv6 
neighbor-discovery 
reachable-time number
stale-time number
router-advertisement 
apply-groups reference
apply-groups-exclude reference
dns-options 
apply-groups reference
apply-groups-exclude reference
rdnss-lifetime (keyword | number)
server string
interface string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
current-hop-limit number
dns-options 
apply-groups reference
apply-groups-exclude reference
include-rdnss boolean
rdnss-lifetime (number | keyword)
server string
managed-configuration boolean
max-advertisement-interval number
min-advertisement-interval number
mtu number
nd-router-preference keyword
other-stateful-configuration boolean
prefix string 
apply-groups reference
apply-groups-exclude reference
autonomous boolean
on-link boolean
preferred-lifetime (keyword | number)
valid-lifetime (keyword | number)
reachable-time number
retransmit-time number
router-lifetime number
use-virtual-mac boolean
ipv6-te-router-id 
interface reference
isa-service-chaining 
apply-groups reference
apply-groups-exclude reference
nat-group number 
vxlan-vtep-range 
end (ipv4-address-no-zone | ipv6-address-no-zone)
start (ipv4-address-no-zone | ipv6-address-no-zone)
isis number 
admin-state keyword
advertise-passive-only boolean
advertise-router-capability keyword
advertise-tunnel-link boolean
all-l1isis string
all-l2isis string
apply-groups reference
apply-groups-exclude reference
area-address string
authentication-check boolean
authentication-key string
authentication-keychain reference
authentication-type keyword
csnp-authentication boolean
database-export 
bgp-ls-identifier 
value number
igp-identifier number
default-route-tag number
entropy-label 
override-tunnel-elc boolean
export-limit 
log-percent number
number number
export-policy reference
flexible-algorithms 
admin-state keyword
advertise-admin-group keyword
flex-algo number 
advertise reference
apply-groups reference
apply-groups-exclude reference
loopfree-alternate 
micro-loop-avoidance 
participate boolean
graceful-restart 
helper-mode boolean
hello-authentication boolean
hello-padding keyword
ignore-attached-bit boolean
ignore-lsp-errors boolean
ignore-narrow-metric boolean
igp-shortcut 
admin-state keyword
allow-sr-over-srte boolean
apply-groups reference
apply-groups-exclude reference
tunnel-next-hop 
family keyword 
apply-groups reference
apply-groups-exclude reference
resolution keyword
resolution-filter 
rsvp boolean
sr-te boolean
iid-tlv boolean
import-policy reference
interface string 
adjacency-set reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness 
ipv4 
include-bfd-tlv boolean
ipv6 
include-bfd-tlv boolean
csnp-interval number
default-instance boolean
flex-algo number 
apply-groups reference
apply-groups-exclude reference
ipv4-node-sid 
index number
label number
ipv6-node-sid 
index number
label number
hello-authentication boolean
hello-authentication-key string
hello-authentication-keychain reference
hello-authentication-type keyword
hello-padding keyword
interface-type keyword
ipv4-adjacency-sid 
label number
ipv4-multicast boolean
ipv4-node-sid 
clear-n-flag boolean
index number
label number
ipv6-adjacency-sid 
label number
ipv6-multicast boolean
ipv6-node-sid 
clear-n-flag boolean
index number
label number
ipv6-unicast boolean
level keyword 
apply-groups reference
apply-groups-exclude reference
hello-authentication-key string
hello-authentication-keychain reference
hello-authentication-type keyword
hello-interval number
hello-multiplier number
hello-padding keyword
ipv4-multicast-metric number
ipv6-multicast-metric number
ipv6-unicast-metric number
metric number
passive boolean
priority number
sd-offset number
sf-offset number
level-capability keyword
load-balancing-weight number
loopfree-alternate 
exclude boolean
policy-map 
route-nh-template reference
lsp-pacing-interval number
mesh-group 
blocked 
value number
passive boolean
retransmit-interval number
sid-protection boolean
tag number
ipv4-multicast-routing keyword
ipv4-routing boolean
ipv6-multicast-routing keyword
ipv6-routing keyword
ldp-over-rsvp boolean
ldp-sync boolean
level keyword 
advertise-router-capability boolean
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-keychain reference
authentication-type keyword
bier 
admin-state keyword
template reference
csnp-authentication boolean
database-export-exclude boolean
default-ipv4-multicast-metric number
default-ipv6-multicast-metric number
default-ipv6-unicast-metric number
default-metric number
external-preference number
hello-authentication boolean
hello-padding keyword
loopfree-alternate-exclude boolean
lsp-mtu-size number
preference number
psnp-authentication boolean
wide-metrics-only boolean
level-capability keyword
link-group string 
apply-groups reference
apply-groups-exclude reference
description string
level keyword 
apply-groups reference
apply-groups-exclude reference
ipv4-multicast-metric-offset number
ipv4-unicast-metric-offset number
ipv6-multicast-metric-offset number
ipv6-unicast-metric-offset number
member reference 
oper-members number
revert-members number
loopfree-alternate 
augment-route-table boolean
exclude 
prefix-policy reference
multi-homed-prefix 
preference keyword
remote-lfa 
max-pq-cost number
node-protect 
max-pq-nodes number
ti-lfa 
max-sr-frr-labels number
max-srv6-frr-sids number
node-protect 
lsp-lifetime number
lsp-minimum-remaining-lifetime number
lsp-mtu-size number
lsp-refresh 
half-lifetime boolean
interval number
mru-mismatch-detection boolean
multi-topology 
ipv4-multicast boolean
ipv6-multicast boolean
ipv6-unicast boolean
multicast-import 
ipv4 boolean
ipv6 boolean
overload 
max-metric boolean
overload-export-external boolean
overload-export-interlevel boolean
overload-fib-error-notify-only 
retry number
overload-include-locators boolean
overload-on-boot 
max-metric boolean
timeout number
poi-tlv boolean
prefix-attributes-tlv boolean
prefix-limit 
limit number
log-only boolean
overload-timeout (number | keyword)
warning-threshold number
prefix-unreachable 
maximum-number-upas number
process-received-upa boolean
upa-lifetime number
upa-metric number
psnp-authentication boolean
reference-bandwidth number
rib-priority 
high 
prefix-list reference
tag number
router-id string
segment-routing 
adj-sid-hold (number | keyword)
adjacency-set number 
advertise boolean
apply-groups reference
apply-groups-exclude reference
family keyword
parallel boolean
sid 
label number
adjacency-sid 
allocate-dual-sids boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
class-forwarding boolean
egress-statistics 
adj-set boolean
adj-sid boolean
node-sid boolean
entropy-label boolean
export-tunnel-table keyword
ingress-statistics 
adj-set boolean
adj-sid boolean
node-sid boolean
mapping-server 
admin-state keyword
node-sid-map number 
apply-groups reference
apply-groups-exclude reference
clear-n-flag boolean
ip-prefix string
level-capability keyword
range number
set-flags 
bit-s boolean
maximum-sid-depth 
override-bmi number
override-erld number
micro-loop-avoidance 
fib-delay number
multi-topology 
mt2 boolean
prefix-sid-range 
global 
max-index number
start-label number
srlb reference
tunnel-mtu number
tunnel-table-pref number
segment-routing-v6 
adj-sid-hold (number | keyword)
admin-state keyword
apply-groups reference
apply-groups-exclude reference
locator reference 
apply-groups reference
apply-groups-exclude reference
level keyword 
apply-groups reference
apply-groups-exclude reference
metric number
level-capability keyword
multi-topology 
mt0 boolean
mt2 boolean
tag number
micro-segment-locator reference 
apply-groups reference
apply-groups-exclude reference
level keyword 
apply-groups reference
apply-groups-exclude reference
metric number
level-capability keyword
multi-topology 
mt0 boolean
mt2 boolean
tag number
standard-multi-instance boolean
strict-adjacency-check boolean
summary-address (ipv4-prefix | ipv6-prefix) 
advertise-unreachable 
advertise-route-tag number
match-route-tag number
algorithm number
apply-groups reference
apply-groups-exclude reference
level-capability keyword
route-tag number
suppress-attached-bit boolean
system-id string
timers 
lsp-wait 
lsp-initial-wait number
lsp-max-wait number
lsp-second-wait number
spf-wait 
spf-initial-wait number
spf-max-wait number
spf-second-wait number
traffic-engineering boolean
traffic-engineering-options 
advertise-delay boolean
application-link-attributes 
legacy boolean
ipv6 boolean
unicast-import 
ipv4 boolean
ipv6 boolean
l2tp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
avp-hiding keyword
challenge boolean
destruct-timeout number
ethernet-tunnel 
reconnect-timeout (number | keyword)
exclude-avps 
calling-number boolean
initial-rx-lcp-conf-req boolean
failover 
recovery-max-session-lifetime number
recovery-method keyword
recovery-time number
track-srrp reference 
apply-groups reference
apply-groups-exclude reference
peer reference
sync-tag string
group string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
avp-hiding keyword
challenge keyword
description string
destruct-timeout number
ethernet-tunnel 
reconnect-timeout (number | keyword)
failover 
recovery-method keyword
recovery-time number
hello-interval (number | keyword)
idle-timeout (number | keyword)
l2tpv3 
cookie-length (number | keyword)
digest-type keyword
nonce-length number
password string
private-tcp-mss-adjust (number | keyword)
public-tcp-mss-adjust (number | keyword)
pw-cap-list 
ethernet boolean
ethernet-vlan boolean
rem-router-id string
track-password-change boolean
lac 
df-bit keyword
lns 
lns-group reference
load-balance-method keyword
mlppp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
endpoint 
ip (ipv4-address | keyword)
mac (mac-address | keyword)
interleave boolean
max-fragment-delay (number | keyword)
max-links number
reassembly-timeout number
short-sequence-numbers boolean
ppp 
authentication keyword
authentication-policy string
chap-challenge-length 
end number
start number
default-group-interface 
interface string
service-name string
ipcp-subnet-negotiation boolean
keepalive 
interval number
multiplier number
lcp-force-ack-accm boolean
lcp-ignore-magic-numbers boolean
mtu number
proxy-authentication boolean
proxy-lcp boolean
reject-disabled-ncp boolean
user-db string
local-address string
local-name string
max-retries-estab number
max-retries-not-estab number
password string
protocol keyword
radius-accounting-policy reference
receive-window-size number
session-assign-method keyword
session-limit (number | keyword)
tunnel string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
auto-establish boolean
avp-hiding keyword
challenge keyword
description string
destruct-timeout number
failover 
recovery-method keyword
recovery-time number
hello-interval (number | keyword)
idle-timeout (number | keyword)
l2tpv3 
private-tcp-mss-adjust (number | keyword)
public-tcp-mss-adjust (number | keyword)
lac 
df-bit keyword
lns 
lns-group reference
load-balance-method keyword
mlppp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
endpoint 
ip (ipv4-address | keyword)
mac (mac-address | keyword)
interleave keyword
max-fragment-delay number
max-links number
reassembly-timeout number
short-sequence-numbers keyword
ppp 
authentication keyword
authentication-policy string
chap-challenge-length 
end number
start number
default-group-interface 
interface string
service-name string
ipcp-subnet-negotiation keyword
keepalive 
interval number
multiplier number
lcp-force-ack-accm keyword
lcp-ignore-magic-numbers keyword
mtu number
proxy-authentication keyword
proxy-lcp keyword
reject-disabled-ncp keyword
user-db string
local-address string
local-name string
max-retries-estab number
max-retries-not-estab number
password string
peer string
preference number
radius-accounting-policy reference
receive-window-size number
remote-name string
session-limit (number | keyword)
group-session-limit number
hello-interval (number | keyword)
idle-timeout (number | keyword)
ignore-avps 
sequencing-required boolean
l2tpv3 
cookie-length number
digest-type keyword
nonce-length number
password string
private-tcp-mss-adjust number
public-tcp-mss-adjust number
transport-type 
ip boolean
lac 
calling-number-format string
cisco-nas-port 
ethernet string
df-bit boolean
local-address string
local-name string
max-retries-estab number
max-retries-not-estab number
next-attempt keyword
password string
peer-address-change-policy keyword
radius-accounting-policy reference
receive-window-size number
replace-result-code 
cdn-invalid-dst boolean
cdn-permanent-no-facilities boolean
cdn-temporary-no-facilities boolean
rtm-debounce-time (number | keyword)
session-assign-method keyword
session-limit number
tunnel-selection-blacklist 
add-tunnel-on 
address-change-timeout boolean
cdn-err-code boolean
cdn-invalid-dst boolean
cdn-permanent-no-facilities boolean
cdn-temporary-no-facilities boolean
stop-ccn-err-code boolean
stop-ccn-other boolean
tx-cdn-not-established-in-time boolean
max-list-length (number | keyword)
max-time number
timeout-action keyword
tunnel-session-limit number
ldp 
admin-state keyword
aggregate-prefix-match 
admin-state keyword
prefix-exclude reference
apply-groups reference
apply-groups-exclude reference
class-forwarding keyword
consider-system-ip-in-gep boolean
egress-statistics 
fec-prefix (ipv4-prefix | ipv6-prefix) 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
collect-stats boolean
entropy-label-capability boolean
export-policy reference
export-tunnel-table reference
fast-reroute 
backup-sr-tunnel boolean
fec-originate (ipv4-prefix | ipv6-prefix) 
advertised-label number
apply-groups reference
apply-groups-exclude reference
interface string
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
pop boolean
swap-label number
generate-basic-fec-only boolean
graceful-restart 
helper-mode boolean
maximum-recovery-time number
neighbor-liveness-time number
implicit-null-label boolean
import-mcast-policy reference
import-pmsi-routes 
mvpn boolean
mvpn-no-export-community boolean
import-policy reference
import-tunnel-table reference
interface-parameters 
interface reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness 
ipv4 boolean
ipv6 boolean
ipv4 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
fec-type-capability 
p2mp-ipv4 boolean
p2mp-ipv6 boolean
prefix-ipv4 boolean
prefix-ipv6 boolean
hello 
factor number
timeout number
keepalive 
factor number
timeout number
local-lsr-id 
interface-name reference
transport-address keyword
ipv6 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
fec-type-capability 
p2mp-ipv4 boolean
p2mp-ipv6 boolean
prefix-ipv4 boolean
prefix-ipv6 boolean
hello 
factor number
timeout number
keepalive 
factor number
timeout number
local-lsr-id 
format-32bit boolean
interface-name reference
transport-address keyword
load-balancing-weight number
ipv4 
hello 
factor number
timeout number
keepalive 
factor number
timeout number
transport-address keyword
ipv6 
hello 
factor number
timeout number
keepalive 
factor number
timeout number
transport-address keyword
label-withdrawal-delay number
ldp-shortcut 
ipv4 boolean
ipv6 boolean
legacy-ipv4-lsr-interop boolean
lsp-bfd reference 
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
bfd-template reference
failure-action keyword
lsp-ping-interval (number | keyword)
priority number
source-address (ipv4-address-no-zone | ipv6-address-no-zone)
max-ecmp-routes number
mcast-upstream-asbr-frr boolean
mcast-upstream-frr boolean
mp-mbb-time number
prefer-mcast-tunnel-in-tunnel boolean
prefer-protocol-stitching boolean
prefer-tunnel-in-tunnel boolean
resolve-root-using keyword
session-parameters 
peer (ipv4-address-no-zone | ipv6-address-no-zone) 
adv-adj-addr-only boolean
adv-local-lsr-id boolean
apply-groups reference
apply-groups-exclude reference
community string
dod-label-distribution boolean
export-addresses reference
export-prefixes reference
fec-limit 
limit number
log-only boolean
threshold number
fec-type-capability 
p2mp boolean
prefix-ipv4 boolean
prefix-ipv6 boolean
fec129-cisco-interop boolean
import-prefixes reference
pe-id-mac-flush-interop boolean
shortcut-local-ttl-propagate boolean
shortcut-transit-ttl-propagate boolean
targeted-session 
auto-rx 
ipv4 
admin-state keyword
tunneling boolean
auto-tx 
ipv4 
admin-state keyword
tunneling boolean
export-prefixes reference
import-prefixes reference
ipv4 
hello 
factor number
timeout number
hello-reduction 
admin-state keyword
factor number
keepalive 
factor number
timeout number
ipv6 
hello 
factor number
timeout number
hello-reduction 
admin-state keyword
factor number
keepalive 
factor number
timeout number
peer (ipv4-address-no-zone | ipv6-address-no-zone) 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
hello 
factor number
timeout number
hello-reduction 
admin-state keyword
factor number
keepalive 
factor number
timeout number
local-lsr-id 
format-32bit boolean
interface-name reference
mcast-tunneling 
lsp string 
tunneling 
lsp string 
peer-template string 
admin-state keyword
adv-local-lsr-id boolean
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
community string
hello 
factor number
timeout number
hello-reduction 
admin-state keyword
factor number
keepalive 
factor number
timeout number
local-lsr-id 
interface-name reference
mcast-tunneling boolean
tunneling boolean
peer-template-map reference 
apply-groups reference
apply-groups-exclude reference
policy-map reference
resolve-v6-prefix-over-shortcut boolean
sdp-auto-targeted-session boolean
tcp-session-parameters 
authentication-key string
authentication-keychain reference
peer-transport (ipv4-address-no-zone | ipv6-address-no-zone) 
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-keychain reference
path-mtu-discovery boolean
ttl-security number
tunnel-down-damp-time number
tunnel-table-pref number
weighted-ecmp boolean
leak-export 
leak-export-limit number
policy-name (policy-expr-string | string)
lsp-bfd 
bfd-sessions number
tail-end 
apply-groups reference
apply-groups-exclude reference
multiplier number
receive-interval number
transmit-interval number
mc-maximum-routes 
log-only boolean
threshold number
value number
mld 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
forwarding-group-interface forwarding-service string group-interface-name reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
import-policy reference
maximum-number-group-sources number
maximum-number-groups number
maximum-number-sources number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
policy reference
query-interval number
query-last-member-interval number
query-response-interval number
query-source-address string
router-alert-check boolean
sub-hosts-only boolean
subnet-check boolean
version keyword
group-if-query-source-address string
group-interface reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
import-policy reference
maximum-number-group-sources number
maximum-number-groups number
maximum-number-sources number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
policy reference
query-interval number
query-last-member-interval number
query-response-interval number
query-source-address string
router-alert-check boolean
sub-hosts-only boolean
subnet-check boolean
version keyword
interface string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
import-policy reference
maximum-number-group-sources number
maximum-number-groups number
maximum-number-sources number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
mc-constraints 
level number 
apply-groups reference
apply-groups-exclude reference
bandwidth number
number-down number 
apply-groups reference
apply-groups-exclude reference
level number
use-lag-port-weight boolean
policy reference
query-interval number
query-last-member-interval number
query-response-interval number
router-alert-check boolean
ssm-translate 
group-range start string end string 
apply-groups reference
apply-groups-exclude reference
source string 
static 
group string 
apply-groups reference
apply-groups-exclude reference
source string 
starg 
group-range start string end string step string 
apply-groups reference
apply-groups-exclude reference
source string 
starg 
version keyword
query-interval number
query-last-member-interval number
query-response-interval number
robust-count number
ssm-translate 
group-range start string end string 
apply-groups reference
apply-groups-exclude reference
source string 
mpls 
admin-group-frr boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
auto-bandwidth-multipliers 
adjust-multiplier number
sample-multiplier number
auto-lsp reference 
apply-groups reference
apply-groups-exclude reference
one-hop boolean
policy reference
aux-stats 
sr boolean
bypass-resignal-timer number
class-forwarding-policy string 
apply-groups reference
apply-groups-exclude reference
default-set number
fc keyword 
apply-groups reference
apply-groups-exclude reference
forwarding-set number
cspf-on-loose-hop boolean
dynamic-bypass boolean
entropy-label 
rsvp-te boolean
sr-te boolean
exponential-backoff-retry boolean
forwarding-policies 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
forwarding-policy string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
binding-label number
egress-statistics 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
ingress-statistics 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
metric number
next-hop-group number 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
backup-next-hop 
apply-groups reference
apply-groups-exclude reference
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
pushed-labels number 
apply-groups reference
apply-groups-exclude reference
label number
load-balancing-weight number
primary-next-hop 
apply-groups reference
apply-groups-exclude reference
next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
pushed-labels number 
apply-groups reference
apply-groups-exclude reference
label number
resolution-type keyword
preference number
revert-timer number
tunnel-table-pref number
reserved-label-block reference
frr-object boolean
hold-timer number
ingress-statistics 
lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) lsp-name string 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
collect-stats boolean
stat-mode keyword
p2mp-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
collect-stats boolean
max-stats number
stat-mode keyword
p2p-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
collect-stats boolean
max-stats number
stat-mode keyword
interface reference 
admin-group reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
label-map number 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
pop 
swap 
apply-groups reference
apply-groups-exclude reference
next-hop string
out-label (number | keyword)
srlg-group reference 
te-metric number
least-fill-min-thd number
least-fill-reoptim-thd number
logger-event-bundling boolean
lsp string 
adaptive boolean
admin-state keyword
admin-tag reference 
adspec boolean
apply-groups reference
apply-groups-exclude reference
auto-bandwidth 
adjust-down 
bw number
percent number
adjust-up 
bw number
percent number
apply-groups reference
apply-groups-exclude reference
fc keyword 
apply-groups reference
apply-groups-exclude reference
sampling-weight number
max-bandwidth number
min-bandwidth number
monitor-bandwidth boolean
multipliers 
adjust-multiplier number
sample-multiplier number
overflow-limit 
bw number
number number
threshold number
underflow-limit 
bw number
number number
threshold number
use-last-adj-bw 
secondary-retry-limit (number | keyword)
bfd 
bfd-liveness boolean
bfd-template reference
failure-action keyword
lsp-ping-interval (number | keyword)
return-path-label number
wait-for-up-timer number
bgp-shortcut boolean
bgp-transport-tunnel boolean
binding-sid number
class-forwarding 
forwarding-set 
policy reference
set number
class-type number
egress-statistics 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
collect-stats boolean
stat-mode keyword
entropy-label keyword
exclude-admin-group reference
exclude-node (ipv4-address-no-zone | ipv6-address-no-zone)
fallback-path-computation-method keyword
fast-reroute 
frr-method keyword
hop-limit number
node-protect boolean
propagate-admin-group boolean
from (ipv4-address-no-zone | ipv6-address-no-zone)
hop-limit number
igp-shortcut 
admin-state keyword
allow-sr-over-srte boolean
lfa-type keyword
relative-metric number
include-admin-group reference
label-stack-reduction boolean
ldp-over-rsvp boolean
least-fill boolean
load-balancing-weight number
local-sr-protection keyword
lsp-self-ping keyword
main-ct-retry-limit number
max-sr-labels 
additional-frr-labels number
label-stack-size number
metric number
metric-type keyword
override-tunnel-elc boolean
p2mp-id number
path-computation-method keyword
path-profile number 
apply-groups reference
apply-groups-exclude reference
path-group number
pce-associations 
diversity reference 
policy reference 
pce-control boolean
pce-report keyword
primary reference 
adaptive boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
backup-class-type number
bandwidth number
bfd 
bfd-liveness boolean
bfd-template reference
lsp-ping-interval (number | keyword)
return-path-label number
wait-for-up-timer number
class-type number
exclude-admin-group 
group reference
hop-limit number
include-admin-group 
group reference
priority 
hold-priority number
setup-priority number
record boolean
record-label boolean
primary-p2mp-instance string 
adaptive boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bandwidth number
exclude-admin-group 
group reference
hop-limit number
include-admin-group 
group reference
priority 
hold-priority number
setup-priority number
record boolean
record-label boolean
s2l-path reference to (ipv4-address-no-zone | ipv6-address-no-zone) 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
propagate-admin-group boolean
retry-limit number
retry-timer number
revert-timer number
rsvp-resv-style keyword
secondary reference 
adaptive boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bandwidth number
bfd 
bfd-liveness boolean
bfd-template reference
lsp-ping-interval (number | keyword)
return-path-label number
wait-for-up-timer number
class-type number
exclude-admin-group 
group reference
hop-limit number
include-admin-group 
group reference
path-preference number
priority 
hold-priority number
setup-priority number
record boolean
record-label boolean
srlg boolean
standby boolean
soft-preemption boolean
to (ipv4-address-no-zone | ipv6-address-no-zone)
type keyword
vprn-auto-bind boolean
lsp-bsid-block reference
lsp-history 
admin-state keyword
lsp-init-retry-timeout number
lsp-self-ping 
interval number
rsvp-te boolean
timeout number
timeout-action keyword
lsp-template string 
adaptive boolean
admin-state keyword
admin-tag reference 
adspec boolean
apply-groups reference
apply-groups-exclude reference
auto-bandwidth 
adjust-down 
bw number
percent number
adjust-up 
bw number
percent number
apply-groups reference
apply-groups-exclude reference
fc keyword 
apply-groups reference
apply-groups-exclude reference
sampling-weight number
max-bandwidth number
min-bandwidth number
monitor-bandwidth boolean
multipliers 
adjust-multiplier number
sample-multiplier number
overflow-limit 
bw number
number number
threshold number
underflow-limit 
bw number
number number
threshold number
backup-class-type number
bandwidth number
bfd 
bfd-liveness boolean
bfd-template reference
failure-action keyword
lsp-ping-interval (number | keyword)
return-path-label number
wait-for-up-timer number
bgp-shortcut boolean
bgp-transport-tunnel boolean
binding-sid boolean
class-forwarding 
forwarding-set 
policy reference
set number
class-type number
default-path reference
egress-statistics 
accounting-policy reference
collect-stats boolean
stat-mode keyword
entropy-label keyword
exclude-admin-group reference
fallback-path-computation-method keyword
family keyword
fast-reroute 
frr-method keyword
hop-limit number
node-protect boolean
propagate-admin-group boolean
from (ipv4-address-no-zone | ipv6-address-no-zone)
hop-limit number
igp-shortcut 
admin-state keyword
allow-sr-over-srte boolean
lfa-type keyword
relative-metric number
include-admin-group reference
label-stack-reduction boolean
ldp-over-rsvp boolean
least-fill boolean
load-balancing-weight number
local-sr-protection keyword
lsp-self-ping keyword
main-ct-retry-limit number
max-sr-labels 
additional-frr-labels number
label-stack-size number
metric number
metric-type keyword
override-tunnel-elc boolean
path-computation-method keyword
path-profile number 
apply-groups reference
apply-groups-exclude reference
path-group number
pce-associations 
diversity reference 
policy reference 
pce-control boolean
pce-report keyword
priority 
hold-priority number
setup-priority number
propagate-admin-group boolean
record boolean
record-label boolean
retry-limit number
retry-timer number
soft-preemption boolean
template-id (number | keyword)
type keyword
vprn-auto-bind boolean
max-bypass-associations number
max-bypass-plr-associations number
mbb-prefer-current-hops boolean
p2mp-resignal-timer number
p2mp-s2l-fast-retry number
p2mp-ttl-propagate boolean
p2p-active-path-fast-retry number
path string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
hop number 
apply-groups reference
apply-groups-exclude reference
ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
sid-label number
type keyword
pce-init-lsp 
apply-groups reference
apply-groups-exclude reference
sr-te 
admin-state keyword
pce-report 
rsvp-te boolean
sr-te boolean
resignal-on-igp-overload boolean
resignal-timer number
retry-on-igp-overload boolean
secondary-fast-retry-timer number
shortcut-local-ttl-propagate boolean
shortcut-transit-ttl-propagate boolean
sr-te-resignal 
resignal-on-igp-event boolean
resignal-on-igp-overload boolean
resignal-timer number
srlg-database 
router-id string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
interface string srlg-group reference 
srlg-frr keyword
static-lsp string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
metric number
push 
apply-groups reference
apply-groups-exclude reference
next-hop string
out-label (number | keyword)
to string
static-lsp-fast-retry number
strict-ero-nhop-direct-resolution boolean
tunnel-table-pref 
rsvp-te number
sr-te number
user-srlg-db boolean
mpls-labels 
apply-groups reference
apply-groups-exclude reference
bgp-labels-hold-timer number
reserved-label-block string 
apply-groups reference
apply-groups-exclude reference
end-label number
start-label number
sr-labels 
end number
start number
static-label-range number
msdp 
active-source-limit number
admin-state keyword
apply-groups reference
apply-groups-exclude reference
data-encapsulation boolean
export-policy reference
group string 
active-source-limit number
admin-state keyword
apply-groups reference
apply-groups-exclude reference
export-policy reference
import-policy reference
local-address string
mode keyword
peer string 
active-source-limit number
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
default-peer boolean
export-policy reference
import-policy reference
local-address string
receive-message-rate 
rate number
threshold number
time number
receive-message-rate 
rate number
threshold number
time number
import-policy reference
local-address string
peer string 
active-source-limit number
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
default-peer boolean
export-policy reference
import-policy reference
local-address string
receive-message-rate 
rate number
threshold number
time number
receive-message-rate 
rate number
threshold number
time number
rpf-table keyword
source string 
active-source-limit number
apply-groups reference
apply-groups-exclude reference
source-active-cache-lifetime number
mss-adjust 
apply-groups reference
apply-groups-exclude reference
nat-group number
segment-size number
mtrace2 
admin-state keyword
udp-port number
multicast-info-policy reference
nat 
apply-groups reference
apply-groups-exclude reference
inside 
l2-aware 
force-unique-ip-addresses boolean
subscribers string 
large-scale 
dnat-only 
source-prefix-list reference
dual-stack-lite 
admin-state keyword
deterministic 
prefix-map string nat-policy reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
map string to string 
apply-groups reference
apply-groups-exclude reference
first-outside-address string
endpoint string 
apply-groups reference
apply-groups-exclude reference
ip-fragmentation keyword
min-first-fragment-size-rx number
reassembly boolean
tunnel-mtu number
max-subscriber-limit number
subscriber-prefix-length number
nat-policy reference
nat44 
destination-prefix string 
apply-groups reference
apply-groups-exclude reference
nat-policy reference
deterministic 
prefix-map string nat-policy reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
map string to string 
apply-groups reference
apply-groups-exclude reference
first-outside-address string
max-subscriber-limit number
nat-import reference
source-prefix string 
apply-groups reference
apply-groups-exclude reference
nat-policy reference
nat64 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
drop-zero-ipv4-checksum boolean
insert-ipv6-fragment-header boolean
ip-fragmentation keyword
ipv6-mtu number
prefix string
subscriber-prefix-length number
tos 
downstream 
use-ipv4 boolean
upstream 
set-tos (keyword | number)
redundancy 
peer string
peer6 string
steering-route string
static-port-forwards 
spf-nat-policy reference 
subscriber-identification 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
attribute 
type keyword
vendor keyword
description string
drop-unidentified-traffic boolean
radius-proxy-server 
router-instance string
server string
traffic-identification 
source-prefix-only boolean
map 
map-domain reference 
outside 
dnat-only 
route-limit number
filters 
downstream 
ipv4 reference
ipv6 reference
upstream 
ipv4 reference
ipv6 reference
mtu number
pool string 
address-pooling keyword
address-range string end string 
apply-groups reference
apply-groups-exclude reference
description string
drain boolean
admin-state keyword
applications 
agnostic boolean
flexible-port-allocation boolean
apply-groups reference
apply-groups-exclude reference
description string
icmp-echo-reply boolean
l2-aware 
default-host 
inside-router-instance string
ip-address string
rate-limit number
external-assignment boolean
port-block-extension 
ports number
subscriber 
watermarks 
high number
low number
subscriber-limit number
watermarks 
high number
low number
large-scale 
default-host 
inside-router-instance string
ip-address string
rate-limit number
deterministic 
port-reservation number
watermarks 
high number
low number
flexible-port-allocation 
free-port-limit 
icmp number
tcp number
udp number
redundancy 
admin-state keyword
export-route string
follow 
name string
router-instance string
monitor-route string
subscriber-limit number
mode keyword
nat-group reference
port-forwarding 
dynamic-block-reservation boolean
range-end number
range-start number
port-reservation 
port-blocks number
ports number
type keyword
watermarks 
high number
low number
wlan-gw-group reference
network-domains 
network-domain string 
apply-groups reference
apply-groups-exclude reference
description string
origin-validation 
apply-groups reference
apply-groups-exclude reference
rpki-session (ipv4-address-no-zone | ipv6-address-no-zone) 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
connect-retry number
description string
local-address (ipv4-address-no-zone | ipv6-address-no-zone)
port number
refresh-time 
hold-time number
value number
stale-time number
static-entry (ipv4-prefix | ipv6-prefix) upto number origin-as number 
apply-groups reference
apply-groups-exclude reference
valid boolean
ospf number 
admin-state keyword
advertise-router-capability keyword
advertise-tunnel-link boolean
apply-groups reference
apply-groups-exclude reference
area string 
advertise-router-capability boolean
apply-groups reference
apply-groups-exclude reference
area-range string 
advertise boolean
apply-groups reference
apply-groups-exclude reference
bier 
admin-state keyword
template reference
blackhole-aggregate boolean
database-export-exclude boolean
export-policy reference
import-policy reference
interface string 
adjacency-set reference 
adjacency-sid 
label number
admin-state keyword
advertise-router-capability boolean
advertise-subnet boolean
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-keychain reference
authentication-type keyword
bfd-liveness 
remain-down-on-failure boolean
strict boolean
strict-mode-holddown number
dead-interval number
flex-algo number 
apply-groups reference
apply-groups-exclude reference
node-sid 
index number
label number
hello-interval number
interface-type keyword
load-balancing-weight number
loopfree-alternate 
exclude boolean
policy-map 
route-nh-template reference
lsa-filter-out keyword
message-digest-key number 
apply-groups reference
apply-groups-exclude reference
md5 string
metric number
mtu number
neighbor string 
node-sid 
clear-n-flag boolean
index number
label number
passive boolean
poll-interval number
priority number
retransmit-interval number
rib-priority keyword
sid-protection boolean
transit-delay number
loopfree-alternate-exclude boolean
nssa 
area-range string 
advertise boolean
apply-groups reference
apply-groups-exclude reference
originate-default-route 
adjacency-check boolean
type-nssa boolean
redistribute-external boolean
summaries boolean
stub 
default-metric number
summaries boolean
virtual-link string transit-area reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-keychain reference
authentication-type keyword
dead-interval number
hello-interval number
message-digest-key number 
apply-groups reference
apply-groups-exclude reference
md5 string
retransmit-interval number
transit-delay number
asbr 
trace-path (number | keyword)
compatible-rfc1583 boolean
database-export 
bgp-ls-identifier 
value number
igp-identifier number
entropy-label 
override-tunnel-elc boolean
export-limit 
log-percent number
number number
export-policy reference
external-db-overflow 
interval number
limit number
external-preference number
flexible-algorithms 
admin-state keyword
advertise-admin-group keyword
apply-groups reference
apply-groups-exclude reference
flex-algo number 
advertise reference
apply-groups reference
apply-groups-exclude reference
loopfree-alternate 
micro-loop-avoidance 
participate boolean
graceful-restart 
helper-mode boolean
strict-lsa-checking boolean
igp-shortcut 
admin-state keyword
allow-sr-over-srte boolean
apply-groups reference
apply-groups-exclude reference
tunnel-next-hop 
family keyword 
apply-groups reference
apply-groups-exclude reference
resolution keyword
resolution-filter 
rsvp boolean
sr-te boolean
import-policy reference
ldp-over-rsvp boolean
ldp-sync boolean
loopfree-alternate 
augment-route-table boolean
exclude 
prefix-policy reference
multi-homed-prefix 
preference keyword
remote-lfa 
max-pq-cost number
node-protect 
max-pq-nodes number
ti-lfa 
max-sr-frr-labels number
node-protect 
multi-instance boolean
multicast-import boolean
overload boolean
overload-include-ext-1 boolean
overload-include-ext-2 boolean
overload-include-stub boolean
overload-on-boot 
timeout number
preference number
reference-bandwidth number
rib-priority 
high 
prefix-list reference
router-id string
rtr-adv-lsa-limit 
log-only boolean
max-lsa-count number
overload-timeout (number | keyword)
warning-threshold number
segment-routing 
adj-sid-hold (number | keyword)
adjacency-set number 
advertise boolean
apply-groups reference
apply-groups-exclude reference
parallel boolean
sid 
label number
adjacency-sid 
allocate-dual-sids boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
backup-node-sid 
index number
ip-prefix string
label number
class-forwarding boolean
egress-statistics 
adj-set boolean
adj-sid boolean
node-sid boolean
entropy-label boolean
export-tunnel-table keyword
ingress-statistics 
adj-set boolean
adj-sid boolean
node-sid boolean
mapping-server 
admin-state keyword
node-sid-map number 
apply-groups reference
apply-groups-exclude reference
ip-prefix string
range number
scope 
area reference
as 
maximum-sid-depth 
override-bmi number
override-erld number
micro-loop-avoidance 
fib-delay number
prefix-sid-range 
global 
max-index number
start-label number
srlb reference
tunnel-mtu number
tunnel-table-pref number
timers 
incremental-spf-wait number
lsa-accumulate number
lsa-arrival number
lsa-generate 
lsa-initial-wait number
lsa-second-wait number
max-lsa-wait number
redistribute-delay number
spf-wait 
spf-initial-wait number
spf-max-wait number
spf-second-wait number
traffic-engineering boolean
traffic-engineering-options 
advertise-delay boolean
sr-te keyword
unicast-import boolean
ospf3 number 
admin-state keyword
advertise-router-capability keyword
apply-groups reference
apply-groups-exclude reference
area string 
advertise-router-capability boolean
apply-groups reference
apply-groups-exclude reference
area-range (ipv4-prefix | ipv6-prefix) 
advertise boolean
apply-groups reference
apply-groups-exclude reference
blackhole-aggregate boolean
database-export-exclude boolean
export-policy reference
extended-lsa keyword
import-policy reference
interface string 
admin-state keyword
advertise-router-capability boolean
apply-groups reference
apply-groups-exclude reference
authentication 
inbound reference
outbound reference
bfd-liveness 
remain-down-on-failure boolean
strict boolean
strict-mode-holddown number
dead-interval number
hello-interval number
interface-type keyword
load-balancing-weight number
loopfree-alternate 
exclude boolean
policy-map 
route-nh-template reference
lsa-filter-out keyword
metric number
mtu number
neighbor (ipv4-address-no-zone | ipv6-address-no-zone) 
node-sid 
clear-n-flag boolean
index number
label number
passive boolean
poll-interval number
priority number
retransmit-interval number
rib-priority keyword
sid-protection boolean
transit-delay number
key-rollover-interval number
loopfree-alternate-exclude boolean
nssa 
area-range (ipv4-prefix | ipv6-prefix) 
advertise boolean
apply-groups reference
apply-groups-exclude reference
originate-default-route 
adjacency-check boolean
type-nssa boolean
redistribute-external boolean
summaries boolean
stub 
default-metric number
summaries boolean
virtual-link string transit-area reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication 
inbound reference
outbound reference
dead-interval number
hello-interval number
retransmit-interval number
transit-delay number
asbr 
database-export 
bgp-ls-identifier 
value number
igp-identifier number
export-limit 
log-percent number
number number
export-policy reference
extended-lsa keyword
external-db-overflow 
interval number
limit number
external-preference number
graceful-restart 
helper-mode boolean
strict-lsa-checking boolean
igp-shortcut 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
tunnel-next-hop 
family keyword 
apply-groups reference
apply-groups-exclude reference
resolution keyword
resolution-filter 
rsvp boolean
sr-te boolean
import-policy reference
ldp-sync boolean
loopfree-alternate 
exclude 
prefix-policy reference
remote-lfa 
max-pq-cost number
node-protect 
max-pq-nodes number
ti-lfa 
max-sr-frr-labels number
node-protect 
multicast-import boolean
overload boolean
overload-include-ext-1 boolean
overload-include-ext-2 boolean
overload-include-stub boolean
overload-on-boot 
timeout number
preference number
reference-bandwidth number
rib-priority 
high 
prefix-list reference
router-id string
rtr-adv-lsa-limit 
log-only boolean
max-lsa-count number
overload-timeout (number | keyword)
warning-threshold number
segment-routing 
adj-sid-hold (number | keyword)
adjacency-sid 
allocate-dual-sids boolean
admin-state keyword
apply-groups reference
apply-groups-exclude reference
egress-statistics 
adj-sid boolean
node-sid boolean
ingress-statistics 
adj-sid boolean
node-sid boolean
prefix-sid-range 
global 
max-index number
start-label number
tunnel-mtu number
tunnel-table-pref number
timers 
incremental-spf-wait number
lsa-accumulate number
lsa-arrival number
lsa-generate 
lsa-initial-wait number
lsa-second-wait number
max-lsa-wait number
redistribute-delay number
spf-wait 
spf-initial-wait number
spf-max-wait number
spf-second-wait number
unicast-import boolean
p2mp-sr-tree 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness keyword
p2mp-policy string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
candidate-path string 
active-instance reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
path-instances number 
apply-groups reference
apply-groups-exclude reference
instance-id number
preference number
root-address (ipv4-address-no-zone | ipv6-address-no-zone)
tree-id number
replication-segment string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
instance-id number
root-address (ipv4-address-no-zone | ipv6-address-no-zone)
segment-routing-mpls 
downstream-nodes number 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
label 
sid-list number 
apply-groups reference
apply-groups-exclude reference
replication-sid number
next-hop-address (ipv4-address-with-zone | ipv6-address-with-zone)
next-hop-interface-name string
protect-nexthop-id reference
incoming-sid number
sid-action keyword
tree-id number
reserved-label-block reference
pcep 
apply-groups reference
apply-groups-exclude reference
pcc 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
dead-timer number
keepalive number
local-address string
local-address-ipv6 string
max-srte-pce-init-lsps number
pce-associations 
diversity string 
apply-groups reference
apply-groups-exclude reference
association-id number
association-source (ipv4-address-no-zone | ipv6-address-no-zone)
disjointness-reference boolean
disjointness-type keyword
diversity-type keyword
policy string 
apply-groups reference
apply-groups-exclude reference
association-id number
association-source (ipv4-address-no-zone | ipv6-address-no-zone)
peer (ipv4-address-no-zone | ipv6-address-no-zone) 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-keychain reference
preference number
route-preference keyword
tls-client-profile reference
tls-wait-timer number
redelegation-timer number
report-path-constraints boolean
state-timer 
timer number
timer-action keyword
unknown-message-rate number
pce 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-keychain reference
dead-timer number
keepalive number
local-address string
local-address-ipv6 string
tls-server-profile reference
tls-wait-timer number
unknown-message-rate number
pcp 
server string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
description string
dual-stack-lite-address string
fwd-inside-router string
interface reference 
policy reference
pim 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
apply-to keyword
import 
join-policy reference
register-policy reference
interface string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
assert-period number
bfd-liveness 
ipv4 boolean
ipv6 boolean
bier-signaling-type 
ipv4 boolean
ipv6 boolean
bsm-check-rtr-alert boolean
hello-interval number
hello-multiplier number
improved-assert boolean
instant-prune-echo boolean
ipv4 
apply-groups reference
apply-groups-exclude reference
monitor-oper-group 
name reference
operation keyword
priority-delta number
multicast boolean
ipv6 
apply-groups reference
apply-groups-exclude reference
monitor-oper-group 
name reference
operation keyword
priority-delta number
multicast boolean
max-groups number
mcac 
bandwidth 
mandatory (number | keyword)
total (number | keyword)
interface-policy reference
mc-constraints 
admin-state keyword
level number 
apply-groups reference
apply-groups-exclude reference
bandwidth number
number-down number 
apply-groups reference
apply-groups-exclude reference
level number
use-lag-port-weight boolean
policy reference
multicast-senders keyword
p2mp-ldp-tree-join 
ipv4 boolean
ipv6 boolean
priority number
sticky-dr 
priority number
three-way-hello boolean
tracking-support boolean
ipv4 
admin-state keyword
gtm 
auto-discovery keyword
multicast-fast-failover boolean
rpf-table keyword
source-address 
register-message string
ssm-assert-compatible-mode boolean
ssm-default-range boolean
ipv6 
admin-state keyword
multicast-fast-failover boolean
rpf-table keyword
source-address 
register-message string
ssm-default-range boolean
lag-usage-optimization boolean
mc-ecmp-balance boolean
mc-ecmp-balance-hold number
mc-ecmp-hashing 
rebalance boolean
mdt-spt boolean
non-dr-attract-traffic boolean
pim-ssm-scaling boolean
rp 
bootstrap 
export reference
import reference
ipv4 
anycast string rp-set-peer string 
auto-rp-discovery boolean
bsr-candidate 
address string
admin-state keyword
hash-mask-len number
priority number
candidate boolean
mapping-agent boolean
rp-candidate 
address string
admin-state keyword
group-range string 
holdtime number
priority number
static 
address string 
apply-groups reference
apply-groups-exclude reference
group-prefix string 
override boolean
ipv6 
anycast string rp-set-peer string 
bsr-candidate 
address string
admin-state keyword
hash-mask-len number
priority number
embedded-rp 
admin-state keyword
group-range string 
rp-candidate 
address string
admin-state keyword
group-range string 
holdtime number
priority number
static 
address string 
apply-groups reference
apply-groups-exclude reference
group-prefix string 
override boolean
rpfv 
core boolean
mvpn boolean
spt-switchover (ipv4-prefix | ipv6-prefix) 
apply-groups reference
apply-groups-exclude reference
threshold (number | keyword)
ssm-groups 
group-range (ipv4-prefix | ipv6-prefix) 
radius 
apply-groups reference
apply-groups-exclude reference
proxy string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
attribute-matching 
entry number 
accounting-server-policy string
apply-groups reference
apply-groups-exclude reference
authentication-server-policy string
prefix-string string
suffix-string string
type number
vendor (number | keyword)
cache 
admin-state keyword
key 
attribute-type number
packet-type keyword
vendor (number | keyword)
timeout number
track-accounting 
accounting-off boolean
accounting-on boolean
interim-update boolean
start boolean
stop boolean
track-authentication 
accept boolean
track-delete-hold-time number
defaults 
accounting-server-policy string
authentication-server-policy string
description string
interface string 
load-balance-key 
attribute-1 
type number
vendor (number | keyword)
attribute-2 
type number
vendor (number | keyword)
attribute-3 
type number
vendor (number | keyword)
attribute-4 
type number
vendor (number | keyword)
attribute-5 
type number
vendor (number | keyword)
source-ip-udp 
purpose keyword
python-policy reference
secret string
send-accounting-response boolean
wlan-gw 
address string
apply-groups reference
apply-groups-exclude reference
ipv6-address string
wlan-gw-group reference
server string 
accept-coa boolean
acct-port number
address (ipv4-address-no-zone | ipv6-address-no-zone)
apply-groups reference
apply-groups-exclude reference
auth-port number
description string
pending-requests-limit number
python-policy reference
secret string
reassembly 
apply-groups reference
apply-groups-exclude reference
nat-group number
to-base-network boolean
rib-api 
apply-groups reference
apply-groups-exclude reference
mpls 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
label-name reference
rip 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-type keyword
bfd-liveness boolean
check-zero boolean
description string
export-limit 
log-percent number
number number
export-policy reference
group string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-type keyword
bfd-liveness boolean
check-zero boolean
description string
export-policy reference
import-policy reference
message-size number
metric-in number
metric-out number
neighbor string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-type keyword
bfd-liveness boolean
check-zero boolean
description string
export-policy reference
import-policy reference
message-size number
metric-in number
metric-out number
preference number
receive keyword
send keyword
split-horizon boolean
timers 
flush number
timeout number
update number
unicast-address string 
preference number
receive keyword
send keyword
split-horizon boolean
timers 
flush number
timeout number
update number
import-policy reference
message-size number
metric-in number
metric-out number
preference number
receive keyword
send keyword
split-horizon boolean
timers 
flush number
timeout number
update number
ripng 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
check-zero boolean
description string
export-limit 
log-percent number
number number
export-policy reference
group string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
check-zero boolean
description string
export-policy reference
import-policy reference
message-size number
metric-in number
metric-out number
neighbor string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
check-zero boolean
description string
export-policy reference
import-policy reference
message-size number
metric-in number
metric-out number
preference number
receive keyword
send keyword
split-horizon boolean
timers 
flush number
timeout number
update number
unicast-address string 
preference number
receive keyword
send keyword
split-horizon boolean
timers 
flush number
timeout number
update number
import-policy reference
message-size number
metric-in number
metric-out number
preference number
receive keyword
send keyword
split-horizon boolean
timers 
flush number
timeout number
update number
router-id string
rsvp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-over-bypass boolean
dbw-accounting 
dbw-multiplier number
down-threshold 
bw number
percent number
sample-interval number
sample-multiplier number
up-threshold 
bw number
percent number
diffserv-te 
admission-control-model keyword
apply-groups reference
apply-groups-exclude reference
class-type-bw 
ct0 number
ct1 number
ct2 number
ct3 number
ct4 number
ct5 number
ct6 number
ct7 number
fc keyword 
apply-groups reference
apply-groups-exclude reference
class-type number
te-class number 
apply-groups reference
apply-groups-exclude reference
class-type number
priority number
entropy-label-capability boolean
graceful-restart 
max-recovery number
max-restart number
graceful-shutdown boolean
implicit-null-label boolean
include-node-id-in-rro boolean
interface reference 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
authentication-key string
authentication-keychain reference
bfd-liveness boolean
class-type-bw 
ct0 number
ct1 number
ct2 number
ct3 number
ct4 number
ct5 number
ct6 number
ct7 number
dbw-down-threshold 
bw number
percent number
dbw-multiplier number
dbw-up-threshold 
bw number
percent number
graceful-restart-helper-mode boolean
graceful-shutdown boolean
hello-interval number
implicit-null-label boolean
refresh-reduction 
reliable-delivery boolean
subscription number
te-down-threshold 
apply-groups reference
apply-groups-exclude reference
value number
te-up-threshold 
apply-groups reference
apply-groups-exclude reference
value number
keep-multiplier number
msg-pacing 
max-burst number
period number
p2mp-merge-point-abort-timer number
p2p-merge-point-abort-timer number
preemption-timer number
rapid-retransmit-time number
rapid-retry-limit number
refresh-reduction-over-bypass boolean
refresh-time number
te-down-threshold number
te-threshold-update 
on-cac-failure boolean
update-timer number
te-up-threshold number
segment-routing 
apply-groups reference
apply-groups-exclude reference
maintenance-policy string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
bfd-liveness boolean
bfd-template reference
hold-down-timer number
mode keyword
return-path-label number
revert-timer number
threshold number
segment-routing-v6 
apply-groups reference
apply-groups-exclude reference
base-routing-instance 
apply-groups reference
apply-groups-exclude reference
locator reference 
apply-groups reference
apply-groups-exclude reference
function 
end number 
apply-groups reference
apply-groups-exclude reference
srh-mode keyword
end-dt4 
value number
end-dt46 
value number
end-dt6 
value number
end-x number 
apply-groups reference
apply-groups-exclude reference
interface-name reference
protection keyword
srh-mode keyword
end-x-auto-allocate keyword protection keyword 
micro-segment-locator reference 
apply-groups reference
apply-groups-exclude reference
function 
ua number 
apply-groups reference
apply-groups-exclude reference
interface-name reference
protection keyword
srh-mode keyword
ua-auto-allocate keyword protection keyword 
udt4 
value number
udt46 
value number
udt6 
value number
locator string 
admin-state keyword
algorithm number
apply-groups reference
apply-groups-exclude reference
argument-length number
block-length number
function-length number
label-block reference
prefix 
ip-prefix string
static-function 
label-block reference
max-entries number
termination-fpe reference
micro-segment 
apply-groups reference
apply-groups-exclude reference
argument-length number
block string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
label-block reference
prefix 
ip-prefix string
static-function 
max-entries number
termination-fpe reference
block-length number
global-sid-entries number
sid-length number
micro-segment-locator string 
admin-state keyword
algorithm number
apply-groups reference
apply-groups-exclude reference
block reference
un 
srh-mode keyword
value number
origination-fpe reference
source-address string
sr-mpls 
apply-groups reference
apply-groups-exclude reference
prefix-sids reference 
apply-groups reference
apply-groups-exclude reference
ipv4-sid 
index number
label number
ipv6-sid 
index number
label number
node-sid boolean
sr-policies 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
egress-statistics 
accounting-policy reference
admin-state keyword
apply-groups reference
apply-groups-exclude reference
collect-stats boolean
ingress-statistics 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
reserved-label-block reference
static-policy string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
binding-sid number
color number
distinguisher number
endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
head-end (ipv4-address-no-zone | ipv6-address-no-zone | keyword)
maintenance-policy reference
preference number
segment-list number 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
segment number 
apply-groups reference
apply-groups-exclude reference
behavior-and-structure 
apply-groups reference
apply-groups-exclude reference
behavior keyword
block-length number
function-length number
node-length number
mpls-label number
srv6-sid string
weight number
segment-routing-v6 
binding-sid number 
apply-groups reference
apply-groups-exclude reference
ip-address string
locator 
function keyword
function-value number
locator-name reference
micro-segment-locator 
function keyword
function-value number
locator-name reference
return-path-bfd-sid string
type keyword
selective-fib boolean
sfm-overload 
holdoff-time number
sgt-qos 
dot1p 
application keyword 
apply-groups reference
apply-groups-exclude reference
dot1p (keyword | number)
dscp 
application keyword 
apply-groups reference
apply-groups-exclude reference
dscp (keyword | number)
dscp-map keyword 
apply-groups reference
apply-groups-exclude reference
fc keyword
static-routes 
apply-groups reference
apply-groups-exclude reference
hold-down 
initial number
max-value number
multiplier number
route (ipv4-prefix | ipv6-prefix) route-type keyword 
apply-groups reference
apply-groups-exclude reference
backup-tag number
blackhole 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
community string
description string
dynamic-bgp boolean
generate-icmp boolean
metric number
preference number
prefix-list 
flag keyword
name reference
tag number
community string
indirect (ipv4-address-no-zone | ipv6-address-no-zone) 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
community string
cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) 
apply-groups reference
apply-groups-exclude reference
drop-count number
interval number
log boolean
padding-size number
description string
destination-class number
metric number
preference number
prefix-list 
flag keyword
name reference
qos 
forwarding-class keyword
priority keyword
source-class number
tag number
tunnel-next-hop 
disallow-igp boolean
flex-algo number
resolution keyword
resolution-filter 
ldp boolean
mpls-fwd-policy boolean
rib-api boolean
rsvp-te 
lsp string 
sr-isis boolean
sr-ospf boolean
sr-ospf3 boolean
sr-te 
lsp string 
interface string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
community string
cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) 
apply-groups reference
apply-groups-exclude reference
drop-count number
interval number
log boolean
padding-size number
description string
destination-class number
load-balancing-weight number
metric number
preference number
prefix-list 
flag keyword
name reference
qos 
forwarding-class keyword
priority keyword
source-class number
tag number
ipsec-tunnel string 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
community string
description string
metric number
preference number
tag number
next-hop (ipv4-address-with-zone | ipv6-address-with-zone) 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
backup-next-hop 
address (ipv4-address-no-zone | ipv6-address-no-zone)
bfd-liveness boolean
community string
cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) 
apply-groups reference
apply-groups-exclude reference
drop-count number
interval number
log boolean
padding-size number
description string
destination-class number
ldp-sync boolean
load-balancing-weight number
metric number
preference number
prefix-list 
flag keyword
name reference
qos 
forwarding-class keyword
priority keyword
source-class number
tag number
validate-next-hop boolean
tag number
subscriber-mgmt 
apply-groups reference
apply-groups-exclude reference
dhcpv4 
apply-groups reference
apply-groups-exclude reference
routed-subnet-transparent-forward boolean
triggered-policy boolean
ttl-propagate 
apply-groups reference
apply-groups-exclude reference
label-route-local keyword
label-route-transit keyword
lsr-label-route keyword
vprn-local keyword
vprn-transit keyword
tunnel-interface 
ldp-p2mp-leaf number sender-address string 
apply-groups reference
apply-groups-exclude reference
description string
ldp-p2mp-root number sender-address string 
apply-groups reference
apply-groups-exclude reference
description string
rsvp-p2mp-leaf string sender-address string 
apply-groups reference
apply-groups-exclude reference
description string
rsvp-p2mp-root string 
apply-groups reference
apply-groups-exclude reference
description string
twamp-light 
apply-groups reference
apply-groups-exclude reference
reflector 
admin-state keyword
allow-ipv6-udp-checksum-zero boolean
apply-groups reference
apply-groups-exclude reference
description string
prefix (ipv4-prefix | ipv6-prefix) 
apply-groups reference
apply-groups-exclude reference
description string
type keyword
udp-port number
vrgw 
lanext 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
vxlan-port number
vxlan-vtep-range 
end (ipv4-address-no-zone | ipv6-address-no-zone)
start (ipv4-address-no-zone | ipv6-address-no-zone)
wlan-gw-group reference
weighted-ecmp keyword
wlan-gw 
apply-groups reference
apply-groups-exclude reference
distributed-subscriber-mgmt 
apply-groups reference
apply-groups-exclude reference
ipv6-tcp-mss-adjust number
mobility-triggered-accounting 
admin-state keyword
hold-down number
include-counters boolean
xconnect 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
tunnel-source-ip string
wlan-gw-group reference
wpp 
admin-state keyword
apply-groups reference
apply-groups-exclude reference
portal string 
ack-auth-retry-count number
address (ipv4-address-no-zone | ipv6-address-no-zone)
admin-state keyword
apply-groups reference
apply-groups-exclude reference
ntf-logout-retry-count number
port-format keyword
retry-interval number
secret string
version number

router command descriptions

router [router-name] string

Synopsis Enter the router list instance
Contextconfigure router string
Treerouter

Description

Commands in this context configure a router instance that represents a virtual router in the system. There will always be at least two instances in the system. The Base or transport router and the management router are created when the system is initialized and cannot be deleted.

Max. Instances4
Introduced16.0.R1

Platforms

All

[router-name] string

Synopsis Administrative router name
Context configure router string
Treerouter
String Length1 to 64
MD-CLI DefaultBase

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

aggregates

Synopsis Enter the aggregates context
Context configure router string aggregates
Treeaggregates
Introduced16.0.R1

Platforms

All

aggregate [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the aggregate list instance
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix)
Treeaggregate

Description

Commands in this context add aggregate routes to the routing table when there are one or more component routes. A component route is any route installed in the forwarding table that is a more-specific match of the aggregate.

The use of aggregate routes can lead to smaller routing table sizes by reducing the number of routes that need to be advertised to neighbor routes.

Introduced16.0.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Destination IP address prefix of the aggregate route
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix)
Treeaggregate

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

aggregator
Synopsis Enter the aggregator context
Context configure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) aggregator
Treeaggregator

Description

Commands in this context configure the BGP AGGREGATOR path attribute for the aggregate route.

Introduced16.0.R1

Platforms

All

as-set boolean
Synopsis Use AS_SET path segment type for the aggregate route
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) as-set boolean
Treeas-set

Description

When configured to true, the AS_PATH attribute of the aggregate contains an AS_SET containing all AS numbers from the contributing routes. This can increase the amount of churn due to best-path changes.

When configured to false, the AS_PATH attribute contains no AS_SET and will be originated by the ESR.

Defaultfalse
Introduced16.0.R1

Platforms

All

blackhole
Synopsis Enable the blackhole context
Context configure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) blackhole
Treeblackhole

Notes

The following elements are part of a choice: blackhole or indirect.

Introduced16.0.R1

Platforms

All

generate-icmp boolean
Synopsis Send ICMP unreachable messages for aggregate routes
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) blackhole generate-icmp boolean
Treegenerate-icmp

Description

When configured to true, ICMP unreachable messages are sent when packets match an aggregate route in the FIB with a black-hole next-hop.

When configured to false, ICMP unreachable messages are not generated.

Defaultfalse
Introduced16.0.R2

Platforms

All

community string
Synopsis Community name that is added to the aggregate route
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) community string
Treecommunity

Description

This command associates a BGP community with the aggregate route. The community name can be matched in route policies and is automatically added to BGP routes exported from the aggregate route.

String Length1 to 72
Max. Instances12

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

indirect (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAddress of the indirect next hop
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) indirect (ipv4-address-no-zone | ipv6-address-no-zone)
Treeindirect

Description

This command programs aggregate routes into the forwarding table with an indirect next hop. If a packet matches the aggregate route but not a contributing route, it is forwarded toward the indirect next hop rather than being discarded.

Notes

The following elements are part of a choice: blackhole or indirect.

Introduced16.0.R1

Platforms

All

local-preference number
Synopsis Local preference used when aggregate route is exported
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) local-preference number
Treelocal-preference

Description

This command configures the local preference value to use when the aggregate route is exported rather than using any of the local preference values assigned for any of the contributing routes.

Range0 to 4294967295
Introduced16.0.R1

Platforms

All

policy reference
Synopsis Policy name for the aggregated route
Context configure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) policy reference
Treepolicy

Description

This command associates an aggregate route with a policy reference. The aggregated route is activated only when there is at least one eligible active route in the sub-trees below it that is accepted by the policy evaluation. There is no evaluation into any sub-tree that starts with another active aggregate route. Eligible routes exclude host routes and LDP shortcut routes.

If an aggregate route has no policy, or the reference is to an empty policy, this configuration is treated as equivalent to a policy with one rule that accepts all routes.

Reference

configure policy-options policy-statement string

Introduced20.10.R1

Platforms

All

summary-only boolean
Synopsis Advertise the aggregate route only
Context configure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) summary-only boolean
Treesummary-only

Description

When configured to true, the router suppresses the advertisement of more specific component routes for the aggregate.

When configured to false, the router advertises both the aggregate route and its contributing routes.

Defaultfalse
Introduced16.0.R1

Platforms

All

tunnel-group number
Synopsis Tunnel group from which to associate the MC IPSec state
Contextconfigure router string aggregates aggregate (ipv4-prefix | ipv6-prefix) tunnel-group number
Treetunnel-group

Description

This command adds the MC-IPsec state of the specific tunnel-group to the aggregate route.

Range1 to 64
Introduced20.7.R1

Platforms

All

allow-bgp-to-igp-export boolean

Synopsis Enable the distribution of BGP routes into the IGP
Contextconfigure router string allow-bgp-to-igp-export boolean
Treeallow-bgp-to-igp-export

Description

When configured to true, the router can export base BGP RTM routes into the IGP routing instance within the base router. This command applies to already exported BGP prefixes and to newly received BGP prefixes.

Defaulttrue
Introduced23.7.R1

Platforms

All

allow-icmp-redirect boolean

Synopsis Allow ICMP redirects on the management interface
Contextconfigure router string allow-icmp-redirect boolean
Treeallow-icmp-redirect

Description

When configured to true, ICMP redirect messages can be received on the management interface.

When configured to false, all received ICMP redirect messages are dropped.

This command cannot be configured on a non-management interface.

Defaultfalse
Introduced16.0.R1

Platforms

All

allow-icmp6-redirect boolean

Synopsis Allow IPv6 ICMP redirects on the management interface
Contextconfigure router string allow-icmp6-redirect boolean
Treeallow-icmp6-redirect

Description

When configured to true, IPv6 ICMP redirect messages can be received on the management interface.

When configured to false, all received IPv6 ICMP redirect messages are dropped.

This command cannot be configured on a non-management interface.

Defaultfalse
Introduced16.0.R1

Platforms

All

autonomous-system number

Synopsis AS number advertised to peers for this router
Contextconfigure router string autonomous-system number
Treeautonomous-system

Description

This command configures the autonomous system (AS) number for the router. This value must be set before BGP can be activated.

If the AS number is changed on a router with an active BGP instance, the new AS number is not used until the BGP instance is restarted.

Range1 to 4294967295
Introduced16.0.R1

Platforms

All

bfd

Synopsis Enter the bfd context
Context configure router string bfd
Treebfd
Introduced19.7.R1

Platforms

All

seamless-bfd
Synopsis Enter the seamless-bfd context
Contextconfigure router string bfd seamless-bfd
Treeseamless-bfd
Introduced19.7.R1

Platforms

All

peer [address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the peer list instance
Context configure router string bfd seamless-bfd peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer
Max. Instances8000
Introduced19.7.R1

Platforms

All

[address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Address of the remote node
Context configure router string bfd seamless-bfd peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer

Notes

This element is part of a list key.

Introduced19.7.R1

Platforms

All

bgp

Synopsis Enable the bgp context
Context configure router string bgp
Treebgp
Introduced16.0.R1

Platforms

All

add-paths
Synopsis Enable the add-paths context
Context configure router string bgp add-paths
Treeadd-paths

Description

Commands in this context configure add-paths support for the specified address families of the BGP instance. The BGP add-paths capability allows the router to send or receive multiple paths per prefix to and from a peer.

Introduced16.0.R1

Platforms

All

evpn
Synopsis Enter the evpn context
Context configure router string bgp add-paths evpn
Treeevpn

Description

Commands in this context configure the Add-Paths capability for EVPN routes. By default, Add-Paths is not enabled for EVPN routes.

Introduced21.10.R1

Platforms

All

receive boolean
Synopsis Receive multiple EVPN paths per prefix from a peer
Contextconfigure router string bgp add-paths evpn receive boolean
Treereceive
Defaultfalse
Introduced21.10.R1

Platforms

All

send (number | keyword)
Synopsis Maximum number of EVPN paths to send
Context configure router string bgp add-paths evpn send (number | keyword)
Treesend
Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced21.10.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string bgp add-paths ipv4
Treeipv4

Description

Commands in this context configure add-paths support for the IPv4 unicast address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per unlabeled IPv4 prefix
Contextconfigure router string bgp add-paths ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple unlabeled IPv4 unicast routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per unlabeled IPv4 unicast prefix
Contextconfigure router string bgp add-paths ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths per unlabeled IPv4 unicast prefix that are allowed to be advertised to ADD-PATH peers. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for unlabeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string bgp add-paths ipv6
Treeipv6

Description

Commands in this context configure add-paths support for the IPv6 unicast address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per unlabeled IPv6 prefix
Contextconfigure router string bgp add-paths ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple unlabeled IPv6 unicast routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per unlabeled IPv6 unicast prefix
Contextconfigure router string bgp add-paths ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per unlabeled IPv6 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for unlabeled IPv6 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

label-ipv4
Synopsis Enter the label-ipv4 context
Context configure router string bgp add-paths label-ipv4
Treelabel-ipv4

Description

Commands in this context configure add-paths support for the labeled IPv4 unicast address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv4 prefix
Contextconfigure router string bgp add-paths label-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple labeled-unicast routes per IPv4 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Paths advertised per labeled IPv4 unicast prefix
Contextconfigure router string bgp add-paths label-ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per labeled IPv4 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for labeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

label-ipv6
Synopsis Enter the label-ipv6 context
Context configure router string bgp add-paths label-ipv6
Treelabel-ipv6

Description

Commands in this context configure add-paths support for the labeled IPv6 unicast address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv6 prefix
Contextconfigure router string bgp add-paths label-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple labeled-unicast routes per IPv6 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Paths advertised per labeled IPv6 unicast prefix
Contextconfigure router string bgp add-paths label-ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per labeled IPv6 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for labeled IPv6 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

mcast-vpn-ipv4
Synopsis Enter the mcast-vpn-ipv4 context
Contextconfigure router string bgp add-paths mcast-vpn-ipv4
Treemcast-vpn-ipv4

Description

Commands in this context configure add-paths support for the multicast IPv4 VPN address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast routes per IPv4 VPN prefix
Contextconfigure router string bgp add-paths mcast-vpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast routes per IPv4 VPN prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths advertised per multicast IPv4 VPN prefix
Contextconfigure router string bgp add-paths mcast-vpn-ipv4 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast IPv4 VPN prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for multicast IPv4 VPN routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv6
Synopsis Enter the mcast-vpn-ipv6 context
Contextconfigure router string bgp add-paths mcast-vpn-ipv6
Treemcast-vpn-ipv6

Description

Commands in this context configure add-paths support for the multicast IPv6 VPN address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast routes per IPv6 VPN prefix
Contextconfigure router string bgp add-paths mcast-vpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast routes per IPv6 VPN prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths advertised per multicast IPv6 VPN prefix
Contextconfigure router string bgp add-paths mcast-vpn-ipv6 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast IPv6 VPN prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for multicast IPv6 VPN routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mvpn-ipv4
Synopsis Enter the mvpn-ipv4 context
Context configure router string bgp add-paths mvpn-ipv4
Treemvpn-ipv4

Description

Commands in this context configure add-paths support for the multicast VPN IPv4 address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per multicast VPN IPv4 NRLI
Contextconfigure router string bgp add-paths mvpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple routes per multicast VPN IPv4 NRLI to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths advertised per multicast VPN IPv4 NRLI
Contextconfigure router string bgp add-paths mvpn-ipv4 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast VPN IPv4 NRLI. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for multicast VPN IPv4 routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mvpn-ipv6
Synopsis Enter the mvpn-ipv6 context
Context configure router string bgp add-paths mvpn-ipv6
Treemvpn-ipv6

Description

Commands in this context configure add-paths support for the multicast VPN IPv6 address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per multicast VPN IPv6 NRLI
Contextconfigure router string bgp add-paths mvpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple routes per multicast VPN IPv6 NRLI to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths advertised per multicast VPN IPv6 NRLI
Contextconfigure router string bgp add-paths mvpn-ipv6 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast VPN IPv6 NRLI. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for multicast VPN IPv6 routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

vpn-ipv4
Synopsis Enter the vpn-ipv4 context
Context configure router string bgp add-paths vpn-ipv4
Treevpn-ipv4

Description

Commands in this context configure add-paths support for the VPN-IPv4 address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per VPN-IPv4 prefix
Contextconfigure router string bgp add-paths vpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple routes per VPN-IPv4 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths advertised per VPN-IPv4 prefix
Contextconfigure router string bgp add-paths vpn-ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per VPN-IPv4 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for VPN-IPv4 routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

vpn-ipv6
Synopsis Enter the vpn-ipv6 context
Context configure router string bgp add-paths vpn-ipv6
Treevpn-ipv6

Description

Commands in this context configure add-paths support for the VPN-IPv6 address family.

Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per VPN-IPv6 prefix
Contextconfigure router string bgp add-paths vpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple routes per VPN-IPv6 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths advertised per VPN-IPv6 prefix
Contextconfigure router string bgp add-paths vpn-ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per VPN-IPv6 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, add-paths send capability is not enabled for VPN-IPv6 routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the BGP instance
Contextconfigure router string bgp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

advertise-external
Synopsis Enter the advertise-external context
Contextconfigure router string bgp advertise-external
Treeadvertise-external

Description

Commands in this context allow BGP to advertise its best external route to a destination for specified address families even when its best overall route is an internal route.

Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Enable support for unlabeled unicast IPv4 routes
Contextconfigure router string bgp advertise-external ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Enable support for unlabeled unicast IPv6 routes
Contextconfigure router string bgp advertise-external ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

advertise-inactive boolean
Synopsis Advertise inactive BGP routes to peers
Contextconfigure router string bgp advertise-inactive boolean
Treeadvertise-inactive

Description

When configured to true, this command allows any inactive BGP route to be advertised, even though it is not the used route.

When configured to false, the advertisement of inactive BGP routes to other BGP peers is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

advertise-ipv6-next-hops
Synopsis Enter the advertise-ipv6-next-hops context
Contextconfigure router string bgp advertise-ipv6-next-hops
Treeadvertise-ipv6-next-hops

Description

Commands in this context allow specified BGP address family routes to be advertised to IPv6 transport peers with a true IPv6 address when originated or when a configured or automatic next-hop-self action is applied.

This command context has no effect on routes advertised to IPv4 peers.

Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise EVPN route with IPv6 next-hop address
Contextconfigure router string bgp advertise-ipv6-next-hops evpn boolean
Treeevpn

Description

When configured to true, EVPN routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, EVPN routes are advertised with IPv4 next-hop addresses to IPv6 transport peers.

Defaultfalse
Introduced19.5.R1

Platforms

All

ipv4 boolean
Synopsis Advertise IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp advertise-ipv6-next-hops ipv4 boolean
Treeipv4

Description

When configured to true, IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, IPv4 routes are advertised with IPv4 next-hop addresses to IPv6 transport peers. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced19.5.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise label IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp advertise-ipv6-next-hops label-ipv4 boolean
Treelabel-ipv4

Description

When configured to true, label IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, label IPv4 routes are advertised with the system IPv4 address as the next hop to IPv6 transport peers. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise label IPv6 route with IPv6 next-hop address
Contextconfigure router string bgp advertise-ipv6-next-hops label-ipv6 boolean
Treelabel-ipv6

Description

When configured to true, label IPv6 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, label IPv6 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop, encoded as an IPv4-mapped IPv6 address.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise VPN IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp advertise-ipv6-next-hops vpn-ipv4 boolean
Treevpn-ipv4

Description

When configured to true, VPN IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, VPN IPv4 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise VPN IPv6 route with IPv6 next-hop address
Contextconfigure router string bgp advertise-ipv6-next-hops vpn-ipv6 boolean
Treevpn-ipv6

Description

When configured to true, VPN IPv6 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, VPN IPv6 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop, encoded as an IPv4-mapped IPv6 address.

Defaultfalse
Introduced16.0.R1

Platforms

All

aggregator-id-zero boolean
Synopsis Set router ID in the BGP AGGREGATOR attribute to 0
Contextconfigure router string bgp aggregator-id-zero boolean
Treeaggregator-id-zero

Description

When configured to true, the router ID in the BGP AGGREGATOR path attribute is set to 0 when BGP aggregates routes. This prevents different routers within an AS from creating aggregate routes for the same prefix with different path attributes.

When configured to false, the AS number and router ID are added to the AGGREGATOR path attribute.

Defaultfalse
Introduced16.0.R1

Platforms

All

asn-4-byte boolean
Synopsis Advertise support for 4-byte ASNs
Context configure router string bgp asn-4-byte boolean
Treeasn-4-byte
Defaulttrue
Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis BGP authentication key for all peers
Context configure router string bgp authentication-key string
Treeauthentication-key

Description

This command configures the authentication key used to protect all sessions. The stored format of the authentication key is based on the configure system security hash-control management-interface md-cli hash-algorithm setting.

String Length1 to 370
Introduced16.0.R1

Platforms

All

authentication-keychain reference
Synopsis TCP authentication keychain for the session
Contextconfigure router string bgp authentication-keychain reference
Treeauthentication-keychain

Description

This command associates the keychain to be used to authenticate the BGP session. The keychain allows the rollover of authentication keys during the lifetime of a session.

Reference

configure system security keychains keychain string

Introduced16.0.R3

Platforms

All

backup-path
Synopsis Enter the backup-path context
Context configure router string bgp backup-path
Treebackup-path

Description

Commands in this context enable the use of a backup path for specified BGP-learned prefixes belonging to the base router. Multiple paths must be received for a prefix in order to take advantage of this feature. When a prefix has a backup path and its primary paths fail, the affected traffic is rapidly diverted to the backup path without waiting for control plane re-convergence to occur. When many prefixes share the same primary paths and in some cases, the same backup path, the time to divert failover traffic to the backup path is independent of the number of prefixes.

By default, IPv4 and IPv6 prefixes do not have a backup path installed in the IOM.

Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Enable support for unlabeled unicast IPv4 routes
Contextconfigure router string bgp backup-path ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Enable support for unlabeled unicast IPv6 routes
Contextconfigure router string bgp backup-path ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv4 boolean
Synopsis Enable support for labeled-unicast IPv4 routes
Contextconfigure router string bgp backup-path label-ipv4 boolean
Treelabel-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Enable support for labeled-unicast IPv6 routes
Contextconfigure router string bgp backup-path label-ipv6 boolean
Treelabel-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

best-path-selection
Synopsis Enter the best-path-selection context
Contextconfigure router string bgp best-path-selection
Treebest-path-selection
Introduced16.0.R1

Platforms

All

always-compare-med
Synopsis Enter the always-compare-med context
Contextconfigure router string bgp best-path-selection always-compare-med
Treealways-compare-med

Description

Commands in this context determine how the BGP decision process is affected by the MED path attribute.

Introduced16.0.R1

Platforms

All

strict-as boolean
Synopsis Compare MED only for routes from same neighbor AS
Contextconfigure router string bgp best-path-selection always-compare-med strict-as boolean
Treestrict-as

Description

When configured to true, the route selection process can compare the MED path attribute between routes only if they come from the same neighbor AS.

When configured to false, the route selection process can compare the MED path attribute between routes even if they come from different neighbor ASs.

Defaulttrue
Introduced16.0.R1

Platforms

All

as-path-ignore
Synopsis Enter the as-path-ignore context
Contextconfigure router string bgp best-path-selection as-path-ignore
Treeas-path-ignore

Description

Commands in this context determine whether the AS path length is considered in the selection process for routes of the specified address families.

Introduced16.0.R1

Platforms

All

compare-origin-validation-state boolean
Synopsis Compare RPKI origin validation state of usable routes
Contextconfigure router string bgp best-path-selection compare-origin-validation-state boolean
Treecompare-origin-validation-state

Description

When configured to true, the RPKI origin validation state is compared between BGP routes, where a Valid state is preferred over a Not-Found state, and a Not-Found state is preferred over an Invalid state.

When configured to false, the RPKI origin validate state comparison is not performed as part of the BGP route selection process.

Defaultfalse
Introduced16.0.R1

Platforms

All

d-path-length-ignore boolean
Synopsis Enable D-PATH length ignore
Context configure router string bgp best-path-selection d-path-length-ignore boolean
Treed-path-length-ignore

Description

When configured to true, this command, enables the router to ignore the D-PATH domain segment length during best-path selection.

At the base router level (or VPRN BGP level for PE-CE routers), this command allows BGP to ignore the D-PATH domain segment length for best-path selection purposes. BGP ignores the D-PATH length when comparing two VPN routes or two IFL routes within the same RD. However, these VPN/IFL routes are processed in the main-BGP instance.

At the VPRN router level, this command allows the VPRN RTM to ignore the D-PATH domain segment length for best-path selection purposes (for routes in VPRN). The user can control whether the RTM considers the D-PATH length when comparing two VPN routes with different RDs.

Best-path selection for EVPN-IFF routes against other owners (for example, EVPN-IFL or IPVPN) still relies on RTM preference. When EVPN-IFF RTM preference matches the RTM preference of another BGP owner, the existing RTM selection applies and D-PATH is not considered, irrespective of the d-path-length-ignore configuration.

When configured to false, this command disables the ability to ignore the D-PATH domain segment length.

Defaultfalse
Introduced21.10.R1

Platforms

All

deterministic-med boolean
Synopsis Group paths based on AS before MED attribute comparison
Contextconfigure router string bgp best-path-selection deterministic-med boolean
Treedeterministic-med

Description

When configured to true, BGP groups paths from the same AS that are equal up to the MED attribute comparison and then compares the best path from each group to select the overall best path. This process ensures that the best-path selection process is deterministic in all cases.

When configured to false, paths are not grouped and the overall best-path selection can depend on the order of route arrival.

Defaultfalse
Introduced16.0.R1

Platforms

All

ebgp-ibgp-equal
Synopsis Enter the ebgp-ibgp-equal context
Contextconfigure router string bgp best-path-selection ebgp-ibgp-equal
Treeebgp-ibgp-equal

Description

Commands in this context allow BGP to ignore the difference between EBGP and IBGP routes in selecting the best path and eligible multipaths (if multipath and ECMP are enabled) for the specified address families. The result is a form of EIBGP load-balancing in a multipath scenario. This behavior can be applied selectively to certain address families.

By default, the BGP decision process prefers an EBGP learned route over an IBGP learned route.

Introduced16.0.R1

Platforms

All

ignore-nh-metric boolean
Synopsis Ignore next-hop distance in best path selection
Contextconfigure router string bgp best-path-selection ignore-nh-metric boolean
Treeignore-nh-metric

Description

When configured to true, BGP ignores the resolved distance to the BGP next hop in its route selection process.

When configured to false, BGP factors the distance to the next hop into its decision process when it compares two BGP routes with the same NLRI learned from base router BGP peers (in the router context) or IP prefix learned from VPRN BGP peers (in the vprn context).

Defaultfalse
Introduced16.0.R1

Platforms

All

ignore-router-id
Synopsis Enable the ignore-router-id context
Contextconfigure router string bgp best-path-selection ignore-router-id
Treeignore-router-id

Description

Commands in this context determine whether the BGP selection process ignores the BGP identifier (router ID) comparison of two EBGP paths from different EBGP peers when determining the best path for the specified address families.

By default, BGP selects the path with the lower router ID when it compares two paths from EBGP peers.

Introduced16.0.R1

Platforms

All

include-internal
Synopsis Enter the include-internal context
Contextconfigure router string bgp best-path-selection ignore-router-id include-internal
Treeinclude-internal

Description

Commands in this context specify the internal address families for which the router ID values are ignored, even when comparing two IBGP paths or an EBGP and an IBGP path.

Introduced16.0.R1

Platforms

All

origin-invalid-unusable boolean
Synopsis Deem invalid routes unusable for best-path selection
Contextconfigure router string bgp best-path-selection origin-invalid-unusable boolean
Treeorigin-invalid-unusable

Description

When configured to true, routes that have an RPKI origin validation state of Invalid are considered unusable by the best-path selection algorithm. These routes cannot be used for forwarding and cannot be advertised to BGP peers.

When configured to false, routes with an RPKI origin validation state of Invalid are compared to other usable routes for the same prefix according to the BGP decision process.

Defaultfalse
Introduced16.0.R1

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD
Contextconfigure router string bgp bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, BFD is enabled on all BGP sessions, subject to the association of those BGP sessions with IP interfaces that have BFD configurations.

When configured to false, BFD is not enabled globally for all BGP sessions.

Defaultfalse
Introduced16.0.R1

Platforms

All

bfd-strict-mode
Synopsis Enter the bfd-strict-mode context
Contextconfigure router string bgp bfd-strict-mode
Treebfd-strict-mode
Introduced23.7.R1

Platforms

All

advertise
Synopsis Enable the advertise context
Context configure router string bgp bfd-strict-mode advertise
Treeadvertise

Description

Commands in this context configure BGP to advertise the Strict-BFD capability to peers that are within scope of this command and meet the following requirements:

  • The inherited or configured value for the bfd-liveness command that applies to the peer is true.

  • The interface associated with the peer has a valid BFD configuration.

When the preceding conditions are satisfied and two peers attempting to form a session both advertise the Strict-BFD capability, the BGP finite state machine in each router transitions the session state to established after the BFD session with the peer enters the up state.

When unconfigured, BGP does not advertise the Strict-BFD capability to peers.

Introduced23.7.R1

Platforms

All

holdtime number
Synopsis Maximum time BGP waits for the BFD session to come up
Contextconfigure router string bgp bfd-strict-mode advertise holdtime number
Treeholdtime

Description

This command configures the maximum time BGP waits for the BFD session to come up, provided that the Strict-BFD procedures apply to a session, and the negotiated BGP hold time is zero (no keepalives). If the negotiated BGP hold time is greater than zero, the advertised hold time is not considered.

Range1 to 65535
Unitsseconds
Default 30
Introduced23.7.R1

Platforms

All

next-hop-reachability boolean
Synopsis Consider next hop unreachable if BFD session is down
Contextconfigure router string bgp bfd-strict-mode next-hop-reachability boolean
Treenext-hop-reachability

Description

When configured to true, the router considers next-hop self routes belonging to specific address families received from a peer within scope of this command as having an unresolved next hop, provided that the following requirements are met:

  • The BFD session to the peer is in a down state.

  • There is a valid interface BFD configuration that applies to the peer.

  • There is a valid BFD liveness configuration that applies to the peer.

The unresolved state is maintained until the BFD session state changes to up or administratively down, even if there is a resolving route or tunnel that matches the BGP next-hop address.

Routes received from one peer with a BGP next-hop address equal to the address of another peer are not affected by the BFD session to the other peer.

The behavior of the router when this command is true does not depend on whether Strict-BFD is used, as both features are independent.

Configuring this command to true only affects routes belonging to the following address families:

  • IPv4

  • IPv6

  • IPv4 VPN

  • IPv6 VPN

  • labeled unicast IPv4

  • labeled unicast IPv6

  • EVPN

  • IPv4 multicast

  • IPv6 multicast

  • IPv4 VPN multicast

  • IPv6 VPN multicast

When configured to false, the router does not consider next-hop self routes belonging to the preceding address families as having an unresolved next hop if the BFD session goes down.

Defaultfalse
Introduced23.7.R1

Platforms

All

bgp-tunnel-metric
Synopsis Enter the bgp-tunnel-metric context
Contextconfigure router string bgp bgp-tunnel-metric
Treebgp-tunnel-metric

Description

Commands in this context control the tunnel table metrics associated with BGP label unicast routes.

Introduced20.5.R1

Platforms

All

prefer-aigp boolean
Synopsis Use the AIGP attribute as tunnel metric when present
Contextconfigure router string bgp bgp-tunnel-metric prefer-aigp boolean
Treeprefer-aigp

Description

When configured to true, the TTM metric is based on the AIGP metric if the route has the path attribute. When the BGP-LU route is selected for installation in TTM and it is not matched by a BGP import policy entry that overrides the BGP tunnel metric action, the TTM metric of the tunnel is set to the AIGP metric value of the BGP-LU route plus the resolved cost to the BGP next-hop of the route; otherwise, the metric is set to the value in the value setting.

When configured to false, the AIGP attribute is ignored for purposes to TTM metric derivation.

Defaultfalse
Introduced20.5.R1

Platforms

All

prefer-med boolean
Synopsis Use the MED attribute as tunnel metric when present
Contextconfigure router string bgp bgp-tunnel-metric prefer-med boolean
Treeprefer-med

Description

When configured to true, the TTM metric is based on the MED metric value of the BGP-LU route. When a BGP-LU route is selected for installation in TTM and is not matched by a BGP import policy entry that overrides the BGP tunnel metric action, the TTM metric of the tunnel is set to the MED metric value of the BGP-LU route with the resolved cost to the BGP next hop of the route added to it. Otherwise, the metric is set to the value configured using the value command.

When configured to false, the MED attribute is ignored for TTM metric derivation.

Note: prefer-aigp takes precedence over this command if the received BGP-LU has both attributes.

Defaultfalse
Introduced23.3.R1

Platforms

All

value number
Synopsis BGP tunnel metric value
Context configure router string bgp bgp-tunnel-metric value number
Treevalue

Description

This command configures a BGP tunnel metric for label IPv4 routes that do not have their metric set by more specific means.

If a BGP-LU route is selected for installation in the TTM and there is no tunnel metric policy action that applies to the route, the TTM metric of the associated tunnel is set to this value if either:

  • prefer-aigp is set to false

  • prefer-aigp is set to true but the BGP-LU route does not have an AIGP attribute

Range0 to 4294967295
Default1000
Introduced 20.5.R1

Platforms

All

bgp-tunnel-preference number
Synopsis BGP tunnel table preference
Context configure router string bgp bgp-tunnel-preference number
Treebgp-tunnel-preference

Description

This command configures the tunnel table preference for BGP-LU tunnel type.

The tunnel table preference applies to next-hop resolution of BGP routes for: EVPN, IPv4, IPv6, VPN-IPv4, VPN-IPv6, label-IPv4, and label-IPV6 in the tunnel table.

This feature does not apply to a VPRN, VPLS, or VLL service with explicit binding to an SDP that enabled the mixed-lsp-mode option. The service manager controls and fixes the tunnel preference in such an SDP. The tunnel table preference configuration does not modify the SDP behavior, nor the services that bind to it.

Range1 to 255
Default12
Introduced 21.10.R1

Platforms

All

block-prefix-sid boolean
Synopsis Block the prefix SID attribute
Context configure router string bgp block-prefix-sid boolean
Treeblock-prefix-sid

Description

When configured to true, all prefix SID attributes are removed from label IPv4 and label IPv6 routes when they are exchanged with EBGP and IBGP peers covered by the scope of the command. Locally-imposed prefix SID attributes are also removed.

When configured to false, all prefix SID attributes associated with label IPv4 and label IPv6 routes are propagated without restriction.

A change of this configuration causes the affected BGP sessions to flap.

Defaultfalse
Introduced19.10.R1

Platforms

All

client-reflect boolean
Synopsis Allow client reflection of routes by route reflector
Contextconfigure router string bgp client-reflect boolean
Treeclient-reflect

Description

When configured to true, routes received from neighbors considered to be RR clients are reflected to other peers as expected.

When configured to false, routes received from neighbors considered to be RR clients are not reflected to other clients.

Defaulttrue
Introduced16.0.R1

Platforms

All

cluster
Synopsis Enter the cluster context
Context configure router string bgp cluster
Treecluster
Introduced16.0.R1

Platforms

All

allow-local-fallback boolean
Synopsis Allow fallback to RR topology location for ORR
Contextconfigure router string bgp cluster allow-local-fallback boolean
Treeallow-local-fallback

Description

When configured to true, this command allows the RR to advertise the best BGP path from its own topology location when there are no reachable routes from the client's ORR location. The ORR location must be specified before this command can be set to true.

When configured to false, no route is advertised to the clients when there are no reachable routes from the client's ORR location.

Defaultfalse
Introduced16.0.R1

Platforms

All

cluster-id string
Synopsis Route reflector cluster ID
Context configure router string bgp cluster cluster-id string
Treecluster-id

Description

The command specifies the cluster ID to associate with the routing instance, effectively making all IBGP peers of the routing instance RR clients.

Introduced16.0.R1

Platforms

All

orr-location number
Synopsis Optimal route reflection location for the cluster
Contextconfigure router string bgp cluster orr-location number
Treeorr-location

Description

This command configures an ORR location ID. If a cluster ID is also specified, the clients in that cluster receive routes optimal for that specific location.

With optimal route reflection, the best path advertised to a client takes location ID into account. If the tie-break for best path (or Add-Paths) comes down to next-hop IGP cost, the IGP costs will be calculated relative to the specified location. In the SR OS implementation, the IGP costs from arbitrary ORR locations are calculated using OSPF, OSPFv3, IS-IS, or BGP-LS information in the TE DB.

Range1 to 255
Introduced16.0.R1

Platforms

All

connect-retry number
Synopsis BGP connect retry timer value
Context configure router string bgp connect-retry number
Treeconnect-retry

Description

This command configures the BGP connect retry timer. When the timer expires, BGP tries to reconnect to the configured peer.

Range1 to 65535
Default120
Introduced 16.0.R1

Platforms

All

convergence
Synopsis Enter the convergence context
Context configure router string bgp convergence
Treeconvergence
Introduced19.7.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp convergence family keyword
Treefamily

Description

Commands in this context configure route convergence options for a specific BGP address family, specifically, the maximum amount of time BGP waits until it advertises the routes of the address family to its BGP peers.

Introduced19.7.R1

Platforms

All

[family-type] keyword
Synopsis Address family for which convergence selection applies
Contextconfigure router string bgp convergence family keyword
Treefamily
Optionsipv4, vpn-ipv4, ipv6, vpn-ipv6, label-ipv4, label-ipv6

Notes

This element is part of a list key.

Introduced19.7.R1

Platforms

All

damp-peer-oscillations
Synopsis Enable the damp-peer-oscillations context
Contextconfigure router string bgp damp-peer-oscillations
Treedamp-peer-oscillations

Description

Commands in this context support the DampPeerOscillations FSM behavior described in section 8.1 of RFC 4271, A Border Gateway Protocol 4 (BGP-4).

When unconfigured, the router does not perform peer oscillation damping and immediately transitions out of the idle state after every reset.

Introduced16.0.R1

Platforms

All

error-interval number
Synopsis Time after a reset that the session must be error-free
Contextconfigure router string bgp damp-peer-oscillations error-interval number
Treeerror-interval

Description

This command sets the interval of time after a reset, during which the session must be error-free in order to reset the penalty counter and return the idle hold time to the initial wait time.

Range0 to 2048
Default30
Introduced 16.0.R1

Platforms

All

idle-hold-time
Synopsis Enter the idle-hold-time context
Contextconfigure router string bgp damp-peer-oscillations idle-hold-time
Treeidle-hold-time

Description

Commands in this context configure how long a BGP peer session remains in the idle state after some type of error causes the session to reset.

In the idle state, BGP does not initiate or respond to attempts to establish a new session. Repeated errors that occur in a short time period after each session reset cause longer and longer hold times in the idle state.

Introduced16.0.R1

Platforms

All

second-wait number
Synopsis Time that doubles after each session failure
Contextconfigure router string bgp damp-peer-oscillations idle-hold-time second-wait number
Treesecond-wait

Description

This command defines the hold time that doubles after each repeated session failure that occurs in a short span of time.

Range1 to 2048
Default5
Introduced 16.0.R1

Platforms

All

damping boolean
Synopsis Use BGP route damping to reduce route flap
Contextconfigure router string bgp damping boolean
Treedamping

Description

When configured to true, this command enables route damping to reduce the number of update messages sent between BGP peers and reduce the load on peers without affecting the route convergence time for stable routes.

Route damping is controlled by profiles set in route policies. If no profile is specified in the route policy, the default damping profile is used with the following parameters:

  • Half-life: 15 minutes

  • Max-suppress: 60 minutes

  • Suppress-threshold: 3000

  • Reuse-threshold: 750

When configured to false, BGP route damping for learned routes is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

def-recv-evpn-encap keyword
Synopsis Default EVPN encapsulation type
Context configure router string bgp def-recv-evpn-encap keyword
Treedef-recv-evpn-encap

Description

This command specifies the encapsulation type that BGP uses when an EVPN route is received without the Encapsulation Extended Community.

Optionsmpls, vxlan
Default mpls
Introduced16.0.R1

Platforms

All

default-label-preference
Synopsis Enter the default-label-preference context
Contextconfigure router string bgp default-label-preference
Treedefault-label-preference
Introduced19.5.R1

Platforms

All

default-preference
Synopsis Enter the default-preference context
Contextconfigure router string bgp default-preference
Treedefault-preference
Introduced19.5.R1

Platforms

All

ebgp number
Synopsis Default preference for EBGP
Context configure router string bgp default-preference ebgp number
Treeebgp
Range0 to 255
Default0
Introduced 19.5.R1

Platforms

All

ibgp number
Synopsis Default preference for IBGP
Context configure router string bgp default-preference ibgp number
Treeibgp
Range0 to 255
Default0
Introduced 19.5.R1

Platforms

All

description string
Synopsis Text description
Context configure router string bgp description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

All

dynamic-neighbor-limit number
Synopsis Max dynamic BGP sessions to accept from remote peers
Contextconfigure router string bgp dynamic-neighbor-limit number
Treedynamic-neighbor-limit

Description

This command configures the maximum number of dynamic BGP sessions to accept from remote peers associated with the entire BGP instance. If accepting a new dynamic session causes the instance limit to be exceeded, the new session attempt is rejected and a Notification message is sent back to the remote peer.

Range1 to 8192
Introduced16.0.R1

Platforms

All

ebgp-default-reject-policy
Synopsis Enter the ebgp-default-reject-policy context
Contextconfigure router string bgp ebgp-default-reject-policy
Treeebgp-default-reject-policy
Introduced19.5.R1

Platforms

All

egress-peer-engineering
Synopsis Enable the egress-peer-engineering context
Contextconfigure router string bgp egress-peer-engineering
Treeegress-peer-engineering
Introduced21.7.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BGP egress engineering
Contextconfigure router string bgp egress-peer-engineering admin-state keyword
Treeadmin-state

Description

This command administratively enables or disables egress engineering for the BGP. If enabled, peer node SIDs and peer adjacency SIDs are advertised in BGP-LS.

Optionsenable, disable
Default disable
Introduced21.7.R1

Platforms

All

enforce-first-as boolean
Synopsis Enforce the configured peer AS value in received routes
Contextconfigure router string bgp enforce-first-as boolean
Treeenforce-first-as

Description

When configured to true for an EBGP session, all routes received from an EBGP peer are checked to ensure that the most recent ASN in the AS_PATH attribute of each route matches the configured AS of the session. If there is not a match, the session is reset (if the update-fault-tolerance command in the error-handling context is set to false) or the session is left up but the route is treated as withdrawn (if update-fault-tolerance is set to true).

This command does not flap an established session because it applies only to routes received after the command is issued.

When configured to false, received routes are not checked for compliance with the rule.

Defaultfalse
Introduced16.0.R1

Platforms

All

error-handling
Synopsis Enter the error-handling context
Contextconfigure router string bgp error-handling
Treeerror-handling
Introduced16.0.R1

Platforms

All

legacy-mode boolean
Synopsis Enable legacy-mode of BGP error handling
Contextconfigure router string bgp error-handling legacy-mode boolean
Treelegacy-mode

Description

When configured to true, the BGP instance handles the BGP update error messages based on the configured update-fault-tolerance commands. If these commands are not explicitly configured, BGP error handling follows the legacy procedures described in RFC 4271, which can result in disruptive session resets.

When configured to false, the BGP instance ignores the configured update-fault-tolerance commands and applies the new error handling procedures described in RFC 7606 on all sessions.

Defaultfalse
Introduced24.3.R1

Platforms

All

update-fault-tolerance boolean
Synopsis Tolerate non-critical errors in UPDATE messages
Contextconfigure router string bgp error-handling update-fault-tolerance boolean
Treeupdate-fault-tolerance

Description

When configured to true, non-critical errors are handled with treat-as-withdraw, attribute-discard, and other non-disruptive approaches that do not cause a session reset. Critical errors still trigger a session reset.

When configured to false, most errors trigger a session reset.

Defaultfalse
Introduced16.0.R1

Platforms

All

export
Synopsis Enable the export context
Context configure router string bgp export
Treeexport

Description

Commands in this context specify route policies that control the handling of outbound routes transmitted to all peers. Route policies are configured in the configure policy-options context.

When no export policies are specified in this context, BGP-learned routes are advertised by default and non-BGP routes are not advertised.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis List of export policy names
Context configure router string bgp export policy (policy-expr-string | string)
Treepolicy

Description

This command specifies route policies that control the handling of outbound routes transmitted to certain peers.

Each object in this command is either a policy logical expression or the name of a single policy. The objects are evaluated in the specified order to determine the modifications of each route and the final action to accept or reject the route.

Only one of the objects referenced by the command can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

When no export policies are specified, BGP-learned routes are advertised by default and non-BGP routes are not advertised.

String Length1 to 255
Max. Instances15
Min. Instances1

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

extended-nh-encoding
Synopsis Enter the extended-nh-encoding context
Contextconfigure router string bgp extended-nh-encoding
Treeextended-nh-encoding

Description

Commands in this context specify the IPv4-related address families that can receive IPv6 next hops from peers. The peers should not send such routes unless the peers receive notification of this capability. If the router receives an enabled address family route from a peer to which it did not advertise the necessary capability, the UPDATE message will be considered malformed. This causes either a session reset or treat-as-withdraw behavior depending on the error handling settings.

Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Advertise encoding capability for IPv4 routes
Contextconfigure router string bgp extended-nh-encoding ipv4 boolean
Treeipv4
Defaultfalse
Introduced19.5.R1

Platforms

All

family
Synopsis Enter the family context
Context configure router string bgp family
Treefamily

Description

Commands in this context specify the BGP address families supported by the base router BGP sessions.

Introduced16.0.R1

Platforms

All

bgp-ls boolean
Synopsis Advertise MP-BGP support for the BGP-LS address family
Contextconfigure router string bgp family bgp-ls boolean
Treebgp-ls
Defaultfalse
Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise MP-BGP support for the EVPN address family
Contextconfigure router string bgp family evpn boolean
Treeevpn
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-ipv4 boolean
Synopsis Advertise support for the flowspec-IPv4 address family
Contextconfigure router string bgp family flow-ipv4 boolean
Treeflow-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-ipv6 boolean
Synopsis Advertise support for the flowspec-IPv6 address family
Contextconfigure router string bgp family flow-ipv6 boolean
Treeflow-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-vpn-ipv4 boolean
Synopsis Advertise support for FlowSpec-VPN IPv4 address family
Contextconfigure router string bgp family flow-vpn-ipv4 boolean
Treeflow-vpn-ipv4
Defaultfalse
Introduced22.7.R1

Platforms

All

flow-vpn-ipv6 boolean
Synopsis Advertise support for FlowSpec-VPN IPv6 address family
Contextconfigure router string bgp family flow-vpn-ipv6 boolean
Treeflow-vpn-ipv6
Defaultfalse
Introduced22.7.R1

Platforms

All

ipv4 boolean
Synopsis Advertise MP-BGP support for the IPv4 address family
Contextconfigure router string bgp family ipv4 boolean
Treeipv4
Defaulttrue
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Advertise MP-BGP support for the IPv6 address family
Contextconfigure router string bgp family ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

l2-vpn boolean
Synopsis Advertise MP-BGP support for the L2-VPN address family
Contextconfigure router string bgp family l2-vpn boolean
Treel2-vpn
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise support for the label-IPv4 address family
Contextconfigure router string bgp family label-ipv4 boolean
Treelabel-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise support for the label-IPv6 address family
Contextconfigure router string bgp family label-ipv6 boolean
Treelabel-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-ipv4 boolean
Synopsis Advertise support for the MCAST-IPv4 address family
Contextconfigure router string bgp family mcast-ipv4 boolean
Treemcast-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-ipv6 boolean
Synopsis Advertise support for the MCAST-IPv6 address family
Contextconfigure router string bgp family mcast-ipv6 boolean
Treemcast-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv4 boolean
Synopsis Advertise support for the IPv4 VPN MCAST address family
Contextconfigure router string bgp family mcast-vpn-ipv4 boolean
Treemcast-vpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv6 boolean
Synopsis Advertise support for the IPv6 VPN MCAST address family
Contextconfigure router string bgp family mcast-vpn-ipv6 boolean
Treemcast-vpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mdt-safi boolean
Synopsis Advertise MP-BGP support for MDT-SAFI address family
Contextconfigure router string bgp family mdt-safi boolean
Treemdt-safi
Defaultfalse
Introduced16.0.R1

Platforms

All

ms-pw boolean
Synopsis Advertise support for multi-segment PW address family
Contextconfigure router string bgp family ms-pw boolean
Treems-pw
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn-ipv4 boolean
Synopsis Advertise support for the IPv4 MCAST VPN address family
Contextconfigure router string bgp family mvpn-ipv4 boolean
Treemvpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn-ipv6 boolean
Synopsis Advertise support for the IPv6 MCAST VPN address family
Contextconfigure router string bgp family mvpn-ipv6 boolean
Treemvpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

route-target boolean
Synopsis Advertise MP-BGP support for RT constraint routes
Contextconfigure router string bgp family route-target boolean
Treeroute-target
Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-ipv4 boolean
Synopsis Advertise MP-BGP support for the SR-policy-IPv4 family
Contextconfigure router string bgp family sr-policy-ipv4 boolean
Treesr-policy-ipv4

Description

This command allows the router to advertise the capability for AFI1/SAFI73, which corresponds to BGP routes that encode a segment routing policy to an IPv4 destination. 

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-ipv6 boolean
Synopsis Advertise MP-BGP support for the SR-policy-IPv6 family
Contextconfigure router string bgp family sr-policy-ipv6 boolean
Treesr-policy-ipv6

Description

This command allows the router to advertise the capability for AFI2/SAFI73, which corresponds to BGP routes that encode a segment routing policy to an IPv6 destination. 

Defaultfalse
Introduced19.10.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise MP-BGP support for IPv4 VPN address family
Contextconfigure router string bgp family vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise MP-BGP support for IPv6 VPN address family
Contextconfigure router string bgp family vpn-ipv6 boolean
Treevpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

fast-external-failover boolean
Synopsis Drop external BGP session immediately when link fails
Contextconfigure router string bgp fast-external-failover boolean
Treefast-external-failover

Description

When configured to true, the router drops an external BGP session to a single-hop neighbor immediately when the local interface goes down.

When configured to false, the BGP session remains up until the hold time expires.

Defaulttrue
Introduced16.0.R1

Platforms

All

flowspec
Synopsis Enter the flowspec context
Context configure router string bgp flowspec
Treeflowspec
Introduced16.0.R1

Platforms

All

validate-dest-prefix boolean
Synopsis Validate destination prefix in FlowSpec-IPv4/IPv6 route
Contextconfigure router string bgp flowspec validate-dest-prefix boolean
Treevalidate-dest-prefix

Description

When configured to true, this command enables validation of received IPv4 and IPv6 FlowSpec routes that contain a destination-prefix subcomponent.

A FlowSpec route with a destination-prefix subcomponent is considered invalid if both of the following are true:

  • it was originated outside the local AS of the receiving BGP router

  • the neighbor AS of the FlowSpec route does not match the neighbor AS of the best match BGP (unicast) route for the destination prefix or the neighbor AS of any longer match BGP (unicast) route for the destination prefix

An invalid route is retained in the BGP but it is not used for filtering traffic or propagated to other BGP routers.

When configured to false, destination-prefix validation is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

validate-redirect-ip boolean
Synopsis Validate the redirect-to-IPv4 action in FlowSpec route
Contextconfigure router string bgp flowspec validate-redirect-ip boolean
Treevalidate-redirect-ip

Description

When configured to true, this command enables procedures to validate the redirect-to-IPv4 action attached to FlowSpec-IPv4 routes that are received by the BGP instance.

A FlowSpec-IPv4 route is considered invalid and is not installed as a filter rule if the FlowSpec-IPv4 route is deemed to have originated from a different AS than the IP route that resolves the redirection IPv4 address. The originating AS of a FlowSpec route is determined from its AS path.

When configured to false, the validation check is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

graceful-restart
Synopsis Enable the graceful-restart context
Contextconfigure router string bgp graceful-restart
Treegraceful-restart

Description

Commands in this context configure BGP graceful restart helper procedures for address families included in the GR capabilities of both peers.

Introduced16.0.R1

Platforms

All

gr-notification boolean
Synopsis Perform Graceful Restart procedures
Context configure router string bgp graceful-restart gr-notification boolean
Treegr-notification

Description

When configured to true, the Graceful Restart capability sent by the router indicates support for NOTIFICATION messages. If the peer also supports this capability, the session is restarted gracefully (while preserving forwarding) if either peer sends a NOTIFICATION message due to some type of event or error.

When configured to false, NOTIFICATION messages are not supported.

Defaultfalse
Introduced16.0.R1

Platforms

All

long-lived
Synopsis Enable the long-lived context
Context configure router string bgp graceful-restart long-lived
Treelong-lived

Description

Commands in this context configure the BGP Long-Lived Graceful-Restart (LLGR) procedures.

LLGR, known informally as BGP persistence, is an extension of BGP GR that allows a session to stay down for a longer period of time. During this time, learned routes are marked and re-advertised as stale but they can continue to be used as routes of last resort.

The LLGR handling of a session failure can be invoked immediately or it can be delayed until the end of the traditional GR restart window.

Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp graceful-restart long-lived family keyword
Treefamily
Introduced16.0.R1

Platforms

All

[family-type] keyword
Synopsis Family type for family-specific LLGR configuration
Contextconfigure router string bgp graceful-restart long-lived family keyword
Treefamily
Optionsipv4, vpn-ipv4, ipv6, vpn-ipv6, l2-vpn, flow-ipv4, route-target, flow-ipv6, label-ipv4, label-ipv6, flow-vpn-ipv4, flow-vpn-ipv6

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

forwarding-bits-set keyword
Synopsis BGP LLGR forwarding-bit behavior for address family
Contextconfigure router string bgp graceful-restart long-lived forwarding-bits-set keyword
Treeforwarding-bits-set

Description

This command determines the setting of the F bit in the GR and LLGR capabilities advertised by the router. When the F bit is set for an address family, it indicates that the advertising router is able to preserve forwarding state for the routes of that address family across the last restart. When the session is re-established after a restart and the F bit is not set, all stale routes from the peer are immediately removed for the corresponding address family.

This command allows the F bit to be set for all address families or only for non-forwarding address families (L2-VPN, route target, flow-IPv4, and flow-IPv6).

Optionsnone, all, non-fwd
Defaultnone
Introduced16.0.R1

Platforms

All

helper-override-restart-time number
Synopsis Locally-configured override for restart time
Contextconfigure router string bgp graceful-restart long-lived helper-override-restart-time number
Treehelper-override-restart-time

Description

This command overrides the restart time advertised by a peer (in its GR capability) with a locally-configured value. This override applies only to AFI/SAFI that were included in the GR capability of the peer. The restart-time is always zero for AFI/SAFI not included in the GR capability. This command is useful if the local router wants to force the LLGR phase to begin after a set time for all protected AFI/SAFI.

Range0 to 4095
Introduced16.0.R1

Platforms

All

helper-override-stale-time number
Synopsis Locally-configured stale routes override time
Contextconfigure router string bgp graceful-restart long-lived helper-override-stale-time number
Treehelper-override-stale-time

Description

This command configures a locally-imposed LLGR stale time that overrides the long-lived stale routes time that is advertised by the router in its LLGR capability.

This command applies to all AFI/SAFI in the advertised LLGR capability except for any AFI/SAFI with a family-specific override.

Range0 to 16777215
Introduced16.0.R1

Platforms

All

without-no-export boolean
Synopsis Advertise LLGR stale routes to non-LLGR peers
Contextconfigure router string bgp graceful-restart long-lived without-no-export boolean
Treewithout-no-export

Description

When configured to true, LLGR stale routes can be advertised to any peer (EBGP or IBGP) that did not signal the LLGR capability. For IBGP and confederation-EBGP peers that did not advertise the LLGR capability, the local preference attribute in the advertised stale routes is automatically set to 0.

When configured to false, LLGR stale routes are not advertised to any EBGP peer that did not signal the LLGR capability. For IBGP and confederation-EBGP peers that did not advertise the LLGR capability, the local preference attribute in the advertised stale routes is automatically set to 0 and a NO_EXPORT standard community is automatically added to the routes.

Defaultfalse
Introduced16.0.R1

Platforms

All

group [group-name] string
Synopsis Enter the group list instance
Context configure router string bgp group string
Treegroup

Description

Commands in this context define BGP peer groups and their group-specific command options. The options in this context are identical to the global BGP options. Any options that are not overridden by the group-specific commands inherit the configuration settings from the BGP global level.

Introduced16.0.R1

Platforms

All

[group-name] string
Synopsis BGP peer group name
Context configure router string bgp group string
Treegroup
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

add-paths
Synopsis Enable the add-paths context
Context configure router string bgp group string add-paths
Treeadd-paths

Description

Commands in this context allow the add-paths node to be configured for the specified families for configuration of the BGP group or neighbor. The BGP add-paths capability allows the router to send or receive multiple paths per prefix to and from a peer.

When unconfigured, command settings are inherited from a higher level BGP configuration.

Introduced16.0.R1

Platforms

All

evpn
Synopsis Enter the evpn context
Context configure router string bgp group string add-paths evpn
Treeevpn

Description

Commands in this context configure the add-paths capability for EVPN routes. By default, add-paths is not enabled for EVPN routes.

Introduced21.10.R1

Platforms

All

receive boolean
Synopsis Receive multiple EVPN paths per prefix from a peer
Contextconfigure router string bgp group string add-paths evpn receive boolean
Treereceive
Defaultfalse
Introduced21.10.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per EVPN prefix to Add-Path peers
Contextconfigure router string bgp group string add-paths evpn send (number | keyword)
Treesend
Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced21.10.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string bgp group string add-paths ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv4 prefix
Contextconfigure router string bgp group string add-paths ipv4 receive boolean
Treereceive

Description

When configured to true, the router can receive multiple unlabeled IPv4 unicast routes per prefix from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per unlabeled IPv4 unicast prefix
Contextconfigure router string bgp group string add-paths ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths per unlabeled IPv4 unicast prefix that are allowed to be advertised to ADD-PATH peers. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for unlabeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string bgp group string add-paths ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per IPv6 prefix
Contextconfigure router string bgp group string add-paths ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple unlabeled IPv6 unicast routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per unlabeled IPv6 unicast prefix
Contextconfigure router string bgp group string add-paths ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths per unlabeled IPv4 unicast prefix that are allowed to be advertised to ADD-PATH peers. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for unlabeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

label-ipv4
Synopsis Enter the label-ipv4 context
Context configure router string bgp group string add-paths label-ipv4
Treelabel-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv4 prefix
Contextconfigure router string bgp group string add-paths label-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple labeled-unicast routes per IPv4 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per labeled IPv4 unicast prefix
Contextconfigure router string bgp group string add-paths label-ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per labeled IPv4 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for labeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

label-ipv6
Synopsis Enter the label-ipv6 context
Context configure router string bgp group string add-paths label-ipv6
Treelabel-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv6 prefix
Contextconfigure router string bgp group string add-paths label-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple labeled-unicast routes per IPv6 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per labeled IPv6 unicast prefix
Contextconfigure router string bgp group string add-paths label-ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per labeled IPv6 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for labeled IPv6 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

mcast-vpn-ipv4
Synopsis Enter the mcast-vpn-ipv4 context
Contextconfigure router string bgp group string add-paths mcast-vpn-ipv4
Treemcast-vpn-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast routes per IPv4 VPN prefix
Contextconfigure router string bgp group string add-paths mcast-vpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast routes per IPv4 VPN prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast IPv4 VPN prefix
Contextconfigure router string bgp group string add-paths mcast-vpn-ipv4 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast IPv4 VPN prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast IPv4 VPN routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv6
Synopsis Enter the mcast-vpn-ipv6 context
Contextconfigure router string bgp group string add-paths mcast-vpn-ipv6
Treemcast-vpn-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast routes per IPv6 VPN prefix
Contextconfigure router string bgp group string add-paths mcast-vpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast routes per IPv6 VPN prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast IPv6 VPN prefix
Contextconfigure router string bgp group string add-paths mcast-vpn-ipv6 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast IPv6 VPN prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast IPv6 VPN routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mvpn-ipv4
Synopsis Enter the mvpn-ipv4 context
Context configure router string bgp group string add-paths mvpn-ipv4
Treemvpn-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast VPN routes per IPv4 prefix
Contextconfigure router string bgp group string add-paths mvpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast VPN routes per IPv4 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast VPN IPv4 prefix
Contextconfigure router string bgp group string add-paths mvpn-ipv4 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast VPN IPv4 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast VPN IPv4 routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mvpn-ipv6
Synopsis Enter the mvpn-ipv6 context
Context configure router string bgp group string add-paths mvpn-ipv6
Treemvpn-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast VPN routes per IPv6 prefix
Contextconfigure router string bgp group string add-paths mvpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast VPN routes per IPv6 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast VPN IPv6 prefix
Contextconfigure router string bgp group string add-paths mvpn-ipv6 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast VPN IPv6 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast VPN IPv6 routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

vpn-ipv4
Synopsis Enter the vpn-ipv4 context
Context configure router string bgp group string add-paths vpn-ipv4
Treevpn-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per VPN-IPv4 prefix
Contextconfigure router string bgp group string add-paths vpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple VPN-IPv4 routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per VPN-IPv4 prefix
Context configure router string bgp group string add-paths vpn-ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per VPN-IPv4 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for VPN-IPv4 routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

vpn-ipv6
Synopsis Enter the vpn-ipv6 context
Context configure router string bgp group string add-paths vpn-ipv6
Treevpn-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per VPN-IPv6 prefix
Contextconfigure router string bgp group string add-paths vpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple VPN-IPv6 routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per VPN-IPv6 prefix
Context configure router string bgp group string add-paths vpn-ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per VPN-IPv6 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for VPN-IPv6 routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the BGP group
Contextconfigure router string bgp group string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

advertise-inactive boolean
Synopsis Advertise an inactive BGP route to peers
Contextconfigure router string bgp group string advertise-inactive boolean
Treeadvertise-inactive

Description

When configured to true, this command allows an inactive BGP route to be advertised, even though it is not the most preferred route. The effect of the command on advertised unlabeled, labeled, and multicast IPv4 and IPv6 routes depends on several factors.

  • If the active route for the IP prefix is a BGP route, that route is advertised.

  • If the active route is a non-BGP route and there are valid inactive BGP routes to the same destination, the best valid inactive route is advertised unless the active non-BGP route is matched and accepted by an export policy applied to the session.

  • If the active route is a non-BGP route and there are no valid BGP routes to the same destination, no route is advertised unless the active non-BGP route is matched and accepted by an export policy applied to the session.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the advertisement of inactive BGP routes to other BGP peers is disabled.

Introduced16.0.R1

Platforms

All

advertise-ipv6-next-hops
Synopsis Enable the advertise-ipv6-next-hops context
Contextconfigure router string bgp group string advertise-ipv6-next-hops
Treeadvertise-ipv6-next-hops

Description

Commands in this context allow specified IP family routes to be advertised to IPv6 transport peers with a true IPv6 address when originated or when a configured or automatic next-hop-self action is applied.

When unconfigured, command settings are inherited from a higher level BGP configuration.

Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise EVPN route with IPv6 next-hop address
Contextconfigure router string bgp group string advertise-ipv6-next-hops evpn boolean
Treeevpn

Description

When configured to true, EVPN routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, EVPN routes are advertised with IPv4 next-hop addresses to IPv6 transport peers.

Defaultfalse
Introduced19.5.R1

Platforms

All

ipv4 boolean
Synopsis Advertise IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp group string advertise-ipv6-next-hops ipv4 boolean
Treeipv4

Description

When configured to true, IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, IPv4 routes are advertised with IPv4 next-hop addresses to IPv6 transport peers. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced19.5.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise label IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp group string advertise-ipv6-next-hops label-ipv4 boolean
Treelabel-ipv4

Description

When configured to true, label IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, label IPv4 routes are advertised with the system IPv4 address as the next hop to IPv6 transport peers. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise label IPv6 route with IPv6 next-hop address
Contextconfigure router string bgp group string advertise-ipv6-next-hops label-ipv6 boolean
Treelabel-ipv6

Description

When configured to true, label IPv6 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, label IPv6 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop, encoded as an IPv4-mapped IPv6 address.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise VPN IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp group string advertise-ipv6-next-hops vpn-ipv4 boolean
Treevpn-ipv4

Description

When configured to true, VPN IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, VPN IPv4 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise VPN IPv6 route with IPv6 next-hop address
Contextconfigure router string bgp group string advertise-ipv6-next-hops vpn-ipv6 boolean
Treevpn-ipv6

Description

When configured to true, VPN IPv6 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, VPN IPv6 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop, encoded as an IPv4-mapped IPv6 address.

Defaultfalse
Introduced16.0.R1

Platforms

All

aigp boolean
Synopsis Add AIGP attribute to advertised routes
Contextconfigure router string bgp group string aigp boolean
Treeaigp

Description

When configured to true, this command enables Accumulated IGP (AIGP) path attribute support with one or more BGP peers. BGP path selection among routes with an associated AIGP metric is based on the end-to-end IGP metrics of the different BGP paths, even when these BGP paths span more than one AS and IGP instance.

When configured to false, the AIGP attribute is removed from advertised routes, if present, and is ignored in received routes.

Defaultfalse
Introduced16.0.R1

Platforms

All

as-override boolean
Synopsis Replace the peer ASN with the local ASN in AS Path
Contextconfigure router string bgp group string as-override boolean
Treeas-override

Description

When configured to true, the advertising router's local AS replaces all occurrences of the peer AS in the AS_PATH attribute.

This command should be used with caution, as it breaks BGP's loop detection mechanism.

When configured to false, no AS override is performed.

Defaultfalse
Introduced19.7.R1

Platforms

All

asn-4-byte boolean
Synopsis Advertise the use of 4-byte ASNs
Context configure router string bgp group string asn-4-byte boolean
Treeasn-4-byte

Description

When this command inherits a value of true, the use of 4-byte ASNs is supported.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to true.

When configured to false, this command disables the use of 4-byte ASNs.

Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis BGP authentication key for peers in the group
Contextconfigure router string bgp group string authentication-key string
Treeauthentication-key

Description

This command configures the authentication key that must be configured on both peers. The stored format of the authentication key is based on the configure system security hash-control management-interface md-cli hash-algorithm setting.

String Length1 to 370
Introduced16.0.R1

Platforms

All

authentication-keychain reference
Synopsis TCP authentication keychain for the session
Contextconfigure router string bgp group string authentication-keychain reference
Treeauthentication-keychain

Description

This command associates the keychain to be used to authenticate the BGP session. The keychain allows the rollover of authentication keys during the lifetime of a session.

Reference

configure system security keychains keychain string

Introduced16.0.R3

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD
Contextconfigure router string bgp group string bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, BFD is enabled on a given protocol interface where the state of the protocol interface is tied to the state of the BFD session between the local node and the remote node.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, BFD is removed from the associated protocol adjacency.

Introduced16.0.R1

Platforms

All

bfd-strict-mode
Synopsis Enter the bfd-strict-mode context
Contextconfigure router string bgp group string bfd-strict-mode
Treebfd-strict-mode
Introduced23.7.R1

Platforms

All

advertise
Synopsis Enable the advertise context
Context configure router string bgp group string bfd-strict-mode advertise
Treeadvertise

Description

Commands in this context configure BGP to advertise the Strict-BFD capability to peers that are within scope of this command and meet the following requirements:

  • The inherited or configured value for the bfd-liveness command that applies to the peer is true.

  • The interface associated with the peer has a valid BFD configuration.

When the preceding conditions are satisfied and two peers attempting to form a session both advertise the Strict-BFD capability, the BGP finite state machine in each router transitions the session state to established after the BFD session with the peer enters the up state.

When unconfigured, BGP does not advertise the Strict-BFD capability to peers.

Introduced23.7.R1

Platforms

All

holdtime number
Synopsis Maximum time BGP waits for the BFD session to come up
Contextconfigure router string bgp group string bfd-strict-mode advertise holdtime number
Treeholdtime

Description

This command configures the maximum time BGP waits for the BFD session to come up, provided that the Strict-BFD procedures apply to a session, and the negotiated BGP hold time is zero (no keepalives). If the negotiated BGP hold time is greater than zero, the advertised hold time is not considered.

Range1 to 65535
Unitsseconds
Default 30
Introduced23.7.R1

Platforms

All

next-hop-reachability boolean
Synopsis Consider next hop unreachable if BFD session is down
Contextconfigure router string bgp group string bfd-strict-mode next-hop-reachability boolean
Treenext-hop-reachability

Description

When configured to true, the router considers next-hop self routes belonging to specific address families received from a peer within scope of this command as having an unresolved next hop, provided that the following requirements are met:

  • The BFD session to the peer is in a down state.

  • There is a valid interface BFD configuration that applies to the peer.

  • There is a valid BFD liveness configuration that applies to the peer.

The unresolved state is maintained until the BFD session state changes to up or administratively down, even if there is a resolving route or tunnel that matches the BGP next-hop address.

Routes received from one peer with a BGP next-hop address equal to the address of another peer are not affected by the BFD session to the other peer.

The behavior of the router when this command is true does not depend on whether Strict-BFD is used, as both features are independent.

Configuring this command to true only affects routes belonging to the following address families:

  • IPv4

  • IPv6

  • IPv4 VPN

  • IPv6 VPN

  • labeled unicast IPv4

  • labeled unicast IPv6

  • EVPN

  • IPv4 multicast

  • IPv6 multicast

  • IPv4 VPN multicast

  • IPv6 VPN multicast

When configured to false, the router does not consider next-hop self routes belonging to the preceding address families as having an unresolved next hop if the BFD session goes down.

Introduced23.7.R1

Platforms

All

block-prefix-sid boolean
Synopsis Block the prefix SID attribute
Context configure router string bgp group string block-prefix-sid boolean
Treeblock-prefix-sid

Description

When configured to true, all prefix SID attributes are removed from all routes exchanged between EBGP and IBGP peers covered by the scope of the command. Locally-imposed prefix SID attributes are also removed.

When configured to false, all prefix SID attributes are propagated without restriction.

A change of this configuration causes the affected BGP sessions to flap.

Defaultfalse
Introduced19.10.R1

Platforms

All

capability-negotiation boolean
Synopsis Enable capability negotiation
Context configure router string bgp group string capability-negotiation boolean
Treecapability-negotiation

Description

When configured to true, this command enables the exchange of capabilities.

When configured to false and the peering is flapped, new capabilities are not negotiated and strictly IPv4 exchanges are supported with the peer.

Defaulttrue
Introduced16.0.R1

Platforms

All

client-reflect boolean
Synopsis Allow cluster RR to advertise routes to its clients
Contextconfigure router string bgp group string client-reflect boolean
Treeclient-reflect

Description

When unconfigured, this command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to true.

When the command inherits a value of true, client reflection of routes is enabled.

When configured to false, this command disables client reflection of routes.

Introduced16.0.R1

Platforms

All

cluster
Synopsis Enter the cluster context
Context configure router string bgp group string cluster
Treecluster
Introduced16.0.R1

Platforms

All

allow-local-fallback boolean
Synopsis Allow fallback to RR topology location
Contextconfigure router string bgp group string cluster allow-local-fallback boolean
Treeallow-local-fallback

Description

When configured to true, this command allows the RR to advertise the best BGP path from its own topology location when there are no reachable routes from the client's ORR location. The ORR location must be specified before this command can be set to true.

When configured to false, no route is advertised to the client.

Defaultfalse
Introduced16.0.R1

Platforms

All

orr-location number
Synopsis Optimal route reflection location for the cluster
Contextconfigure router string bgp group string cluster orr-location number
Treeorr-location

Description

This command configures an ORR location ID. If a cluster ID is also specified, the clients in that cluster receive routes optimal for that specific location.

With optimal route reflection, the best path advertised to a client takes location ID into account. If the tie-break for best path (or Add-Paths) comes down to next-hop IGP cost, the IGP costs are calculated relative to the specified location. In the SR OS implementation, the IGP costs from arbitrary ORR locations are calculated using OSPF, OSPFv3, IS-IS, or BGP-LS information in the TE DB.

Range1 to 255
Introduced16.0.R1

Platforms

All

damp-peer-oscillations
Synopsis Enable the damp-peer-oscillations context
Contextconfigure router string bgp group string damp-peer-oscillations
Treedamp-peer-oscillations

Description

Commands in this context specify how long a BGP peer session remains in the idle state after an error causes the session to reset. In the idle state, BGP does not initiate or respond to attempts to establish a new session. Repeated errors that occur a short time after each session reset cause longer and longer hold times in the idle state.

When unconfigured, command settings are inherited from the global-level configuration.

Introduced16.0.R1

Platforms

All

error-interval number
Synopsis Time after a reset that the session must be error-free
Contextconfigure router string bgp group string damp-peer-oscillations error-interval number
Treeerror-interval

Description

This command sets the interval of time after a reset, during which the session must be error-free in order to reset the penalty counter and return the idle hold time to the initial wait time.

Range0 to 2048
Default30
Introduced 16.0.R1

Platforms

All

idle-hold-time
Synopsis Enter the idle-hold-time context
Contextconfigure router string bgp group string damp-peer-oscillations idle-hold-time
Treeidle-hold-time
Introduced16.0.R1

Platforms

All

second-wait number
Synopsis Time that doubles after each repeated session failure
Contextconfigure router string bgp group string damp-peer-oscillations idle-hold-time second-wait number
Treesecond-wait

Description

This command defines the hold time that doubles after each repeated session failure that occurs in a short span of time.

Range1 to 2048
Default5
Introduced 16.0.R1

Platforms

All

damping boolean
Synopsis Use BGP route damping to reduce route flap
Contextconfigure router string bgp group string damping boolean
Treedamping
Introduced16.0.R1

Platforms

All

def-recv-evpn-encap keyword
Synopsis Default EVPN encapsulation type
Context configure router string bgp group string def-recv-evpn-encap keyword
Treedef-recv-evpn-encap

Description

This command specifies the encapsulation type that BGP uses when an EVPN route is received without the Encapsulation Extended Community.

When unconfigured, the setting for this command is inherited from the BGP global-level configuration.

Optionsmpls, vxlan
Introduced 16.0.R1

Platforms

All

default-label-preference
Synopsis Enter the default-label-preference context
Contextconfigure router string bgp group string default-label-preference
Treedefault-label-preference
Introduced19.5.R1

Platforms

All

default-preference
Synopsis Enter the default-preference context
Contextconfigure router string bgp group string default-preference
Treedefault-preference
Introduced19.5.R1

Platforms

All

default-route-target boolean
Synopsis Send default RTC route (zero prefix length) to peers
Contextconfigure router string bgp group string default-route-target boolean
Treedefault-route-target

Description

When configured to true, this command sends the default RTC route (zero prefix length) toward the selected peers.

When configured to false, a default RTC route is not sent.

Defaultfalse
Introduced16.0.R1

Platforms

All

description string
Synopsis Text description
Context configure router string bgp group string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

All

dynamic-neighbor
Synopsis Enter the dynamic-neighbor context
Contextconfigure router string bgp group string dynamic-neighbor
Treedynamic-neighbor

Description

Commands in this context configure dynamic BGP sessions for a peer group.

Introduced16.0.R1

Platforms

All

interface [interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string bgp group string dynamic-neighbor interface string
Treeinterface

Description

Commands in this context configure an unnumbered base router network interface for dynamic neighbors.

If this interface connects to a network with other BGP routers, sessions with the other routers can be set up automatically without explicitly configuring them as BGP neighbors. The interface must be IPv6 enabled, but because the interface is considered unnumbered, it does not require an IPv4 address or a global-unicast IPv6 address. The sessions are set up using IPv6 link-local addresses.

The BGP unnumbered feature supports all address families that allow IPv6 link-local BGP next-hop addresses. This includes IPv4 with the use of RFC 8950 extensions.

When an interface is added to the list of dynamic-neighbor interfaces, an outgoing connection attempt is initiated toward any directly connected router on the interface that announces itself using an ICMPv6 router advertisement message. The session attempt is unsuccessful if the peer type is not EBGP, the reported AS number of the peer does not match one of the allowed values, or the maximum session limit of the interface would be exceeded.

Introduced22.10.R1

Platforms

All

[interface-name] string
Synopsis Name of the dynamic neighbor interface
Contextconfigure router string bgp group string dynamic-neighbor interface string
Treeinterface
String Length1 to 32

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

All

allowed-peer-as string
Synopsis Allowed peer AS value or range of acceptable values
Contextconfigure router string bgp group string dynamic-neighbor interface string allowed-peer-as string
Treeallowed-peer-as

Description

This command specifies a singular allowed peer AS value or a range of acceptable values in the format n1..n2.

All values greater than or equal to n1 and less than or equal to n2 are acceptable. For example, if the acceptable peer AS numbers are 65001 to 65005 (range) and 62100 (singular value), configure this command to use a value of [65001..65005 62100].

Max. Instances32

Notes

This element is ordered by the user.

Introduced22.10.R1

Platforms

All

max-sessions number
Synopsis Maximum number of dynamic sessions allowed
Contextconfigure router string bgp group string dynamic-neighbor interface string max-sessions number
Treemax-sessions

Description

This command specifies the maximum number of dynamic sessions that are allowed to be set up on the interface as a result of accepting sessions from link-local addresses or initiating sessions by receiving IPv6 router advertisements.

Range1 to 255
Default1
Introduced 22.10.R1

Platforms

All

match
Synopsis Enter the match context
Context configure router string bgp group string dynamic-neighbor match
Treematch

Description

Commands in this context configure match conditions for the dynamic neighbors.

Introduced19.5.R1

Platforms

All

prefix [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the prefix list instance
Contextconfigure router string bgp group string dynamic-neighbor match prefix (ipv4-prefix | ipv6-prefix)
Treeprefix
Introduced19.5.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Dynamic peer prefix for the group
Context configure router string bgp group string dynamic-neighbor match prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

allowed-peer-as string
Synopsis Allowed peer AS value or range of acceptable values
Contextconfigure router string bgp group string dynamic-neighbor match prefix (ipv4-prefix | ipv6-prefix) allowed-peer-as string
Treeallowed-peer-as

Description

This command specifies a singular allowed peer AS value or a range of acceptable values in the format n1..n2.

All values greater than or equal to n1 and less than or equal to n2 are acceptable. For example, if the acceptable peer AS numbers are 65001 to 65005 (range) and 62100 (singular value), configure this command to use a value of [65001..65005 62100].

Max. Instances32

Notes

This element is ordered by the user.

Introduced19.5.R1

Platforms

All

dynamic-neighbor-limit number
Synopsis Maximum dynamic BGP sessions to accept from remote peer
Contextconfigure router string bgp group string dynamic-neighbor-limit number
Treedynamic-neighbor-limit

Description

This command configures the maximum number of dynamic BGP sessions that are accepted from remote peers associated with a specific peer group. If accepting a new dynamic session causes the group limit to be exceeded, the new session attempt is rejected and a Notification message is sent back to the remote peer.

When unconfigured, the setting is inherited from the BGP global-level configuration.

Range1 to 8192
Introduced16.0.R1

Platforms

All

ebgp-default-reject-policy
Synopsis Enable the ebgp-default-reject-policy context
Contextconfigure router string bgp group string ebgp-default-reject-policy
Treeebgp-default-reject-policy
Introduced19.5.R1

Platforms

All

egress-engineering
Synopsis Enable the egress-engineering context
Contextconfigure router string bgp group string egress-engineering
Treeegress-engineering
Introduced21.7.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BGP egress engineering
Contextconfigure router string bgp group string egress-engineering admin-state keyword
Treeadmin-state

Description

This command administratively enables or disables egress engineering for the BGP. If enabled, peer node SIDs and peer adjacency SIDs are advertised in BGP-LS.

Optionsenable, disable
Default disable
Introduced21.7.R1

Platforms

All

egress-peer-engineering-label-unicast boolean
Synopsis Generate EPE label-unicast routes for group
Contextconfigure router string bgp group string egress-peer-engineering-label-unicast boolean
Treeegress-peer-engineering-label-unicast

Description

When configured to true, BGP generates a label-unicast route for each /32 or /128 prefix that corresponds to the BGP group address in the scope of the command. These routes can be advertised to other routers to recursively resolve unlabeled BGP routes for AS external destinations. They support the Egress Peer Engineering (EPE) use case.

Defaultfalse
Introduced22.2.R1

Platforms

All

error-handling
Synopsis Enter the error-handling context
Contextconfigure router string bgp group string error-handling
Treeerror-handling
Introduced16.0.R1

Platforms

All

update-fault-tolerance boolean
Synopsis Tolerate non-critical errors in UPDATE messages
Contextconfigure router string bgp group string error-handling update-fault-tolerance boolean
Treeupdate-fault-tolerance

Description

When configured to true, non-critical errors are handled with treat-as-withdraw, attribute-discard, and other non-disruptive approaches that do not cause a session reset. Critical errors still trigger a session reset.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, all errors trigger a session reset.

Introduced16.0.R1

Platforms

All

export
Synopsis Enable the export context
Context configure router string bgp group string export
Treeexport

Description

Commands in this context specify route policies that control the handling of outbound routes transmitted to certain peers. Route policies are configured in the configure policy-options context.

When this context is unconfigured, the policy association for the group is inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis BGP export policy name
Context configure router string bgp group string export policy (policy-expr-string | string)
Treepolicy

Description

This command specifies route policies that control the handling of outbound routes transmitted to certain peers.

Each object in this command is either a policy logical expression or the name of a single policy. The objects are evaluated in the specified order to determine the modifications of each route and the final action to accept or reject the route.

Only one of the objects referenced by the command can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or"start@variable@".

String Length1 to 255
Max. Instances15
Min. Instances1

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

extended-nh-encoding
Synopsis Enable the extended-nh-encoding context
Contextconfigure router string bgp group string extended-nh-encoding
Treeextended-nh-encoding

Description

Commands in this context specify the address families enabled to advertise the capability to receive label IPv4 routes, VPN IPv4 routes, or IPv6 next hops from peers. The peers should not send such routes unless notification has been received of this capability. If the router receives an enabled address family route from a peer to which it did not advertise the necessary capability, the UPDATE message will be considered malformed. This causes either a session reset or treat-as-withdraw behavior depending on the error handling settings.

When the context is unconfigured, command settings are inherited from the higher level BGP configuration.

Introduced16.0.R1

Platforms

All

family
Synopsis Enable the family context
Context configure router string bgp group string family
Treefamily
Introduced16.0.R1

Platforms

All

bgp-ls boolean
Synopsis Advertise MP-BGP support for the BGP-LS address family
Contextconfigure router string bgp group string family bgp-ls boolean
Treebgp-ls
Defaultfalse
Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise MP-BGP support for the EVPN address family
Contextconfigure router string bgp group string family evpn boolean
Treeevpn
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-ipv4 boolean
Synopsis Advertise support for the flowspec-IPv4 address family
Contextconfigure router string bgp group string family flow-ipv4 boolean
Treeflow-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-ipv6 boolean
Synopsis Advertise support for the flowspec-IPv6 address family
Contextconfigure router string bgp group string family flow-ipv6 boolean
Treeflow-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Add support for the IPv4 address family
Contextconfigure router string bgp group string family ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Advertise MP-BGP support for the IPv6 address family
Contextconfigure router string bgp group string family ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

l2-vpn boolean
Synopsis Advertise MP-BGP support for the L2-VPN address family
Contextconfigure router string bgp group string family l2-vpn boolean
Treel2-vpn
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise support for the label-IPv4 address family
Contextconfigure router string bgp group string family label-ipv4 boolean
Treelabel-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise support for the label-IPv6 address family
Contextconfigure router string bgp group string family label-ipv6 boolean
Treelabel-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-ipv4 boolean
Synopsis Advertise support for the MCAST-IPv4 address family
Contextconfigure router string bgp group string family mcast-ipv4 boolean
Treemcast-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-ipv6 boolean
Synopsis Advertise support for the MCAST-IPv6 address family
Contextconfigure router string bgp group string family mcast-ipv6 boolean
Treemcast-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mdt-safi boolean
Synopsis Advertise MP-BGP support for MDT-SAFI address family
Contextconfigure router string bgp group string family mdt-safi boolean
Treemdt-safi
Defaultfalse
Introduced16.0.R1

Platforms

All

ms-pw boolean
Synopsis Advertise support for multi-segment PW address family
Contextconfigure router string bgp group string family ms-pw boolean
Treems-pw
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn-ipv4 boolean
Synopsis Advertise support for the IPv4 MCAST VPN address family
Contextconfigure router string bgp group string family mvpn-ipv4 boolean
Treemvpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn-ipv6 boolean
Synopsis Advertise support for the IPv6 MCAST VPN address family
Contextconfigure router string bgp group string family mvpn-ipv6 boolean
Treemvpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-ipv4 boolean
Synopsis Advertise MP-BGP support for the SR-policy-IPv4 family
Contextconfigure router string bgp group string family sr-policy-ipv4 boolean
Treesr-policy-ipv4

Description

This command allows the router to advertise the capability for AFI1/SAFI73, which corresponds to BGP routes that encode a segment routing policy to an IPv4 destination. 

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-ipv6 boolean
Synopsis Advertise MP-BGP support for the SR-policy-IPv6 family
Contextconfigure router string bgp group string family sr-policy-ipv6 boolean
Treesr-policy-ipv6

Description

This command allows the router to advertise the capability for AFI2/SAFI73, which corresponds to BGP routes that encode a segment routing policy to an IPv6 destination. 

Defaultfalse
Introduced19.10.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise MP-BGP support for IPv4 VPN address family
Contextconfigure router string bgp group string family vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise MP-BGP support for IPv6 VPN address family
Contextconfigure router string bgp group string family vpn-ipv6 boolean
Treevpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

fast-external-failover boolean
Synopsis Drop external BGP session immediately when link fails
Contextconfigure router string bgp group string fast-external-failover boolean
Treefast-external-failover

Description

When this command inherits a value of true, the router drops an external BGP session on a single-hop route immediately when the local interface goes down.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to true.

When configured to false, the BGP session remains up until the hold time expires.

Introduced16.0.R1

Platforms

All

graceful-restart
Synopsis Enable the graceful-restart context
Contextconfigure router string bgp group string graceful-restart
Treegraceful-restart

Description

Commands in this context configure BGP graceful restart helper procedures for address families included in the GR capabilities of both peers.

When the context is unconfigured, the command settings are inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

gr-notification boolean
Synopsis Perform graceful restart procedures after NOTIFICATION
Contextconfigure router string bgp group string graceful-restart gr-notification boolean
Treegr-notification

Description

When configured to true, the Graceful Restart capability sent by the router indicates support for NOTIFICATION messages. If the peer also supports this capability, the session is restarted gracefully (while preserving forwarding) if either peer sends a NOTIFICATION message due to some type of event or error.

When configured to false, NOTIFICATION messages are not supported.

Defaultfalse
Introduced16.0.R1

Platforms

All

long-lived
Synopsis Enable the long-lived context
Context configure router string bgp group string graceful-restart long-lived
Treelong-lived

Description

Commands in this context configure the BGP Long-Lived Graceful-Restart (LLGR) procedures.

LLGR, known informally as BGP persistence, is an extension of BGP GR that allows a session to stay down for a longer period of time. During this time, learned routes are marked and re-advertised as stale but they can continue to be used as routes of last resort.

The LLGR handling of a session failure can be invoked immediately or it can be delayed until the end of the traditional GR restart window.

Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp group string graceful-restart long-lived family keyword
Treefamily
Introduced16.0.R1

Platforms

All

[family-type] keyword
Synopsis Family type for family-specific LLGR configuration
Contextconfigure router string bgp group string graceful-restart long-lived family keyword
Treefamily
Optionsipv4, vpn-ipv4, ipv6, vpn-ipv6, l2-vpn, flow-ipv4, route-target, flow-ipv6, label-ipv4, label-ipv6, flow-vpn-ipv4, flow-vpn-ipv6

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertised-stale-time number
Synopsis LLGR stale routes time for family override
Contextconfigure router string bgp group string graceful-restart long-lived family keyword advertised-stale-time number
Treeadvertised-stale-time

Description

This command configures the long-lived stale routes time that is advertised by the router in its LLGR capability.

This command applies to all AFI/SAFI in the advertised LLGR capability with a family-specific override.

Range0 to 16777215
Default86400
Introduced 16.0.R1

Platforms

All

helper-override-stale-time number
Synopsis Locally-configured stale routes override time
Contextconfigure router string bgp group string graceful-restart long-lived family keyword helper-override-stale-time number
Treehelper-override-stale-time

Description

This command configures a locally-imposed LLGR stale time that overrides the long-lived stale routes time that is advertised by the router in its LLGR capability. This is a family-specific override value.

Range0 to 16777216
Default16777216
Introduced16.0.R1

Platforms

All

forwarding-bits-set keyword
Synopsis BGP LLGR forwarding-bit behavior for address family
Contextconfigure router string bgp group string graceful-restart long-lived forwarding-bits-set keyword
Treeforwarding-bits-set

Description

This command determines the setting of the F bit in the GR and LLGR capabilities advertised by the router. When the F bit is set for an address family, it indicates that the advertising router is able to preserve forwarding state for the routes of that address family across the last restart. When the session is re-established after a restart and the F bit is not set, all stale routes from the peer are immediately removed for the corresponding address family.

This command allows the F bit to be set for all address families or only for non-forwarding address families (L2-VPN, route target, flow-IPv4, and flow-IPv6).

Optionsnone, all, non-fwd
Defaultnone
Introduced16.0.R1

Platforms

All

helper-override-restart-time number
Synopsis Locally-configured override for restart time
Contextconfigure router string bgp group string graceful-restart long-lived helper-override-restart-time number
Treehelper-override-restart-time

Description

This command overrides the restart time advertised by a peer (in its GR capability) with a locally-configured value. This override applies only to AFI/SAFI that were included in the GR capability of the peer. The restart-time is always zero for AFI/SAFI not included in the GR capability. This command is useful if the local router wants to force the LLGR phase to begin after a set time for all protected AFI/SAFI.

Range0 to 4095
Introduced16.0.R1

Platforms

All

helper-override-stale-time number
Synopsis Locally-configured stale routes override time
Contextconfigure router string bgp group string graceful-restart long-lived helper-override-stale-time number
Treehelper-override-stale-time

Description

This command configures a locally-imposed LLGR stale time that overrides the long-lived stale routes time that is advertised by the router in its LLGR capability.

This command applies to all AFI/SAFI in the advertised LLGR capability except for any AFI/SAFI with a family-specific override.

Range0 to 16777215
Introduced16.0.R1

Platforms

All

without-no-export boolean
Synopsis Advertise LLGR stale routes to non-LLGR peers
Contextconfigure router string bgp group string graceful-restart long-lived without-no-export boolean
Treewithout-no-export

Description

When configured to true, LLGR stale routes can be advertised to any peer (EBGP or IBGP) that did not signal the LLGR capability. For IBGP and confederation-EBGP peers that did not advertise the LLGR capability, the local preference attribute in the advertised stale routes is automatically set to 0.

When configured to false, LLGR stale routes are not advertised to any EBGP peer that did not signal the LLGR capability. For IBGP and confederation-EBGP peers that did not advertise the LLGR capability, the local preference attribute in the advertised stale routes is automatically set to 0 and a NO_EXPORT standard community is automatically added to the routes.

Defaultfalse
Introduced16.0.R1

Platforms

All

hold-time
Synopsis Enter the hold-time context
Context configure router string bgp group string hold-time
Treehold-time
Introduced16.0.R1

Platforms

All

minimum-hold-time number
Synopsis Minimum hold time between successive messages
Contextconfigure router string bgp group string hold-time minimum-hold-time number
Treeminimum-hold-time

Description

This command specifies the minimum hold time that is accepted for the session. If a peer proposes a hold time lower than this value, the session attempt is rejected.

When unconfigured, the command value is inherited from the BGP global-level setting.

Range0 | 3 to 65536
Default0
Introduced 16.0.R1

Platforms

All

seconds number
Synopsis Maximum time BGP waits between successive messages
Contextconfigure router string bgp group string hold-time seconds number
Treeseconds

Description

This command configures the maximum time BGP waits between successive messages (either keepalive or update) from its peer before closing the connection.

Although the implementation allows setting the keepalive timer at the BGP group level times separately, the configured keepalive timer is overridden by this value under the following circumstances.

  • If the specified hold time is less than the configured keepalive time, the operational keepalive time is set to a third of the hold-time; the configured keepalive time is not changed.

  • If the hold time is set to zero, the operational value of the keepalive time is set to zero; the configured keepalive time is not changed. The connection with the peer is up permanently and no keepalive packets are sent to the peer.

When unconfigured, the command setting is inherited from the BGP global-level configuration.

Range0 | 3 to 65535
Introduced16.0.R1

Platforms

All

import
Synopsis Enable the import context
Context configure router string bgp group string import
Treeimport

Description

Commands in this context specify route policies that control the handling of inbound routes received from certain peers. Route policies are configured in the configure policy-options context.

When this context is unconfigured, the policy association for the group is inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis BGP import policy name
Context configure router string bgp group string import policy (policy-expr-string | string)
Treepolicy

Description

This command specifies route policies that control the handling of inbound routes received from certain peers.

Each object in this command is either a policy logical expression or the name of a single policy. The objects are evaluated in the specified order to determine the modifications of each route and the final action to accept or reject the route.

Only one of the objects referenced by the command can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or"start@variable@".

String Length1 to 255
Max. Instances15
Min. Instances1

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

initial-send-delay-zero boolean
Synopsis Send BGP updates as soon as the session comes up
Contextconfigure router string bgp group string initial-send-delay-zero boolean
Treeinitial-send-delay-zero

Description

When configured to true, BGP updates are sent as soon as the session comes up.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, BGP waits to send UPDATE messages for the minimum route advertisement time after a session is established.

Introduced16.0.R1

Platforms

All

keepalive number
Synopsis Time after which the BGP KEEPALIVE message is sent
Contextconfigure router string bgp group string keepalive number
Treekeepalive

Description

This command configures the BGP keepalive timer value. A keepalive message is sent every time this timer expires.

This value is generally one-third of the hold time interval configured in the hold-time seconds context. Although the implementation allows this keepalive value and the hold time interval to be independently set, under the following circumstances, the configured keepalive value is overridden by the hold time interval value:

  • If the specified keepalive value is greater than the configured hold time, the specified keepalive value is ignored and the timer value is set to one third of the current hold time value.

  • If the specified hold time interval is less than the configured keepalive value, the keepalive value is reset to one third of the specified hold time interval.

  • If the hold time interval is set to zero, the configured keepalive value is ignored. This means that the connection with the peer is up permanently and no keepalive packets are sent to the peer.

When unconfigured, the command inherits the BGP global-level setting.

Range0 to 21845
Introduced16.0.R1

Platforms

All

link-bandwidth
Synopsis Enter the link-bandwidth context
Contextconfigure router string bgp group string link-bandwidth
Treelink-bandwidth

Description

Commands in this context specify the handling of the Link Bandwidth Extended Community attached to specific BGP routes.

When all used multipaths of an IP prefix correspond to BGP routes with a Link Bandwidth EC, the datapath is programmed to use weighted ECMP across the BGP next hops in proportion to the bandwidth values.

Introduced16.0.R3

Platforms

All

accept-from-ebgp
Synopsis Enter the accept-from-ebgp context
Contextconfigure router string bgp group string link-bandwidth accept-from-ebgp
Treeaccept-from-ebgp
Introduced16.0.R4

Platforms

All

add-to-received-ebgp
Synopsis Enter the add-to-received-ebgp context
Contextconfigure router string bgp group string link-bandwidth add-to-received-ebgp
Treeadd-to-received-ebgp
Introduced16.0.R3

Platforms

All

aggregate-used-paths
Synopsis Enter the aggregate-used-paths context
Contextconfigure router string bgp group string link-bandwidth aggregate-used-paths
Treeaggregate-used-paths
Introduced16.0.R4

Platforms

All

send-to-ebgp
Synopsis Enter the send-to-ebgp context
Contextconfigure router string bgp group string link-bandwidth send-to-ebgp
Treesend-to-ebgp
Introduced16.0.R4

Platforms

All

local-address (ipv4-address-no-zone | ipv6-address-no-zone | interface-name)
Synopsis Local IP address used when communicating with BGP peers
Contextconfigure router string bgp group string local-address (ipv4-address-no-zone | ipv6-address-no-zone | interface-name)
Treelocal-address
String Length1 to 32
Introduced16.0.R1

Platforms

All

local-as
Synopsis Enter the local-as context
Context configure router string bgp group string local-as
Treelocal-as
Introduced16.0.R1

Platforms

All

prepend-global-as boolean
Synopsis Prepend global ASN when advertising routes to BGP peer
Contextconfigure router string bgp group string local-as prepend-global-as boolean
Treeprepend-global-as

Description

When configured to true, the global ASN is added to the AS_PATH attribute in outbound routes sent to the peer.

When configured to false, the global ASN is not included in the AS_PATH attribute.

Defaulttrue
Introduced16.0.R1

Platforms

All

private boolean
Synopsis Hide the local ASN in sent paths learned from peering
Contextconfigure router string bgp group string local-as private boolean
Treeprivate

Description

When configured to true, the local AS number is only advertised to peers that use the local ASN for establishing BGP peering sessions.

When configured to false, the local ASN is advertised to all peers, including those that can use the global ASN for establishing BGP peering sessions.

Defaultfalse
Introduced16.0.R1

Platforms

All

loop-detect keyword
Synopsis Strategy for loop detection in the AS path
Contextconfigure router string bgp group string loop-detect keyword
Treeloop-detect
Optionsdrop-peer, ignore-loop, off, discard-route
Introduced16.0.R1

Platforms

All

med-out (number | keyword)
Synopsis Default MED attribute value to advertise to peers
Contextconfigure router string bgp group string med-out (number | keyword)
Treemed-out
Max. Range0 to 4294967295
Optionsigp-cost
Introduced16.0.R1

Platforms

All

monitor
Synopsis Enable the monitor context
Context configure router string bgp group string monitor
Treemonitor

Description

Commands in this context specify BMP-related configurations at the BGP group level.

When this context is unconfigured, the command settings are inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BMP monitoring
Contextconfigure router string bgp group string monitor admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

all-stations boolean
Synopsis Send BMP messages to all configured stations
Contextconfigure router string bgp group string monitor all-stations boolean
Treeall-stations

Description

When configured to true, this command specifies that BMP messages are to be sent to all configured BMP monitoring stations.

When configured to false, the command is not used to indicate the stations which can receive BMP messages. The station command (at the same context level) identifies the BMP stations for which BMP messages are to be sent.

Defaultfalse
Introduced16.0.R1

Platforms

All

route-monitoring
Synopsis Enter the route-monitoring context
Contextconfigure router string bgp group string monitor route-monitoring
Treeroute-monitoring
Introduced16.0.R1

Platforms

All

station [station-name] reference
Synopsis Add a list entry for station
Context configure router string bgp group string monitor station reference
Treestation

Description

This command identifies a BMP monitoring station for which BMP messages are to be sent.

Max. Instances8
Introduced16.0.R1

Platforms

All

[station-name] reference
Synopsis BMP monitoring station
Context configure router string bgp group string monitor station reference
Treestation

Reference

configure bmp station string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

multihop number
Synopsis TTL in IP packet headers for EBGP peers multi-hops away
Contextconfigure router string bgp group string multihop number
Treemultihop
Range1 to 255
Introduced16.0.R1

Platforms

All

next-hop-self boolean
Synopsis Advertise routes with local address as next-hop address
Contextconfigure router string bgp group string next-hop-self boolean
Treenext-hop-self
Defaultfalse
Introduced16.0.R1

Platforms

All

next-hop-unchanged
Synopsis Enter the next-hop-unchanged context
Contextconfigure router string bgp group string next-hop-unchanged
Treenext-hop-unchanged

Description

Commands in this context specify the IP address families that allow unchanged BGP next-hops when sending BGP routes to peers in the group.

Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise EVPN routes with unchanged BGP next hop
Contextconfigure router string bgp group string next-hop-unchanged evpn boolean
Treeevpn
Defaultfalse
Introduced20.2.R1

Platforms

All

origin-validation
Synopsis Enter the origin-validation context
Contextconfigure router string bgp group string origin-validation
Treeorigin-validation
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Enable support for unlabeled unicast IPv4 routes
Contextconfigure router string bgp group string origin-validation ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Enable support for unlabeled unicast IPv6 routes
Contextconfigure router string bgp group string origin-validation ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

outbound-route-filtering
Synopsis Enable the outbound-route-filtering context
Contextconfigure router string bgp group string outbound-route-filtering
Treeoutbound-route-filtering

Description

Commands in this context configure the send and receive capabilities for Outbound Route Filtering (ORF).

When this context is unconfigured, the group command settings are inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

extended-community
Synopsis Enable the extended-community context
Contextconfigure router string bgp group string outbound-route-filtering extended-community
Treeextended-community

Description

Commands in this context configure the ORF send and receive capabilities based on Extended Communities.

When this context is unconfigured, the command settings are inherited from the global-level configuration.

Introduced16.0.R1

Platforms

All

accept-orf boolean
Synopsis Negotiate with peer to accept BGP ORF filters
Contextconfigure router string bgp group string outbound-route-filtering extended-community accept-orf boolean
Treeaccept-orf

Description

When configured to true, the receive capability in the BGP ORF is negotiated with a peer and ORF filters can be accepted from peers.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the accept capability in the BGP ORF is removed and any existing ORF filters that are currently in place are cleared.

Introduced16.0.R1

Platforms

All

send-orf
Synopsis Enable the send-orf context
Context configure router string bgp group string outbound-route-filtering extended-community send-orf
Treesend-orf

Description

Commands in this context allow BGP to negotiate the send capability in the ORF negotiation with a peer. The send capability also causes the router to send a community filter, prefix filter, or AS path filter configured as an inbound filter on the BGP session to its peer as an ORF Action ADD.

When this context is unconfigured, the command settings are inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

route-target [community-name] string
Synopsis Add a list entry for route-target
Contextconfigure router string bgp group string outbound-route-filtering extended-community send-orf route-target string
Treeroute-target
Introduced16.0.R1

Platforms

All

passive boolean
Synopsis Enable passive mode for BGP communication
Contextconfigure router string bgp group string passive boolean
Treepassive
Defaultfalse
Introduced16.0.R1

Platforms

All

path-mtu-discovery boolean
Synopsis Enable Path MTU Discovery
Context configure router string bgp group string path-mtu-discovery boolean
Treepath-mtu-discovery

Description

When configured to true, Path MTU Discovery (PMTUD) is enabled for the associated TCP connections.

When set to true, PMTUD is activated toward an IPv4 BGP neighbor and the Don’t Fragment (DF) bit is set in the IP header of all IPv4 packets sent to the peer. If any device along the path toward the peer cannot forward the packet because the IP MTU of the interface is smaller than the IP packet size, this device drops the packet and sends an ICMP or ICMPv6 error message encoding the interface MTU. When the router receives the ICMP or ICMPv6 message, it lowers the TCP maximum segment size limit from the previous value so that the IP MTU constraint can be accommodated.

When configured to false and there is no TCP MSS configuration that can be associated with a BGP neighbor (in either the BGP configuration or the first hop IP interface configuration), the router advertises a value of only 1024 bytes as the TCP MSS option value, limiting received TCP segments to that size.

Introduced16.0.R1

Platforms

All

peer-as number
Synopsis Peer AS number
Contextconfigure router string bgp group string peer-as number
Treepeer-as
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

peer-ip-tracking boolean
Synopsis Enable BGP peer tracking
Context configure router string bgp group string peer-ip-tracking boolean
Treepeer-ip-tracking

Description

When configured to true, this command enables BGP peer tracking.

Peer tracking should be used with caution. Peer tracking can tear a session down even if the loss of connectivity turns out to be short-lived (for example, while the IGP protocol is re-converging). Next-hop tracking, which is always enabled, handles temporary connectivity issues more effectively.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, peer tracking is disabled.

Introduced16.0.R1

Platforms

All

preference number
Synopsis Route preference for routes learned from all peers
Contextconfigure router string bgp group string preference number
Treepreference
Range1 to 255
Introduced16.0.R1

Platforms

All

prefix-limit [family] keyword
Synopsis Enter the prefix-limit list instance
Contextconfigure router string bgp group string prefix-limit keyword
Treeprefix-limit

Description

Commands in this context limit the number of BGP routes per address family received from a BGP peer and define the actions when crossing the configured maximum.

Introduced16.0.R1

Platforms

All

[family] keyword
Synopsis Address family to which the limit applies
Contextconfigure router string bgp group string prefix-limit keyword
Treeprefix-limit
Optionsipv4, vpn-ipv4, ipv6, mcast-ipv4, vpn-ipv6, l2-vpn, mvpn-ipv4, mdt-safi, ms-pw, flow-ipv4, route-target, mcast-vpn-ipv4, mvpn-ipv6, flow-ipv6, evpn, mcast-ipv6, label-ipv4, label-ipv6, bgp-ls, mcast-vpn-ipv6, sr-policy-ipv4, sr-policy-ipv6, flow-vpn-ipv4, flow-vpn-ipv6

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

hold-excess number
Synopsis Percentage of maximum routes to install in route table
Contextconfigure router string bgp group string prefix-limit keyword hold-excess number
Treehold-excess

Description

This command specifies the percentage of maximum routes that are allowed to be installed in the route table for the configured address family. If a peer within scope of the configuration exceeds the limit, the overflow routes are held in the BGP RIB as inactive routes and are ineligible for forwarding and advertisement to other peers. If the post-import command is configured to true, only routes not rejected by import policies count toward the limit.

A BGP route in an overflow state is reconsidered for activation and reinstallation when an UPDATE message is received for the route.

This command is mutually exclusive with the idle-timeout and log-only commands.

Range1 to 100
Introduced23.7.R1

Platforms

All

idle-timeout number
Synopsis Time BGP peering remains idle before reconnecting
Contextconfigure router string bgp group string prefix-limit keyword idle-timeout number
Treeidle-timeout

Description

This command configures the time in minutes before a BGP peer is automatically re-established after reaching the prefix limit.

When unconfigured, the BGP peer stays down until the operator performs a reset. This command and log-only cannot be configured simultaneously.

Range1 to 1024
Introduced16.0.R1

Platforms

All

log-only boolean
Synopsis Send warning message at threshold instead of take-down
Contextconfigure router string bgp group string prefix-limit keyword log-only boolean
Treelog-only

Description

When configured to true, the router disables the BGP session from being taken down upon reaching the prefix limit. Instead, only a warning message is sent when the limit is reached. A warning message is also sent when the configured threshold percentage of the limit is reached.

This command and idle-timeout cannot be configured simultaneously.

When configured to false, the router generates a log event and takes the BGP session down upon reaching the prefix limit.

Defaultfalse
Introduced16.0.R1

Platforms

All

maximum number
Synopsis Maximum number of routes to be learned from a peer
Contextconfigure router string bgp group string prefix-limit keyword maximum number
Treemaximum

Description

This command configures the maximum number of BGP routes of the specified address family that can be received from a peer before administrative action is taken.

When log-only is unconfigured, the BGP session is taken down whenever the limit of any family is exceeded even if the limits of the other family has not been exceeded.

Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R2

Platforms

All

post-import boolean
Synopsis Apply limit only to routes accepted by import policies
Contextconfigure router string bgp group string prefix-limit keyword post-import boolean
Treepost-import

Description

When configured to true, the system limits the number of routes that are accepted by import policies. Routes rejected by import policies are not counted against the configured limit.

When configured to false, the system limits the number of routes to all routes received from the peer.

Defaultfalse
Introduced16.0.R1

Platforms

All

threshold number
Synopsis Percentage threshold that triggers a warning message
Contextconfigure router string bgp group string prefix-limit keyword threshold number
Treethreshold
Range1 to 100
Default90
Introduced 16.0.R1

Platforms

All

remove-private
Synopsis Enable the remove-private context
Contextconfigure router string bgp group string remove-private
Treeremove-private
Introduced16.0.R1

Platforms

All

limited boolean
Synopsis Remove private ASNs up to first public ASN encountered
Contextconfigure router string bgp group string remove-private limited boolean
Treelimited
Defaultfalse
Introduced16.0.R1

Platforms

All

replace boolean
Synopsis Replace private ASN with global ASN before advertising
Contextconfigure router string bgp group string remove-private replace boolean
Treereplace
Defaultfalse
Introduced19.10.R1

Platforms

All

segment-routing-v6
Synopsis Enable the segment-routing-v6 context
Contextconfigure router string bgp group string segment-routing-v6
Treesegment-routing-v6
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

route-advertisement
Synopsis Enable the route-advertisement context
Contextconfigure router string bgp group string segment-routing-v6 route-advertisement
Treeroute-advertisement
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

drop-routes-with-srv6-tlvs boolean
Synopsis Drop BGP routes with SRv6 TLVs
Context configure router string bgp group string segment-routing-v6 route-advertisement drop-routes-with-srv6-tlvs boolean
Treedrop-routes-with-srv6-tlvs

Description

When configured to true, the router drops and does not advertise BGP routes (that belong to any address family) with SRv6 TLVs.

When configured to false, the router advertises BGP routes with SRv6 TLVs.

Defaultfalse
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp group string segment-routing-v6 route-advertisement family keyword
Treefamily
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[family-type] keyword
Synopsis IP address type that SRv6 route attributes apply to
Contextconfigure router string bgp group string segment-routing-v6 route-advertisement family keyword
Treefamily
Optionsipv4, ipv6

Notes

This element is part of a list key.

Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

strip-srv6-tlvs boolean
Synopsis Strip SRv6 TLVs from BGP routes advertised to peers
Contextconfigure router string bgp group string segment-routing-v6 route-advertisement family keyword strip-srv6-tlvs boolean
Treestrip-srv6-tlvs

Description

When configured to true, BGP routes that belong to the address family specified using the family command are advertised to peers with SRv6 TLVs removed. Locally or remotely added SRv6 TLVs can be removed.

When configured to false, SRv6 TLVs are not stripped from BGP routes advertised to peers.

Defaultfalse
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

send-communities
Synopsis Enter the send-communities context
Contextconfigure router string bgp group string send-communities
Treesend-communities
Introduced16.0.R1

Platforms

All

extended boolean
Synopsis Advertise the Extended Communities attribute to peers
Contextconfigure router string bgp group string send-communities extended boolean
Treeextended

Description

When unconfigured, this command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to true.

When this command inherits a value of true, BGP extended communities are sent to peers in the Extended Communities attribute.

When configured to false, all extended communities are removed from all routes advertised to BGP peers.

Introduced16.0.R1

Platforms

All

large boolean
Synopsis Advertise the Large Communities attribute to peers
Contextconfigure router string bgp group string send-communities large boolean
Treelarge

Description

When unconfigured, this command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to true.

When this command inherits a value of true, BGP large communities are sent to peers in the Large Communities attribute.

When configured to false, all large communities are removed from all routes advertised to BGP peers.

Introduced16.0.R1

Platforms

All

standard boolean
Synopsis Advertise the Communities attribute to peers
Contextconfigure router string bgp group string send-communities standard boolean
Treestandard

Description

When unconfigured, this command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to true.

When this command inherits a value of true, BGP standard communities are sent to peers in the Communities attribute.

When configured to false, all standard communities are removed from all routes advertised to BGP peers.

Introduced16.0.R1

Platforms

All

send-default
Synopsis Enable the send-default context
Contextconfigure router string bgp group string send-default
Treesend-default
Introduced19.7.R1

Platforms

All

ipv4 boolean
Synopsis Generate and advertise an IPv4 default route (0/0)
Contextconfigure router string bgp group string send-default ipv4 boolean
Treeipv4
Defaultfalse
Introduced19.7.R1

Platforms

All

ipv6 boolean
Synopsis Generate and advertise an IPv6 default route (::/0)
Contextconfigure router string bgp group string send-default ipv6 boolean
Treeipv6
Defaultfalse
Introduced19.7.R1

Platforms

All

split-horizon boolean
Synopsis Prevent routes being reflected back to best-route peer
Contextconfigure router string bgp group string split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split-horizon.

This command prevents routes from being reflected back to a peer that sends the best route. It applies to routes of all address families and to any type of sending peer; confed-EBGP, EBGP and IBGP.

Enabling the split-horizon functionality may have a detrimental impact on peer and route scaling and should only be used when absolutely necessary.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the use of split-horizon is disabled.

Introduced16.0.R1

Platforms

All

tcp-mss (number | keyword)
Synopsis TCP maximum segment size override
Context configure router string bgp group string tcp-mss (number | keyword)
Treetcp-mss

Description

This command configures an override for the TCP maximum segment size to use with a specific peer or set of peers (depending on the scope of the command).

The configured value controls two properties of the TCP connection as follows:

TCP MSS option - The router advertises the TCP MSS option value in the TCP SYN packet it sends as part of the 3-way handshake. The advertised value may be lower than the configured value, depending on the IP MTU of the first hop IP interface. The peers must abide by this value when sending TCP segments to the local router.

TCP maximum segment size - The actual transmitted size may be lower than the configured value, depending on the TCP MSS option value signaled by the peers, the effect of path MTU discovery, or other factors.

Range384 to 9746
Optionsip-stack
Introduced21.2.R1

Platforms

All

third-party-nexthop boolean
Synopsis Apply third-party next-hop processing to EBGP peers
Contextconfigure router string bgp group string third-party-nexthop boolean
Treethird-party-nexthop

Description

When configured to true, this command enables the router to send third-party next hop to EBGP peers in the same subnet as the source peer. The address family of the transport must match the address family of the route.

When an IPv4 or IPv6 route is received from one EBGP peer and advertised to another EBGP peer in the same IP subnet, the BGP next hop is left unchanged.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, third-party next-hop processing is disabled and the next hop carries the IP address of the interface used to establish the TCP connection to the peer.

Introduced16.0.R1

Platforms

All

ttl-security number
Synopsis Minimum TTL value for an incoming BGP packet
Contextconfigure router string bgp group string ttl-security number
Treettl-security

Description

This command configures the minimum TTL value that BGP accepst from an incoming packet. A packet with a TTL value less than the minimum configured TTL value is discarded.

Range1 to 255
Introduced16.0.R1

Platforms

All

type keyword
Synopsis BGP peer type
Contextconfigure router string bgp group string type keyword
Treetype
Optionsno-type, internal, external
Defaultno-type
Introduced16.0.R1

Platforms

All

vpn-apply-export boolean
Synopsis Apply base-instance BGP export policies to VPN routes
Contextconfigure router string bgp group string vpn-apply-export boolean
Treevpn-apply-export

Description

When configured to true, base-instance BGP export route policies are applied to VPN-IPv4/6, MVPN-IPv4/6, L2-VPN, MDT-SAFI, MCAST-VPN-IPv4, and EVPN routes.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the export policies are not applied.

Introduced16.0.R1

Platforms

All

vpn-apply-import boolean
Synopsis Apply base-instance BGP import policies to VPN routes
Contextconfigure router string bgp group string vpn-apply-import boolean
Treevpn-apply-import

Description

When configured to true, base-instance BGP import route policies are applied to VPN-IPv4/6, MVPN-IPv4/6, L2-VPN, MDT-SAFI, MCAST-VPN-IPv4, and EVPN routes.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the import policies are not applied.

Introduced16.0.R1

Platforms

All

hold-time
Synopsis Enter the hold-time context
Context configure router string bgp hold-time
Treehold-time
Introduced16.0.R1

Platforms

All

minimum-hold-time number
Synopsis Minimum hold time between successive messages
Contextconfigure router string bgp hold-time minimum-hold-time number
Treeminimum-hold-time

Description

This command specifies the minimum hold time that is accepted for the session. If a peer proposes a hold time lower than this value, the session attempt is rejected.

Range0 | 3 to 65535
Default0
Introduced 16.0.R1

Platforms

All

seconds number
Synopsis Maximum time BGP waits between successive messages
Contextconfigure router string bgp hold-time seconds number
Treeseconds

Description

This command configures the maximum time BGP waits between successive messages (either keepalive or update) from its peer before closing the connection.

Although the implementation allows setting the keepalive timer at the BGP global level times separately, the configured keepalive timer is overridden by this value under the following circumstances.

  • If the specified hold time is less than the configured keepalive time, the operational keepalive time is set to a third of the hold-time; the configured keepalive time is not changed.

  • If the hold time is set to zero, the operational value of the keepalive time is set to zero; the configured keepalive time is not changed. The connection with the peer is up permanently and no keepalive packets are sent to the peer.

Range0 | 3 to 65535
Default90
Introduced 16.0.R1

Platforms

All

ibgp-multipath boolean
Synopsis Enable IBGP multipath load balancing
Context configure router string bgp ibgp-multipath boolean
Treeibgp-multipath

Description

When configured to true, this command enables IBGP multipath load balancing when adding BGP routes to the route table if the route resolving the BGP next hop offers multiple next hops.

When configured to false, this command disables IBGP multipath load balancing.

Defaultfalse
Introduced16.0.R1

Platforms

All

import
Synopsis Enable the import context
Context configure router string bgp import
Treeimport

Description

Commands in this context specify route policies that control the handling of inbound routes received from certain peers. Route policies are configured in the configure policy-options context.

When no import policies are specified in this context, BGP routes are accepted by default.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis BGP import policy name
Context configure router string bgp import policy (policy-expr-string | string)
Treepolicy

Description

This command specifies a list of objects, where each object is either a policy logical expression or the name of a single policy. The objects are evaluated in the specified order to determine the modifications of each route and the final action to accept or reject the route.

Only one of the objects referenced by this command is allowed to be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or"start@variable@".

String Length1 to 255
Max. Instances15
Min. Instances1

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

inter-as-vpn boolean
Synopsis Allow advertisement of VPN routes across AS boundaries
Contextconfigure router string bgp inter-as-vpn boolean
Treeinter-as-vpn

Description

When configured to true, VPNs can exchange routes across AS boundaries, providing model B connectivity.

When configured to false, ASBRs are prevented from advertising VPN routes to peers in other ASs.

Defaultfalse
Introduced16.0.R1

Platforms

All

keepalive number
Synopsis Time after which the BGP KEEPALIVE message is sent
Contextconfigure router string bgp keepalive number
Treekeepalive
Range0 to 21845
Default30
Introduced 16.0.R1

Platforms

All

label-allocation
Synopsis Enter the label-allocation context
Contextconfigure router string bgp label-allocation
Treelabel-allocation
Introduced20.10.R1

Platforms

All

label-ipv6
Synopsis Enter the label-ipv6 context
Context configure router string bgp label-allocation label-ipv6
Treelabel-ipv6

Description

This command controls the label allocation behavior for labeled unicast IPv6 routes. The label options are explicit-null and normal.

Introduced20.10.R1

Platforms

All

explicit-null boolean
Synopsis Apply advertised label and associated programming rules
Contextconfigure router string bgp label-allocation label-ipv6 explicit-null boolean
Treeexplicit-null

Description

When configured to true, this command uses the advertised label and associated programming rules on this instance of BGP. The following applies:

  • The router is required to act as the BGP next-hop of a label-unicast IPv6 route that it is advertising. It sets the BGP label value to IPv6 explicit null (value 2), forcing a POP behavior for received packets.

  • The received label-unicast IPv6 routes never create tunnels in TTM that can be used to resolve other BGP routes (with an IPv6 next-hop).

  • A received label-unicast IPv6 route can be resolved by a label-ipv4 BGP tunnel that is transported over a stacked tunnel (SR-TE LSP or LDPoRSVP LSP).

When configured to false, advertised label IPv6 programming rules are not used. The following applies

  • When the router is required to act as the BGP next-hop of a label-unicast IPv6 route that it is advertising, it sets the BGP label value to a proper value in the dynamic label range and programs a POP or SWAP operation for that label, depending on the origin of the route and various import policy actions that could apply to the route.

  • Received label-unicast IPv6 routes that have a prefix length of 128 bits are automatically installed in TTM so that they can be used to resolve other (non-labeled-unicast) BGP routes (with an IPv6 next-hop).

  • A received label-unicast IPv6 route cannot be resolved by a label-ipv4 BGP tunnel that is transported over a stacked tunnel (SR-TE LSP or LDPoRSVP LSP).

  • The label-ipv6 routes used for ECMP toward an IPv6 destination cannot be a mix of routes with regular label values and routes with special (IPv6 explicit null) label values.

Changes in the value of this leaf do not cause the BGP sessions of the base router to reset.

Defaulttrue
Introduced20.10.R1

Platforms

All

label-preference number
Synopsis Route preference for routes from labeled-unicast peers
Contextconfigure router string bgp label-preference number
Treelabel-preference
Range1 to 255
Default170
Introduced 16.0.R1

Platforms

All

link-state-route-export boolean
Synopsis Allow the export of the TED NLRI database
Contextconfigure router string bgp link-state-route-export boolean
Treelink-state-route-export

Description

When configured to true, this command allows BGP to export link-state information to BGP neighbors.

When configured to false, link-state information is not exported.

Defaultfalse
Introduced16.0.R1

Platforms

All

link-state-route-import boolean
Synopsis Allow the import of the TED NLRI database
Contextconfigure router string bgp link-state-route-import boolean
Treelink-state-route-import

Description

When configured to true, this command enables the import of link-state information into the BGP-LS address family for advertisement to other BGP neighbors.

When configured to false, this command disables the import of link-state information.

Defaultfalse
Introduced16.0.R1

Platforms

All

local-as
Synopsis Enter the local-as context
Context configure router string bgp local-as
Treelocal-as
Introduced16.0.R1

Platforms

All

as-number number
Synopsis Local (or virtual) BGP AS number
Context configure router string bgp local-as as-number number
Treeas-number
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

prepend-global-as boolean
Synopsis Prepend global AS when advertising routes to BGP peer
Contextconfigure router string bgp local-as prepend-global-as boolean
Treeprepend-global-as

Description

When configured to true, the global ASN is added to the AS_PATH attribute in outbound routes sent to the peer.

When configured to false, the global ASN is hidden in paths announced to the EBGP peer.

Defaulttrue
Introduced16.0.R1

Platforms

All

private boolean
Synopsis Hide the local ASN in sent paths learned from peering
Contextconfigure router string bgp local-as private boolean
Treeprivate

Description

When configured to true, the local ASN is hidden in paths learned from the peering.

When configured to false, the local ASN is advertised to all peers, including those that can use the global ASN for establishing BGP peering sessions.

Defaultfalse
Introduced16.0.R1

Platforms

All

local-preference number
Synopsis Default local preference if not in incoming routes
Contextconfigure router string bgp local-preference number
Treelocal-preference
Max. Range0 to 4294967295
Default100
Introduced16.0.R1

Platforms

All

loop-detect keyword
Synopsis Strategy for loop detection in the AS path
Contextconfigure router string bgp loop-detect keyword
Treeloop-detect
Optionsdrop-peer, ignore-loop, off, discard-route
Defaultignore-loop
Introduced 16.0.R1

Platforms

All

med-out (number | keyword)
Synopsis Default MED attribute value to advertise to peers
Contextconfigure router string bgp med-out (number | keyword)
Treemed-out
Max. Range0 to 4294967295
Optionsigp-cost
Introduced16.0.R1

Platforms

All

monitor
Synopsis Enable the monitor context
Context configure router string bgp monitor
Treemonitor

Description

Commands in this context specify BMP-related configurations. 

When this context is unconfigured, the sending of BMP messages to BMP monitoring stations is disabled.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BMP monitoring
Contextconfigure router string bgp monitor admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

all-stations boolean
Synopsis Send BMP messages to all configured stations
Contextconfigure router string bgp monitor all-stations boolean
Treeall-stations

Description

When configured to true, this command specifies that BMP messages are to be sent to all configured BMP monitoring stations.

When configured to false, the command is not used to indicate the stations which can receive BMP messages. The station command (at the same context level) identifies the BMP stations for which BMP messages are to be sent.

Defaultfalse
Introduced16.0.R1

Platforms

All

route-monitoring
Synopsis Enter the route-monitoring context
Contextconfigure router string bgp monitor route-monitoring
Treeroute-monitoring
Introduced16.0.R1

Platforms

All

station [station-name] reference
Synopsis Add a list entry for station
Context configure router string bgp monitor station reference
Treestation

Description

This command identifies a BMP monitoring station for which BMP messages are to be sent.

Max. Instances8
Introduced16.0.R1

Platforms

All

[station-name] reference
Synopsis BMP monitoring station
Context configure router string bgp monitor station reference
Treestation

Reference

configure bmp station string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

mp-bgp-keep boolean
Synopsis Keep rejected VPN-IP routes in RIB-IN
Contextconfigure router string bgp mp-bgp-keep boolean
Treemp-bgp-keep

Description

When configured to true, the RIB-IN retains all MP-BGP routes, including VPN routes rejected by import policies or not imported by any services. As a result, sending Route Refresh messages is not required when an import policy changes.

When configured to false, these VPN routes are deleted from the RIB-IN.

Defaultfalse
Introduced16.0.R1

Platforms

All

multihop number
Synopsis TTL in IP packet headers for EBGP peers multi-hops away
Contextconfigure router string bgp multihop number
Treemultihop

Description

This command configures the Time to Live (TTL) value entered in the IP header of packets sent to an EBGP peer multiple hops away. This command applies only to EBGP.

Range1 to 255
Introduced16.0.R1

Platforms

All

multipath
Synopsis Enter the multipath context
Context configure router string bgp multipath
Treemultipath
Introduced16.0.R1

Platforms

All

ebgp number
Synopsis Maximum multipaths per prefix for EBGP learned routes
Contextconfigure router string bgp multipath ebgp number
Treeebgp
Range1 to 64
Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp multipath family keyword
Treefamily
Introduced19.5.R1

Platforms

All

[family-type] keyword
Synopsis Address family for which multipath selection applies
Contextconfigure router string bgp multipath family keyword
Treefamily
Optionsipv4, ipv6, label-ipv4, label-ipv6

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

ebgp number
Synopsis Maximum multipaths when best path is EBGP learned route
Contextconfigure router string bgp multipath family keyword ebgp number
Treeebgp

Description

This command configures the maximum number of multipaths per prefix or NLRI when the best path is an EBGP learned route. The limit configured using this command overrides the limit configured in the max-paths command. If the best path is an EBGP learned route, and this command is set to 1, multipaths are disabled.

Range1 to 64
Introduced19.5.R1

Platforms

All

ibgp number
Synopsis Maximum multipaths when best path is IBGP learned route
Contextconfigure router string bgp multipath family keyword ibgp number
Treeibgp

Description

This command configures the maximum number of multipaths per prefix or NLRI when the best path is an IBGP learned route. The limit configured using this command overrides the limit configured in the max-paths command. If the best path is an IBGP learned route and this command is set to 1, multipaths are disabled.

Range1 to 64
Introduced19.5.R1

Platforms

All

max-paths number
Synopsis Maximum number of multipaths per prefix or NLRI
Contextconfigure router string bgp multipath family keyword max-paths number
Treemax-paths

Description

This command configures the maximum number of multipaths per prefix or NLRI for the IP family option specified using the family command.

Consider the following when configuring this command: 

  • If the best path is an EBGP-learned route and the ebgp command is configured, the limit configured in the ebgp command overrides the limit configured in this command. 

  • If the best path is an IBGP-learned route and the ibgp command is configured, the limit configured in the ibgp command overrides the limit configured in this command.

  • If the best path is an EBGP-learned route and the ebgp command is not configured, and this command is configured to 1, multipaths are disabled.

  • If the best path is an IBGP-learned route and the ibgp command is not configured, and this command is configured to 1, multipaths are disabled.

Range1 to 64
Introduced19.5.R1

Platforms

All

restrict keyword
Synopsis AS path restriction for the non-best path
Contextconfigure router string bgp multipath family keyword restrict keyword
Treerestrict
Optionssame-as-path-length, same-neighbor-as, exact-as-path
Defaultsame-as-path-length
Introduced19.5.R1

Platforms

All

unequal-cost boolean
Synopsis Ignore differences in the next-hop cost for multipath
Contextconfigure router string bgp multipath family keyword unequal-cost boolean
Treeunequal-cost

Description

When configured to true, BGP ignores differences in the next-hop cost when determining eligible multipaths.

Defaultfalse
Introduced19.5.R1

Platforms

All

ibgp number
Synopsis Maximum multipaths per prefix for IBGP learned routes
Contextconfigure router string bgp multipath ibgp number
Treeibgp
Range1 to 64
Introduced16.0.R1

Platforms

All

max-paths number
Synopsis Maximum multipaths per prefix
Context configure router string bgp multipath max-paths number
Treemax-paths
Range1 to 64
Default1
Introduced 16.0.R1

Platforms

All

restrict keyword
Synopsis AS path restriction for the non-best path
Contextconfigure router string bgp multipath restrict keyword
Treerestrict
Optionssame-as-path-length, same-neighbor-as, exact-as-path
Defaultsame-as-path-length
Introduced16.0.R1

Platforms

All

unequal-cost boolean
Synopsis Ignore differences in the next-hop cost for multipath
Contextconfigure router string bgp multipath unequal-cost boolean
Treeunequal-cost
Defaultfalse
Introduced19.5.R1

Platforms

All

mvpn-vrf-import-subtype-new boolean
Synopsis Encode the IANA value of 0x010b in advertised routes
Contextconfigure router string bgp mvpn-vrf-import-subtype-new boolean
Treemvpn-vrf-import-subtype-new

Description

When configured to true, this command encodes the value of 0x010b for the type or subtype in advertised routes.

When configured to false, BGP encodes the extended community type or subtype as 0x010a to preserve backwards compatibility.

Defaultfalse
Introduced16.0.R1

Platforms

All

neighbor [ip-address] (ipv4-address-with-zone | ipv6-address-with-zone)
Synopsis Enter the neighbor list instance
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone)
Treeneighbor
Introduced16.0.R1

Platforms

All

[ip-address] (ipv4-address-with-zone | ipv6-address-with-zone)
Synopsis IP address of the BGP peer router
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone)
Treeneighbor

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

add-paths
Synopsis Enable the add-paths context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths
Treeadd-paths

Description

Commands in this context allow the add-paths node to be configured for the specified families for configuration of the BGP group or neighbor. The BGP add-paths capability allows the router to send or receive multiple paths per prefix to and from a peer.

When unconfigured, command settings are inherited from a higher level BGP configuration.

Introduced16.0.R1

Platforms

All

evpn
Synopsis Enter the evpn context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths evpn
Treeevpn

Description

Commands in this context configure the add-paths capability for EVPN routes. By default, add-paths is not enabled for EVPN routes.

Introduced21.10.R1

Platforms

All

receive boolean
Synopsis Receive multiple EVPN paths per prefix from a peer
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths evpn receive boolean
Treereceive
Defaultfalse
Introduced21.10.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per EVPN prefix to Add-Path peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths evpn send (number | keyword)
Treesend
Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced21.10.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv4 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths ipv4 receive boolean
Treereceive

Description

When configured to true, the router can receive multiple unlabeled IPv4 unicast routes per prefix from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per unlabeled IPv4 unicast prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths per unlabeled IPv4 unicast prefix that are allowed to be advertised to ADD-PATH peers. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for unlabeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per IPv6 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple unlabeled IPv6 unicast routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per unlabeled IPv6 unicast prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths per unlabeled IPv4 unicast prefix that are allowed to be advertised to ADD-PATH peers. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for unlabeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

label-ipv4
Synopsis Enter the label-ipv4 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths label-ipv4
Treelabel-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv4 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths label-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple labeled-unicast routes per IPv4 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per labeled IPv4 unicast prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths label-ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per labeled IPv4 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for labeled IPv4 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

label-ipv6
Synopsis Enter the label-ipv6 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths label-ipv6
Treelabel-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple labeled-unicast routes per IPv6 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths label-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple labeled-unicast routes per IPv6 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per labeled IPv6 unicast prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths label-ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per labeled IPv6 unicast prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for labeled IPv6 unicast routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

mcast-vpn-ipv4
Synopsis Enter the mcast-vpn-ipv4 context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mcast-vpn-ipv4
Treemcast-vpn-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast routes per IPv4 VPN prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mcast-vpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast routes per IPv4 VPN prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast IPv4 VPN prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mcast-vpn-ipv4 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast IPv4 VPN prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast IPv4 VPN routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv6
Synopsis Enter the mcast-vpn-ipv6 context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mcast-vpn-ipv6
Treemcast-vpn-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast routes per IPv6 VPN prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mcast-vpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast routes per IPv6 VPN prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast IPv6 VPN prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mcast-vpn-ipv6 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast IPv6 VPN prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast IPv6 VPN routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mvpn-ipv4
Synopsis Enter the mvpn-ipv4 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mvpn-ipv4
Treemvpn-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast VPN routes per IPv4 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mvpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast VPN routes per IPv4 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast VPN IPv4 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mvpn-ipv4 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast VPN IPv4 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast VPN IPv4 routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

mvpn-ipv6
Synopsis Enter the mvpn-ipv6 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mvpn-ipv6
Treemvpn-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple multicast VPN routes per IPv6 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mvpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple multicast VPN routes per IPv6 prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send number
Synopsis Maximum paths per multicast VPN IPv6 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths mvpn-ipv6 send number
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per multicast VPN IPv6 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for multicast VPN IPv6 routes.

Range1 to 16
Introduced16.0.R1

Platforms

All

vpn-ipv4
Synopsis Enter the vpn-ipv4 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths vpn-ipv4
Treevpn-ipv4
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per VPN-IPv4 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths vpn-ipv4 receive boolean
Treereceive

Description

When configured to true, this command allows multiple VPN-IPv4 routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per VPN-IPv4 prefix
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths vpn-ipv4 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per VPN-IPv4 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for VPN-IPv4 routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

vpn-ipv6
Synopsis Enter the vpn-ipv6 context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths vpn-ipv6
Treevpn-ipv6
Introduced16.0.R1

Platforms

All

receive boolean
Synopsis Receive multiple routes per VPN-IPv6 prefix
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths vpn-ipv6 receive boolean
Treereceive

Description

When configured to true, this command allows multiple VPN-IPv6 routes per prefix to be received from a peer.

When configured to false, the ADD-PATH receive capability is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

send (number | keyword)
Synopsis Maximum paths per VPN-IPv6 prefix
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) add-paths vpn-ipv6 send (number | keyword)
Treesend

Description

This command configures the maximum number of paths that are allowed to be advertised to add-paths peers per VPN-IPv6 prefix. The actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies, or route advertisement rules.

When not configured, ADD-PATH send capability is not enabled for VPN-IPv6 routes.

Range1 to 16
Options

multipaths – Number of best multipaths for each NLRI

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the BGP neighbor
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

advertise-inactive boolean
Synopsis Advertise an inactive BGP route to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-inactive boolean
Treeadvertise-inactive

Description

When configured to true, this command allows an inactive BGP route to be advertised, even though it is not the most preferred route. The effect of the command on advertised unlabeled, labeled, and multicast IPv4 and IPv6 routes depends on several factors.

  • If the active route for the IP prefix is a BGP route, that route is advertised.

  • If the active route is a non-BGP route and there are valid inactive BGP routes to the same destination, the best valid inactive route is advertised unless the active non-BGP route is matched and accepted by an export policy applied to the session.

  • If the active route is a non-BGP route and there are no valid BGP routes to the same destination, no route is advertised unless the active non-BGP route is matched and accepted by an export policy applied to the session.

When unconfigured, the command inherits the value of the global-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the advertisement of inactive BGP routes to other BGP peers is disabled.

Introduced16.0.R1

Platforms

All

advertise-ipv6-next-hops
Synopsis Enable the advertise-ipv6-next-hops context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops
Treeadvertise-ipv6-next-hops

Description

Commands in this context allow specified IP family routes to be advertised to IPv6 transport peers with a true IPv6 address when originated or when a configured or automatic next-hop-self action is applied.

When unconfigured, command settings are inherited from a higher level BGP configuration.

Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise EVPN route with IPv6 next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops evpn boolean
Treeevpn

Description

When configured to true, EVPN routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, EVPN routes are advertised with IPv4 next-hop addresses to IPv6 transport peers.

Defaultfalse
Introduced19.5.R1

Platforms

All

ipv4 boolean
Synopsis Advertise IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops ipv4 boolean
Treeipv4

Description

When configured to true, IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, IPv4 routes are advertised with IPv4 next-hop addresses to IPv6 transport peers. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced19.5.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise label IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops label-ipv4 boolean
Treelabel-ipv4

Description

When configured to true, label IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, label IPv4 routes are advertised with the system IPv4 address as the next hop to IPv6 transport peers. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise label IPv6 route with IPv6 next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops label-ipv6 boolean
Treelabel-ipv6

Description

When configured to true, label IPv6 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, label IPv6 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop, encoded as an IPv4-mapped IPv6 address.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise VPN IPv4 route with IPv6 next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops vpn-ipv4 boolean
Treevpn-ipv4

Description

When configured to true, VPN IPv4 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers. The appropriate extended NH encoding capability must also be received from the remote peer before the route can be advertised with an IPv6 address instead of the IPv4 system address as the next hop.

When configured to false, VPN IPv4 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop. If the route matches a BGP export policy entry that tries to change the next hop to an IPv6 address and an appropriate extended NH encoding capability was not received by the remote peer, the route is handled as though it was rejected by the policy entry.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise VPN IPv6 route with IPv6 next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) advertise-ipv6-next-hops vpn-ipv6 boolean
Treevpn-ipv6

Description

When configured to true, VPN IPv6 routes are advertised with IPv6 next-hop addresses to IPv6 transport peers.

When configured to false, VPN IPv6 routes are advertised toward IPv6 transport peers with the system IPv4 address as the BGP next hop, encoded as an IPv4-mapped IPv6 address.

Defaultfalse
Introduced16.0.R1

Platforms

All

aggregator-id-zero boolean
Synopsis Set router ID in the BGP AGGREGATOR attribute to zero
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) aggregator-id-zero boolean
Treeaggregator-id-zero
Introduced16.0.R1

Platforms

All

aigp boolean
Synopsis Add AIGP attribute to advertised routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) aigp boolean
Treeaigp

Description

When configured to true, this command enables Accumulated IGP (AIGP) path attribute support with one or more BGP peers. BGP path selection among routes with an associated AIGP metric is based on the end-to-end IGP metrics of the different BGP paths, even when these BGP paths span more than one AS and IGP instance.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the AIGP attribute is removed from advertised routes, if present, and is ignored in received routes.

Introduced16.0.R1

Platforms

All

as-override boolean
Synopsis Replace the peer's ASN with the local ASN in AS Path
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) as-override boolean
Treeas-override

Description

When configured to true, the advertising router's local AS replaces all occurrences of the peer AS in the AS_PATH attribute.

This command should be used with caution, as it breaks BGP's loop detection mechanism.

When unconfigured, the command inherits the value of the group-level setting (true or false). This command cannot be explicitly configured to false.

When configured to false, no AS override is performed.

Introduced19.7.R1

Platforms

All

asn-4-byte boolean
Synopsis Advertise the use of 4-byte ASNs
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) asn-4-byte boolean
Treeasn-4-byte
Introduced16.0.R1

Platforms

All

authentication-keychain reference
Synopsis TCP authentication keychain for the session
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) authentication-keychain reference
Treeauthentication-keychain

Description

This command associates the keychain to be used to authenticate the BGP session. The keychain allows the rollover of authentication keys during the lifetime of a session.

Reference

configure system security keychains keychain string

Introduced16.0.R3

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, BFD is enabled on a given protocol interface where the state of the protocol interface is tied to the state of the BFD session between the local node and the remote node.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, BFD is removed from the associated protocol adjacency.

Introduced16.0.R1

Platforms

All

bfd-strict-mode
Synopsis Enter the bfd-strict-mode context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) bfd-strict-mode
Treebfd-strict-mode
Introduced23.7.R1

Platforms

All

advertise
Synopsis Enable the advertise context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) bfd-strict-mode advertise
Treeadvertise

Description

Commands in this context configure BGP to advertise the Strict-BFD capability to peers that are within scope of this command and meet the following requirements:

  • The inherited or configured value for the bfd-liveness command that applies to the peer is true.

  • The interface associated with the peer has a valid BFD configuration.

When the preceding conditions are satisfied and two peers attempting to form a session both advertise the Strict-BFD capability, the BGP finite state machine in each router transitions the session state to established after the BFD session with the peer enters the up state.

When unconfigured, BGP does not advertise the Strict-BFD capability to peers.

Introduced23.7.R1

Platforms

All

holdtime number
Synopsis Maximum time BGP waits for the BFD session to come up
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) bfd-strict-mode advertise holdtime number
Treeholdtime

Description

This command configures the maximum time BGP waits for the BFD session to come up, provided that the Strict-BFD procedures apply to a session, and the negotiated BGP hold time is zero (no keepalives). If the negotiated BGP hold time is greater than zero, the advertised hold time is not considered.

Range1 to 65535
Unitsseconds
Default 30
Introduced23.7.R1

Platforms

All

next-hop-reachability boolean
Synopsis Consider next hop unreachable if BFD session is down
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) bfd-strict-mode next-hop-reachability boolean
Treenext-hop-reachability

Description

When configured to true, the router considers next-hop self routes belonging to specific address families received from a peer within scope of this command as having an unresolved next hop, provided that the following requirements are met:

  • The BFD session to the peer is in a down state.

  • There is a valid interface BFD configuration that applies to the peer.

  • There is a valid BFD liveness configuration that applies to the peer.

The unresolved state is maintained until the BFD session state changes to up or administratively down, even if there is a resolving route or tunnel that matches the BGP next-hop address.

Routes received from one peer with a BGP next-hop address equal to the address of another peer are not affected by the BFD session to the other peer.The behavior of the router when this command is true does not depend on whether Strict-BFD is used, as both features are independent.

Configuring this command to true only affects routes belonging to the following address families:

  • IPv4

  • IPv6

  • IPv4 VPN

  • IPv6 VPN

  • labeled unicast IPv4

  • labeled unicast IPv6

  • EVPN

  • IPv4 multicast

  • IPv6 multicast

  • IPv4 VPN multicast

  • IPv6 VPN multicast

When configured to false, the router does not consider next-hop self routes belonging to the preceding address families as having an unresolved next hop if the BFD session goes down.

Introduced23.7.R1

Platforms

All

block-prefix-sid boolean
Synopsis Block the prefix SID attribute
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) block-prefix-sid boolean
Treeblock-prefix-sid

Description

When configured to true, all prefix SID attributes are removed from all routes exchanged between EBGP and IBGP peers covered by the scope of the command. Locally-imposed prefix SID attributes are also removed.

When configured to false, all prefix SID attributes are propagated without restriction.

A change of this configuration causes the affected BGP sessions to flap.

Defaultfalse
Introduced19.10.R1

Platforms

All

client-reflect boolean
Synopsis Allow cluster RR to advertise routes to its clients
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) client-reflect boolean
Treeclient-reflect
Introduced16.0.R1

Platforms

All

cluster
Synopsis Enter the cluster context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) cluster
Treecluster
Introduced16.0.R1

Platforms

All

allow-local-fallback boolean
Synopsis Allow fallback to RR topology
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) cluster allow-local-fallback boolean
Treeallow-local-fallback

Description

When configured to true, this command allows the RR to advertise the best BGP path from its own topology location when there are no reachable routes from the client's ORR location. The ORR location must be specified before this command can be set to true.

When configured to false, this command no route is advertised to the client.

Defaultfalse
Introduced16.0.R1

Platforms

All

cluster-id string
Synopsis Route reflector cluster ID
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) cluster cluster-id string
Treecluster-id
Introduced16.0.R1

Platforms

All

orr-location number
Synopsis Optimal route reflection location for the cluster
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) cluster orr-location number
Treeorr-location

Description

This command configures an ORR location ID. If a cluster ID is also specified, the clients in that cluster receive routes optimal for that specific location.

With optimal route reflection, the best path advertised to a client takes location ID into account. If the tie-break for best path (or Add-Paths) comes down to next-hop IGP cost, the IGP costs will be calculated relative to the specified location. In the SR OS implementation, the IGP costs from arbitrary ORR locations are calculated using OSPF, OSPFv3, IS-IS, or BGP-LS information in the TE DB.

Range1 to 255
Introduced16.0.R1

Platforms

All

connect-retry number
Synopsis BGP connect retry timer value
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) connect-retry number
Treeconnect-retry
Range1 to 65535
Introduced16.0.R1

Platforms

All

damp-peer-oscillations
Synopsis Enable the damp-peer-oscillations context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) damp-peer-oscillations
Treedamp-peer-oscillations
Introduced16.0.R1

Platforms

All

error-interval number
Synopsis Time after a reset that the session must be error-free
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) damp-peer-oscillations error-interval number
Treeerror-interval

Description

This command sets the interval of time after a reset, during which the session must be error-free in order to reset the penalty counter and return the idle hold time to the initial wait time.

Range0 to 2048
Default30
Introduced 16.0.R1

Platforms

All

idle-hold-time
Synopsis Enter the idle-hold-time context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) damp-peer-oscillations idle-hold-time
Treeidle-hold-time
Introduced16.0.R1

Platforms

All

second-wait number
Synopsis Time that doubles after each repeated session failure
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) damp-peer-oscillations idle-hold-time second-wait number
Treesecond-wait

Description

This command defines the hold time that doubles after each repeated session failure that occurs in a short span of time.

Range1 to 2048
Default5
Introduced 16.0.R1

Platforms

All

damping boolean
Synopsis Use BGP route damping to reduce route flap
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) damping boolean
Treedamping
Introduced16.0.R1

Platforms

All

def-recv-evpn-encap keyword
Synopsis Default EVPN encapsulation type
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) def-recv-evpn-encap keyword
Treedef-recv-evpn-encap

Description

This command specifies the encapsulation type that BGP uses when an EVPN route is received without the Encapsulation Extended Community.

When unconfigured, the setting for this command is inherited from the BGP group-level configuration.

Optionsmpls, vxlan
Introduced 16.0.R1

Platforms

All

default-label-preference
Synopsis Enter the default-label-preference context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) default-label-preference
Treedefault-label-preference
Introduced19.5.R1

Platforms

All

default-preference
Synopsis Enter the default-preference context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) default-preference
Treedefault-preference
Introduced19.5.R1

Platforms

All

ebgp number
Synopsis Default preference for EBGP
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) default-preference ebgp number
Treeebgp
Range0 to 255
Introduced19.5.R1

Platforms

All

ibgp number
Synopsis Default preference for IBGP
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) default-preference ibgp number
Treeibgp
Range0 to 255
Introduced19.5.R1

Platforms

All

default-route-target boolean
Synopsis Send default RTC route (zero prefix length) to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) default-route-target boolean
Treedefault-route-target

Description

When configured to true, this command sends the default RTC route (zero prefix length) toward the selected peers.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, a default RTC route is not sent.

Introduced16.0.R1

Platforms

All

description string
Synopsis Text description
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

All

ebgp-default-reject-policy
Synopsis Enable the ebgp-default-reject-policy context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) ebgp-default-reject-policy
Treeebgp-default-reject-policy
Introduced19.5.R1

Platforms

All

egress-engineering
Synopsis Enable the egress-engineering context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) egress-engineering
Treeegress-engineering
Introduced21.7.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BGP egress engineering
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) egress-engineering admin-state keyword
Treeadmin-state

Description

This command administratively enables or disables egress engineering for the BGP. If enabled, peer node SIDs and peer adjacency SIDs are advertised in BGP-LS.

Optionsenable, disable
Default disable
Introduced21.7.R1

Platforms

All

egress-peer-engineering-label-unicast boolean
Synopsis Generate EPE label-unicast routes for neighbor
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) egress-peer-engineering-label-unicast boolean
Treeegress-peer-engineering-label-unicast

Description

When configured to true, BGP generates a label-unicast route for the /32 or /128 prefix that corresponds to the BGP neighbor address. This route can be advertised to other routers to recursively resolve unlabeled BGP routes for AS external destinations. This supports the Egress Peer Engineering (EPE) use case.

Defaultfalse
Introduced22.2.R1

Platforms

All

enforce-first-as boolean
Synopsis Enforce the configured peer AS value in received routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) enforce-first-as boolean
Treeenforce-first-as

Description

When configured to true for an EBGP session, all routes received from an EBGP peer are checked to ensure that the most recent ASN in the AS_PATH attribute of each route matches the configured AS of the session. If there is not a match, the session is reset (if the update-fault-tolerance command in the error-handling context is set to false) or the session is left up but the route is treated as withdrawn (if update-fault-tolerance is set to true).

This command does not flap an established session because it applies only to routes received after the command is issued.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, received routes are not checked for compliance with the rule.

Introduced16.0.R1

Platforms

All

error-handling
Synopsis Enter the error-handling context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) error-handling
Treeerror-handling
Introduced16.0.R1

Platforms

All

update-fault-tolerance boolean
Synopsis Tolerate non-critical errors in UPDATE messages
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) error-handling update-fault-tolerance boolean
Treeupdate-fault-tolerance

Description

When configured to true, non-critical errors are handled with treat-as-withdraw, attribute-discard, and other non-disruptive approaches that do not cause a session reset. Critical errors still trigger a session reset.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, all errors trigger a session reset.

Introduced16.0.R1

Platforms

All

export
Synopsis Enable the export context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) export
Treeexport

Description

Commands in this context specify route policies that control the handling of outbound routes transmitted to certain peers. Route policies are configured in the configure policy-options context.

When this context is unconfigured, the policy association for the group is inherited from the BGP global-level configuration.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis BGP export policy name
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) export policy (policy-expr-string | string)
Treepolicy

Description

This command specifies route policies that control the handling of outbound routes transmitted to certain peers.

Each object in this command is either a policy logical expression or the name of a single policy. The objects are evaluated in the specified order to determine the modifications of each route and the final action to accept or reject the route.

Only one of the objects referenced by the command can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or"start@variable@".

String Length1 to 255
Max. Instances15
Min. Instances1

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

extended-nh-encoding
Synopsis Enable the extended-nh-encoding context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) extended-nh-encoding
Treeextended-nh-encoding

Description

Commands in this context specify the address families enabled to advertise the capability to receive label IPv4 routes, VPN IPv4 routes, or IPv6 next hops from peers. The peers should not send such routes unless notification has been received of this capability. If the router receives an enabled address family route from a peer to which it did not advertise the necessary capability, the UPDATE message will be considered malformed. This causes either a session reset or treat-as-withdraw behavior depending on the error handling settings.

When the context is unconfigured, command settings are inherited from the higher level BGP configuration.

Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Advertise encoding capability for IPv4 routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) extended-nh-encoding ipv4 boolean
Treeipv4
Defaultfalse
Introduced19.5.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise encoding capability for VPN-IPv4 routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) extended-nh-encoding vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

family
Synopsis Enable the family context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family
Treefamily
Introduced16.0.R1

Platforms

All

bgp-ls boolean
Synopsis Advertise MP-BGP support for the BGP-LS address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family bgp-ls boolean
Treebgp-ls
Defaultfalse
Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise MP-BGP support for the EVPN address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family evpn boolean
Treeevpn
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-ipv4 boolean
Synopsis Advertise support for the flowspec-IPv4 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family flow-ipv4 boolean
Treeflow-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-ipv6 boolean
Synopsis Advertise support for the flowspec-IPv6 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family flow-ipv6 boolean
Treeflow-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

flow-vpn-ipv4 boolean
Synopsis Advertise support for FlowSpec-VPN IPv4 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family flow-vpn-ipv4 boolean
Treeflow-vpn-ipv4
Defaultfalse
Introduced22.7.R1

Platforms

All

flow-vpn-ipv6 boolean
Synopsis Advertise support for FlowSpec-VPN IPv6 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family flow-vpn-ipv6 boolean
Treeflow-vpn-ipv6
Defaultfalse
Introduced22.7.R1

Platforms

All

ipv4 boolean
Synopsis Add support for the IPv4 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Advertise MP-BGP support for the IPv6 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

l2-vpn boolean
Synopsis Advertise MP-BGP support for the L2-VPN address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family l2-vpn boolean
Treel2-vpn
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise support for the label-IPv4 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family label-ipv4 boolean
Treelabel-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise support for the label-IPv6 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family label-ipv6 boolean
Treelabel-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-ipv4 boolean
Synopsis Advertise support for the MCAST-IPv4 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mcast-ipv4 boolean
Treemcast-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-ipv6 boolean
Synopsis Advertise support for the MCAST-IPv6 address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mcast-ipv6 boolean
Treemcast-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv4 boolean
Synopsis Advertise support for the IPv4 VPN MCAST address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mcast-vpn-ipv4 boolean
Treemcast-vpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mcast-vpn-ipv6 boolean
Synopsis Advertise support for the IPv6 VPN MCAST address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mcast-vpn-ipv6 boolean
Treemcast-vpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

mdt-safi boolean
Synopsis Advertise MP-BGP support for MDT-SAFI address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mdt-safi boolean
Treemdt-safi
Defaultfalse
Introduced16.0.R1

Platforms

All

ms-pw boolean
Synopsis Advertise support for multi-segment PW address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family ms-pw boolean
Treems-pw
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn-ipv4 boolean
Synopsis Advertise support for the IPv4 MCAST VPN address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mvpn-ipv4 boolean
Treemvpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn-ipv6 boolean
Synopsis Advertise support for the IPv6 MCAST VPN address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family mvpn-ipv6 boolean
Treemvpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

route-target boolean
Synopsis Advertise MP-BGP support for RT constraint routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family route-target boolean
Treeroute-target
Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-ipv4 boolean
Synopsis Advertise MP-BGP support for the SR-policy-IPv4 family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family sr-policy-ipv4 boolean
Treesr-policy-ipv4

Description

This command allows the router to advertise the capability for AFI1/SAFI73, which corresponds to BGP routes that encode a segment routing policy to an IPv4 destination. 

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-ipv6 boolean
Synopsis Advertise MP-BGP support for the SR-policy-IPv6 family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family sr-policy-ipv6 boolean
Treesr-policy-ipv6

Description

This command allows the router to advertise the capability for AFI2/SAFI73, which corresponds to BGP routes that encode a segment routing policy to an IPv6 destination. 

Defaultfalse
Introduced19.10.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise MP-BGP support for IPv4 VPN address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise MP-BGP support for IPv6 VPN address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) family vpn-ipv6 boolean
Treevpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

fast-external-failover boolean
Synopsis Drop external BGP session immediately when link fails
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) fast-external-failover boolean
Treefast-external-failover

Description

When this command inherits a value of true, the router drops an external BGP session on a single-hop route immediately when the local interface goes down.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to true.

When configured to false, the BGP session remains up until the hold time expires.

Introduced16.0.R1

Platforms

All

graceful-restart
Synopsis Enable the graceful-restart context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart
Treegraceful-restart

Description

Commands in this context configure BGP graceful restart helper procedures for address families included in the GR capabilities of both peers.

When this context is unconfigured, the command settings are inherited from the BGP group-level configuration.

Introduced16.0.R1

Platforms

All

gr-notification boolean
Synopsis Perform graceful restart procedures after NOTIFICATION
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart gr-notification boolean
Treegr-notification

Description

When configured to true, the Graceful Restart capability sent by the router indicates support for NOTIFICATION messages. If the peer also supports this capability, the session is restarted gracefully (while preserving forwarding) if either peer sends a NOTIFICATION message due to some type of event or error.

When configured to false, NOTIFICATION messages are not supported.

Defaultfalse
Introduced16.0.R1

Platforms

All

long-lived
Synopsis Enable the long-lived context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived
Treelong-lived

Description

Commands in this context configure the BGP Long-Lived Graceful-Restart (LLGR) procedures.

LLGR, known informally as BGP persistence, is an extension of BGP GR that allows a session to stay down for a longer period of time. During this time, learned routes are marked and re-advertised as stale but they can continue to be used as routes of last resort.

The LLGR handling of a session failure can be invoked immediately or it can be delayed until the end of the traditional GR restart window.

Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived family keyword
Treefamily
Introduced16.0.R1

Platforms

All

[family-type] keyword
Synopsis Family type for family-specific LLGR configuration
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived family keyword
Treefamily
Optionsipv4, vpn-ipv4, ipv6, vpn-ipv6, l2-vpn, flow-ipv4, route-target, flow-ipv6, label-ipv4, label-ipv6, flow-vpn-ipv4, flow-vpn-ipv6

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertised-stale-time number
Synopsis LLGR stale routes time for family override
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived family keyword advertised-stale-time number
Treeadvertised-stale-time

Description

This command configures the long-lived stale routes time that is advertised by the router in its LLGR capability.

This command applies to all AFI/SAFI in the advertised LLGR capability with a family-specific override.

Range0 to 16777215
Default86400
Introduced 16.0.R1

Platforms

All

helper-override-stale-time number
Synopsis Locally-configured stale routes override time
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived family keyword helper-override-stale-time number
Treehelper-override-stale-time

Description

This command configures a locally-imposed LLGR stale time that overrides the long-lived stale routes time that is advertised by the router in its LLGR capability. This is a family-specific override value.

Range0 to 16777216
Default16777216
Introduced16.0.R1

Platforms

All

forwarding-bits-set keyword
Synopsis BGP LLGR forwarding-bit behavior for address family
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived forwarding-bits-set keyword
Treeforwarding-bits-set

Description

This command determines the setting of the F bit in the GR and LLGR capabilities advertised by the router. When the F bit is set for an address family, it indicates that the advertising router is able to preserve forwarding state for the routes of that address family across the last restart. When the session is re-established after a restart and the F bit is not set, all stale routes from the peer are immediately removed for the corresponding address family.

This command allows the F bit to be set for all address families or only for non-forwarding address families (L2-VPN, route target, flow-IPv4, and flow-IPv6).

Optionsnone, all, non-fwd
Defaultnone
Introduced16.0.R1

Platforms

All

helper-override-restart-time number
Synopsis Locally-configured override for restart time
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived helper-override-restart-time number
Treehelper-override-restart-time

Description

This command overrides the restart time advertised by a peer (in its GR capability) with a locally-configured value. This override applies only to AFI/SAFI that were included in the GR capability of the peer. The restart-time is always zero for AFI/SAFI not included in the GR capability. This command is useful if the local router wants to force the LLGR phase to begin after a set time for all protected AFI/SAFI.

Range0 to 4095
Introduced16.0.R1

Platforms

All

helper-override-stale-time number
Synopsis Locally-configured stale routes override time
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived helper-override-stale-time number
Treehelper-override-stale-time

Description

This command configures a locally-imposed LLGR stale time that overrides the long-lived stale routes time that is advertised by the router in its LLGR capability.

This command applies to all AFI/SAFI in the advertised LLGR capability except for any AFI/SAFI with a family-specific override.

Range0 to 16777215
Introduced16.0.R1

Platforms

All

without-no-export boolean
Synopsis Advertise LLGR stale routes to non-LLGR peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) graceful-restart long-lived without-no-export boolean
Treewithout-no-export

Description

When configured to true, LLGR stale routes can be advertised to any peer (EBGP or IBGP) that did not signal the LLGR capability. For IBGP and confederation-EBGP peers that did not advertise the LLGR capability, the local preference attribute in the advertised stale routes is automatically set to 0.

When configured to false, LLGR stale routes are not advertised to any EBGP peer that did not signal the LLGR capability. For IBGP and confederation-EBGP peers that did not advertise the LLGR capability, the local preference attribute in the advertised stale routes is automatically set to 0 and a NO_EXPORT standard community is automatically added to the routes.

Defaultfalse
Introduced16.0.R1

Platforms

All

group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisBGP peer group
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) group reference
Treegroup

Reference

configure router string bgp group string

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

hold-time
Synopsis Enter the hold-time context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) hold-time
Treehold-time
Introduced16.0.R1

Platforms

All

seconds number
Synopsis Maximum hold time between successive messages
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) hold-time seconds number
Treeseconds

Description

The BGP hold time specifies the maximum time BGP waits between successive messages (either keepalive or update) from its peer, before closing the connection.

Even though the implementation allows setting the keepalive timer at the BGP neighbor level times separately, the configured keepalive timer is overridden by this value under the following circumstances:

  • If the specified hold time is less than the configured keepalive time, then the operational keepalive time is set to a third of the hold-time; the configured keepalive time is not changed.

  • If the hold time is set to zero, the operational value of the keepalive time is set to zero; the configured keepalive time is not changed. This means that the connection with the peer is up permanently and no keepalive packets are sent to the peer.

When unconfigured, the command setting is inherited from the BGP group-level configuration.

Range0 | 3 to 65535
Introduced16.0.R1

Platforms

All

import
Synopsis Enable the import context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) import
Treeimport

Description

Commands in this context specify route policies that control the handling of inbound routes received from certain peers. Route policies are configured in the configure policy-options context.

When this context is unconfigured, the policy association is inherited from the BGP group-level configuration.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis Names of the BGP import policies
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) import policy (policy-expr-string | string)
Treepolicy

Description

This command specifies route policies that control the handling of inbound routes received from certain peers.

Each object in this command is either a policy logical expression or the name of a single policy. The objects are evaluated in the specified order to determine the modifications of each route and the final action to accept or reject the route.

Only one of the objects referenced by the command can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or"start@variable@".

String Length1 to 255
Max. Instances15
Min. Instances1

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

initial-send-delay-zero boolean
Synopsis Send BGP updates as soon as the session comes up
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) initial-send-delay-zero boolean
Treeinitial-send-delay-zero

Description

When configured to true, BGP updates are sent as soon as the session comes up.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, BGP waits to send UPDATE messages for the minimum route advertisement time after a session is established.

Introduced16.0.R1

Platforms

All

keepalive number
Synopsis Time after which the BGP KEEPALIVE message is sent
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) keepalive number
Treekeepalive
Range0 to 21845
Introduced16.0.R1

Platforms

All

l2vpn-cisco-interop boolean
Synopsis Allow translation from Cisco non-compliant NLRI format
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) l2vpn-cisco-interop boolean
Treel2vpn-cisco-interop
Defaultfalse
Introduced16.0.R1

Platforms

All

label-preference number
Synopsis Route preference for routes from labeled-unicast peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) label-preference number
Treelabel-preference
Range1 to 255
Introduced16.0.R1

Platforms

All

link-bandwidth
Synopsis Enter the link-bandwidth context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) link-bandwidth
Treelink-bandwidth
Introduced16.0.R3

Platforms

All

accept-from-ebgp
Synopsis Enable the accept-from-ebgp context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) link-bandwidth accept-from-ebgp
Treeaccept-from-ebgp
Introduced16.0.R4

Platforms

All

add-to-received-ebgp
Synopsis Enable the add-to-received-ebgp context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) link-bandwidth add-to-received-ebgp
Treeadd-to-received-ebgp
Introduced16.0.R3

Platforms

All

aggregate-used-paths
Synopsis Enable the aggregate-used-paths context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) link-bandwidth aggregate-used-paths
Treeaggregate-used-paths
Introduced16.0.R4

Platforms

All

send-to-ebgp
Synopsis Enable the send-to-ebgp context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) link-bandwidth send-to-ebgp
Treesend-to-ebgp
Introduced16.0.R4

Platforms

All

local-address (ipv4-address-no-zone | ipv6-address-no-zone | interface-name)
Synopsis Local IP address used when communicating with BGP peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) local-address (ipv4-address-no-zone | ipv6-address-no-zone | interface-name)
Treelocal-address
String Length1 to 32
Introduced16.0.R1

Platforms

All

local-as
Synopsis Enter the local-as context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) local-as
Treelocal-as
Introduced16.0.R1

Platforms

All

as-number number
Synopsis Local (or virtual) BGP AS number
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) local-as as-number number
Treeas-number
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

prepend-global-as boolean
Synopsis Prepend global ASN when advertising routes to BGP peer
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) local-as prepend-global-as boolean
Treeprepend-global-as

Description

When configured to true, the global ASN is added to the AS_PATH attribute in outbound routes sent to the peer.

When configured to false, the global ASN is not included in the AS_PATH attribute.

Defaulttrue
Introduced16.0.R1

Platforms

All

private boolean
Synopsis Hide the local ASN in sent paths learned from peering
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) local-as private boolean
Treeprivate

Description

When configured to true, the local AS number is only advertised to peers that use the local ASN for establishing BGP peering sessions.

When configured to false, the local ASN is advertised to all peers, including those that can use the global ASN for establishing BGP peering sessions.

Defaultfalse
Introduced16.0.R1

Platforms

All

local-preference number
Synopsis Default local preference if not in incoming routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) local-preference number
Treelocal-preference
Range0 to 4294967295
Introduced16.0.R1

Platforms

All

loop-detect keyword
Synopsis Strategy for loop detection in the AS path
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) loop-detect keyword
Treeloop-detect
Optionsdrop-peer, ignore-loop, off, discard-route
Introduced16.0.R1

Platforms

All

med-out (number | keyword)
Synopsis Default MED attribute value to advertise to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) med-out (number | keyword)
Treemed-out
Max. Range0 to 4294967295
Optionsigp-cost
Introduced16.0.R1

Platforms

All

monitor
Synopsis Enable the monitor context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) monitor
Treemonitor

Description

Commands in this context specify BMP-related configurations at the BGP neighbor level.

When this context is unconfigured, the command settings are inherited from the BGP group-level configuration.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BMP monitoring
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) monitor admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

all-stations boolean
Synopsis Send BMP messages to all configured stations
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) monitor all-stations boolean
Treeall-stations

Description

When configured to true, this command specifies that BMP messages are to be sent to all configured BMP monitoring stations.

When configured to false, the command is not used to indicate the stations which can receive BMP messages. The station command (at the same context level) identifies the BMP stations for which BMP messages are to be sent.

Defaultfalse
Introduced16.0.R1

Platforms

All

route-monitoring
Synopsis Enter the route-monitoring context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) monitor route-monitoring
Treeroute-monitoring
Introduced16.0.R1

Platforms

All

station [station-name] reference
Synopsis Add a list entry for station
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) monitor station reference
Treestation

Description

This command configures the set of BMP monitoring stations for which BMP messages are to be sent.

Max. Instances8
Introduced16.0.R1

Platforms

All

[station-name] reference
Synopsis BMP monitoring station
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) monitor station reference
Treestation

Reference

configure bmp station string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

multihop number
Synopsis TTL in IP packet headers for EBGP peers multi-hops away
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) multihop number
Treemultihop
Range1 to 255
Introduced16.0.R1

Platforms

All

next-hop-self boolean
Synopsis Advertise routes with local address as next-hop address
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-self boolean
Treenext-hop-self

Description

When configured to true, this command configures BGP to advertise routes to members of a group using a local address of the BGP instance as the BGP next-hop address.

Note that this command is set without exception, regardless of the route source (EBGP or IBGP) or its family. When used with VPN-IPv4 and VPN-IPv6 routes, the configure router bgp rr-vpn-forwarding command should also be configured.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, protocol standard behavior is applied to determine whether to set next-hop-self in advertised routes.

Introduced16.0.R1

Platforms

All

next-hop-unchanged
Synopsis Enable the next-hop-unchanged context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-unchanged
Treenext-hop-unchanged

Description

Commands in this context specify the IP address families where the next hop remains unchanged when sending BGP routes to peers of the neighbor.

Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Advertise EVPN routes with unchanged BGP next hop
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-unchanged evpn boolean
Treeevpn
Defaultfalse
Introduced20.2.R1

Platforms

All

label-ipv4 boolean
Synopsis Advertise label-IPv4 routes with unchanged BGP next hop
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-unchanged label-ipv4 boolean
Treelabel-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

label-ipv6 boolean
Synopsis Advertise label-IPv6 routes with unchanged BGP next hop
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-unchanged label-ipv6 boolean
Treelabel-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Advertise VPN IPv4 routes with unchanged BGP next hop
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-unchanged vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced20.2.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Advertise VPN IPv6 routes with unchanged BGP next hop
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) next-hop-unchanged vpn-ipv6 boolean
Treevpn-ipv6
Defaultfalse
Introduced20.2.R1

Platforms

All

origin-validation
Synopsis Enable the origin-validation context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) origin-validation
Treeorigin-validation
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Enable support for unlabeled unicast IPv4 routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) origin-validation ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Enable support for unlabeled unicast IPv6 routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) origin-validation ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

outbound-route-filtering
Synopsis Enable the outbound-route-filtering context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) outbound-route-filtering
Treeoutbound-route-filtering

Description

Commands in this context configure the send and receive capabilities for Outbound Route Filtering (ORF).

When this context is unconfigured, the command settings are inherited from the BGP group-level configuration.

Introduced16.0.R1

Platforms

All

extended-community
Synopsis Enable the extended-community context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) outbound-route-filtering extended-community
Treeextended-community

Description

Commands in this context configure the ORF send and receive capabilities based on Extended Communities.

When this context is unconfigured, the command settings are inherited from the group-level configuration.

Introduced16.0.R1

Platforms

All

accept-orf boolean
Synopsis Negotiate with peer to accept BGP ORF filters
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) outbound-route-filtering extended-community accept-orf boolean
Treeaccept-orf

Description

When configured to true, the receive capability in the BGP ORF is negotiated with a peer and ORF filters can be accepted from peers.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the accept capability in the BGP ORF is removed and any existing ORF filters that are currently in place are cleared.

Introduced16.0.R1

Platforms

All

send-orf
Synopsis Enable the send-orf context
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) outbound-route-filtering extended-community send-orf
Treesend-orf

Description

Commands in this context allow BGP to negotiate the send capability in the ORF negotiation with a peer. The send capability also causes the router to send a community filter, prefix filter, or AS path filter configured as an inbound filter on the BGP session to its peer as an ORF Action ADD.

When this context is unconfigured, the command settings are inherited from the BGP group-level configuration.

Introduced16.0.R1

Platforms

All

route-target [community-name] string
Synopsis Add a list entry for route-target
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) outbound-route-filtering extended-community send-orf route-target string
Treeroute-target
Introduced16.0.R1

Platforms

All

passive boolean
Synopsis Use passive mode for BGP communication
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) passive boolean
Treepassive
Introduced16.0.R1

Platforms

All

path-mtu-discovery boolean
Synopsis Enable path MTU discovery
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) path-mtu-discovery boolean
Treepath-mtu-discovery

Description

When configured to true, Path MTU Discovery (PMTUD) is enabled for the associated TCP connections.

When set to true, PMTUD is activated toward an IPv4 BGP neighbor and the Don’t Fragment (DF) bit is set in the IP header of all IPv4 packets sent to the peer. If any device along the path toward the peer cannot forward the packet because the IP MTU of the interface is smaller than the IP packet size, this device drops the packet and sends an ICMP or ICMPv6 error message encoding the interface MTU. When the router receives the ICMP or ICMPv6 message, it lowers the TCP maximum segment size limit from the previous value so that the IP MTU constraint can be accommodated.

When PMTUD is configured to false and there is no TCP MSS configuration that can be associated with a BGP neighbor (in either the BGP configuration or the first hop IP interface configuration), the router advertises a value of only 1024 bytes as the TCP MSS option value, limiting received TCP segments to that size.

Introduced16.0.R1

Platforms

All

peer-as number
Synopsis Peer AS number
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) peer-as number
Treepeer-as

Description

This command configures the autonomous system number for the peer. The peer AS number must be configured for each configured peer.

For EBGP peers, the peer AS number configured must be different from the autonomous system number configured for this router under the global level since the peer will be in a different autonomous system than this router.

For IBGP peers, the peer AS number must be the same as the autonomous system number of this router configured under the global level.

Range1 to 4294967295
Introduced16.0.R1

Platforms

All

peer-creation-type keyword
Synopsis Peer creation type
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) peer-creation-type keyword
Treepeer-creation-type
Optionsstatic, dynamic, dynamic-if-remote, dynamic-if-local
Defaultstatic
Introduced 16.0.R1

Platforms

All

peer-ip-tracking boolean
Synopsis Enable BGP peer tracking
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) peer-ip-tracking boolean
Treepeer-ip-tracking

Description

When configured to true, this command enables BGP peer tracking.

Peer tracking should be used with caution. Peer tracking can tear a session down even if the loss of connectivity turns out to be short-lived (for example, while the IGP protocol is re-converging). Next-hop tracking, which is always enabled, handles temporary connectivity issues more effectively.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, peer tracking is disabled.

Introduced16.0.R1

Platforms

All

preference number
Synopsis Route preference for routes learned from all peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) preference number
Treepreference

Description

This command configures the route preference for routes learned from the configured peers.

The lower the preference value, the higher the chance of the route being the active route. The router assigns BGP routes the highest default preference as compared to routes that are direct, static or learned via MPLS or OSPF.

When unconfigured, the command setting is inherited from the group-level configuration.

Range1 to 255
Introduced16.0.R1

Platforms

All

prefix-limit [family] keyword
Synopsis Enter the prefix-limit list instance
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword
Treeprefix-limit
Introduced16.0.R1

Platforms

All

[family] keyword
Synopsis Address family to which the limit applies
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword
Treeprefix-limit
Optionsipv4, vpn-ipv4, ipv6, mcast-ipv4, vpn-ipv6, l2-vpn, mvpn-ipv4, mdt-safi, ms-pw, flow-ipv4, route-target, mcast-vpn-ipv4, mvpn-ipv6, flow-ipv6, evpn, mcast-ipv6, label-ipv4, label-ipv6, bgp-ls, mcast-vpn-ipv6, sr-policy-ipv4, sr-policy-ipv6, flow-vpn-ipv4, flow-vpn-ipv6

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

hold-excess number
Synopsis Percentage of maximum routes to install in route table
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword hold-excess number
Treehold-excess

Description

This command specifies the percentage of maximum routes that are allowed to be installed in the route table for the configured address family. If a peer within scope of the configuration exceeds the limit, the overflow routes are held in the BGP RIB as inactive routes and are ineligible for forwarding and advertisement to other peers. If the post-import command is configured to true, only routes not rejected by import policies count toward the limit.

A BGP route in an overflow state is reconsidered for activation and reinstallation when an UPDATE message is received for the route.

This command is mutually exclusive with the idle-timeout and log-only commands.

Range1 to 100
Introduced23.7.R1

Platforms

All

idle-timeout number
Synopsis Time which BGP peering remains idle before reconnecting
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword idle-timeout number
Treeidle-timeout

Description

This command defines the idle time after an administrative take-down before BGP re-establishes a session and reconnects to a peer.

When unconfigured, the command inherits the value from the group-level configuration.

Range1 to 1024
Introduced16.0.R1

Platforms

All

log-only boolean
Synopsis Send warning message at threshold instead of take-down
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword log-only boolean
Treelog-only
Defaultfalse
Introduced16.0.R1

Platforms

All

maximum number
Synopsis Maximum number of routes to be learned from a peer
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword maximum number
Treemaximum

Description

This command configures the maximum number of BGP routes than can be received from a peer before administrative action is taken.

Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R2

Platforms

All

post-import boolean
Synopsis Apply limit only to routes accepted by import policies
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword post-import boolean
Treepost-import
Defaultfalse
Introduced16.0.R1

Platforms

All

threshold number
Synopsis Percentage threshold that triggers a warning message
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) prefix-limit keyword threshold number
Treethreshold
Range1 to 100
Default90
Introduced 16.0.R1

Platforms

All

remove-private
Synopsis Enable the remove-private context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) remove-private
Treeremove-private
Introduced16.0.R1

Platforms

All

limited boolean
Synopsis Remove private ASNs up to first public ASN encountered
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) remove-private limited boolean
Treelimited
Defaultfalse
Introduced16.0.R1

Platforms

All

replace boolean
Synopsis Replace private ASN with global ASN before advertising
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) remove-private replace boolean
Treereplace
Defaultfalse
Introduced19.10.R1

Platforms

All

skip-peer-as boolean
Synopsis Keep private ASN if it is the same as the BGP peer ASN
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) remove-private skip-peer-as boolean
Treeskip-peer-as
Defaultfalse
Introduced16.0.R1

Platforms

All

segment-routing-v6
Synopsis Enable the segment-routing-v6 context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) segment-routing-v6
Treesegment-routing-v6
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

route-advertisement
Synopsis Enable the route-advertisement context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) segment-routing-v6 route-advertisement
Treeroute-advertisement
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

drop-routes-with-srv6-tlvs boolean
Synopsis Drop BGP routes with SRv6 TLVs
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) segment-routing-v6 route-advertisement drop-routes-with-srv6-tlvs boolean
Treedrop-routes-with-srv6-tlvs

Description

When configured to true, the router drops and does not advertise BGP routes (that belong to any address family) with SRv6 TLVs.

When configured to false, the router advertises BGP routes with SRv6 TLVs.

Defaultfalse
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) segment-routing-v6 route-advertisement family keyword
Treefamily
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[family-type] keyword
Synopsis IP address type that SRv6 route attributes apply to
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) segment-routing-v6 route-advertisement family keyword
Treefamily
Optionsipv4, ipv6

Notes

This element is part of a list key.

Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

strip-srv6-tlvs boolean
Synopsis Strip SRv6 TLVs from BGP routes advertised to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) segment-routing-v6 route-advertisement family keyword strip-srv6-tlvs boolean
Treestrip-srv6-tlvs

Description

When configured to true, BGP routes that belong to the address family specified using the family command are advertised to peers with SRv6 TLVs removed. Locally or remotely added SRv6 TLVs can be removed.

When configured to false, SRv6 TLVs are not stripped from BGP routes advertised to peers.

Defaultfalse
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

send-communities
Synopsis Enter the send-communities context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-communities
Treesend-communities
Introduced16.0.R1

Platforms

All

extended boolean
Synopsis Advertise the Extended Communities attribute to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-communities extended boolean
Treeextended

Description

When unconfigured, this command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to true.

When this command inherits a value of true, BGP extended communities are sent to peers in the Extended Communities attribute.

When configured to false, all extended communities are removed from all routes advertised to BGP peers.

Introduced16.0.R1

Platforms

All

large boolean
Synopsis Advertise the Large Communities attribute to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-communities large boolean
Treelarge

Description

When unconfigured, this command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to true.

When this command inherits a value of true, BGP large communities are sent to peers in the Large Communities attribute.

When configured to false, all large communities are removed from all routes advertised to BGP peers.

Introduced16.0.R1

Platforms

All

standard boolean
Synopsis Advertise the Communities attribute to peers
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-communities standard boolean
Treestandard

Description

When unconfigured, this command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to true.

When this command inherits a value of true, BGP standard communities are sent to peers in the Communities attribute.

When configured to false, all standard communities are removed from all routes advertised to BGP peers.

Introduced16.0.R1

Platforms

All

send-default
Synopsis Enable the send-default context
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-default
Treesend-default
Introduced19.7.R1

Platforms

All

ipv4 boolean
Synopsis Enable IPv4 family type
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-default ipv4 boolean
Treeipv4
Defaultfalse
Introduced19.7.R1

Platforms

All

ipv6 boolean
Synopsis Enable IPv6 family type
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) send-default ipv6 boolean
Treeipv6
Defaultfalse
Introduced19.7.R1

Platforms

All

split-horizon boolean
Synopsis Prevent routes being reflected back to best-route peer
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split-horizon.

This command prevents routes from being reflected back to a peer that sends the best route. It applies to routes of all address families and to any type of sending peer; confed-EBGP, EBGP and IBGP.

Enabling the split-horizon functionality may have a detrimental impact on peer and route scaling and should only be used when absolutely necessary.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the use of split-horizon is disabled.

Introduced16.0.R1

Platforms

All

tcp-mss (number | keyword)
Synopsis TCP maximum segment size override
Context configure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) tcp-mss (number | keyword)
Treetcp-mss

Description

This command configures an override for the TCP maximum segment size to use with a specific peer or set of peers (depending on the scope of the command).

The configured value controls two properties of the TCP connection as follows:

TCP MSS option - The router advertises the TCP MSS option value in the TCP SYN packet it sends as part of the 3-way handshake. The advertised value may be lower than the configured value, depending on the IP MTU of the first hop IP interface. The peers must abide by this value when sending TCP segments to the local router.

TCP maximum segment size - The actual transmitted size may be lower than the configured value, depending on the TCP MSS option value signaled by the peers, the effect of path MTU discovery, or other factors.

Range384 to 9746
Optionsip-stack
Introduced21.2.R1

Platforms

All

ttl-security number
Synopsis Minimum TTL value for an incoming BGP packet
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) ttl-security number
Treettl-security

Description

This command configures the minimum TTL value that BGP will accept from an incoming packet. A packet with a TTL value less than the minimum configured TTL value is discarded.

When unconfigured, the command inherits the value of the group-level setting.

Range1 to 255
Introduced16.0.R1

Platforms

All

type keyword
Synopsis BGP peer type
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) type keyword
Treetype
Optionsno-type, internal, external
Introduced16.0.R1

Platforms

All

vpn-apply-export boolean
Synopsis Apply base-instance BGP export policies to VPN routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) vpn-apply-export boolean
Treevpn-apply-export

Description

When configured to true, base-instance BGP export route policies are applied to VPN-IPv4/6, MVPN-IPv4/6, L2-VPN, MDT-SAFI, MCAST-VPN-IPv4, and EVPN routes.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the export policies are not applied.

Introduced16.0.R1

Platforms

All

vpn-apply-import boolean
Synopsis Apply base-instance BGP import policies to VPN routes
Contextconfigure router string bgp neighbor (ipv4-address-with-zone | ipv6-address-with-zone) vpn-apply-import boolean
Treevpn-apply-import

Description

When configured to true, base-instance BGP import route policies are applied to VPN-IPv4/6, MVPN-IPv4/6, L2-VPN, MDT-SAFI, MCAST-VPN-IPv4, and EVPN routes.

When unconfigured, the command inherits the value of the group-level setting (true or false). The command cannot be explicitly configured to false.

When this command inherits a value of false, the import policies are not applied.

Introduced16.0.R1

Platforms

All

neighbor-trust
Synopsis Enter the neighbor-trust context
Contextconfigure router string bgp neighbor-trust
Treeneighbor-trust

Description

Commands in this context enable a label security feature at an inter-AS boundary for the specified IP families.

This label security feature allows the configuration of a router, acting in a PE or in an ASBR role, to accept packets of VPN-IP or EVPN prefixes only from direct EBGP neighbors to which it advertised a service label.

The untrusted state identifies the participating interfaces. The router supports a maximum of 15 network interfaces that can participate in this feature.

At a high level, BGP tracks each direct EBGP neighbor over an untrusted interface and to which it sent a prefix label. For each of those prefixes, BGP programs a bit map in the ILM record that indicates, on a per-untrusted interface basis, whether the matching received packets must be forwarded or dropped.

Introduced16.0.R4

Platforms

All

evpn boolean
Synopsis Enable inter-AS label security for the EVPN family
Contextconfigure router string bgp neighbor-trust evpn boolean
Treeevpn
Defaultfalse
Introduced23.3.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Enable inter-AS label security for the VPN-IPv4 family
Contextconfigure router string bgp neighbor-trust vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced16.0.R4

Platforms

All

vpn-ipv6 boolean
Synopsis Enable inter-AS label security for the VPN-IPv6 family
Contextconfigure router string bgp neighbor-trust vpn-ipv6 boolean
Treevpn-ipv6
Defaultfalse
Introduced16.0.R4

Platforms

All

next-hop-resolution
Synopsis Enter the next-hop-resolution context
Contextconfigure router string bgp next-hop-resolution
Treenext-hop-resolution
Introduced16.0.R1

Platforms

All

allow-unresolved-leaking boolean
Synopsis Allow unresolved BGP routes to be leaked to VPRN routes
Contextconfigure router string bgp next-hop-resolution allow-unresolved-leaking boolean
Treeallow-unresolved-leaking

Description

When configured to true, this command instructs BGP in the base router instance to allow its routes to be leaked to other (VPRN) BGP instances even if the routes to be leaked do not have a BGP next-hop that can be resolved by the base instance.

When configured to false, VPRN cannot import a route.

Defaultfalse
Introduced19.10.R1

Platforms

All

labeled-routes
Synopsis Enter the labeled-routes context
Contextconfigure router string bgp next-hop-resolution labeled-routes
Treelabeled-routes
Introduced16.0.R1

Platforms

All

allow-static boolean
Synopsis Allow static routes to resolve BGP next-hop
Contextconfigure router string bgp next-hop-resolution labeled-routes allow-static boolean
Treeallow-static

Description

When configured to true, the BGP next-hop of label-IPv4, label-IPv6, VPN-IPv4, and VPN-IPv6 routes received from any EBGP or IBGP peer can be resolved using static routes, except for static default routes (0/0 and ::/0).

A static route is less preferred than a local or interface route for resolving the BGP next-hop of labeled route but is more preferred than other IGP routes or tunnels.

When configured to false, BGP next-hop resolution using static routes is not allowed.

A label-IPv4 or label-IPv6 route can be resolved by a static blackhole route, even when this command is configured to false, but only if the static blackhole route is the longest prefix match (LPM) static route for the BGP next-hop address.

Defaultfalse
Introduced16.0.R1

Platforms

All

rr-use-route-table boolean
Synopsis Use RTM to resolve BGP next-hop if TTM resolution fails
Contextconfigure router string bgp next-hop-resolution labeled-routes rr-use-route-table boolean
Treerr-use-route-table

Description

When configured to true, this command enables BGP to perform a lookup of IGP routes in the route table to resolve the BGP next-hop of label-IPv4 and label-IPv6 routes. This is useful for a Route Reflector (RR) that does not participate in tunnel signaling protocols such as LDP and RSVP and therefore, does not have tunnels to resolve the BGP next-hops of label-unicast routes.

Disable route table installation (via the route-table-install command) before setting this command to true; otherwise, forwarding of label routes resolved in this way will be incorrect.

When configured to false, RTM next-hop resolution is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

transport-tunnel
Synopsis Enter the transport-tunnel context
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel
Treetransport-tunnel

Description

Commands in this context configure options for the next-hop resolution of BGP labeled routes (VPN-IP and labeled-unicast) using tunnels in TTM.

Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword
Treefamily
Introduced16.0.R1

Platforms

All

allow-flex-algo-fallback boolean
Synopsis Enable flexible algorithm fallback
Context configure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword allow-flex-algo-fallback boolean
Treeallow-flex-algo-fallback

Description

When configured to true, a BGP router with a Flex-Algorithm action configured (via the configure policy-options policy-statement entry action flex-algo command) can resolve to a tunnel with algorithm 0 if no target Flex-Algorithm tunnel is available.

When configured to false, the BGP router can resolve only to the intended Flex-Algorithm tunnel, which may cause traffic loss if no corresponding Flex-Algorithm tunnel is available.

Defaultfalse
Introduced20.10.R1

Platforms

All

enforce-strict-tunnel-tagging boolean
Synopsis Consider only LSPs with an admin-tag for next hop
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword enforce-strict-tunnel-tagging boolean
Treeenforce-strict-tunnel-tagging

Description

When configured to true, the system only considers LSPs marked with an administrative tag for next-hop resolution. Untagged LSPs are not considered.

When configured to false, matching admin-tagged RSVP or SR-TE LSPs are used in preference to other LSP types, whether tagged or untagged. If no eligible RSVP or SR-TE LSP exists, the system falls back to using tagged LSPs that are not explicitly excluded by a route admin tag policy and untagged LSPs of other types.

Defaultfalse
Introduced16.0.R1

Platforms

All

resolution-filter
Synopsis Enter the resolution-filter context
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter
Treeresolution-filter
Introduced16.0.R1

Platforms

All

bgp boolean
Synopsis Use BGP tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter bgp boolean
Treebgp

Description

When configured to true, this command enables the selection of BGP tunneling for next-hop resolution and specifies the IPv4 tunnels created by receiving BGP label-unicast IPv4 routes for /32 IPv4 prefixes.

When configured to false, BGP tunneling for next-hop resolution is not enabled.

Introduced16.0.R1

Platforms

All

ldp boolean
Synopsis Use LDP tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter ldp boolean
Treeldp

Description

When configured to true, this command enables the selection of LDP tunneling for next-hop resolution and specifies the LDP tunnels in the tunnel table corresponding to /32 IPv4 FECs and /128 IPv6 FECs.

When configured to false, LDP tunneling for next-hop resolution is not enabled.

Defaulttrue
Introduced16.0.R1

Platforms

All

rsvp boolean
Synopsis Use RSVP tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter rsvp boolean
Treersvp

Description

When configured to true, this command enables the selection of RSVP tunneling for next-hop resolution and specifies RSVP tunnels in a tunnel table to IPv4 destinations.

This option allows BGP to use the best metric RSVP LSP to the address of the BGP next hop. This address can correspond to the system interface or to another loopback interface of the remote BGP router. In the case of multiple RSVP LSPs with the same lowest metric, BGP selects the LSP with the lowest tunnel ID.

When configured to false, this command disables the selection of RSVP tunneling for next-hop resolution.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-isis boolean
Synopsis Use IS-IS SR tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter sr-isis boolean
Treesr-isis

Description

When configured to true, this command enables the selection of the Segment Routing (SR) tunnel type programmed by an IS-IS instance in the TTM for next-hop resolution of BGP routes and labeled routes.

This command allows BGP to use the segment-routing tunnel in the tunnel table submitted by the lowest preference IS-IS instance or, in case of a tie, the lowest numbered IS-IS instance.

When configured to false, the SR tunnel type programmed by an IS-IS instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-ospf boolean
Synopsis Use OSPF SR tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter sr-ospf boolean
Treesr-ospf

Description

When configured to true, this command enables the selection of the Segment Routing (SR) tunnel type programmed by an OSPF instance in the TTM for next-hop resolution of BGP routes and labeled routes.

This command allows BGP to use the segment routing tunnel in the tunnel table submitted by the lowest preference OSPF instance or, in case of a tie, the lowest numbered OSPF instance.

When configured to false, the SR tunnel type programmed by an OSPF instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-ospf3 boolean
Synopsis Use OSPFv3 SR tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter sr-ospf3 boolean
Treesr-ospf3

Description

When configured to true, this command enables the selection of the IPv6 Segment Routing (SR) tunnel type programmed by an OSPFv3 instance in the TTMv6 for next-hop resolution of BGP routes and labeled routes.

This command allows BGP to use the segment routing tunnel in the tunnel table submitted by the lowest preference OSPFv3 instance or, in case of a tie, the lowest numbered OSPFv3 instance.

When configured to false, the SR tunnel type programmed by an OSPFv3 instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R6

Platforms

All

sr-policy boolean
Synopsis Use SR policies for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter sr-policy boolean
Treesr-policy

Description

When configured to true, this command enables the use of segment routing policies to resolve the BGP next hop of certain BGP routes (depending on the context).

The segment routing policies that are considered are statically configured in the local router or learned by BGP routes (AFI 1/SAFI 73). For a BGP route to be resolved by an SR policy, the highest numbered color extended community attached to BGP route must match the color of the SR policy. Next hop resolution of VPN-IP routes by SR policies is not supported.

When configured to false, segment routing policies are not enabled for next-hop resolution.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-te boolean
Synopsis Use SR-TE tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution labeled-routes transport-tunnel family keyword resolution-filter sr-te boolean
Treesr-te

Description

When configured to true, this command enables the selection of the Segment Routing (SR) tunnel type programmed by a traffic engineered (TE) instance in the TTM for next-hop resolution.

In the case of multiple SR-TE tunnels with the same lowest metric, BGP selects the tunnel with the lowest tunnel ID.

When configured to false, the SR tunnel type programmed by a TE instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R1

Platforms

All

use-bgp-routes
Synopsis Enter the use-bgp-routes context
Contextconfigure router string bgp next-hop-resolution labeled-routes use-bgp-routes
Treeuse-bgp-routes
Introduced21.2.R1

Platforms

All

label-ipv6-explicit-null boolean
Synopsis Use BGP routes to resolve address family routes
Contextconfigure router string bgp next-hop-resolution labeled-routes use-bgp-routes label-ipv6-explicit-null boolean
Treelabel-ipv6-explicit-null

Description

When configured to true, a labeled IPv6 route with the explicit-null label can be resolved by other routes, and also by unlabeled IPv4 routes and unlabeled IPv6 routes that are resolved by static routes, interface routes, or tunnels. Up to four levels of recursive resolution are supported when the top route is a labeled IPv6 route with an explicit-null label. When disabled, a labeled IPv6 route cannot be resolved by other labeled IPv6 routes.

A labeled IPv6 route with a regular label (not explicit-null) is never resolved by other labeled IPv6 routes.

Defaultfalse
Introduced21.2.R1

Platforms

All

shortcut-tunnel
Synopsis Enter the shortcut-tunnel context
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel
Treeshortcut-tunnel

Description

Commands in this context configure the tunnel types that can be used to resolve unlabeled IPv4 and IPv6 BGP routes.

Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword
Treefamily
Introduced16.0.R1

Platforms

All

allow-flex-algo-fallback boolean
Synopsis Enable flexible algorithm fallback
Context configure router string bgp next-hop-resolution shortcut-tunnel family keyword allow-flex-algo-fallback boolean
Treeallow-flex-algo-fallback

Description

When configured to true, a BGP router with a Flex-Algorithm action configured (via the configure policy-options policy-statement entry action flex-algo command) can resolve to a tunnel with algorithm 0 if no target Flex-Algorithm tunnel is available.

When configured to false, the BGP router can resolve only to the intended Flex-Algorithm tunnel, which may cause traffic loss if no corresponding Flex-Algorithm tunnel is available.

Defaultfalse
Introduced20.10.R1

Platforms

All

disallow-igp boolean
Synopsis Do not perform route table lookup to resolve BGP route
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword disallow-igp boolean
Treedisallow-igp

Description

When configured to true, no attempt is made to resolve the IPv4 or IPv6 BGP route using route table lookup if no resolving tunnel can be found in the tunnel table.

When configured to false, route table lookup can be performed if no resolving tunnel is found in the tunnel table.

Defaultfalse
Introduced16.0.R1

Platforms

All

enforce-strict-tunnel-tagging boolean
Synopsis Consider only LSPs with an admin-tag for next hop
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword enforce-strict-tunnel-tagging boolean
Treeenforce-strict-tunnel-tagging

Description

When configured to true, the system only considers LSPs marked with an administrative tag for next-hop resolution. Untagged LSPs are not considered.

When configured to false, matching admin-tagged RSVP or SR-TE LSPs are used in preference to other LSP types, whether tagged or untagged. If no eligible RSVP or SR-TE LSP exists, the system falls back to using tagged LSPs that are not explicitly excluded by a route admin tag policy and untagged LSPs of other types.

Defaultfalse
Introduced16.0.R1

Platforms

All

resolution-filter
Synopsis Enter the resolution-filter context
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter
Treeresolution-filter
Introduced16.0.R1

Platforms

All

bgp boolean
Synopsis Use BGP tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter bgp boolean
Treebgp

Description

When configured to true, this command enables the selection of BGP tunneling for next-hop resolution and specifies the IPv4 tunnels created by receiving BGP label-unicast IPv4 routes for /32 IPv4 prefixes.

When configured to false, BGP tunneling for next-hop resolution is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

ldp boolean
Synopsis Use LDP tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter ldp boolean
Treeldp

Description

When configured to true, BGP selects the LDP FEC that is the longest prefix match to the BGP next-hop address.

When configured to false, LDP tunneling for next-hop resolution is not enabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

rsvp boolean
Synopsis Use RSVP tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter rsvp boolean
Treersvp

Description

When configured to true, this command enables the selection of RSVP tunneling for next-hop resolution and specifies RSVP tunnels in a tunnel table to IPv4 destinations.

This option allows BGP to use the best metric RSVP LSP to the address of the BGP next hop. This address can correspond to the system interface or to another loopback interface of the remote BGP router. In the case of multiple RSVP LSPs with the same lowest metric, BGP selects the LSP with the lowest tunnel ID.

When configured to false, this command disables the selection of RSVP tunneling for next-hop resolution.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-isis boolean
Synopsis Use IS-IS SR tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter sr-isis boolean
Treesr-isis

Description

When configured to true, this command enables the selection of the Segment Routing (SR) tunnel type programmed by an IS-IS instance in the TTM for next-hop resolution of BGP routes and labeled routes.

This command allows BGP to use the segment-routing tunnel in the tunnel table submitted by the lowest preference IS-IS instance or, in case of a tie, the lowest numbered IS-IS instance.

When configured to false, the SR tunnel type programmed by an IS-IS instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-ospf boolean
Synopsis Use OSPF SR tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter sr-ospf boolean
Treesr-ospf

Description

When configured to true, this command enables the selection of the Segment Routing (SR) tunnel type programmed by an OSPF instance in the TTM for next-hop resolution of BGP routes and labeled routes.

This command allows BGP to use the segment routing tunnel in the tunnel table submitted by the lowest preference OSPF instance or, in case of a tie, the lowest numbered OSPF instance.

When configured to false, the SR tunnel type programmed by an OSPF instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-ospf3 boolean
Synopsis Use OSPFv3 SR tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter sr-ospf3 boolean
Treesr-ospf3

Description

When configured to true, this command enables the selection of the IPv6 Segment Routing (SR) tunnel type programmed by an OSPFv3 instance in the TTMv6 for next-hop resolution of BGP routes and labeled routes.

This command allows BGP to use the segment routing tunnel in the tunnel table submitted by the lowest preference OSPFv3 instance or, in case of a tie, the lowest numbered OSPFv3 instance.

When configured to false, the SR tunnel type programmed by an OSPFv3 instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R6

Platforms

All

sr-policy boolean
Synopsis Use SR policies for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter sr-policy boolean
Treesr-policy

Description

When configured to true, this command enables the use of segment routing policies to resolve the BGP next hop of certain BGP routes (depending on the context).

The segment routing policies that are considered are statically configured in the local router or learned by BGP routes (AFI 1/SAFI 73). For a BGP route to be resolved by an SR policy, the highest numbered color extended community attached to BGP route must match the color of the SR policy.

When configured to false, segment routing policies are not enabled for next-hop resolution.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-te boolean
Synopsis Use SR-TE tunneling for next-hop resolution
Contextconfigure router string bgp next-hop-resolution shortcut-tunnel family keyword resolution-filter sr-te boolean
Treesr-te

Description

When configured to true, this command enables the selection of the Segment Routing (SR) tunnel type programmed by a traffic engineered (TE) instance in the TTM for next-hop resolution.

In the case of multiple SR-TE tunnels with the same lowest metric, BGP selects the tunnel with the lowest tunnel ID.

When configured to false, the SR tunnel type programmed by a TE instance in the TTM for next-hop resolution is not enabled for selection.

Defaultfalse
Introduced16.0.R1

Platforms

All

use-bgp-routes boolean
Synopsis Use BGP routes to resolve BGP next hops
Contextconfigure router string bgp next-hop-resolution use-bgp-routes boolean
Treeuse-bgp-routes

Description

This command enables the use of BGP routes to resolve BGP next hops. When this command is enabled, any unlabeled IPv4 or IPv6 BGP route received from a VPRN BGP peer becomes resolvable by up to four other BGP routes in order to resolve the route to a VPRN IP interface. A VPRN BGP route is not resolvable by another VPRN BGP route or by a BGP-VPN route.

This command also allows unlabeled IPv4 or IPv6 BGP routes leaked from the GRT with unresolved next hops (in the GRT) to be resolvable by BGP-VPN routes (of the VPRN).

Defaultfalse
Introduced16.0.R1

Platforms

All

use-leaked-routes
Synopsis Enter the use-leaked-routes context
Contextconfigure router string bgp next-hop-resolution use-leaked-routes
Treeuse-leaked-routes
Introduced23.7.R1

Platforms

All

static boolean
Synopsis Use leaked static routes to resolve BGP next hop
Contextconfigure router string bgp next-hop-resolution use-leaked-routes static boolean
Treestatic

Description

When configured to true, the router allows any non-leaked unlabeled unicast IPv4 or IPv6 route in the BGP RIB to be resolved by a leaked static route with direct next hops. A BGP route resolved this way cannot resolve other routes (including BGP routes) and cannot be redistributed into non-BGP protocols, such as IGP.

When configured to false, the router prevents the use of leaked static routes to resolve BGP routes.

Defaultfalse
Introduced23.7.R1

Platforms

All

weighted-ecmp boolean
Synopsis Use weighted ECMP for next-hop tunnel selection for 6PE
Contextconfigure router string bgp next-hop-resolution weighted-ecmp boolean
Treeweighted-ecmp

Description

When configured to true, this command enables weighted ECMP for next-hop tunnel selection for 6PE. When weighted ECMP is enabled, the RSVP-TE tunnel used to forward 6PE packets to the ECMP next hop that is chosen according to the outcome of the hash on the packet at the normalized load-balancing weight of the tunnel.

When configured to false, weighted ECMP is disabled for next-hop tunnel selection for 6PE.

Defaultfalse
Introduced16.0.R1

Platforms

All

optimal-route-reflection
Synopsis Enter the optimal-route-reflection context
Contextconfigure router string bgp optimal-route-reflection
Treeoptimal-route-reflection
Introduced16.0.R1

Platforms

All

location [location-id] number
Synopsis Enter the location list instance
Contextconfigure router string bgp optimal-route-reflection location number
Treelocation

Description

Commands in this context configure the location ID for the route reflector. A BGP neighbor can be associated with a location if it is a route-reflector client.

Up to three IPv4 addresses and three IPv6 addresses can be specified per location.

If the TE DB is unable find a node in its topology database that matches a primary address of the location, it tries to find a node matching a secondary address. If this attempt also fails, the TE DB tries to find a node matching a tertiary address.

The IP addresses specified for a location should be topologically “close” to a set of clients that should all receive the same optimal path for that location.

Introduced16.0.R1

Platforms

All

spf-wait
Synopsis Enter the spf-wait context
Context configure router string bgp optimal-route-reflection spf-wait
Treespf-wait

Description

Commands in this context specify the interval between consecutive SPF calculations performed by the TE DB in support of BGP optimal route reflection. The time components implement an exponential back-off algorithm.

.

Introduced16.0.R1

Platforms

All

outbound-route-filtering
Synopsis Enable the outbound-route-filtering context
Contextconfigure router string bgp outbound-route-filtering
Treeoutbound-route-filtering

Description

Commands in this context configure the send and receive capabilities for Outbound Route Filtering (ORF).

When unconfigured, the ORF capabilities are not enabled.

Introduced16.0.R1

Platforms

All

extended-community
Synopsis Enable the extended-community context
Contextconfigure router string bgp outbound-route-filtering extended-community
Treeextended-community

Description

Commands in this context configure the ORF send and receive capabilities based on Extended Communities.

When this context is unconfigured, the ORF capabilities for Extended Communities is not enabled.

Introduced16.0.R1

Platforms

All

accept-orf boolean
Synopsis Negotiate with peer to accept BGP ORF filters
Contextconfigure router string bgp outbound-route-filtering extended-community accept-orf boolean
Treeaccept-orf

Description

When configured to true, the receive capability in the BGP ORF is negotiated with a peer and ORF filters can be accepted from peers.

When configured to false, the accept capability in the BGP ORF is removed and any existing ORF filters that are currently in place are cleared.

Defaultfalse
Introduced16.0.R1

Platforms

All

send-orf
Synopsis Enable the send-orf context
Context configure router string bgp outbound-route-filtering extended-community send-orf
Treesend-orf

Description

Commands in this context allow BGP to negotiate the send capability in the ORF negotiation with a peer. The send capability also causes the router to send a community filter, prefix filter, or AS path filter configured as an inbound filter on the BGP session to its peer as an ORF Action ADD.

When this context in unconfigured, ORF send capability is not enabled.

Introduced16.0.R1

Platforms

All

route-target [community-name] string
Synopsis Add a list entry for route-target
Contextconfigure router string bgp outbound-route-filtering extended-community send-orf route-target string
Treeroute-target
Introduced16.0.R1

Platforms

All

override-tunnel-elc boolean
Synopsis Enable entropy label capability on BGP tunnels
Contextconfigure router string bgp override-tunnel-elc boolean
Treeoverride-tunnel-elc

Description

When configured to true, this command renders all far ends for BGP tunnels as entropy-label-capable, regardless of any received capability signaling. This ensures that the entropy label will be inserted on BGP tunnels in the absence of capability signaling support by the far end.

This is a system-wide configuration, since efficient entropy label operation requires that all LSRs in a network support entropy labels. This command should be used with care, particularly in inter-AS use cases, as entropy label capability may differ between domains.

When configured to false, this command disables all far ends for BGP tunnels as entropy-label-capable.

Defaultfalse
Introduced16.0.R1

Platforms

All

path-mtu-discovery boolean
Synopsis Enable Path MTU Discovery
Context configure router string bgp path-mtu-discovery boolean
Treepath-mtu-discovery

Description

When configured to true, Path MTU Discovery (PMTUD) is activated toward an IPv4 BGP neighbor. The Don't Fragment (DF) bit is set in the IP header of all IPv4 packets sent to the peer. If any device along the path toward the peer cannot forward the packet because the IP MTU of the interface is smaller than the IP packet size, the device drops the packet and sends an ICMP or ICMPv6 error message encoding the interface MTU. When the router receives the ICMP or ICMPv6 message, it lowers the TCP maximum segment size limit from the previous value to accomodate the IP MTU constraint.

When configured to false, PMTUD is disabled and there is no TCP MSS configuration to associate with a BGP neighbor (in either the BGP configuration or the first-hop IP interface configuration). The router advertises a TCP MSS option of only 1024 bytes, limiting the received TCP segments to that size.

Defaultfalse
Introduced16.0.R1

Platforms

All

peer-tracking-policy reference
Synopsis Policy for BGP peer tracking on router instance
Contextconfigure router string bgp peer-tracking-policy reference
Treepeer-tracking-policy

Description

This command specifies the name of a policy statement to use with the BGP peer-tracking function on BGP sessions where peer tracking is enabled.

When unconfigured, the default peer-tracking policy allows any type of route to match the neighbor IP address except aggregate routes and LDP shortcut routes.

Peer tracking should be used with caution. The peer-tracking policy should only permit one of direct-interface or direct routes to be advertised to a BGP peer. Advertising both routes causes the best route to oscillate.

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

All

preference number
Synopsis Route preference for routes learned from all peers
Contextconfigure router string bgp preference number
Treepreference

Description

This command configures the route preference for routes learned from the configured peers.

The lower the preference value, the higher the chance of the route being the active route. The router assigns BGP routes the highest default preference as compared to routes that are direct, static or learned via MPLS or OSPF.

Range1 to 255
Default170
Introduced 16.0.R1

Platforms

All

purge-timer number
Synopsis Maximum time before stale routes are purged
Contextconfigure router string bgp purge-timer number
Treepurge-timer

Description

This command configures the maximum time before stale routes are purged. 

When a route refresh request is sent to a peer for VPN-IP routes received from that peer (in the RIB-IN), the routes are set to stale and the purge timer is started. If the routes are not updated (refreshed) before the purge timer expires, the routes are removed.

Range1 to 60
Default10
Introduced 16.0.R1

Platforms

All

rapid-update
Synopsis Enter the rapid-update context
Contextconfigure router string bgp rapid-update
Treerapid-update

Description

Commands in this context specify the address families that are configured to support the rapid update functionality.

The rapid update functionality overrides the remaining time on a peer's MRAI timer and immediately sends routes belonging the specified address families (and all other pending updates) to the peers receiving these routes.

Introduced16.0.R1

Platforms

All

evpn boolean
Synopsis Include EVPN address family routes
Context configure router string bgp rapid-update evpn boolean
Treeevpn
Defaultfalse
Introduced16.0.R1

Platforms

All

l2-vpn boolean
Synopsis Include L2 VPN address family routes
Context configure router string bgp rapid-update l2-vpn boolean
Treel2-vpn
Defaultfalse
Introduced16.0.R1

Platforms

All

mdt-safi boolean
Synopsis Include MDT SAFI address family routes
Contextconfigure router string bgp rapid-update mdt-safi boolean
Treemdt-safi
Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv4 boolean
Synopsis Include VPN IPv4 address family routes
Contextconfigure router string bgp rapid-update vpn-ipv4 boolean
Treevpn-ipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-ipv6 boolean
Synopsis Include VPN IPv6 address family routes
Contextconfigure router string bgp rapid-update vpn-ipv6 boolean
Treevpn-ipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

rapid-withdrawal boolean
Synopsis Send BGP withdrawal UPDATE messages immediately
Contextconfigure router string bgp rapid-withdrawal boolean
Treerapid-withdrawal

Description

When configured to true, UPDATE messages containing withdrawn NLRI are sent immediately to a peer without waiting for the MRAI timer to expire. UPDATE messages containing reachable NLRI continue to wait for the MRAI timer to expire, or for a rapid update trigger.

When configured to false, withdrawal processing continues with the normal behavior.

Defaultfalse
Introduced16.0.R1

Platforms

All

remove-private
Synopsis Enable the remove-private context
Contextconfigure router string bgp remove-private
Treeremove-private
Introduced16.0.R1

Platforms

All

limited boolean
Synopsis Remove private ASNs up to first public ASN encountered
Contextconfigure router string bgp remove-private limited boolean
Treelimited
Defaultfalse
Introduced16.0.R1

Platforms

All

replace boolean
Synopsis Replace private ASN with global ASN before advertising
Contextconfigure router string bgp remove-private replace boolean
Treereplace
Defaultfalse
Introduced19.10.R1

Platforms

All

rib-management
Synopsis Enter the rib-management context
Contextconfigure router string bgp rib-management
Treerib-management
Introduced16.0.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string bgp rib-management ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

leak-import
Synopsis Enter the leak-import context
Context configure router string bgp rib-management ipv4 leak-import
Treeleak-import

Description

Commands in this context specify route policies that control the importation of leak-eligible routes from the BGP RIB of another routing instance into the unlabeled-IPv4 RIB of the base router. To leak a route from one routing instance to another, the origin and destination RIB types must be the same; for example, it is not possible to leak a route from an unlabeled-IPv4 RIB of a VPRN into the labeled-IPv4 RIB of the base router.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis Leak import policy name
Context configure router string bgp rib-management ipv4 leak-import policy (policy-expr-string | string)
Treepolicy

Description

This command specifies one or more leak import policies.

Policy names are limited to 64 characters except for the first policy. Only one object can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

String Length1 to 255
Max. Instances15

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

route-table-import
Synopsis Enter the route-table-import context
Contextconfigure router string bgp rib-management ipv4 route-table-import
Treeroute-table-import
Introduced16.0.R1

Platforms

All

policy-name reference
Synopsis Name of policy that controls route importation into RIB
Contextconfigure router string bgp rib-management ipv4 route-table-import policy-name reference
Treepolicy-name

Description

This command specifies the name of a policy that controls the importation of active routes from the IP route table into one of the BGP RIBs.

When this command is configured, routes dropped or rejected by the policy are not installed in the associated RIB. Rejected routes cannot be advertised to BGP peers associated with the RIB, but they can still be used to resolve BGP next hops of routes in that RIB. If the active route for a prefix is rejected by the policy, the best BGP route for that prefix in the BGP RIB can be advertised to peers as though it is used.

Aggregate routes are always imported into each RIB, independent of the specified policy.

Route modifications specified in the actions of the policy are ignored and have no effect on the imported routes.

When unconfigured, or if the command refers to an empty policy, all non-BGP routes from the IP route table are imported into the applicable RIB.

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string bgp rib-management ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

leak-import
Synopsis Enter the leak-import context
Context configure router string bgp rib-management ipv6 leak-import
Treeleak-import

Description

Commands in this context specify route policies that control the importation of leak-eligible routes from the BGP RIB of another routing instance into the unlabeled-IPv6 RIB of the base router. To leak a route from one routing instance to another, the origin and destination RIB types must be the same; for example, it is not possible to leak a route from an unlabeled-IPv4 RIB of a VPRN into the labeled-IPv4 RIB of the base router.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis Leak import policy name
Context configure router string bgp rib-management ipv6 leak-import policy (policy-expr-string | string)
Treepolicy

Description

This command specifies one or more leak import policies.

Policy names are limited to 64 characters except for the first policy. Only one object can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

String Length1 to 255
Max. Instances15

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

route-table-import
Synopsis Enter the route-table-import context
Contextconfigure router string bgp rib-management ipv6 route-table-import
Treeroute-table-import

Description

This command enables the context to specify the name of a route to control the importation of active routes from the IP route table into one of the BGP RIBs.

If this command is configured, then routes dropped or rejected by the configured policy are not installed in the associated RIB. Rejected routes cannot be advertised to BGP peers associated with the RIB, but they can still be used to resolve BGP next hops of routes in that RIB. If the active route for a prefix is rejected by this command then the best BGP route for that prefix in the BGP RIB can be advertised to peers as though it is used.

Aggregate routes are always imported into each RIB, independent of this command's policy.

Route modifications specified in the actions of this command's policy are ignored and have no effect on the imported routes.

If this command is not configured, or if the command refers to an empty policy, all non-BGP routes from the IP route table are imported into the applicable RIB.

Introduced16.0.R1

Platforms

All

policy-name reference
Synopsis Name of policy that controls route importation into RIB
Contextconfigure router string bgp rib-management ipv6 route-table-import policy-name reference
Treepolicy-name

Description

This command specifies the name of a policy that controls the importation of active routes from the IP route table into one of the BGP RIBs.

When this command is configured, routes dropped or rejected by the policy are not installed in the associated RIB. Rejected routes cannot be advertised to BGP peers associated with the RIB, but they can still be used to resolve BGP next hops of routes in that RIB. If the active route for a prefix is rejected by the policy, the best BGP route for that prefix in the BGP RIB can be advertised to peers as though it is used.

Aggregate routes are always imported into each RIB, independent of the specified policy.

Route modifications specified in the actions of the policy are ignored and have no effect on the imported routes.

When unconfigured, or if the command refers to an empty policy, all non-BGP routes from the IP route table are imported into the applicable RIB.

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

All

label-ipv4
Synopsis Enter the label-ipv4 context
Context configure router string bgp rib-management label-ipv4
Treelabel-ipv4
Introduced16.0.R1

Platforms

All

leak-import
Synopsis Enter the leak-import context
Context configure router string bgp rib-management label-ipv4 leak-import
Treeleak-import

Description

Commands in this context specify route policies that control the importation of leak-eligible routes from the BGP RIB of another routing instance into the labeled-IPv4 RIB of the base router. To leak a route from one routing instance to another, the origin and destination RIB types must be the same; for example, it is not possible to leak a route from an unlabeled-IPv4 RIB of a VPRN into the labeled-IPv4 RIB of the base router.

Introduced16.0.R1

Platforms

All

policy (policy-expr-string | string)
Synopsis Leak import policy name
Context configure router string bgp rib-management label-ipv4 leak-import policy (policy-expr-string | string)
Treepolicy

Description

This command specifies one or more leak import policies.

Policy names are limited to 64 characters except for the first policy. Only one object can be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT).

String Length1 to 255
Max. Instances15

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

route-table-import
Synopsis Enter the route-table-import context
Contextconfigure router string bgp rib-management label-ipv4 route-table-import
Treeroute-table-import
Introduced16.0.R1

Platforms

All

policy-name reference
Synopsis Name of policy that controls route importation into RIB
Contextconfigure router string bgp rib-management label-ipv4 route-table-import policy-name reference
Treepolicy-name

Description

This command specifies the name of a policy that controls the importation of active routes from the IP route table into one of the BGP RIBs.

When this command is configured, routes dropped or rejected by the policy are not installed in the associated RIB. Rejected routes cannot be advertised to BGP peers associated with the RIB, but they can still be used to resolve BGP next hops of routes in that RIB. If the active route for a prefix is rejected by the policy, the best BGP route for that prefix in the BGP RIB can be advertised to peers as though it is used.

Aggregate routes are always imported into each RIB, independent of the specified policy.

Route modifications specified in the actions of the policy are ignored and have no effect on the imported routes.

When unconfigured, or if the command refers to an empty policy, all non-BGP routes from the IP route table are imported into the applicable RIB.

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

All

label-ipv6
Synopsis Enter the label-ipv6 context
Context configure router string bgp rib-management label-ipv6
Treelabel-ipv6
Introduced16.0.R1

Platforms

All

route-table-import
Synopsis Enter the route-table-import context
Contextconfigure router string bgp rib-management label-ipv6 route-table-import
Treeroute-table-import
Introduced16.0.R1

Platforms

All

policy-name reference
Synopsis Name of policy that controls route importation into RIB
Contextconfigure router string bgp rib-management label-ipv6 route-table-import policy-name reference
Treepolicy-name

Description

This command specifies the name of a policy that controls the importation of active routes from the IP route table into one of the BGP RIBs.

When this command is configured, routes dropped or rejected by the policy are not installed in the associated RIB. Rejected routes cannot be advertised to BGP peers associated with the RIB, but they can still be used to resolve BGP next hops of routes in that RIB. If the active route for a prefix is rejected by the policy, the best BGP route for that prefix in the BGP RIB can be advertised to peers as though it is used.

Aggregate routes are always imported into each RIB, independent of the specified policy.

Route modifications specified in the actions of the policy are ignored and have no effect on the imported routes.

When unconfigured, or if the command refers to an empty policy, all non-BGP routes from the IP route table are imported into the applicable RIB.

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

All

route-target-list [community-name] string
Synopsis Add a list entry for route-target-list
Contextconfigure router string bgp route-target-list string
Treeroute-target-list

Description

This command specifies a route target to be accepted from or advertised to peers.

This command is only applicable if the router is a route-reflector server.

Introduced16.0.R1

Platforms

All

[community-name] string
Synopsis Route target community name
Context configure router string bgp route-target-list string
Treeroute-target-list
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

router-id string
Synopsis Router ID for the BGP instance in the AS
Contextconfigure router string bgp router-id string
Treerouter-id

Description

This command specifies the router ID to be used with the BGP instance.

Changing the BGP router ID on an active BGP instance causes the BGP instance to restart with the new router ID.

When an SR OS is configured with an IPv6-only BOF and no IPv4 system interface address, explicitly-defined IPv4 router IDs are required for BGP as there is no mechanism to derive the router ID from an IPv6 system interface address.

Introduced16.0.R1

Platforms

All

rr-vpn-forwarding boolean
Synopsis Allow route reflector to forward VPN-IP routes
Contextconfigure router string bgp rr-vpn-forwarding boolean
Treerr-vpn-forwarding

Description

When configured to true, the route reflector resolves VPN-IPv4 and VPN-IPv6 routes, sets itself as the next hop, and generates new labels for all the resolved routes.

During this process, all received VPN-IP routes, regardless of route target, are imported into the dummy VRF, where the BGP next hops are resolved. The routes are resolved to next-hop-self, and BGP allocates new VPRN service-label values for the routes, which are then advertised to peers.

The transport-tunnel command under the configure router bgp next-hop-resolution labeled-routes context determines what types of tunnels are eligible to resolve the next hops. If a received VPN-IP route from IBGP peer X is resolved and selected as the best path so that it can be re-advertised to an IBGP peer Y, and the BGP next-hop is modified toward peer Y (by using the next-hop-self command in Y’s group or neighbor context or by using a next-hop action in an export policy applied to Y), BGP allocates a new VPRN service label value for the route, signals that new label value to Y, and programs the IOM to do the corresponding label swap operation. The supported combinations of X and Y are outlined below:

  • from X (client) to Y (client)

  • from X (client) to Y (non-client)

  • from X (non-client) to Y (client)

When configured to false, the routes are re-advertised without signaling new VPRN labels, even if the BGP next hop is changed.

Nokia recommends setting this command to false for scaling and convergence reasons.

Defaultfalse
Introduced16.0.R1

Platforms

All

segment-routing
Synopsis Enter the segment-routing context
Contextconfigure router string bgp segment-routing
Treesegment-routing

Description

Commands in this context configure options related to BGP segment routing (including prefix SID support).

Introduced19.10.R1

Platforms

All

prefix-sid-range
Synopsis Enable the prefix-sid-range context
Contextconfigure router string bgp segment-routing prefix-sid-range
Treeprefix-sid-range
Introduced19.10.R1

Platforms

All

global
Synopsis Allow label allocation from entire SRBG space
Contextconfigure router string bgp segment-routing prefix-sid-range global
Treeglobal

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced19.10.R1

Platforms

All

max-index number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLast label value available in contiguous range
Contextconfigure router string bgp segment-routing prefix-sid-range max-index number
Treemax-index
Range0 to 524287
Default1

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced19.10.R1

Platforms

All

start-label number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisFirst label value available in a contiguous range
Contextconfigure router string bgp segment-routing prefix-sid-range start-label number
Treestart-label
Range0 to 524287
Default0

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced19.10.R1

Platforms

All

segment-routing-v6
Synopsis Enable the segment-routing-v6 context
Contextconfigure router string bgp segment-routing-v6
Treesegment-routing-v6
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string bgp segment-routing-v6 family keyword
Treefamily

Description

Commands in this context configure family-specific behavior for processing prefix SID attributes containing SRv6 TLVs.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[family-type] keyword
Synopsis IP address type that SRv6 route attributes apply to
Contextconfigure router string bgp segment-routing-v6 family keyword
Treefamily
Optionsipv4, ipv6

Notes

This element is part of a list key.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

add-srv6-tlvs
Synopsis Enable the add-srv6-tlvs context
Contextconfigure router string bgp segment-routing-v6 family keyword add-srv6-tlvs
Treeadd-srv6-tlvs

Description

Commands in this context configure locator information for the family.

When a locator is specified for the family, a family route that is redistributed from another protocol is advertised to BGP peers with a prefix SID attribute containing an SRv6 TLV.

The commands also have the effect of adding a prefix SID attribute with SRv6 TLV to BGP routes received from other peers without the SRv6 TLV and propagating to other peers with next-hop-self applied.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

micro-segment-locator-name reference
Synopsis Micro-segment SRv6 locator name
Context configure router string bgp segment-routing-v6 family keyword add-srv6-tlvs micro-segment-locator-name reference
Treemicro-segment-locator-name

Description

This command adds a prefix SID attribute containing an SRv6 TLV to routes that belong to the family and that are redistributed from another protocol to BGP. This command also adds a prefix SID attribute with SRv6 TLV to BGP routes that are received from other peers without the SRv6 TLV and that are propagated to other peers with next-hop-self applied.

Reference

configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

ignore-received-srv6-tlvs boolean
Synopsis Ignore SRv6 TLVs for received routes
Context configure router string bgp segment-routing-v6 family keyword ignore-received-srv6-tlvs boolean
Treeignore-received-srv6-tlvs

Description

When configured to true, if a route of the family is received with a prefix SID attribute carrying an SRv6 TLV, the SRv6 TLV is ignored and the route resolution is based on the BGP next-hop only.

When configured to false, if a route of the family is received with a prefix SID attribute carrying an SRv6 TLV, the SRv6 TLV is processed. Such a route is resolved only if its BGP next-hop is reachable and the locator prefix is reachable. The datapath programming and IGP cost to reach the next-hop (used by the BGP decision process) is based on the route to the locator prefix.

Defaulttrue
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

resolution keyword
Synopsis Resolution options for routes
Context configure router string bgp segment-routing-v6 family keyword resolution keyword
Treeresolution
Optionsroute-table, tunnel-table, fallback-tunnel-to-route-table
Defaultroute-table
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

upa-trigger
Synopsis Enter the upa-trigger context
Context configure router string bgp segment-routing-v6 family keyword upa-trigger
Treeupa-trigger

Description

Commands in this context configure the UPA trigger handling for the next hop.

Introduced24.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

next-hop keyword
Synopsis Action taken when an UPA is received for a next hop
Contextconfigure router string bgp segment-routing-v6 family keyword upa-trigger next-hop keyword
Treenext-hop

Description

This command specifies the action the router takes when checking the Network Layer Reachability Information (NLRI) next hop in the routing table for a matching UPA entry using the longest prefix match (LPM).

frr - Enable BGP FRR when UPA is received

Optionsfrr
Introduced24.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

source-address string
Synopsis Source address used in SRv6 packet
Context configure router string bgp segment-routing-v6 source-address string
Treesource-address

Description

When configured, this command specifies the source IPv6 address used in the SA field of the outer IPv6 header of the SRv6 encapsulated packet.

When not configured, the source IPv6 address is inherited from the configuration of the global default address in the router "basesegment-routing segment-routing-v6 source-address context. 

A source IPv6 address must be configured in this context or in the base router context. 

The system does not check if the address entered is a valid local address.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

selective-label-ip keyword
Synopsis Label IP routes installed for local use on NHS router
Contextconfigure router string bgp selective-label-ip keyword
Treeselective-label-ip

Description

This command enables selective installation of labeled unicast routes for resolution by local services and IP shortcuts on a labeled unicast Next-hop=self router.

This command is supported for labeled unicast for both IPv4 and IPv6 routes.

The no-install option installs labeled IP routes that are required by services. This option conserves labeled route table space in addition to RTM table space on BGP-LU next-hop-self route reflectors. The route-table-install-only option ensures that the labeled unicast routes are installed in the RTM in full. When no-install is specified, the download of labeled unicast routes for NHLFE resolution by services continues.

Optionsno-install, route-table-install-only
Introduced22.10.R1

Platforms

All

selective-label-ip-prioritization boolean
Synopsis Enable BGP selective prioritization for labeled routes
Contextconfigure router string bgp selective-label-ip-prioritization boolean
Treeselective-label-ip-prioritization

Description

When this command is set to true, every labeled IPv4 and IPv6 route that is received and potentially usable by a local service is automatically prioritized for fast control plane reconvergence. When the reachability of a BGP next-hop changes, the labeled IPv4 and IPv6 routes are updated into the route table first, along with other routes manually tagged as high priority by import policies. A /32 or /128 labeled unicast route (and associated BGP-LU tunnel) is determined to be potentially usable by a local service if one of the following conditions applies:

  • the route matches the far-end address of a user-provisioned SDP of a Layer 2 service and the SDP is configured to use BGP tunnels as transport

  • the route matches the BGP next-hop address of a BGP-EVPN or IP VPN route, and this VPN route is either imported into a local service or readvertised by the router acting as a next-hop-self route reflector or a model-B ASBR

When this command is set to false, selective-label IP prioritization for BGP is not used.

Defaultfalse
Introduced21.10.R1

Platforms

All

send-communities
Synopsis Enter the send-communities context
Contextconfigure router string bgp send-communities
Treesend-communities
Introduced16.0.R1

Platforms

All

extended boolean
Synopsis Advertise the Extended Communities attribute to peers
Contextconfigure router string bgp send-communities extended boolean
Treeextended
Defaulttrue
Introduced16.0.R1

Platforms

All

large boolean
Synopsis Advertise the Large Communities attribute to peers
Contextconfigure router string bgp send-communities large boolean
Treelarge
Defaulttrue
Introduced16.0.R1

Platforms

All

send-default
Synopsis Enter the send-default context
Contextconfigure router string bgp send-default
Treesend-default
Introduced19.7.R1

Platforms

All

ipv4 boolean
Synopsis Enable IPv4 family type
Context configure router string bgp send-default ipv4 boolean
Treeipv4
Defaultfalse
Introduced19.7.R1

Platforms

All

ipv6 boolean
Synopsis Enable IPv6 family type
Context configure router string bgp send-default ipv6 boolean
Treeipv6
Defaultfalse
Introduced19.7.R1

Platforms

All

split-horizon boolean
Synopsis Prevent routes being reflected back to best-route peer
Contextconfigure router string bgp split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split-horizon.

This command prevents routes from being reflected back to a peer that sends the best route. It applies to routes of all address families and to any type of sending peer; confed-EBGP, EBGP and IBGP.

Enabling the split-horizon functionality may have a detrimental impact on peer and route scaling and should only be used when absolutely necessary.

When configured to false, the use of split-horizon is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

sr-policy-import boolean
Synopsis Import all segment routing policies into the BGP RIB
Contextconfigure router string bgp sr-policy-import boolean
Treesr-policy-import

Description

When configured to true, statically-configured non-local segment routing policies from the segment routing database are imported into the BGP RIB so that they can be advertised as originated routes toward BGP peers supporting segment routing policies (sr-policy-ipv4 IP family type).

When configured to false, the SR policies are not imported into the BGP RIB.

Defaultfalse
Introduced16.0.R1

Platforms

All

subconfed-vpn-forwarding boolean
Synopsis Allow subconfed route resolution, next hop and labels
Contextconfigure router string bgp subconfed-vpn-forwarding boolean
Treesubconfed-vpn-forwarding

Description

When this is set to true, the base router BGP instance retains all received VPN-IPv4 and VPN-IPv6 routes, including those with route targets not matching any VRF import policy of any locally configured VPRN. In addition, when the base router BGP is configured to apply a next-hop-self command to a peer of any type (EBGP, IBGP, or confed-EBGP), VPN-IPv4 and VPN-IPv6 routes are advertised to the peer with a new BGP label, next hop, and label-swap forwarding entry. These behaviors described above are applied when the enable-inter-as-vpn or enable-rr-vpn-forwarding commands are enabled in the configure router bgp context, in the same BGP instance. This applies regardless of whether the base router has a confederation configuration.

When this command is set to false, subconfederation VPN forwarding is not used.

Defaultfalse
Introduced21.10.R1

Platforms

All

tcp-mss number
Synopsis TCP maximum segment size override
Context configure router string bgp tcp-mss number
Treetcp-mss

Description

This command configures an override for the TCP maximum segment size to use with a specific peer or set of peers (depending on the scope of the command).

The configured value controls two properties of the TCP connection as follows:

TCP MSS option - The router advertises the TCP MSS option value in the TCP SYN packet it sends as part of the 3-way handshake. The advertised value may be lower than the configured value, depending on the IP MTU of the first hop IP interface. The peers must abide by this value when sending TCP segments to the local router.

TCP maximum segment size - The actual transmitted size may be lower than the configured value, depending on the TCP MSS option value signaled by the peers, the effect of path MTU discovery, or other factors.

Range384 to 9746
Introduced21.2.R1

Platforms

All

third-party-nexthop boolean
Synopsis Apply third-party next-hop processing to EBGP peers
Contextconfigure router string bgp third-party-nexthop boolean
Treethird-party-nexthop

Description

When configured to true, this command enables the router to send third-party next hop to EBGP peers in the same subnet as the source peer. The address family of the transport must match the address family of the route.

When an IPv4 or IPv6 route is received from one EBGP peer and advertised to another EBGP peer in the same IP subnet, the BGP next hop is left unchanged.

When configured to false, third-party next-hop processing is disabled and the next hop carries the IP address of the interface used to establish the TCP connection to the peer.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-apply-export boolean
Synopsis Apply base-instance BGP export policies to VPN routes
Contextconfigure router string bgp vpn-apply-export boolean
Treevpn-apply-export

Description

When configured to true, base-instance BGP export route policies are applied to VPN-IPv4/6, MVPN-IPv4/6, L2-VPN, MDT-SAFI, MCAST-VPN-IPv4, and EVPN routes.

When configured to false, the export policies are not applied.

Defaultfalse
Introduced16.0.R1

Platforms

All

vpn-apply-import boolean
Synopsis Apply base-instance import route policies to VPN routes
Contextconfigure router string bgp vpn-apply-import boolean
Treevpn-apply-import

Description

When configured to true, base-instance BGP import route policies are applied to VPN-IPv4/6, MVPN-IPv4/6, L2-VPN, MDT-SAFI, MCAST-VPN-IPv4, and EVPN routes.

When configured to false, the import policies are not applied.

Defaultfalse
Introduced16.0.R1

Platforms

All

bier

Synopsis Enable the bier context
Context configure router string bier
Treebier
Introduced19.5.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BIER
Context configure router string bier admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced19.5.R1

Platforms

All

bfd-liveness keyword
Synopsis BIER next-hops with BFD enabled
Context configure router string bier bfd-liveness keyword
Treebfd-liveness
Optionsipv4
Max. Instances1
Introduced21.7.R1

Platforms

All

fast-reroute boolean
Synopsis Enable BIER Fast Reroute
Context configure router string bier fast-reroute boolean
Treefast-reroute
Defaultfalse
Introduced21.7.R1

Platforms

All

template [template-name] string
Synopsis Enter the template list instance
Contextconfigure router string bier template string
Treetemplate

Description

Commands in this context create a BIER template to be assigned to IGP.

Introduced19.5.R1

Platforms

All

[template-name] string
Synopsis BIER template name
Context configure router string bier template string
Treetemplate
String Length1 to 32

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the BIER template
Contextconfigure router string bier template string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced19.5.R1

Platforms

All

sub-domain [start] number end number
Synopsis Enter the sub-domain list instance
Contextconfigure router string bier template string sub-domain number end number
Treesub-domain
Introduced19.5.R1

Platforms

All

[start] number
Synopsis Lower bound of sub-domain range
Context configure router string bier template string sub-domain number end number
Treesub-domain
Range0 to 255

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

end number
Synopsis Upper bound of sub-domain range
Context configure router string bier template string sub-domain number end number
Treesub-domain
Range0 to 255

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

multi-topology keyword
Synopsis Multi-topology for the sub-domain
Context configure router string bier template string sub-domain number end number multi-topology keyword
Treemulti-topology
Optionsipv4-unicast, ipv6-unicast, ipv4-multicast, ipv6-multicast
Defaultipv4-unicast
Introduced 19.5.R1

Platforms

All

prefix string
Synopsis IP address used as BFR prefix
Context configure router string bier template string sub-domain number end number prefix string
Treeprefix

Description

This command specifies the IP address to be used as the BFR prefix. The prefix can be a loopback interface or system IP address.

Default0.0.0.0
Introduced19.5.R1

Platforms

All

class-forwarding boolean

Synopsis Allow class-based forwarding over IGP shortcuts
Contextconfigure router string class-forwarding boolean
Treeclass-forwarding

Description

When configured to true, this command enables class-based forwarding (CBF) over IGP shortcuts.

Weighted ECMP, at the transport-tunnel level of BGP prefixes over IGP shortcuts, and the CBF feature on a per-BGP next-hop basis are mutually exclusive.

When configured to false, class-based forwarding (CBF) over IGP shortcuts is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

confederation

Synopsis Enter the confederation context
Contextconfigure router string confederation
Treeconfederation

Description

Commands in this context configure members that are to be part of a confederation.

Creating confederation autonomous systems within as AS can be used to reduce the number of IBGP sessions required within an AS.

Introduced16.0.R1

Platforms

All

members [as-number] number
Synopsis Add a list entry for members
Context configure router string confederation members number
Treemembers
Max. Instances256
Introduced16.0.R1

Platforms

All

[as-number] number
Synopsis Confederation member AS number
Context configure router string confederation members number
Treemembers
Range1 to 4294967295

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

description string

Synopsis Text description
Context configure router string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

All

dhcp-server

Synopsis Enter the dhcp-server context
Context configure router string dhcp-server
Treedhcp-server
Introduced16.0.R1

Platforms

All

dhcpv4 [name] string
Synopsis Enter the dhcpv4 list instance
Contextconfigure router string dhcp-server dhcpv4 string
Treedhcpv4
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis DHCP server name
Context configure router string dhcp-server dhcpv4 string
Treedhcpv4
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the DHCP server
Contextconfigure router string dhcp-server dhcpv4 string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string dhcp-server dhcpv4 string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string dhcp-server dhcpv4 string failover
Treefailover

Description

Commands in this context define DHCP failover where two DHCP servers manage the same pool of addresses, enabling them to share the load to assign leases for pool and provide backup for each in the event of network outages.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the failover mechanism
Contextconfigure router string dhcp-server dhcpv4 string failover admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ignore-mclt-on-takeover boolean
Synopsis Ignore maximum client lead during takeover from partner
Contextconfigure router string dhcp-server dhcpv4 string failover ignore-mclt-on-takeover boolean
Treeignore-mclt-on-takeover

Description

When configured to true, the remote IP address range can be taken over immediately when the intercommunication link enters the PARTNER-DOWN state, without having to wait for the MCLT to expire.

When configured to false, the DHCP lease time for new clients is restricted to the MCLT during a failure. For existing clients, the lease time is gradually reduced over time to the MCLT by consecutive DHCP renewals.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-client-lead-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum time that DHCP server can extend client's lease
Contextconfigure router string dhcp-server dhcpv4 string failover maximum-client-lead-time number
Treemaximum-client-lead-time

Description

This command configures the maximum client lead time (MCLT), which is the maximum time that a DHCP server can extend the client's lease time beyond the lease time currently known by the DHCP partner node. In dual-homed environments, the initial lease time for all DHCP clients is restricted to the MCLT by default. Consecutive DHCP renewals can extend the lease time beyond the MCLT.

Range600 to 86399
Unitsseconds
Default 600
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

partner-down-delay number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDelay to prevent lease duplication during link failure
Contextconfigure router string dhcp-server dhcpv4 string failover partner-down-delay number
Treepartner-down-delay

Description

This command configures the interval before a failed intercommunication link transitions from the COMM-INT state to the PARTNER-DOWN state. This delay prevents IP lease duplication during link failure by not allowing new IP addresses to be assigned from the remote IP address range. This timer is intended to provide the operator with enough time to remedy the failed situation and avoid duplication of IP addresses and prefixes during the failure.

Range0 to 86399
Unitsseconds
Default 86399
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer [address] reference
Synopsis Enter the peer list instance
Context configure router string dhcp-server dhcpv4 string failover peer reference
Treepeer

Description

Commands in this context define the peer-related parameters for DHCP failover.

DHCP leases can be synchronized at the level of the DHCP server or pool. The pair of synchronizing servers or pools is identified by a tag. The synchronization information is carried over the Multi-Chassis Synchronization (MCS) link between the two peers. The MCS link is a logical IP or MPLS link.

MCS runs over TCP port 45067, using either data traffic or keepalives to detect failure on the communication link between the two nodes. In the absence of any MCS data traffic for more than 0.5 seconds, MCS sends its own keepalive to the peer. If a reply is not received within 3 seconds, MCS declares its operational state as down and the DB sync state as out-of-sync. MCS consequently notifies its clients, including the DHCP server. It can take up to 3 seconds before the DHCP client realizes that the inter-chassis link has failed.

The link failure does not necessarily imply the same failed state for the access links. It is possible, although unlikely, that both access links are operational while the inter-chassis communication link is broken. In this case, the two redundant nodes can become isolated from each other in the network. For this reason, it is important that the MCS link be highly redundant.

Max. Instances1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[address] reference
Synopsis IP address of the failover peer
Context configure router string dhcp-server dhcpv4 string failover peer reference
Treepeer

Reference

configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone)

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sync-tag string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTag that identifies synchronizing server or pool pairs
Contextconfigure router string dhcp-server dhcpv4 string failover peer reference sync-tag string
Treesync-tag
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

startup-wait-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime between initialization and assuming active role
Contextconfigure router string dhcp-server dhcpv4 string failover startup-wait-time number
Treestartup-wait-time

Description

This command configures a delay that avoids transient issues during the initialization process. During startup wait time, each failover peer waits after the initialization process before assuming the active role for the prefix designated as local or remote.

Range60 to 3600
Unitsseconds
Default 120
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

force-renews boolean
Synopsis Send FORCERENEW messages to force renewals of leases
Contextconfigure router string dhcp-server dhcpv4 string force-renews boolean
Treeforce-renews

Description

When configured to true, FORCERENEW messages are enabled for DHCP.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lease-hold
Synopsis Enter the lease-hold context
Context configure router string dhcp-server dhcpv4 string lease-hold
Treelease-hold
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

additional-scenarios
Synopsis Enter the additional-scenarios context
Contextconfigure router string dhcp-server dhcpv4 string lease-hold additional-scenarios
Treeadditional-scenarios

Description

Commands in this context configure additional types of leases or triggers that cause the system to hold up leases.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

solicited-release boolean
Synopsis Apply lease hold timer for solicited releases
Contextconfigure router string dhcp-server dhcpv4 string lease-hold additional-scenarios solicited-release boolean
Treesolicited-release

Description

This command enables the server to hold up a lease even for a solicited release, for example, when the server receives a normal DHCP release message.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

time number
Synopsis Lease hold time
Context configure router string dhcp-server dhcpv4 string lease-hold time number
Treetime
Range1 to 631152000
Unitsseconds
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

pool [pool-name] string
Synopsis Enter the pool list instance
Context configure router string dhcp-server dhcpv4 string pool string
Treepool

Description

Commands in this context configure a DHCP address pool on the router.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[pool-name] string
Synopsis DHCP server pool name
Context configure router string dhcp-server dhcpv4 string pool string
Treepool
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string dhcp-server dhcpv4 string pool string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string dhcp-server dhcpv4 string pool string failover
Treefailover

Description

Commands in this context define DHCP failover where two DHCP servers manage the same pool of addresses, enabling them to share the load to assign leases for pool and provide backup for each in the event of network outages.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the failover mechanism
Contextconfigure router string dhcp-server dhcpv4 string pool string failover admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ignore-mclt-on-takeover boolean
Synopsis Ignore maximum client lead during takeover from partner
Contextconfigure router string dhcp-server dhcpv4 string pool string failover ignore-mclt-on-takeover boolean
Treeignore-mclt-on-takeover

Description

When configured to true, the remote IP address range can be taken over immediately when the intercommunication link enters the PARTNER-DOWN state, without having to wait for the MCLT to expire.

When configured to false, the DHCP lease time for new clients is restricted to the MCLT during a failure. For existing clients, the lease time is gradually reduced over time to the MCLT by consecutive DHCP renewals.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-client-lead-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum time that DHCP server can extend client's lease
Contextconfigure router string dhcp-server dhcpv4 string pool string failover maximum-client-lead-time number
Treemaximum-client-lead-time

Description

This command configures the maximum client lead time (MCLT), which is the maximum time that a DHCP server can extend the client's lease time beyond the lease time currently known by the DHCP partner node. In dual-homed environments, the initial lease time for all DHCP clients is restricted to the MCLT by default. Consecutive DHCP renewals can extend the lease time beyond the MCLT.

Range600 to 86399
Unitsseconds
Default 600
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

partner-down-delay number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDelay to prevent lease duplication during link failure
Contextconfigure router string dhcp-server dhcpv4 string pool string failover partner-down-delay number
Treepartner-down-delay

Description

This command configures the interval before a failed intercommunication link transitions from the COMM-INT state to the PARTNER-DOWN state. This delay prevents IP lease duplication during link failure by not allowing new IP addresses to be assigned from the remote IP address range. This timer is intended to provide the operator with enough time to remedy the failed situation and avoid duplication of IP addresses and prefixes during the failure.

Range0 to 86399
Unitsseconds
Default 86399
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer [address] reference
Synopsis Enter the peer list instance
Context configure router string dhcp-server dhcpv4 string pool string failover peer reference
Treepeer

Description

Commands in this context configure peer-related parameters for DHCP failover.

DHCP leases can be synchronized at the level of the DHCP server or pool. The pair of synchronizing servers or pools is identified by a tag. The synchronization information is carried over the Multi-Chassis Synchronization (MCS) link between the two peers. The MCS link is a logical IP or MPLS link.

MCS runs over TCP port 45067, using either data traffic or keepalives to detect failure on the communication link between the two nodes. In the absence of any MCS data traffic for more than 0.5 seconds, MCS sends its own keepalive to the peer. If a reply is not received within 3 seconds, MCS declares its operational state as down and the DB sync state as out-of-sync. MCS consequently notifies its clients, including the DHCP server. It can take up to 3 seconds before the DHCP client realizes that the inter-chassis link has failed.

The link failure does not necessarily imply the same failed state for the access links. It is possible, although unlikely, that both access links are operational while the inter-chassis communication link is broken. In this case, the two redundant nodes can become isolated from each other in the network. For this reason, it is important that the MCS link be highly redundant.

Max. Instances1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[address] reference
Synopsis IP address of the failover peer
Context configure router string dhcp-server dhcpv4 string pool string failover peer reference
Treepeer

Reference

configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone)

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sync-tag string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTag that identifies synchronizing server or pool pairs
Contextconfigure router string dhcp-server dhcpv4 string pool string failover peer reference sync-tag string
Treesync-tag
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

startup-wait-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime between initialization and assuming active role
Contextconfigure router string dhcp-server dhcpv4 string pool string failover startup-wait-time number
Treestartup-wait-time

Description

This command configures a delay that avoids transient issues during the initialization process. During startup wait time, each failover peer waits after the initialization process before assuming the active role for the prefix designated as local or remote.

Range60 to 3600
Unitsseconds
Default 120
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-lease-time number
Synopsis Maximum lease time
Context configure router string dhcp-server dhcpv4 string pool string max-lease-time number
Treemax-lease-time
Range10 to 315446399
Unitsseconds
Default 864000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

min-lease-time number
Synopsis Minimum lease time
Context configure router string dhcp-server dhcpv4 string pool string min-lease-time number
Treemin-lease-time
Range10 to 315446399
Unitsseconds
Default 600
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

minimum-free
Synopsis Enter the minimum-free context
Contextconfigure router string dhcp-server dhcpv4 string pool string minimum-free
Treeminimum-free

Description

Commands in this context specify the minimum number of free addresses in this pool.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

absolute number
Synopsis Minimum number of free addresses in this pool or subnet
Contextconfigure router string dhcp-server dhcpv4 string pool string minimum-free absolute number
Treeabsolute
Range0 to 255
Default1

Notes

The following elements are part of a choice: absolute or percent.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

event-when-depleted boolean
Synopsis Generate notification when addresses are depleted
Contextconfigure router string dhcp-server dhcpv4 string pool string minimum-free event-when-depleted boolean
Treeevent-when-depleted

Description

When configured to true, a system-generated event is generated when all available addresses in the pool or subnet of a local DHCP server are depleted.

When configured to false, no action is taken when all available addresses in the pool or subnet of a local DHCP server are depleted.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

percent number
Synopsis Minimum free addresses as a percentage
Contextconfigure router string dhcp-server dhcpv4 string pool string minimum-free percent number
Treepercent
Range0 to 100
Default1

Notes

The following elements are part of a choice: absolute or percent.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

nak-non-matching-subnet boolean
Synopsis Send NAK if no match for request address pool range
Contextconfigure router string dhcp-server dhcpv4 string pool string nak-non-matching-subnet boolean
Treenak-non-matching-subnet

Description

When configured to true, a NAK response when the local DHCPv4 server receives a DHCP request with option 50 (the client is trying to request a previously allocated message). If the address-allocation algorithm uses a pool that does not contain the requested address, the system returns the DHCP NAK.

When configured to false or unconfigured, the system drops the DHCP packet.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

offer-time number
Synopsis Time interval during which a DHCP offer remains valid
Contextconfigure router string dhcp-server dhcpv4 string pool string offer-time number
Treeoffer-time
Range10 to 600
Unitsseconds
Default 60
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

options
Synopsis Enter the options context
Context configure router string dhcp-server dhcpv4 string pool string options
Treeoptions

Description

Commands in this context define DHCPv4 pool options.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

option [number] (number | keyword)
Synopsis Enter the option list instance
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword)
Treeoption

Description

This command configures DHCP options at the pool level. The pool options can be overruled by the value of the same option in the local user database.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[number] (number | keyword)
Synopsis DHCP option to send identification strings to client
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword)
Treeoption
Range1 to 254
Optionssubnet-mask, default-router, dns-server, domain-name, netbios-name-server, netbios-node-type, lease-time, lease-renew-time, lease-rebind-time

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ascii-string string
Synopsis DHCP option specified as an ASCII string
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword) ascii-string string
Treeascii-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duration number
Synopsis DHCP option specified as time duration
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword) duration number
Treeduration
Range10 to 315446399
Unitsseconds

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

empty
Synopsis Remove DHCP option from configuration
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword) empty
Treeempty

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hex-string string
Synopsis DHCP option specified as hexadecimal string
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword) hex-string string
Treehex-string
String Length1 to 256

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ipv4-address string
Synopsis DHCP option specified as a list of IPv4 addresses
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword) ipv4-address string
Treeipv4-address
Max. Instances4

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

This element is ordered by the user.

Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

netbios-node-type keyword
Synopsis DHCP option specified as a NetBIOS node type
Contextconfigure router string dhcp-server dhcpv4 string pool string options option (number | keyword) netbios-node-type keyword
Treenetbios-node-type
Optionsb-node, p-node, m-node, h-node

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

subnet [ipv4-prefix] string
Synopsis Enter the subnet list instance
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string
Treesubnet
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[ipv4-prefix] string
Synopsis IPv4 prefix for the subnet
Context configure router string dhcp-server dhcpv4 string pool string subnet string
Treesubnet

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

address-range [start] string end string
Synopsis Enter the address-range list instance
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string address-range string end string
Treeaddress-range

Description

This command configures the range of IP addresses to be served from the pool subnet. The range includes all the IP addresses between the specified start and end addresses, other than specifically excluded addresses. The start and end addresses must be unique within the subnet.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[start] string
Synopsis Lower bound of the IP address range
Context configure router string dhcp-server dhcpv4 string pool string subnet string address-range string end string
Treeaddress-range

Description

This command specifies the start of a range of IP addresses that are excluded from the pool of IP addresses in this subnet.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

end string
Synopsis Upper bound of the IP address range
Context configure router string dhcp-server dhcpv4 string pool string subnet string address-range string end string
Treeaddress-range

Description

This command specifies the end of a range of IP addresses that are excluded from the pool of IP addresses in this subnet.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover-control-type keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisFailover control type for this range
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string address-range string end string failover-control-type keyword
Treefailover-control-type
Optionslocal, remote, access-driven
Defaultlocal
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

drain boolean
Synopsis Prevent new lease assignment from this subnet
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string drain boolean
Treedrain

Description

When configured to true, new leases cannot be assigned and existing leases are kept up until they are released.

When configured to false, the subnet is active and new leases can be assigned.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

exclude-addresses [start] string end string
Synopsis Add a list entry for exclude-addresses
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string exclude-addresses string end string
Treeexclude-addresses

Description

This command configures an IP address to be excluded from the pool of IP addresses in the subnet.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[start] string
Synopsis Lower bound of the IP address range
Context configure router string dhcp-server dhcpv4 string pool string subnet string exclude-addresses string end string
Treeexclude-addresses

Description

This command specifies the start of a range of IP addresses that are excluded from the pool of IP addresses in this subnet.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

end string
Synopsis Upper bound of the IP address range
Context configure router string dhcp-server dhcpv4 string pool string subnet string exclude-addresses string end string
Treeexclude-addresses

Description

This command specifies the end of a range of IP addresses that are excluded from the pool of IP addresses in this subnet.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-declined number
Synopsis Maximum number of declined addresses allowed
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string maximum-declined number
Treemaximum-declined
Max. Range0 to 4294967295
Default64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

minimum-free
Synopsis Enter the minimum-free context
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string minimum-free
Treeminimum-free

Description

Commands in this context specify the minimum number of free addresses in this pool.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

absolute number
Synopsis Minimum number of free addresses in this pool or subnet
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string minimum-free absolute number
Treeabsolute
Range0 to 255
Default1

Notes

The following elements are part of a choice: absolute or percent.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

event-when-depleted boolean
Synopsis Generate notification when addresses are depleted
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string minimum-free event-when-depleted boolean
Treeevent-when-depleted

Description

When configured to true, a system-generated event is generated when all available addresses in the pool or subnet of a local DHCP server are depleted.

When configured to false, no action is taken when all available addresses in the pool or subnet of a local DHCP server are depleted.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

percent number
Synopsis Minimum free addresses as a percentage
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string minimum-free percent number
Treepercent
Range0 to 100
Default1

Notes

The following elements are part of a choice: absolute or percent.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

options
Synopsis Enter the options context
Context configure router string dhcp-server dhcpv4 string pool string subnet string options
Treeoptions
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

option [number] (number | keyword)
Synopsis Enter the option list instance
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword)
Treeoption

Description

This command configures DHCP options at the pool subnet level. The options can be overruled by the value of the same option in the local user database.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[number] (number | keyword)
Synopsis DHCP option to send identification strings to client
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword)
Treeoption
Range1 to 254
Optionssubnet-mask, default-router, dns-server, domain-name, netbios-name-server, netbios-node-type, lease-time, lease-renew-time, lease-rebind-time

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ascii-string string
Synopsis DHCP option specified as an ASCII string
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword) ascii-string string
Treeascii-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duration number
Synopsis DHCP option specified as time
Context configure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword) duration number
Treeduration
Range10 to 315446399
Unitsseconds

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

empty
Synopsis Empty DHCP option
Context configure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword) empty
Treeempty

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hex-string string
Synopsis DHCP option specified as hexadecimal string
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword) hex-string string
Treehex-string
String Length1 to 256

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ipv4-address string
Synopsis DHCP option specified as a list of IPv4 addresses
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword) ipv4-address string
Treeipv4-address
Max. Instances4

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

This element is ordered by the user.

Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

netbios-node-type keyword
Synopsis DHCP option specified as a NetBIOS node type
Contextconfigure router string dhcp-server dhcpv4 string pool string subnet string options option (number | keyword) netbios-node-type keyword
Treenetbios-node-type
Optionsb-node, p-node, m-node, h-node

Notes

The following elements are part of a mandatory choice: ascii-string, duration, empty, hex-string, ipv4-address, or netbios-node-type.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

pool-selection
Synopsis Enter the pool-selection context
Contextconfigure router string dhcp-server dhcpv4 string pool-selection
Treepool-selection
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

use-gi-address
Synopsis Enable the use-gi-address context
Contextconfigure router string dhcp-server dhcpv4 string pool-selection use-gi-address
Treeuse-gi-address

Description

Commands in this context configure gateway interface (GI) address matching. When configured, the pool can be used for address matching even if a subnet is not found. If the local user database name is not used, addresses are provided only by GI. If a user must be blocked from getting an address, the server maps to a local user database and configures the user with no address.

A pool can include multiple subnets. Since the GI is shared by multiple subnets in a subscriber interface, the pool can provide IP addresses from any of the subnets included when the GI is matched to one of its subnets. This allows a pool to be created that represents a sub-net.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

use-pool-from-client
Synopsis Enable the use-pool-from-client context
Contextconfigure router string dhcp-server dhcpv4 string pool-selection use-pool-from-client
Treeuse-pool-from-client
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

delimiter string
Synopsis Delimiter to combine primary and secondary pool names
Contextconfigure router string dhcp-server dhcpv4 string pool-selection use-pool-from-client delimiter string
Treedelimiter

Description

This command configures a single ASCII character that separates the pool names in DHCP vendor-specific option 82, which identifies the address pool to be used for this client.

String Length1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

user-identification keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUser identification method for the DHCP server
Contextconfigure router string dhcp-server dhcpv4 string user-identification keyword
Treeuser-identification
Optionsmac-circuit-id, client-id, mac, circuit-id, remote-id
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

dhcpv6 [name] string
Synopsis Enter the dhcpv6 list instance
Contextconfigure router string dhcp-server dhcpv6 string
Treedhcpv6

Description

Commands in this context configure DHCPv6 parameters.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis DHCP server name
Context configure router string dhcp-server dhcpv6 string
Treedhcpv6
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the DHCP server
Contextconfigure router string dhcp-server dhcpv6 string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

auto-provisioned boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAuto-provision the pools of this server
Contextconfigure router string dhcp-server dhcpv6 string auto-provisioned boolean
Treeauto-provisioned
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

defaults
Synopsis Enter the defaults context
Context configure router string dhcp-server dhcpv6 string defaults
Treedefaults
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

options
Synopsis Enter the options context
Context configure router string dhcp-server dhcpv6 string defaults options
Treeoptions
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

option [number] (number | keyword)
Synopsis Enter the option list instance
Contextconfigure router string dhcp-server dhcpv6 string defaults options option (number | keyword)
Treeoption

Description

This command configures DHCP options at the pool level. The pool options defined here can be overruled by the value of the same option in the local user database.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[number] (number | keyword)
Synopsis DHCP option to send as identification string
Contextconfigure router string dhcp-server dhcpv6 string defaults options option (number | keyword)
Treeoption
Range1 to 65535
Optionsdns-server, domain-name

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ascii-string string
Synopsis DHCP option specified as an ASCII string
Contextconfigure router string dhcp-server dhcpv6 string defaults options option (number | keyword) ascii-string string
Treeascii-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

domain-string string
Synopsis DHCP option specified as a domain name
Contextconfigure router string dhcp-server dhcpv6 string defaults options option (number | keyword) domain-string string
Treedomain-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duration number
Synopsis DHCP option specified as time
Context configure router string dhcp-server dhcpv6 string defaults options option (number | keyword) duration number
Treeduration
Range10 to 315446399
Unitsseconds

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

empty
Synopsis Empty DHCP option
Context configure router string dhcp-server dhcpv6 string defaults options option (number | keyword) empty
Treeempty

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hex-string string
Synopsis DHCP option specified as hexadecimal string
Contextconfigure router string dhcp-server dhcpv6 string defaults options option (number | keyword) hex-string string
Treehex-string
String Length1 to 256

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ipv6-address string
Synopsis DHCP option specified as a list of IPv6 addresses
Contextconfigure router string dhcp-server dhcpv6 string defaults options option (number | keyword) ipv6-address string
Treeipv6-address
Max. Instances4

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

This element is ordered by the user.

Introduced 16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

preferred-lifetime number
Synopsis Time this lease remains preferred
Context configure router string dhcp-server dhcpv6 string defaults preferred-lifetime number
Treepreferred-lifetime

Description

This command configures the preferred lifetime of the IPv6 lease address or prefix. When the preferred lifetime expires, any derived addresses are deprecated. The preferred lifetime must be less than or equal to the valid lifetime. 

Each address or prefix assigned to the client has associated preferred and valid lifetimes specified by the address assignment authority (such as the DHCP server, RADIUS, or ESM). To request an extension of the lifetimes assigned to an address, the client sends a renew message to the addressing authority. The authority sends a reply message to the client with the new lifetimes, allowing the client to continue to use the address/prefix without interruption. The lifetimes are transmitted from the addressing authority to the client in the identity association (IA) option at the top level of the message (not the address or prefix level).

Range300 to 315446399
Unitsseconds
Default 3600
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

rebind-time number
Synopsis Rebind time for the lease
Context configure router string dhcp-server dhcpv6 string defaults rebind-time number
Treerebind-time

Description

This command configures the rebind time, known as T2, at which the client contacts the addressing authority to extend the lifetimes of its leases.

The IP addressing authority (such as the DHCP server, RADIUS, or ESM) controls the time for extending lifetimes on assigned addresses/prefixes through the T1 and T2 parameters assigned to an identity association (IA). At renew time, T1, the client initiates a renew or reply message exchange to extend the lifetimes of any addresses in the IA. The client includes an IA option with all addresses or prefixes currently assigned to the IA in its renew message.

Recommended values for T1 and T2 are 0.5 and 0.8 times the shortest preferred lifetime of the addresses or prefixes in the IA that the addressing authority is willing to extend, respectively. The configured rebind timer value should always be less than or equal to the rebind timer. The T1 and T2 values are carried in the IPV6 address option in the IA.

Range0 to 1209600
Unitsseconds
Default 2880
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

renew-time number
Synopsis Renew time for the lease
Context configure router string dhcp-server dhcpv6 string defaults renew-time number
Treerenew-time

Description

This command configures the renew time, known as T1, at which the client makes a transition to the lease-renewal state.

The IP addressing authority (such as the DHCP server, RADIUS, or ESM) controls the time for extending lifetimes on assigned addresses/prefixes through the T1 and T2 parameters assigned to an identity association (IA). At renew time, T1, the client initiates a renew/reply message exchange to extend the lifetimes of any addresses in the IA. The client includes an IA option with all addresses/prefixes currently assigned to the IA in its renew message.

Recommended values for T1 and T2 are 0.5 and 0.8 times the shortest preferred lifetime of the addresses or prefixes in the IA that the addressing authority is willing to extend, respectively. The configured renew timer value should always be shorter than or equal to the rebind timer. The T1 and T2 values are carried in the IPV6 address option in the IA.

Range0 to 604800
Unitsseconds
Default 1800
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

valid-lifetime number
Synopsis Time for the lease to remain valid
Context configure router string dhcp-server dhcpv6 string defaults valid-lifetime number
Treevalid-lifetime

Description

This command configures a valid lifetime for a DHCPv6 lease address or prefix. The valid lifetime is the length of time an address and prefix remains in the valid state. The valid lifetime must be greater than or equal to the preferred lifetime. When the valid lifetime expires, the address and prefix becomes invalid and must not be used in communications. RFC 2461 recommends a default value of 30 days.

Each address and prefix assigned to the client has associated preferred and valid lifetimes specified by the address assignment authority (such as the DHCP server, RADIUS, or ESM). To request an extension of the lifetimes assigned to an address, the client sends a renew message to the addressing authority. The authority sends a reply message to the client with the new lifetimes, allowing the client to continue to use the address and prefix without interruption. The lifetimes are transmitted from the addressing authority to the client in the identity association (IA) option at the top level of the message (not the address or prefix level).

Range300 to 315446399
Unitsseconds
Default 86400
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string dhcp-server dhcpv6 string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string dhcp-server dhcpv6 string failover
Treefailover
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the failover mechanism
Contextconfigure router string dhcp-server dhcpv6 string failover admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ignore-mclt-on-takeover boolean
Synopsis Ignore maximum client lead during takeover from partner
Contextconfigure router string dhcp-server dhcpv6 string failover ignore-mclt-on-takeover boolean
Treeignore-mclt-on-takeover

Description

When configured to true, the remote IP address range can be taken over immediately when the intercommunication link enters the PARTNER-DOWN state, without having to wait for the MCLT to expire.

When configured to false, the DHCP lease time for new clients is restricted to the MCLT during a failure. For existing clients, the lease time is gradually reduced over time to the MCLT by consecutive DHCP renewals.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-client-lead-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum time that DHCP server can extend client's lease
Contextconfigure router string dhcp-server dhcpv6 string failover maximum-client-lead-time number
Treemaximum-client-lead-time

Description

This command configures the maximum client lead time (MCLT), which is the maximum time that a DHCP server can extend the client's lease time beyond the lease time currently known by the DHCP partner node. In dual-homed environments, the initial lease time for all DHCP clients is restricted to the MCLT by default. Consecutive DHCP renewals can extend the lease time beyond the MCLT.

Range600 to 86399
Unitsseconds
Default 600
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

partner-down-delay number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDelay to prevent lease duplication during link failure
Contextconfigure router string dhcp-server dhcpv6 string failover partner-down-delay number
Treepartner-down-delay

Description

This command configures the interval before a failed intercommunication link transitions from the COMM-INT state to the PARTNER-DOWN state. This delay prevents IP lease duplication during link failure by not allowing new IP addresses to be assigned from the remote IP address range. This timer is intended to provide the operator with enough time to remedy the failed situation and avoid duplication of IP addresses and prefixes during the failure.

Range0 to 86399
Unitsseconds
Default 86399
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer [address] reference
Synopsis Enter the peer list instance
Context configure router string dhcp-server dhcpv6 string failover peer reference
Treepeer
Max. Instances1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[address] reference
Synopsis IP address of the failover peer
Context configure router string dhcp-server dhcpv6 string failover peer reference
Treepeer

Reference

configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone)

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sync-tag string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTag that identifies synchronizing server or pool pairs
Contextconfigure router string dhcp-server dhcpv6 string failover peer reference sync-tag string
Treesync-tag
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

startup-wait-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime between initialization and assuming active role
Contextconfigure router string dhcp-server dhcpv6 string failover startup-wait-time number
Treestartup-wait-time

Description

This command configures a delay that avoids transient issues during the initialization process. During startup wait time, each failover peer waits after the initialization process before assuming the active role for the prefix designated as local or remote.

Range60 to 3600
Unitsseconds
Default 120
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ignore-rapid-commit boolean
Synopsis Ignore Rapid Commit option
Context configure router string dhcp-server dhcpv6 string ignore-rapid-commit boolean
Treeignore-rapid-commit

Description

When configured to true, the server ignores the Rapid Commit option sent by the client and uses the regular message exchange.   

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

interface-id-mapping boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMap hosts within interface-to-prefix combinations
Contextconfigure router string dhcp-server dhcpv6 string interface-id-mapping boolean
Treeinterface-id-mapping

Description

When configured to true, this command specifies an interface-mapping method that uses a combination of unique /64 prefixes and interface IDs. A /64 prefix is allocated to each interface ID, and all clients with the same interface ID are assigned an address from the prefix. This method is used for bridging clients in the same local loop and SAP, so that sharing the prefix allows communication to stay local. For SLAAC-based assignment, downstream neighbor discovery is automatically enabled to resolve the assigned address.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lease-hold
Synopsis Enter the lease-hold context
Context configure router string dhcp-server dhcpv6 string lease-hold
Treelease-hold
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

additional-scenarios
Synopsis Enter the additional-scenarios context
Contextconfigure router string dhcp-server dhcpv6 string lease-hold additional-scenarios
Treeadditional-scenarios

Description

Commands in this context configure additional types of leases or triggers that cause the system to hold up leases.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

solicited-release boolean
Synopsis Apply lease hold timer for solicited releases
Contextconfigure router string dhcp-server dhcpv6 string lease-hold additional-scenarios solicited-release boolean
Treesolicited-release

Description

This command enables the server to hold up a lease even for a solicited release, for example, when the server receives a normal DHCP release message.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

time number
Synopsis Lease hold time
Context configure router string dhcp-server dhcpv6 string lease-hold time number
Treetime
Range1 to 631152000
Unitsseconds
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lease-query boolean
Synopsis Handle and reply to lease query messages
Contextconfigure router string dhcp-server dhcpv6 string lease-query boolean
Treelease-query
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

pool [pool-name] string
Synopsis Enter the pool list instance
Context configure router string dhcp-server dhcpv6 string pool string
Treepool
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[pool-name] string
Synopsis DHCP server pool name
Context configure router string dhcp-server dhcpv6 string pool string
Treepool
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

delegated-prefix
Synopsis Enter the delegated-prefix context
Contextconfigure router string dhcp-server dhcpv6 string pool string delegated-prefix
Treedelegated-prefix
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

length number
Synopsis Prefix length for pool if unspecified by client
Contextconfigure router string dhcp-server dhcpv6 string pool string delegated-prefix length number
Treelength
Range48 to 127
Default64
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum number
Synopsis Maximum delegated prefix length for this pool
Contextconfigure router string dhcp-server dhcpv6 string pool string delegated-prefix maximum number
Treemaximum
Range48 to 127
Default64
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

minimum number
Synopsis Minimum delegated prefix length for this pool
Contextconfigure router string dhcp-server dhcpv6 string pool string delegated-prefix minimum number
Treeminimum
Range48 to 127
Default48
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string dhcp-server dhcpv6 string pool string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

exclude-prefix [ipv6-prefix] string
Synopsis Add a list entry for exclude-prefix
Contextconfigure router string dhcp-server dhcpv6 string pool string exclude-prefix string
Treeexclude-prefix
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[ipv6-prefix] string
Synopsis IPv6 prefix to be excluded from available pool prefixes
Contextconfigure router string dhcp-server dhcpv6 string pool string exclude-prefix string
Treeexclude-prefix

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string dhcp-server dhcpv6 string pool string failover
Treefailover
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the failover mechanism
Contextconfigure router string dhcp-server dhcpv6 string pool string failover admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ignore-mclt-on-takeover boolean
Synopsis Ignore maximum client lead during takeover from partner
Contextconfigure router string dhcp-server dhcpv6 string pool string failover ignore-mclt-on-takeover boolean
Treeignore-mclt-on-takeover

Description

When configured to true, the remote IP address range can be taken over immediately when the intercommunication link enters the PARTNER-DOWN state, without having to wait for the MCLT to expire.

When configured to false, the DHCP lease time for new clients is restricted to the MCLT during a failure. For existing clients, the lease time is gradually reduced over time to the MCLT by consecutive DHCP renewals.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-client-lead-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum time that DHCP server can extend client's lease
Contextconfigure router string dhcp-server dhcpv6 string pool string failover maximum-client-lead-time number
Treemaximum-client-lead-time

Description

This command configures the maximum client lead time (MCLT), which is the maximum time that a DHCP server can extend the client's lease time beyond the lease time currently known by the DHCP partner node. In dual-homed environments, the initial lease time for all DHCP clients is restricted to the MCLT by default. Consecutive DHCP renewals can extend the lease time beyond the MCLT.

Range600 to 86399
Unitsseconds
Default 600
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

partner-down-delay number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDelay to prevent lease duplication during link failure
Contextconfigure router string dhcp-server dhcpv6 string pool string failover partner-down-delay number
Treepartner-down-delay

Description

This command configures the interval before a failed intercommunication link transitions from the COMM-INT state to the PARTNER-DOWN state. This delay prevents IP lease duplication during link failure by not allowing new IP addresses to be assigned from the remote IP address range. This timer is intended to provide the operator with enough time to remedy the failed situation and avoid duplication of IP addresses and prefixes during the failure.

Range0 to 86399
Unitsseconds
Default 86399
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer [address] reference
Synopsis Enter the peer list instance
Context configure router string dhcp-server dhcpv6 string pool string failover peer reference
Treepeer
Max. Instances1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[address] reference
Synopsis IP address of the failover peer
Context configure router string dhcp-server dhcpv6 string pool string failover peer reference
Treepeer

Reference

configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone)

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sync-tag string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTag that identifies synchronizing server or pool pairs
Contextconfigure router string dhcp-server dhcpv6 string pool string failover peer reference sync-tag string
Treesync-tag
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

startup-wait-time number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime between initialization and assuming active role
Contextconfigure router string dhcp-server dhcpv6 string pool string failover startup-wait-time number
Treestartup-wait-time

Description

This command configures a delay that avoids transient issues during the initialization process. During startup wait time, each failover peer waits after the initialization process before assuming the active role for the prefix designated as local or remote.

Range60 to 3600
Unitsseconds
Default 120
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

options
Synopsis Enter the options context
Context configure router string dhcp-server dhcpv6 string pool string options
Treeoptions
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

option [number] (number | keyword)
Synopsis Enter the option list instance
Contextconfigure router string dhcp-server dhcpv6 string pool string options option (number | keyword)
Treeoption
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[number] (number | keyword)
Synopsis DHCP option to send as identification string
Contextconfigure router string dhcp-server dhcpv6 string pool string options option (number | keyword)
Treeoption
Range1 to 65535
Optionsdns-server, domain-name

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ascii-string string
Synopsis DHCP option specified as an ASCII string
Contextconfigure router string dhcp-server dhcpv6 string pool string options option (number | keyword) ascii-string string
Treeascii-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

domain-string string
Synopsis DHCP option specified as a domain name
Contextconfigure router string dhcp-server dhcpv6 string pool string options option (number | keyword) domain-string string
Treedomain-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duration number
Synopsis DHCP option specified as time
Context configure router string dhcp-server dhcpv6 string pool string options option (number | keyword) duration number
Treeduration
Range10 to 315446399
Unitsseconds

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

empty
Synopsis Empty DHCP option
Context configure router string dhcp-server dhcpv6 string pool string options option (number | keyword) empty
Treeempty

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hex-string string
Synopsis DHCP option specified as hexadecimal string
Contextconfigure router string dhcp-server dhcpv6 string pool string options option (number | keyword) hex-string string
Treehex-string
String Length1 to 256

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ipv6-address string
Synopsis DHCP option specified as a list of IPv6 addresses
Contextconfigure router string dhcp-server dhcpv6 string pool string options option (number | keyword) ipv6-address string
Treeipv6-address
Max. Instances4

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

This element is ordered by the user.

Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

prefix [ipv6-prefix] string
Synopsis Enter the prefix list instance
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string
Treeprefix
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[ipv6-prefix] string
Synopsis IPv6 prefix to be excluded from available pool prefixes
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string
Treeprefix

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

drain boolean
Synopsis No new leases can be assigned
Context configure router string dhcp-server dhcpv6 string pool string prefix string drain boolean
Treedrain
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover-control-type keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisFailover control type for this range
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string failover-control-type keyword
Treefailover-control-type
Optionslocal, remote, access-driven
Defaultlocal
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

options
Synopsis Enter the options context
Context configure router string dhcp-server dhcpv6 string pool string prefix string options
Treeoptions
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

option [number] (number | keyword)
Synopsis Enter the option list instance
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword)
Treeoption
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[number] (number | keyword)
Synopsis DHCP option to send as identification string
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword)
Treeoption
Range1 to 65535
Optionsdns-server, domain-name

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ascii-string string
Synopsis DHCP option specified as an ASCII string
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword) ascii-string string
Treeascii-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

domain-string string
Synopsis DHCP option specified as a domain name
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword) domain-string string
Treedomain-string
String Length1 to 127

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duration number
Synopsis DHCP option specified as time
Context configure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword) duration number
Treeduration
Range10 to 315446399
Unitsseconds

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

empty
Synopsis Empty DHCP option
Context configure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword) empty
Treeempty

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hex-string string
Synopsis DHCP option specified as hexadecimal string
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword) hex-string string
Treehex-string
String Length1 to 256

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ipv6-address string
Synopsis DHCP option specified as a list of IPv6 addresses
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string options option (number | keyword) ipv6-address string
Treeipv6-address
Max. Instances4

Notes

The following elements are part of a mandatory choice: ascii-string, domain-string, duration, empty, hex-string, or ipv6-address.

This element is ordered by the user.

Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

preferred-lifetime number
Synopsis Time this lease remains preferred
Context configure router string dhcp-server dhcpv6 string pool string prefix string preferred-lifetime number
Treepreferred-lifetime

Description

This command configures the preferred lifetime of the IPv6 lease address or prefix. When the preferred lifetime expires, any derived addresses are deprecated. The preferred lifetime must be less than or equal to the valid lifetime. 

Each address or prefix assigned to the client has associated preferred and valid lifetimes specified by the address assignment authority (such as the DHCP server, RADIUS, or ESM). To request an extension of the lifetimes assigned to an address, the client sends a renew message to the addressing authority. The authority sends a reply message to the client with the new lifetimes, allowing the client to continue to use the address/prefix without interruption. The lifetimes are transmitted from the addressing authority to the client in the identity association (IA) option at the top level of the message (not the address or prefix level).

Range300 to 315446399
Unitsseconds
Default 3600
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

prefix-length-threshold [prefix-length] number
Synopsis Enter the prefix-length-threshold list instance
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string prefix-length-threshold number
Treeprefix-length-threshold
Max. Instances8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

absolute number
Synopsis Minimum number of free prefixes for this prefix length
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string prefix-length-threshold number absolute number
Treeabsolute
Range1 to 4294967295

Notes

The following elements are part of a choice: absolute or percent.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

percent number
Synopsis Minimum percentage of free prefixes for prefix length
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string prefix-length-threshold number percent number
Treepercent
Range1 to 100

Notes

The following elements are part of a choice: absolute or percent.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

prefix-type
Synopsis Enter the prefix-type context
Context configure router string dhcp-server dhcpv6 string pool string prefix string prefix-type
Treeprefix-type
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

pd boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAllocate IA-PD prefixes from this prefix pool
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string prefix-type pd boolean
Treepd
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

wan-host boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAllocate IA-NA or SLAAC prefixes from this prefix pool
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix string prefix-type wan-host boolean
Treewan-host
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

rebind-time number
Synopsis Rebind time for the lease
Context configure router string dhcp-server dhcpv6 string pool string prefix string rebind-time number
Treerebind-time

Description

This command configures the rebind time, known as T2, at which the client contacts the addressing authority to extend the lifetimes of its leases.

The IP addressing authority (such as the DHCP server, RADIUS, or ESM) controls the time for extending lifetimes on assigned addresses/prefixes through the T1 and T2 parameters assigned to an identity association (IA). At renew time, T1, the client initiates a renew or reply message exchange to extend the lifetimes of any addresses in the IA. The client includes an IA option with all addresses or prefixes currently assigned to the IA in its renew message.

Recommended values for T1 and T2 are 0.5 and 0.8 times the shortest preferred lifetime of the addresses or prefixes in the IA that the addressing authority is willing to extend, respectively. The configured rebind timer value should always be less than or equal to the rebind timer. The T1 and T2 values are carried in the IPV6 address option in the IA.

Range0 to 1209600
Unitsseconds
Default 2880
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

renew-time number
Synopsis Renew time for the lease
Context configure router string dhcp-server dhcpv6 string pool string prefix string renew-time number
Treerenew-time

Description

This command configures the renew time, known as T1, at which the client makes a transition to the lease-renewal state.

The IP addressing authority (such as the DHCP server, RADIUS, or ESM) controls the time for extending lifetimes on assigned addresses/prefixes through the T1 and T2 parameters assigned to an identity association (IA). At renew time, T1, the client initiates a renew/reply message exchange to extend the lifetimes of any addresses in the IA. The client includes an IA option with all addresses/prefixes currently assigned to the IA in its renew message.

Recommended values for T1 and T2 are 0.5 and 0.8 times the shortest preferred lifetime of the addresses or prefixes in the IA that the addressing authority is willing to extend, respectively. The configured renew timer value should always be shorter than or equal to the rebind timer. The T1 and T2 values are carried in the IPV6 address option in the IA.

Range0 to 604800
Unitsseconds
Default 1800
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

valid-lifetime number
Synopsis Time for the lease to remain valid
Context configure router string dhcp-server dhcpv6 string pool string prefix string valid-lifetime number
Treevalid-lifetime

Description

This command configures a valid lifetime for a DHCPv6 lease address or prefix. The valid lifetime is the length of time an address and prefix remains in the valid state. The valid lifetime must be greater than or equal to the preferred lifetime. When the valid lifetime expires, the address and prefix becomes invalid and must not be used in communications. RFC 2461 recommends a default value of 30 days.

Each address and prefix assigned to the client has associated preferred and valid lifetimes specified by the address assignment authority (such as the DHCP server, RADIUS, or ESM). To request an extension of the lifetimes assigned to an address, the client sends a renew message to the addressing authority. The authority sends a reply message to the client with the new lifetimes, allowing the client to continue to use the address and prefix without interruption. The lifetimes are transmitted from the addressing authority to the client in the identity association (IA) option at the top level of the message (not the address or prefix level).

Range300 to 315446399
Unitsseconds
Default 86400
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

prefix-length-threshold [prefix-length] number
Synopsis Enter the prefix-length-threshold list instance
Contextconfigure router string dhcp-server dhcpv6 string pool string prefix-length-threshold number
Treeprefix-length-threshold
Max. Instances8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

pool-selection
Synopsis Enter the pool-selection context
Contextconfigure router string dhcp-server dhcpv6 string pool-selection
Treepool-selection
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

use-link-address
Synopsis Enable the use-link-address context
Contextconfigure router string dhcp-server dhcpv6 string pool-selection use-link-address
Treeuse-link-address

Description

This command configures the local pool selection for DHCPv6 address or prefix assignment to use the link address. When configured, the selected pool contains a prefix covering the link address.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

use-pool-from-client
Synopsis Enable the use-pool-from-client context
Contextconfigure router string dhcp-server dhcpv6 string pool-selection use-pool-from-client
Treeuse-pool-from-client
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

delimiter string
Synopsis Delimiter to combine primary and secondary pool names
Contextconfigure router string dhcp-server dhcpv6 string pool-selection use-pool-from-client delimiter string
Treedelimiter

Description

This command configures a single ASCII character that separates the pool names in DHCP vendor-specific option 82, which identifies the address pool to be used for this client.

String Length1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

server-id
Synopsis Enter the server-id context
Context configure router string dhcp-server dhcpv6 string server-id
Treeserver-id
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duid-enterprise
Synopsis Enter the duid-enterprise context
Contextconfigure router string dhcp-server dhcpv6 string server-id duid-enterprise
Treeduid-enterprise

Notes

The following elements are part of a choice: duid-enterprise or duid-link-local.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ascii-string string
Synopsis DUID enterprise server ID specified as an ASCII string
Contextconfigure router string dhcp-server dhcpv6 string server-id duid-enterprise ascii-string string
Treeascii-string
String Length1 to 58

Notes

The following elements are part of a choice: ascii-string or hex-string.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hex-string string
Synopsis DUID enterprise server ID specified as a hex string
Contextconfigure router string dhcp-server dhcpv6 string server-id duid-enterprise hex-string string
Treehex-string
String Length1 to 118

Notes

The following elements are part of a choice: ascii-string or hex-string.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

duid-link-local
Synopsis Derive DUID server ID from a system link-layer address
Contextconfigure router string dhcp-server dhcpv6 string server-id duid-link-local
Treeduid-link-local

Notes

The following elements are part of a choice: duid-enterprise or duid-link-local.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

user-identification keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUser identification method for the DHCP server
Contextconfigure router string dhcp-server dhcpv6 string user-identification keyword
Treeuser-identification
Optionsduid, interface-id, interface-id-link-local
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

dns

Synopsis Enter the dns context
Context configure router string dns
Treedns
Introduced20.2.R1

Platforms

All

redirect-vprn
Synopsis Enter the redirect-vprn context
Contextconfigure router string dns redirect-vprn
Treeredirect-vprn

Description

Commands in this context configure DNS resolution of all packets through the VPRN DNS server.

The VPRN DNS server must be configured before using the commands in this context. If the VPRN DNS server is not configured, all packet resolution fails.

Introduced20.2.R1

Platforms

All

service [service-name] reference
Synopsis Enter the service list instance
Contextconfigure router string dns redirect-vprn service reference
Treeservice
Max. Instances1
Introduced20.2.R1

Platforms

All

[service-name] reference
Synopsis Administrative service name
Context configure router string dns redirect-vprn service reference
Treeservice

Reference

configure service vprn string

Notes

This element is part of a list key.

Introduced20.2.R1

Platforms

All

ecmp number

Synopsis Maximum equal-cost routes for routing table instance
Contextconfigure router string ecmp number
Treeecmp

Description

This command configures ECMP and defines the number of routes for path sharing.

ECMP can be used only for routes learned with the same preference and the same protocol.

If available ECMP routes at the best preference exceed the maximum ECMP routes allowed, the system selects the route using the following criteria:

  1. The system selects the lowest next hop router ID.

  2. If the next hop goes to the same neighbor, the system selects the next hop with the lowest interface index.

Range1 to 64
Default1
Introduced 16.0.R1

Platforms

All

entropy-label boolean

Synopsis Use entropy label
Context configure router string entropy-label boolean
Treeentropy-label

Description

When configured to true, this command enables the use of entropy labels.

The entropy label and indicator (EL/ELI) are inserted on relevant packets. Applicable packets are those for which at least one LSP in the stack at the far end has advertised the entropy-label capability. These LSPs are in LDP or RSVP tunnels used by an IGP or BGP shortcut. If the tunnel is of type RSVP, the entropy-label capability must also be enabled under the configure router mpls or configure router mpls lsp context.

This command also results in other traffic that is forwarded over an LDP or RSVP LSP for which this router is the LER, and for which there is no explicit service endpoint on this router, to have the EL/ELI enabled, subject to the LSP far-end advertising entropy-label-capability. An example of such traffic includes packets arriving on a stitched LDP LSP forwarded over an RSVP LSP.

The entropy label and the hash label features are mutually exclusive. The entropy label cannot be configured on a spoke SDP or service where the hash label feature has already been configured.

When configured to false, the use of entropy labels is disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

fib-priority keyword

Synopsis FIB priority for VPRN BGP routes
Context configure router string fib-priority keyword
Treefib-priority
Optionsstandard, high
Default standard
Introduced16.0.R1

Platforms

All

fib-telemetry boolean

Synopsis Collect extra state information
Context configure router string fib-telemetry boolean
Treefib-telemetry
Defaultfalse
Introduced16.0.R4

Platforms

All

firewall

Synopsis Enter the firewall context
Context configure router string firewall
Treefirewall
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

domain [name] string
Synopsis Enter the domain list instance
Contextconfigure router string firewall domain string
Treedomain
Max. Instances1024
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis Firewall domain name
Context configure router string firewall domain string
Treedomain
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the firewall domain
Contextconfigure router string firewall domain string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

dhcpv6-server
Synopsis Enter the dhcpv6-server context
Contextconfigure router string firewall domain string dhcpv6-server
Treedhcpv6-server
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

name string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDHCPv6 server name
Contextconfigure router string firewall domain string dhcpv6-server name string
Treename
String Length1 to 32
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

router-instance string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisRouter name
Contextconfigure router string firewall domain string dhcpv6-server router-instance string
Treerouter-instance
Introduced16.0.R4

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNAT group for this domain
Contextconfigure router string firewall domain string nat-group reference
Treenat-group

Reference

configure isa nat-group number

Notes

The following elements are part of a mandatory choice: nat-group or wlan-gw-group.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

prefix [ip-prefix] string
Synopsis Enter the prefix list instance
Contextconfigure router string firewall domain string prefix string
Treeprefix
Max. Instances4096
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

[ip-prefix] string
Synopsis IP prefix and prefix length for the domain firewall
Contextconfigure router string firewall domain string prefix string
Treeprefix

Description

This command configures a prefix for which firewall functionality applies within the domain. Prefixes cannot be shared or duplicated across multiple domains in the same routing context. A domain can contain multiple prefixes.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

wlan-gw-group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisWLAN GW group used for NAT
Contextconfigure router string firewall domain string wlan-gw-group reference
Treewlan-gw-group

Reference

configure isa wlan-gw-group number

Notes

The following elements are part of a mandatory choice: nat-group or wlan-gw-group.

Introduced16.0.R4

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

flowspec

Synopsis Enter the flowspec context
Context configure router string flowspec
Treeflowspec

Description

This command configures the maximum number of flowspec routes, or rules, that can be entered in the auto-created embedded filter, fSpec-X. Flowspec filter entries are placed in an ingress IP filter policy in this router from the filter range between the configured offset plus 1 (embedding offset plus 1) and the value of this command (embedding offset plus ip-filter-max-size or ipv6-filter-max-size).

The sum of the maximum-size value and the highest offset in any IP filter that embeds flowspec rules from this routing instance (excluding filters that embed at offset 262143) must not exceed 262143.

The maximum size can be adjusted up or down at any time. If the current number of flowspec rules is greater than the new maximum, the extra rules are removed immediately but retained in the BGP RIB. If the limit is increased, new rules are embedded only as they are received in new BGP updates.

Introduced16.0.R1

Platforms

All

filter-cam-type keyword
Synopsis Filter policy type for FlowSpec embedding
Contextconfigure router string flowspec filter-cam-type keyword
Treefilter-cam-type

Description

This command specifies the filter type that is required to embed FlowSpec entries. The filter type defines the match criteria that are available in the filter policy.

Optionsnormal, packet-length
Defaultnormal
Introduced 20.7.R1

Platforms

All

ip-filter-max-size number
Synopsis Maximum number of flowspec rule entries in IPv4 filter
Contextconfigure router string flowspec ip-filter-max-size number
Treeip-filter-max-size

Description

This command configures the maximum number of IPv4 flowspec routes, or rules, that can be entered in the auto-created embedded filter, fSpec-X. Flowspec filter entries embedded in a filter policy in this routing instance will use filter entries from the range between the embedding offset and (offset + ip-filter-max-size – 1).

The sum of the maximum-size value and the highest offset in any IPv4 filter that embeds IPv4 flowspec rules from this routing instance (excluding filters that embed at offset 262143) must not exceed 262143.

The maximum size can be adjusted up or down at any time. If the current number of IPv4 flowspec rules is greater than the new maximum, the extra rules are removed immediately but retained in the BGP RIB. If the limit is increased, new rules are programmed only as they are received in new BGP updates.

Range0 to 262143
Default512
Introduced 16.0.R1

Platforms

All

ipv6-filter-max-size number
Synopsis Maximum number of flowspec rule entries in IPv6 filter
Contextconfigure router string flowspec ipv6-filter-max-size number
Treeipv6-filter-max-size

Description

This command configures the maximum number of IPv6 flowspec routes or rules that can be embedded into an ingress IPv6 filter policy for a specified routing instance. Flowspec filter entries embedded in a filter policy in this routing instance will use filter entries from the range between the embedding offset and (offset + ip-filter-max-size – 1).

The sum of the maximum-size value and the highest offset in any IPv6 filter that embeds IPv6 flowspec rules from this routing instance (excluding filters that embed at offset 262143) must not exceed 262143.

The maximum size can be adjusted up or down at any time. If the current number of IPv6 flowspec rules is greater than the new maximum, the extra rules are removed immediately but retained in the BGP RIB. If the limit is increased, new rules are programmed only as they are received in new BGP updates.

Range0 to 262143
Default512
Introduced 16.0.R1

Platforms

All

gtm

Synopsis Enter the gtm context
Context configure router string gtm
Treegtm
Introduced19.5.R1

Platforms

All

mvpn boolean
Synopsis Enable the configuration of MVPN-related parameters
Contextconfigure router string gtm mvpn boolean
Treemvpn
Defaultfalse
Introduced19.5.R1

Platforms

All

provider-tunnel
Synopsis Enter the provider-tunnel context
Contextconfigure router string gtm provider-tunnel
Treeprovider-tunnel
Introduced19.5.R1

Platforms

All

inclusive
Synopsis Enter the inclusive context
Context configure router string gtm provider-tunnel inclusive
Treeinclusive
Introduced19.5.R1

Platforms

All

rsvp
Synopsis Enable the rsvp context
Context configure router string gtm provider-tunnel inclusive rsvp
Treersvp
Introduced19.5.R1

Platforms

All

selective
Synopsis Enter the selective context
Context configure router string gtm provider-tunnel selective
Treeselective
Introduced19.5.R1

Platforms

All

data-threshold
Synopsis Enter the data-threshold context
Contextconfigure router string gtm provider-tunnel selective data-threshold
Treedata-threshold
Introduced19.5.R1

Platforms

All

group-prefix [ip-group-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the group-prefix list instance
Contextconfigure router string gtm provider-tunnel selective data-threshold group-prefix (ipv4-prefix | ipv6-prefix)
Treegroup-prefix
Introduced19.5.R1

Platforms

All

rsvp
Synopsis Enable the rsvp context
Context configure router string gtm provider-tunnel selective rsvp
Treersvp
Introduced19.5.R1

Platforms

All

gtp

Synopsis Enter the gtp context
Context configure router string gtp
Treegtp
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

s11
Synopsis Enter the s11 context
Context configure router string gtp s11
Trees11
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

interface [interface-name] reference
Synopsis Enter the interface list instance
Contextconfigure router string gtp s11 interface reference
Treeinterface
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

[interface-name] reference
Synopsis Name for the S11 interface
Context configure router string gtp s11 interface reference
Treeinterface

Reference

configure router string interface string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

peer-profile-map
Synopsis Enter the peer-profile-map context
Contextconfigure router string gtp s11 peer-profile-map
Treepeer-profile-map
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

prefix [peer-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the prefix list instance
Contextconfigure router string gtp s11 peer-profile-map prefix (ipv4-prefix | ipv6-prefix)
Treeprefix
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

[peer-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP prefix and prefix length for the subnet
Contextconfigure router string gtp s11 peer-profile-map prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

upf-data-endpoint
Synopsis Enable the upf-data-endpoint context
Contextconfigure router string gtp upf-data-endpoint
Treeupf-data-endpoint

Description

Commands in this context configure a GTP - User Plane (GTP-U) endpoint used by BNG CUPS FWA sessions.

Introduced21.2.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

fpe reference
Synopsis FPE used to encapsulate and decapsulate GTP-U traffic
Contextconfigure router string gtp upf-data-endpoint fpe reference
Treefpe

Reference

configure fwd-path-ext fpe number

Notes

This element is mandatory.

Introduced21.5.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

interface reference
Synopsis Interface on which the GTP-U packets terminate
Contextconfigure router string gtp upf-data-endpoint interface reference
Treeinterface

Reference

configure router string interface string

Notes

This element is mandatory.

Introduced21.2.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

uplink
Synopsis Enable the uplink context
Context configure router string gtp uplink
Treeuplink
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

apn string
Synopsis Network identifier part of the APN for the uplink
Contextconfigure router string gtp uplink apn string
Treeapn
String Length1 to 80
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

pdn-type keyword
Synopsis Default PDN to be signaled in GTP
Context configure router string gtp uplink pdn-type keyword
Treepdn-type
Optionsipv4, ipv6, ipv4v6
Defaultipv4
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

peer-profile-map
Synopsis Enter the peer-profile-map context
Contextconfigure router string gtp uplink peer-profile-map
Treepeer-profile-map
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

prefix [peer-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the prefix list instance
Contextconfigure router string gtp uplink peer-profile-map prefix (ipv4-prefix | ipv6-prefix)
Treeprefix
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

[peer-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP prefix and prefix length for the subnet
Contextconfigure router string gtp uplink peer-profile-map prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

icmp-tunneling boolean

Synopsis Allow tunneling of ICMP reply packets over MPLS LSPs
Contextconfigure router string icmp-tunneling boolean
Treeicmp-tunneling
Defaultfalse
Introduced16.0.R1

Platforms

All

igmp

Synopsis Enable the igmp context
Context configure router string igmp
Treeigmp
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of IGMP
Context configure router string igmp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

forwarding-group-interface forwarding-service string group-interface-name reference
Synopsis Enter the forwarding-group-interface list instance
Contextconfigure router string igmp forwarding-group-interface forwarding-service string group-interface-name reference
Treeforwarding-group-interface
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

import-policy reference
Synopsis Import policy that filters IGMP packets
Contextconfigure router string igmp forwarding-group-interface forwarding-service string group-interface-name reference import-policy reference
Treeimport-policy

Description

This command configures the IGMP import policy, or filter, for an interface subscriber or a group interface. An IGMP filter is also known as a black or white list, and it is defined as a router policy option.

When redirection is applied, only the import policy from the subscriber is in effect. The import policy under the group interface is applicable only for IGMP states received directly on the SAP (AN in IGMP proxy mode).

Reference

configure policy-options policy-statement string

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-number-group-sources number
Synopsis Maximum number of group sources for this interface
Contextconfigure router string igmp forwarding-group-interface forwarding-service string group-interface-name reference maximum-number-group-sources number
Treemaximum-number-group-sources

Description

This command configures the maximum number of group sources for which IGMP or MLD can have local receiver information based on received IGMP or MLD reports on this interface. When this configuration is changed dynamically to a lower value than the currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources are not allowed.

Range1 to 32000
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

mcac
Synopsis Enter the mcac context
Context configure router string igmp forwarding-group-interface forwarding-service string group-interface-name reference mcac
Treemcac
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

bandwidth
Synopsis Enter the bandwidth context
Context configure router string igmp forwarding-group-interface forwarding-service string group-interface-name reference mcac bandwidth
Treebandwidth
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

policy reference
Synopsis Multicast CAC policy name
Context configure router string igmp forwarding-group-interface forwarding-service string group-interface-name reference mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

group-interface [group-interface-name] reference
Synopsis Enter the group-interface list instance
Contextconfigure router string igmp group-interface reference
Treegroup-interface
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of IGMP
Context configure router string igmp group-interface reference admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

import-policy reference
Synopsis Import policy that filters IGMP packets
Contextconfigure router string igmp group-interface reference import-policy reference
Treeimport-policy

Description

This command configures the IGMP import policy, or filter, for an interface subscriber or a group interface. An IGMP filter is also known as a black or white list, and it is defined as a router policy option.

When redirection is applied, only the import policy from the subscriber is in effect. The import policy under the group interface is applicable only for IGMP states received directly on the SAP (AN in IGMP proxy mode).

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-number-group-sources number
Synopsis Maximum number of group sources for this interface
Contextconfigure router string igmp group-interface reference maximum-number-group-sources number
Treemaximum-number-group-sources

Description

This command configures the maximum number of group sources for which IGMP or MLD can have local receiver information based on received IGMP or MLD reports on this interface. When this configuration is changed dynamically to a lower value than the currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources are not allowed.

Range1 to 32000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

mcac
Synopsis Enter the mcac context
Context configure router string igmp group-interface reference mcac
Treemcac
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

bandwidth
Synopsis Enter the bandwidth context
Context configure router string igmp group-interface reference mcac bandwidth
Treebandwidth
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

mandatory (number | keyword)
Synopsis Pre-reserved bandwidth for all mandatory channels
Contextconfigure router string igmp group-interface reference mcac bandwidth mandatory (number | keyword)
Treemandatory
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

total (number | keyword)
Synopsis Maximum allowed bandwidth
Context configure router string igmp group-interface reference mcac bandwidth total (number | keyword)
Treetotal
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

policy reference
Synopsis Multicast CAC policy name
Context configure router string igmp group-interface reference mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

query-interval number
Synopsis Time between two consecutive host-query messages
Contextconfigure router string igmp group-interface reference query-interval number
Treequery-interval
Range2 to 1024
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

query-source-address string
Synopsis Source address for IGMP queries
Context configure router string igmp group-interface reference query-source-address string
Treequery-source-address

Description

This command configures the query source IP address for the group interface. This IP address overrides the source IP address configured at the router level.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sub-hosts-only boolean
Synopsis Allow IGMP traffic from known hosts only
Contextconfigure router string igmp group-interface reference sub-hosts-only boolean
Treesub-hosts-only
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

subnet-check boolean
Synopsis Allow subnet checking
Context configure router string igmp group-interface reference subnet-check boolean
Treesubnet-check
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

version keyword
Synopsis IGMP protocol version
Context configure router string igmp group-interface reference version keyword
Treeversion
Options1, 2, 3
Default3
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

interface [ip-interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string igmp interface string
Treeinterface
Introduced16.0.R1

Platforms

All

[ip-interface-name] string
Synopsis IP interface name
Context configure router string igmp interface string
Treeinterface

Description

This command configures the interface name, which must be unique within the group of defined IP interfaces for the context. If the IP interface name does not exist or does not have an IP address configured, an error message is returned. If the IP interface exists in a different area, it is moved to this area.

An interface name cannot be in the form of an IP address.

String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

admin-state keyword
Synopsis Administrative state of IGMP
Context configure router string igmp interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

import-policy reference
Synopsis Import policy that filters IGMP packets
Contextconfigure router string igmp interface string import-policy reference
Treeimport-policy

Description

This command configures the IGMP import policy, or filter, for an interface subscriber or a group interface. An IGMP filter is also known as a black or white list, and it is defined as a router policy option.

When redirection is applied, only the import policy from the subscriber is in effect. The import policy under the group interface is applicable only for IGMP states received directly on the SAP (AN in IGMP proxy mode).

Reference

configure policy-options policy-statement string

Introduced16.0.R1

Platforms

All

maximum-number-group-sources number
Synopsis Maximum number of group sources for this interface
Contextconfigure router string igmp interface string maximum-number-group-sources number
Treemaximum-number-group-sources

Description

This command configures the maximum number of group sources for which IGMP or MLD can have local receiver information based on received IGMP or MLD reports on this interface. When this configuration is changed dynamically to a lower value than the currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources are not allowed.

Range1 to 32000
Introduced16.0.R1

Platforms

All

mcac
Synopsis Enter the mcac context
Context configure router string igmp interface string mcac
Treemcac
Introduced16.0.R1

Platforms

All

bandwidth
Synopsis Enter the bandwidth context
Context configure router string igmp interface string mcac bandwidth
Treebandwidth
Introduced16.0.R1

Platforms

All

mandatory (number | keyword)
Synopsis Pre-reserved bandwidth for all mandatory channels
Contextconfigure router string igmp interface string mcac bandwidth mandatory (number | keyword)
Treemandatory
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

All

total (number | keyword)
Synopsis Maximum allowed bandwidth
Context configure router string igmp interface string mcac bandwidth total (number | keyword)
Treetotal
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

All

mc-constraints
Synopsis Enter the mc-constraints context
Contextconfigure router string igmp interface string mcac mc-constraints
Treemc-constraints
Introduced16.0.R1

Platforms

All

level [level-id] number
Synopsis Enter the level list instance
Context configure router string igmp interface string mcac mc-constraints level number
Treelevel

Description

Commands in this context configure the amount of bandwidth available within a given bundle for MC traffic for a specified level.

Introduced16.0.R1

Platforms

All

[level-id] number
Synopsis Bandwidth level ID for an MCAC constraint
Contextconfigure router string igmp interface string mcac mc-constraints level number
Treelevel
Range1 to 8

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

number-down [number-lag-port-down] number
Synopsis Enter the number-down list instance
Contextconfigure router string igmp interface string mcac mc-constraints number-down number
Treenumber-down

Description

Commands in this context configure the number of ports down along with level for the MCAC policy on the interface.

Introduced16.0.R1

Platforms

All

level number
Synopsis Level ID to associate with number of down LAG ports
Contextconfigure router string igmp interface string mcac mc-constraints number-down number level number
Treelevel

Description

This command specifies the bandwidth for a given level. Level 1 has the highest priority and level 8 has the lowest priority.

Range1 to 8

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

use-lag-port-weight boolean
Synopsis Use LAG port weight in calculating MCAC constraints
Contextconfigure router string igmp interface string mcac mc-constraints use-lag-port-weight boolean
Treeuse-lag-port-weight

Description

When configured to true, port weight is used when determining available bandwidth per level when LAG ports go down or come up. This command is required for proper operation on mixed port-speed LAGs and can also be used for unmixed port-speed LAGs.

Defaultfalse
Introduced16.0.R1

Platforms

All

policy reference
Synopsis Multicast CAC policy name
Context configure router string igmp interface string mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced16.0.R1

Platforms

All

ssm-translate
Synopsis Enter the ssm-translate context
Contextconfigure router string igmp interface string ssm-translate
Treessm-translate

Description

Commands in this context configure a group range that is translated to SSM (S,G) entries. If a static entry needs to be created, it is translated from an IGMPv1 or v2 request to an SSM join message.

Introduced16.0.R1

Platforms

All

group-range start string end string
Synopsis Enter the group-range list instance
Contextconfigure router string igmp interface string ssm-translate group-range start string end string
Treegroup-range

Description

Commands in this context configure the range of IP addresses that is translated to SSM (S,G) entries.

Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string igmp interface string ssm-translate group-range start string end string source string
Treesource
Min. Instances1
Introduced16.0.R1

Platforms

All

static
Synopsis Enter the static context
Context configure router string igmp interface string static
Treestatic

Description

Commands in this context configure the testing of multicast forwarding on an interface without a receiver host.

Introduced16.0.R1

Platforms

All

group [group-address] string
Synopsis Enter the group list instance
Context configure router string igmp interface string static group string
Treegroup

Description

Commands in this context configure a static multicast group as either a starg (*,G), or one or more SSM (S,G) records. IGMP static group memberships are used to test multicast forwarding without a receiver host.

When a static IGMP group is configured, data is forwarded to an interface without receiving membership reports from host members.

When the group entries are configured on point-to-point links that connect routers to a rendezvous point (RP), the static IGMP group entries do not generate join messages toward the RP.

Introduced16.0.R1

Platforms

All

[group-address] string
Synopsis Group address of static IGMP multicast channel
Contextconfigure router string igmp interface string static group string
Treegroup

Description

This command configures an address that receives data on an interface. The IP address must be unique for each static group.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string igmp interface string static group string source string
Treesource

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R1

Platforms

All

[source-address] string
Synopsis Source IP address of multicast channel sending data
Contextconfigure router string igmp interface string static group string source string
Treesource

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

starg
Synopsis Add a starg (*,G) address entry for the group range
Contextconfigure router string igmp interface string static group string starg
Treestarg

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R2

Platforms

All

group-range start string end string step string
Synopsis Enter the group-range list instance
Contextconfigure router string igmp interface string static group-range start string end string step string
Treegroup-range

Description

Commands in this context configure the ranges of IP addresses for the static groups.

Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string igmp interface string static group-range start string end string step string source string
Treesource

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R1

Platforms

All

starg
Synopsis Add a starg (*,G) address entry for the group range
Contextconfigure router string igmp interface string static group-range start string end string step string starg
Treestarg

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R2

Platforms

All

version keyword
Synopsis IGMP protocol version
Context configure router string igmp interface string version keyword
Treeversion
Options1, 2, 3
Default3
Introduced 16.0.R1

Platforms

All

query-interval number
Synopsis Time between two consecutive host-query messages
Contextconfigure router string igmp query-interval number
Treequery-interval

Description

This command configures the timing of the host-query messages that solicit group membership information. The messages are sent to the all-systems multicast group address, 224.0.0.1.

Range2 to 1024
Unitsseconds
Default 125
Introduced16.0.R1

Platforms

All

query-last-member-interval number
Synopsis Time between group-specific query messages
Contextconfigure router string igmp query-last-member-interval number
Treequery-last-member-interval

Description

This command configures the timing of the query-message interval, defining the interval for leave-group messages among others. The lower the interval that is configured, the faster the detection of the loss of the last member of a group.

Range1 to 1023
Unitsseconds
Default 1
Introduced16.0.R1

Platforms

All

robust-count number
Synopsis Number of retries after expected message loss
Contextconfigure router string igmp robust-count number
Treerobust-count

Description

This command configures the level of expected packet loss on a subnet. If a subnet anticipates losses, this value can be increased.

Range2 to 10
Default2
Introduced 16.0.R1

Platforms

All

ssm-translate
Synopsis Enter the ssm-translate context
Contextconfigure router string igmp ssm-translate
Treessm-translate

Description

Commands in this context configure a group range that is translated to SSM (S,G) entries. If a static entry needs to be created, it is translated from an IGMPv1 or v2 request to an SSM join message.

Introduced16.0.R1

Platforms

All

group-range start string end string
Synopsis Enter the group-range list instance
Contextconfigure router string igmp ssm-translate group-range start string end string
Treegroup-range

Description

Commands in this context configure the range of IP addresses that is translated to SSM (S,G) entries.

Introduced16.0.R1

Platforms

All

tunnel-interface
Synopsis Enter the tunnel-interface context
Contextconfigure router string igmp tunnel-interface
Treetunnel-interface
Introduced16.0.R1

Platforms

All

ldp-p2mp-root [p2mp-id] reference sender-address reference
Synopsis Enter the ldp-p2mp-root list instance
Contextconfigure router string igmp tunnel-interface ldp-p2mp-root reference sender-address reference
Treeldp-p2mp-root

Description

Commands in this context configure the LDP parameters for the IGMP P2MP LSP tunnel.

Introduced16.0.R1

Platforms

All

static
Synopsis Enter the static context
Context configure router string igmp tunnel-interface ldp-p2mp-root reference sender-address reference static
Treestatic

Description

Commands in this context configure static multicast receiver hosts on a tunnel interface associated with an RSVP P2MP LSP.

When a static IGMP group is configured, data is forwarded to an interface without receiving membership reports from host members.

Introduced16.0.R1

Platforms

All

group [group-address] string
Synopsis Enter the group list instance
Context configure router string igmp tunnel-interface ldp-p2mp-root reference sender-address reference static group string
Treegroup

Description

Commands in this context configure a static multicast group as either a starg (*,G), or one or more SSM (S,G) records.

Static multicast group joins can be assigned to a tunnel interface associated with an RSVP P2MP LSP.

A given <*,G> or <S,G> can only be associated with a single tunnel interface.

A multicast packet which is received on an interface and which succeeds the RPF check for the source address will be replicated and forwarded to all OIFs which correspond to the branches of the P2MP LSP. The packet is sent on each OIF with the label stack indicated in the NHLFE of this OIF. The packets will also be replicated and forwarded natively on all OIFs which have received IGMP or PIM joins for this <S,G>.

The multicast packet can be received over a PIM or IGMP interface which can be an IES interface, a spoke SDP terminated IES interface, or a network interface.

Introduced16.0.R1

Platforms

All

[group-address] string
Synopsis Group address of static IGMP multicast channel
Contextconfigure router string igmp tunnel-interface ldp-p2mp-root reference sender-address reference static group string
Treegroup

Description

This command configures an address that receives data on an interface. The IP address must be unique for each static group.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string igmp tunnel-interface ldp-p2mp-root reference sender-address reference static group string source string
Treesource

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R1

Platforms

All

rsvp-p2mp-root [lsp-name] reference
Synopsis Enter the rsvp-p2mp-root list instance
Contextconfigure router string igmp tunnel-interface rsvp-p2mp-root reference
Treersvp-p2mp-root

Description

Commands in this context configure the RSVP parameters for the IGMP P2MP LSP tunnel.

Introduced16.0.R1

Platforms

All

static
Synopsis Enter the static context
Context configure router string igmp tunnel-interface rsvp-p2mp-root reference static
Treestatic

Description

Commands in this context configure static multicast receiver hosts on a tunnel interface associated with an RSVP P2MP LSP.

When a static IGMP group is configured, data is forwarded to an interface without receiving membership reports from host members.

Introduced16.0.R1

Platforms

All

group [group-address] string
Synopsis Enter the group list instance
Context configure router string igmp tunnel-interface rsvp-p2mp-root reference static group string
Treegroup
Introduced16.0.R1

Platforms

All

[group-address] string
Synopsis Group address of static IGMP multicast channel
Contextconfigure router string igmp tunnel-interface rsvp-p2mp-root reference static group string
Treegroup

Description

This command configures an address that receives data on an interface. The IP address must be unique for each static group.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string igmp tunnel-interface rsvp-p2mp-root reference static group string source string
Treesource

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R1

Platforms

All

interface [interface-name] string

Synopsis Enter the interface list instance
Contextconfigure router string interface string
Treeinterface

Description

Commands in this context create a logical IP routing or unnumbered MPLS-TP interface. An IP address, port, or system can then be associated with the IP interface.

Introduced16.0.R1

Platforms

All

[interface-name] string
Synopsis Router interface name
Context configure router string interface string
Treeinterface

Description

This command specifies the name of the router interface. When a user enters a new name, the system creates a new logical interface and the context changes to that interface for more command processing.

When an existing interface name is entered, the user enters the router interface context for editing and configuration.

Nokia recommends using names that are meaningful and unique to remove ambiguity when displaying the state associated with IP interfaces either via show commands or model-driven interfaces.

See "Router configuration overview" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Router Configuration Guide for more information about the interface name.

String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the interface
Contextconfigure router string interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Introduced 16.0.R1

Platforms

All

cflowd-parameters
Synopsis Enter the cflowd-parameters context
Contextconfigure router string interface string cflowd-parameters
Treecflowd-parameters

Description

Commands in this context configure cflowd parameters for the associated IP interfaces.

Introduced16.0.R1

Platforms

All

sampling [sampling-type] keyword
Synopsis Enter the sampling list instance
Contextconfigure router string interface string cflowd-parameters sampling keyword
Treesampling

Description

Commands in this context configure cflowd sampling behavior, which configures the collection of traffic flow samples for analysis for this IP interface. 

Introduced16.0.R1

Platforms

All

[sampling-type] keyword
Synopsis Traffic sampling type
Context configure router string interface string cflowd-parameters sampling keyword
Treesampling

Description

This command configures the type of traffic to be sampled on the associated IP interface.

Optionsunicast, multicast, both

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

direction keyword
Synopsis Direction of traffic for cflowd sampling
Contextconfigure router string interface string cflowd-parameters sampling keyword direction keyword
Treedirection

Description

This command configures the direction in which sampling occurs on the associated IP interfaces.

Optionsingress-only, egress-only, both
Defaultingress-only
Introduced16.0.R1

Platforms

All

sample-profile (keyword | number)
Synopsis Sample profile ID
Context configure router string interface string cflowd-parameters sampling keyword sample-profile (keyword | number)
Treesample-profile

Description

This command defines the sampling rate profile associated with this interface.

Max. Range0 to 4294967295
Options1
Introduced19.5.R1

Platforms

All

type keyword
Synopsis Type of cflowd analysis
Context configure router string interface string cflowd-parameters sampling keyword type keyword
Treetype

Description

This command configures the cflowd sampling type on the associated IP interface.

Optionsacl, interface

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

cpu-protection reference
Synopsis CPU protection policy ID for the interface
Contextconfigure router string interface string cpu-protection reference
Treecpu-protection

Description

This command assigns an existing CPU protection policy to the associated interface. For these interface types, the per-source rate limit is not applicable.

If no CPU-protection policy is assigned to an interface, the default policy is used to limit the overall rate.

Reference

configure system security cpu-protection policy number

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR-7/12/12e, 7750 SR-7s, 7750 SR-14s, 7950 XRS

dist-cpu-protection reference
Synopsis DCP policy name for interface
Context configure router string interface string dist-cpu-protection reference
Treedist-cpu-protection

Description

This command configures a Distributed CPU Protection (DCP) policy for the associated IP interface or SAP. The user can only assign a valid created DCP policy to a SAP or network interface (this rule does not apply to templates such as an MSAP policy).

If the operator does not assign a DCP policy to a router interface, the system uses the default network DCP policy.

See "Distributed CPU protection" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR System Management Guide for more information.

Reference

configure system security dist-cpu-protection policy string

Introduced16.0.R1

Platforms

All

egress
Synopsis Enter the egress context
Context configure router string interface string egress
Treeegress

Description

Commands in this context configure egress network filter policies for the IP interface. The system does not filter unless an operator defines a filter.

Introduced16.0.R1

Platforms

All

filter
Synopsis Enter the filter context
Context configure router string interface string egress filter
Treefilter

Description

Commands in this context configure the names of the egress IPv4 and IPv6 network filter policies for the interface. Filter policies control packet forwarding and dropping based on IP match criteria.

Introduced16.0.R1

Platforms

All

eth-cfm
Synopsis Enter the eth-cfm context
Context configure router string interface string eth-cfm
Treeeth-cfm

Description

Commands in this context configure the Ethernet CFM parameters for the associated IP interface.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

mep md-admin-name reference ma-admin-name reference mep-id number
Synopsis Enter the mep list instance
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number
Treemep

Description

Commands in this context configure an 802.1ag Maintenance Endpoint (MEP) instance.

Max. Instances1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

mep-id number
Synopsis Maintenance Endpoint (MEP) ID
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number
Treemep
Range1 to 8191

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

alarm-notification
Synopsis Enter the alarm-notification context
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number alarm-notification
Treealarm-notification

Description

Commands in this context configure the Fault Notification Generator (FNG) time values to raise an alarm or reset the CCM defect alarm. 

Use these timers for network management processes. The timers are not tied into delaying the notification to the fault management system on the network element and do not affect fault propagation mechanisms.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ccm-padding-size number
Synopsis Number of octets of padding to insert in CCM packets
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number ccm-padding-size number
Treeccm-padding-size

Description

This command sets the byte size of the optional Data TLV to be included in the ETH-CC PDU.

This command increases the size of the ETH-CC PDU by the configured value. The base size of the ETH-CC PDU, including the Interface Status TLV and Port Status TLV, is 83 bytes not including the Layer 2 encapsulation. CCM padding is not supported when the CCM interval (configured through configure eth-cfm domain association ccm-interval) is less than 1 second.

Range3 to 1500
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ccm-tlv-ignore keyword
Synopsis TLV to ignore on reception
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number ccm-tlv-ignore keyword
Treeccm-tlv-ignore

Description

This command configures the receiving MEP to ignore the specified TLVs in the CCM PDU. The ignored TLVs are reported as absent and have no impact on the MEP state machine.

When unconfigured, the MEP processes all the recognized TLVs.

Optionsinterface-status, port-status
Max. Instances 2
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

collect-lmm-fc-stats
Synopsis Enter the collect-lmm-fc-stats context
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number collect-lmm-fc-stats
Treecollect-lmm-fc-stats

Description

Commands in this context configure per forwarding class (FC) LMM information collection.

The commands fc-in-profile and fc in this context are mutually exclusive. The commands apply to either profile-aware or profile-unaware FCs respectively. 

This command and the collect-lmm-stats command are mutually exclusive when there is entity resource contention.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

fc keyword
Synopsis Forwarding class name for profile-unaware counter
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number collect-lmm-fc-stats fc keyword
Treefc

Description

This command configures individual counters for the specified FCs without regard for profile. The system includes all countable packets that match a configured FC, regardless of profile, in this counter.

An FC specified as part of this command and for this specific context cannot be specified as a profile-aware FC using the fc-in-profile command under the collect-lmm-fc-stats context. 

When this command is reentered, a differential is performed. Omitted FCs stop counting, newly added FCs start counting, and unchanged FCs continue to count.

Optionsbe, l2, af, l1, h2, ef, h1, nc
Max. Instances 8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

fc-in-profile keyword
Synopsis Forwarding class name for profile-aware counter
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number collect-lmm-fc-stats fc-in-profile keyword
Treefc-in-profile

Description

This command configures individual counters for the specified FCs with regard to profile. The system includes all countable packets that match a configured FC and that are deemed to be in-profile in this counter.

An FC specified as part of this command and for this specific context cannot be specified as a profile-unaware FC using the fc command under the collect-lmm-fc-stats context.

When this command is reentered, a differential is performed. Omitted FCs stop counting, newly added FCs start counting, and unchanged FCs continue to count.

Optionsbe, l2, af, l1, h2, ef, h1, nc
Max. Instances 8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

collect-lmm-stats boolean
Synopsis Collect statistics for loss measurement message tests
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number collect-lmm-stats boolean
Treecollect-lmm-stats

Description

When configured to true, the router instantiates the statistical counter to transmit and receive packets for the LAG facility MEP bindings.

The show eth-cfm collect-lmm-stats command displays entities that have been enabled to collect transit and receive counters.

When configured to false, the router does not instantiate the counter and the LMM PDU associated with the MEP does not populate the counters in the packet.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

eth-test
Synopsis Enable the eth-test context
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number eth-test
Treeeth-test

Description

Commands in this context configure information used by the Ethernet Test (ETH-TST) packet. The commands must be configured on both the sender and the receiver nodes. The test packets are used with the oam eth-cfm eth-test command.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

test-pattern
Synopsis Enter the test-pattern context
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number eth-test test-pattern
Treetest-pattern

Description

Commands in this context specify the test pattern for the ETH-TST frames. The pattern does not have to be the same on the sender and the receiver.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

pattern keyword
Synopsis Test pattern for Ethernet Test frames
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number eth-test test-pattern pattern keyword
Treepattern

Description

This command specifies the test pattern of the Ethernet Test (ETH-TST) frames. This does not have to be configured the same on the sender and the receiver.

Optionsall-zeros, all-ones
Default all-zeros
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

facility-fault boolean
Synopsis Allow the facility MEP to generate a network action
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number facility-fault boolean
Treefacility-fault

Description

When configured to true, the system facility MEP responds to a fault with a network-actionable function instead of just reporting the defect condition.

When configured to false, the system monitors transmissions and reports fault conditions.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

grace
Synopsis Enter the grace context
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number grace
Treegrace

Description

Commands in this context configure the Nokia ETH-CFM Grace function and the ITU-T Y.1731 Ethernet Expected Default (ETH-ED) function.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

eth-ed
Synopsis Enter the eth-ed context
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number grace eth-ed
Treeeth-ed

Description

Commands in this context configure the ITU-T Y.1731 ETH-ED function.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

rx-eth-ed boolean
Synopsis Receive and process ETH-ED ITU-T Y.1731 PDUs on the MEP
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number grace eth-ed rx-eth-ed boolean
Treerx-eth-ed

Description

This command enables the reception and processing of the ITU-T Y.1731 ETH-ED PDU on the MEP.

Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

eth-vsm-grace
Synopsis Enter the eth-vsm-grace context
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number grace eth-vsm-grace
Treeeth-vsm-grace

Description

Commands in this context configure the Nokia ETH-CFM Grace function.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

rx-eth-vsm-grace boolean
Synopsis Receive and process Nokia ETH-CFM Grace PDU on the MEP
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number grace eth-vsm-grace rx-eth-vsm-grace boolean
Treerx-eth-vsm-grace

Description

When configured to true, the router enables the Nokia Grace function, which is a vendor-specific PDU that informs MEP peers that the local node may be entering a period of expected defect.

When configured to false, the router disables the Nokia Grace function.

Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

tx-eth-vsm-grace boolean
Synopsis Transmit ETH-ED PDUs from the MEP
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number grace eth-vsm-grace tx-eth-vsm-grace boolean
Treetx-eth-vsm-grace

Description

When configured to true, the router can transmit the Nokia ETH-CFM Grace PDU from the MEP when a system soft reset notification is received for one or more cards.

The Nokia Grace function is a vendor-specific PDU that informs MEP peers that the local node may be entering a period of expected defect.

The operator must configure the configure system eth-cfm grace command to instruct the system that the node is capable of transmitting expected-defect windows to peers. The system can only transmit one form of ETH-CFM grace (Nokia ETH-CFM Grace or ITU-T Y.1731 ETH-ED).

When configured to false, the router disables the transmission of the Nokia ETH-CFM Grace PDU from the MEP.

Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

lbm-svc-act-responder boolean
Synopsis Process service activation streams in ETH-CFM LBM
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number lbm-svc-act-responder boolean
Treelbm-svc-act-responder

Description

When configured to true, the router enables the MEP to process service activation streams encapsulated in ETH-CFM LBM frames that are directed to it.

When configured to false, this command reverts to MEP LBM standard processing.

There is interaction between this command and the tools perform service id loopback eth command. Nokia recommends that either the lbm-svc act-responder or the tools perform service id loopback eth command be used within a service. If both commands must be configured, and the target reflection point is the MAC Swap Loopback function, the inbound stream of data must not include ETH-CFM traffic that is equal to or lower than the domain level of any configured MEP that would otherwise extract and process the ETH-CFM message.

See "Promiscuous ETH-LBM mode of operation" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Services Overview Guide for more information.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

low-priority-defect keyword
Synopsis Lowest priority defect for fault alarm generation
Contextconfigure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number low-priority-defect keyword
Treelow-priority-defect

Description

This command specifies the lowest priority defect that generates a fault alarm and also configures the fault state of the MEP that causes a network reaction.

Optionsall-def, mac-rem-err-xcon, rem-err-xcon, err-xcon, xcon, no-xcon
Default mac-rem-err-xcon
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

mac-address string
Synopsis MAC address of the MEP
Context configure router string interface string eth-cfm mep md-admin-name reference ma-admin-name reference mep-id number mac-address string
Treemac-address

Description

This command specifies the MAC address of the MEP.

When unconfigured, the MAC address of the port (if the MEP is on a SAP) or the MAC address of a bridge (if the MEP is on a spoke) is used.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

external-reference
Synopsis Enter the external-reference context
Contextconfigure router string interface string external-reference
Treeexternal-reference

Description

Commands in this context configure the external reference used to map a Nokia vendor-specific configuration and the OpenConfig state.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

openconfig
Synopsis Enter the openconfig context
Context configure router string interface string external-reference openconfig
Treeopenconfig

Description

Commands in this context configure the OpenConfig reference key used to map a Nokia vendor-specific configuration and the OpenConfig state.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

subinterface number
Synopsis Reference to the subinterface
Context configure router string interface string external-reference openconfig subinterface number
Treesubinterface

Description

This command configures the subinterface used to map a Nokia vendor-specific configuration and the OpenConfig state.

This command configures the ability to query the OpenConfig state through NETCONF, gRPC, and the MD-CLI from any configuration mode, without having to add any OpenConfig model configuration. As part of the configuration, a user must also add a port to the Layer 3 interface.

Range0 to 4294967295
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

flavor keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNetwork interface flavor
Contextconfigure router string interface string flavor keyword
Treeflavor
Options

regular – Regular network interface

pdn – PDN interface

unnumbered-mpls-tp – Unnumbered MPLS-TP interface

Defaultregular
Introduced16.0.R1

Platforms

All

gre-termination boolean
Synopsis Terminate GRE packets on primary subnet of interface
Contextconfigure router string interface string gre-termination boolean
Treegre-termination
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

hold-time
Synopsis Enter the hold-time context
Context configure router string interface string hold-time
Treehold-time

Description

Commands in this context configure the interface-level up and down hold timers for the associated IP interface.

Introduced16.0.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string interface string hold-time ipv4
Treeipv4

Description

Commands in this context configure the interface-level IPv4 hold timers for the associated IP interface.

Introduced16.0.R1

Platforms

All

down
Synopsis Enter the down context
Context configure router string interface string hold-time ipv4 down
Treedown

Description

Commands in this context configure the down hold timer, which specifies the delay before activating the associated interface. The delay is invoked whenever the system attempts to bring the associated IP interface up, unless an operator configures the init-only command. 

Introduced16.0.R1

Platforms

All

init-only boolean
Synopsis Apply delay only at interface configuration or reboot
Contextconfigure router string interface string hold-time ipv4 down init-only boolean
Treeinit-only

Description

This command applies a delay only when the IP interface is first configured or after a system reboot.

Defaultfalse
Introduced16.0.R1

Platforms

All

up
Synopsis Enter the up context
Context configure router string interface string hold-time ipv4 up
Treeup

Description

Commands in this context configure the up hold timer, which specifies the delay before deactivation of the associated interface. The delay is invoked whenever the system attempts to bring the associated IP interface down.

Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string interface string hold-time ipv6
Treeipv6

Description

Commands in this context configure the interface-level IPv6 hold timers for the associated IP interface.

Introduced16.0.R1

Platforms

All

down
Synopsis Enter the down context
Context configure router string interface string hold-time ipv6 down
Treedown

Description

Commands in this context configure the down hold timer, which specifies the delay before activation of the associated interface. The delay is invoked whenever the system attempts to bring the associated IP interface up, unless an operator configures the init-only command. 

Introduced16.0.R1

Platforms

All

init-only boolean
Synopsis Apply delay only at interface configuration or reboot
Contextconfigure router string interface string hold-time ipv6 down init-only boolean
Treeinit-only

Description

When configured to true, the system applies a delay only when the IP interface is first configured or after a system reboot.

Defaultfalse
Introduced16.0.R1

Platforms

All

up
Synopsis Enter the up context
Context configure router string interface string hold-time ipv6 up
Treeup

Description

Commands in this context configure the up hold timer, which specifies the delay before deactivation of the associated interface. The delay is invoked whenever the system attempts to bring the associated IP interface down.

Introduced16.0.R1

Platforms

All

if-attribute
Synopsis Enter the if-attribute context
Contextconfigure router string interface string if-attribute
Treeif-attribute

Description

Commands in this context configure attributes of the IP interface.

Introduced16.0.R1

Platforms

All

admin-group reference
Synopsis Administrative group name for the interface
Contextconfigure router string interface string if-attribute admin-group reference
Treeadmin-group

Description

This command specifies the administrative group membership to an interface. 

The configured administrative group membership is applied in all levels or areas the interface is participating in. The same interface cannot have different memberships in different levels or areas.

Reference

configure routing-options if-attribute admin-group string

Max. Instances32
Introduced16.0.R1

Platforms

All

delay
Synopsis Enter the delay context
Context configure router string interface string if-attribute delay
Treedelay
Introduced20.7.R1

Platforms

All

delay-selection keyword
Synopsis Delay source advertised by IGP for the interface
Contextconfigure router string interface string if-attribute delay delay-selection keyword
Treedelay-selection
Optionsstatic, dynamic, static-preferred, dynamic-preferred
Defaultstatic-preferred
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

dynamic
Synopsis Enter the dynamic context
Context configure router string interface string if-attribute delay dynamic
Treedynamic

Description

Commands in this context configure dynamic link delay measurement options for the interface.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

twamp-light
Synopsis Enter the twamp-light context
Context configure router string interface string if-attribute delay dynamic twamp-light
Treetwamp-light
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv4
Synopsis Enter the ipv4 context
Context configure router string interface string if-attribute delay dynamic twamp-light ipv4
Treeipv4
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

admin-state keyword
Synopsis Administrative state of IPv4 TWAMP Light packets
Contextconfigure router string interface string if-attribute delay dynamic twamp-light ipv4 admin-state keyword
Treeadmin-state

Description

This command specifies the administrative state of the IPv4 encapsulated TWAMP Light measurement packets.

Optionsenable, disable
Default disable
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

destination string
Synopsis TWAMP Light measurement packet destination IPv4 address
Contextconfigure router string interface string if-attribute delay dynamic twamp-light ipv4 destination string
Treedestination

Description

This command specifies the unicast destination address to be associated with the IPv4 TWAMP Light measurement packet.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

source string
Synopsis TWAMP Light measurement packets source IPv4 address
Contextconfigure router string interface string if-attribute delay dynamic twamp-light ipv4 source string
Treesource

Description

This command specifies the unicast source address to be associated with the IPv4 TWAMP Light measurement packet.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv6
Synopsis Enter the ipv6 context
Context configure router string interface string if-attribute delay dynamic twamp-light ipv6
Treeipv6
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

destination string
Synopsis TWAMP Light measurement packet destination IPv6 address
Contextconfigure router string interface string if-attribute delay dynamic twamp-light ipv6 destination string
Treedestination

Description

This command specifies the unicast destination address to be associated with the IPv6 TWAMP Light measurement packet. Globally routable and Link Local addressing is supported.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

source string
Synopsis TWAMP Light measurement packets source IPv6 address
Contextconfigure router string interface string if-attribute delay dynamic twamp-light ipv6 source string
Treesource

Description

This command specifies the unicast source address to be associated with the IPv6 TWAMP Light measurement packet. Globally routable and Link Local addressing is supported.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

static number
Synopsis Unidirectional link delay static information
Contextconfigure router string interface string if-attribute delay static number
Treestatic

Description

This command configures the unidirectional link delay. By default there is no configured delay, and the link delay metric TLV is pruned in the IGP. 

Range1 to 16777214
Unitsmicroseconds
Introduced20.7.R1

Platforms

All

srlg-group [name] reference
Synopsis Add a list entry for srlg-group
Contextconfigure router string interface string if-attribute srlg-group reference
Treesrlg-group

Description

Commands in this context add a list entry for a Shared Risk Link Group (SRLG) that can be associated with an IP or MPLS interface to tag IP or MPLS interfaces that share a specific outcome with the same identifier. For example, an SRLG group identifier could represent all links that use separate fibers but are carried in the same fiber conduit. 

The name and identifier of each SRLG group must be configured locally on each router before the user configures the SRLG membership of an interface. A maximum of 1024 SRLGs can be configured per system. The user can apply SRLGs to an IES, VPRN, network IP, or MPLS interface. A maximum of 64 SRLGs can be applied to an interface.

See "Shared Risk Link Groups" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR MPLS Guide for more information about SRLGs.

Introduced16.0.R1

Platforms

All

ingress
Synopsis Enter the ingress context
Context configure router string interface string ingress
Treeingress

Description

Commands in this context configure ingress network filter policies for the IP interface. If an ingress filter is not defined, the system performs no filtering.

Introduced16.0.R1

Platforms

All

destination-class-lookup boolean
Synopsis Enable BGP destination class lookup
Context configure router string interface string ingress destination-class-lookup boolean
Treedestination-class-lookup

Description

When configured to true, the router performs a destination class lookup. This command is supported on FP3-based cards and later and is used in combination with the destination-class match criterion for an IP filter policy to filter egress traffic based on BGP destination classes.

When configured to false, destination class lookup is not enabled.

Defaultfalse
Introduced20.7.R1

Platforms

All

filter
Synopsis Enter the filter context
Context configure router string interface string ingress filter
Treefilter

Description

Commands in this context associate an IP filter policy with an IP interface. Filter policies control packet forwarding and dropping based on IP match criteria.

Introduced16.0.R1

Platforms

All

ingress-stats boolean
Synopsis Collect ingress statistics
Context configure router string interface string ingress-stats boolean
Treeingress-stats

Description

When configured to true, the router configures the collection of IPv4 and IPv6 offered packets and octets. This only applies to IP statistics, not to uRPF statistics.

Octet statistics for IPv4 and IPv6 bytes at IP interfaces include the Layer 2 frame overhead.

When configured to false, the router does not collect the statistics.

Defaultfalse
Introduced16.0.R1

Platforms

All

ip-mtu number
Synopsis Interface IP MTU
Context configure router string interface string ip-mtu number
Treeip-mtu

Description

This command configures the IP maximum transmission unit (MTU) for the associated router IP interface.

The operational IP MTU used for the interface is based on the configured IP MTU and the port MTU of the port bound to this interface; that is, the operational MTU is set to the lesser of the values configured by this command and the port MTU value less the Ethernet header size.

If the interface supports IPv6 packets, this command must be set to at least 1280, in accordance with RFC 2460 Internet Protocol, Version 6 (IPv6) Specification.

Range512 to 9786
Unitsbytes
Introduced 16.0.R1

Platforms

All

ipsec
Synopsis Enable the ipsec context
Context configure router string interface string ipsec
Treeipsec

Description

Commands in this context configure an IPsec secured interface.

Introduced22.7.R1

Platforms

VSR

admin-state keyword
Synopsis Administrative state of IPsec secured interface
Contextconfigure router string interface string ipsec admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced22.7.R1

Platforms

VSR

ip-exception reference
Synopsis IP exception filter
Context configure router string interface string ipsec ip-exception reference
Treeip-exception

Description

This command configures the IP exception filter for the secured interface. All ingress traffic matching the specified filter bypasses IPsec processing.

Reference

configure filter ip-exception string

Introduced22.7.R1

Platforms

VSR

ipsec-tunnel [name] string
Synopsis Enter the ipsec-tunnel list instance
Contextconfigure router string interface string ipsec ipsec-tunnel string
Treeipsec-tunnel

Description

Commands in this context configure IPsec tunnels used to secure traffic forwarded over the interface.

Introduced22.7.R1

Platforms

VSR

[name] string
Synopsis IPsec tunnel name
Context configure router string interface string ipsec ipsec-tunnel string
Treeipsec-tunnel
String Length1 to 32

Notes

This element is part of a list key.

Introduced22.7.R1

Platforms

VSR

bfd
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the bfd context
Contextconfigure router string interface string ipsec ipsec-tunnel string bfd
Treebfd
Introduced22.7.R1

Platforms

VSR

bfd-designate boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDesignate IPsec tunnel to carry BFD traffic
Contextconfigure router string interface string ipsec ipsec-tunnel string bfd bfd-designate boolean
Treebfd-designate
Defaultfalse
Introduced22.7.R1

Platforms

VSR

bfd-liveness
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the bfd-liveness context
Contextconfigure router string interface string ipsec ipsec-tunnel string bfd bfd-liveness
Treebfd-liveness

Description

Commands in this context configure a BFD session to provide a heart-beat mechanism for a specified IPsec tunnel. There can be only one BFD session assigned to any given IPsec tunnel, but there can be multiple IPsec tunnels using the same BFD session.

BFD controls the state of the association tunnel. If the BFD session goes down, the system brings down the associated non-designated IPsec tunnel.

Introduced22.7.R1

Platforms

VSR

dest-ip string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDestination address used for the BFD session
Contextconfigure router string interface string ipsec ipsec-tunnel string bfd bfd-liveness dest-ip string
Treedest-ip

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

interface string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisName of the interface used by the BFD session
Contextconfigure router string interface string ipsec ipsec-tunnel string bfd bfd-liveness interface string
Treeinterface
String Length1 to 32

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

service-name string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAdministrative service name
Contextconfigure router string interface string ipsec ipsec-tunnel string bfd bfd-liveness service-name string
Treeservice-name

Description

This command configures the name of the service where BFD traffic is forwarded to.

String Length1 to 64

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

clear-df-bit boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisReset the DF bit to 0 in all payload IP packets
Contextconfigure router string interface string ipsec ipsec-tunnel string clear-df-bit boolean
Treeclear-df-bit

Description

When configured to true, the DF bit is set to 0 in all payload IP packets associated with the IPsec tunnel, before any potential fragmentation occurs.

Defaultfalse
Introduced22.7.R1

Platforms

VSR

copy-traffic-class-upon-decapsulation boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable traffic class copy upon decapsulation
Contextconfigure router string interface string ipsec ipsec-tunnel string copy-traffic-class-upon-decapsulation boolean
Treecopy-traffic-class-upon-decapsulation

Description

When configured to true, the system copies the traffic class from the outer tunnel IP packet header to the payload IP packet header in the decapsulating direction (public to private).

Defaultfalse
Introduced22.7.R1

Platforms

VSR

encapsulated-ip-mtu number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum size of the encapsulated tunnel packet
Contextconfigure router string interface string ipsec ipsec-tunnel string encapsulated-ip-mtu number
Treeencapsulated-ip-mtu

Description

This command specifies the maximum size of the encapsulated tunnel packet to the IPsec tunnel, the IP tunnel, or the dynamic tunnels terminated on the IPsec Gateway. If the encapsulated IPv4 or IPv6 tunnel packet exceeds this value, the system fragments the packet.

Range512 to 9000
Unitsbytes
Introduced 22.7.R1

Platforms

VSR

icmp-generation
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the icmp-generation context
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp-generation
Treeicmp-generation

Description

Commands in this context configure settings for ICMPv4 message generation.

Introduced22.7.R1

Platforms

VSR

frag-required
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the frag-required context
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp-generation frag-required
Treefrag-required

Description

Commands in this context configure the attributes for sending generated ICMP Destination Unreachable "fragmentation needed and DF set" messages (type 3, code 4) back to the source, if the received size of the IPv4 packet on the private side exceeds the private MTU size.

Introduced22.7.R1

Platforms

VSR

admin-state keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAdministrative state of sending ICMP messages
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp-generation frag-required admin-state keyword
Treeadmin-state

Description

This command configures the administrative state of sending ICMP Destination Unreachable "fragmentation needed, DF set" messages (type 3, code 4) messages to the source if the received size of the IPv4 packet on the private side exceeds the private MTU size.

Optionsenable, disable
Default enable
Introduced22.7.R1

Platforms

VSR

interval number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisInterval for sending ICMP messages
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp-generation frag-required interval number
Treeinterval

Description

This command configures the interval for sending ICMP Destination Unreachable "fragmentation needed, DF set" messages (type 3, code 4).

Range1 to 60
Unitsseconds
Default 10
Introduced22.7.R1

Platforms

VSR

message-count number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of ICMP messages that can be sent
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp-generation frag-required message-count number
Treemessage-count

Description

This command configures the maximum number of ICMP Destination Unreachable "fragmentation needed, DF set" messages (type 3, code 4) that can be sent during the configured interval.

Range10 to 1000
Default100
Introduced 22.7.R1

Platforms

VSR

icmp6-generation
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the icmp6-generation context
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp6-generation
Treeicmp6-generation

Description

Commands in this context configure settings for ICMPv6 message generation.

Introduced22.7.R1

Platforms

VSR

packet-too-big
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the packet-too-big context
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp6-generation packet-too-big
Treepacket-too-big

Description

Commands in this context configure the parameters to send ICMPv6 PTB (Packet Too Big) messages on the private side.

The system sends PTB messages if a received IPv6 packet on the private side is greater than 1280 bytes and it exceeds the private MTU of the tunnel.

The private MTU for the tunnel is configured via the configure router interface ipsec ipsec-tunnel ip-mtu command for the interface.

Introduced22.7.R1

Platforms

VSR

interval number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisInterval for sending Packet Too Big messages
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp6-generation packet-too-big interval number
Treeinterval
Range1 to 60
Unitsseconds
Default 10
Introduced22.7.R1

Platforms

VSR

message-count number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of ICMPv6 PTB messages that can be sent
Contextconfigure router string interface string ipsec ipsec-tunnel string icmp6-generation packet-too-big message-count number
Treemessage-count

Description

This command configures the maximum number of PTB messages that can be sent during the configured interval.

Range10 to 1000
Default100
Introduced 22.7.R1

Platforms

VSR

ip-mtu number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisPrivate MTU of the IPsec tunnel
Contextconfigure router string interface string ipsec ipsec-tunnel string ip-mtu number
Treeip-mtu

Description

This command specifies the private MTU of the IPsec tunnel. The private MTU is used to determine the need for fragmentation before encapsulation of the payload packet.

Range512 to 9000
Unitsbytes
Introduced 22.7.R1

Platforms

VSR

key-exchange
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the key-exchange context
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange
Treekey-exchange
Introduced22.7.R1

Platforms

VSR

dynamic
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the dynamic context
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic
Treedynamic

Notes

The following elements are part of a choice: dynamic or manual.

Introduced22.7.R1

Platforms

VSR

cert
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the cert context
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic cert
Treecert

Description

Commands in this context configure the attributes of the dynamic keying certificate.

Introduced22.7.R1

Platforms

VSR

status-verify
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the status-verify context
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic cert status-verify
Treestatus-verify

Description

Commands in this context configure attributes of Certificate Status Verification (CSV).

Introduced22.7.R1

Platforms

VSR

primary keyword
Synopsis Primary method of CSV to verify the revocation status
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic cert status-verify primary keyword
Treeprimary

Description

This command configures the primary method of Certificate Status Verification (CSV) that is used to verify the revocation status of the certificate of the peer.

Optionscrl, ocsp
Default crl
Introduced22.7.R1

Platforms

VSR

secondary keyword
Synopsis Secondary method used to verify certificate revocation
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic cert status-verify secondary keyword
Treesecondary

Description

This command specifies the secondary method of Certificate Status Verification (CSV) that is used to verify the revocation status of the peer certificate.

Optionsnone, crl, ocsp
Defaultnone
Introduced22.7.R1

Platforms

VSR

id
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the id context
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic id
Treeid

Description

Commands in this context specify the local ID used for IDi or IDr for IKEv2 negotiation.

The default behavior depends on the local authentication method as follows:

  • Psk: local tunnel IP address

  • Cert-auth: subject of the local certificate

Introduced22.7.R1

Platforms

VSR

fqdn string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisFQDN used as the local ID IKE type
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic id fqdn string
Treefqdn
String Length1 to 255

Notes

The following elements are part of a choice: fqdn, ipv4, or ipv6.

Introduced22.7.R1

Platforms

VSR

ipv4 string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIPv4 as the local ID type
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic id ipv4 string
Treeipv4

Notes

The following elements are part of a choice: fqdn, ipv4, or ipv6.

Introduced22.7.R1

Platforms

VSR

ipv6 (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIPv6 used as the local IKE ID type
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic id ipv6 (ipv4-address-no-zone | ipv6-address-no-zone)
Treeipv6

Notes

The following elements are part of a choice: fqdn, ipv4, or ipv6.

Introduced22.7.R1

Platforms

VSR

ike-policy reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIKE policy ID
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic ike-policy reference
Treeike-policy

Description

This command specifies the ID of the IKE policy used for IKE negotiation.

The ipsec-transport-mode-profile configuration only supports IKEv2.

Reference

configure ipsec ike-policy number

Introduced22.7.R1

Platforms

VSR

ipsec-transform reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIPsec transform IDs used by the dynamic key
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange dynamic ipsec-transform reference
Treeipsec-transform

Description

This command specifies IPsec transform IDs used for CHILD_SA negotiation.

Reference

configure ipsec ipsec-transform number

Max. Instances4
Introduced22.7.R1

Platforms

VSR

manual
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the manual context
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange manual
Treemanual

Description

Commands in this context configure settings for manually configured security associations for the IPsec tunnel.

Notes

The following elements are part of a choice: dynamic or manual.

Introduced22.7.R1

Platforms

VSR

keys [security-association] number direction keyword
Synopsis Enter the keys list instance
Context configure router string interface string ipsec ipsec-tunnel string key-exchange manual keys number direction keyword
Treekeys

Description

Commands in this context configure the security association list for the tunnel.

Introduced22.7.R1

Platforms

VSR

spi number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisSPI of inbound and outbound packets
Contextconfigure router string interface string ipsec ipsec-tunnel string key-exchange manual keys number direction keyword spi number
Treespi

Description

This command specifies the Security Parameter Index (SPI) used to look up the instruction to verify and decrypt the incoming IPsec packets when the direction is inbound. When the direction is outbound, the SPI is used in the encoding of the outgoing packets.

The remote node can use the SPI to look up the instruction to verify and decrypt the packet.

Range256 to 16383

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

local-gateway-address-override (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal IPsec tunnel endpoint address
Contextconfigure router string interface string ipsec ipsec-tunnel string local-gateway-address-override (ipv4-address-no-zone | ipv6-address-no-zone)
Treelocal-gateway-address-override

Description

This command configures the local IPsec tunnel endpoint address. This overrides the default endpoint address, which is the interface address.

Introduced22.7.R1

Platforms

VSR

max-history-key-records
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the max-history-key-records context
Contextconfigure router string interface string ipsec ipsec-tunnel string max-history-key-records
Treemax-history-key-records

Description

Commands in this context configure the settings for recording historical IPsec keys.

Introduced22.7.R1

Platforms

VSR

esp number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of recent records
Contextconfigure router string interface string ipsec ipsec-tunnel string max-history-key-records esp number
Treeesp
Range1 to 48
Introduced22.7.R1

Platforms

VSR

ike number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of historical IKE key records
Contextconfigure router string interface string ipsec ipsec-tunnel string max-history-key-records ike number
Treeike
Range1 to 3
Introduced22.7.R1

Platforms

VSR

pmtu-discovery-aging number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAging out time of the learned path MTU
Contextconfigure router string interface string ipsec ipsec-tunnel string pmtu-discovery-aging number
Treepmtu-discovery-aging

Description

This command configures the temporary public and private MTU expiration time. The temporary MTU is used for MTU propagation.

Range900 to 3600
Unitsseconds
Default 900
Introduced22.7.R1

Platforms

VSR

private-sap number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisPrivate SAP ID
Contextconfigure router string interface string ipsec ipsec-tunnel string private-sap number
Treeprivate-sap
Range0 to 4094

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

private-service string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisPrivate service name
Contextconfigure router string interface string ipsec ipsec-tunnel string private-service string
Treeprivate-service

Description

This command configures the private service name.

If unconfigured, the private service is the service where the secured interface resides.

String Length1 to 64
Introduced22.7.R1

Platforms

VSR

private-tcp-mss-adjust number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTCP maximum segment size (MSS) adjustment
Contextconfigure router string interface string ipsec ipsec-tunnel string private-tcp-mss-adjust number
Treeprivate-tcp-mss-adjust

Description

This command specifies the TCP MSS to adjust for the tunnel on the private side.

When configured, the system may use the value to update the MSS option in the received TCP SYN packet on the private side.

Range512 to 9000
Unitsbytes
Introduced 22.7.R1

Platforms

VSR

propagate-pmtu-v4 boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable propagation of the path MTU to IPv4 hosts
Contextconfigure router string interface string ipsec ipsec-tunnel string propagate-pmtu-v4 boolean
Treepropagate-pmtu-v4

Description

When configured to true, the system propagates the path MTU learned from the public side to the private side (IPv4 hosts).

Defaulttrue
Introduced22.7.R1

Platforms

VSR

propagate-pmtu-v6 boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable propagation of the path MTU to IPv6 hosts
Contextconfigure router string interface string ipsec ipsec-tunnel string propagate-pmtu-v6 boolean
Treepropagate-pmtu-v6

Description

When configured to true, the system propagates the path MTU learned from the public side to the private side (IPv6 hosts).

Defaulttrue
Introduced22.7.R1

Platforms

VSR

public-tcp-mss-adjust (number | keyword)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTCP maximum segment size (MSS) on the public network
Contextconfigure router string interface string ipsec ipsec-tunnel string public-tcp-mss-adjust (number | keyword)
Treepublic-tcp-mss-adjust

Description

This command configures the MSS for the TCP traffic in an IPsec tunnel that is sent from the public network to the private network. The system may use this value to adjust or insert the MSS option in the TCP SYN packet.

Range512 to 9000
Unitsbytes
Options auto
Introduced 22.7.R1

Platforms

VSR

remote-gateway-address (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisRemote IPsec tunnel endpoint address
Contextconfigure router string interface string ipsec ipsec-tunnel string remote-gateway-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeremote-gateway-address
Introduced22.7.R1

Platforms

VSR

replay-window number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAnti-replay window size
Contextconfigure router string interface string ipsec ipsec-tunnel string replay-window number
Treereplay-window

Description

This command specifies the size of an IPsec anti-replay window. If unconfigured, IPsec anti-replay is disabled.

Range32 | 64 | 128 | 256 | 512
Unitspackets
Introduced22.7.R1

Platforms

VSR

security-policy
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the security-policy context
Contextconfigure router string interface string ipsec ipsec-tunnel string security-policy
Treesecurity-policy

Description

Commands in this context specify a security policy used by the tunnel.

Introduced22.7.R1

Platforms

VSR

id number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSecurity policy ID for use by the tunnel
Contextconfigure router string interface string ipsec ipsec-tunnel string security-policy id number
Treeid
Max. Range0 to 4294967295
Introduced22.7.R1

Platforms

VSR

strict-match boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable strict match of the security policy entry
Contextconfigure router string interface string ipsec ipsec-tunnel string security-policy strict-match boolean
Treestrict-match

Description

When configured to true, this command enables strict match of the security policy entry.

When a CREATE_CHILD exchange request is received for a static IPsec tunnel, and this request is not a rekey request, ISA matches the received TSi and TSr with the configured security policy. This can be a match only when a received TS (in TSi or TSr) address range matches exactly with the subnet in a security policy entry.

If there is no match, the setup fails, and TS_UNACCEPTABLE is sent.

If there is a match, but there is an existing CHILD_SA for the matched security policy, the setup fails, and NO_PROPOSAL_CHOSEN is sent.

If there is a match, and there is not a CHILD_SA for the matched entry, the subnet is sent in the matched security policy entry as TSi and TSr, and the CHILD_SA is created.

Defaultfalse
Introduced22.7.R1

Platforms

VSR

ipv6-exception reference
Synopsis IPv6 filter exception used to bypass encryption
Contextconfigure router string interface string ipsec ipv6-exception reference
Treeipv6-exception

Description

This command specifies the IPv6 filter exception for an IPsec-secured IPv6 interface. When an IPv6 filter exception is added, clear text packets that match the exception criteria in the IPv6 filter exception can ingress the interface, even when IPsec is enabled on the interface.

Reference

configure filter ipv6-exception string

Introduced22.7.R1

Platforms

VSR

public-sap number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisPublic SAP ID
Contextconfigure router string interface string ipsec public-sap number
Treepublic-sap
Range0 to 4094

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

tunnel-group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTunnel group ID
Contextconfigure router string interface string ipsec tunnel-group reference
Treetunnel-group

Reference

configure isa tunnel-group number

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

VSR

ipv4
Synopsis Enter the ipv4 context
Context configure router string interface string ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

allow-directed-broadcasts boolean
Synopsis Forward directed broadcasts
Context configure router string interface string ipv4 allow-directed-broadcasts boolean
Treeallow-directed-broadcasts

Description

When configured to true, the router forwards packets received on a local router interface to the subnet broadcast address of another IP interface.

When configured to false, this router does not allow directed broadcasts and the packets are discarded.

Allowing directed broadcasts is a well-known mechanism used for denial-of-service attacks.

Defaultfalse
Introduced16.0.R1

Platforms

All

bfd
Synopsis Enter the bfd context
Context configure router string interface string ipv4 bfd
Treebfd

Description

Commands in this context configure the Bidirectional Forwarding Detection (BFD) settings for the associated IP interface.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BFD sessions
Context configure router string interface string ipv4 bfd admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

echo-receive number
Synopsis Minimum echo interval over this interface
Contextconfigure router string interface string ipv4 bfd echo-receive number
Treeecho-receive
Range100 to 100000
Unitsmilliseconds
Introduced16.0.R1

Platforms

All

multiplier number
Synopsis Number of consecutive BFD messages missed from the peer
Contextconfigure router string interface string ipv4 bfd multiplier number
Treemultiplier

Description

This command configures the number of missed messages before the BFD session state is changed to down and the upper-level protocol is notified of the fault. A multiplier of less than 3 should not be used in production environments. 

Range1 to 20
Default3
Introduced 16.0.R1

Platforms

All

receive number
Synopsis BFD receive interval over this interface
Contextconfigure router string interface string ipv4 bfd receive number
Treereceive

Description

This command specifies the receive interval for the BFD session.

On the 7750 SR, this command can only be configured to a value less than 100 when the type command is configured to cpm-np.

Range10 to 100000
Unitsmilliseconds
Default100
Introduced 16.0.R1

Platforms

All

transmit-interval number
Synopsis BFD transmit interval over this interface
Contextconfigure router string interface string ipv4 bfd transmit-interval number
Treetransmit-interval

Description

This command configures the transmit intervals.

On the 7750 SR, this command can only be configured to a value less than 100 when the type command is configured to cpm-np.

Range10 to 100000
Unitsmilliseconds
Default100
Introduced 16.0.R1

Platforms

All

type keyword
Synopsis Local termination point for the BFD session
Contextconfigure router string interface string ipv4 bfd type keyword
Treetype

Description

This command sets the local termination point for the BFD session to allow for fast timers down to 10 ms granularity.

The options to specify where the BFD session runs are:

  • auto (default) – the system chooses and uses the line card CPU only for single-hop BFD sessions with timer intervals equal to or greater than 100ms. All others are placed on the cpm-np.

  • cpm-np – BFD session runs on the FP complex associated with the CPM. This is either the FP on the CPM or the one elected on smaller systems. 

  • fp – BFD session runs on the line card CPU. This option can only be used for single-hop BFD sessions with timers equal to or greater than 100ms.  

Optionscpm-np, auto, fp
Defaultauto
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

dhcp
Synopsis Enter the dhcp context
Context configure router string interface string ipv4 dhcp
Treedhcp
Introduced16.0.R1

Platforms

All

gi-address string
Synopsis GI address for the DHCP relay
Context configure router string interface string ipv4 dhcp gi-address string
Treegi-address

Description

This command configures the GI address to distinguish between the different subscriber interfaces (and potentially group interfaces) defined when the router functions as a DHCP relay.

By default, the GI address used in the relayed DHCP packet is the primary IP address of a normal IES interface. Specifying the GI address allows the user to choose a secondary address. For group interfaces, a GI address must be specified under the group interface DHCP context or subscriber interface DHCP context for DHCP to function.

Introduced16.0.R1

Platforms

All

option-82
Synopsis Enter the option-82 context
Context configure router string interface string ipv4 dhcp option-82
Treeoption-82

Description

Commands in this context configure the processing required when the router receives a DHCP request that already has an Option 82 field in the packet.

Introduced16.0.R1

Platforms

All

action keyword
Synopsis Action to take with received DHCP Option 82
Contextconfigure router string interface string ipv4 dhcp option-82 action keyword
Treeaction
Optionsreplace, drop, keep
Defaultkeep
Introduced16.0.R1

Platforms

All

circuit-id
Synopsis Enter the circuit-id context
Context configure router string interface string ipv4 dhcp option-82 circuit-id
Treecircuit-id
Introduced16.0.R1

Platforms

All

ascii-tuple
Synopsis Use the ASCII-encoded tuple for the circuit ID
Contextconfigure router string interface string ipv4 dhcp option-82 circuit-id ascii-tuple
Treeascii-tuple

Notes

The following elements are part of a choice: ascii-tuple, if-name, ifindex, none, port-id, or vlan-ascii-tuple.

Introduced16.0.R1

Platforms

All

if-name
Synopsis Use the interface name for the circuit ID
Contextconfigure router string interface string ipv4 dhcp option-82 circuit-id if-name
Treeif-name

Notes

The following elements are part of a choice: ascii-tuple, if-name, ifindex, none, port-id, or vlan-ascii-tuple.

Introduced16.0.R1

Platforms

All

ifindex
Synopsis Use the interface index for the circuit ID
Contextconfigure router string interface string ipv4 dhcp option-82 circuit-id ifindex
Treeifindex

Notes

The following elements are part of a choice: ascii-tuple, if-name, ifindex, none, port-id, or vlan-ascii-tuple.

Introduced16.0.R1

Platforms

All

none
Synopsis Do not include the circuit ID
Context configure router string interface string ipv4 dhcp option-82 circuit-id none
Treenone

Notes

The following elements are part of a choice: ascii-tuple, if-name, ifindex, none, port-id, or vlan-ascii-tuple.

Introduced16.0.R1

Platforms

All

port-id
Synopsis Use the port ID for the circuit ID
Context configure router string interface string ipv4 dhcp option-82 circuit-id port-id
Treeport-id

Notes

The following elements are part of a choice: ascii-tuple, if-name, ifindex, none, port-id, or vlan-ascii-tuple.

Introduced16.0.R1

Platforms

All

vlan-ascii-tuple
Synopsis Include the VLAN ID and dot1p bits in the ASCII tuple
Contextconfigure router string interface string ipv4 dhcp option-82 circuit-id vlan-ascii-tuple
Treevlan-ascii-tuple

Description

When configured, the router includes the VLAN ID and dot1p bits with the ASCII-tuple information. This only occurs on dot1q and QinQ-encapsulated ports. When the Option 82 bits are stripped, dot1p bits are copied to the Ethernet header of the outgoing packet.

When unconfigured, the router leaves the circuit ID sub-option of the DHCP packet empty.

Notes

The following elements are part of a choice: ascii-tuple, if-name, ifindex, none, port-id, or vlan-ascii-tuple.

Introduced16.0.R1

Platforms

All

remote-id
Synopsis Enter the remote-id context
Context configure router string interface string ipv4 dhcp option-82 remote-id
Treeremote-id

Description

Commands in this context configure the remote IP sub-option of the DHCP packet with the identity of the remote host end (typically the DHCP client).

Introduced16.0.R1

Platforms

All

mac
Synopsis Use the MAC address for the remote ID
Contextconfigure router string interface string ipv4 dhcp option-82 remote-id mac
Treemac

Notes

The following elements are part of a choice: ascii-string, mac, or none.

Introduced16.0.R1

Platforms

All

vendor-specific-option
Synopsis Enter the vendor-specific-option context
Contextconfigure router string interface string ipv4 dhcp option-82 vendor-specific-option
Treevendor-specific-option

Description

Commands in this context configure the Nokia Vendor-Specific Option (VSO) of the DHCP packet.

Introduced16.0.R1

Platforms

All

relay-plain-bootp boolean
Synopsis Relay plain BOOTP messages
Context configure router string interface string ipv4 dhcp relay-plain-bootp boolean
Treerelay-plain-bootp

Description

When configured to true, the system relays plain BOOTP messages.

When configured to false, the system considers the plain BOOTP packets as malformed DHCP packets; therefore, the system does not relay the messages.

Defaultfalse
Introduced16.0.R1

Platforms

All

server string
Synopsis IP addresses for DHCP server requests
Contextconfigure router string interface string ipv4 dhcp server string
Treeserver

Description

This command configures a list of servers that this interface forwards requests to.

The operator can enter the list of servers as either IP addresses or fully qualified domain names. The operator must specify at least one server specified for DHCP relay to work. If there are multiple servers, the system forwards the request to all the servers in the list.

Max. Instances8

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

src-ip-addr keyword
Synopsis Type of source address to use for DHCP relay
Contextconfigure router string interface string ipv4 dhcp src-ip-addr keyword
Treesrc-ip-addr
Optionsauto, gi-address
Default auto
Introduced16.0.R1

Platforms

All

trusted boolean
Synopsis Relay untrusted packets
Context configure router string interface string ipv4 dhcp trusted boolean
Treetrusted

Description

When configured to true, the router enables the trusted mode on the interface. When enabled, the relay agent changes the existing GI address (of the request) to the ingress interface, and forwards the request.

A DHCP request that contains a GI address of 0.0.0.0 and an Option 82 field in the packet is discarded unless it arrives on a trusted circuit.

This behavior only applies if the Relay Agent Information Option action is to keep the existing information. When the Option 82 field is replaced by the relay agent, the original Option 82 information is lost, and there is no reason to enable the trusted option.

Defaultfalse
Introduced16.0.R1

Platforms

All

icmp
Synopsis Enter the icmp context
Context configure router string interface string ipv4 icmp
Treeicmp

Description

Commands in this context configure Internet Control Message Protocol (ICMP) parameters on a network IP interface.

Introduced16.0.R1

Platforms

All

mask-reply boolean
Synopsis Allow responses to ICMP mask requests on the interface
Contextconfigure router string interface string ipv4 icmp mask-reply boolean
Treemask-reply
Defaulttrue
Introduced16.0.R1

Platforms

All

param-problem
Synopsis Enter the param-problem context
Contextconfigure router string interface string ipv4 icmp param-problem
Treeparam-problem

Description

Commands in this context specify the settings for ICMP Parameter Problem messages generated by the interface.

Introduced16.0.R1

Platforms

All

redirects
Synopsis Enter the redirects context
Context configure router string interface string ipv4 icmp redirects
Treeredirects

Description

Commands in this context configure the settings for ICMP redirect messages generated by the interface.

The system sends ICMP redirect messages to alert the sending node that a more optimal route is available on another router on the same subnetwork.

Introduced16.0.R1

Platforms

All

number number
Synopsis Maximum number of ICMP redirect messages to send
Contextconfigure router string interface string ipv4 icmp redirects number number
Treenumber
Range10 to 1000
Default100
Introduced 16.0.R1

Platforms

All

seconds number
Synopsis Time used to limit the number of ICMP redirect messages
Contextconfigure router string interface string ipv4 icmp redirects seconds number
Treeseconds
Range1 to 60
Unitsseconds
Default 10
Introduced16.0.R1

Platforms

All

ttl-expired
Synopsis Enter the ttl-expired context
Context configure router string interface string ipv4 icmp ttl-expired
Treettl-expired

Description

Commands in this context configure the settings for ICMP TTL expired messages generated by the interface.

Introduced16.0.R1

Platforms

All

seconds number
Synopsis Time used to limit the number of TTL expired messages
Contextconfigure router string interface string ipv4 icmp ttl-expired seconds number
Treeseconds
Range1 to 60
Unitsseconds
Default 10
Introduced16.0.R1

Platforms

All

unreachables
Synopsis Enter the unreachables context
Contextconfigure router string interface string ipv4 icmp unreachables
Treeunreachables

Description

Commands in this context specify the settings for ICMP host and network destination unreachable messages generated by the interface.

Introduced16.0.R1

Platforms

All

ip-helper-address string
Synopsis IP address of the target UDP broadcast gateway
Contextconfigure router string interface string ipv4 ip-helper-address string
Treeip-helper-address

Description

This command configures the redirection of broadcast UDP packets received on the associated interface to the specified helper gateway address, and then to the gateway.

Introduced16.0.R1

Platforms

All

neighbor-discovery
Synopsis Enter the neighbor-discovery context
Contextconfigure router string interface string ipv4 neighbor-discovery
Treeneighbor-discovery
Introduced16.0.R1

Platforms

All

learn-unsolicited boolean
Synopsis Learn new entries from any received NA message
Contextconfigure router string interface string ipv4 neighbor-discovery learn-unsolicited boolean
Treelearn-unsolicited

Description

When configured to true, the router can learn neighbor entries from received unsolicited Neighbor Advertisement (NA) messages, with or without the solicited (S) flag set. The command can be enabled for global addresses, link-local addresses, or for both.

When configured to false, the router follows standard behavior for learning neighbor entries.

  • If an unsolicited NA (regardless of the S flag) is received from a neighbor that is not yet in the Neighbor Discovery (ND) cache, the NA is ignored.

  • If an NS, RS, RA, or Redirect message with a Link Layer Address (MAC) is received from a neighbor that is not yet in the ND cache, a new neighbor entry is created in the cache to store the received Link Layer MAC. The neighbor is put in the STALE state.

Defaultfalse
Introduced16.0.R1

Platforms

All

limit
Synopsis Enter the limit context
Context configure router string interface string ipv4 neighbor-discovery limit
Treelimit

Description

Commands in this context configure the maximum number of dynamic neighbor entries that can be learned on the interface

When the number of entries reaches the threshold (the configured percentage) of this limit, the system sends an SNMP trap.

When the limit is exceeded, the system learns no new entries until an entry expires and traffic to these destinations is dropped. Already learned entries are refreshed.

Introduced16.0.R1

Platforms

All

local-proxy-arp boolean
Synopsis Enable local proxy ARP on interface
Context configure router string interface string ipv4 neighbor-discovery local-proxy-arp boolean
Treelocal-proxy-arp

Description

When configured to true, the router enables local proxy ARP on the interface.

When configured to false, the router does not respond to ARP requests for addresses on the same subnet.

Introduced16.0.R1

Platforms

All

proactive-refresh boolean
Synopsis Send a single refresh message before entry timeout
Contextconfigure router string interface string ipv4 neighbor-discovery proactive-refresh boolean
Treeproactive-refresh

Description

When configured to true, the router always sends a refresh message 30 seconds before the timeout of the entry (a single refresh message with no retries).

When configured to false, the router marks an entry as stale 30 seconds before age-out, and the router only sends an ARP request to refresh the entry if the IOM receives traffic that uses it. Then, the IOM asks the ARP application to send a refresh message. With ARP proactive refresh enabled, the ARP module sends a refresh message regardless of the IOM receiving traffic.

Defaultfalse
Introduced16.0.R1

Platforms

All

static-neighbor [ipv4-address] string
Synopsis Enter the static-neighbor list instance
Contextconfigure router string interface string ipv4 neighbor-discovery static-neighbor string
Treestatic-neighbor

Description

Commands in this context configure a static ARP entry that associates an IP address with a MAC address for the core router instance.

Introduced16.0.R1

Platforms

All

static-neighbor-unnumbered
Synopsis Enable the static-neighbor-unnumbered context
Contextconfigure router string interface string ipv4 neighbor-discovery static-neighbor-unnumbered
Treestatic-neighbor-unnumbered

Description

Commands in this context configure the static ARP MAC for an unnumbered interface. This entry overrides the dynamic ARP entry on the unnumbered interface.

Introduced16.0.R1

Platforms

All

timeout number
Synopsis Timeout for an ARP entry learned on the interface
Contextconfigure router string interface string ipv4 neighbor-discovery timeout number
Treetimeout

Description

This command configures the minimum time an ARP entry learned on the IP interface is stored in the ARP table. ARP entries are automatically refreshed when an ARP request or gratuitous ARP is seen by an IP host. Otherwise, the ARP entry is aged from the ARP table.

Range0 to 65535
Unitsseconds
Default 14400
Introduced16.0.R1

Platforms

All

primary
Synopsis Enable the primary context
Context configure router string interface string ipv4 primary
Treeprimary
Introduced16.0.R1

Platforms

All

address string
Synopsis Primary IPv4 address assigned to the interface
Contextconfigure router string interface string ipv4 primary address string
Treeaddress

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

broadcast keyword
Synopsis Broadcast address format
Context configure router string interface string ipv4 primary broadcast keyword
Treebroadcast

Description

This command overrides the default broadcast address that the IP interface uses when sourcing IP broadcasts.

This command does not affect the type of broadcasts the IP interface can receive. The IP interface can receive either the local broadcast or the valid subnet broadcast address sent by a host.

Optionsall-ones, host-ones
Default host-ones
Introduced16.0.R1

Platforms

All

gre-termination boolean
Synopsis Enable GRE termination
Context configure router string interface string ipv4 primary gre-termination boolean
Treegre-termination

Description

When configured to true, the router terminates MPLS-over-GRE and IP-over-GRE packets for destination IP addresses from a user-defined subnet. The user defines a subnet for the termination of GRE packets by executing this command on a numbered network IP interface or a loopback interface.

Defaultfalse
Introduced19.10.R1

Platforms

VSR

qos-route-lookup keyword
Synopsis IP address for QoS route lookup for ingress IP packets
Contextconfigure router string interface string ipv4 qos-route-lookup keyword
Treeqos-route-lookup

Description

This command specifies the IP address type used for QPPB enabled per-packet QoS handling (in terms of FC and priority). When using QPPB, routes are associated with a QoS treatment (FC and optionally priority) through either explicit configuration or the route policy. If an IPv4 or IPv6 packet arrives on an interface where the configuration of this command applies to the packet, the QoS treatment of the packet is based on the route that matched the destination IP address or the route that matched the source IP address.

See "Enabling QPPB on an IP interface" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Router Configuration Guide for more information about QPPB.

Optionsdestination, source, source-and-dest
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

secondary [address] string
Synopsis Enter the secondary list instance
Contextconfigure router string interface string ipv4 secondary string
Treesecondary
Introduced16.0.R1

Platforms

All

[address] string
Synopsis Secondary IPv4 address assigned to the interface
Contextconfigure router string interface string ipv4 secondary string
Treesecondary

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

broadcast keyword
Synopsis Broadcast address format
Context configure router string interface string ipv4 secondary string broadcast keyword
Treebroadcast

Description

This command overrides the default broadcast address that the IP interface uses when sourcing IP broadcasts.

This command does not affect the type of broadcasts the IP interface can receive. The IP interface can receive either the local broadcast or the valid subnet broadcast address sent by a host.

Optionsall-ones, host-ones
Default host-ones
Introduced16.0.R1

Platforms

All

igp-inhibit boolean
Synopsis Disable the running IGP from recognizing secondary IP
Contextconfigure router string interface string ipv4 secondary string igp-inhibit boolean
Treeigp-inhibit

Description

When configured to true, the running IGP does not recognize the secondary IP address as a local interface.

Defaultfalse
Introduced16.0.R1

Platforms

All

tcp-mss number
Synopsis TCP maximum segment size for the interface
Contextconfigure router string interface string ipv4 tcp-mss number
Treetcp-mss
Range384 to 9746
Introduced16.0.R1

Platforms

All

unnumbered
Synopsis Enter the unnumbered context
Context configure router string interface string ipv4 unnumbered
Treeunnumbered

Description

Commands in this context configure an IP interface as an unnumbered interface and specify the IP address to use for the interface. An operator can configure unnumbered interfaces to conserve IP addresses.

Introduced16.0.R1

Platforms

All

ip-address string
Synopsis IP address to associate with unnumbered IP interface
Contextconfigure router string interface string ipv4 unnumbered ip-address string
Treeip-address

Notes

The following elements are part of a choice: ip-address, ip-int-name, or system.

Introduced16.0.R1

Platforms

All

ip-int-name string
Synopsis Unnumbered IP interface name
Context configure router string interface string ipv4 unnumbered ip-int-name string
Treeip-int-name
String Length1 to 32

Notes

The following elements are part of a choice: ip-address, ip-int-name, or system.

Introduced16.0.R1

Platforms

All

system
Synopsis Use system IP address for the unnumbered IP interface
Contextconfigure router string interface string ipv4 unnumbered system
Treesystem

Notes

The following elements are part of a choice: ip-address, ip-int-name, or system.

Introduced16.0.R1

Platforms

All

urpf-check
Synopsis Enable the urpf-check context
Context configure router string interface string ipv4 urpf-check
Treeurpf-check
Introduced16.0.R1

Platforms

All

ignore-default boolean
Synopsis Ignore default routes when performing a uRPF check
Contextconfigure router string interface string ipv4 urpf-check ignore-default boolean
Treeignore-default

Description

When configured to true, the router ignores default routes while performing a uRPF check to determine the validity of incoming packets.

When configured to false, default routes are considered eligible.

Defaultfalse
Introduced16.0.R1

Platforms

All

mode keyword
Synopsis Unicast RPF check mode
Context configure router string interface string ipv4 urpf-check mode keyword
Treemode
Optionsstrict, loose, strict-no-ecmp
Defaultstrict
Introduced16.0.R1

Platforms

All

vrrp [virtual-router-id] number
Synopsis Enter the vrrp list instance
Context configure router string interface string ipv4 vrrp number
Treevrrp

Description

Commands in this context configure a VRRP virtual router instance. A virtual router is defined by its Virtual Router Identifier (VRID) and a set of IP addresses.

Introduced16.0.R1

Platforms

All

[virtual-router-id] number
Synopsis Virtual Router Identifier (VRID) for the IP interface
Contextconfigure router string interface string ipv4 vrrp number
Treevrrp
Range1 to 255

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of VRRP
Context configure router string interface string ipv4 vrrp number admin-state keyword
Treeadmin-state

Description

The command determines the administrative state of non-owner virtual router instances.

Non-owner virtual router instances can be administratively disabled. This allows the termination of VRRP participation in the virtual router and stops all routing and other access capabilities with regards to the virtual router IP addresses. Disabling the virtual router instance provides a mechanism to maintain the virtual routers without causing false backup or master state changes.

When disabled, no VRRP advertisement messages are generated and all received VRRP advertisement messages are silently discarded with no processing.

Whenever the administrative or operational state of a virtual router instance transitions, a log message is generated.

An owner virtual router context does not use this command. To administratively disable an owner virtual router instance, use the admin-state command within the parent IP interface node which administratively disables the IP interface.

Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis Password for simple text authentication
Contextconfigure router string interface string ipv4 vrrp number authentication-key string
Treeauthentication-key

Description

This command optionally assigns a simple text password authentication key to generate master VRRP advertisement messages and validate received VRRP advertisement messages.

If this command is re-executed with a different password key defined, the new key immediately replaces the old key. This command may be executed at any time. 

String Length1 to 38
Introduced16.0.R1

Platforms

All

backup string
Synopsis Virtual router IP addresses for the interface
Contextconfigure router string interface string ipv4 vrrp number backup string
Treebackup

Description

This command associates virtual router IP addresses with those of the parental IP interface.

This command has two different functions based on whether it is being executed on an owner or non-owner virtual router instance.

Non-owner virtual router instances create a routable IP interface address that is operationally dependent on the virtual router instance mode (master or backup). This command, when executed on an owner virtual router instance, does not create a routable IP interface address; it simply defines the existing IP addresses of the parental IP interface that are advertised by the virtual router instance.

For owner virtual router instances, this command defines the IP addresses that are advertised within VRRP advertisement messages. This communicates the IP addresses that the master is advertising to backup virtual routers receiving the messages. The specified unicast-ipv4-address must be equal to one of the existing IP addresses in the parental IP interface (primary or secondary) or this command fails.

See "Owner and non-owner VRRP" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Router Configuration Guide for more information about owner and non-owner virtual router instances.

Max. Instances16
Introduced16.0.R1

Platforms

All

bfd-liveness
Synopsis Enable the bfd-liveness context
Contextconfigure router string interface string ipv4 vrrp number bfd-liveness
Treebfd-liveness

Description

Commands in this context assign a Bidirectional Forwarding Detection (BFD) session to a specific VRRP or SRRP instance. This BFD session provides a heartbeat mechanism that speeds up the transition of the standby VRRP router to an active state. If the associated BFD session fails, the VRRP routers immediately send a VRRP advertisement message. In addition, the standby VRRP routers transition to a master state to speed up convergence.

The VRRP election process takes place based on the advertisement messages sent by all VRRP routers.

Only one BFD session can be assigned to any VRRP or SRRP instance, but multiple SRRP or VRRP sessions can use the same BFD session.

Introduced16.0.R1

Platforms

All

dest-ip string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisDestination IP address to use for BFD session
Contextconfigure router string interface string ipv4 vrrp number bfd-liveness dest-ip string
Treedest-ip

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

interface-name string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisName of the interface running BFD
Contextconfigure router string interface string ipv4 vrrp number bfd-liveness interface-name string
Treeinterface-name
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

service-name string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAdministrative service name
Contextconfigure router string interface string ipv4 vrrp number bfd-liveness service-name string
Treeservice-name
String Length1 to 64
Introduced16.0.R1

Platforms

All

init-delay number
Synopsis VRRP initialization delay timer
Context configure router string interface string ipv4 vrrp number init-delay number
Treeinit-delay
Range1 to 65535
Unitsseconds
Introduced 16.0.R1

Platforms

All

mac string
Synopsis Virtual MAC address to use in ARP responses
Contextconfigure router string interface string ipv4 vrrp number mac string
Treemac

Description

This command sets an explicit MAC address for the virtual router instance that overrides the VRRP default derived from the VRID.

Changing the default MAC address is useful when an existing HSRP or other non-VRRP default MAC is in use by the IP hosts that use the virtual router IP address. Many hosts do not monitor unessential ARPs and continue to use the cached non-VRRP MAC address after the virtual router becomes master of the host’s gateway address.

Additionally, this command sets the MAC address used in ARP responses when the virtual router instance is master. Routing of IP packets with unicast-mac-address as the destination MAC is also enabled. The MAC must be the same for all virtual routers participating as a virtual router or indeterminate connectivity by the attached IP hosts results. All VRRP advertisement messages are transmitted with unicast-mac-address as the source MAC.

An operator can execute this command at any time and it takes effect immediately. When the virtual router MAC on a master virtual router instance changes, a gratuitous ARP is immediately sent with a VRRP advertisement message. If the virtual router instance is disabled or operating as a backup, the gratuitous ARP and VRRP advertisement messages are not sent.

Introduced16.0.R1

Platforms

All

master-int-inherit boolean
Synopsis Allow master instance to dictate the master down timer
Contextconfigure router string interface string ipv4 vrrp number master-int-inherit boolean
Treemaster-int-inherit

Description

When configured to true, the virtual router instance inherits the advertisement interval timer of the master VRRP router, which backup routers use to calculate the master down timer.

When configured to false, the locally configured message interval must match the master's VRRP advertisement message advertisement interval field value or the message is discarded.

Introduced16.0.R1

Platforms

All

message-interval number
Synopsis Interval for sending VRRP advertisement messages
Contextconfigure router string interface string ipv4 vrrp number message-interval number
Treemessage-interval

Description

This command configures the administrative advertisement message timer used by the master virtual router instance to send VRRP advertisement messages. The backup master down timer is derived from the value configured using this command.

The usage of this command varies for non-owner virtual router instances, depending on the state of the virtual router (master or backup) and the state of the master-int-inherit command:

  • When a non-owner is operating as master for the virtual router, the system uses the configured value of this command as the operational advertisement timer, similar to an owner virtual router instance. The master-int-inherit command has no effect when operating as master.

  • When a non-owner is in the backup state with master-int-inherit disabled, the system uses the configured value of this command to match the incoming advertisement interval field of the VRRP advertisement message. If the locally configured message interval does not match the advertisement interval field, the system discards the VRRP advertisement.

  • When a non-owner is in the backup state with master-int-inherit enabled, the configured value of this command is ignored. The master down timer is indirectly derived from the advertisement interval field value of the incoming VRRP advertisement message.

Range1 to 2559
Unitsdeciseconds
Default 10
Introduced16.0.R1

Platforms

All

monitor-oper-group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisVRRP instance to follow a specified operational group
Contextconfigure router string interface string ipv4 vrrp number monitor-oper-group reference
Treemonitor-oper-group

Description

This command configures VRRP to associate with an operational group. When associated, VRRP notifies the operational group of its state changes so that other protocols can monitor it to provide a redundancy mechanism. When VRRP is the master router, the operational group is up and the operational group is down for all other VRRP states.

Reference

configure service oper-group string

Introduced22.2.R1

Platforms

All

ntp-reply boolean
Synopsis Allow processing of NTP requests
Context configure router string interface string ipv4 vrrp number ntp-reply boolean
Treentp-reply

Description

When configured to true, the router redirects NTP requests to the VRRP virtual IP address. This behavior only applies to the router acting as the master VRRP router.

When configured to false, the router does not process NTP requests.

Defaultfalse
Introduced20.2.R1

Platforms

All

oper-group reference
Synopsis Operational group name associated with the VRRP
Contextconfigure router string interface string ipv4 vrrp number oper-group reference
Treeoper-group

Description

This command configures an operational group to associate with the VRRP. When associated, VRRP notifies the operational group of its state changes so that other protocols can monitor it to provide a redundancy mechanism. When VRRP is the master router (MR), the operational group is up. The operational group is down for all other VRRP states.

Reference

configure service oper-group string

Introduced16.0.R1

Platforms

All

owner boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisDesignate the virtual router instance as owner
Contextconfigure router string interface string ipv4 vrrp number owner boolean
Treeowner

Description

When configured to true, the router designates this virtual router instance as the owner of the virtual router IP addresses. Therefore, this virtual router becomes responsible for forwarding packets sent to the virtual router IP addresses. The owner also assumes the role of master virtual router.

When configured to false, this virtual router instance is designated as a non-owner.

Defaultfalse
Introduced16.0.R1

Platforms

All

passive boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisSuppress the processing of VRRP advertisement messages
Contextconfigure router string interface string ipv4 vrrp number passive boolean
Treepassive

Description

When configured to true, the router identifies this virtual router instance as passive; and therefore the owner of the virtual router IP addresses. A passive virtual router instance does not transmit or receive VRRP advertisement messages and is always in either the master state (if the interface is operationally up) or the init state (if the interface is operationally down).

When configured to false, this virtual router instance is not identified as passive, meaning that it transmits and receives VRRP advertisement messages. 

Defaultfalse
Introduced16.0.R1

Platforms

All

ping-reply boolean
Synopsis Allow non-owner master to reply to ICMP echo requests
Contextconfigure router string interface string ipv4 vrrp number ping-reply boolean
Treeping-reply

Description

When configured to true, the router allows the non-owner master to reply to ICMP echo requests directed at the IP addresses of the virtual router instance. Any routed interface can receive the ping request. Ping must not have been disabled at the management security level (either on the parental IP interface or on the Ping source host address).

When configured to false, ICMP echo requests sent to non-owner master virtual IP addresses are silently discarded.

Non-owner backup virtual routers never respond to ICMP echo requests, regardless of the configuration of this command.

Defaultfalse
Introduced16.0.R1

Platforms

All

policy reference
Synopsis VRRP priority control policy
Context configure router string interface string ipv4 vrrp number policy reference
Treepolicy

Description

This command configures a VRRP priority control policy to associate with the virtual router instance.

VRRP priority control policies can override or adjust the base priority value of the virtual router instance, depending on events or conditions within the chassis.

An operator can associate a policy with more than one virtual router instance. The priority events within the policy either override or diminish the base priority set with the priority command. As priority events clear in the policy, the in-use priority can eventually be restored to the base priority value.

For non-owner virtual router instances, if this command is not executed, the base priority is used as the in-use priority.

Reference

configure vrrp policy number

Introduced16.0.R1

Platforms

All

preempt boolean
Synopsis Allow the VRRP to override an existing non-owner master
Contextconfigure router string interface string ipv4 vrrp number preempt boolean
Treepreempt

Description

When configured to true, this virtual router instance overrides any non-owner master with an in-use message priority value less than the in-use priority value of this virtual router.

When configured to false, this virtual router only becomes master if the master down timer expires before a VRRP advertisement message is received from another virtual router.

Defaulttrue
Introduced16.0.R1

Platforms

All

priority number
Synopsis Base priority for the VRRP
Context configure router string interface string ipv4 vrrp number priority number
Treepriority

Description

This command configures the base router priority for the virtual router instance, which defines the selection order of the virtual router in the master election process.

The in-use priority is derived from the base priority. However, the in-use priority is modified by optional VRRP priority control policies. An operator can use VRRP priority control policies to either override or adjust the base priority value depending on events or conditions within the chassis.

Range1 to 255
Introduced16.0.R1

Platforms

All

ssh-reply boolean
Synopsis Allow the non-owner master to reply to SSH requests
Contextconfigure router string interface string ipv4 vrrp number ssh-reply boolean
Treessh-reply

Description

When configured to true, the router allows the non-owner master to reply to SSH requests directed at the IP addresses of the virtual router instance. Any routed interface can receive the SSH request. SSH cannot be disabled at the management security level (either on the parental IP interface or on the SSH source host address).

When configure to false, SSH requests to non-owner master virtual IP addresses are silently discarded.

Defaultfalse
Introduced16.0.R1

Platforms

All

standby-forwarding boolean
Synopsis Allow standby router to forward traffic
Contextconfigure router string interface string ipv4 vrrp number standby-forwarding boolean
Treestandby-forwarding

Description

When configured to true, the standby router forwards all traffic.

When configured to false, the standby router cannot forward traffic sent to the MAC address of the virtual router. However, the standby router still forwards traffic sent to its own MAC address.

Defaultfalse
Introduced16.0.R1

Platforms

All

telnet-reply boolean
Synopsis Allow non-owner master to reply to Telnet requests
Contextconfigure router string interface string ipv4 vrrp number telnet-reply boolean
Treetelnet-reply

Description

When configured to true, the router allows the non-owner master to reply to Telnet requests directed at the IP addresses of the virtual router instance. Any routed interface can receive Telnet requests. Telnet cannot be disabled at the management security level (either on the parental IP interface or on the Telnet source host address).

When configured to false, the router silently discards Telnet requests sent to non-owner master virtual IP addresses.

Defaultfalse
Introduced16.0.R1

Platforms

All

traceroute-reply boolean
Synopsis Allow non-owner master to reply to traceroute requests
Contextconfigure router string interface string ipv4 vrrp number traceroute-reply boolean
Treetraceroute-reply

Description

When configured to true, the router allows a non-owner master to reply to traceroute requests directed to the IP addresses of the virtual router instance.

When configured to false, the router silently discards traceroute requests sent to non-owner master virtual IP addresses.

Traceroute must not have been disabled at the management security level (either on the parental IP interface or the source host address).

Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enable the ipv6 context
Context configure router string interface string ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

address [ipv6-address] string
Synopsis Enter the address list instance
Contextconfigure router string interface string ipv6 address string
Treeaddress
Introduced16.0.R1

Platforms

All

[ipv6-address] string
Synopsis IPv6 address assigned to the interface
Contextconfigure router string interface string ipv6 address string
Treeaddress

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

duplicate-address-detection boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisEnable Duplicate Address Detection
Contextconfigure router string interface string ipv6 address string duplicate-address-detection boolean
Treeduplicate-address-detection

Description

When configured to true, the router enables Duplicate Address Detection (DAD).

When configured to false, the router disables DAD and sets the address to preferred, even if there is a duplicated address.

Defaulttrue
Introduced16.0.R1

Platforms

All

eui-64 boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisForm IPv6 address from prefix and 64-bit interface ID
Contextconfigure router string interface string ipv6 address string eui-64 boolean
Treeeui-64

Description

When configured to true, the router forms a complete IPv6 address from the supplied prefix and 64-bit interface identifier. The 64-bit interface identifier is derived from the MAC address on Ethernet interfaces. For interfaces without a MAC address, for example POS interfaces, use the base MAC address of the chassis.

Defaultfalse
Introduced16.0.R1

Platforms

All

primary-preference number
Synopsis Index assigned to the IPv6 address of the interface
Contextconfigure router string interface string ipv6 address string primary-preference number
Treeprimary-preference

Description

This command assigns a primary preference index to an IPv6 address of the interface to enforce the order in which the address is used by control plane protocols and applications that require a fixed address of the interface, such as LDP and Segment Routing. In cases where a fixed address is required when originating packets from the interface, the IPv6 address with the lowest primary preference index is selected. If the selected address is removed, the next IPv6 address with the next lowest primary preference index is selected.

If this index is not specified for the IPv6 address, the system assigns the next available index value to the address. The address index space is unique across all addresses of a given interface.

Range1 to 4294967295
Introduced16.0.R1

Platforms

All

track-srrp number
Synopsis SRRP ID whose state is tracked on this IP address
Contextconfigure router string interface string ipv6 address string track-srrp number
Treetrack-srrp
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

bfd
Synopsis Enter the bfd context
Context configure router string interface string ipv6 bfd
Treebfd
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BFD sessions
Context configure router string interface string ipv6 bfd admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

echo-receive number
Synopsis Minimum echo interval over this interface
Contextconfigure router string interface string ipv6 bfd echo-receive number
Treeecho-receive
Range100 to 100000
Unitsmilliseconds
Introduced16.0.R1

Platforms

All

multiplier number
Synopsis Number of consecutive BFD messages missed from the peer
Contextconfigure router string interface string ipv6 bfd multiplier number
Treemultiplier

Description

This command configures the number of missed messages before the BFD session state is changed to down and the upper-level protocol is notified of the fault. A multiplier of less than 3 should not be used in production environments. 

Range1 to 20
Default3
Introduced 16.0.R1

Platforms

All

receive number
Synopsis BFD receive interval over this interface
Contextconfigure router string interface string ipv6 bfd receive number
Treereceive

Description

This command specifies the receive interval for the BFD session.

On the 7750 SR, this command can only be configured to a value less than 100 when the type command is configured to cpm-np.

Range10 to 100000
Unitsmilliseconds
Default100
Introduced 16.0.R1

Platforms

All

transmit-interval number
Synopsis BFD transmit interval over this interface
Contextconfigure router string interface string ipv6 bfd transmit-interval number
Treetransmit-interval

Description

This command configures the transmit intervals.

On the 7750 SR, this command can only be configured to a value less than 100 when the type command is configured to cpm-np.

Range10 to 100000
Unitsmilliseconds
Default100
Introduced 16.0.R1

Platforms

All

type keyword
Synopsis Local termination point for the BFD session
Contextconfigure router string interface string ipv6 bfd type keyword
Treetype

Description

This command sets the local termination point for the BFD session to allow for fast timers down to 10 ms granularity.

The options to specify where the BFD session runs are:

  • auto (default) – the system chooses and uses the line card CPU only for single-hop BFD sessions with timer intervals equal to or greater than 100ms. All others are placed on the cpm-np.

  • cpm-np – BFD session runs on the FP complex associated with the CPM. This is either the FP on the CPM or the one elected on smaller systems. 

  • fp – BFD session runs on the line card CPU. This option can only be used for single-hop BFD sessions with timers equal to or greater than 100ms.  

Optionscpm-np, auto, fp
Defaultauto
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

duplicate-address-detection boolean
Synopsis Enable Duplicate Address Detection
Context configure router string interface string ipv6 duplicate-address-detection boolean
Treeduplicate-address-detection

Description

When configured to true, the router enables Duplicate Address Detection (DAD) on the interface.

When configured to false, the router disables DAD on a per-interface basis. This prevents the router from performing a DAD check on the interface. All IPv6 addresses on an interface with DAD disabled, immediately enter a preferred state, without checking for uniqueness on the interface. This is useful for interfaces that enter a looped state during troubleshooting and are operationally disabled when the loop is detected, requiring manual intervention to clear the DAD violation.

Defaulttrue
Introduced16.0.R1

Platforms

All

forward-ipv4-packets boolean
Synopsis Forward unencapsulated IPv4 packets
Context configure router string interface string ipv6 forward-ipv4-packets boolean
Treeforward-ipv4-packets

Description

When configured to true, the router can use an IPv6-only interface, with no configured IPv4 addresses, to forward IPv4 packets that originate or terminate locally.

The interface reports that its IPv4 operational state is up if its IPv6 operational state is up. Not all protocols observe the interface as up from an IPv4 perspective. This command mostly supports BGP routing use cases; see RFC 5549 for details.

When configured to false, the router prevents IPv4 packets from being forwarded if there are no configured IPv4 subnets.

Defaultfalse
Introduced19.5.R1

Platforms

All

icmp6
Synopsis Enter the icmp6 context
Context configure router string interface string ipv6 icmp6
Treeicmp6
Introduced16.0.R1

Platforms

All

packet-too-big
Synopsis Enter the packet-too-big context
Contextconfigure router string interface string ipv6 icmp6 packet-too-big
Treepacket-too-big

Description

Commands in this context configure limiting the number of ICMPv6 Packet Too Big messages.

Introduced16.0.R1

Platforms

All

param-problem
Synopsis Enter the param-problem context
Contextconfigure router string interface string ipv6 icmp6 param-problem
Treeparam-problem
Introduced16.0.R1

Platforms

All

redirects
Synopsis Enter the redirects context
Context configure router string interface string ipv6 icmp6 redirects
Treeredirects
Introduced16.0.R1

Platforms

All

number number
Synopsis Number to limit ICMPv6 Redirect messages per time frame
Contextconfigure router string interface string ipv6 icmp6 redirects number number
Treenumber
Range10 to 1000
Default100
Introduced 16.0.R1

Platforms

All

time-exceeded
Synopsis Enter the time-exceeded context
Contextconfigure router string interface string ipv6 icmp6 time-exceeded
Treetime-exceeded
Introduced16.0.R1

Platforms

All

unreachables
Synopsis Enter the unreachables context
Contextconfigure router string interface string ipv6 icmp6 unreachables
Treeunreachables
Introduced16.0.R1

Platforms

All

link-local-address
Synopsis Enter the link-local-address context
Contextconfigure router string interface string ipv6 link-local-address
Treelink-local-address

Description

Commands in this context configure the IPv6 link-local address that is used as a virtual SRRP IPv6 address by the master SRRP node. This address is sent in the Router Advertisements initiated by the master SRRP node. Clients use this address as IPv6 default-gateway. Both SRRP nodes, master and backup, must be configured with the same link-local address.

Only one link-local address is allowed per interface.

Caution: Removing a manually configured link-local address may impact routing protocols or static routes that have a dependency on that address. Nokia does not recommend removing a link-local address when there are active IPv6 subscriber hosts on an IES or VPRN interface.

Introduced16.0.R1

Platforms

All

duplicate-address-detection boolean
Synopsis Enable Duplicate Address Detection
Context configure router string interface string ipv6 link-local-address duplicate-address-detection boolean
Treeduplicate-address-detection

Description

When configured to true, the router enables Duplicate Address Detection (DAD) on the interface.

When configured to false, the router disables DAD and sets the address to preferred, even if there is a duplicated address.

Defaulttrue
Introduced16.0.R1

Platforms

All

local-dhcp-server reference
Synopsis DHCP server for the interface
Context configure router string interface string ipv6 local-dhcp-server reference
Treelocal-dhcp-server

Description

This command instantiates a local DHCP server. A local DHCP server can serve multiple interfaces but is limited to the routing context in which it was created.

Reference

configure router string dhcp-server dhcpv6 string

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

neighbor-discovery
Synopsis Enter the neighbor-discovery context
Contextconfigure router string interface string ipv6 neighbor-discovery
Treeneighbor-discovery
Introduced16.0.R1

Platforms

All

learn-unsolicited keyword
Synopsis Type of entries learned from unsolicited NA messages
Contextconfigure router string interface string ipv6 neighbor-discovery learn-unsolicited keyword
Treelearn-unsolicited

Description

This command enables the ability to learn neighbor entries out of received unsolicited Neighbor Advertisement (NA) messages, with or without the solicited flag set.

When unconfigured, the router follows standard RFC 4861 behavior for learning of neighbor entries. The neighbor is put in the stale state. This is the standard RFC behavior.

Optionsglobal, link-local, both
Introduced16.0.R1

Platforms

All

limit
Synopsis Enter the limit context
Context configure router string interface string ipv6 neighbor-discovery limit
Treelimit

Description

Commands in this context configure the maximum amount of dynamic IPv6 neighbor entries that can be learned on an IP interface.

When the number of dynamic neighbor entries reaches the configured percentage of this limit the system sends an SNMP trap. When the limit is exceeded, no new entries are learned until an entry expires and traffic to these destinations is dropped. Entries that have already been learned are refreshed.

Introduced16.0.R1

Platforms

All

log-only boolean
Synopsis Generate log entries when limit is reached
Contextconfigure router string interface string ipv6 neighbor-discovery limit log-only boolean
Treelog-only

Description

When configured to true, the router sends the warning message at the specified threshold percentage or upon exceeding the specified limit. Entries that exceed the limit are learned.

When configured to false, the router does not send the warning message.

Defaultfalse
Introduced16.0.R1

Platforms

All

max-entries number
Synopsis Maximum number of entries learned on an IP interface
Contextconfigure router string interface string ipv6 neighbor-discovery limit max-entries number
Treemax-entries

Description

This command configures the maximum number of entries that can be learned on an IP interface.

When unconfigured, no maximum limit is imposed.

Range0 to 102400
Introduced16.0.R1

Platforms

All

local-proxy-nd boolean
Synopsis Enable local proxy neighbor discovery on the interface
Contextconfigure router string interface string ipv6 neighbor-discovery local-proxy-nd boolean
Treelocal-proxy-nd

Description

When configured to true, the router enables local proxy neighbor discovery on the interface and replies to neighbor solicitation requests when both the hosts are on the same subnet. In this case, ICMP redirects are disabled.

When configured to false, the router disables local proxy neighbor discovery on the interface and does not reply to neighbor solicitation requests if both the hosts are on the same subnet.

Defaultfalse
Introduced16.0.R1

Platforms

All

proactive-refresh keyword
Synopsis Proactive refresh of neighbor entries
Contextconfigure router string interface string ipv6 neighbor-discovery proactive-refresh keyword
Treeproactive-refresh

Description

This command enables a proactive refresh of the neighbor entries. After the stale timer expires, the router sends an NUD message to the host (regardless of the existence of traffic to the IP address on the IOM), so the entry can be refreshed or removed.

Optionsglobal, link-local, both
Introduced16.0.R1

Platforms

All

secure-nd
Synopsis Enter the secure-nd context
Context configure router string interface string ipv6 neighbor-discovery secure-nd
Treesecure-nd
Introduced16.0.R1

Platforms

All

allow-unsecured-msgs boolean
Synopsis Accept unsecured messages
Context configure router string interface string ipv6 neighbor-discovery secure-nd allow-unsecured-msgs boolean
Treeallow-unsecured-msgs

Description

When configured to true, the router accepts unsecured messages. When Secure Neighbor Discovery (SeND) is enabled, only secure messages are accepted.

When configured to false, the router disables the acceptance of unsecured messages.

Defaulttrue
Introduced16.0.R1

Platforms

All

static-neighbor [ipv6-address] string
Synopsis Enter the static-neighbor list instance
Contextconfigure router string interface string ipv6 neighbor-discovery static-neighbor string
Treestatic-neighbor

Description

Commands in this context configure an IPv6-to-MAC address mapping on the interface. Use this command if a directly attached IPv6 node does not support ICMPv6 neighbor discovery, or for some reason, a static address must be used. This command can only be used on Ethernet media.

The IPv6 address must be on the subnet that was configured from the IPv6 address or a link-local-address commands.

Introduced16.0.R1

Platforms

All

qos-route-lookup keyword
Synopsis IP address for QoS route lookup for ingress IP packets
Contextconfigure router string interface string ipv6 qos-route-lookup keyword
Treeqos-route-lookup

Description

This command specifies the IP address type used for QPPB enabled per-packet QoS handling (in terms of FC and priority). When using QPPB, routes are associated with a QoS treatment (FC and optionally priority) through either explicit configuration or the route policy. If an IPv4 or IPv6 packet arrives on an interface where the configuration of this command applies to the packet, the QoS treatment of the packet is based on the route that matched the destination IP address or the route that matched the source IP address.

See "Enabling QPPB on an IP interface" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Router Configuration Guide for more information about QPPB.

Optionsdestination, source, source-and-dest
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

tcp-mss number
Synopsis TCP maximum segment size for the IPv6 interface
Contextconfigure router string interface string ipv6 tcp-mss number
Treetcp-mss
Range1220 to 9726
Introduced16.0.R1

Platforms

All

urpf-check
Synopsis Enable the urpf-check context
Context configure router string interface string ipv6 urpf-check
Treeurpf-check
Introduced16.0.R1

Platforms

All

mode keyword
Synopsis Unicast RPF check mode
Context configure router string interface string ipv6 urpf-check mode keyword
Treemode
Optionsstrict, loose, strict-no-ecmp
Defaultstrict
Introduced16.0.R1

Platforms

All

vrrp [virtual-router-id] number
Synopsis Enter the vrrp list instance
Context configure router string interface string ipv6 vrrp number
Treevrrp

Description

Commands in this context configure a VRRP virtual router instance. A virtual router is defined by its virtual router identifier (VRID) and a set of IP addresses.

Max. Instances4
Introduced16.0.R1

Platforms

All

[virtual-router-id] number
Synopsis Virtual Router Identifier (VRID) for the IP interface
Contextconfigure router string interface string ipv6 vrrp number
Treevrrp
Range1 to 255

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of VRRP
Context configure router string interface string ipv6 vrrp number admin-state keyword
Treeadmin-state

Description

The command determines the administrative state of non-owner virtual router instances.

Non-owner virtual router instances can be administratively disabled. This allows the termination of VRRP participation in the virtual router and stops all routing and other access capabilities with regards to the virtual router IP addresses. Disabling the virtual router instance provides a mechanism to maintain the virtual routers without causing false backup or master state changes.

When disabled, no VRRP advertisement messages are generated and all received VRRP advertisement messages are silently discarded with no processing.

Whenever the administrative or operational state of a virtual router instance transitions, a log message is generated.

An owner virtual router context does not use this command. To administratively disable an owner virtual router instance, use the admin-state command within the parent IP interface node which administratively disables the IP interface.

Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

backup string
Synopsis Virtual router IP addresses for the interface
Contextconfigure router string interface string ipv6 vrrp number backup string
Treebackup

Description

This command associates router IPv6 virtual router IP addresses with those of the parental IP interface.

This command has two different functions based on whether it is being executed on an owner or non-owner virtual router instance.

Non-owner virtual router instance create a routable IP interface address that is operationally dependent on the virtual router instance mode (master or backup). This command, when executed on an owner virtual router instance, does not create a routable IP interface address; it simply defines the existing IP addresses of the parental IP interface that are advertised by the virtual router instance.

For owner virtual router instances, this command defines the IP addresses that are advertised within VRRP advertisement messages. This communicates the IP addresses that the master is representing to backup virtual routers receiving the messages. The specified IPv6 address must be equal to one of the existing parental IP addresses in the parental IP interface (primary or secondary) or this command fails.

See "Owner and non-owner VRRP" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Router Configuration Guide for more information about owner and non-owner virtual router instances.

Max. Instances10
Introduced16.0.R1

Platforms

All

bfd-liveness
Synopsis Enable the bfd-liveness context
Contextconfigure router string interface string ipv6 vrrp number bfd-liveness
Treebfd-liveness

Description

Commands in this context assign a bidirectional forwarding detect (BFD) session to a specific VRRP or SRRP instance. This BFD session provides a heartbeat mechanism for use in speeding up the transition of the standby VRRP router to an active state. If the associated BFD session fails, the VRRP routers immediately send a VRRP Advertisement message. In addition, the standby VRRP routers transition to a Master state to speed convergence.

The normal VRRP election process takes place based on the Advertisement messages sent by all VRRP routers.

There can be only one BFD session assigned to any specific VRRP or SRRP instance, but there can be multiple SRRP or VRRP sessions using the same BFD session.

Introduced16.0.R1

Platforms

All

dest-ip (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisDestination address for the BFD session
Contextconfigure router string interface string ipv6 vrrp number bfd-liveness dest-ip (ipv4-address-no-zone | ipv6-address-no-zone)
Treedest-ip

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

interface-name string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisName of the interface running BFD
Contextconfigure router string interface string ipv6 vrrp number bfd-liveness interface-name string
Treeinterface-name
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

service-name string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAdministrative service name
Contextconfigure router string interface string ipv6 vrrp number bfd-liveness service-name string
Treeservice-name
String Length1 to 64
Introduced16.0.R1

Platforms

All

init-delay number
Synopsis VRRP initialization delay timer
Context configure router string interface string ipv6 vrrp number init-delay number
Treeinit-delay
Range1 to 65535
Unitsseconds
Introduced 16.0.R1

Platforms

All

mac string
Synopsis Virtual MAC address to use in ARP responses
Contextconfigure router string interface string ipv6 vrrp number mac string
Treemac

Description

This command sets an explicit MAC address for the virtual router instance that overrides the VRRP default derived from the VRID.

Changing the default MAC address is useful when an existing HSRP or other non-VRRP default MAC is in use by the IP hosts that use the virtual router IP address. Many hosts do not monitor unessential ARPs and continue to use the cached non-VRRP MAC address after the virtual router becomes master of the host’s gateway address.

Additionally, this command sets the MAC address used in ARP responses when the virtual router instance is master. Routing of IP packets with unicast-mac-address as the destination MAC is also enabled. The MAC must be the same for all virtual routers participating as a virtual router or indeterminate connectivity by the attached IP hosts results. All VRRP advertisement messages are transmitted with unicast-mac-address as the source MAC.

An operator can execute this command at any time and it takes effect immediately. When the virtual router MAC on a master virtual router instance changes, a gratuitous ARP is immediately sent with a VRRP advertisement message. If the virtual router instance is disabled or operating as a backup, the gratuitous ARP and VRRP advertisement messages are not sent.

Introduced16.0.R1

Platforms

All

master-int-inherit boolean
Synopsis Allow master instance to dictate the master down timer
Contextconfigure router string interface string ipv6 vrrp number master-int-inherit boolean
Treemaster-int-inherit

Description

When configured to true, the virtual router instance inherits the advertisement interval timer of the master VRRP router, which backup routers use to calculate the master down timer.

When configured to false, the locally configured message interval must match the master's VRRP advertisement message advertisement interval field value or the message is discarded.

Introduced16.0.R1

Platforms

All

message-interval number
Synopsis Interval for sending VRRP advertisement messages
Contextconfigure router string interface string ipv6 vrrp number message-interval number
Treemessage-interval

Description

This command configures the administrative advertisement message timer used by the master virtual router instance to send VRRP advertisement messages. The backup master down timer is derived from the value configured using this command.

The use of this command varies for non-owner virtual router instances, depending on the state of the virtual router (master or backup) and the state of the master-int-inherit command:

  • When a non-owner is operating as master for the virtual router, the system uses the configured value of this command as the operational advertisement timer, similar to an owner virtual router instance. The master-int-inherit command has no effect when operating as the master.

  • When a non-owner is in the backup state with master-int-inherit disabled, the system uses the configured value of this command to match the incoming advertisement interval field of the VRRP advertisement message. If the locally configured message interval does not match the advertisement interval field, the system discards the VRRP advertisement.

  • When a non-owner is in the backup state with master-int-inherit enabled, the configured value of this command is ignored. The master down timer is indirectly derived from the advertisement interval field value of the incoming VRRP advertisement message.

Range10 to 4095
Unitscentiseconds
Default 100
Introduced16.0.R1

Platforms

All

monitor-oper-group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisVRRP instance to follow a specified operational group
Contextconfigure router string interface string ipv6 vrrp number monitor-oper-group reference
Treemonitor-oper-group

Description

This command configures VRRP to associate with an operational group. When associated, VRRP notifies the operational group of its state changes so that other protocols can monitor it to provide a redundancy mechanism. When VRRP is the master router, the operational group is up and the operational group is down for all other VRRP states.

Reference

configure service oper-group string

Introduced22.2.R1

Platforms

All

ntp-reply boolean
Synopsis Allow processing of NTP requests
Context configure router string interface string ipv6 vrrp number ntp-reply boolean
Treentp-reply

Description

When configured to true, the router redirects NTP requests to the VRRP virtual IP address. This behavior only applies to the router acting as the master VRRP router.

When configured to false, the router does not process NTP requests.

Defaultfalse
Introduced20.2.R1

Platforms

All

oper-group reference
Synopsis Operational group name associated with the VRRP
Contextconfigure router string interface string ipv6 vrrp number oper-group reference
Treeoper-group

Description

This command configures an operational group to associate with the VRRP. When associated, VRRP notifies the operational group of its state changes so that other protocols can monitor it to provide a redundancy mechanism. When VRRP is the master router (MR), the operational group is up. The operational group is down for all other VRRP states.

Reference

configure service oper-group string

Introduced16.0.R1

Platforms

All

owner boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisDesignate the virtual router instance as owner
Contextconfigure router string interface string ipv6 vrrp number owner boolean
Treeowner

Description

When configured to true, the router designates this virtual router instance as the owner of the virtual router IP addresses. Therefore, this virtual router becomes responsible for forwarding packets sent to the virtual router IP addresses. The owner also assumes the role of master virtual router.

When configured to false, this virtual router instance is designated as a non-owner.

Defaultfalse
Introduced16.0.R1

Platforms

All

passive boolean
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisSuppress the processing of VRRP advertisement messages
Contextconfigure router string interface string ipv6 vrrp number passive boolean
Treepassive

Description

When configured to true, the router identifies this virtual router instance as passive; and therefore the owner of the virtual router IP addresses. A passive virtual router instance does not transmit or receive VRRP advertisement messages and is always in either the master state (if the interface is operationally up) or the init state (if the interface is operationally down).

When configured to false, this virtual router instance is not identified as passive, meaning that it transmits and receives VRRP advertisement messages. 

Defaultfalse
Introduced16.0.R1

Platforms

All

ping-reply boolean
Synopsis Allow non-owner master to reply to ICMP echo requests
Contextconfigure router string interface string ipv6 vrrp number ping-reply boolean
Treeping-reply

Description

When configured to true, the router allows the non-owner master to reply to ICMP echo requests directed at the IP addresses of the virtual router instance. Any routed interface can receive the ping request. Ping must not have been disabled at the management security level (either on the parental IP interface or on the Ping source host address).

When configured to false, ICMP echo requests sent to non-owner master virtual IP addresses are silently discarded.

Non-owner backup virtual routers never respond to ICMP echo requests, regardless of the configuration of this command.

Defaultfalse
Introduced16.0.R1

Platforms

All

policy reference
Synopsis VRRP priority control policy
Context configure router string interface string ipv6 vrrp number policy reference
Treepolicy

Description

This command configures a VRRP priority control policy to associate with the virtual router instance.

VRRP priority control policies can override or adjust the base priority value of the virtual router instance, depending on events or conditions within the chassis.

An operator can associate a policy with more than one virtual router instance. The priority events within the policy either override or diminish the base priority set with the priority command. As priority events clear in the policy, the in-use priority can eventually be restored to the base priority value.

For non-owner virtual router instances, if this command is not executed, the base priority is used as the in-use priority.

Reference

configure vrrp policy number

Introduced16.0.R1

Platforms

All

preempt boolean
Synopsis Allow the VRRP to override an existing non-owner master
Contextconfigure router string interface string ipv6 vrrp number preempt boolean
Treepreempt

Description

When configured to true, this virtual router instance overrides any non-owner master with an in-use message priority value less than the in-use priority value of this virtual router.

When configured to false, this virtual router only becomes master if the master down timer expires before a VRRP advertisement message is received from another virtual router.

Defaulttrue
Introduced16.0.R1

Platforms

All

priority number
Synopsis Base priority for the VRRP
Context configure router string interface string ipv6 vrrp number priority number
Treepriority

Description

This command configures the base router priority for the virtual router instance, which defines the selection order of the virtual router in the master election process.

The in-use priority is derived from the base priority. However, the in-use priority is modified by optional VRRP priority control policies. An operator can use VRRP priority control policies to either override or adjust the base priority value depending on events or conditions within the chassis.

Range1 to 255
Introduced16.0.R1

Platforms

All

standby-forwarding boolean
Synopsis Allow standby router to forward traffic
Contextconfigure router string interface string ipv6 vrrp number standby-forwarding boolean
Treestandby-forwarding

Description

When configured to true, the standby router forwards all traffic.

When configured to false, the standby router cannot forward traffic sent to the MAC address of the virtual router. However, the standby router still forwards traffic sent to its own MAC address.

Defaultfalse
Introduced16.0.R1

Platforms

All

telnet-reply boolean
Synopsis Allow non-owner master to reply to Telnet requests
Contextconfigure router string interface string ipv6 vrrp number telnet-reply boolean
Treetelnet-reply

Description

When configured to true, the router allows the non-owner master to reply to Telnet requests directed at the IP addresses of the virtual router instance. Any routed interface can receive Telnet requests. Telnet cannot be disabled at the management security level (either on the parental IP interface or on the Telnet source host address).

When configured to false, the router silently discards Telnet requests sent to non-owner master virtual IP addresses.

Defaultfalse
Introduced16.0.R1

Platforms

All

traceroute-reply boolean
Synopsis Allow non-owner master to reply to traceroute requests
Contextconfigure router string interface string ipv6 vrrp number traceroute-reply boolean
Treetraceroute-reply

Description

When configured to true, the router allows a non-owner master to reply to traceroute requests directed to the IP addresses of the virtual router instance.

When configured to false, the router silently discards traceroute requests sent to non-owner master virtual IP addresses.

Traceroute must not have been disabled at the management security level (either on the parental IP interface or the source host address).

Defaultfalse
Introduced16.0.R1

Platforms

All

lag
Synopsis Enter the lag context
Context configure router string interface string lag
Treelag
Introduced16.0.R1

Platforms

All

link-map-profile number
Synopsis LAG link map profile for a SAP or network interface
Contextconfigure router string interface string lag link-map-profile number
Treelink-map-profile

Description

This command assigns a preconfigured LAG link map profile to a SAP or network interface configured on a LAG or a PW port that exists on a LAG. After an operator assigns a LAG link map profile, the system rehashes the SAP or network interface egress traffic over the LAG as required by the new configuration.

If the LAG link map profile for a SAP or network interface is deleted, the system reverts back to per-flow hashing.

Range1 to 64
Introduced16.0.R1

Platforms

All

per-link-hash
Synopsis Enter the per-link-hash context
Contextconfigure router string interface string lag per-link-hash
Treeper-link-hash
Introduced16.0.R1

Platforms

All

class number
Synopsis Class used on LAG egress using weighted per-link-hash
Contextconfigure router string interface string lag per-link-hash class number
Treeclass
Range1 to 3
Default1
Introduced 16.0.R1

Platforms

All

weight number
Synopsis Weight used on LAG egress using weighted per-link-hash
Contextconfigure router string interface string lag per-link-hash weight number
Treeweight
Range1 to 1024
Default1
Introduced 16.0.R1

Platforms

All

ldp-sync-timer
Synopsis Enter the ldp-sync-timer context
Contextconfigure router string interface string ldp-sync-timer
Treeldp-sync-timer

Description

Commands in this context set associated parameters for the synchronization of an IGP and LDP.

Introduced16.0.R1

Platforms

All

end-of-lib boolean
Synopsis Terminate LDP synchronization timer
Context configure router string interface string ldp-sync-timer end-of-lib boolean
Treeend-of-lib

Description

This command configures the system to terminate the LDP synchronization timer early for a specific session to an LDP peer, if the IGP interface receives LDP End-of-LIB Typed Wildcard FEC messages for every FEC type negotiated.

Defaultfalse
Introduced16.0.R1

Platforms

All

load-balancing
Synopsis Enter the load-balancing context
Contextconfigure router string interface string load-balancing
Treeload-balancing

Description

Commands in this context configure interface per-flow load-balancing options that apply to traffic that enters this interface and that egresses over a LAG or ECMP. This is a per-interface setting. Load-balancing options enabled on the interface level overwrite options that can also be enabled on the system level.

Introduced16.0.R1

Platforms

All

flow-label-load-balancing boolean
Synopsis Enable flow label load balancing
Context configure router string interface string load-balancing flow-label-load-balancing boolean
Treeflow-label-load-balancing

Description

When configured to true, the router enables load balancing in ECMP and LAG based on the output of a hash performed on the triplet (SA, DA, flow label) in the header of an IPv6 packet received on an IES, VPRN, R-VPLS, CSC, or network interface.

When configured to false, the router disables load balancing in ECMP and LAG.

Defaultfalse
Introduced21.5.R1

Platforms

All

ip-load-balancing keyword
Synopsis IP load-balancing algorithm
Context configure router string interface string load-balancing ip-load-balancing keyword
Treeip-load-balancing

Description

This command specifies whether to include the source address, destination address, or both in LAG or ECMP hash on IP interfaces. Additionally, when the l4-load-balancing command is enabled, this command also includes the source or destination port in the hash inputs.

Optionsboth, destination, source, inner-ip
Default both
Introduced16.0.R3

Platforms

All

lsr-load-balancing keyword
Synopsis LSR load-balancing algorithm
Context configure router string interface string load-balancing lsr-load-balancing keyword
Treelsr-load-balancing

Description

This command specifies whether the IP header is used in the LAG and ECMP LSR hashing algorithm. This is the per-interface setting.

Optionslbl-only, lbl-ip, ip-only, eth-encap-ip, lbl-ip-l4-teid
Introduced16.0.R1

Platforms

All

spi-load-balancing boolean
Synopsis Enable SPI use in hashing
Context configure router string interface string load-balancing spi-load-balancing boolean
Treespi-load-balancing

Description

When configured to true, the router uses the Security Parameter Index (SPI) in hashing for ESP and AH encrypted IPv4 and IPv6 traffic. This is a per-interface setting.

Defaultfalse
Introduced16.0.R1

Platforms

All

loopback
Synopsis Use interface as a loopback interface
Contextconfigure router string interface string loopback
Treeloopback

Description

When configured, this interface is used as a loopback interface.

This command and the vas-if-type command are mutually exclusive.

Notes

The following elements are part of a choice: loopback or port.

Introduced16.0.R1

Platforms

All

mac string
Synopsis MAC address of the interface
Context configure router string interface string mac string
Treemac

Description

This command assigns a specific MAC address to an IP interface. Only one MAC address can be assigned to an IP interface. When multiple mac commands are entered, the last command overwrites the previous command.

Introduced16.0.R1

Platforms

All

mac-accounting boolean
Synopsis Enable MAC accounting functionality
Context configure router string interface string mac-accounting boolean
Treemac-accounting

Description

When configured to true, the router enables MAC accounting functionality.

Defaultfalse
Introduced16.0.R1

Platforms

All

network-domains
Synopsis Enter the network-domains context
Contextconfigure router string interface string network-domains
Treenetwork-domains
Introduced16.0.R4

Platforms

All

network-domain [domain-name] reference
Synopsis Add a list entry for network-domain
Contextconfigure router string interface string network-domains network-domain reference
Treenetwork-domain

Description

Commands in this context assign an interface to a network domain. The router then takes the network domain into account during SAP ingress queue allocation for VPLS SAP.

The network domain association can only be done in the base routing context. An operator can associate a network domain with an interface without a physical port being specified, but the configuration has no effect until a corresponding port, or LAG, is defined.

Single interfaces can be associated with multiple network domains.

Max. Instances5
Introduced16.0.R4

Platforms

All

port (port-and-encap | keyword)
Synopsis Port to bind to this interface
Context configure router string interface string port (port-and-encap | keyword)
Treeport

Description

This command creates an association between a logical IP interface and a physical port. An operator can also associate an interface with the system (loopback address).

String Length1 to 45
Optionssystem

Notes

The following elements are part of a choice: loopback or port.

Introduced16.0.R1

Platforms

All

ptp-hw-assist
Synopsis Enter the ptp-hw-assist context
Contextconfigure router string interface string ptp-hw-assist
Treeptp-hw-assist

Description

Commands in this context enable the port-based timestamping assist of PTP packets at the physical interface. This capability is supported on specific hardware. The command may be blocked if not all hardware has the required level of support.

Only one interface per physical port can have port-based timestamping assist enabled. This feature cannot be enabled if the physical port supporting the interface is configured as a PTP port.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

admin-state keyword
Synopsis Administrative state of the PTP timestamping assist
Contextconfigure router string interface string ptp-hw-assist admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

qos
Synopsis Enter the qos context
Context configure router string interface string qos
Treeqos

Description

Commands in this context associate a network QoS policy with a network IP interface. Only one network QoS policy can be associated with an IP interface at one time. Attempts to associate a second QoS policy return an error.

Introduced16.0.R1

Platforms

All

egress-instance number
Synopsis Port egress queue group instance for this interface
Contextconfigure router string interface string qos egress-instance number
Treeegress-instance

Description

This command specifies which instance to associate with this specific network IP interface since multiple instances of the same egress queue-group can be applied to the same port.

Range1 to 65535
Introduced16.0.R1

Platforms

All

egress-port-redirect-group reference
Synopsis QoS queue group name
Context configure router string interface string qos egress-port-redirect-group reference
Treeegress-port-redirect-group

Description

This command configures the egress queue group used for all egress forwarding-class redirections specified within the network QoS policy ID. The specified queue group name must exist as an egress queue group applied to the egress context of the port associated with the IP interface.

Reference

configure qos queue-group-templates egress queue-group string

Introduced16.0.R1

Platforms

All

ingress-fp-redirect-group reference
Synopsis Forwarding plane queue group policy for the interface
Contextconfigure router string interface string qos ingress-fp-redirect-group reference
Treeingress-fp-redirect-group

Description

This command configures the ingress queue-group used for all ingress forwarding-class redirections specified within the network QoS policy ID. The specified queue group name must exist as an ingress queue group applied to the ingress context of the forwarding plane associated with the IP interface.

Reference

configure qos queue-group-templates ingress queue-group string

Introduced16.0.R1

Platforms

All

ingress-instance number
Synopsis Forwarding plane ingress queue group for this interface
Contextconfigure router string interface string qos ingress-instance number
Treeingress-instance

Description

This command configures which instance to associate with this specific network IP interface. An operator can apply multiple instances of the same ingress queue group to the same forwarding plane.

Range1 to 65535
Introduced16.0.R1

Platforms

All

network-policy reference
Synopsis Network policy name associated with a network interface
Contextconfigure router string interface string qos network-policy reference
Treenetwork-policy

Description

This command associates an existing network policy name with the IP interface.

Reference

configure qos network string

Introduced16.0.R1

Platforms

All

strip-label boolean
Synopsis Strip all MPLS labels before PBR processing
Contextconfigure router string interface string strip-label boolean
Treestrip-label

Description

When configured to true, the router forces packets to be stripped of all (maximum 5) MPLS labels before the packets are handed over for possible filter (PBR) processing.

This command is supported on:

  • optical ports for the 7750 SR and 7450 ESS

  • null/dot1q encaps

  • network ports

  • IPv4

  • IPv6

Defaultfalse
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

tos-marking-state keyword
Synopsis TOS marking state
Context configure router string interface string tos-marking-state keyword
Treetos-marking-state

Description

This command configures the ToS marking state.

This command is used to alter the default trusted state to a non-trusted state. When configured to trusted or default, the ToS field is not remarked by egress network IP interfaces unless the egress network IP interface has the remark-trusted state set, in which case the egress network interface treats all VPRN and network IP interfaces as untrusted.

When configured to untrusted, all egress network IP interfaces remark IP packets received on the network interface according to the egress marking defintions on each network interface.

Optionstrusted, untrusted
Default trusted
Introduced16.0.R1

Platforms

All

untrusted
Synopsis Enable the untrusted context
Context configure router string interface string untrusted
Treeuntrusted

Description

Commands in this context configure the untrusted state for a network IP interface.

The untrusted state identifies the participating interfaces in the label security feature for prefixes of a VPN family at an inter-AS boundary. The router supports a maximum of 15 network interfaces that can participate in this feature.

The user normally applies this command to an inter-AS interface. PIP keeps track of the untrusted status of each interface. 

Introduced16.0.R4

Platforms

All

default-forwarding keyword
Synopsis Default action for selective ILM
Context configure router string interface string untrusted default-forwarding keyword
Treedefault-forwarding

Description

This command specifies the default forwarding behavior of labeled packets received on this interface.

This command sets the default behavior for an untrusted interface in the datapath and for all ILMs. When enabling the label security for VPN IPv4 or VPN IPv6 prefixes, BGP programs the data path to provide an exception to the normal way of forwarding away from the default for those VPRN ILMs.

When the default behavior is to forward packets, the router checks labeled packets in the normal way against the table of programmed ILMs to decide if packets are dropped or forwarded in a GRT, a VRF, or a L2 service context.

When the specified behavior is to drop packets, all labeled packets received on the interface are automatically dropped.

Optionsforward, drop
Default forward
Introduced16.0.R4

Platforms

All

urpf-selected-vprns boolean
Synopsis Enable uRPF checking of incoming traffic on interface
Contextconfigure router string interface string urpf-selected-vprns boolean
Treeurpf-selected-vprns

Description

When configured to true, the router performs uRPF checks of incoming traffic on the network interface for the following:

  • Packets associated with the global routing table (base router) context

  • Packets associated with VPRNs that have enabled the uRPF check using the configure service vprn network ingress urpf-check command

When configured to false, the router performs uRPF checks for all ingress traffic on the network interface (associated with the base router and all VPRNs) based on the IPv4 and IPv6 urpf-check command configuration options of the network interface.

Defaultfalse
Introduced16.0.R1

Platforms

All

vas-if-type keyword
Synopsis VAS interface type
Context configure router string interface string vas-if-type keyword
Treevas-if-type

Description

This command configures the type of a Value Added Service (VAS) facing interface. This command and loopback command

Optionsto-from-access, to-from-network, to-from-both
Introduced16.0.R1

Platforms

All

ipsec

Synopsis Enter the ipsec context
Context configure router string ipsec
Treeipsec
Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

multi-chassis-shunt-interface [name] string
Synopsis Enter the multi-chassis-shunt-interface list instance
Contextconfigure router string ipsec multi-chassis-shunt-interface string
Treemulti-chassis-shunt-interface

Description

This command configures the multi-chassis shunting interface name for the peer.

Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

next-hop
Synopsis Enter the next-hop context
Context configure router string ipsec multi-chassis-shunt-interface string next-hop
Treenext-hop

Description

Commands in this context configure the next hop for shunting over the interface.

Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Next hop address for the shunting interface
Contextconfigure router string ipsec multi-chassis-shunt-interface string next-hop address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeaddress
Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

multi-chassis-shunting-profile [name] string
Synopsis Enter the multi-chassis-shunting-profile list instance
Contextconfigure router string ipsec multi-chassis-shunting-profile string
Treemulti-chassis-shunting-profile
Max. Instances64
Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

peer [ip-address] reference
Synopsis Enter the peer list instance
Context configure router string ipsec multi-chassis-shunting-profile string peer reference
Treepeer
Max. Instances3
Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

security-policy [id] number
Synopsis Enter the security-policy list instance
Contextconfigure router string ipsec security-policy number
Treesecurity-policy
Introduced22.7.R1

Platforms

VSR

[id] number
Synopsis IPsec security policy ID
Context configure router string ipsec security-policy number
Treesecurity-policy
Range1 to 32768

Notes

This element is part of a list key.

Introduced22.7.R1

Platforms

VSR

entry [entry-id] number
Synopsis Enter the entry list instance
Context configure router string ipsec security-policy number entry number
Treeentry
Introduced22.7.R1

Platforms

VSR

[entry-id] number
Synopsis IPsec security policy entry ID
Context configure router string ipsec security-policy number entry number
Treeentry
Range1 to 16

Notes

This element is part of a list key.

Introduced22.7.R1

Platforms

VSR

local-ip
Synopsis Enter the local-ip context
Context configure router string ipsec security-policy number entry number local-ip
Treelocal-ip

Description

Commands in this context configure the local (from the VPN) IPv4 prefix/mask for the policy entry.

The system evaluates the local IP as the source IP when traffic is examined in the direction of the flows from private to public and as the destination IP when traffic flows from public to private.

Introduced22.7.R1

Platforms

VSR

address string
Synopsis Destination IPv4 address of the aggregate route
Contextconfigure router string ipsec security-policy number entry number local-ip address string
Treeaddress

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

any boolean
Synopsis Use any IP address
Context configure router string ipsec security-policy number entry number local-ip any boolean
Treeany
Defaultfalse

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

local-ipv6
Synopsis Enter the local-ipv6 context
Context configure router string ipsec security-policy number entry number local-ipv6
Treelocal-ipv6

Description

Commands in this context configure the local (from the VPN) IPv6 prefix/mask for the policy entry.

The system evaluates the local IP as the source IP when traffic is examined in the direction of the flows from private to public and as the destination IP when traffic flows from public to private.

Introduced22.7.R1

Platforms

VSR

address string
Synopsis Destination IPv6 address of the aggregate route
Contextconfigure router string ipsec security-policy number entry number local-ipv6 address string
Treeaddress

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

any boolean
Synopsis Use any IP address
Context configure router string ipsec security-policy number entry number local-ipv6 any boolean
Treeany
Defaultfalse

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

remote-ip
Synopsis Enter the remote-ip context
Context configure router string ipsec security-policy number entry number remote-ip
Treeremote-ip

Description

Commands in this context configure the remote (from the tunnel) IP prefix/mask for the policy entry.

The system evaluates the remote IP as the source IP when traffic flows public to private and as the destination IP when traffic flows from private to public.

Introduced22.7.R1

Platforms

VSR

address string
Synopsis Destination IPv4 address of the aggregate route
Contextconfigure router string ipsec security-policy number entry number remote-ip address string
Treeaddress

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

any boolean
Synopsis Use any IP address
Context configure router string ipsec security-policy number entry number remote-ip any boolean
Treeany
Defaultfalse

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

remote-ipv6
Synopsis Enter the remote-ipv6 context
Context configure router string ipsec security-policy number entry number remote-ipv6
Treeremote-ipv6

Description

Commands in this context configure the remote (from the tunnel) IPv6 prefix/mask for the policy entry.

The system evaluates the remote IP as the source IP when traffic flows from public to private and as the destination IP when traffic flows from private to public.

Introduced22.7.R1

Platforms

VSR

address string
Synopsis Destination IPv6 address of the aggregate route
Contextconfigure router string ipsec security-policy number entry number remote-ipv6 address string
Treeaddress

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

any boolean
Synopsis Use any IP address
Context configure router string ipsec security-policy number entry number remote-ipv6 any boolean
Treeany
Defaultfalse

Notes

The following elements are part of a choice: address or any.

Introduced22.7.R1

Platforms

VSR

ipv6

Synopsis Enter the ipv6 context
Context configure router string ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

neighbor-discovery
Synopsis Enter the neighbor-discovery context
Contextconfigure router string ipv6 neighbor-discovery
Treeneighbor-discovery
Introduced16.0.R1

Platforms

All

router-advertisement
Synopsis Enter the router-advertisement context
Contextconfigure router string ipv6 router-advertisement
Treerouter-advertisement
Introduced16.0.R1

Platforms

All

dns-options
Synopsis Enable the dns-options context
Contextconfigure router string ipv6 router-advertisement dns-options
Treedns-options
Introduced16.0.R1

Platforms

All

rdnss-lifetime (keyword | number)
Synopsis Maximum time over which the RDNSS address is valid
Contextconfigure router string ipv6 router-advertisement dns-options rdnss-lifetime (keyword | number)
Treerdnss-lifetime

Description

This command specifies the maximum time that the RDNSS address is used for name resolution by the client.

Range0 | 4 to 3600
Unitsseconds
Options infinite
Defaultinfinite
Introduced 16.0.R1

Platforms

All

interface [ip-int-name] string
Synopsis Enter the interface list instance
Contextconfigure router string ipv6 router-advertisement interface string
Treeinterface
Introduced16.0.R1

Platforms

All

dns-options
Synopsis Enable the dns-options context
Contextconfigure router string ipv6 router-advertisement interface string dns-options
Treedns-options
Introduced16.0.R1

Platforms

All

nd-router-preference keyword
Synopsis Default router preference for Router Advertisements
Contextconfigure router string ipv6 router-advertisement interface string nd-router-preference keyword
Treend-router-preference

Description

This command configures the default router preference for Router Advertisements (RAs) and allows IPv6 hosts to discover and select a default gateway address by listening to RAs.

This feature provides basic traffic engineering functionality for host devices. When this command is applied, the router advertises the respective router preference to the connected host to assist in its selection of the most appropriate default gateway on a link.

This extension is backward compatible, both for routers (setting the router preference bits) and hosts (interpreting the router preference bits). These bits are ignored by hosts that do not implement the RFC 4191 functionality by configuring this command. Similarly, hosts that do not implement the RFC 4191 functionality interpret the values sent by devices that do not implement the RFC 4191 extension as a medium preference.

Optionsmedium, high, low
Defaultmedium
Introduced23.10.R1

Platforms

All

prefix [ipv6-prefix] string
Synopsis Enter the prefix list instance
Contextconfigure router string ipv6 router-advertisement interface string prefix string
Treeprefix
Max. Instances254
Introduced16.0.R1

Platforms

All

ipv6-te-router-id

Synopsis Enter the ipv6-te-router-id context
Contextconfigure router string ipv6-te-router-id
Treeipv6-te-router-id
Introduced19.10.R1

Platforms

All

interface reference
Synopsis Network IP interface name to obtain IP address
Contextconfigure router string ipv6-te-router-id interface reference
Treeinterface

Description

This command specifies the interface name from which to obtain the IP address to use as the IPv6 TE Router ID. This router ID uniquely identifies the router to other routers as IPv6 TE capable in an IGP TE domain.

IS-IS advertises this information using the IPv6 TE Router ID TLV.

Reference

configure router string interface string

Introduced19.10.R1

Platforms

All

isa-service-chaining

Synopsis Enable the isa-service-chaining context
Contextconfigure router string isa-service-chaining
Treeisa-service-chaining
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-group [id] number
Synopsis Add a list entry for nat-group
Contextconfigure router string isa-service-chaining nat-group number
Treenat-group
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[id] number
Synopsis ISA NAT group/ISA WLAN GW group ID for the EVPN pools
Contextconfigure router string isa-service-chaining nat-group number
Treenat-group
Max. Range0 to 4294967295

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

vxlan-vtep-range
Synopsis Enable the vxlan-vtep-range context
Contextconfigure router string isa-service-chaining vxlan-vtep-range
Treevxlan-vtep-range
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

end (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis End address of the VXLAN VTEP range
Context configure router string isa-service-chaining vxlan-vtep-range end (ipv4-address-no-zone | ipv6-address-no-zone)
Treeend

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

start (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Start address of the VXLAN VTEP range
Contextconfigure router string isa-service-chaining vxlan-vtep-range start (ipv4-address-no-zone | ipv6-address-no-zone)
Treestart

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

isis [isis-instance] number

Synopsis Enter the isis list instance
Context configure router string isis number
Treeisis
Introduced16.0.R1

Platforms

All

[isis-instance] number
Synopsis Instance ID for the IS-IS instance
Context configure router string isis number
Treeisis
Range0 to 127
MD-CLI Default0

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the IS-IS instance
Contextconfigure router string isis number admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

all-l1isis string
Synopsis Destination MAC address for all L1 IS-IS routers
Contextconfigure router string isis number all-l1isis string
Treeall-l1isis
Default01:80:C2:00:00:14
Introduced16.0.R1

Platforms

All

all-l2isis string
Synopsis Destination MAC address for all L2 IS-IS routers
Contextconfigure router string isis number all-l2isis string
Treeall-l2isis
Default01:80:C2:00:00:15
Introduced16.0.R1

Platforms

All

area-address string
Synopsis Area address portion of the NSAP address
Contextconfigure router string isis number area-address string
Treearea-address
String Length2 to 38
Max. Instances3
Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis Authentication key to verify PDUs sent from neighbors
Contextconfigure router string isis number authentication-key string
Treeauthentication-key
String Length1 to 366
Introduced16.0.R1

Platforms

All

database-export
Synopsis Enable the database-export context
Contextconfigure router string isis number database-export
Treedatabase-export
Introduced16.0.R1

Platforms

All

export-limit
Synopsis Enable the export-limit context
Contextconfigure router string isis number export-limit
Treeexport-limit
Introduced16.0.R1

Platforms

All

number number
Synopsis Maximum routes or prefixes exported from route table
Contextconfigure router string isis number export-limit number number
Treenumber
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

export-policy reference
Synopsis Export policies that determine exported routes
Contextconfigure router string isis number export-policy reference
Treeexport-policy

Description

This command configures export routing policies for the routes exported from the routing table to IS-IS.

If the export policy is undefined, the system does not export non IS-IS routes from the routing table manager to IS-IS.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

If the aggregate command is also configured in the configure router context, the aggregation is applied before the export policy is applied.

Routing policies are created in the configure router policy-options context.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

flexible-algorithms
Synopsis Enter the flexible-algorithms context
Contextconfigure router string isis number flexible-algorithms
Treeflexible-algorithms

Description

Commands in this context configure IS-IS parameters for flexible algorithm participation.

Introduced20.7.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of flexible algorithm support
Contextconfigure router string isis number flexible-algorithms admin-state keyword
Treeadmin-state

Description

This command specifies the administrative state of the support of flexible algorithm IGP LSDB extensions.

Optionsenable, disable
Default disable
Introduced20.7.R1

Platforms

All

advertise-admin-group keyword
Synopsis Administrative group TLV to advertise
Contextconfigure router string isis number flexible-algorithms advertise-admin-group keyword
Treeadvertise-admin-group

Description

This command configures the type of Administrative Group TLV the router advertises as an IGP link attribute. This command is configured for this IGP instance.

Optionsprefer-ag, eag-only, ag-eag
Defaultprefer-ag
Introduced23.3.R1

Platforms

All

flex-algo [flex-algo-id] number
Synopsis Enter the flex-algo list instance
Contextconfigure router string isis number flexible-algorithms flex-algo number
Treeflex-algo

Description

Commands in this context configure an IS-IS flexible algorithm.

When flexible algorithm is configured in an IS-IS instance, the IS-IS instance is configured for all levels (Level 1 and Level 2).

Max. Instances7
Introduced20.7.R1

Platforms

All

[flex-algo-id] number
Synopsis Flexible algorithm ID
Context configure router string isis number flexible-algorithms flex-algo number
Treeflex-algo
Range128 to 255

Notes

This element is part of a list key.

Introduced20.7.R1

Platforms

All

advertise reference
Synopsis Flexible Algorithm Definition advertisement
Contextconfigure router string isis number flexible-algorithms flex-algo number advertise reference
Treeadvertise

Description

This command enables the advertisement of a locally configured Flexible Algorithm Definition (FAD).

The winning FAD that a router uses must be consistent with the winning FAD on all other routers, which avoids routing loops and traffic blackholing. The winning FAD is selected using a tiebreaker algorithm that first selects the highest advertised FAD priority followed by the highest system ID.

Reference

configure routing-options flexible-algorithm-definitions flex-algo string

Introduced20.7.R1

Platforms

All

participate boolean
Synopsis Allow participation in the Flexible Algorithm
Contextconfigure router string isis number flexible-algorithms flex-algo number participate boolean
Treeparticipate

Description

When configured to true, the router advertises the capability to participate in a flexible algorithm within the IS-IS Router Capability TLV. A router only advertises participation when the winning FAD can be supported, which includes segment routing support.

When configured to false, flexible algorithm participation is not enabled.

Defaultfalse
Introduced20.7.R1

Platforms

All

hello-padding keyword
Synopsis IS-IS Hello message padding
Context configure router string isis number hello-padding keyword
Treehello-padding
Optionsadaptive, loose, strict, none
Introduced 16.0.R1

Platforms

All

igp-shortcut
Synopsis Enter the igp-shortcut context
Contextconfigure router string isis number igp-shortcut
Treeigp-shortcut
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of RSVP-TE or SR-TE shortcut
Contextconfigure router string isis number igp-shortcut admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

allow-sr-over-srte boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable SR over SR-TE LSPs
Contextconfigure router string isis number igp-shortcut allow-sr-over-srte boolean
Treeallow-sr-over-srte

Description

When configured to true, the router only allows SR-MPLS SRv4 and SRv6 IGP shortcuts to use SR-TE LSPs with allow-sr-over-srte explicitly enabled with an adjacency SID as top SID in the SR-TE LSP. IPv4 and IPv6 addresses can use all available SR-TE LSPs as IGP shortcuts regardless of the explicit allow-sr-over-srte configuration.

Under ECMP, when this command is configured to true, preference is given to the SR-TE LSPs with allow-sr-over-srte explicitly configured over the LSPs that do not have allow-sr-over-srte configured.

Defaultfalse
Introduced23.3.R1

Platforms

All

tunnel-next-hop
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the tunnel-next-hop context
Contextconfigure router string isis number igp-shortcut tunnel-next-hop
Treetunnel-next-hop
Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string isis number igp-shortcut tunnel-next-hop family keyword
Treefamily
Introduced16.0.R1

Platforms

All

[family-type] keyword
Synopsis Address family type for tunnel next hop
Contextconfigure router string isis number igp-shortcut tunnel-next-hop family keyword
Treefamily
Optionsipv4, ipv6, srv4, srv6

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

resolution-filter
Synopsis Enter the resolution-filter context
Contextconfigure router string isis number igp-shortcut tunnel-next-hop family keyword resolution-filter
Treeresolution-filter
Introduced16.0.R1

Platforms

All

iid-tlv boolean
Synopsis Use IID TLVs with IS-IS multi-instance
Contextconfigure router string isis number iid-tlv boolean
Treeiid-tlv
Defaultfalse
Introduced16.0.R1

Platforms

All

interface [interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string isis number interface string
Treeinterface
Introduced16.0.R1

Platforms

All

[interface-name] string
Synopsis Router interface name
Context configure router string isis number interface string
Treeinterface
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adjacency-set [id] reference
Synopsis Add a list entry for adjacency-set
Contextconfigure router string isis number interface string adjacency-set reference
Treeadjacency-set
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the IS-IS interface
Contextconfigure router string isis number interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

bfd-liveness
Synopsis Enter the bfd-liveness context
Contextconfigure router string isis number interface string bfd-liveness
Treebfd-liveness

Description

Commands in this context enable the use of bidirectional forwarding (BFD) to control IPv4 and IPv6 adjacencies. Enabling BFD on an IPv4 or IPv6 protocol interface ties the protocol interface state to the BFD session state between the local and remote nodes. BFD must be enabled on the applicable IP interface.

Introduced16.0.R1

Platforms

All

csnp-interval number
Synopsis Time interval between successive CSN PDUs sent
Contextconfigure router string isis number interface string csnp-interval number
Treecsnp-interval
Range1 to 65535
Unitsseconds
Default 10
Introduced16.0.R1

Platforms

All

flex-algo [flex-algo-id] number
Synopsis Enter the flex-algo list instance
Contextconfigure router string isis number interface string flex-algo number
Treeflex-algo
Max. Instances7
Introduced20.7.R1

Platforms

All

[flex-algo-id] number
Synopsis Flexible algorithm ID
Context configure router string isis number interface string flex-algo number
Treeflex-algo
Range128 to 255

Notes

This element is part of a list key.

Introduced20.7.R1

Platforms

All

ipv4-node-sid
Synopsis Enable the ipv4-node-sid context
Contextconfigure router string isis number interface string flex-algo number ipv4-node-sid
Treeipv4-node-sid
Introduced20.7.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string isis number interface string flex-algo number ipv4-node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced20.7.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string isis number interface string flex-algo number ipv4-node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced20.7.R1

Platforms

All

ipv6-node-sid
Synopsis Enable the ipv6-node-sid context
Contextconfigure router string isis number interface string flex-algo number ipv6-node-sid
Treeipv6-node-sid
Introduced20.7.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string isis number interface string flex-algo number ipv6-node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced20.7.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string isis number interface string flex-algo number ipv6-node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced20.7.R1

Platforms

All

hello-padding keyword
Synopsis Padding on IS-IS Hello packets
Context configure router string isis number interface string hello-padding keyword
Treehello-padding
Optionsadaptive, loose, strict, none
Introduced 16.0.R1

Platforms

All

interface-type keyword
Synopsis Interface type to broadcast, point-to-point, or to be default
Contextconfigure router string isis number interface string interface-type keyword
Treeinterface-type
Optionspoint-to-point, broadcast
Introduced 16.0.R1

Platforms

All

ipv4-node-sid
Synopsis Enable the ipv4-node-sid context
Contextconfigure router string isis number interface string ipv4-node-sid
Treeipv4-node-sid
Introduced16.0.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string isis number interface string ipv4-node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string isis number interface string ipv4-node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

ipv6-node-sid
Synopsis Enable the ipv6-node-sid context
Contextconfigure router string isis number interface string ipv6-node-sid
Treeipv6-node-sid
Introduced16.0.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string isis number interface string ipv6-node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string isis number interface string ipv6-node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

ipv6-unicast boolean
Synopsis Enable IPv6 unicast routing for the interface
Contextconfigure router string isis number interface string ipv6-unicast boolean
Treeipv6-unicast
Defaulttrue
Introduced16.0.R1

Platforms

All

level [level-number] keyword
Synopsis Enter the level list instance
Context configure router string isis number interface string level keyword
Treelevel
Max. Instances2
Introduced16.0.R1

Platforms

All

[level-number] keyword
Synopsis ISIS protocol level number
Context configure router string isis number interface string level keyword
Treelevel
Options1, 2

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

hello-authentication-key string
Synopsis Authentication key for Hello PDUs
Context configure router string isis number interface string level keyword hello-authentication-key string
Treehello-authentication-key

Description

This command configures the authentication key (password) for Hello PDUs. Both the Hello authentication key and the Hello authentication type on a segment must match.

If both IS-IS and Hello authentication are configured, Hello messages are validated using Hello authentication. If only IS-IS authentication is configured, it is used to authenticate all IS-IS (including Hello) protocol PDUs.

String Length1 to 366
Introduced16.0.R1

Platforms

All

hello-authentication-type keyword
Synopsis Hello authentication enabled on the context
Contextconfigure router string isis number interface string level keyword hello-authentication-type keyword
Treehello-authentication-type

Description

This command enables Hello authentication at the level context. Both the Hello authentication key and the Hello authentication type on a segment must match. The Hello authentication-key statement must also be included.

Optionspassword, message-digest
Introduced16.0.R1

Platforms

All

hello-interval number
Synopsis Interval between Hello messages sent on this level
Contextconfigure router string isis number interface string level keyword hello-interval number
Treehello-interval
Range1 to 20000
Unitsseconds
Default 9
Introduced16.0.R1

Platforms

All

hello-multiplier number
Synopsis Hello messages missed from neighbor before router declares adjacency down
Contextconfigure router string isis number interface string level keyword hello-multiplier number
Treehello-multiplier
Range2 to 100
Default3
Introduced 16.0.R1

Platforms

All

metric number
Synopsis IS-IS interface metric applied for IPv4 unicast
Contextconfigure router string isis number interface string level keyword metric number
Treemetric
Range1 to 16777215
Introduced16.0.R1

Platforms

All

priority number
Synopsis Router to become the designated router on a multi-access network
Contextconfigure router string isis number interface string level keyword priority number
Treepriority
Range0 to 127
Default64
Introduced 16.0.R1

Platforms

All

sd-offset number
Synopsis Value of the signal degrade offset
Context configure router string isis number interface string level keyword sd-offset number
Treesd-offset
Range1 to 16777215
Introduced16.0.R1

Platforms

All

sf-offset number
Synopsis Value of the signal fail offset
Context configure router string isis number interface string level keyword sf-offset number
Treesf-offset
Range1 to 16777215
Introduced16.0.R1

Platforms

All

loopfree-alternate
Synopsis Enter the loopfree-alternate context
Contextconfigure router string isis number interface string loopfree-alternate
Treeloopfree-alternate
Introduced16.0.R3

Platforms

All

policy-map
Synopsis Enable the policy-map context
Context configure router string isis number interface string loopfree-alternate policy-map
Treepolicy-map
Introduced16.0.R3

Platforms

All

mesh-group
Synopsis Enable the mesh-group context
Context configure router string isis number interface string mesh-group
Treemesh-group
Introduced16.0.R1

Platforms

All

blocked
Synopsis Prevent the interface from flooding LSPs
Contextconfigure router string isis number interface string mesh-group blocked
Treeblocked

Notes

The following elements are part of a choice: blocked or value.

Introduced16.0.R1

Platforms

All

value number
Synopsis Mesh group for the interface
Context configure router string isis number interface string mesh-group value number
Treevalue
Range1 to 2000000000

Notes

The following elements are part of a choice: blocked or value.

Introduced16.0.R1

Platforms

All

passive boolean
Synopsis Passive interface
Context configure router string isis number interface string passive boolean
Treepassive
Defaultfalse
Introduced16.0.R1

Platforms

All

retransmit-interval number
Synopsis Minimum time between LSP PDU retransmissions on point-to-point interface
Contextconfigure router string isis number interface string retransmit-interval number
Treeretransmit-interval
Range1 to 65535
Unitsseconds
Default 5
Introduced16.0.R1

Platforms

All

tag number
Synopsis Route tag for IP address of interface
Contextconfigure router string isis number interface string tag number
Treetag
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

ipv4-routing boolean
Synopsis Support IPv4 routing for IS-IS instance
Contextconfigure router string isis number ipv4-routing boolean
Treeipv4-routing
Defaulttrue
Introduced16.0.R1

Platforms

All

ipv6-routing keyword
Synopsis Routing topology for IPv6
Context configure router string isis number ipv6-routing keyword
Treeipv6-routing
Optionsfalse, native, mt
Defaultfalse
Introduced16.0.R1

Platforms

All

ldp-over-rsvp boolean
Synopsis Allow LDP over RSVP processing
Context configure router string isis number ldp-over-rsvp boolean
Treeldp-over-rsvp
Defaultfalse
Introduced16.0.R1

Platforms

All

ldp-sync boolean
Synopsis Use IGP-LDP synchronization feature on all interfaces participating in IS-IS routing protocol
Contextconfigure router string isis number ldp-sync boolean
Treeldp-sync
Defaulttrue
Introduced16.0.R1

Platforms

All

level [level-number] keyword
Synopsis Enter the level list instance
Context configure router string isis number level keyword
Treelevel
Max. Instances2
Introduced16.0.R1

Platforms

All

[level-number] keyword
Synopsis ISIS protocol level number
Context configure router string isis number level keyword
Treelevel
Options1, 2

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis Authentication key to verify PDUs sent on the interface
Contextconfigure router string isis number level keyword authentication-key string
Treeauthentication-key

Description

This command sets the authentication key used to verify PDUs sent by neighboring routers on the interface.

Neighboring routers use passwords to authenticate PDUs sent from an interface. For authentication to work, both the authentication key and the authentication type on a segment must match. The authentication-type command must also be included.

String Length1 to 366
Introduced16.0.R1

Platforms

All

bier
Synopsis Enter the bier context
Context configure router string isis number level keyword bier
Treebier
Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of BIER
Context configure router string isis number level keyword bier admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

All

hello-padding keyword
Synopsis Padding on IS-IS Hello packets
Context configure router string isis number level keyword hello-padding keyword
Treehello-padding
Optionsadaptive, loose, strict, none
Introduced 16.0.R1

Platforms

All

lsp-mtu-size number
WARNING:

Modifying this element requires the admin-state of the parent element to be toggled manually for the new value to take effect.

SynopsisLSP MTU size
Contextconfigure router string isis number level keyword lsp-mtu-size number
Treelsp-mtu-size
Range490 to 9778
Unitsbytes
Default 1492
Introduced16.0.R1

Platforms

All

preference number
Synopsis External route preference at level
Context configure router string isis number level keyword preference number
Treepreference
Range1 to 255
Introduced16.0.R1

Platforms

All

link-group [link-group-name] string
Synopsis Enter the link-group list instance
Contextconfigure router string isis number link-group string
Treelink-group
Introduced16.0.R1

Platforms

All

[link-group-name] string
Synopsis Link group name for the IS-IS protocol
Contextconfigure router string isis number link-group string
Treelink-group
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

level [level-number] keyword
Synopsis Enter the level list instance
Context configure router string isis number link-group string level keyword
Treelevel
Max. Instances2
Introduced16.0.R1

Platforms

All

[level-number] keyword
Synopsis ISIS protocol level number
Context configure router string isis number link-group string level keyword
Treelevel
Options1, 2

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

member [interface-name] reference
Synopsis Add a list entry for member
Context configure router string isis number link-group string level keyword member reference
Treemember
Max. Instances8
Introduced16.0.R1

Platforms

All

[interface-name] reference
Synopsis Router interface name for this link group
Contextconfigure router string isis number link-group string level keyword member reference
Treemember

Reference

configure router string isis number interface string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

revert-members number
Synopsis Minimum number of operational links to return link group to normal state and remove offsets
Contextconfigure router string isis number link-group string level keyword revert-members number
Treerevert-members
Range1 to 8
Introduced16.0.R1

Platforms

All

loopfree-alternate
Synopsis Enable the loopfree-alternate context
Contextconfigure router string isis number loopfree-alternate
Treeloopfree-alternate
Introduced16.0.R1

Platforms

All

augment-route-table boolean
Synopsis Attach remote LFA information to RTM entries
Contextconfigure router string isis number loopfree-alternate augment-route-table boolean
Treeaugment-route-table

Description

When configured to true, this command enables IS-IS to attach remote LFA-specific information to RTM entries for use by protocols such as LDP.

When configured to false, rLFA-specific information is not added to RTM entries.

Defaultfalse
Introduced19.10.R1

Platforms

All

exclude
Synopsis Enter the exclude context
Context configure router string isis number loopfree-alternate exclude
Treeexclude
Introduced16.0.R3

Platforms

All

prefix-policy reference
Synopsis Policy to exclude prefixes from LFA SPF calculation
Contextconfigure router string isis number loopfree-alternate exclude prefix-policy reference
Treeprefix-policy

Description

This command specifies the name of the policy for the prefixes to exclude from the LFA SPF calculation.

An excluded prefix is not included in LFA calculation regardless of its priority. The prefix tag is, however, used in the main SPF.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R3

Platforms

All

multi-homed-prefix
Synopsis Enable the multi-homed-prefix context
Contextconfigure router string isis number loopfree-alternate multi-homed-prefix
Treemulti-homed-prefix

Description

Commands in this context enable multihomed prefix LFA for IS-IS routes (IP FRR), SR-ISIS tunnels, and SRv6-ISIS tunnels.

This feature uses the multihomed prefix model described in RFC 8518 to compute a backup IP next hop using an alternate ABR or ASBR for external prefixes and to an alternate router owner for local anycast prefixes.

This feature further enhances the multihomed prefix backup path calculation beyond RFC 8518 with the addition of repair tunnels that make use of a PQ node or a P-Q set to reach the alternate exit ABR or ASBR of external prefixes or the alternate owner router of intra-area anycast prefixes.

The computed IP next hop-based backup path is added to IS-IS routes of external /32 prefixes or /128 prefixes and intra-area /32 or /128 anycast prefixes in the RTM if the prefix is not protected by the base LFA or if the user set leaf preference command option is configured to all. The user must enable the configure routing-options ip-fast-reroute command to have these backup paths programmed into the FIB in the datapath.

The computed IP next hop or repair tunnel-based backup path is also programmed for:

  •  SR-ISIS node SID tunnels of external /32 IPv4 prefixes and /128 IPv6 prefixes, and node SID tunnels of intra-area /32 IPv4 anycast prefixes and /128 anycast IPv6 prefixes, in both algorithm 0 and flexible-algorithms

  •  SRv6-ISIS locator routes and tunnels of external prefixes and of intra-area anycast prefixes of any size, in both algorithm 0 and flexible algorithm numbers.

As a result, an SR-TE LSP, an SR-MPLS policy, or an SRv6 policy which uses an SR-ISIS SID or an SRv6-ISIS SID of those same prefixes in its configured or computed SID list benefits from the multihomed prefix LFA protection.

Once the IP next-hop based multihomed prefix LFA is enabled, the extensions to compute an SR-TE repair tunnel for the multihomed prefix LFA in the case of SR-ISIS and SRv6-ISIS are automatically enabled if the user also enabled TI-LFA or Remote LFA. The computation reuses the SID list of the primary path or of the TI-LFA or Remote LFA backup path of the alternate ABR or ASBR or alternate owner router.

Introduced22.7.R1

Platforms

All

remote-lfa
Synopsis Enable the remote-lfa context
Context configure router string isis number loopfree-alternate remote-lfa
Treeremote-lfa
Introduced16.0.R1

Platforms

All

ti-lfa
Synopsis Enable the ti-lfa context
Context configure router string isis number loopfree-alternate ti-lfa
Treeti-lfa

Description

Commands in this context configure the Topology-Independent Loop-Free Alternate (TI-LFA) algorithm used in the LFA Shortest Path First (SPF) calculation for this IS-IS instance.

Introduced16.0.R1

Platforms

All

max-sr-frr-labels number
Synopsis Maximum number of labels the TI-LFA backup path can use
Contextconfigure router string isis number loopfree-alternate ti-lfa max-sr-frr-labels number
Treemax-sr-frr-labels

Description

This command configures the maximum number of labels allowed in the segment list of the TI-LFA repair tunnel. A higher value results in better coverage by TI-LFA at the expense of increased packet encapsulation overhead. The TI-LFA algorithm uses this value to limit the search for the Q-node from the P-node on the post-convergence path.

Range0 to 3
Default2
Introduced 16.0.R1

Platforms

All

max-srv6-frr-sids number
Synopsis Maximum number of SIDs the TI-LFA backup path can use
Contextconfigure router string isis number loopfree-alternate ti-lfa max-srv6-frr-sids number
Treemax-srv6-frr-sids

Description

This command configures the maximum number of SRv6 SIDs allowed in the segment list of the TI-LFA repair tunnel. A higher value results in better coverage by TI-LFA at the expense of increased packet encapsulation overhead. The TI-LFA algorithm uses this value to limit the search for the Q-node from the P-node on the post-convergence path

Range0 to 3
Default1
Introduced 22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

lsp-lifetime number
WARNING:

Modifying this element requires the admin-state of the parent element to be toggled manually for the new value to take effect.

SynopsisAmount of time during which an LSP is considered valid
Contextconfigure router string isis number lsp-lifetime number
Treelsp-lifetime
Range350 to 65535
Unitsseconds
Default 1200
Introduced16.0.R1

Platforms

All

lsp-mtu-size number
WARNING:

Modifying this element requires the admin-state of the parent element to be toggled manually for the new value to take effect.

SynopsisLSP MTU size
Contextconfigure router string isis number lsp-mtu-size number
Treelsp-mtu-size
Range490 to 9778
Unitsbytes
Default 1492
Introduced16.0.R1

Platforms

All

lsp-refresh
Synopsis Enter the lsp-refresh context
Context configure router string isis number lsp-refresh
Treelsp-refresh
Introduced16.0.R1

Platforms

All

interval number
Synopsis Refresh timer interval
Context configure router string isis number lsp-refresh interval number
Treeinterval
Range150 to 65535
Unitsseconds
Default 600
Introduced16.0.R1

Platforms

All

mru-mismatch-detection boolean
Synopsis Enable detection of MRU mismatch
Context configure router string isis number mru-mismatch-detection boolean
Treemru-mismatch-detection

Description

When configured to true, this command verifies that the received IS-IS Hello (IIH) packet size does not exceed the configured maximum port MTU size. The received IIH packet is dropped when its size exceeds the maximum port MTU size.

When configured to false, the IS-IS router instance will not drop oversized IIH packets.

By default, FP-based hardware can receive oversized packets but it will not originate them.

Defaultfalse
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

multi-topology
Synopsis Enable the multi-topology context
Contextconfigure router string isis number multi-topology
Treemulti-topology
Introduced16.0.R1

Platforms

All

multicast-import
Synopsis Enter the multicast-import context
Contextconfigure router string isis number multicast-import
Treemulticast-import
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Submit IPv4 routes into the multicast RPF of the RTM
Contextconfigure router string isis number multicast-import ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Submit IPv6 routes into the multicast RPF of the RTM
Contextconfigure router string isis number multicast-import ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

overload
Synopsis Enable the overload context
Context configure router string isis number overload
Treeoverload
Introduced16.0.R1

Platforms

All

max-metric boolean
Synopsis Advertise transit links with maximum metric instead of setting overload bit
Contextconfigure router string isis number overload max-metric boolean
Treemax-metric
Defaultfalse
Introduced16.0.R1

Platforms

All

overload-fib-error-notify-only
Synopsis Enable the overload-fib-error-notify-only context
Contextconfigure router string isis number overload-fib-error-notify-only
Treeoverload-fib-error-notify-only

Description

Commands in this context configure the IS-IS router to send a notification when an overload condition occurs while programming the FIB, instead of advertising the overload condition of the router in the IS-IS LSP.

Note: Nokia recommends being careful using this command. When you configure the router not to advertise the IS-IS overload state in the IS-IS LSP, other routers are not instructed to take the overloaded router out of the IS-IS forwarding topology and this will cause suboptimal forwarding and non-deterministic behavior on the overloaded router. To avoid changing the default IS-IS overflow behavior, leave this command disabled.

When this command is configured, the IS-IS router enters a suboptimal state where it sends only a notification trap; transit traffic can still use the router in this state.

The IS-IS router tracks the segment routing prefix SIDs where FIB programming failed. With the retry command configured, the router retries programming the segment routing prefix SIDs in the FIB using this tracked information.

When this command is not configured, during normal operation, the system may force the router to enter an overload state because of a lack of FIB resources. In this state, the router is used to terminate traffic and is not used to transit traffic.

Introduced23.7.R1

Platforms

All

retry number
Synopsis Time to retry programming failed entries in the FIB
Contextconfigure router string isis number overload-fib-error-notify-only retry number
Treeretry

Description

This command configures the time the router uses to retry programming the failed entries in the FIB.

The overload-fib-error-notify-only command must be configured to use the retry timer. The removal of the overload-fib-error-notify-only configuration causes the system to program the failed entries in the FIB by triggering an immediate SPF.

Range10 to 1800
Unitsseconds
Default 10
Introduced23.7.R1

Platforms

All

overload-include-locators boolean
Synopsis Advertise SRv6 locators if IS-IS instance overloads
Contextconfigure router string isis number overload-include-locators boolean
Treeoverload-include-locators

Description

When configured to true, if the IS-IS instance goes into overload (because of resource depletion or manual configuration), the router includes SRv6 locators when it advertises links and prefixes with max-metric.

Defaultfalse
Introduced23.10.R1

Platforms

All

overload-on-boot
Synopsis Enable the overload-on-boot context
Contextconfigure router string isis number overload-on-boot
Treeoverload-on-boot
Introduced16.0.R1

Platforms

All

max-metric boolean
Synopsis Advertise transit links with maximum metric instead of setting overload bit
Contextconfigure router string isis number overload-on-boot max-metric boolean
Treemax-metric
Defaultfalse
Introduced16.0.R1

Platforms

All

timeout number
Synopsis Time during which the router operates in overload state after reboot
Contextconfigure router string isis number overload-on-boot timeout number
Treetimeout
Range60 to 1800
Unitsseconds
Introduced 16.0.R1

Platforms

All

poi-tlv boolean
Synopsis Purge Originator Identification TLV
Context configure router string isis number poi-tlv boolean
Treepoi-tlv
Defaultfalse
Introduced16.0.R1

Platforms

All

prefix-attributes-tlv boolean
Synopsis Use IS-IS Prefix Attributes TLV to exchange extended IPv4 and IPv6 reachability information
Contextconfigure router string isis number prefix-attributes-tlv boolean
Treeprefix-attributes-tlv
Defaultfalse
Introduced16.0.R1

Platforms

All

prefix-limit
Synopsis Enable the prefix-limit context
Contextconfigure router string isis number prefix-limit
Treeprefix-limit
Introduced16.0.R1

Platforms

All

limit number
Synopsis Maximum number of prefixes for IS-IS instance
Contextconfigure router string isis number prefix-limit limit number
Treelimit
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

log-only boolean
Synopsis Send warning message when the prefix limit is reached
Contextconfigure router string isis number prefix-limit log-only boolean
Treelog-only
Defaultfalse
Introduced16.0.R1

Platforms

All

overload-timeout (number | keyword)
Synopsis Time in overload state when prefix limit is reached
Contextconfigure router string isis number prefix-limit overload-timeout (number | keyword)
Treeoverload-timeout
Range1 to 1800
Unitsseconds
Options forever
Defaultforever
Introduced 16.0.R1

Platforms

All

prefix-unreachable
Synopsis Enter the prefix-unreachable context
Contextconfigure router string isis number prefix-unreachable
Treeprefix-unreachable
Introduced24.3.R1

Platforms

All

maximum-number-upas number
Synopsis Maximum number of UPAs the router can advertise
Contextconfigure router string isis number prefix-unreachable maximum-number-upas number
Treemaximum-number-upas

Description

This command configures a limit for the number of UPAs the router can advertise. If overrun, a system log is generated and additional UPAs are not advertised.

Range1 to 8192
Default32
Introduced 24.3.R1

Platforms

All

process-received-upa boolean
Synopsis Process received UPA
Context configure router string isis number prefix-unreachable process-received-upa boolean
Treeprocess-received-upa

Description

When configured to true, the router enables processing of received UPAs from other routers. Received UPAs are inserted into the unicast routing table as unreachable prefixes. When configured on an Area Boundary Router (ABR), received UPAs are inserted into the unreachable prefix table and redistributed into the other areas.

When configured to false, received UPAs are ignored by the router.

Defaultfalse
Introduced24.3.R1

Platforms

All

psnp-authentication boolean
Synopsis Authenticate individual IS-IS protocol packets of partial sequence number PDU (PSNP) type
Contextconfigure router string isis number psnp-authentication boolean
Treepsnp-authentication
Defaulttrue
Introduced16.0.R1

Platforms

All

reference-bandwidth number
Synopsis Reference bandwidth for bandwidth relative costing
Contextconfigure router string isis number reference-bandwidth number
Treereference-bandwidth
Range1 to 18446744073709551615
Unitskilobps
Introduced16.0.R1

Platforms

All

rib-priority
Synopsis Enter the rib-priority context
Contextconfigure router string isis number rib-priority
Treerib-priority
Introduced16.0.R1

Platforms

All

high
Synopsis Enter the high context
Context configure router string isis number rib-priority high
Treehigh
Introduced16.0.R1

Platforms

All

prefix-list reference
Synopsis List used to select routes processed at higher priority through OSPF route calculation process
Contextconfigure router string isis number rib-priority high prefix-list reference
Treeprefix-list

Reference

configure policy-options prefix-list string

Notes

The following elements are part of a choice: prefix-list or tag.

Introduced16.0.R1

Platforms

All

tag number
Synopsis Tag value that is used to match IS-IS routes
Contextconfigure router string isis number rib-priority high tag number
Treetag
Range1 to 4294967295

Notes

The following elements are part of a choice: prefix-list or tag.

Introduced16.0.R1

Platforms

All

router-id string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUnique router ID for the ISIS instance
Contextconfigure router string isis number router-id string
Treerouter-id
Introduced16.0.R1

Platforms

All

segment-routing
Synopsis Enter the segment-routing context
Contextconfigure router string isis number segment-routing
Treesegment-routing
Introduced16.0.R1

Platforms

All

adj-sid-hold (number | keyword)
Synopsis Adjacency SID hold time
Context configure router string isis number segment-routing adj-sid-hold (number | keyword)
Treeadj-sid-hold

Description

This command configures a timer to hold the ILM or LTN of an adjacency SID following a failure of the adjacency.

When an adjacency to a neighbor fails, the following procedure is followed for both an LFA protected and the LFA unprotected SID of this adjacency in SR-MPLS. An adjacency can have both types of SIDs assigned by configuration. An LFA protected adjacency SID is eligible for LFA protection, however, the following procedure applies even if an LFA backup is not programmed at the time of the failure. An LFA unprotected adjacency SID is not eligible for LFA protection.

  • IGP withdraws the advertisement of the link TLV as well as its adjacency SID sub-TLV.

  • The adjacency SID hold timer starts.

  • The LTN and ILM records of the adjacency are kept in the datapath for as long as the adjacency SID hold time is running. This allows packets to flow over the LFA backup path, when the adjacency is protected, and allows the ingress LER or PCE time to compute a new path of the SR-TE LSP after IGP converges.

  • If the adjacency is restored while the adjacency SID hold timer is running, the timer is aborted, and the adjacency SID remains programmed in the datapath with the retained SID values. However, the backup NHLFE may change if a new LFA SPF runs while the adjacency SID hold timer running. An update to the backup NHLFE is performed immediately following the LFA SPF. In all cases, the adjacency keeps its assigned SID label value.

  • If the adjacency SID hold timer expires before the adjacency is restored, the SID is deprogrammed from the datapath and the label returned into the common pool where it was drawn from. Users of the adjacency (for example, SR policy and SR-TE LSP) are also informed. When the adjacency is subsequently restored, it gets assigned its allocated static-label value or a new dynamic-label value.

  • A new PG-ID is assigned each time an adjacency comes back up. This PG-ID is used by the ILM and LTN of the adjacency SID and of all downstream node SIDs that resolve to a next hop over this adjacency.

Range1 to 1800
Unitsseconds
Options none
Default 15
Introduced16.0.R1

Platforms

All

adjacency-set [id] number
Synopsis Enter the adjacency-set list instance
Contextconfigure router string isis number segment-routing adjacency-set number
Treeadjacency-set
Introduced16.0.R1

Platforms

All

adjacency-sid
Synopsis Enter the adjacency-sid context
Contextconfigure router string isis number segment-routing adjacency-sid
Treeadjacency-sid
Introduced22.7.R1

Platforms

All

allocate-dual-sids boolean
Synopsis Allocate dual adjacency SIDs per interface
Contextconfigure router string isis number segment-routing adjacency-sid allocate-dual-sids boolean
Treeallocate-dual-sids

Description

When configured to true, the router supports two SR-MPLS adjacency SIDs per interface. A protected and unprotected adjacency SID is instantiated and advertised. If an SR-MPLS adjacency SID already exists, an additional complementary (protected or unprotected) adjacency SID is created on the interface.

When configured to false, the router disables the support of two SR-MPLS adjacency SIDs per interface.

Defaultfalse
Introduced22.7.R1

Platforms

All

class-forwarding boolean
Synopsis Allow CBF with ECMP over RSVP-TE LSPs as IGP shortcuts
Contextconfigure router string isis number segment-routing class-forwarding boolean
Treeclass-forwarding

Description

When configured to true, this command enables Class-Based Forwarding (CBF) with ECMP for SR-ISIS resolved to RSVP-TE LSPs as IGP shortcuts.

For CBF with ECMP to be effective, a class forwarding policy must be defined, as well as FC to set associations and RSVP-TE LSPs to set associations.

When configured to false, CBF over IGP shortcuts is disabled.

Defaultfalse
Introduced20.2.R1

Platforms

All

egress-statistics
Synopsis Enter the egress-statistics context
Contextconfigure router string isis number segment-routing egress-statistics
Treeegress-statistics
Introduced19.10.R1

Platforms

All

adj-set boolean
Synopsis Enable the allocation of statistics on adjacency sets
Contextconfigure router string isis number segment-routing egress-statistics adj-set boolean
Treeadj-set

Description

When configured to true, this command enables the allocation of statistic indices to each adjacency set. All adjacencies of a set share the same statistics index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

adj-sid boolean
Synopsis Enable the allocation of statistics on adjacency SIDs
Contextconfigure router string isis number segment-routing egress-statistics adj-sid boolean
Treeadj-sid

Description

When configured to true, this command enables the allocation of statistic indexes to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

ingress-statistics
Synopsis Enter the ingress-statistics context
Contextconfigure router string isis number segment-routing ingress-statistics
Treeingress-statistics
Introduced19.10.R1

Platforms

All

adj-set boolean
Synopsis Enable the allocation of statistics on adjacency sets
Contextconfigure router string isis number segment-routing ingress-statistics adj-set boolean
Treeadj-set

Description

When configured to true, this command enables the allocation of statistic indices to each adjacency set. All adjacencies of a set share the same statistics index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

adj-sid boolean
Synopsis Enable the allocation of statistics on adjacency SIDs
Contextconfigure router string isis number segment-routing ingress-statistics adj-sid boolean
Treeadj-sid

Description

When configured to true, this command enables the allocation of statistic indexes to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

mapping-server
Synopsis Enter the mapping-server context
Contextconfigure router string isis number segment-routing mapping-server
Treemapping-server
Introduced16.0.R1

Platforms

All

node-sid-map [sid-index] number
Synopsis Enter the node-sid-map list instance
Contextconfigure router string isis number segment-routing mapping-server node-sid-map number
Treenode-sid-map
Introduced16.0.R1

Platforms

All

maximum-sid-depth
Synopsis Enter the maximum-sid-depth context
Contextconfigure router string isis number segment-routing maximum-sid-depth
Treemaximum-sid-depth
Introduced20.2.R1

Platforms

All

override-bmi number
Synopsis Value to override the announced node MSD-BMI value
Contextconfigure router string isis number segment-routing maximum-sid-depth override-bmi number
Treeoverride-bmi

Description

This command overrides the announced MSD node Base MPLS Imposition (BMI) value. The MSD-BMI value announced by a router can be used by recipients to understand the number of MPLS labels that can be imposed inclusive of all service, transport, or special labels.

When unconfigured, the router announces the maximum supported BMI of the node assuming the most simple services and Layer 2 encapsulation.

Range0 to 12
Introduced20.2.R1

Platforms

All

override-erld number
Synopsis Value to override the announced node MSD-ERLD value
Contextconfigure router string isis number segment-routing maximum-sid-depth override-erld number
Treeoverride-erld

Description

This command configures the override Entropy Readable Label Depth (ERLD) Maximum Sid Depth (MSD) value. Information about the capability of each intermediate LSR of reading the maximum label stack depth is used by ingress LSRs to perform EL-based load balancing.

When unconfigured, the router announces the node maximum supported ERLD assuming the most simple Layer 2 encapsulation.

Range0 to 15
Introduced20.2.R1

Platforms

All

micro-loop-avoidance
Synopsis Enable the micro-loop-avoidance context
Contextconfigure router string isis number segment-routing micro-loop-avoidance
Treemicro-loop-avoidance

Description

Commands in this context configure the micro-loop avoidance feature in the IGP instance. This feature prevents micro-loops from using Segment Routing (SR) loop-free tunnels for packets that are forwarded over SR IS-IS node SID tunnels.

Introduced19.10.R1

Platforms

All

fib-delay number
Synopsis FIB delay before programming new primary next-hops
Contextconfigure router string isis number segment-routing micro-loop-avoidance fib-delay number
Treefib-delay

Description

This command specifies the delay time before programming the new next-hops for the SR tunnel.

Range1 to 300
Unitsdeciseconds
Default 15
Introduced19.10.R1

Platforms

All

multi-topology
Synopsis Enter the multi-topology context
Contextconfigure router string isis number segment-routing multi-topology
Treemulti-topology
Introduced23.10.R1

Platforms

All

mt2 boolean
Synopsis Support IPv6 routing topology (MT2)
Context configure router string isis number segment-routing multi-topology mt2 boolean
Treemt2

Description

When configured to true, the router enables SR-MPLS for MS-ISIS MT, which enables Segment Routing in MT2.

Defaultfalse
Introduced23.10.R1

Platforms

All

prefix-sid-range
Synopsis Enable the prefix-sid-range context
Contextconfigure router string isis number segment-routing prefix-sid-range
Treeprefix-sid-range

Description

Commands in this context configure the label block BGP segment routing can use.

Introduced16.0.R1

Platforms

All

global
Synopsis Allocate labels from the SRBG space
Context configure router string isis number segment-routing prefix-sid-range global
Treeglobal

Description

When configured, the system allows BGP to allocate labels from the SRGB space, as defined under the configure router mpls-labels sr-labels context.

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R1

Platforms

All

max-index number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUpper bound value for the local SID index
Contextconfigure router string isis number segment-routing prefix-sid-range max-index number
Treemax-index
Range0 to 524287
Default1

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R1

Platforms

All

start-label number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLower bound value for the local label offset
Contextconfigure router string isis number segment-routing prefix-sid-range start-label number
Treestart-label
Range0 to 524287
Default0

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R1

Platforms

All

tunnel-table-pref number
Synopsis Preference of SR tunnels created by the IGP instance
Contextconfigure router string isis number segment-routing tunnel-table-pref number
Treetunnel-table-pref

Description

This command configures the TTM preference of SR tunnels created by the IGP instance. This is used in the case of BGP shortcuts, VPRN auto-bind, or BGP transport tunnel when the new tunnel binding commands are configured to the any value which parses the TTM for tunnels in the protocol preference order. The user can choose to either go with the global TTM preference or list explicitly the tunnel types they want to use. When they list the tunnel types explicitly, the TTM preference is still used to select one type over the other. In both cases, a fallback to the next preferred tunnel type is performed if the selected one fails. Also, a reversion to a more preferred tunnel type is performed as soon as one is available.

The segment routing module adds to TTM a SR tunnel entry for each resolved remote node SID prefix and programs the data path with the corresponding LTN with the push operation pointing to the primary and LFA backup NHLFEs.

The default preference for SR tunnels in the TTM is set lower than LDP tunnels but higher than BGP tunnels to allow controlled migration of customers without disrupting their current deployment when they enable segment routing. The following is the setting of the default preference of the various tunnel types. This includes the preference of SR tunnels based on shortest path (referred to as SR-ISIS and SR-OSPF).

The global default TTM preference for the tunnel types is as follows:

  • ROUTE_PREF_RSVP 7

  • ROUTE_PREF_SR_TE 8

  • ROUTE_PREF_LDP 9

  • ROUTE_PREF_OSPF_TTM 10

  • ROUTE_PREF_ISIS_TTM 11

  • ROUTE_PREF_BGP_TTM 12

  • ROUTE_PREF_GRE 255

The default value for SR-ISIS or SR-OSPF is the same regardless if one or more IS-IS or OSPF instances programmed a tunnel for the same prefix. The selection of a SR tunnel in this case will be based on lowest IGP instance-id.

It is recommended to not set two or more tunnel types to the same preference value. In such a situation, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default11
Introduced 16.0.R1

Platforms

All

segment-routing-v6
Synopsis Enter the segment-routing-v6 context
Contextconfigure router string isis number segment-routing-v6
Treesegment-routing-v6
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

adj-sid-hold (number | keyword)
Synopsis Adjacency SID hold time
Context configure router string isis number segment-routing-v6 adj-sid-hold (number | keyword)
Treeadj-sid-hold

Description

This command specifies the length of time the system holds the SRv6 adjacency route and tunnel entries programmed in datapath while the adjacency is down.

When an adjacency to a neighbor fails, the following procedure is followed for both an LFA protected and the LFA unprotected SID of this adjacency in SR-MPLS. An adjacency can have both types of SIDs assigned by configuration. An LFA protected adjacency SID is eligible for LFA protection, however, the following procedure applies even if an LFA backup is not programmed at the time of the failure. An LFA unprotected adjacency SID is not eligible for LFA protection.

  • IGP withdraws the advertisement of the link TLV as well as its SRv6 End.X SID sub-TLV

  • The adjacency SID hold timer starts.

  • The route table, FIB, and tunnel table entries are kept for as long as the adjacency SID hold timer is running. This is allows packets to flow over the LFA backup path, if the adjacency is protected, and allows the ingress LER or PCE time to compute a new path of a SRv6 policy after IGP converges.

  • If the adjacency is restored while the adjacency SID hold timer is running, the timer is aborted, and the adjacency SID remains programmed in the datapath with the retained SID values. However, the backup NHLFE may change when a new LFA SPF is run while the adjacency SID hold timer is running. An update to the backup NHLFE is performed immediately following the LFA SPF. In all cases, the adjacency keeps its assigned SID value.

  • If the adjacency SID hold timer expires before the adjacency is restored, the SID is deprogrammed from the datapath and the SID value returned into the locator subnet where it was drawn from. Users of the adjacency (for example, SRv6 policy) are also informed. When the adjacency is subsequently restored, it gets assigned its allocated static SID value or a new dynamic SID value.

  • A new PG-ID is assigned each time an adjacency comes back up. This PG-ID is used by tunnel of the local adjacency SID and of all remote locator routes that resolve to a next hop over this adjacency.

Each IS-IS instance runs a single timer per adjacency that IPv4 SR-MPLS, IPv6 SR-MPLS, and SRv6 adjacency SIDs share. When you enable both SR-MPLS (configure router isis segment-routing) and SRv6 (configure router isis segment-routing-v6) in the IS-IS instance, the system programs the higher of the two timer values for all SIDs on the adjacency.

Range1 to 1800
Unitsseconds
Options none
Default 15
Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

admin-state keyword
Synopsis Administrative state of segment routing SRv6
Contextconfigure router string isis number segment-routing-v6 admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

locator [locator-name] reference
Synopsis Enter the locator list instance
Contextconfigure router string isis number segment-routing-v6 locator reference
Treelocator

Description

This command adds a reference to a locator for each algorithm in this IS-IS instance.

The same algorithm locator can be shared with other IGP instances and BGP instances in IP-VPN or EVPN.

Max. Instances8
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

level [level-number] keyword
Synopsis Enter the level list instance
Context configure router string isis number segment-routing-v6 locator reference level keyword
Treelevel
Max. Instances2
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[level-number] keyword
Synopsis ISIS protocol level number
Context configure router string isis number segment-routing-v6 locator reference level keyword
Treelevel
Options1, 2

Notes

This element is part of a list key.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

metric number
Synopsis IS-IS metric to advertise in the locator level list
Contextconfigure router string isis number segment-routing-v6 locator reference level keyword metric number
Treemetric
Range1 to 16777215
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

level-capability keyword
Synopsis IS-IS routing level capability
Context configure router string isis number segment-routing-v6 locator reference level-capability keyword
Treelevel-capability

Description

This command configures the routing level capability for an instance of the IS-IS routing process.

The level capability configured on the instance must match the level capability on the interface to form an adjacency.

Options1, 2, 1/2
Default1/2
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

multi-topology
Synopsis Enter the multi-topology context
Contextconfigure router string isis number segment-routing-v6 locator reference multi-topology
Treemulti-topology

Description

Commands in this context enable the use of a local SRv6 locator in an IS-IS IPv6 topology. A user can enable one or more locators in an IS-IS instance. Each locator can be enabled in a single topology of an IS-IS instance, topology 0 (MT0) or topology 2 (MT2). A local locator can be used in multiple IS-IS instances, but can only be assigned to at most one IPv6 topology independently within each IS-IS instance.

Use the configure router isis segment-routing-v6 admin-state command to enable the processing of local and remote IPv6 prefixes and SRv6 locators in MT0 and MT2. In addition, to enable SRv6 forwarding in the MT0, MT2, or both topologies, set the configure router isis ipv6-routing command to native, the configure router isis multi-topology ipv6-unicast command to true, or both.

Introduced22.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

tag number
Synopsis Route tag to advertise in the locator
Contextconfigure router string isis number segment-routing-v6 locator reference tag number
Treetag
Range1 to 4294967295
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

micro-segment-locator [locator-name] reference
Synopsis Enter the micro-segment-locator list instance
Contextconfigure router string isis number segment-routing-v6 micro-segment-locator reference
Treemicro-segment-locator
Max. Instances8
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

level [level-number] keyword
Synopsis Enter the level list instance
Context configure router string isis number segment-routing-v6 micro-segment-locator reference level keyword
Treelevel
Max. Instances2
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[level-number] keyword
Synopsis ISIS protocol level number
Context configure router string isis number segment-routing-v6 micro-segment-locator reference level keyword
Treelevel
Options1, 2

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

level-capability keyword
Synopsis IS-IS routing level capability
Context configure router string isis number segment-routing-v6 micro-segment-locator reference level-capability keyword
Treelevel-capability

Description

This command configures the routing level capability for an instance of the IS-IS routing process.

The level capability configured on the instance must match the level capability on the interface to form an adjacency.

Options1, 2, 1/2
Default1/2
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

multi-topology
Synopsis Enter the multi-topology context
Contextconfigure router string isis number segment-routing-v6 micro-segment-locator reference multi-topology
Treemulti-topology

Description

Commands in this context enable the use of a local SRv6 locator in an IS-IS IPv6 topology. A user can enable one or more locators in an IS-IS instance. Each locator can be enabled in a single topology of an IS-IS instance, topology 0 (MT0) or topology 2 (MT2). A local locator can be used in multiple IS-IS instances, but can only be assigned to at most one IPv6 topology independently within each IS-IS instance.

Use the configure router isis segment-routing-v6 admin-state command to enable the processing of local and remote IPv6 prefixes and SRv6 locators in MT0 and MT2. In addition, to enable SRv6 forwarding in the MT0, MT2, or both topologies, set the configure router isis ipv6-routing command to native, the configure router isis multi-topology ipv6-unicast command to true, or both.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

summary-address [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the summary-address list instance
Contextconfigure router string isis number summary-address (ipv4-prefix | ipv6-prefix)
Treesummary-address
Introduced16.0.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP prefix for the summary address
Context configure router string isis number summary-address (ipv4-prefix | ipv6-prefix)
Treesummary-address

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertise-unreachable
Synopsis Enable the advertise-unreachable context
Contextconfigure router string isis number summary-address (ipv4-prefix | ipv6-prefix) advertise-unreachable
Treeadvertise-unreachable

Description

Commands in this context enable Unreachable Prefix Announcements (UPAs) for summary member routes. A UPA is advertised for IPv4 and IPv6 summary member prefixes when a summary member prefix suddenly becomes unreachable. By default, all summary member prefixes are monitored for reachability.

Introduced24.3.R1

Platforms

All

advertise-route-tag number
Synopsis Route tag to advertise in UPA
Context configure router string isis number summary-address (ipv4-prefix | ipv6-prefix) advertise-unreachable advertise-route-tag number
Treeadvertise-route-tag

Description

This command configures a UPA route tag to add to the advertised UPA. The UPA route tag can be used when there are multiple Autonomous System Boundary Routers (ASBRs) redistributing prefixes between two Interior Gateway Protocol (IGP) areas.

Range1 to 4294967295
Introduced24.3.R1

Platforms

All

match-route-tag number
Synopsis Route tag to match UPA
Context configure router string isis number summary-address (ipv4-prefix | ipv6-prefix) advertise-unreachable match-route-tag number
Treematch-route-tag

Description

This command specifies the route tag to be used (by the router) as the basis to select a subset of summary member prefixes to monitor for reachability.

Range1 to 4294967295
Introduced24.3.R1

Platforms

All

algorithm number
Synopsis Algorithm topology for the summary address
Contextconfigure router string isis number summary-address (ipv4-prefix | ipv6-prefix) algorithm number
Treealgorithm
Range0 | 128 to 255
Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

route-tag number
Synopsis Route tag assigned to the summary address
Contextconfigure router string isis number summary-address (ipv4-prefix | ipv6-prefix) route-tag number
Treeroute-tag
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

system-id string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSystem ID
Contextconfigure router string isis number system-id string
Treesystem-id
String Length14
Default0000.0000.0000
Introduced 16.0.R1

Platforms

All

timers
Synopsis Enter the timers context
Context configure router string isis number timers
Treetimers
Introduced16.0.R1

Platforms

All

lsp-wait
Synopsis Enter the lsp-wait context
Context configure router string isis number timers lsp-wait
Treelsp-wait
Introduced16.0.R1

Platforms

All

lsp-max-wait number
Synopsis Maximum time between two consecutive LSP occurrences
Contextconfigure router string isis number timers lsp-wait lsp-max-wait number
Treelsp-max-wait
Range10 to 120000
Unitsmilliseconds
Default5000
Introduced 16.0.R1

Platforms

All

spf-wait
Synopsis Enter the spf-wait context
Context configure router string isis number timers spf-wait
Treespf-wait
Introduced16.0.R1

Platforms

All

spf-max-wait number
Synopsis Maximum interval amid two consecutive SPF calculations
Contextconfigure router string isis number timers spf-wait spf-max-wait number
Treespf-max-wait
Range10 to 120000
Unitsmilliseconds
Default10000
Introduced 16.0.R1

Platforms

All

traffic-engineering-options
Synopsis Enter the traffic-engineering-options context
Contextconfigure router string isis number traffic-engineering-options
Treetraffic-engineering-options
Introduced19.10.R1

Platforms

All

advertise-delay boolean
Synopsis Enable the advertisement of link delay for TE
Contextconfigure router string isis number traffic-engineering-options advertise-delay boolean
Treeadvertise-delay

Description

When configured to true, the router advertises link delay in the IGP LSDB within legacy Traffic Engineering (TE) attributes in IS-IS or within the Application-Specific Link Attribute (ASLA) when ASLA is enabled for SR-TE or RSVP-TE applications.

When the application-link-attributes legacy command is configured for SR-TE or RSVP-TE, link delay is advertised as a legacy TE TLV with the ASLA legacy bit set.

When configured to false, the router disables link delay advertisement.

Defaultfalse
Introduced22.10.R1

Platforms

All

application-link-attributes
Synopsis Enable the application-link-attributes context
Contextconfigure router string isis number traffic-engineering-options application-link-attributes
Treeapplication-link-attributes

Description

Commands in this context configure the traffic engineering behavior for the advertisement of TE attributes for each link on a per-application basis for RSVP-TE and SR-TE applications.

Introduced19.10.R1

Platforms

All

unicast-import
Synopsis Enter the unicast-import context
Contextconfigure router string isis number unicast-import
Treeunicast-import
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Submit IPv4 routes into unicast RTM
Context configure router string isis number unicast-import ipv4 boolean
Treeipv4
Defaulttrue
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Submit IPv6 routes into unicast RTM
Context configure router string isis number unicast-import ipv6 boolean
Treeipv6
Defaulttrue
Introduced16.0.R1

Platforms

All

l2tp

Synopsis Enter the l2tp context
Context configure router string l2tp
Treel2tp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of L2TP
Context configure router string l2tp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

avp-hiding keyword
Synopsis Attribute of the Value Pair (AVP) hiding algorithm
Contextconfigure router string l2tp avp-hiding keyword
Treeavp-hiding
Optionssensitive, always
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

challenge boolean
Synopsis Use challenge-response authentication
Contextconfigure router string l2tp challenge boolean
Treechallenge
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

destruct-timeout number
Synopsis Destruction timeout
Context configure router string l2tp destruct-timeout number
Treedestruct-timeout
Range60 to 86400
Unitsseconds
Default 60
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ethernet-tunnel
Synopsis Enter the ethernet-tunnel context
Contextconfigure router string l2tp ethernet-tunnel
Treeethernet-tunnel
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

reconnect-timeout (number | keyword)
Synopsis Timeout for a session setup retry
Context configure router string l2tp ethernet-tunnel reconnect-timeout (number | keyword)
Treereconnect-timeout
Range10 to 3600
Unitsseconds
Options infinite
Defaultinfinite
Introduced 16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

exclude-avps
Synopsis Enter the exclude-avps context
Contextconfigure router string l2tp exclude-avps
Treeexclude-avps
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string l2tp failover
Treefailover
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-max-session-lifetime number
Synopsis Subset of sessions that this system attempts to synchronize in the Session State Synchronization phase
Contextconfigure router string l2tp failover recovery-max-session-lifetime number
Treerecovery-max-session-lifetime
Range2 to 4294967295
Unitscentiseconds
Default2
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-method keyword
Synopsis Recovery method of the sequence numbers after failover
Contextconfigure router string l2tp failover recovery-method keyword
Treerecovery-method
Optionsmcs, recovery-tunnel
Defaultmcs
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-time number
Synopsis Time requested from the L2TP peer before assuming failover as failed
Contextconfigure router string l2tp failover recovery-time number
Treerecovery-time
Range0 to 900
Unitsseconds
Default 0
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

track-srrp [id] reference
Synopsis Enter the track-srrp list instance
Contextconfigure router string l2tp failover track-srrp reference
Treetrack-srrp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[id] reference
Synopsis SRRP instance ID for multi-chassis redundancy failover
Contextconfigure router string l2tp failover track-srrp reference
Treetrack-srrp

Reference

configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone) sync track-srrp number

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer reference
Synopsis Multi-chassis peer address
Context configure router string l2tp failover track-srrp reference peer reference
Treepeer

Reference

configure redundancy multi-chassis peer (ipv4-address-no-zone | ipv6-address-no-zone)

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sync-tag string
Synopsis Synchronization tag on the multi-chassis peer
Contextconfigure router string l2tp failover track-srrp reference sync-tag string
Treesync-tag
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

group [tunnel-group-name] string
Synopsis Enter the group list instance
Context configure router string l2tp group string
Treegroup
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[tunnel-group-name] string
Synopsis Tunnel group name
Context configure router string l2tp group string
Treegroup
String Length1 to 63

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the L2TP tunnel group
Contextconfigure router string l2tp group string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

avp-hiding keyword
Synopsis The AVP hiding algorithm
Context configure router string l2tp group string avp-hiding keyword
Treeavp-hiding
Optionsnever, sensitive, always
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

challenge keyword
Synopsis Enable use of challenge-response authentication
Contextconfigure router string l2tp group string challenge keyword
Treechallenge
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string l2tp group string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

destruct-timeout number
Synopsis Destruction timeout
Context configure router string l2tp group string destruct-timeout number
Treedestruct-timeout
Range60 to 86400
Unitsseconds
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ethernet-tunnel
Synopsis Enter the ethernet-tunnel context
Contextconfigure router string l2tp group string ethernet-tunnel
Treeethernet-tunnel
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

reconnect-timeout (number | keyword)
Synopsis Timeout for a session setup retry at group level
Contextconfigure router string l2tp group string ethernet-tunnel reconnect-timeout (number | keyword)
Treereconnect-timeout
Range10 to 3600
Unitsseconds
Options infinite
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string l2tp group string failover
Treefailover
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-method keyword
Synopsis Recovery method of the sequence numbers after failover
Contextconfigure router string l2tp group string failover recovery-method keyword
Treerecovery-method
Optionsmcs, recovery-tunnel
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-time number
Synopsis Time requested from the L2TP peer before assuming failover as failed
Contextconfigure router string l2tp group string failover recovery-time number
Treerecovery-time
Range0 to 900
Unitsseconds
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hello-interval (number | keyword)
Synopsis Hello interval
Contextconfigure router string l2tp group string hello-interval (number | keyword)
Treehello-interval
Range10 to 3600
Unitsseconds
Options infinite
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

idle-timeout (number | keyword)
Synopsis Idle timeout
Contextconfigure router string l2tp group string idle-timeout (number | keyword)
Treeidle-timeout
Range0 to 3600
Unitsseconds
Options infinite
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

l2tpv3
Synopsis Enter the l2tpv3 context
Context configure router string l2tp group string l2tpv3
Treel2tpv3
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

cookie-length (number | keyword)
Synopsis Cookie field length
Context configure router string l2tp group string l2tpv3 cookie-length (number | keyword)
Treecookie-length
Range4 | 8
Optionsdisable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

digest-type keyword
Synopsis Hashing algorithm that calculates the message digest
Contextconfigure router string l2tp group string l2tpv3 digest-type keyword
Treedigest-type
Optionsnone, md5, sha1
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

nonce-length number
Synopsis Length for the local L2TPv3 nonce (random number)
Contextconfigure router string l2tp group string l2tpv3 nonce-length number
Treenonce-length
Range0 | 16 to 64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

password string
Synopsis L2TPv3 password
Context configure router string l2tp group string l2tpv3 password string
Treepassword
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

private-tcp-mss-adjust (number | keyword)
Synopsis TCP maximum segment size (MSS) on private network
Contextconfigure router string l2tp group string l2tpv3 private-tcp-mss-adjust (number | keyword)
Treeprivate-tcp-mss-adjust
Range512 to 9000
Unitsoctets
Options disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

public-tcp-mss-adjust (number | keyword)
Synopsis TCP Maximum Segment Size (MSS) on public network
Contextconfigure router string l2tp group string l2tpv3 public-tcp-mss-adjust (number | keyword)
Treepublic-tcp-mss-adjust
Range512 to 9000
Unitsoctets
Options disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

pw-cap-list
Synopsis Enter the pw-cap-list context
Context configure router string l2tp group string l2tpv3 pw-cap-list
Treepw-cap-list
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ethernet boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAdvertise Ethernet pseudowire type
Contextconfigure router string l2tp group string l2tpv3 pw-cap-list ethernet boolean
Treeethernet
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ethernet-vlan boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAdvertise Ethernet VLAN pseudowire type
Contextconfigure router string l2tp group string l2tpv3 pw-cap-list ethernet-vlan boolean
Treeethernet-vlan
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

rem-router-id string
Synopsis Filter on remote router ID
Context configure router string l2tp group string l2tpv3 rem-router-id string
Treerem-router-id
Default0.0.0.0
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lac
Synopsis Enter the lac context
Context configure router string l2tp group string lac
Treelac
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

df-bit keyword
Synopsis DF (do not fragment) bit in data traffic transmitted as LAC
Contextconfigure router string l2tp group string lac df-bit keyword
Treedf-bit
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lns
Synopsis Enter the lns context
Context configure router string l2tp group string lns
Treelns
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

lns-group reference
Synopsis ISA LNS group
Contextconfigure router string l2tp group string lns lns-group reference
Treelns-group

Reference

configure isa lns-group number

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

load-balance-method keyword
Synopsis New sessions for L2TP ISA MDA
Context configure router string l2tp group string lns load-balance-method keyword
Treeload-balance-method
Optionsper-session, per-tunnel
Default per-session
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mlppp
Synopsis Enter the mlppp context
Context configure router string l2tp group string lns mlppp
Treemlppp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

admin-state keyword
Synopsis Administrative state of MLPPP in the L2TP tunnel group
Contextconfigure router string l2tp group string lns mlppp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

endpoint
Synopsis Enter the endpoint context
Context configure router string l2tp group string lns mlppp endpoint
Treeendpoint
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

ip (ipv4-address | keyword)
Synopsis Endpoint ID as an IP address
Context configure router string l2tp group string lns mlppp endpoint ip (ipv4-address | keyword)
Treeip
Optionssystem

Notes

The following elements are part of a choice: ip or mac.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

mac (mac-address | keyword)
Synopsis Endpoint ID as a MAC address
Context configure router string l2tp group string lns mlppp endpoint mac (mac-address | keyword)
Treemac
Optionssystem

Notes

The following elements are part of a choice: ip or mac.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

interleave boolean
Synopsis Enable link fragmentation and interleaving
Contextconfigure router string l2tp group string lns mlppp interleave boolean
Treeinterleave
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

max-fragment-delay (number | keyword)
Synopsis Maximum fragment delay caused by transmission on a link
Contextconfigure router string l2tp group string lns mlppp max-fragment-delay (number | keyword)
Treemax-fragment-delay
Range5 to 1000
Unitsmilliseconds
Options no-fragmentation
Defaultno-fragmentation
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

max-links number
Synopsis Maximum MLPPP links
Context configure router string l2tp group string lns mlppp max-links number
Treemax-links
Range1 to 8
Default1
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

ppp
Synopsis Enter the ppp context
Context configure router string l2tp group string lns ppp
Treeppp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

authentication keyword
Synopsis PPP authentication protocol to negotiate
Contextconfigure router string l2tp group string lns ppp authentication keyword
Treeauthentication
Optionspap, chap, pref-chap, pref-pap
Default pref-chap
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

chap-challenge-length
Synopsis Enter the chap-challenge-length context
Contextconfigure router string l2tp group string lns ppp chap-challenge-length
Treechap-challenge-length
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

end number
Synopsis Upper bound of the PPP CHAP challenge length
Contextconfigure router string l2tp group string lns ppp chap-challenge-length end number
Treeend
Range8 to 64
Unitsoctets
Default 64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

start number
Synopsis Lower bound of the PPP CHAP challenge length
Contextconfigure router string l2tp group string lns ppp chap-challenge-length start number
Treestart
Range8 to 64
Unitsoctets
Default 32
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

default-group-interface
Synopsis Enter the default-group-interface context
Contextconfigure router string l2tp group string lns ppp default-group-interface
Treedefault-group-interface
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

keepalive
Synopsis Enter the keepalive context
Context configure router string l2tp group string lns ppp keepalive
Treekeepalive
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

interval number
Synopsis PPP keepalive interval
Context configure router string l2tp group string lns ppp keepalive interval number
Treeinterval
Range10 to 300
Unitsseconds
Default 30
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

lcp-force-ack-accm boolean
Synopsis Force acknowledgement of the LCP Asynchronous Control Character Map (ACCM) option
Contextconfigure router string l2tp group string lns ppp lcp-force-ack-accm boolean
Treelcp-force-ack-accm
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mtu number
Synopsis Maximum PPP MTU size
Context configure router string l2tp group string lns ppp mtu number
Treemtu
Range512 to 9212
Unitsoctets
Default 1500
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

proxy-lcp boolean
Synopsis Proxy LCP AVPs that are received from LAC
Contextconfigure router string l2tp group string lns ppp proxy-lcp boolean
Treeproxy-lcp
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

user-db string
Synopsis Local user database for PPP PAP and CHAP authentication
Contextconfigure router string l2tp group string lns ppp user-db string
Treeuser-db
String Length1 to 32
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

local-address string
Synopsis Local address
Contextconfigure router string l2tp group string local-address string
Treelocal-address
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

local-name string
Synopsis Local host name used to distinguish tunnels
Contextconfigure router string l2tp group string local-name string
Treelocal-name
String Length1 to 64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-retries-estab number
Synopsis Maximum retries for established tunnels
Contextconfigure router string l2tp group string max-retries-estab number
Treemax-retries-estab
Range2 to 7
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

password string
Synopsis Password between L2TP LAC and LNS
Context configure router string l2tp group string password string
Treepassword
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

protocol keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisProtocol version
Contextconfigure router string l2tp group string protocol keyword
Treeprotocol
Optionsv2, v3, v3draft
Defaultv2
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

session-assign-method keyword
Synopsis Session assignment method
Context configure router string l2tp group string session-assign-method keyword
Treesession-assign-method
Optionsexisting-first, weighted, weighted-random
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

session-limit (number | keyword)
Synopsis Session limit
Contextconfigure router string l2tp group string session-limit (number | keyword)
Treesession-limit
Range1 to 250000
Optionsunlimited
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

tunnel [tunnel-name] string
Synopsis Enter the tunnel list instance
Contextconfigure router string l2tp group string tunnel string
Treetunnel
Max. Instances31
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[tunnel-name] string
Synopsis Tunnel name
Contextconfigure router string l2tp group string tunnel string
Treetunnel
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the L2TP tunnel
Contextconfigure router string l2tp group string tunnel string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

auto-establish boolean
Synopsis Allow the tunnel to be automatically set up by the system
Contextconfigure router string l2tp group string tunnel string auto-establish boolean
Treeauto-establish
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

avp-hiding keyword
Synopsis The AVP hiding algorithm
Context configure router string l2tp group string tunnel string avp-hiding keyword
Treeavp-hiding
Optionsnever, sensitive, always
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

challenge keyword
Synopsis Enable use of challenge-response authentication
Contextconfigure router string l2tp group string tunnel string challenge keyword
Treechallenge
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string l2tp group string tunnel string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

destruct-timeout number
Synopsis Destruction timeout
Context configure router string l2tp group string tunnel string destruct-timeout number
Treedestruct-timeout
Range60 to 86400
Unitsseconds
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

failover
Synopsis Enter the failover context
Context configure router string l2tp group string tunnel string failover
Treefailover
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-method keyword
Synopsis Recovery method of the sequence numbers after failover
Contextconfigure router string l2tp group string tunnel string failover recovery-method keyword
Treerecovery-method
Optionsmcs, recovery-tunnel
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

recovery-time number
Synopsis Time requested from the L2TP peer before assuming failover as failed
Contextconfigure router string l2tp group string tunnel string failover recovery-time number
Treerecovery-time
Range0 to 900
Unitsseconds
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hello-interval (number | keyword)
Synopsis Hello interval
Contextconfigure router string l2tp group string tunnel string hello-interval (number | keyword)
Treehello-interval
Range10 to 3600
Unitsseconds
Options infinite
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

idle-timeout (number | keyword)
Synopsis Idle timeout
Contextconfigure router string l2tp group string tunnel string idle-timeout (number | keyword)
Treeidle-timeout
Range0 to 3600
Unitsseconds
Options infinite
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

l2tpv3
Synopsis Enter the l2tpv3 context
Context configure router string l2tp group string tunnel string l2tpv3
Treel2tpv3
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

private-tcp-mss-adjust (number | keyword)
Synopsis TCP maximum segment size (MSS) on private network
Contextconfigure router string l2tp group string tunnel string l2tpv3 private-tcp-mss-adjust (number | keyword)
Treeprivate-tcp-mss-adjust
Range512 to 9000
Unitsoctets
Options disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

public-tcp-mss-adjust (number | keyword)
Synopsis TCP maximum segment size (MSS) on public network
Contextconfigure router string l2tp group string tunnel string l2tpv3 public-tcp-mss-adjust (number | keyword)
Treepublic-tcp-mss-adjust
Range512 to 9000
Unitsoctets
Options disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lac
Synopsis Enter the lac context
Context configure router string l2tp group string tunnel string lac
Treelac
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

df-bit keyword
Synopsis DF (do not fragment) bit in data traffic transmitted as LAC
Contextconfigure router string l2tp group string tunnel string lac df-bit keyword
Treedf-bit
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lns
Synopsis Enter the lns context
Context configure router string l2tp group string tunnel string lns
Treelns
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mlppp
Synopsis Enter the mlppp context
Context configure router string l2tp group string tunnel string lns mlppp
Treemlppp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

admin-state keyword
Synopsis Administrative state of MLPPP in the L2TP tunnel
Contextconfigure router string l2tp group string tunnel string lns mlppp admin-state keyword
Treeadmin-state
Optionsenable, disable
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

endpoint
Synopsis Enter the endpoint context
Context configure router string l2tp group string tunnel string lns mlppp endpoint
Treeendpoint
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

ip (ipv4-address | keyword)
Synopsis Endpoint ID as an IP address
Context configure router string l2tp group string tunnel string lns mlppp endpoint ip (ipv4-address | keyword)
Treeip
Optionssystem

Notes

The following elements are part of a choice: ip or mac.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

mac (mac-address | keyword)
Synopsis Endpoint ID as a MAC address
Context configure router string l2tp group string tunnel string lns mlppp endpoint mac (mac-address | keyword)
Treemac
Optionssystem

Notes

The following elements are part of a choice: ip or mac.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

interleave keyword
Synopsis Use of Link fragmentation and interleaving
Contextconfigure router string l2tp group string tunnel string lns mlppp interleave keyword
Treeinterleave
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s

ppp
Synopsis Enter the ppp context
Context configure router string l2tp group string tunnel string lns ppp
Treeppp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

authentication keyword
Synopsis PPP authentication protocol to negotiate
Contextconfigure router string l2tp group string tunnel string lns ppp authentication keyword
Treeauthentication
Optionspap, chap, pref-chap, pref-pap
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

chap-challenge-length
Synopsis Enter the chap-challenge-length context
Contextconfigure router string l2tp group string tunnel string lns ppp chap-challenge-length
Treechap-challenge-length
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

end number
Synopsis Upper bound of the PPP CHAP challenge length
Contextconfigure router string l2tp group string tunnel string lns ppp chap-challenge-length end number
Treeend
Range8 to 64
Unitsoctets
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

default-group-interface
Synopsis Enter the default-group-interface context
Contextconfigure router string l2tp group string tunnel string lns ppp default-group-interface
Treedefault-group-interface
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

keepalive
Synopsis Enter the keepalive context
Context configure router string l2tp group string tunnel string lns ppp keepalive
Treekeepalive
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

lcp-force-ack-accm keyword
Synopsis Forced acknowledgement of the LCP Asynchronous Control Character Map (ACCM) option
Contextconfigure router string l2tp group string tunnel string lns ppp lcp-force-ack-accm keyword
Treelcp-force-ack-accm
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mtu number
Synopsis Maximum PPP MTU size
Context configure router string l2tp group string tunnel string lns ppp mtu number
Treemtu
Range512 to 9212
Unitsoctets
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

proxy-lcp keyword
Synopsis Use the Proxy LCP AVPs that are received from the LAC
Contextconfigure router string l2tp group string tunnel string lns ppp proxy-lcp keyword
Treeproxy-lcp
Optionsfalse, true
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

user-db string
Synopsis Local user database for PPP PAP and CHAP authentication
Contextconfigure router string l2tp group string tunnel string lns ppp user-db string
Treeuser-db
String Length1 to 32
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

local-name string
Synopsis Local host name used to distinguish tunnels
Contextconfigure router string l2tp group string tunnel string local-name string
Treelocal-name
String Length1 to 64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-retries-estab number
Synopsis Maximum retries for established tunnels
Contextconfigure router string l2tp group string tunnel string max-retries-estab number
Treemax-retries-estab
Range2 to 7
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

password string
Synopsis Password between L2TP LAC and LNS
Context configure router string l2tp group string tunnel string password string
Treepassword
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer string
Synopsis Peer address
Contextconfigure router string l2tp group string tunnel string peer string
Treepeer
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

preference number
Synopsis Tunnel preference number with its group
Contextconfigure router string l2tp group string tunnel string preference number
Treepreference
Range0 to 16777215
Default50
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

remote-name string
Synopsis Remote tunnel host name
Context configure router string l2tp group string tunnel string remote-name string
Treeremote-name
String Length1 to 64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

session-limit (number | keyword)
Synopsis L2TP session limit for each tunnel of this router
Contextconfigure router string l2tp group string tunnel string session-limit (number | keyword)
Treesession-limit
Range1 to 65534
Optionsunlimited
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

group-session-limit number
Synopsis L2TP session limit for each group of this router
Contextconfigure router string l2tp group-session-limit number
Treegroup-session-limit
Range1 to 250000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

hello-interval (number | keyword)
Synopsis Hello interval
Contextconfigure router string l2tp hello-interval (number | keyword)
Treehello-interval
Range10 to 3600
Unitsseconds
Options infinite
Default300
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

idle-timeout (number | keyword)
Synopsis Idle timeout
Contextconfigure router string l2tp idle-timeout (number | keyword)
Treeidle-timeout
Range0 to 3600
Unitsseconds
Options infinite
Defaultinfinite
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ignore-avps
Synopsis Enter the ignore-avps context
Context configure router string l2tp ignore-avps
Treeignore-avps
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

l2tpv3
Synopsis Enter the l2tpv3 context
Context configure router string l2tp l2tpv3
Treel2tpv3
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

cookie-length number
Synopsis Cookie field length
Context configure router string l2tp l2tpv3 cookie-length number
Treecookie-length
Range4 | 8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

digest-type keyword
Synopsis Hashing algorithm that calculates the message digest
Contextconfigure router string l2tp l2tpv3 digest-type keyword
Treedigest-type
Optionsmd5, sha1
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

nonce-length number
Synopsis Length of the local L2TPv3 nonce (random number)
Contextconfigure router string l2tp l2tpv3 nonce-length number
Treenonce-length
Range0 | 16 to 64
Default0
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

password string
Synopsis L2TPv3 password
Context configure router string l2tp l2tpv3 password string
Treepassword
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

private-tcp-mss-adjust number
Synopsis TCP maximum segment size (MSS) on private network
Contextconfigure router string l2tp l2tpv3 private-tcp-mss-adjust number
Treeprivate-tcp-mss-adjust
Range512 to 9000
Unitsoctets
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

public-tcp-mss-adjust number
Synopsis TCP maximum segment size (MSS) on public network
Contextconfigure router string l2tp l2tpv3 public-tcp-mss-adjust number
Treepublic-tcp-mss-adjust
Range512 to 9000
Unitsoctets
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

transport-type
Synopsis Enter the transport-type context
Contextconfigure router string l2tp l2tpv3 transport-type
Treetransport-type
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ip boolean
Synopsis Use IP as the transport type for the L2TPv3 tunnel
Contextconfigure router string l2tp l2tpv3 transport-type ip boolean
Treeip
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

lac
Synopsis Enter the lac context
Context configure router string l2tp lac
Treelac
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

calling-number-format string
Synopsis Calling Number AVP for L2TP control messages
Contextconfigure router string l2tp lac calling-number-format string
Treecalling-number-format
String Length1 to 255
Default%S %s
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

cisco-nas-port
Synopsis Enter the cisco-nas-port context
Contextconfigure router string l2tp lac cisco-nas-port
Treecisco-nas-port
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ethernet string
Synopsis L2TP Cisco NAS port AVP with binary patterns for Ethernet
Contextconfigure router string l2tp lac cisco-nas-port ethernet string
Treeethernet
String Length1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

df-bit boolean
Synopsis Send all L2TP packets with DF bit set to 1
Contextconfigure router string l2tp lac df-bit boolean
Treedf-bit
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

local-address string
Synopsis Local address
Contextconfigure router string l2tp local-address string
Treelocal-address
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

local-name string
Synopsis Local host name
Context configure router string l2tp local-name string
Treelocal-name
String Length1 to 64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-retries-estab number
Synopsis Maximum retries for established tunnels
Contextconfigure router string l2tp max-retries-estab number
Treemax-retries-estab
Range2 to 7
Default5
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-retries-not-estab number
Synopsis Maximum retries for unestablished tunnels
Contextconfigure router string l2tp max-retries-not-estab number
Treemax-retries-not-estab
Range2 to 7
Default5
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

next-attempt keyword
Synopsis Tunnel that is selected when previous session setup failed
Contextconfigure router string l2tp next-attempt keyword
Treenext-attempt
Optionssame-preference-level, next-preference-level
Defaultnext-preference-level
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

password string
Synopsis L2TP password
Contextconfigure router string l2tp password string
Treepassword
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

peer-address-change-policy keyword
Synopsis Reaction for L2TP response from a different address
Contextconfigure router string l2tp peer-address-change-policy keyword
Treepeer-address-change-policy
Optionsaccept, ignore, reject
Defaultreject
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

receive-window-size number
Synopsis L2TP receive window size
Context configure router string l2tp receive-window-size number
Treereceive-window-size
Range4 to 1024
Default64
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

replace-result-code
Synopsis Enter the replace-result-code context
Contextconfigure router string l2tp replace-result-code
Treereplace-result-code
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

rtm-debounce-time (number | keyword)
Synopsis Debounce timer that declares L2TP action for route table management events
Contextconfigure router string l2tp rtm-debounce-time (number | keyword)
Treertm-debounce-time
Range0 to 5000
Unitsmilliseconds
Options infinite
Defaultinfinite
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

session-assign-method keyword
Synopsis Session assignment method
Context configure router string l2tp session-assign-method keyword
Treesession-assign-method
Optionsexisting-first, weighted, weighted-random
Defaultexisting-first
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

session-limit number
Synopsis L2TP session limit of this router
Context configure router string l2tp session-limit number
Treesession-limit
Range1 to 250000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

tunnel-selection-blacklist
Synopsis Enter the tunnel-selection-blacklist context
Contextconfigure router string l2tp tunnel-selection-blacklist
Treetunnel-selection-blacklist
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

add-tunnel-on
Synopsis Enter the add-tunnel-on context
Contextconfigure router string l2tp tunnel-selection-blacklist add-tunnel-on
Treeadd-tunnel-on
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-list-length (number | keyword)
Synopsis Number of tunnels or peers in the denylist
Contextconfigure router string l2tp tunnel-selection-blacklist max-list-length (number | keyword)
Treemax-list-length
Range1 to 65535
Optionsinfinite
Defaultinfinite
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

max-time number
Synopsis Time that a tunnel or peer can remain in the denylist
Contextconfigure router string l2tp tunnel-selection-blacklist max-time number
Treemax-time
Range1 to 60
Unitsminutes
Default 5
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

timeout-action keyword
Synopsis Action when a tunnel or peer exceeds time in denylist
Contextconfigure router string l2tp tunnel-selection-blacklist timeout-action keyword
Treetimeout-action
Optionsremove-from-blacklist, try-one-session
Defaultremove-from-blacklist
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

tunnel-session-limit number
Synopsis L2TP session limit for each tunnel of this router
Contextconfigure router string l2tp tunnel-session-limit number
Treetunnel-session-limit
Range1 to 65534
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ldp

Synopsis Enable the ldp context
Context configure router string ldp
Treeldp
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of LDP
Context configure router string ldp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

aggregate-prefix-match
Synopsis Enable the aggregate-prefix-match context
Contextconfigure router string ldp aggregate-prefix-match
Treeaggregate-prefix-match
Introduced16.0.R1

Platforms

All

class-forwarding keyword
Synopsis Forwarding mode for LDP over RSVP
Context configure router string ldp class-forwarding keyword
Treeclass-forwarding
Options

lsr – Class-based forwarding for LSR/SWAP only

ler – Class-based forwarding for LER/PUSH only

lsr-and-ler – Class-based forwarding for LER/PUSH and LSR/SWAP

Introduced16.0.R1

Platforms

All

egress-statistics
Synopsis Enter the egress-statistics context
Contextconfigure router string ldp egress-statistics
Treeegress-statistics
Introduced16.0.R1

Platforms

All

fec-prefix [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the fec-prefix list instance
Contextconfigure router string ldp egress-statistics fec-prefix (ipv4-prefix | ipv6-prefix)
Treefec-prefix
Introduced16.0.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP prefix
Contextconfigure router string ldp egress-statistics fec-prefix (ipv4-prefix | ipv6-prefix)
Treefec-prefix

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

fec-originate [fec-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the fec-originate list instance
Contextconfigure router string ldp fec-originate (ipv4-prefix | ipv6-prefix)
Treefec-originate
Introduced16.0.R1

Platforms

All

[fec-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Static FEC IP prefix
Context configure router string ldp fec-originate (ipv4-prefix | ipv6-prefix)
Treefec-originate

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

interface string
Synopsis Interface name for this static FEC prefix
Contextconfigure router string ldp fec-originate (ipv4-prefix | ipv6-prefix) interface string
Treeinterface
String Length0 to 32

Notes

The following elements are part of a choice: (interface, next-hop, and swap-label) or pop.

Introduced16.0.R1

Platforms

All

next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the next hop
Context configure router string ldp fec-originate (ipv4-prefix | ipv6-prefix) next-hop (ipv4-address-no-zone | ipv6-address-no-zone)
Treenext-hop

Notes

The following elements are part of a choice: (interface, next-hop, and swap-label) or pop.

Introduced16.0.R1

Platforms

All

pop boolean
Synopsis Pop the label and transmit without the label
Contextconfigure router string ldp fec-originate (ipv4-prefix | ipv6-prefix) pop boolean
Treepop

Notes

The following elements are part of a choice: (interface, next-hop, and swap-label) or pop.

Introduced16.0.R1

Platforms

All

swap-label number
Synopsis Value mapped to egress label associated with next-hop entry that LSR uses to swap incoming label
Contextconfigure router string ldp fec-originate (ipv4-prefix | ipv6-prefix) swap-label number
Treeswap-label
Range6 to 1048575

Notes

The following elements are part of a choice: (interface, next-hop, and swap-label) or pop.

Introduced16.0.R1

Platforms

All

graceful-restart
Synopsis Enter the graceful-restart context
Contextconfigure router string ldp graceful-restart
Treegraceful-restart
Introduced16.0.R1

Platforms

All

implicit-null-label boolean
Synopsis Signal the implicit null label value for all LDP FECs for which the node is the egress LER
Contextconfigure router string ldp implicit-null-label boolean
Treeimplicit-null-label
Defaultfalse
Introduced16.0.R1

Platforms

All

import-pmsi-routes
Synopsis Enter the import-pmsi-routes context
Contextconfigure router string ldp import-pmsi-routes
Treeimport-pmsi-routes
Introduced19.5.R1

Platforms

All

import-policy reference
Synopsis Import policies to filter LDP label bindings received from LDP peers
Contextconfigure router string ldp import-policy reference
Treeimport-policy

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

interface-parameters
Synopsis Enter the interface-parameters context
Contextconfigure router string ldp interface-parameters
Treeinterface-parameters
Introduced16.0.R1

Platforms

All

interface [ip-int-name] reference
Synopsis Enter the interface list instance
Contextconfigure router string ldp interface-parameters interface reference
Treeinterface
Introduced16.0.R1

Platforms

All

bfd-liveness
Synopsis Enter the bfd-liveness context
Contextconfigure router string ldp interface-parameters interface reference bfd-liveness
Treebfd-liveness
Introduced16.0.R1

Platforms

All

ipv4
Synopsis Enable the ipv4 context
Context configure router string ldp interface-parameters interface reference ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

fec-type-capability
Synopsis Enter the fec-type-capability context
Contextconfigure router string ldp interface-parameters interface reference ipv4 fec-type-capability
Treefec-type-capability
Introduced16.0.R1

Platforms

All

hello
Synopsis Enable the hello context
Context configure router string ldp interface-parameters interface reference ipv4 hello
Treehello
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enable the keepalive context
Context configure router string ldp interface-parameters interface reference ipv4 keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

local-lsr-id
Synopsis Enter the local-lsr-id context
Contextconfigure router string ldp interface-parameters interface reference ipv4 local-lsr-id
Treelocal-lsr-id
Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enable the ipv6 context
Context configure router string ldp interface-parameters interface reference ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

fec-type-capability
Synopsis Enter the fec-type-capability context
Contextconfigure router string ldp interface-parameters interface reference ipv6 fec-type-capability
Treefec-type-capability
Introduced16.0.R1

Platforms

All

hello
Synopsis Enable the hello context
Context configure router string ldp interface-parameters interface reference ipv6 hello
Treehello
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enable the keepalive context
Context configure router string ldp interface-parameters interface reference ipv6 keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

local-lsr-id
Synopsis Enter the local-lsr-id context
Contextconfigure router string ldp interface-parameters interface reference ipv6 local-lsr-id
Treelocal-lsr-id
Introduced16.0.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string ldp interface-parameters ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

hello
Synopsis Enter the hello context
Context configure router string ldp interface-parameters ipv4 hello
Treehello
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enter the keepalive context
Context configure router string ldp interface-parameters ipv4 keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string ldp interface-parameters ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

hello
Synopsis Enter the hello context
Context configure router string ldp interface-parameters ipv6 hello
Treehello
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enter the keepalive context
Context configure router string ldp interface-parameters ipv6 keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

label-withdrawal-delay number
Synopsis Time interval during which LDP delays for the withdrawal of FEC-label binding
Contextconfigure router string ldp label-withdrawal-delay number
Treelabel-withdrawal-delay
Range3 to 120
Unitsseconds
Introduced 16.0.R1

Platforms

All

ldp-shortcut
Synopsis Enter the ldp-shortcut context
Contextconfigure router string ldp ldp-shortcut
Treeldp-shortcut
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Forward IPv4 packets by using LDP shortcuts
Contextconfigure router string ldp ldp-shortcut ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Forward IPv6 packets by using LDP shortcuts
Contextconfigure router string ldp ldp-shortcut ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

lsp-bfd [prefix-list] reference
Synopsis Enter the lsp-bfd list instance
Contextconfigure router string ldp lsp-bfd reference
Treelsp-bfd
Max. Instances16
Introduced16.0.R1

Platforms

All

[prefix-list] reference
Synopsis Name of a router policy options prefix list
Contextconfigure router string ldp lsp-bfd reference
Treelsp-bfd

Reference

configure policy-options prefix-list string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD on LDP LSPs with FECs that match the prefix list
Contextconfigure router string ldp lsp-bfd reference bfd-liveness boolean
Treebfd-liveness
Defaultfalse
Introduced16.0.R1

Platforms

All

failure-action keyword
Synopsis Reaction to BFD session failure for the prefix list
Contextconfigure router string ldp lsp-bfd reference failure-action keyword
Treefailure-action
Optionsdown
Introduced16.0.R1

Platforms

All

lsp-ping-interval (number | keyword)
Synopsis LSP ping transmit interval for periodic verification
Contextconfigure router string ldp lsp-bfd reference lsp-ping-interval (number | keyword)
Treelsp-ping-interval
Range60 to 300
Unitsseconds
Options none
Default 60
Introduced16.0.R1

Platforms

All

priority number
Synopsis Prefix list to control the search order
Contextconfigure router string ldp lsp-bfd reference priority number
Treepriority
Range1 to 99
Default1
Introduced 16.0.R1

Platforms

All

source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Source address in LSP ping packets and BFD control packets associated with prefix list
Contextconfigure router string ldp lsp-bfd reference source-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treesource-address
Introduced16.0.R1

Platforms

All

max-ecmp-routes number
Synopsis Maximum ECMP value for LDP
Context configure router string ldp max-ecmp-routes number
Treemax-ecmp-routes

Description

This command sets the maximum number of ECMP routes that LDP may use to resolve the next hop for a FEC as permitted by the RTM or TTM.

The system-wide maximum number of ECMP routes is set by the configure router ecmp command; therefore, the operational maximum number used by LDP is set to the lesser of the values configured by this command and the configure router ecmp command.

Range1 to 64
Default32
Introduced 19.10.R1

Platforms

All

mp-mbb-time number
Synopsis MP MBB time
Contextconfigure router string ldp mp-mbb-time number
Treemp-mbb-time
Range0 to 10
Unitsseconds
Default 3
Introduced16.0.R1

Platforms

All

prefer-protocol-stitching boolean
Synopsis Stitch LDP ILM to SR NHLFE even if LDP NHLFE exists
Contextconfigure router string ldp prefer-protocol-stitching boolean
Treeprefer-protocol-stitching

Description

When configured to true, an LDP ILM stitches to an SR NHLFE, even if an LDP NHLFE exists.

When configured to false, the stitching preference of an LDP ILM is to an LDP NHLFE.

Defaultfalse
Introduced21.7.R1

Platforms

All

resolve-root-using keyword
Synopsis Resolution route table for multicast FECs
Contextconfigure router string ldp resolve-root-using keyword
Treeresolve-root-using
Optionsucast-rtm, mcast-rtm
Default ucast-rtm
Introduced16.0.R1

Platforms

All

session-parameters
Synopsis Enter the session-parameters context
Contextconfigure router string ldp session-parameters
Treesession-parameters
Introduced16.0.R1

Platforms

All

peer [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the peer list instance
Context configure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer
Introduced16.0.R1

Platforms

All

[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the LDP peer
Context configure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

community string
Synopsis Community string associated with a session to a specified peer
Contextconfigure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone) community string
Treecommunity
String Length1 to 32
Introduced16.0.R1

Platforms

All

fec-limit
Synopsis Enter the fec-limit context
Context configure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone) fec-limit
Treefec-limit
Introduced16.0.R1

Platforms

All

limit number
Synopsis Maximum number of FECs to be accepted from this peer LSR
Contextconfigure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone) fec-limit limit number
Treelimit
Range0 | 1 to 4294967295
Default0
Introduced 16.0.R1

Platforms

All

log-only boolean
Synopsis Trap and syslog message to generate when reaching the threshold and limit
Contextconfigure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone) fec-limit log-only boolean
Treelog-only
Defaultfalse
Introduced16.0.R1

Platforms

All

fec-type-capability
Synopsis Enter the fec-type-capability context
Contextconfigure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone) fec-type-capability
Treefec-type-capability
Introduced16.0.R1

Platforms

All

fec129-cisco-interop boolean
Synopsis Allow translation between non-compliant FEC 129 formats of Cisco
Contextconfigure router string ldp session-parameters peer (ipv4-address-no-zone | ipv6-address-no-zone) fec129-cisco-interop boolean
Treefec129-cisco-interop
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

targeted-session
Synopsis Enter the targeted-session context
Contextconfigure router string ldp targeted-session
Treetargeted-session
Introduced16.0.R1

Platforms

All

auto-rx
Synopsis Enter the auto-rx context
Context configure router string ldp targeted-session auto-rx
Treeauto-rx

Description

Commands in this context specify the LDP session configuration to accept targeted Hello messages from any peer.

Introduced20.10.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string ldp targeted-session auto-rx ipv4
Treeipv4
Introduced20.10.R1

Platforms

All

tunneling boolean
Synopsis Enable tunneling for targeted peers
Context configure router string ldp targeted-session auto-rx ipv4 tunneling boolean
Treetunneling

Description

When configured to true, this command enables the local system to use the targeted LDP session to send FEC label bindings that are advertised to other LDP peers. For LDP rLFA, the source node requires the PQ node's label binding information in order to reach the destination.

If the auto-rx and auto-tx contexts are both administratively enabled, this command must be set to true for LDP rLFA to function properly.

When configured to false, FEC label bindings are not sent via the LDP session.

Defaultfalse
Introduced20.10.R1

Platforms

All

auto-tx
Synopsis Enter the auto-tx context
Context configure router string ldp targeted-session auto-tx
Treeauto-tx

Description

Commands in this context specify the LDP session configuration to send targeted Hello messages toward PQ nodes determined by the rLFA algorithm.

Introduced20.10.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string ldp targeted-session auto-tx ipv4
Treeipv4
Introduced20.10.R1

Platforms

All

tunneling boolean
Synopsis Enable tunneling for targeted peers
Context configure router string ldp targeted-session auto-tx ipv4 tunneling boolean
Treetunneling

Description

When configured to true, this command enables the local system to use the targeted LDP session to send FEC label bindings that are advertised to other LDP peers. For LDP rLFA, the source node requires the PQ node's label binding information in order to reach the destination.

If the auto-rx context is administratively disabled, this command should be set to true for LDP rLFA to function properly.

When configured to false, FEC label bindings are not sent via the LDP session.

Defaultfalse
Introduced20.10.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string ldp targeted-session ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

hello
Synopsis Enter the hello context
Context configure router string ldp targeted-session ipv4 hello
Treehello
Introduced16.0.R1

Platforms

All

hello-reduction
Synopsis Enter the hello-reduction context
Contextconfigure router string ldp targeted-session ipv4 hello-reduction
Treehello-reduction
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enter the keepalive context
Context configure router string ldp targeted-session ipv4 keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string ldp targeted-session ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

hello
Synopsis Enter the hello context
Context configure router string ldp targeted-session ipv6 hello
Treehello
Introduced16.0.R1

Platforms

All

hello-reduction
Synopsis Enter the hello-reduction context
Contextconfigure router string ldp targeted-session ipv6 hello-reduction
Treehello-reduction
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enter the keepalive context
Context configure router string ldp targeted-session ipv6 keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

peer [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the peer list instance
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer
Introduced16.0.R1

Platforms

All

[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the LDP peer
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the LDP peer
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

hello
Synopsis Enable the hello context
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) hello
Treehello
Introduced16.0.R1

Platforms

All

timeout number
Synopsis Timeout value for Hello
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) hello timeout number
Treetimeout
Range3 to 65535
Unitsseconds
Introduced 16.0.R1

Platforms

All

hello-reduction
Synopsis Enable the hello-reduction context
Contextconfigure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) hello-reduction
Treehello-reduction
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enable the keepalive context
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

timeout number
Synopsis Time that LDP waits before tearing down session
Contextconfigure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) keepalive timeout number
Treetimeout
Range3 to 65535
Unitsseconds
Introduced 16.0.R1

Platforms

All

local-lsr-id
Synopsis Enter the local-lsr-id context
Contextconfigure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) local-lsr-id
Treelocal-lsr-id
Introduced16.0.R1

Platforms

All

mcast-tunneling
Synopsis Enable the mcast-tunneling context
Contextconfigure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) mcast-tunneling
Treemcast-tunneling
Introduced21.2.R1

Platforms

All

lsp [lsp-name] string
Synopsis Add a list entry for lsp
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) mcast-tunneling lsp string
Treelsp
Max. Instances4
Introduced21.2.R1

Platforms

All

[lsp-name] string
Synopsis LSP name
Contextconfigure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) mcast-tunneling lsp string
Treelsp
String Length1 to 64

Notes

This element is part of a list key.

Introduced21.2.R1

Platforms

All

tunneling
Synopsis Enable the tunneling context
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) tunneling
Treetunneling
Introduced16.0.R1

Platforms

All

lsp [lsp-name] string
Synopsis Add a list entry for lsp
Context configure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) tunneling lsp string
Treelsp
Max. Instances4
Introduced16.0.R1

Platforms

All

[lsp-name] string
Synopsis LSP name
Contextconfigure router string ldp targeted-session peer (ipv4-address-no-zone | ipv6-address-no-zone) tunneling lsp string
Treelsp
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

peer-template [template-name] string
Synopsis Enter the peer-template list instance
Contextconfigure router string ldp targeted-session peer-template string
Treepeer-template
Max. Instances500
Introduced16.0.R1

Platforms

All

hello
Synopsis Enable the hello context
Context configure router string ldp targeted-session peer-template string hello
Treehello
Introduced16.0.R1

Platforms

All

hello-reduction
Synopsis Enable the hello-reduction context
Contextconfigure router string ldp targeted-session peer-template string hello-reduction
Treehello-reduction
Introduced16.0.R1

Platforms

All

keepalive
Synopsis Enable the keepalive context
Context configure router string ldp targeted-session peer-template string keepalive
Treekeepalive
Introduced16.0.R1

Platforms

All

local-lsr-id
Synopsis Enter the local-lsr-id context
Contextconfigure router string ldp targeted-session peer-template string local-lsr-id
Treelocal-lsr-id
Introduced16.0.R1

Platforms

All

peer-template-map [template-map-name] reference
Synopsis Enter the peer-template-map list instance
Contextconfigure router string ldp targeted-session peer-template-map reference
Treepeer-template-map
Max. Instances500
Introduced16.0.R1

Platforms

All

resolve-v6-prefix-over-shortcut boolean
Synopsis Resolve IPv6 prefix over IGP shortcuts
Contextconfigure router string ldp targeted-session resolve-v6-prefix-over-shortcut boolean
Treeresolve-v6-prefix-over-shortcut

Description

When configured to true, the system enables the resolution of IPv6 LDP unicast prefix FECs over IGP shortcuts.

When configured to false, the resolution is not allowed.

Defaultfalse
Introduced22.7.R1

Platforms

All

tcp-session-parameters
Synopsis Enter the tcp-session-parameters context
Contextconfigure router string ldp tcp-session-parameters
Treetcp-session-parameters
Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis Authentication key between LDP peers
Context configure router string ldp tcp-session-parameters authentication-key string
Treeauthentication-key

Description

This command specifies the authentication key used to establish a session between LDP peers.

Authentication uses the MD-5 message-based digest. The peer address used in authentication must be the TCP session transport address. If one or more transport addresses used in the Hello adjacencies to the same peer LSR are different from the LSR ID value, the user must add each transport address to the authentication key configuration as a separate peer. As a result, when the TCP connection is bootstrapped by a specific Hello adjacency, the authentication can operate over that TCP connection by using its specific transport address.

The per-peer authentication configuration takes precedence over global authentication configuration, and authentication keychain configuration takes precedence over authentication key configuration.

String Length1 to 370
Introduced21.2.R1

Platforms

All

authentication-keychain reference
Synopsis Authentication keychain to use for the TCP session
Contextconfigure router string ldp tcp-session-parameters authentication-keychain reference
Treeauthentication-keychain

Description

This command configures the authentication keychain to use for the TCP session.

The per-peer authentication configuration takes precedence over the global authentication configuration.

Reference

configure system security keychains keychain string

Introduced21.2.R1

Platforms

All

peer-transport [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the peer-transport list instance
Contextconfigure router string ldp tcp-session-parameters peer-transport (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer-transport
Introduced16.0.R1

Platforms

All

[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the TCP connection to the LDP peer
Contextconfigure router string ldp tcp-session-parameters peer-transport (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer-transport

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis Authentication key between LDP peers
Context configure router string ldp tcp-session-parameters peer-transport (ipv4-address-no-zone | ipv6-address-no-zone) authentication-key string
Treeauthentication-key

Description

This command specifies the authentication key used to establish a session between LDP peers.

Authentication uses the MD-5 message-based digest. The peer address used in authentication must be the TCP session transport address. If one or more transport addresses used in the Hello adjacencies to the same peer LSR are different from the LSR ID value, the user must add each transport address to the authentication key configuration as a separate peer. As a result, when the TCP connection is bootstrapped by a specific Hello adjacency, the authentication can operate over that TCP connection by using its specific transport address.

The per-peer authentication configuration takes precedence over global authentication configuration, and authentication keychain configuration takes precedence over authentication key configuration.

String Length1 to 370
Introduced16.0.R1

Platforms

All

authentication-keychain reference
Synopsis Authentication keychain to use for the TCP session
Contextconfigure router string ldp tcp-session-parameters peer-transport (ipv4-address-no-zone | ipv6-address-no-zone) authentication-keychain reference
Treeauthentication-keychain

Description

This command configures the authentication keychain to use for the TCP session.

The per-peer authentication configuration takes precedence over the global authentication configuration.

Reference

configure system security keychains keychain string

Introduced16.0.R3

Platforms

All

tunnel-down-damp-time number
Synopsis Time interval for an LDP to damp a tunnel down event before posting to the Route Table Manager (RTM)
Contextconfigure router string ldp tunnel-down-damp-time number
Treetunnel-down-damp-time
Range0 to 20
Unitsseconds
Default 3
Introduced16.0.R1

Platforms

All

tunnel-table-pref number
Synopsis Tunnel table preference value for address FECs
Contextconfigure router string ldp tunnel-table-pref number
Treetunnel-table-pref

Description

This command configures the tunnel table preference for an LDP tunnel type.

The tunnel table preference applies to next-hop resolution of BGP routes for: EVPN, IPv4, IPv6, VPN-IPv4, VPN-IPv6, label-IPv4, and label-IPV6 in the tunnel table.

This feature does not apply to a VPRN, VPLS, or VLL service with explicit binding to an SDP that enabled the mixed-lsp-mode option. The service manager controls and fixes the tunnel preference in such an SDP. The tunnel table preference configuration does not modify the SDP behavior, nor the services that bind to it.

It is recommended to not set two or more tunnel types to the same preference value. In such a situation, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default9
Introduced 21.10.R1

Platforms

All

weighted-ecmp boolean
Synopsis Allow weighted ECMP load-balancing
Context configure router string ldp weighted-ecmp boolean
Treeweighted-ecmp

Description

When configured to true, the system allows weighted ECMP on LDP using RSVP LSPs or SR-TE LSPs. LDP labeled packets are sprayed across the RSVP or SR-TE LSP ECMP set in proportion to the configured load-balancing weight of LSPs.

When configured to false, the system removes weighted ECMP load-balancing.

Defaultfalse
Introduced16.0.R1

Platforms

All

leak-export

Synopsis Enter the leak-export context
Context configure router string leak-export
Treeleak-export
Introduced16.0.R4

Platforms

All

policy-name (policy-expr-string | string)
Synopsis Route policy name
Context configure router string leak-export policy-name (policy-expr-string | string)
Treepolicy-name
String Length1 to 255
Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

lsp-bfd

Synopsis Enter the lsp-bfd context
Context configure router string lsp-bfd
Treelsp-bfd
Introduced16.0.R1

Platforms

All

bfd-sessions number
Synopsis Maximum number of LSP BFD session tail-ends
Contextconfigure router string lsp-bfd bfd-sessions number
Treebfd-sessions
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

tail-end
Synopsis Enter the tail-end context
Context configure router string lsp-bfd tail-end
Treetail-end
Introduced20.10.R1

Platforms

All

multiplier number
Synopsis Missed message threshold before session is set to down
Contextconfigure router string lsp-bfd tail-end multiplier number
Treemultiplier
Range1 to 20
Default3
Introduced 20.10.R1

Platforms

All

mc-maximum-routes

Synopsis Enter the mc-maximum-routes context
Contextconfigure router string mc-maximum-routes
Treemc-maximum-routes
Introduced16.0.R1

Platforms

All

log-only boolean
Synopsis Log and allow learning of new multicast routes
Contextconfigure router string mc-maximum-routes log-only boolean
Treelog-only
Defaultfalse
Introduced16.0.R1

Platforms

All

threshold number
Synopsis Maximum multicast routes which the VRF holds
Contextconfigure router string mc-maximum-routes threshold number
Treethreshold
Range1 to 100
Unitspercent
Introduced 16.0.R1

Platforms

All

value number
Synopsis Maximum multicast routes configured on virtual router
Contextconfigure router string mc-maximum-routes value number
Treevalue
Range1 to 2147483647
Introduced16.0.R1

Platforms

All

mld

Synopsis Enable the mld context
Context configure router string mld
Treemld
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of MLD
Context configure router string mld admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

forwarding-group-interface forwarding-service string group-interface-name reference
Synopsis Enter the forwarding-group-interface list instance
Contextconfigure router string mld forwarding-group-interface forwarding-service string group-interface-name reference
Treeforwarding-group-interface
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-number-group-sources number
Synopsis Maximum number of group sources for this interface
Contextconfigure router string mld forwarding-group-interface forwarding-service string group-interface-name reference maximum-number-group-sources number
Treemaximum-number-group-sources

Description

This command configures the maximum number of group sources for which IGMP or MLD can have local receiver information based on received IGMP or MLD reports on this interface. When this configuration is changed dynamically to a lower value than the currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources are not allowed.

Range1 to 32000
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

mcac
Synopsis Enter the mcac context
Context configure router string mld forwarding-group-interface forwarding-service string group-interface-name reference mcac
Treemcac
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

bandwidth
Synopsis Enter the bandwidth context
Context configure router string mld forwarding-group-interface forwarding-service string group-interface-name reference mcac bandwidth
Treebandwidth
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

policy reference
Synopsis Multicast CAC policy name
Context configure router string mld forwarding-group-interface forwarding-service string group-interface-name reference mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

group-interface [group-interface-name] reference
Synopsis Enter the group-interface list instance
Contextconfigure router string mld group-interface reference
Treegroup-interface
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the MLD interface
Contextconfigure router string mld group-interface reference admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

maximum-number-group-sources number
Synopsis Maximum number of group sources for this interface
Contextconfigure router string mld group-interface reference maximum-number-group-sources number
Treemaximum-number-group-sources

Description

This command configures the maximum number of group sources for which IGMP or MLD can have local receiver information based on received IGMP or MLD reports on this interface. When this configuration is changed dynamically to a lower value than the currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources are not allowed.

Range1 to 32000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

mcac
Synopsis Enter the mcac context
Context configure router string mld group-interface reference mcac
Treemcac
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

bandwidth
Synopsis Enter the bandwidth context
Context configure router string mld group-interface reference mcac bandwidth
Treebandwidth
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

mandatory (number | keyword)
Synopsis Pre-reserved bandwidth for all mandatory channels
Contextconfigure router string mld group-interface reference mcac bandwidth mandatory (number | keyword)
Treemandatory
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

total (number | keyword)
Synopsis Maximum allowed bandwidth
Context configure router string mld group-interface reference mcac bandwidth total (number | keyword)
Treetotal
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

policy reference
Synopsis Multicast CAC policy name
Context configure router string mld group-interface reference mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

query-interval number
Synopsis Time between two consecutive host-query messages
Contextconfigure router string mld group-interface reference query-interval number
Treequery-interval
Range2 to 1024
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

sub-hosts-only boolean
Synopsis Allow MLD traffic from known hosts only
Contextconfigure router string mld group-interface reference sub-hosts-only boolean
Treesub-hosts-only
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

subnet-check boolean
Synopsis Enable subnet checking
Context configure router string mld group-interface reference subnet-check boolean
Treesubnet-check
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

version keyword
Synopsis MLD protocol version
Context configure router string mld group-interface reference version keyword
Treeversion
Options1, 2
Default 2
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

interface [ip-interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string mld interface string
Treeinterface
Introduced16.0.R1

Platforms

All

[ip-interface-name] string
Synopsis IP interface name
Context configure router string mld interface string
Treeinterface
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

admin-state keyword
Synopsis Administrative state of the MLD interface
Contextconfigure router string mld interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

maximum-number-group-sources number
Synopsis Maximum number of group sources for this interface
Contextconfigure router string mld interface string maximum-number-group-sources number
Treemaximum-number-group-sources

Description

This command configures the maximum number of group sources for which IGMP or MLD can have local receiver information based on received IGMP or MLD reports on this interface. When this configuration is changed dynamically to a lower value than the currently accepted number of group sources, the group sources that are already accepted are not deleted. Only new group sources are not allowed.

Range1 to 32000
Introduced16.0.R1

Platforms

All

mcac
Synopsis Enter the mcac context
Context configure router string mld interface string mcac
Treemcac
Introduced16.0.R1

Platforms

All

bandwidth
Synopsis Enter the bandwidth context
Context configure router string mld interface string mcac bandwidth
Treebandwidth
Introduced16.0.R1

Platforms

All

mandatory (number | keyword)
Synopsis Pre-reserved bandwidth for all mandatory channels
Contextconfigure router string mld interface string mcac bandwidth mandatory (number | keyword)
Treemandatory
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

All

total (number | keyword)
Synopsis Maximum allowed bandwidth
Context configure router string mld interface string mcac bandwidth total (number | keyword)
Treetotal
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

All

mc-constraints
Synopsis Enter the mc-constraints context
Contextconfigure router string mld interface string mcac mc-constraints
Treemc-constraints
Introduced16.0.R1

Platforms

All

level [level-id] number
Synopsis Enter the level list instance
Context configure router string mld interface string mcac mc-constraints level number
Treelevel
Introduced16.0.R1

Platforms

All

[level-id] number
Synopsis Bandwidth level ID for an MCAC constraint
Contextconfigure router string mld interface string mcac mc-constraints level number
Treelevel
Range1 to 8

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

number-down [number-lag-port-down] number
Synopsis Enter the number-down list instance
Contextconfigure router string mld interface string mcac mc-constraints number-down number
Treenumber-down
Introduced16.0.R1

Platforms

All

level number
Synopsis Level ID to associate with number of down LAG ports
Contextconfigure router string mld interface string mcac mc-constraints number-down number level number
Treelevel

Description

This command specifies the bandwidth for a given level. Level 1 has the highest priority and level 8 has the lowest priority.

Range1 to 8

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

use-lag-port-weight boolean
Synopsis Use LAG port weight in calculating MCAC constraints
Contextconfigure router string mld interface string mcac mc-constraints use-lag-port-weight boolean
Treeuse-lag-port-weight

Description

When configured to true, port weight is used when determining available bandwidth per level when LAG ports go down or come up. This command is required for proper operation on mixed port-speed LAGs and can also be used for unmixed port-speed LAGs.

Defaultfalse
Introduced16.0.R1

Platforms

All

policy reference
Synopsis Multicast CAC policy name
Context configure router string mld interface string mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced16.0.R1

Platforms

All

ssm-translate
Synopsis Enter the ssm-translate context
Contextconfigure router string mld interface string ssm-translate
Treessm-translate
Introduced16.0.R1

Platforms

All

group-range start string end string
Synopsis Enter the group-range list instance
Contextconfigure router string mld interface string ssm-translate group-range start string end string
Treegroup-range
Introduced16.0.R1

Platforms

All

static
Synopsis Enter the static context
Context configure router string mld interface string static
Treestatic
Introduced16.0.R1

Platforms

All

group [group-address] string
Synopsis Enter the group list instance
Context configure router string mld interface string static group string
Treegroup
Introduced16.0.R1

Platforms

All

[group-address] string
Synopsis Group address of multicast channel
Context configure router string mld interface string static group string
Treegroup

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string mld interface string static group string source string
Treesource

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R1

Platforms

All

[source-address] string
Synopsis Source IP address
Context configure router string mld interface string static group string source string
Treesource

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

starg
Synopsis any source address (*,G)
Context configure router string mld interface string static group string starg
Treestarg

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R2

Platforms

All

group-range start string end string step string
Synopsis Enter the group-range list instance
Contextconfigure router string mld interface string static group-range start string end string step string
Treegroup-range
Introduced16.0.R1

Platforms

All

source [source-address] string
Synopsis Add a list entry for source
Context configure router string mld interface string static group-range start string end string step string source string
Treesource

Notes

The following elements are part of a mandatory choice: source or starg.

Introduced16.0.R1

Platforms

All

version keyword
Synopsis MLD protocol version
Context configure router string mld interface string version keyword
Treeversion
Options1, 2
Default 2
Introduced16.0.R1

Platforms

All

query-interval number
Synopsis Time between two consecutive host-query messages
Contextconfigure router string mld query-interval number
Treequery-interval
Range2 to 1024
Unitsseconds
Default 125
Introduced16.0.R1

Platforms

All

robust-count number
Synopsis Number of retries after expected message loss
Contextconfigure router string mld robust-count number
Treerobust-count
Range2 to 10
Default2
Introduced 16.0.R1

Platforms

All

ssm-translate
Synopsis Enter the ssm-translate context
Contextconfigure router string mld ssm-translate
Treessm-translate
Introduced16.0.R1

Platforms

All

group-range start string end string
Synopsis Enter the group-range list instance
Contextconfigure router string mld ssm-translate group-range start string end string
Treegroup-range
Introduced16.0.R1

Platforms

All

mpls

Synopsis Enable the mpls context
Context configure router string mpls
Treempls
Introduced16.0.R1

Platforms

All

admin-group-frr boolean
Synopsis Use admin group constraints for FRR path computation
Contextconfigure router string mpls admin-group-frr boolean
Treeadmin-group-frr
Defaultfalse
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the MPLS instance
Contextconfigure router string mpls admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

auto-bandwidth-multipliers
Synopsis Enter the auto-bandwidth-multipliers context
Contextconfigure router string mpls auto-bandwidth-multipliers
Treeauto-bandwidth-multipliers
Introduced16.0.R1

Platforms

All

auto-lsp [template-name] reference
Synopsis Enter the auto-lsp list instance
Contextconfigure router string mpls auto-lsp reference
Treeauto-lsp
Max. Instances500
Introduced16.0.R1

Platforms

All

[template-name] reference
Synopsis LSP template name
Context configure router string mpls auto-lsp reference
Treeauto-lsp

Reference

configure router string mpls lsp-template string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

one-hop boolean
Synopsis Enable one-hop point-to-point LSP automatic signaling
Contextconfigure router string mpls auto-lsp reference one-hop boolean
Treeone-hop

Description

This command enables the automatic signaling of one-hop point-to-point LSPs.

Defaultfalse

Notes

The following elements are part of a choice: one-hop or policy.

Introduced16.0.R1

Platforms

All

policy reference
Synopsis Peer prefix policy name
Context configure router string mpls auto-lsp reference policy reference
Treepolicy

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

The following elements are part of a choice: one-hop or policy.

This element is ordered by the user.

Introduced 16.0.R1

Platforms

All

aux-stats
Synopsis Enable the aux-stats context
Context configure router string mpls aux-stats
Treeaux-stats
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

sr boolean
Synopsis Traffic type count in MPLS statistics table
Contextconfigure router string mpls aux-stats sr boolean
Treesr

Description

This command configures the type of traffic to count in the auxiliary MPLS statistics table. It refers to any type of segment routing traffic (SR-OSPF, SR-ISIS, SR-TE, and so on).

Defaultfalse
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

class-forwarding-policy [policy-name] string
Synopsis Enter the class-forwarding-policy list instance
Contextconfigure router string mpls class-forwarding-policy string
Treeclass-forwarding-policy
Max. Instances15
Introduced16.0.R1

Platforms

All

fc [fc-name] keyword
Synopsis Enter the fc list instance
Context configure router string mpls class-forwarding-policy string fc keyword
Treefc
Introduced16.0.R1

Platforms

All

[fc-name] keyword
Synopsis Forwarding class name for LSP
Context configure router string mpls class-forwarding-policy string fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

forwarding-policies
Synopsis Enable the forwarding-policies context
Contextconfigure router string mpls forwarding-policies
Treeforwarding-policies
Introduced16.0.R1

Platforms

All

forwarding-policy [policy-name] string
Synopsis Enter the forwarding-policy list instance
Contextconfigure router string mpls forwarding-policies forwarding-policy string
Treeforwarding-policy
Max. Instances65536
Introduced16.0.R1

Platforms

All

egress-statistics
Synopsis Enable the egress-statistics context
Contextconfigure router string mpls forwarding-policies forwarding-policy string egress-statistics
Treeegress-statistics
Introduced19.7.R1

Platforms

All

endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure endpoint address.
Contextconfigure router string mpls forwarding-policies forwarding-policy string endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Treeendpoint
Introduced16.0.R4

Platforms

All

ingress-statistics
Synopsis Enable the ingress-statistics context
Contextconfigure router string mpls forwarding-policies forwarding-policy string ingress-statistics
Treeingress-statistics
Introduced16.0.R1

Platforms

All

next-hop-group [index] number
Synopsis Enter the next-hop-group list instance
Contextconfigure router string mpls forwarding-policies forwarding-policy string next-hop-group number
Treenext-hop-group
Max. Instances32
Introduced16.0.R1

Platforms

All

backup-next-hop
Synopsis Enable the backup-next-hop context
Contextconfigure router string mpls forwarding-policies forwarding-policy string next-hop-group number backup-next-hop
Treebackup-next-hop
Introduced16.0.R1

Platforms

All

pushed-labels [index] number
Synopsis Enter the pushed-labels list instance
Contextconfigure router string mpls forwarding-policies forwarding-policy string next-hop-group number backup-next-hop pushed-labels number
Treepushed-labels
Max. Instances10
Introduced16.0.R4

Platforms

All

primary-next-hop
Synopsis Enable the primary-next-hop context
Contextconfigure router string mpls forwarding-policies forwarding-policy string next-hop-group number primary-next-hop
Treeprimary-next-hop
Introduced16.0.R1

Platforms

All

pushed-labels [index] number
Synopsis Enter the pushed-labels list instance
Contextconfigure router string mpls forwarding-policies forwarding-policy string next-hop-group number primary-next-hop pushed-labels number
Treepushed-labels
Max. Instances10
Introduced16.0.R4

Platforms

All

preference number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisPreference number
Contextconfigure router string mpls forwarding-policies forwarding-policy string preference number
Treepreference
Range1 to 255
Default255
Introduced 16.0.R1

Platforms

All

tunnel-table-pref number
Synopsis Tunnel table preference
Context configure router string mpls forwarding-policies forwarding-policy string tunnel-table-pref number
Treetunnel-table-pref

Description

This command configures the TTM preference value of an MPLS forwarding policy. It is used by applications to select one tunnel type to bind to in TTM when multiple tunnel types are enabled for the application.

It is recommended to not set two or more tunnel types to the same preference value. In such a situation, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default255
Introduced 16.0.R4

Platforms

All

frr-object boolean
Synopsis Signal with fast reroute object
Context configure router string mpls frr-object boolean
Treefrr-object
Defaulttrue
Introduced16.0.R1

Platforms

All

hold-timer number
Synopsis Hold timer value
Context configure router string mpls hold-timer number
Treehold-timer
Range0 to 1000
Unitsseconds
Default 1
Introduced16.0.R1

Platforms

All

ingress-statistics
Synopsis Enter the ingress-statistics context
Contextconfigure router string mpls ingress-statistics
Treeingress-statistics
Introduced16.0.R1

Platforms

All

lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) lsp-name string
Synopsis Enter the lsp list instance
Context configure router string mpls ingress-statistics lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) lsp-name string
Treelsp
Introduced16.0.R1

Platforms

All

sender (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Sender address
Contextconfigure router string mpls ingress-statistics lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) lsp-name string
Treelsp

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

lsp-name string
Synopsis LSP name
Contextconfigure router string mpls ingress-statistics lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) lsp-name string
Treelsp
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

stat-mode keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisStat mode
Contextconfigure router string mpls ingress-statistics lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) lsp-name string stat-mode keyword
Treestat-mode
Optionsper-fc, aggregate
Introduced 21.10.R1

Platforms

All

p2mp-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string
Synopsis Enter the p2mp-template-lsp list instance
Contextconfigure router string mpls ingress-statistics p2mp-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string
Treep2mp-template-lsp
Introduced16.0.R1

Platforms

All

p2p-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string
Synopsis Enter the p2p-template-lsp list instance
Contextconfigure router string mpls ingress-statistics p2p-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string
Treep2p-template-lsp
Introduced16.0.R1

Platforms

All

max-stats number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of statistic indices
Contextconfigure router string mpls ingress-statistics p2p-template-lsp sender (ipv4-address-no-zone | ipv6-address-no-zone) rsvp-session-name string max-stats number
Treemax-stats
Range1 to 8191
Default8191
Introduced 16.0.R1

Platforms

All

interface [interface-name] reference
Synopsis Enter the interface list instance
Contextconfigure router string mpls interface reference
Treeinterface

Description

Commands in this context configure the attributes for MPLS protocol support on an IP interface. 

MPLS commands are not executed on an IP interface where MPLS is not enabled. An MPLS interface must be explicitly enabled (admin-state enabled).

The MPLS interface must be admin-state disabled to delete the interface definition.

A corresponding RSVP interface must also be configured. The MPLS interface cannot be deleted without also deleting the RSVP interface.

Introduced16.0.R1

Platforms

All

[interface-name] reference
Synopsis Router interface name
Context configure router string mpls interface reference
Treeinterface

Reference

configure router string interface string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-group reference
Synopsis Administrative groups supported by the interface
Contextconfigure router string mpls interface reference admin-group reference
Treeadmin-group

Description

This command specifies the administrative groups that the interface supports.

This information is advertised as part of OSPF and IS-IS to help CSPF compute constrained LSPs that must include or exclude certain administrative groups. An MPLS interface is assumed to belong to all the administrative groups unless this command is issued under the interface configuration. With this command configured, the interface is assumed to belong to only the groups specifically configured in this command.

Only the administrative groups bound to an MPLS interface are advertised in TE link TLVs and sub-TLVs when the traffic-engineering option is enabled in IS-IS or OSPF. IES and VPRN interfaces do not have their attributes advertised in TE TLVs.

Reference

configure routing-options if-attribute admin-group string

Max. Instances32
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the MPLS interface
Contextconfigure router string mpls interface reference admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

label-map [in-label] number
Synopsis Enter the label-map list instance
Contextconfigure router string mpls interface reference label-map number
Treelabel-map
Introduced16.0.R1

Platforms

All

[in-label] number
Synopsis Match the incoming MPLS label
Context configure router string mpls interface reference label-map number
Treelabel-map
Range32 to 1048575

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

pop
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisPop (remove) the incoming label and forward packet based on service header
Contextconfigure router string mpls interface reference label-map number pop
Treepop

Notes

The following elements are part of a choice: pop or swap.

Introduced16.0.R1

Platforms

All

swap
Synopsis Enable the swap context
Context configure router string mpls interface reference label-map number swap
Treeswap

Notes

The following elements are part of a choice: pop or swap.

Introduced16.0.R1

Platforms

All

out-label (number | keyword)
Synopsis Push specific label onto the top of the outgoing packet's label stack
Contextconfigure router string mpls interface reference label-map number swap out-label (number | keyword)
Treeout-label
Range16 to 1048575
Optionsimplicit-null-label

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

te-metric number
Synopsis TE metric for the interface
Context configure router string mpls interface reference te-metric number
Treete-metric
Range1 to 16777215
Introduced16.0.R1

Platforms

All

least-fill-min-thd number
Synopsis Percentage of the least fill minimum threshold value
Contextconfigure router string mpls least-fill-min-thd number
Treeleast-fill-min-thd
Range0 to 100
Unitspercent
Default 5
Introduced16.0.R1

Platforms

All

logger-event-bundling boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMerge and bundle MPLS traps
Contextconfigure router string mpls logger-event-bundling boolean
Treelogger-event-bundling
Defaultfalse
Introduced16.0.R1

Platforms

All

lsp [lsp-name] string
Synopsis Enter the lsp list instance
Context configure router string mpls lsp string
Treelsp
Introduced16.0.R1

Platforms

All

[lsp-name] string
Synopsis Labeled Switch path name
Context configure router string mpls lsp string
Treelsp
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adaptive boolean
Synopsis Enable make-before-break functionality
Contextconfigure router string mpls lsp string adaptive boolean
Treeadaptive
Defaulttrue
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the LSP
Context configure router string mpls lsp string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

adspec boolean
Synopsis Include ADSPEC object in RSVP messages
Contextconfigure router string mpls lsp string adspec boolean
Treeadspec
Defaultfalse
Introduced16.0.R1

Platforms

All

auto-bandwidth
Synopsis Enable the auto-bandwidth context
Contextconfigure router string mpls lsp string auto-bandwidth
Treeauto-bandwidth
Introduced16.0.R1

Platforms

All

adjust-down
Synopsis Enter the adjust-down context
Context configure router string mpls lsp string auto-bandwidth adjust-down
Treeadjust-down
Introduced16.0.R1

Platforms

All

bw number
Synopsis Minimum difference in absolute bandwidth
Contextconfigure router string mpls lsp string auto-bandwidth adjust-down bw number
Treebw
Range0 to 6400000
Unitsmegabps
Default 0
Introduced16.0.R1

Platforms

All

adjust-up
Synopsis Enter the adjust-up context
Context configure router string mpls lsp string auto-bandwidth adjust-up
Treeadjust-up
Introduced16.0.R1

Platforms

All

bw number
Synopsis Minimum difference in absolute bandwidth
Contextconfigure router string mpls lsp string auto-bandwidth adjust-up bw number
Treebw
Range0 to 6400000
Unitsmegabps
Default 0
Introduced16.0.R1

Platforms

All

fc [fc-name] keyword
Synopsis Enter the fc list instance
Context configure router string mpls lsp string auto-bandwidth fc keyword
Treefc
Max. Instances8
Introduced16.0.R1

Platforms

All

[fc-name] keyword
Synopsis Forwarding class name for LSP
Context configure router string mpls lsp string auto-bandwidth fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

multipliers
Synopsis Enter the multipliers context
Context configure router string mpls lsp string auto-bandwidth multipliers
Treemultipliers
Introduced16.0.R1

Platforms

All

overflow-limit
Synopsis Enable the overflow-limit context
Contextconfigure router string mpls lsp string auto-bandwidth overflow-limit
Treeoverflow-limit
Introduced16.0.R1

Platforms

All

number number
Synopsis Number of overflow samples to trigger an overflow auto-bandwidth adjustment attempt
Contextconfigure router string mpls lsp string auto-bandwidth overflow-limit number number
Treenumber
Range1 to 10

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

underflow-limit
Synopsis Enable the underflow-limit context
Contextconfigure router string mpls lsp string auto-bandwidth underflow-limit
Treeunderflow-limit
Introduced16.0.R1

Platforms

All

number number
Synopsis Number of overflow samples to trigger an overflow auto-bandwidth adjustment attempt
Contextconfigure router string mpls lsp string auto-bandwidth underflow-limit number number
Treenumber
Range1 to 10

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

use-last-adj-bw
Synopsis Enable the use-last-adj-bw context
Contextconfigure router string mpls lsp string auto-bandwidth use-last-adj-bw
Treeuse-last-adj-bw
Introduced16.0.R5

Platforms

All

secondary-retry-limit (number | keyword)
Synopsis Maximum number of retry limits for secondary paths
Contextconfigure router string mpls lsp string auto-bandwidth use-last-adj-bw secondary-retry-limit (number | keyword)
Treesecondary-retry-limit

Description

This command configures the maximum number of retry attempts for secondary paths. After each successful attempt, the counter is reset to zero.

Range1 to 10000
Optionsinfinite
Default5
Introduced 16.0.R5

Platforms

All

bfd
Synopsis Enter the bfd context
Context configure router string mpls lsp string bfd
Treebfd

Description

Commands in this context configure BFD on RSVP LSPs or Seamless BFD on SR-TE LSPs. 

Introduced16.0.R1

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD on the RSVP LSP or S-BFD on the SR-TE LSP
Contextconfigure router string mpls lsp string bfd bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, LSP BFD is enabled on the RSVP LSP or S-BFD is enabled for the SR-TE LSP.

LSP BFD must also be configured under the configure router context. The named BFD template provides the configuration settings for the BFD session, which must be configured and associated with the service using the BFD template.

When configured to false, LSP BFD is disabled on the RSVP LSP or S-BFD on the SR-TE LSP.

Defaultfalse
Introduced16.0.R1

Platforms

All

failure-action keyword
Synopsis Action when LSP BFD fails on the RSVP SR-TE LSP
Contextconfigure router string mpls lsp string bfd failure-action keyword
Treefailure-action

Description

The command specifies the action when LSP BFD fails on an RSVP, SR-TE, or LDP LSP.

Regardless of the failure action specified, when the BFD session goes down on the LSP, the system generates an SNMP trap.

Optionsnone, down, failover, failover-or-down
Defaultnone
Introduced 16.0.R1

Platforms

All

lsp-ping-interval (number | keyword)
Synopsis Interval for periodic LSP ping for BFD bootstrapping
Contextconfigure router string mpls lsp string bfd lsp-ping-interval (number | keyword)
Treelsp-ping-interval
Range60 to 300
Unitsseconds
Options none
Default 60
Introduced16.0.R1

Platforms

All

return-path-label number
Synopsis S-BFD return-path label
Context configure router string mpls lsp string bfd return-path-label number
Treereturn-path-label

Description

This command configures the S-BFD session to echo mode and adds an additional MPLS label to the bottom of the label stack for the S-BFD packet. 

The command applies to the initiator of the S-BFD sessions. The return-path label may be a binding SID for an SR policy or other MPLS path configured on the reflector router. Instead of being routed through the IGP path, the S-BFD packet returns to the initiator through this MPLS return path. 

If the command is deleted, S-BFD returns to asynchronous mode and no return-path label is pushed by the initiator node. Any S-BFD packets for this LSP or path that the reflector receives are routed through the IGP path.

Range32 to 1048512
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

wait-for-up-timer number
Synopsis Time to wait for BFD to become operationally available
Contextconfigure router string mpls lsp string bfd wait-for-up-timer number
Treewait-for-up-timer

Description

This command configures the time to wait for BFD to become operationally up. The timer is applicable to SR-TE LSPs, including auto LSPs and PCE-initiated LSPS, as well RSVP-TE LSPs.

For SR-TE LSPs, the timer takes effect when BFD is first enabled on a path or when BFD transitions from up to down. Upon expiration, if BFD is not up, the path is torn down, removed from the TTM and the IOM, and the system starts the retry timer.

For RSVP-TE LSPs, the timer controls the following:

  • a path undergoing MBB when BFD is up

  • the initial administrative state of the LSP

  • the retry signaling of non-standby secondary paths

Range1 to 60
Unitsseconds
Default 4
Introduced19.7.R1

Platforms

All

binding-sid number
Synopsis Binding SID for the LSP
Context configure router string mpls lsp string binding-sid number
Treebinding-sid

Description

This command binds a label to the LSP. The label value must belong to the reserved label block that is configured with the configure router mpls lsp-bsid-block command.

Range32 to 1048575
Introduced22.10.R1

Platforms

All

class-forwarding
Synopsis Enable the class-forwarding context
Contextconfigure router string mpls lsp string class-forwarding
Treeclass-forwarding
Introduced16.0.R1

Platforms

All

forwarding-set
Synopsis Enter the forwarding-set context
Contextconfigure router string mpls lsp string class-forwarding forwarding-set
Treeforwarding-set

Notes

The following elements are part of a choice: (default-lsp and fc) or forwarding-set.

Introduced16.0.R1

Platforms

All

class-type number
Synopsis Class type for an LSP
Context configure router string mpls lsp string class-type number
Treeclass-type
Range0 to 7
Default0
Introduced 16.0.R1

Platforms

All

egress-statistics
Synopsis Enable the egress-statistics context
Contextconfigure router string mpls lsp string egress-statistics
Treeegress-statistics
Introduced16.0.R1

Platforms

All

collect-stats boolean
Synopsis Collect LSP statistics
Context configure router string mpls lsp string egress-statistics collect-stats boolean
Treecollect-stats

Description

When configured to true, this command enables LSP statistics collection. When you apply accounting policies, the forwarding engine collects data in the appropriate records and by default the CPU obtains and writes the results to the designated billing file.

When configured to false, the forwarding engine still accumulates statistics. However, the CPU does not write them to the billing file. If you subsequently re-enable this command, the counters written to the billing file include all the traffic collected while the command was disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

stat-mode keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisStatistics collection mode
Contextconfigure router string mpls lsp string egress-statistics stat-mode keyword
Treestat-mode
Optionsper-fc, aggregate
Introduced 21.10.R1

Platforms

All

exclude-node (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Exclude Routers object to be included in the bypass path message
Contextconfigure router string mpls lsp string exclude-node (ipv4-address-no-zone | ipv6-address-no-zone)
Treeexclude-node
Introduced16.0.R1

Platforms

All

fallback-path-computation-method keyword
Synopsis Fallback path computation method
Context configure router string mpls lsp string fallback-path-computation-method keyword
Treefallback-path-computation-method

Description

This command specifies the fallback path computation method used if all configured PCEs are down or are signaling overload and the redelegation timer has expired. This method is used regardless of whether the LSP is PCE-controlled and PCE-computed, or only PCE-computed.

Optionsnone, local-cspf
Introduced 21.2.R1

Platforms

All

fast-reroute
Synopsis Enable the fast-reroute context
Contextconfigure router string mpls lsp string fast-reroute
Treefast-reroute
Introduced16.0.R1

Platforms

All

hop-limit number
Synopsis Total number of hops a detour or backup LSP can take
Contextconfigure router string mpls lsp string fast-reroute hop-limit number
Treehop-limit
Range0 to 255
Default16
Introduced 16.0.R1

Platforms

All

from (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSource IP address of this LSP
Contextconfigure router string mpls lsp string from (ipv4-address-no-zone | ipv6-address-no-zone)
Treefrom
Introduced16.0.R1

Platforms

All

hop-limit number
Synopsis Maximum number of hops that an LSP can traverse including ingress and egress routers
Contextconfigure router string mpls lsp string hop-limit number
Treehop-limit
Range2 to 255
Default255
Introduced 16.0.R1

Platforms

All

igp-shortcut
Synopsis Enter the igp-shortcut context
Contextconfigure router string mpls lsp string igp-shortcut
Treeigp-shortcut
Introduced16.0.R1

Platforms

All

allow-sr-over-srte boolean
Synopsis Use as eligible SRv4 or SRv6 IGP shortcut
Contextconfigure router string mpls lsp string igp-shortcut allow-sr-over-srte boolean
Treeallow-sr-over-srte

Description

When configured to true, the router performs the local SPF and the SR-TE LSP is used as an eligible IGP SR-MPLS shortcut for SR-MPLS SRv4 or SRv6 only if the SR-TE is explicitly allowed using this command when the top SID in the SR-TE LSP is an adjacency SID.

Defaultfalse
Introduced23.3.R1

Platforms

All

lfa-type keyword
Synopsis LSP usage in LFA SPF
Context configure router string mpls lsp string igp-shortcut lfa-type keyword
Treelfa-type
Optionslfa-protect, lfa-only

Notes

The following elements are part of a choice: lfa-type or relative-metric.

Introduced16.0.R1

Platforms

All

relative-metric number
Synopsis Shortest IGP cost between the endpoints of the LSP plus the configured offset
Contextconfigure router string mpls lsp string igp-shortcut relative-metric number
Treerelative-metric
Range-10 to 10

Notes

The following elements are part of a choice: lfa-type or relative-metric.

Introduced16.0.R1

Platforms

All

least-fill boolean
Synopsis Enable least-fill path selection for this LSP
Contextconfigure router string mpls lsp string least-fill boolean
Treeleast-fill
Defaultfalse
Introduced16.0.R1

Platforms

All

local-sr-protection keyword
Synopsis Local SR protection preference for LSP path computation
Contextconfigure router string mpls lsp string local-sr-protection keyword
Treelocal-sr-protection
Optionsnone, preferred, mandatory
Defaultpreferred
Introduced19.7.R1

Platforms

All

lsp-self-ping keyword
Synopsis LSP Self Ping activation status on the RSVP-TE LSP
Contextconfigure router string mpls lsp string lsp-self-ping keyword
Treelsp-self-ping

Description

When configured, the system uses this setting for the LSP regardless of the value configured under configure router mpls lsp-self-ping rsvp-te.

When unconfigured, the command inherits the value configured under configure router mpls lsp-self-ping rsvp-te.

Optionsfalse, true
Introduced 19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

max-sr-labels
Synopsis Enter the max-sr-labels context
Contextconfigure router string mpls lsp string max-sr-labels
Treemax-sr-labels
Introduced16.0.R1

Platforms

All

label-stack-size number
Synopsis Maximum label stack size
Context configure router string mpls lsp string max-sr-labels label-stack-size number
Treelabel-stack-size

Description

This command configures the maximum label stack size of the primary path of the SR-TE LSP.

Range1 to 11
Introduced16.0.R1

Platforms

All

metric number
Synopsis LSP metric that forces to a constant value
Contextconfigure router string mpls lsp string metric number
Treemetric
Range0 to 16777215
Introduced16.0.R1

Platforms

All

metric-type keyword
Synopsis Metric type used for LSP path computation
Contextconfigure router string mpls lsp string metric-type keyword
Treemetric-type
Optionsigp, te
Default igp
Introduced19.7.R1

Platforms

All

override-tunnel-elc boolean
Synopsis Override any received entropy label capability
Contextconfigure router string mpls lsp string override-tunnel-elc boolean
Treeoverride-tunnel-elc

Description

When configured to true, this command allows the system to override any received entropy label capability advertisement.

When configured to false, this command disables the override.

Defaultfalse
Introduced21.10.R1

Platforms

All

p2mp-id number
Synopsis Unique identifier as Point-to-Multipoint (P2MP) identifier
Contextconfigure router string mpls lsp string p2mp-id number
Treep2mp-id
Range1 to 65535
Introduced16.0.R1

Platforms

All

path-computation-method keyword
Synopsis Path computation method
Context configure router string mpls lsp string path-computation-method keyword
Treepath-computation-method

Description

This command configures the path computation method of an RSVP-TE or SR-TE LSP.

If this command is not configured to one of the supported options, the default path computation method is used depending on the type of LSP; the hop-to-label translation is used for the SR-TE LSP template and the IGP-based path is used for the RSVP-TE-LSP.

See "SR-TE LSP path computation using hop-to-label translation" in the 7750 Service Router and 7950 Extensible Routing System Segment Routing nad PCE User Guide for more information.

Optionslocal-cspf, pce
Introduced 19.7.R1

Platforms

All

path-profile [profile-id] number
Synopsis Enter the path-profile list instance
Contextconfigure router string mpls lsp string path-profile number
Treepath-profile

Description

Commands in this context configure the attributes of the PCE path profile.

Max. Instances5
Introduced16.0.R1

Platforms

All

[profile-id] number
Synopsis Profile ID for the specified LSP
Context configure router string mpls lsp string path-profile number
Treepath-profile
Range1 to 4294967295

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

path-group number
Synopsis Path-group ID for the specified LSP
Context configure router string mpls lsp string path-profile number path-group number
Treepath-group
Max. Range0 to 4294967295
Default0
Introduced 16.0.R1

Platforms

All

pce-associations
Synopsis Enter the pce-associations context
Contextconfigure router string mpls lsp string pce-associations
Treepce-associations

Description

Commands in this context configure the LSP binding with one or more PCEP associations.

Introduced22.5.R1

Platforms

All

diversity [diversity-name] reference
Synopsis Add a list entry for diversity
Contextconfigure router string mpls lsp string pce-associations diversity reference
Treediversity

Description

Commands in this context bind the LSP to a named diversity association. The diversity association must exist under the PCC.

Max. Instances5
Introduced22.5.R1

Platforms

All

policy [policy-name] reference
Synopsis Add a list entry for policy
Context configure router string mpls lsp string pce-associations policy reference
Treepolicy

Description

Commands in this context bind the LSP to a named policy association. The policy association name must exist under the PCC.

Max. Instances5
Introduced22.5.R1

Platforms

All

pce-control boolean
Synopsis Enable PCE controlled LSP mode of operation
Contextconfigure router string mpls lsp string pce-control boolean
Treepce-control

Description

When configured to true, this command enables a PCE-controlled mode of operation for the LSP. In this mode, the router delegates full control of the LSP to the PCE (PCE controlled). The PCE acts in stateful-active mode for this LSP and is able to reroute the path following a failure or to re-optimize the path and update the router without a request from the router.

When configured to false, the PCE-controlled mode of operation for the LSP has no effect.

Defaultfalse
Introduced16.0.R1

Platforms

All

pce-report keyword
Synopsis Global configuration of reporting to PCE to override
Contextconfigure router string mpls lsp string pce-report keyword
Treepce-report
Optionsfalse, true
Introduced 16.0.R1

Platforms

All

primary [path-name] reference
Synopsis Enter the primary list instance
Contextconfigure router string mpls lsp string primary reference
Treeprimary
Max. Instances1
Introduced16.0.R1

Platforms

All

[path-name] reference
Synopsis Path name
Contextconfigure router string mpls lsp string primary reference
Treeprimary

Reference

configure router string mpls path string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adaptive boolean
Synopsis Enable make-before-break functionality
Contextconfigure router string mpls lsp string primary reference adaptive boolean
Treeadaptive
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the LSP path
Context configure router string mpls lsp string primary reference admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

bandwidth number
Synopsis Amount of bandwidth to be reserved
Context configure router string mpls lsp string primary reference bandwidth number
Treebandwidth
Range0 to 6400000
Unitsmegabps
Default 0
Introduced16.0.R1

Platforms

All

bfd
Synopsis Enter the bfd context
Context configure router string mpls lsp string primary reference bfd
Treebfd

Description

Commands in this context configure BFD on RSVP LSPs or Seamless BFD on SR-TE LSPs. 

Introduced16.0.R1

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD on the RSVP LSP or S-BFD on the SR-TE LSP
Contextconfigure router string mpls lsp string primary reference bfd bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, LSP BFD is enabled on the RSVP LSP or S-BFD is enabled for the SR-TE LSP.

LSP BFD must also be configured under the configure router context. The named BFD template provides the configuration settings for the BFD session, which must be configured and associated with the service using the BFD template.

When configured to false, LSP BFD is disabled on the RSVP LSP or S-BFD on the SR-TE LSP.

Defaultfalse
Introduced16.0.R1

Platforms

All

lsp-ping-interval (number | keyword)
Synopsis Interval for periodic LSP ping for BFD bootstrapping
Contextconfigure router string mpls lsp string primary reference bfd lsp-ping-interval (number | keyword)
Treelsp-ping-interval
Range60 to 300
Unitsseconds
Options none
Default 60
Introduced16.0.R1

Platforms

All

return-path-label number
Synopsis S-BFD return-path label
Context configure router string mpls lsp string primary reference bfd return-path-label number
Treereturn-path-label

Description

This command configures the S-BFD session to echo mode and adds an additional MPLS label to the bottom of the label stack for the S-BFD packet. 

The command applies to the initiator of the S-BFD sessions. The return-path label may be a binding SID for an SR policy or other MPLS path configured on the reflector router. Instead of being routed through the IGP path, the S-BFD packet returns to the initiator through this MPLS return path. 

If the command is deleted, S-BFD returns to asynchronous mode and no return-path label is pushed by the initiator node. Any S-BFD packets for this LSP or path that the reflector receives are routed through the IGP path.

Range32 to 1048512
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

wait-for-up-timer number
Synopsis Time to wait for BFD to become operationally available
Contextconfigure router string mpls lsp string primary reference bfd wait-for-up-timer number
Treewait-for-up-timer

Description

This command configures the time to wait for BFD to become operationally up. The timer is applicable to SR-TE LSPs, including auto LSPs and PCE-initiated LSPS, as well RSVP-TE LSPs.

For SR-TE LSPs, the timer takes effect when BFD is first enabled on a path or when BFD transitions from up to down. Upon expiration, if BFD is not up, the path is torn down, removed from the TTM and the IOM, and the system starts the retry timer.

For RSVP-TE LSPs, the timer controls the following:

  • a path undergoing MBB when BFD is up

  • the initial administrative state of the LSP

  • the retry signaling of non-standby secondary paths

Range1 to 60
Unitsseconds
Default 4
Introduced19.7.R1

Platforms

All

exclude-admin-group
Synopsis Enable the exclude-admin-group context
Contextconfigure router string mpls lsp string primary reference exclude-admin-group
Treeexclude-admin-group
Introduced16.0.R1

Platforms

All

hop-limit number
Synopsis Total number of hops that an LSP traverses
Contextconfigure router string mpls lsp string primary reference hop-limit number
Treehop-limit
Range2 to 255
Introduced16.0.R1

Platforms

All

include-admin-group
Synopsis Enable the include-admin-group context
Contextconfigure router string mpls lsp string primary reference include-admin-group
Treeinclude-admin-group
Introduced16.0.R1

Platforms

All

priority
Synopsis Enter the priority context
Context configure router string mpls lsp string primary reference priority
Treepriority
Introduced16.0.R1

Platforms

All

record boolean
Synopsis Enable recording of all hops that an LSP path traverses
Contextconfigure router string mpls lsp string primary reference record boolean
Treerecord
Defaulttrue
Introduced16.0.R1

Platforms

All

record-label boolean
Synopsis Enable recording of labels at each node or instance
Contextconfigure router string mpls lsp string primary reference record-label boolean
Treerecord-label
Defaulttrue
Introduced16.0.R1

Platforms

All

primary-p2mp-instance [instance-name] string
Synopsis Enter the primary-p2mp-instance list instance
Contextconfigure router string mpls lsp string primary-p2mp-instance string
Treeprimary-p2mp-instance
Max. Instances1
Introduced16.0.R4

Platforms

All

exclude-admin-group
Synopsis Enable the exclude-admin-group context
Contextconfigure router string mpls lsp string primary-p2mp-instance string exclude-admin-group
Treeexclude-admin-group
Introduced16.0.R4

Platforms

All

include-admin-group
Synopsis Enable the include-admin-group context
Contextconfigure router string mpls lsp string primary-p2mp-instance string include-admin-group
Treeinclude-admin-group
Introduced16.0.R4

Platforms

All

priority
Synopsis Enter the priority context
Context configure router string mpls lsp string primary-p2mp-instance string priority
Treepriority
Introduced21.10.R1

Platforms

All

s2l-path [path-name] reference to (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the s2l-path list instance
Contextconfigure router string mpls lsp string primary-p2mp-instance string s2l-path reference to (ipv4-address-no-zone | ipv6-address-no-zone)
Trees2l-path
Max. Instances650
Introduced16.0.R4

Platforms

All

to (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis System IP address of the egress router
Contextconfigure router string mpls lsp string primary-p2mp-instance string s2l-path reference to (ipv4-address-no-zone | ipv6-address-no-zone)
Trees2l-path

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the S2L sub-LSP for a P2MP LSP
Contextconfigure router string mpls lsp string primary-p2mp-instance string s2l-path reference to (ipv4-address-no-zone | ipv6-address-no-zone) admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

retry-limit number
Synopsis Number of attempts to re-establish LSP after it fails
Contextconfigure router string mpls lsp string retry-limit number
Treeretry-limit
Range1 to 10000
Introduced16.0.R1

Platforms

All

retry-timer number
Synopsis Time for LSP re-establishment attempts after failure
Contextconfigure router string mpls lsp string retry-timer number
Treeretry-timer
Range1 to 600
Unitsseconds
Default 30
Introduced16.0.R1

Platforms

All

revert-timer number
Synopsis Revert timer for the LSP
Context configure router string mpls lsp string revert-timer number
Treerevert-timer
Range1 to 4320
Unitsminutes
Introduced 16.0.R1

Platforms

All

secondary [path-name] reference
Synopsis Enter the secondary list instance
Contextconfigure router string mpls lsp string secondary reference
Treesecondary
Max. Instances8
Introduced16.0.R1

Platforms

All

[path-name] reference
Synopsis Path name
Contextconfigure router string mpls lsp string secondary reference
Treesecondary

Reference

configure router string mpls path string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adaptive boolean
Synopsis Enable make-before-break functionality
Contextconfigure router string mpls lsp string secondary reference adaptive boolean
Treeadaptive
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the LSP path
Context configure router string mpls lsp string secondary reference admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

bandwidth number
Synopsis Amount of bandwidth to be reserved
Context configure router string mpls lsp string secondary reference bandwidth number
Treebandwidth
Range0 to 6400000
Unitsmegabps
Default 0
Introduced16.0.R1

Platforms

All

bfd
Synopsis Enter the bfd context
Context configure router string mpls lsp string secondary reference bfd
Treebfd

Description

Commands in this context configure BFD on RSVP LSPs or Seamless BFD on SR-TE LSPs.

Introduced19.7.R1

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD on the RSVP LSP or S-BFD on the SR-TE LSP
Contextconfigure router string mpls lsp string secondary reference bfd bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, LSP BFD is enabled on the RSVP LSP or S-BFD is enabled for the SR-TE LSP.

LSP BFD must also be configured under the configure router context. The named BFD template provides the configuration settings for the BFD session, which must be configured and associated with the service using the BFD template.

When configured to false, LSP BFD is disabled on the RSVP LSP or S-BFD on the SR-TE LSP.

Defaultfalse
Introduced19.7.R1

Platforms

All

lsp-ping-interval (number | keyword)
Synopsis Interval for periodic LSP ping for BFD bootstrapping
Contextconfigure router string mpls lsp string secondary reference bfd lsp-ping-interval (number | keyword)
Treelsp-ping-interval
Range60 to 300
Unitsseconds
Options none
Default 60
Introduced19.7.R1

Platforms

All

return-path-label number
Synopsis S-BFD return-path label
Context configure router string mpls lsp string secondary reference bfd return-path-label number
Treereturn-path-label

Description

This command configures the S-BFD session to echo mode and adds an additional MPLS label to the bottom of the label stack for the S-BFD packet. 

The command applies to the initiator of the S-BFD sessions. The return-path label may be a binding SID for an SR policy or other MPLS path configured on the reflector router. Instead of being routed through the IGP path, the S-BFD packet returns to the initiator through this MPLS return path. 

If the command is deleted, S-BFD returns to asynchronous mode and no return-path label is pushed by the initiator node. Any S-BFD packets for this LSP or path that the reflector receives are routed through the IGP path.

Range32 to 1048512
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

wait-for-up-timer number
Synopsis Time to wait for BFD to become operationally available
Contextconfigure router string mpls lsp string secondary reference bfd wait-for-up-timer number
Treewait-for-up-timer

Description

This command configures the time to wait for BFD to become operationally up. The timer is applicable to SR-TE LSPs, including auto LSPs and PCE-initiated LSPS, as well RSVP-TE LSPs.

For SR-TE LSPs, the timer takes effect when BFD is first enabled on a path or when BFD transitions from up to down. Upon expiration, if BFD is not up, the path is torn down, removed from the TTM and the IOM, and the system starts the retry timer.

For RSVP-TE LSPs, the timer controls the following:

  • a path undergoing MBB when BFD is up

  • the initial administrative state of the LSP

  • the retry signaling of non-standby secondary paths

Range1 to 60
Unitsseconds
Default 4
Introduced19.7.R1

Platforms

All

exclude-admin-group
Synopsis Enable the exclude-admin-group context
Contextconfigure router string mpls lsp string secondary reference exclude-admin-group
Treeexclude-admin-group
Introduced16.0.R1

Platforms

All

hop-limit number
Synopsis Total number of hops that an LSP traverses
Contextconfigure router string mpls lsp string secondary reference hop-limit number
Treehop-limit
Range2 to 255
Introduced16.0.R1

Platforms

All

include-admin-group
Synopsis Enable the include-admin-group context
Contextconfigure router string mpls lsp string secondary reference include-admin-group
Treeinclude-admin-group
Introduced16.0.R1

Platforms

All

priority
Synopsis Enter the priority context
Context configure router string mpls lsp string secondary reference priority
Treepriority
Introduced16.0.R1

Platforms

All

record boolean
Synopsis Enable recording of all hops that an LSP path traverses
Contextconfigure router string mpls lsp string secondary reference record boolean
Treerecord
Defaulttrue
Introduced16.0.R1

Platforms

All

record-label boolean
Synopsis Enable recording of labels at each node or instance
Contextconfigure router string mpls lsp string secondary reference record-label boolean
Treerecord-label
Defaulttrue
Introduced16.0.R1

Platforms

All

srlg boolean
Synopsis Use SRLG constraint in secondary path computation for an LSP at the head-end LER
Contextconfigure router string mpls lsp string secondary reference srlg boolean
Treesrlg
Defaultfalse
Introduced16.0.R1

Platforms

All

standby boolean
Synopsis Keep secondary path indefinitely in hot standby state
Contextconfigure router string mpls lsp string secondary reference standby boolean
Treestandby
Defaultfalse
Introduced16.0.R1

Platforms

All

soft-preemption boolean
Synopsis Enable soft preemption
Context configure router string mpls lsp string soft-preemption boolean
Treesoft-preemption

Description

When configured to true, the P2MP LSP preemption is governed by the configure router rsvp preemption-timer value.

When configured to false, the preemption timer value is set to 0 and the P2MP LSPs are hard preempted. 

For P2P LSPs, soft preemption is always enabled and cannot be disabled.

Introduced22.2.R1

Platforms

All

to (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDestination IP address or the egress router for the LSP
Contextconfigure router string mpls lsp string to (ipv4-address-no-zone | ipv6-address-no-zone)
Treeto
Introduced16.0.R1

Platforms

All

type keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisLSP for bypass protection, point to multipoint, segment routing or MPLS-TP static LSP
Contextconfigure router string mpls lsp string type keyword
Treetype
Optionsp2p-rsvp, p2p-static-mpls, p2p-rsvp-bypass, p2mp-rsvp, p2mp-rsvp-auto, p2p-rsvp-mesh, p2p-rsvp-one-hop, p2p-sr-te, p2p-sr-te-mesh, p2p-sr-te-one-hop, p2p-sr-te-pce-init, p2p-sr-te-on-demand

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

lsp-bsid-block reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisReserved label block for binding SIDs
Contextconfigure router string mpls lsp-bsid-block reference
Treelsp-bsid-block

Description

This command references a pre-existing reserved label block for statically configured binding SIDs.

Reference

configure router string mpls-labels reserved-label-block string

Introduced22.7.R1

Platforms

All

lsp-history
Synopsis Enable the lsp-history context
Contextconfigure router string mpls lsp-history
Treelsp-history

Description

Commands in this context control the recording of LSP history events.

When the context is created, memory is allocated for storing up to 100 of the most recent LSP history events.

When the context is deleted, memory is deallocated.

Introduced22.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of LSP history recording
Contextconfigure router string mpls lsp-history admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced22.10.R1

Platforms

All

lsp-self-ping
Synopsis Enter the lsp-self-ping context
Contextconfigure router string mpls lsp-self-ping
Treelsp-self-ping

Description

Commands in this context configure LSP Self Ping parameters. 

LSP Self Ping checks that the datapath of an RSVP LSP has been programmed by all LSRs along its path before switching the traffic to it. If enabled, LSP Self Ping packets are sent periodically at a configurable interval following the receipt of the RESV message for an RSVP LSP path following an MBB or other event where the active path changes while the previous active path stayed up. The router will not switch traffic to the new path until an LSP Self Ping reply is received from the far-end LER.

When configured under the MPLS context, LSP Self Ping is enabled for all RSVP LSPs, unless it is explicitly disabled for a given LSP.

Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

interval number
Synopsis MPLS periodic LSP Self Ping interval
Context configure router string mpls lsp-self-ping interval number
Treeinterval

Description

This command configures the interval at which LSP Self Ping packets are periodically sent on a candidate path of an RSVP LSP.

This value is used for all LSPs that have LSP Self Ping enabled.

Range1 to 10
Unitsseconds
Default 1
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

rsvp-te boolean
Synopsis Activate LSP Self Ping on RSVP-TE LSPs
Contextconfigure router string mpls lsp-self-ping rsvp-te boolean
Treersvp-te

Description

When configured to true, this command enables LSP Self Ping on all RSVP-TE LSPs, unless an individual LSP has this explicitly disabled under the configure router mpls lsp lsp-self-ping command or in the LSP template.

When configured to false, this command disables LSP Self Ping on all RSVP-TE LSPs.

Defaultfalse
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

timeout number
Synopsis MPLS LSP Self Ping timeout
Context configure router string mpls lsp-self-ping timeout number
Treetimeout

Description

This command configures a timeout value for the LSP Self Ping timer.

The LSP Self Ping timer starts when the RESV message is received for an LSP. The system periodically sends LSP Self Ping packets until the timer expires or the first LSP Self Ping reply is received, whichever comes first. If the timer expires before an LSP Self Ping packet is received, the configured timeout action is performed.

Range3 to 3600
Unitsseconds
Default 300
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

timeout-action keyword
Synopsis Action taken when LSP Self Ping timer expires
Contextconfigure router string mpls lsp-self-ping timeout-action keyword
Treetimeout-action
Optionsretry, switch
Default retry
Introduced20.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

lsp-template [template-name] string
Synopsis Enter the lsp-template list instance
Contextconfigure router string mpls lsp-template string
Treelsp-template

Description

Commands in this context configure the attributes of an LSP template that can be referenced by a client application when dynamic LSPs must be created.

Max. Instances4096
Introduced16.0.R1

Platforms

All

[template-name] string
Synopsis LSP template name
Context configure router string mpls lsp-template string
Treelsp-template

Description

This command specifies the name of the LSP template. An LSP template name and LSP name must not be the same.

String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adaptive boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable make-before-break functionality
Contextconfigure router string mpls lsp-template string adaptive boolean
Treeadaptive
Defaulttrue
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the LSP template
Contextconfigure router string mpls lsp-template string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

adspec boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisInclude ADSPEC objects in RSVP messages
Contextconfigure router string mpls lsp-template string adspec boolean
Treeadspec
Defaultfalse
Introduced16.0.R1

Platforms

All

auto-bandwidth
Synopsis Enable the auto-bandwidth context
Contextconfigure router string mpls lsp-template string auto-bandwidth
Treeauto-bandwidth
Introduced16.0.R1

Platforms

All

adjust-down
Synopsis Enter the adjust-down context
Context configure router string mpls lsp-template string auto-bandwidth adjust-down
Treeadjust-down
Introduced16.0.R1

Platforms

All

adjust-up
Synopsis Enter the adjust-up context
Context configure router string mpls lsp-template string auto-bandwidth adjust-up
Treeadjust-up
Introduced16.0.R1

Platforms

All

fc [fc-name] keyword
Synopsis Enter the fc list instance
Context configure router string mpls lsp-template string auto-bandwidth fc keyword
Treefc
Max. Instances8
Introduced16.0.R1

Platforms

All

[fc-name] keyword
Synopsis Forwarding class name for LSP
Context configure router string mpls lsp-template string auto-bandwidth fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

multipliers
Synopsis Enter the multipliers context
Context configure router string mpls lsp-template string auto-bandwidth multipliers
Treemultipliers
Introduced16.0.R1

Platforms

All

overflow-limit
Synopsis Enable the overflow-limit context
Contextconfigure router string mpls lsp-template string auto-bandwidth overflow-limit
Treeoverflow-limit
Introduced16.0.R1

Platforms

All

underflow-limit
Synopsis Enable the underflow-limit context
Contextconfigure router string mpls lsp-template string auto-bandwidth underflow-limit
Treeunderflow-limit
Introduced16.0.R1

Platforms

All

backup-class-type number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisBackup class type for this LSP template
Contextconfigure router string mpls lsp-template string backup-class-type number
Treebackup-class-type
Range0 to 7
Default0
Introduced 16.0.R1

Platforms

All

bandwidth number
Synopsis Amount of bandwidth reserved for the P2MP instance
Contextconfigure router string mpls lsp-template string bandwidth number
Treebandwidth
Range0 to 6400000
Unitsmegabps
Default 0
Introduced16.0.R1

Platforms

All

bfd
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the bfd context
Contextconfigure router string mpls lsp-template string bfd
Treebfd

Description

Commands in this context configure BFD on RSVP LSPs or Seamless BFD on SR-TE LSPs. 

Introduced16.0.R1

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD on the RSVP LSP or S-BFD on the SR-TE LSP
Contextconfigure router string mpls lsp-template string bfd bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, LSP BFD is enabled on the RSVP LSP or S-BFD is enabled for the SR-TE LSP.

LSP BFD must also be configured under the configure router context. The named BFD template provides the configuration settings for the BFD session, which must be configured and associated with the service using the BFD template.

When configured to false, LSP BFD is disabled on the RSVP LSP or S-BFD on the SR-TE LSP.

Defaultfalse
Introduced16.0.R1

Platforms

All

lsp-ping-interval (number | keyword)
Synopsis Interval for periodic LSP ping for BFD bootstrapping
Contextconfigure router string mpls lsp-template string bfd lsp-ping-interval (number | keyword)
Treelsp-ping-interval
Range60 to 300
Unitsseconds
Options none
Default 60
Introduced16.0.R1

Platforms

All

return-path-label number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisS-BFD return-path label
Contextconfigure router string mpls lsp-template string bfd return-path-label number
Treereturn-path-label

Description

This command configures the S-BFD session to echo mode and adds an additional MPLS label to the bottom of the label stack for the S-BFD packet. 

The command applies to the initiator of the S-BFD sessions. The return-path label may be a binding SID for an SR policy or other MPLS path configured on the reflector router. Instead of being routed through the IGP path, the S-BFD packet returns to the initiator through this MPLS return path. 

If the command is deleted, S-BFD returns to asynchronous mode and no return-path label is pushed by the initiator node. Any S-BFD packets for this LSP or path that the reflector receives are routed through the IGP path.

Range32 to 1048512
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

wait-for-up-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime to wait for BFD to become operationally available
Contextconfigure router string mpls lsp-template string bfd wait-for-up-timer number
Treewait-for-up-timer

Description

This command configures the time to wait for BFD to become operationally up. The timer is applicable to SR-TE LSPs, including auto LSPs and PCE-initiated LSPS, as well RSVP-TE LSPs.

For SR-TE LSPs, the timer takes effect when BFD is first enabled on a path or when BFD transitions from up to down. Upon expiration, if BFD is not up, the path is torn down, removed from the TTM and the IOM, and the system starts the retry timer.

For RSVP-TE LSPs, the timer controls the following:

  • a path undergoing MBB when BFD is up

  • the initial administrative state of the LSP

  • the retry signaling of non-standby secondary paths

Range1 to 60
Unitsseconds
Default 4
Introduced19.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

bgp-shortcut boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable/disable use of RSVP LSP for IPv4 BGP routes.
Contextconfigure router string mpls lsp-template string bgp-shortcut boolean
Treebgp-shortcut
Introduced16.0.R1

Platforms

All

bgp-transport-tunnel boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAllow use of RSVP-TE LSP as transport for tunnel routes
Contextconfigure router string mpls lsp-template string bgp-transport-tunnel boolean
Treebgp-transport-tunnel
Defaulttrue
Introduced16.0.R1

Platforms

All

binding-sid boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisRequest to allocate and bind a label
Contextconfigure router string mpls lsp-template string binding-sid boolean
Treebinding-sid

Description

When configured to true, the system allocates and binds a label to any LSP that is created using the template.

When configured to false, this command removes the configuration but this does not affect LSPs that were already created using the template.

Defaultfalse
Introduced22.10.R1

Platforms

All

class-forwarding
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the class-forwarding context
Contextconfigure router string mpls lsp-template string class-forwarding
Treeclass-forwarding
Introduced16.0.R1

Platforms

All

forwarding-set
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the forwarding-set context
Contextconfigure router string mpls lsp-template string class-forwarding forwarding-set
Treeforwarding-set

Notes

The following elements are part of a choice: (default-lsp and fc) or forwarding-set.

Introduced16.0.R1

Platforms

All

set number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisForwarding set ID
Contextconfigure router string mpls lsp-template string class-forwarding forwarding-set set number
Treeset
Range1 to 6
Introduced16.0.R1

Platforms

All

class-type number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisClass type for an LSP template
Contextconfigure router string mpls lsp-template string class-type number
Treeclass-type
Range0 to 7
Default0
Introduced 16.0.R1

Platforms

All

default-path reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisDefault path to be used for signaling LSP instances
Contextconfigure router string mpls lsp-template string default-path reference
Treedefault-path

Reference

configure router string mpls path string

Introduced16.0.R1

Platforms

All

egress-statistics
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the egress-statistics context
Contextconfigure router string mpls lsp-template string egress-statistics
Treeegress-statistics
Introduced16.0.R1

Platforms

All

collect-stats boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisCollect LSP statistics
Contextconfigure router string mpls lsp-template string egress-statistics collect-stats boolean
Treecollect-stats

Description

When configured to true, this command enables LSP statistics collection. When you apply accounting policies, the forwarding engine collects data in the appropriate records and by default the CPU obtains and writes the results to the designated billing file.

When configured to false, the forwarding engine still accumulates statistics. However, the CPU does not write them to the billing file. If you subsequently re-enable this command, the counters written to the billing file include all the traffic collected while the command was disabled.

Defaultfalse
Introduced16.0.R1

Platforms

All

stat-mode keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisStatistics collection mode
Contextconfigure router string mpls lsp-template string egress-statistics stat-mode keyword
Treestat-mode
Optionsper-fc, aggregate
Introduced 21.10.R1

Platforms

All

entropy-label keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEntropy label for an LSP template
Contextconfigure router string mpls lsp-template string entropy-label keyword
Treeentropy-label
Optionsfalse, true
Introduced 16.0.R1

Platforms

All

fallback-path-computation-method keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisFallback path computation method
Contextconfigure router string mpls lsp-template string fallback-path-computation-method keyword
Treefallback-path-computation-method

Description

This command specifies the fallback path computation method used if all configured PCEs are down or are signaling overload and the redelegation timer has expired. This method is used regardless of whether the LSP is PCE-controlled and PCE-computed, or only PCE-computed.

Optionsnone, local-cspf
Introduced 21.10.R1

Platforms

All

family keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAddress family that specifies template use in SR-TE LSP
Contextconfigure router string mpls lsp-template string family keyword
Treefamily

Description

This command specifies the address family for which the LSP template applies in an SR-TE LSP.

An LSP template is required for each address family.

Optionsipv4, ipv6
Default ipv4
Introduced20.5.R1

Platforms

All

fast-reroute
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the fast-reroute context
Contextconfigure router string mpls lsp-template string fast-reroute
Treefast-reroute
Introduced16.0.R1

Platforms

All

frr-method keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisFast Reroute method for the LSPs that are dynamically created using this LSP template
Contextconfigure router string mpls lsp-template string fast-reroute frr-method keyword
Treefrr-method
Optionsone-to-one, facility
Default facility
Introduced16.0.R1

Platforms

All

from (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIP address of the ingress router for the LSP template
Contextconfigure router string mpls lsp-template string from (ipv4-address-no-zone | ipv6-address-no-zone)
Treefrom
Introduced16.0.R1

Platforms

All

hop-limit number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum hops for an LSP created using this LSP template
Contextconfigure router string mpls lsp-template string hop-limit number
Treehop-limit
Range2 to 255
Introduced16.0.R1

Platforms

All

igp-shortcut
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the igp-shortcut context
Contextconfigure router string mpls lsp-template string igp-shortcut
Treeigp-shortcut
Introduced16.0.R1

Platforms

All

admin-state keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisAdministrative state of LSP for shortcut or forwarding
Contextconfigure router string mpls lsp-template string igp-shortcut admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

allow-sr-over-srte boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUse as eligible SRv4 or SRv6 IGP shortcut
Contextconfigure router string mpls lsp-template string igp-shortcut allow-sr-over-srte boolean
Treeallow-sr-over-srte

Description

When configured to true, the router performs local SPF and the SR-TE LSP template is used as an eligible IGP SR-MPLS shortcut for SR-MPLS SRv4 or SRv6 only if the SR-TE is explicitly allowed using this command and when the top SID in the SR-TE LSP is an adjacency SID.

Defaultfalse
Introduced23.3.R1

Platforms

All

lfa-type keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLSP usage in LFA SPF
Contextconfigure router string mpls lsp-template string igp-shortcut lfa-type keyword
Treelfa-type
Optionslfa-protect, lfa-only

Notes

The following elements are part of a choice: lfa-type or relative-metric.

Introduced16.0.R1

Platforms

All

relative-metric number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisShortest IGP cost between the endpoints of the LSP plus the configured offset
Contextconfigure router string mpls lsp-template string igp-shortcut relative-metric number
Treerelative-metric
Range-10 to 10

Notes

The following elements are part of a choice: lfa-type or relative-metric.

Introduced16.0.R1

Platforms

All

label-stack-reduction boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable label compression for LSP path
Contextconfigure router string mpls lsp-template string label-stack-reduction boolean
Treelabel-stack-reduction
Defaultfalse
Introduced19.7.R1

Platforms

All

ldp-over-rsvp boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisInclude this LSP in LDP over RSVP
Contextconfigure router string mpls lsp-template string ldp-over-rsvp boolean
Treeldp-over-rsvp
Defaulttrue
Introduced16.0.R1

Platforms

All

least-fill boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable least-fill path selection for this LSP template
Contextconfigure router string mpls lsp-template string least-fill boolean
Treeleast-fill
Defaultfalse
Introduced16.0.R1

Platforms

All

load-balancing-weight number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLoad balancing weight for an MPLS LSP template
Contextconfigure router string mpls lsp-template string load-balancing-weight number
Treeload-balancing-weight
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

local-sr-protection keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal SR protection preference for LSP path computation
Contextconfigure router string mpls lsp-template string local-sr-protection keyword
Treelocal-sr-protection
Optionsnone, preferred, mandatory
Defaultpreferred
Introduced19.7.R1

Platforms

All

lsp-self-ping keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLSP Self Ping activation status on RSVP-TE LSP template
Contextconfigure router string mpls lsp-template string lsp-self-ping keyword
Treelsp-self-ping

Description

When configured, the system uses this setting for the LSP template regardless of the value configured under configure router mpls lsp-self-ping rsvp-te.

When unconfigured, the command inherits the value configured under configure router mpls lsp-self-ping rsvp-te.

Optionsfalse, true
Introduced 19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

main-ct-retry-limit number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of retries before reverting to backup CT
Contextconfigure router string mpls lsp-template string main-ct-retry-limit number
Treemain-ct-retry-limit
Range1 to 10000
Introduced16.0.R1

Platforms

All

max-sr-labels
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the max-sr-labels context
Contextconfigure router string mpls lsp-template string max-sr-labels
Treemax-sr-labels
Introduced16.0.R1

Platforms

All

additional-frr-labels number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of additional overhead labels
Contextconfigure router string mpls lsp-template string max-sr-labels additional-frr-labels number
Treeadditional-frr-labels
Range0 to 4
Default1
Introduced 16.0.R1

Platforms

All

label-stack-size number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSize for the maximum segment routing label stack
Contextconfigure router string mpls lsp-template string max-sr-labels label-stack-size number
Treelabel-stack-size
Range1 to 11
Introduced16.0.R1

Platforms

All

metric number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLSP template metric
Contextconfigure router string mpls lsp-template string metric number
Treemetric
Range0 to 16777215
Default0
Introduced 16.0.R1

Platforms

All

metric-type keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMetric type used for LSP path computation
Contextconfigure router string mpls lsp-template string metric-type keyword
Treemetric-type
Optionsigp, te
Default igp
Introduced19.7.R1

Platforms

All

override-tunnel-elc boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisOverride any received entropy label capability
Contextconfigure router string mpls lsp-template string override-tunnel-elc boolean
Treeoverride-tunnel-elc

Description

When configured to true, this command allows the system to override any received entropy label capability advertisement.

When configured to false, this command disables the override.

Defaultfalse
Introduced21.10.R1

Platforms

All

path-computation-method keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisPath computation method
Contextconfigure router string mpls lsp-template string path-computation-method keyword
Treepath-computation-method

Description

This command configures the path computation method of an RSVP-TE or SR-TE LSP.

If this command is not configured to one of the supported options, the default path computation method is used depending on the type of LSP; the hop-to-label translation is used for the SR-TE LSP template and the IGP-based path is used for the RSVP-TE-LSP.

See "SR-TE LSP path computation using hop-to-label translation" in the 7750 Service Router and 7950 Extensible Routing System Segment Routing nad PCE User Guide for more information.

Optionslocal-cspf, pce
Introduced 19.7.R1

Platforms

All

path-profile [profile-id] number
Synopsis Enter the path-profile list instance
Contextconfigure router string mpls lsp-template string path-profile number
Treepath-profile

Description

Commands in this context configure the attributes of the PCE path profile.

Max. Instances5
Introduced21.10.R1

Platforms

All

[profile-id] number
Synopsis Profile ID for the specified LSP
Context configure router string mpls lsp-template string path-profile number
Treepath-profile
Range1 to 4294967295

Notes

This element is part of a list key.

Introduced21.10.R1

Platforms

All

pce-associations
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the pce-associations context
Contextconfigure router string mpls lsp-template string pce-associations
Treepce-associations

Description

Commands in this context configure the LSP binding with one or more PCEP associations.

Introduced22.5.R1

Platforms

All

diversity [diversity-name] reference
Synopsis Add a list entry for diversity
Contextconfigure router string mpls lsp-template string pce-associations diversity reference
Treediversity

Description

Commands in this context bind the LSP to a named diversity association. The diversity association must exist under the PCC.

Max. Instances5
Introduced22.5.R1

Platforms

All

policy [policy-name] reference
Synopsis Add a list entry for policy
Context configure router string mpls lsp-template string pce-associations policy reference
Treepolicy

Description

Commands in this context bind the LSP to a named policy association. The policy association name must exist under the PCC.

Max. Instances5
Introduced22.5.R1

Platforms

All

pce-control boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable PCE controlled LSP mode of operation
Contextconfigure router string mpls lsp-template string pce-control boolean
Treepce-control

Description

When configured to true, this command enables a PCE-controlled mode of operation for the LSP. In this mode, the router delegates full control of the LSP to the PCE (PCE controlled). The PCE acts in stateful-active mode for this LSP and is able to reroute the path following a failure or to re-optimize the path and update the router without a request from the router.

When configured to false, the PCE-controlled mode of operation for the LSP has no effect.

Defaultfalse
Introduced21.10.R1

Platforms

All

pce-report keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable reporting modes to PCE for RSVP-TE or SR-TE LSPs
Contextconfigure router string mpls lsp-template string pce-report keyword
Treepce-report
Optionsfalse, true
Introduced 16.0.R1

Platforms

All

priority
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the priority context
Contextconfigure router string mpls lsp-template string priority
Treepriority
Introduced16.0.R1

Platforms

All

hold-priority number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisHold priority when insufficient bandwidth is available to set up LSP
Contextconfigure router string mpls lsp-template string priority hold-priority number
Treehold-priority
Range0 to 7
Default0
Introduced 16.0.R1

Platforms

All

setup-priority number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSetup priority when insufficient bandwidth is available to set up LSP
Contextconfigure router string mpls lsp-template string priority setup-priority number
Treesetup-priority
Range0 to 7
Default7
Introduced 16.0.R1

Platforms

All

propagate-admin-group boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable admin groups via session attribute object
Contextconfigure router string mpls lsp-template string propagate-admin-group boolean
Treepropagate-admin-group
Defaultfalse
Introduced16.0.R1

Platforms

All

record boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable recording of all hops for this LSP template
Contextconfigure router string mpls lsp-template string record boolean
Treerecord
Defaulttrue
Introduced16.0.R1

Platforms

All

record-label boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable recording of labels at each node or instance
Contextconfigure router string mpls lsp-template string record-label boolean
Treerecord-label
Defaulttrue
Introduced16.0.R1

Platforms

All

retry-limit number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisNumber of attempts to re-establish LSP after it fails
Contextconfigure router string mpls lsp-template string retry-limit number
Treeretry-limit
Range1 to 10000
Introduced16.0.R1

Platforms

All

retry-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime for LSP re-establishment attempts after failure
Contextconfigure router string mpls lsp-template string retry-timer number
Treeretry-timer
Range1 to 600
Unitsseconds
Default 30
Introduced16.0.R1

Platforms

All

soft-preemption boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable soft preemption
Contextconfigure router string mpls lsp-template string soft-preemption boolean
Treesoft-preemption

Description

When configured to true, the P2MP LSP preemption is governed by the configure router rsvp preemption-timer value.

When configured to false, the preemption timer value is set to 0 and the P2MP LSPs are hard preempted. 

For P2P LSPs, soft preemption is always enabled and cannot be disabled.

Introduced22.2.R1

Platforms

All

template-id (number | keyword)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTemplate ID
Contextconfigure router string mpls lsp-template string template-id (number | keyword)
Treetemplate-id

Description

This command specifies the value that is signaled in the PCE to identify the LSP template.

Range1 to 4294967295
Optionsdefault
Introduced16.0.R5

Platforms

All

type keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisLSP template type
Contextconfigure router string mpls lsp-template string type keyword
Treetype

Description

This command configures the type of a template that can be referenced by a client application where dynamic LSP creation is required. The LSP template type is mandatory.

Optionsp2mp-rsvp, p2p-rsvp-one-hop, p2p-rsvp-mesh, p2p-sr-te-one-hop, p2p-sr-te-mesh, p2p-sr-te-pce-init, p2p-sr-te-on-demand

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

vprn-auto-bind boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisInclude LSP template in auto-bind for VPRN services
Contextconfigure router string mpls lsp-template string vprn-auto-bind boolean
Treevprn-auto-bind
Defaulttrue
Introduced16.0.R1

Platforms

All

p2mp-ttl-propagate boolean
Synopsis Use uniform mode for TTL propagation for RSVP P2MP LSPs
Contextconfigure router string mpls p2mp-ttl-propagate boolean
Treep2mp-ttl-propagate

Description

When configured to true, the router configures the uniform mode of operation for P2MP LSPs.

When configured to false, the router configures the pipe mode of operation for RSVP P2MP LSPs.

When the propagation mode is modified, the new configuration applies to future RSVP P2MP LSPs only and the existing operational LSPs are not affected.

Defaulttrue
Introduced23.7.R1

Platforms

All

path [path-name] string
Synopsis Enter the path list instance
Context configure router string mpls path string
Treepath
Max. Instances65535
Introduced16.0.R1

Platforms

All

[path-name] string
Synopsis Name for this LSP path
Context configure router string mpls path string
Treepath
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the path used for LSPs
Contextconfigure router string mpls path string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

hop [hop-index] number
Synopsis Enter the hop list instance
Context configure router string mpls path string hop number
Treehop
Max. Instances255
Introduced16.0.R1

Platforms

All

[hop-index] number
Synopsis Index to identify a particular hop
Context configure router string mpls path string hop number
Treehop
Range1 to 1024

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisIP address of the transit router
Contextconfigure router string mpls path string hop number ip-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeip-address

Notes

The following elements are part of a mandatory choice: (ip-address and type) or sid-label.

Introduced16.0.R1

Platforms

All

sid-label number
Synopsis MPLS label for tunnel hop in the path of an SR-TE LSP
Contextconfigure router string mpls path string hop number sid-label number
Treesid-label
Range32 to 1048575

Notes

The following elements are part of a mandatory choice: (ip-address and type) or sid-label.

Introduced19.10.R1

Platforms

All

type keyword
Synopsis Tunnel hop type
Context configure router string mpls path string hop number type keyword
Treetype
Optionsstrict, loose

Notes

The following elements are part of a mandatory choice: (ip-address and type) or sid-label.

Introduced16.0.R1

Platforms

All

pce-init-lsp
Synopsis Enable the pce-init-lsp context
Contextconfigure router string mpls pce-init-lsp
Treepce-init-lsp
Introduced16.0.R5

Platforms

All

pce-report
Synopsis Enter the pce-report context
Context configure router string mpls pce-report
Treepce-report
Introduced16.0.R1

Platforms

All

rsvp-te boolean
Synopsis Allow PCE reporting for all TE LSPs of RSVP-TE type
Contextconfigure router string mpls pce-report rsvp-te boolean
Treersvp-te
Defaultfalse
Introduced16.0.R1

Platforms

All

sr-te boolean
Synopsis Allow PCE reporting for all TE LSPs of SR-TE type
Contextconfigure router string mpls pce-report sr-te boolean
Treesr-te
Defaultfalse
Introduced16.0.R1

Platforms

All

resignal-on-igp-overload boolean
Synopsis Resignal all RSVP-TE LSPs upon IGP overload
Contextconfigure router string mpls resignal-on-igp-overload boolean
Treeresignal-on-igp-overload

Description

When configured to true, the receipt of the IS-IS overload bit in the TE-DB triggers the immediate resignaling of all RSVP-TE LSPs. MPLS forces the expiry of the resignal timer and the TE-DB computes a new CSPF for each RSVP-TE LSP active path. The re-optimization causes the immediate transition of RSVP-TE LSP paths away from the IS-IS node in overload using the MBB operation.

This command cannot be configured to true when the retry-on-igp-overload command is configured to true.

When configured to false, the default behavior is maintained where MBB re-optimization occurs only when a timer-based resignal is performed or a manual resignal is executed.

Defaultfalse
Introduced20.10.R1

Platforms

All

resignal-timer number
Synopsis Resignal timer for RSVP LSPs
Context configure router string mpls resignal-timer number
Treeresignal-timer
Range30 to 10080
Unitsminutes
Introduced 16.0.R1

Platforms

All

sr-te-resignal
Synopsis Enter the sr-te-resignal context
Contextconfigure router string mpls sr-te-resignal
Treesr-te-resignal
Introduced19.10.R1

Platforms

All

resignal-on-igp-event boolean
Synopsis Re-optimize SR-TE LSPs upon IGP link events
Contextconfigure router string mpls sr-te-resignal resignal-on-igp-event boolean
Treeresignal-on-igp-event

Description

When configured to true, the system signals the re-optimization of all SR-TE LSPs when one or more IGP link down events are received in the TE-DB. The triggered behavior is identical to the timer-based or resignal behavior or the manual-based resignal behavior used with a delay option. MPLS forces the expiry of the resignal timer and all active paths of all SR-TE LSPs are re-evaluated.

When configured to false, re-optimization is not triggered by IGP events.

Defaultfalse
Introduced19.10.R1

Platforms

All

resignal-on-igp-overload boolean
Synopsis Enable resignaling of SR-TE LSPs upon IGP overload
Contextconfigure router string mpls sr-te-resignal resignal-on-igp-overload boolean
Treeresignal-on-igp-overload

Description

When configured to true, the system enables ad-hoc re-optimzation of the CSPF paths of all SR-TE LSPs when IS-IS receives an IS-IS overload bit advertisement from a remote router.

When this command is enabled on the router and an IGP overload bit is set in a Layer 1 or Layer 2 IS-IS LSP received from a remote router, MPLS performs an ad-hoc re-optimization of all the paths of all the SR-TE LSPs that have paths computed by the local CSPF. For each SR-TE LSP current path that transits the router in overload, the CSPF looks for a new path that avoids the router. For each SR-TE LSP current path that terminates on the router in overload, the CSPF checks if a better path exists. In both cases, if a new path is not found the system maintains the current path when operationally up.

The ad-hoc re-optimization triggers the timer-based re-optimization by forcing the resignal timer to expire. Therefore, the user must use the configure router mpls sr-te-resignal resignal-timer command to configure the resignal timer for the SR-TE application.

When configured to false, MPLS does not act immediately on an IS-IS overload bit from a remote router. MPLS acts on it at the next timer-based or manual re-optimization of the SR-TE LSPs.

Defaultfalse
Introduced23.3.R1

Platforms

All

resignal-timer number
Synopsis Resignal timer for SR-TE LSPs
Context configure router string mpls sr-te-resignal resignal-timer number
Treeresignal-timer

Description

This command configures the time the system waits before signaling the re-optimization of all SR-TE LSPs.

Range30 to 10080
Unitsminutes
Introduced 19.10.R1

Platforms

All

srlg-database
Synopsis Enter the srlg-database context
Contextconfigure router string mpls srlg-database
Treesrlg-database
Introduced16.0.R1

Platforms

All

router-id [router-address] string
Synopsis Enter the router-id list instance
Contextconfigure router string mpls srlg-database router-id string
Treerouter-id
Introduced16.0.R1

Platforms

All

[router-address] string
Synopsis Router ID for the system
Context configure router string mpls srlg-database router-id string
Treerouter-id

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

interface [interface-address] string srlg-group reference
Synopsis Add a list entry for interface
Contextconfigure router string mpls srlg-database router-id string interface string srlg-group reference
Treeinterface
Introduced16.0.R1

Platforms

All

srlg-frr keyword
Synopsis Use of SRLG constraint for FRR path computation
Contextconfigure router string mpls srlg-frr keyword
Treesrlg-frr
Optionsloose, strict
Introduced 16.0.R1

Platforms

All

static-lsp [lsp-name] string
Synopsis Enter the static-lsp list instance
Contextconfigure router string mpls static-lsp string
Treestatic-lsp
Max. Instances1000
Introduced16.0.R1

Platforms

All

[lsp-name] string
Synopsis Labeled Switch path name
Context configure router string mpls static-lsp string
Treestatic-lsp
String Length1 to 64

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the static LSP
Contextconfigure router string mpls static-lsp string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

metric number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMPLS static LSP metric to select an LSP
Contextconfigure router string mpls static-lsp string metric number
Treemetric
Range1 to 16777215
Introduced16.0.R1

Platforms

All

push
Synopsis Enable the push context
Context configure router string mpls static-lsp string push
Treepush
Introduced16.0.R1

Platforms

All

next-hop string
Synopsis IP address for the next hop
Context configure router string mpls static-lsp string push next-hop string
Treenext-hop

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

out-label (number | keyword)
Synopsis Push specific label onto the top of the outgoing packet's label stack
Contextconfigure router string mpls static-lsp string push out-label (number | keyword)
Treeout-label
Range16 to 1048575
Optionsimplicit-null-label

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

to string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDestination IP address or the egress router for the LSP
Contextconfigure router string mpls static-lsp string to string
Treeto
Introduced16.0.R1

Platforms

All

strict-ero-nhop-direct-resolution boolean
Synopsis Resolves RSVP-TE LSP ERO to local and host routes only
Contextconfigure router string mpls strict-ero-nhop-direct-resolution boolean
Treestrict-ero-nhop-direct-resolution

Description

When configured to true, the router enables the strict Explicit Route Object (ERO) next-hop direct resolution. The feature restricts the routes used to resolve the next hop of an ERO address to local and host routes. This command avoids using a next hop over a parallel link when a half link is up in the routing table.

This command applies to an ERO when all of the following conditions are met:

  • the ERO next hop is an IPv4 address

  • the ERO object is a strict hop

  • the IPv4 address matches the primary subnet of a local numbered interface

If no such route exists, RSVP rejects the PATH message with ErrCode = Routing Error (24) and SubErrCode = Bad Strict Node (2).

When configured to false, the router disables the strict ERO next-hop direct resolution.

Defaultfalse
Introduced22.5.R1

Platforms

All

tunnel-table-pref
Synopsis Enter the tunnel-table-pref context
Contextconfigure router string mpls tunnel-table-pref
Treetunnel-table-pref

Description

Commands in this context configure the tunnel table preference for RSVP-TE LSP and SR-TE LSP tunnel types.

Introduced21.10.R1

Platforms

All

rsvp-te number
Synopsis RSVP-TE tunnel table preference
Context configure router string mpls tunnel-table-pref rsvp-te number
Treersvp-te

Description

This command configures the tunnel table preference for RSVP-TE LSP tunnel type.

The tunnel table preference applies to next-hop resolution of BGP routes for: EVPN, IPv4, IPv6, VPN-IPv4, VPN-IPv6, label-IPv4, and label-IPV6 in the tunnel table.

This feature does not apply to a VPRN, VPLS, or VLL service with explicit binding to an SDP that enabled the mixed-lsp-mode option. The service manager controls and fixes the tunnel preference in such an SDP. The tunnel table preference configuration does not modify the SDP behavior, nor the services that bind to it.

Nokia recommends that tunnel types have unique preference values. In a situation where two or more tunnel types are set to the same preference value, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default7
Introduced 21.10.R1

Platforms

All

sr-te number
Synopsis SR-TE tunnel table preference
Context configure router string mpls tunnel-table-pref sr-te number
Treesr-te

Description

This command configures the tunnel table preference for SR-TE LSP tunnel type.

The tunnel table preference applies to next-hop resolution of BGP routes for: EVPN, IPv4, IPv6, VPN-IPv4, VPN-IPv6, label-IPv4, and label-IPV6 in the tunnel table.

This feature does not apply to a VPRN, VPLS, or VLL service with explicit binding to an SDP that enabled the mixed-lsp-mode option. The service manager controls and fixes the tunnel preference in such an SDP. The tunnel table preference configuration does not modify the SDP behavior, nor the services that bind to it.

It is recommended to not set two or more tunnel types to the same preference value. In such a situation, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default8
Introduced 21.10.R1

Platforms

All

user-srlg-db boolean
Synopsis Enable the use of user SRLG database
Context configure router string mpls user-srlg-db boolean
Treeuser-srlg-db
Defaultfalse
Introduced16.0.R1

Platforms

All

mpls-labels

Synopsis Enter the mpls-labels context
Context configure router string mpls-labels
Treempls-labels
Introduced16.0.R1

Platforms

All

reserved-label-block [label-block-name] string
Synopsis Enter the reserved-label-block list instance
Contextconfigure router string mpls-labels reserved-label-block string
Treereserved-label-block

Description

Commands in this context configure a block of labels from the dynamic range to be locally assigned for specific applications, such as segment routing adjacency SIDs. The reserved label block is not advertised by the IGP.

Note: Changes to the reserved label block range do not impact the actual MPLS datapath table sizes.

Max. Instances16
Introduced16.0.R1

Platforms

All

sr-labels
Synopsis Enter the sr-labels context
Context configure router string mpls-labels sr-labels
Treesr-labels

Description

Commands in this context configure the range of the Segment Routing Global Block (SRGB), which assigns labels to segment routing prefix SIDs originated by this router. The range is taken from the system dynamic label range and is not instantiated by default.

Segment routing labels are reserved labels. After they are instantiated, they cannot be used for dynamic label assignment by other protocols, such as RSVP, LDP, and BGP.

Note: Changes to the SRGB range do not impact the actual MPLS datapath table sizes.

Introduced16.0.R1

Platforms

All

end number
Synopsis Upper bound of the label range
Context configure router string mpls-labels sr-labels end number
Treeend
Range32 to 1048575
Introduced16.0.R1

Platforms

All

msdp

Synopsis Enable the msdp context
Context configure router string msdp
Treemsdp

Description

Commands in this context configure Multicast Source Discovery Protocol (MSDP) for the router.

Introduced19.10.R1

Platforms

All

active-source-limit number
Synopsis Maximum source-active messages accepted by MSDP
Contextconfigure router string msdp active-source-limit number
Treeactive-source-limit

Description

This command configures the maximum number of source-active (SA) messages that are accepted by MSDP, effectively controlling the number of active sources that the system can store.

When unconfigured, the system sets no limit on the number of SA messages it can accept.

Range0 to 1000000
Introduced19.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of MSDP
Context configure router string msdp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced19.10.R1

Platforms

All

data-encapsulation boolean
Synopsis Enable encapsulation of multicast data used by MSDP
Contextconfigure router string msdp data-encapsulation boolean
Treedata-encapsulation

Description

When configured to true, the system (acting as the rendezvous point [RP]) encapsulates multicast data received from MSDP register messages inside forwarded MSDP SA messages.

Defaulttrue
Introduced19.10.R1

Platforms

All

export-policy reference
Synopsis Policy to export source-active states into MSDP
Contextconfigure router string msdp export-policy reference
Treeexport-policy

Description

This command specifies the policy used to export SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

group [name] string
Synopsis Enter the group list instance
Context configure router string msdp group string
Treegroup

Description

Commands in this context configure an MSDP group.

By default, group options are inherited from the global MSDP options. To override these global options, configure the group-specific options within this context.

For a group to function, at least one peer must be configured in the group.

Introduced19.10.R1

Platforms

All

[name] string
Synopsis MSDP group name
Context configure router string msdp group string
Treegroup
String Length1 to 32

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

active-source-limit number
Synopsis Maximum source-active messages accepted by MSDP
Contextconfigure router string msdp group string active-source-limit number
Treeactive-source-limit

Description

This command configures the maximum number of source-active (SA) messages that are accepted by MSDP, effectively controlling the number of active sources that the system can store.

When unconfigured, the system sets no limit on the number of SA messages it can accept.

Range0 to 1000000
Introduced19.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of MSDP
Context configure router string msdp group string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced19.10.R1

Platforms

All

export-policy reference
Synopsis Policy to export source-active states into MSDP
Contextconfigure router string msdp group string export-policy reference
Treeexport-policy

Description

This command specifies the policy used to export SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

import-policy reference
Synopsis Policy to import source-active states into MSDP
Contextconfigure router string msdp group string import-policy reference
Treeimport-policy

Description

This command specifies the policy used to import SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

local-address string
Synopsis Local end IP address of the MSDP group
Contextconfigure router string msdp group string local-address string
Treelocal-address

Description

This command configures the local end address of an MSDP session. For MSDP to function, at least one peer with a local address must be configured. This address must be present on the node and is used to validate incoming connections to the peer and to establish connections to the remote peer.

The specified IP address is validated and used as the local address for MSDP peers from that point. If a subsequent address is configured, it replaces the existing configuration and terminates any existing sessions

When a session is terminated, all information pertaining to and learned from that peer is removed. When a new peering session is created or a peering session is lost, an event message is generated.

Introduced19.10.R1

Platforms

All

mode keyword
Synopsis Topology of the group of peers
Context configure router string msdp group string mode keyword
Treemode

Description

This command configures the MSDP group topology. MSDP peers can be grouped in a full-mesh topology to prevent excessive flooding of SA messages to neighboring peers.

In a mesh group, SA messages received from a mesh group member are always accepted but are not flooded to other members of the same mesh group. These SA messages are only flooded to non-mesh group peers or members of other mesh groups.

Note: In a meshed configuration, all members of the group must have a peer connection with every other mesh group member. If this rule is not adhered to, unpredictable results may occur.

Optionsstandard, mesh-group
Default standard
Introduced19.10.R1

Platforms

All

peer [ip-address] string
Synopsis Enter the peer list instance
Context configure router string msdp group string peer string
Treepeer

Description

Commands in this context configure an MSDP group peer. For MSDP to function, at least one peer with a local address must be configured.

After peer relationships are established, the MSDP peers exchange messages to advertise active multicast sources.

By default, the options applied to a peer are inherited from the global or group level. To override these inherited options, configure the peer-specific options within this context.

Introduced19.10.R1

Platforms

All

[ip-address] string
Synopsis IP address of the remote MSDP router for peering
Contextconfigure router string msdp group string peer string
Treepeer

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

active-source-limit number
Synopsis Maximum source-active messages accepted by MSDP
Contextconfigure router string msdp group string peer string active-source-limit number
Treeactive-source-limit

Description

This command configures the maximum number of source-active (SA) messages that are accepted by MSDP, effectively controlling the number of active sources that the system can store.

When unconfigured, the system sets no limit on the number of SA messages it can accept.

Range0 to 1000000
Introduced19.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of MSDP
Context configure router string msdp group string peer string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced19.10.R1

Platforms

All

authentication-key string
Synopsis MD5 authentication key for the MSDP peering session
Contextconfigure router string msdp group string peer string authentication-key string
Treeauthentication-key

Description

This command configures a Message Digest 5 (MD5) authentication key to be used with a specific MSDP peering session. The authentication key is not inherited from the global or group level and must be configured per peer.

String Length1 to 370
Introduced19.10.R1

Platforms

All

default-peer boolean
Synopsis Set the peer as a default MSDP peer
Context configure router string msdp group string peer string default-peer boolean
Treedefault-peer

Description

When configured to true, the system sets the peer as a default MSDP peer. All SA messages from a default peer are accepted without the usual peer-reverse-path-forwarding (RPF) check.

Unlike the normal multicast RPF checks, the peer-RPF check stops SA messages from looping.

When configured to false, the system sets the peer as a non-default peer, which forces all SA messages from the peer to be RPF checked.

See "Peer-RPF check" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Multicast Routing Protocols Guide for information about the peer-RPF check rules.

Defaultfalse
Introduced19.10.R1

Platforms

All

export-policy reference
Synopsis Policy to export source-active states into MSDP
Contextconfigure router string msdp group string peer string export-policy reference
Treeexport-policy

Description

This command specifies the policy used to export SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

import-policy reference
Synopsis Policy to import source-active states into MSDP
Contextconfigure router string msdp group string peer string import-policy reference
Treeimport-policy

Description

This command specifies the policy used to import SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

local-address string
Synopsis Local end IP address of the MSDP group
Contextconfigure router string msdp group string peer string local-address string
Treelocal-address

Description

This command configures the local end address of an MSDP session. For MSDP to function, at least one peer with a local address must be configured. This address must be present on the node and is used to validate incoming connections to the peer and to establish connections to the remote peer.

The specified IP address is validated and used as the local address for MSDP peers from that point. If a subsequent address is configured, it replaces the existing configuration and terminates any existing sessions

When a session is terminated, all information pertaining to and learned from that peer is removed. When a new peering session is created or a peering session is lost, an event message is generated.

Introduced19.10.R1

Platforms

All

receive-message-rate
Synopsis Enter the receive-message-rate context
Contextconfigure router string msdp group string peer string receive-message-rate
Treereceive-message-rate

Description

Commands in this context configure rate limiting for the number of MSDP messages that the router can read from the TCP session.

Introduced19.10.R1

Platforms

All

rate number
Synopsis Maximum number of MSDP messages read from TCP session
Contextconfigure router string msdp group string peer string receive-message-rate rate number
Treerate

Description

This command configures the maximum number of MSDP messages that the MSDP or RP router can read from the TCP session when message rate limiting is active. When this limit is reached within the time interval configured using the configure router msdp group peer receive-message-rate time command, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range10 to 10000
Introduced19.10.R1

Platforms

All

threshold number
Synopsis Processed MSDP message limit to activate rate limiting
Contextconfigure router string msdp group string peer string receive-message-rate threshold number
Treethreshold

Description

This command configures the number of MSDP messages that the router can process before it activates message rate limiting.

Range1 to 1000000
Introduced19.10.R1

Platforms

All

time number
Synopsis Time interval to rate limit MSDP messages
Contextconfigure router string msdp group string peer string receive-message-rate time number
Treetime

Description

This command configures the time interval to rate limit MSDP messages read from the TCP session. When the message limit, configured using the configure router msdp group peer receive-message-rate rate command, is reached within this time interval, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range1 to 600
Unitsseconds
Introduced 19.10.R1

Platforms

All

receive-message-rate
Synopsis Enter the receive-message-rate context
Contextconfigure router string msdp group string receive-message-rate
Treereceive-message-rate

Description

Commands in this context configure rate limiting for the number of MSDP messages that the router can read from the TCP session.

Introduced19.10.R1

Platforms

All

rate number
Synopsis Maximum number of MSDP messages read from TCP session
Contextconfigure router string msdp group string receive-message-rate rate number
Treerate

Description

This command configures the maximum number of MSDP messages that the MSDP or RP router can read from the TCP session when message rate limiting is active. When this limit is reached within the time interval configured using the configure router msdp group peer receive-message-rate time command, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range10 to 10000
Introduced19.10.R1

Platforms

All

threshold number
Synopsis Processed MSDP message limit to activate rate limiting
Contextconfigure router string msdp group string receive-message-rate threshold number
Treethreshold

Description

This command configures the number of MSDP messages that the router can process before it activates message rate limiting.

Range1 to 1000000
Introduced19.10.R1

Platforms

All

time number
Synopsis Time interval to rate limit MSDP messages
Contextconfigure router string msdp group string receive-message-rate time number
Treetime

Description

This command configures the time interval to rate limit MSDP messages read from the TCP session. When the message limit, configured using the configure router msdp group peer receive-message-rate rate command, is reached within this time interval, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range1 to 600
Unitsseconds
Introduced 19.10.R1

Platforms

All

import-policy reference
Synopsis Policy to import source-active states into MSDP
Contextconfigure router string msdp import-policy reference
Treeimport-policy

Description

This command specifies the policy used to import SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

local-address string
Synopsis Local end IP address of the MSDP group
Contextconfigure router string msdp local-address string
Treelocal-address

Description

This command configures the local end address of an MSDP session. For MSDP to function, at least one peer with a local address must be configured. This address must be present on the node and is used to validate incoming connections to the peer and to establish connections to the remote peer.

The specified IP address is validated and used as the local address for MSDP peers from that point. If a subsequent address is configured, it replaces the existing configuration and terminates any existing sessions

When a session is terminated, all information pertaining to and learned from that peer is removed. When a new peering session is created or a peering session is lost, an event message is generated.

Introduced19.10.R1

Platforms

All

peer [ip-address] string
Synopsis Enter the peer list instance
Context configure router string msdp peer string
Treepeer

Description

Commands in this context configure an MSDP peer. For MSDP to function, at least one peer with a local address must be configured.

After peer relationships are established, the MSDP peers exchange messages to advertise active multicast sources.

By default, the options applied to a peer are inherited from the global level. To override these inherited options, configure the peer-specific options within this context.

Introduced19.10.R1

Platforms

All

[ip-address] string
Synopsis IP address of the remote MSDP router for peering
Contextconfigure router string msdp peer string
Treepeer

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

active-source-limit number
Synopsis Maximum source-active messages accepted by MSDP
Contextconfigure router string msdp peer string active-source-limit number
Treeactive-source-limit

Description

This command configures the maximum number of source-active (SA) messages that are accepted by MSDP, effectively controlling the number of active sources that the system can store.

When unconfigured, the system sets no limit on the number of SA messages it can accept.

Range0 to 1000000
Introduced19.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of MSDP
Context configure router string msdp peer string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced19.10.R1

Platforms

All

authentication-key string
Synopsis MD5 authentication key for the MSDP peering session
Contextconfigure router string msdp peer string authentication-key string
Treeauthentication-key

Description

This command configures an MD5 authentication key to be used with a specific MSDP peering session. The authentication key is not inherited from the global level and must be configured per peer.

String Length1 to 370
Introduced19.10.R1

Platforms

All

default-peer boolean
Synopsis Set the peer as a default MSDP peer
Context configure router string msdp peer string default-peer boolean
Treedefault-peer

Description

When configured to true, the system sets the peer as a default MSDP peer. All SA messages from a default peer are accepted without the usual peer-reverse-path-forwarding (RPF) check.

Unlike the normal multicast RPF checks, the peer-RPF check stops SA messages from looping.

When configured to false, the system sets the peer as a non-default peer, which forces all SA messages from the peer to be RPF checked.

See "Peer-RPF check" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Multicast Routing Protocols Guide for information about the peer-RPF check rules.

Defaultfalse
Introduced19.10.R1

Platforms

All

export-policy reference
Synopsis Policy to export source-active states into MSDP
Contextconfigure router string msdp peer string export-policy reference
Treeexport-policy

Description

This command specifies the policy used to export SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

import-policy reference
Synopsis Policy to import source-active states into MSDP
Contextconfigure router string msdp peer string import-policy reference
Treeimport-policy

Description

This command specifies the policy used to import SA states from the SA list into MSDP.

If multiple policy names are specified, the router evaluates the policies in the order they are specified, and applies the first policy that matches.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced19.10.R1

Platforms

All

local-address string
Synopsis Local end IP address of the MSDP group
Contextconfigure router string msdp peer string local-address string
Treelocal-address

Description

This command configures the local end address of an MSDP session. For MSDP to function, at least one peer with a local address must be configured. This address must be present on the node and is used to validate incoming connections to the peer and to establish connections to the remote peer.

The specified IP address is validated and used as the local address for MSDP peers from that point. If a subsequent address is configured, it replaces the existing configuration and terminates any existing sessions

When a session is terminated, all information pertaining to and learned from that peer is removed. When a new peering session is created or a peering session is lost, an event message is generated.

Introduced19.10.R1

Platforms

All

receive-message-rate
Synopsis Enter the receive-message-rate context
Contextconfigure router string msdp peer string receive-message-rate
Treereceive-message-rate

Description

Commands in this context configure rate limiting for the number of MSDP messages that the router can read from the TCP session.

Introduced19.10.R1

Platforms

All

rate number
Synopsis Maximum number of MSDP messages read from TCP session
Contextconfigure router string msdp peer string receive-message-rate rate number
Treerate

Description

This command configures the maximum number of MSDP messages that the MSDP or RP router can read from the TCP session when message rate limiting is active. When this limit is reached within the time interval configured using the configure router msdp group peer receive-message-rate time command, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range10 to 10000
Introduced19.10.R1

Platforms

All

threshold number
Synopsis Processed MSDP message limit to activate rate limiting
Contextconfigure router string msdp peer string receive-message-rate threshold number
Treethreshold

Description

This command configures the number of MSDP messages that the router can process before it activates message rate limiting.

Range1 to 1000000
Introduced19.10.R1

Platforms

All

time number
Synopsis Time interval to rate limit MSDP messages
Contextconfigure router string msdp peer string receive-message-rate time number
Treetime

Description

This command configures the time interval to rate limit MSDP messages read from the TCP session. When the message limit, configured using the configure router msdp group peer receive-message-rate rate command, is reached within this time interval, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range1 to 600
Unitsseconds
Introduced 19.10.R1

Platforms

All

receive-message-rate
Synopsis Enter the receive-message-rate context
Contextconfigure router string msdp receive-message-rate
Treereceive-message-rate

Description

Commands in this context configure rate limiting for the number of MSDP messages that the router can read from the TCP session.

Introduced19.10.R1

Platforms

All

rate number
Synopsis Maximum number of MSDP messages read from TCP session
Contextconfigure router string msdp receive-message-rate rate number
Treerate

Description

This command configures the maximum number of MSDP messages that the MSDP or RP router can read from the TCP session when message rate limiting is active. When this limit is reached within the time interval configured using the configure router msdp group peer receive-message-rate time command, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range10 to 10000
Introduced19.10.R1

Platforms

All

threshold number
Synopsis Processed MSDP message limit to activate rate limiting
Contextconfigure router string msdp receive-message-rate threshold number
Treethreshold

Description

This command configures the number of MSDP messages that the router can process before it activates message rate limiting.

Range1 to 1000000
Introduced19.10.R1

Platforms

All

time number
Synopsis Time interval to rate limit MSDP messages
Contextconfigure router string msdp receive-message-rate time number
Treetime

Description

This command configures the time interval to rate limit MSDP messages read from the TCP session. When the message limit, configured using the configure router msdp group peer receive-message-rate rate command, is reached within this time interval, the router stops accepting messages from the TCP session until the time interval has elapsed.

Range1 to 600
Unitsseconds
Introduced 19.10.R1

Platforms

All

rpf-table keyword
Synopsis Route tables for RPF lookup
Context configure router string msdp rpf-table keyword
Treerpf-table

Description

This command configures the sequence of route tables used to find an RPF interface for a multicast route.

By default, the router only uses the unicast route table to calculate RPF interface towards the source or rendezvous point. The user can specify the following options:

  • rtable-u - use the unicast route table only

  • rtable-m - use the multicast route table only

  • both - use both route tables

Optionsrtable-m, rtable-u, both
Defaultrtable-u
Introduced19.10.R1

Platforms

All

source [ip-prefix] string
Synopsis Enter the source list instance
Contextconfigure router string msdp source string
Treesource
Introduced19.10.R1

Platforms

All

[ip-prefix] string
Synopsis Source IP address for accepted source-active messages
Contextconfigure router string msdp source string
Treesource

Notes

This element is part of a list key.

Introduced19.10.R1

Platforms

All

active-source-limit number
Synopsis Number of source-active messages accepted by MSDP
Contextconfigure router string msdp source string active-source-limit number
Treeactive-source-limit

Description

This command configures the maximum number of SA messages that are accepted by the MSDP source, effectively controlling the number of active sources that the system can store.

When unconfigured, the system sets no limit on the number of SA messages it can accept.

Range0 to 1000000
Introduced19.10.R1

Platforms

All

source-active-cache-lifetime number
Synopsis Timeout interval for SA entries in the cache
Contextconfigure router string msdp source-active-cache-lifetime number
Treesource-active-cache-lifetime

Description

This command configures the timeout interval for the SA entries in the cache. If these entries are not refreshed within the timeout interval, they are removed from the cache. Normally, the entries are refreshed at least once per minute, but under high load with many MSDP peers, the refresh cycle could be incomplete. Configuring a higher timeout value is useful to prevent instabilities in the MSDP cache.

Range90 to 600
Unitsseconds
Default 90
Introduced19.10.R1

Platforms

All

mss-adjust

Synopsis Enable the mss-adjust context
Context configure router string mss-adjust
Treemss-adjust
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-group number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNAT group used for TCP-MSS adjustment
Contextconfigure router string mss-adjust nat-group number
Treenat-group
Max. Range0 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

segment-size number
Synopsis TCP-MSS option value in transmitted TCP SYN requests
Contextconfigure router string mss-adjust segment-size number
Treesegment-size
Range160 to 10240

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mtrace2

Synopsis Enter the mtrace2 context
Context configure router string mtrace2
Treemtrace2
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of multicast path tracing
Contextconfigure router string mtrace2 admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

udp-port number
Synopsis Destination and listening port for the mtrace2 command
Contextconfigure router string mtrace2 udp-port number
Treeudp-port
Range1024 to 49151
Default5000
Introduced 16.0.R1

Platforms

All

nat

Synopsis Enable the nat context
Context configure router string nat
Treenat
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

inside
Synopsis Enter the inside context
Context configure router string nat inside
Treeinside
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

l2-aware
Synopsis Enter the l2-aware context
Context configure router string nat inside l2-aware
Treel2-aware
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

force-unique-ip-addresses boolean
Synopsis Enforce unique IPv4 addresses for L2-aware subscribers
Contextconfigure router string nat inside l2-aware force-unique-ip-addresses boolean
Treeforce-unique-ip-addresses

Description

When configured to true, the system enforces the uniqueness of IPv4 addresses of L2-aware subscribers in an inside routing context.

This functionality is required if multicast sourced from the inside routing context is enabled for L2-aware subscribers.

Defaultfalse
Introduced23.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscribers [prefix] string
Synopsis Add a list entry for subscribers
Contextconfigure router string nat inside l2-aware subscribers string
Treesubscribers
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[prefix] string
Synopsis Layer-2 Aware NAT subscriber prefix
Context configure router string nat inside l2-aware subscribers string
Treesubscribers

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

large-scale
Synopsis Enter the large-scale context
Context configure router string nat inside large-scale
Treelarge-scale
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

dnat-only
Synopsis Enter the dnat-only context
Context configure router string nat inside large-scale dnat-only
Treednat-only
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

dual-stack-lite
Synopsis Enter the dual-stack-lite context
Contextconfigure router string nat inside large-scale dual-stack-lite
Treedual-stack-lite
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

deterministic
Synopsis Enter the deterministic context
Contextconfigure router string nat inside large-scale dual-stack-lite deterministic
Treedeterministic
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

prefix-map [source-prefix] string nat-policy reference
Synopsis Enter the prefix-map list instance
Contextconfigure router string nat inside large-scale dual-stack-lite deterministic prefix-map string nat-policy reference
Treeprefix-map
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

map [from] string to string
Synopsis Enter the map list instance
Context configure router string nat inside large-scale dual-stack-lite deterministic prefix-map string nat-policy reference map string to string
Treemap
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

first-outside-address string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisOutside IP address mapped to inside IP address range
Contextconfigure router string nat inside large-scale dual-stack-lite deterministic prefix-map string nat-policy reference map string to string first-outside-address string
Treefirst-outside-address

Notes

This element is mandatory.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

endpoint [address] string
Synopsis Enter the endpoint list instance
Contextconfigure router string nat inside large-scale dual-stack-lite endpoint string
Treeendpoint
Max. Instances128
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

min-first-fragment-size-rx number
Synopsis Minimum MTU size for upstream packets
Contextconfigure router string nat inside large-scale dual-stack-lite endpoint string min-first-fragment-size-rx number
Treemin-first-fragment-size-rx

Description

This command configures the minimum MTU size for the first fragment in the upstream direction. This command can be used to enable processing of first IPv6 fragments smaller than 1280 bytes. RFC 8200 recommends the minimum MTU in IPv6 be 1280 bytes which allows fragmentation only for packets that are larger than 1280 bytes. If a first fragment is smaller than 1280 bytes, DS-lite implementation in the SR OS, by default, drops the first fragment.

Range512 to 1280
Default1280
Introduced 21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

tunnel-mtu number
Synopsis DS-Lite tunnel MTU for this address
Context configure router string nat inside large-scale dual-stack-lite endpoint string tunnel-mtu number
Treetunnel-mtu

Description

This command configures the Dual Stack Lite (DS-Lite) tunnel MTU for this address.

Range464 to 9212
Default1500
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

max-subscriber-limit number
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisLargest value for all subscriber limits in each deterministic pool
Contextconfigure router string nat inside large-scale dual-stack-lite max-subscriber-limit number
Treemax-subscriber-limit
Range1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384 | 32768
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscriber-prefix-length number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisIPv6 prefix length of the Dual Stack Lite subscribers
Contextconfigure router string nat inside large-scale dual-stack-lite subscriber-prefix-length number
Treesubscriber-prefix-length
Range32 to 64 | 128
Default128
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-policy reference
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisNAT policy for LSN
Contextconfigure router string nat inside large-scale nat-policy reference
Treenat-policy

Reference

configure service nat nat-policy string

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat44
Synopsis Enter the nat44 context
Context configure router string nat inside large-scale nat44
Treenat44
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

destination-prefix [ip-prefix-length] string
Synopsis Enter the destination-prefix list instance
Contextconfigure router string nat inside large-scale nat44 destination-prefix string
Treedestination-prefix
Max. Instances6144
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

deterministic
Synopsis Enter the deterministic context
Contextconfigure router string nat inside large-scale nat44 deterministic
Treedeterministic
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

prefix-map [source-prefix] string nat-policy reference
Synopsis Enter the prefix-map list instance
Contextconfigure router string nat inside large-scale nat44 deterministic prefix-map string nat-policy reference
Treeprefix-map
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

map [from] string to string
Synopsis Enter the map list instance
Context configure router string nat inside large-scale nat44 deterministic prefix-map string nat-policy reference map string to string
Treemap
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

max-subscriber-limit number
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisLargest value for all subscriber limits in each deterministic pool
Contextconfigure router string nat inside large-scale nat44 max-subscriber-limit number
Treemax-subscriber-limit
Range1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384 | 32768
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-import reference
Synopsis Import BGP-VPN routes in NAT inside routing context
Contextconfigure router string nat inside large-scale nat44 nat-import reference
Treenat-import

Description

This command references an import policy to determine the routes that should be installed in the routing table as NAT routes, which are used to steer traffic to NAT.

A dynamic route obtained by BGP-VPN can be imported into an inside (private side) routing context in NAT environment. This route is associated with a NAT policy that maps traffic destined into a NAT pool and outside routing context. If the NAT policy is not explicitly configured in the import route-policy, the imported NAT route is, by default, associated with the default NAT policy defined in the NAT inside routing context.

All BGP-VPN routes that are destined to be imported into NAT inside routing context must be configured with action-type accept in the route policy.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

source-prefix [ip-prefix-length] string
Synopsis Enter the source-prefix list instance
Contextconfigure router string nat inside large-scale nat44 source-prefix string
Treesource-prefix

Description

Commands in this context configure the source prefix used to identify traffic for NAT processing. After the traffic is diverted to the ESA-VM or vISA, its source IP address is checked to determine if it belongs to the configured prefix. If it does, the traffic is processed by NAT, otherwise, it is dropped.

Introduced23.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-policy reference
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAT policy associated with the source prefix
Contextconfigure router string nat inside large-scale nat44 source-prefix string nat-policy reference
Treenat-policy

Reference

configure service nat nat-policy string

Notes

This element is mandatory.

Introduced23.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat64
Synopsis Enable the nat64 context
Context configure router string nat inside large-scale nat64
Treenat64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

drop-zero-ipv4-checksum boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDrop UDP datagrams with zero IPv4 checksum
Contextconfigure router string nat inside large-scale nat64 drop-zero-ipv4-checksum boolean
Treedrop-zero-ipv4-checksum
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

insert-ipv6-fragment-header boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisInclude IPv6 fragment header to indicate that the sender allows fragmentation
Contextconfigure router string nat inside large-scale nat64 insert-ipv6-fragment-header boolean
Treeinsert-ipv6-fragment-header
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

ip-fragmentation keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisControl fragmentation of originated downstream IPv6 traffic
Contextconfigure router string nat inside large-scale nat64 ip-fragmentation keyword
Treeip-fragmentation
Optionsfragment-ipv6, fragment-ipv6-unless-ipv4-df-set
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

ipv6-mtu number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSize of the IPv6 downstream packet in NAT64
Contextconfigure router string nat inside large-scale nat64 ipv6-mtu number
Treeipv6-mtu
Range1280 to 9212
Default1520
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

prefix string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisIPv6 prefix to derive the IPv6 address from the IPv4 address
Contextconfigure router string nat inside large-scale nat64 prefix string
Treeprefix
Default64:ff9b::/96
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscriber-prefix-length number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisIPv6 prefix length for the NAT64 subscribers
Contextconfigure router string nat inside large-scale nat64 subscriber-prefix-length number
Treesubscriber-prefix-length
Range32 to 64 | 128
Default128
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

tos
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the tos context
Contextconfigure router string nat inside large-scale nat64 tos
Treetos
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

downstream
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the downstream context
Contextconfigure router string nat inside large-scale nat64 tos downstream
Treedownstream
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

use-ipv4 boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisCopy TOS/DSCP bits from the incoming IPv4 frame to the outgoing IPv6 frame
Contextconfigure router string nat inside large-scale nat64 tos downstream use-ipv4 boolean
Treeuse-ipv4
Defaultfalse
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

upstream
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnter the upstream context
Contextconfigure router string nat inside large-scale nat64 tos upstream
Treeupstream
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

set-tos (keyword | number)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTOS/DSCP bits in IPv4 frame in the upstream direction
Contextconfigure router string nat inside large-scale nat64 tos upstream set-tos (keyword | number)
Treeset-tos
Range0 to 255
Optionsuse-ipv6
Defaultuse-ipv6
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

redundancy
Synopsis Enter the redundancy context
Context configure router string nat inside large-scale redundancy
Treeredundancy
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

peer string
Synopsis IP address of the NAT redundancy peer for this virtual router instance
Contextconfigure router string nat inside large-scale redundancy peer string
Treepeer
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

peer6 string
Synopsis IPv6 address of the NAT redundancy peer for this virtual router instance
Contextconfigure router string nat inside large-scale redundancy peer6 string
Treepeer6
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

static-port-forwards
Synopsis Enter the static-port-forwards context
Contextconfigure router string nat inside large-scale static-port-forwards
Treestatic-port-forwards
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

spf-nat-policy [nat-policy] reference
Synopsis Add a list entry for spf-nat-policy
Contextconfigure router string nat inside large-scale static-port-forwards spf-nat-policy reference
Treespf-nat-policy

Description

This command specifies that the NAT policy for the inside routing context is used when SPF is requested. The predeclaration of the NAT policy used in SPF is mandatory in the following scenarios:

  • when assigning SPF to NAT subscribers in pools that differ from the ones to which their corresponding source prefixes are mapped

  • when the source prefixes are not configured for the NAT subscriber

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscriber-identification
Synopsis Enter the subscriber-identification context
Contextconfigure router string nat inside large-scale subscriber-identification
Treesubscriber-identification
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

attribute
Synopsis Enter the attribute context
Context configure router string nat inside large-scale subscriber-identification attribute
Treeattribute
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

type keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisRADIUS attribute used as subscriber identifier
Contextconfigure router string nat inside large-scale subscriber-identification attribute type keyword
Treetype
Optionsalc-sub-string, user-name, class, station-id, imsi, imei
Default alc-sub-string
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

vendor keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisThe RADIUS Vendor
Contextconfigure router string nat inside large-scale subscriber-identification attribute vendor keyword
Treevendor
Optionsstandard, nokia, 3gpp
Defaultnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

radius-proxy-server
Synopsis Enable the radius-proxy-server context
Contextconfigure router string nat inside large-scale subscriber-identification radius-proxy-server
Treeradius-proxy-server
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

server string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisServer name
Contextconfigure router string nat inside large-scale subscriber-identification radius-proxy-server server string
Treeserver
String Length1 to 32

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

traffic-identification
Synopsis Enter the traffic-identification context
Contextconfigure router string nat inside large-scale traffic-identification
Treetraffic-identification

Description

Commands in this context configure traffic idenification for NAT processing

Introduced23.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

map
Synopsis Enter the map context
Context configure router string nat map
Treemap
Introduced16.0.R1

Platforms

VSR

outside
Synopsis Enter the outside context
Context configure router string nat outside
Treeoutside
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

dnat-only
Synopsis Enter the dnat-only context
Context configure router string nat outside dnat-only
Treednat-only
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

route-limit number
Synopsis Limit for internal routes for downstream traffic
Contextconfigure router string nat outside dnat-only route-limit number
Treeroute-limit
Range1 to 131072
Default32768
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

filters
Synopsis Enter the filters context
Context configure router string nat outside filters
Treefilters
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

downstream
Synopsis Enter the downstream context
Context configure router string nat outside filters downstream
Treedownstream
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

upstream
Synopsis Enter the upstream context
Context configure router string nat outside filters upstream
Treeupstream
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mtu number
Synopsis MTU for downstream traffic
Context configure router string nat outside mtu number
Treemtu
Range512 to 9000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

pool [name] string
Synopsis Enter the pool list instance
Context configure router string nat outside pool string
Treepool
Max. Instances4096
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis NAT pool name
Contextconfigure router string nat outside pool string
Treepool
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

address-pooling keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisOutside IP address allocation mode for a NAT subscriber
Contextconfigure router string nat outside pool string address-pooling keyword
Treeaddress-pooling

Description

This command configures address pooling which defines a relationship between the NAT subscriber and its outside IP address(es).

The behavior in NAT, as defined in RFC 7857, strongly recommends that the NAT subscribers be mapped to a single outside IP address. If this outside IP address runs out of ports, no new ports for the subscriber are allocated. This behavior is called paired address pooling.

The alternative behavior is arbitrary address pooling, where a NAT subscriber is mapped to multiple IP addresses when the current outside IP address runs out of ports. This way, the subscriber becomes associated with multiple outside IP addresses. While this results in better resource utilization in NAT, it may negatively affect the behavior of some applications.

Optionspaired, arbitrary
Default paired
Introduced23.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

address-range [start] string end string
Synopsis Enter the address-range list instance
Contextconfigure router string nat outside pool string address-range string end string
Treeaddress-range
Max. Instances4096
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[start] string
Synopsis Lower bound of the NAT address range
Context configure router string nat outside pool string address-range string end string
Treeaddress-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

end string
Synopsis Upper bound of the NAT address range
Context configure router string nat outside pool string address-range string end string
Treeaddress-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

drain boolean
Synopsis Start or stop draining this NAT address range
Contextconfigure router string nat outside pool string address-range string end string drain boolean
Treedrain
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the outside routing NAT pool
Contextconfigure router string nat outside pool string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

applications
Synopsis Enter the applications context
Contextconfigure router string nat outside pool string applications
Treeapplications
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

agnostic boolean
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNAT pool to create in the outside routing context
Contextconfigure router string nat outside pool string applications agnostic boolean
Treeagnostic
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

flexible-port-allocation boolean
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisAllocates individual ports per subscriber in a pool
Contextconfigure router string nat outside pool string applications flexible-port-allocation boolean
Treeflexible-port-allocation

Description

When configured to true, the router enables LSN44 pool behavior, where a subscriber allocates ports individually and not through port blocks. The port block is removed and port logging is disabled for this application. Static port forwards can be interleaved with dynamically allocated ports when this application is enabled. A subscriber limit that is the maximum number of subscribers per outside IP address is not supported for this application.

Defaultfalse
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string nat outside pool string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

icmp-echo-reply boolean
Synopsis Allow NAT pool IP addresses to respond to ICMP PINGs
Contextconfigure router string nat outside pool string icmp-echo-reply boolean
Treeicmp-echo-reply

Description

This command allows IP addresses in the NAT pool to respond to ICMP Echo requests (PINGs). The configuration can be toggled while the pool is in use.

In L2-aware NAT when port-block-extensions is disabled, the reply from an outside IP address is generated only when this IP address has at least one host (binding) behind it.

In L2-aware NAT when port-block-extensions is enabled, the reply from an outside IP address is generated regardless if a binding is present.

In LSN, the reply from an outside IP address is generated regardless if a binding is present.

Defaultfalse
Introduced21.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

l2-aware
Synopsis Enter the l2-aware context
Context configure router string nat outside pool string l2-aware
Treel2-aware
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

default-host
Synopsis Enable the default-host context
Contextconfigure router string nat outside pool string l2-aware default-host
Treedefault-host

Description

Commands in this context configure the default DMZ host options. A default DMZ host is a node on the inside to which all unknown traffic is redirected by changing the destination IPv4 address in the traffic header. During this operation, the checksums in the Layer 3 and Layer 4 header (UDP and TCP) are recalculated. 

Unknown traffic in NAT represent all unmatched traffic arriving from the outside (where there is no pinhole or a matching flow record created by traffic initiated from the inside). The purpose of the default DMZ host is to capture and analyze the unknown traffic as part of threat analysis.

The rate of redirected unknown traffic can be restricted by configuration.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

ip-address string
Synopsis IP address of the default DMZ host
Context configure router string nat outside pool string l2-aware default-host ip-address string
Treeip-address

Description

This command configures the IP address of the default DMZ host. Redirection to the default DMZ host is achieved by replacing the destination IP address in the traffic header in the unknown traffic initiated from the outside with the one of the default DMZ host.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

rate-limit number
Synopsis Rate limit for unknown traffic sent to default DMZ host
Contextconfigure router string nat outside pool string l2-aware default-host rate-limit number
Treerate-limit

Description

This command configures the rate limit of the unknown traffic sent to the default DMZ host.

Unknown traffic sent to the default DMZ host is rate limited by a configurable value expressed in mbps. The rate limit is configurable per NAT pool per ISA, vISA, or ESA-VM.

Range1 to 10000
Unitsmegabps
Default 10
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

external-assignment boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisExternal IP address for Layer-2-aware
Contextconfigure router string nat outside pool string l2-aware external-assignment boolean
Treeexternal-assignment
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

port-block-extension
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the port-block-extension context
Contextconfigure router string nat outside pool string l2-aware port-block-extension
Treeport-block-extension

Description

Commands in this context configure the attributes of the port block reserved for a dynamic NAT traffic flow for each subscriber with a port forwarding entry.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

ports number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisNumber of ports per dynamic port-block
Contextconfigure router string nat outside pool string l2-aware port-block-extension ports number
Treeports

Description

For Carrier Grade NAT (CGN), this command represents the size of all port blocks for NAT subscribes in the NAT pool.

For L2-Aware NAT, this command represents only the size of the initial port block of a subscriber in the L2-aware NAT pool. Additional port-blocks (extended port blocks) for the L2-Aware subscriber must be explicitly enabled under the l2-aware port-block-extension hierarchy in the NAT pool.

This command does not affect the size of extended port-blocks.

Range10 to 5000

Notes

This element is mandatory.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscriber
Synopsis Enter the subscriber context
Context configure router string nat outside pool string l2-aware port-block-extension subscriber
Treesubscriber
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

watermarks
Synopsis Enable the watermarks context
Context configure router string nat outside pool string l2-aware port-block-extension subscriber watermarks
Treewatermarks

Description

This command configures watermarks for NAT resources.

Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

high number
Synopsis High watermark percentage
Context configure router string nat outside pool string l2-aware port-block-extension subscriber watermarks high number
Treehigh

Description

This command configures the high threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

low number
Synopsis Low watermark percentage
Context configure router string nat outside pool string l2-aware port-block-extension subscriber watermarks low number
Treelow

Description

This command configures the low threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscriber-limit number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisNumber of L2-Aware NAT subscribers per outside address
Contextconfigure router string nat outside pool string l2-aware port-block-extension subscriber-limit number
Treesubscriber-limit

Description

When port-block extensions for the L2-Aware subscribers are enabled, the port space for an outside IP address is divided into the following:

  • well-known port (this is a fixed and permanently allocated block of ports for all NAT types)

  • static port-forwarding range (if enabled by configuration)

  • port range allocated for initial port blocks of each L2-Aware subscriber

  • port range allocated for extended port blocks for the remainder after the three previous port ranges

The number of L2-Aware NAT subscribers per an outside IP address multiplied by the size of the initial port-block size determines the size of the port range reserved for initial port-blocks of each subscriber.

The lower boundary of the extended port range is determined by adding the upper boundary of the configured port forwarding range and the size of the port range allocated for initial port blocks.

Range2 to 2000

Notes

This element is mandatory.

Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

watermarks
Synopsis Enable the watermarks context
Context configure router string nat outside pool string l2-aware port-block-extension watermarks
Treewatermarks
Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

high number
Synopsis High watermark percentage
Context configure router string nat outside pool string l2-aware port-block-extension watermarks high number
Treehigh

Description

This command configures the high threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

low number
Synopsis Low watermark percentage
Context configure router string nat outside pool string l2-aware port-block-extension watermarks low number
Treelow

Description

This command configures the low threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

large-scale
Synopsis Enter the large-scale context
Context configure router string nat outside pool string large-scale
Treelarge-scale
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

default-host
Synopsis Enable the default-host context
Contextconfigure router string nat outside pool string large-scale default-host
Treedefault-host

Description

Commands in this context configure the default DMZ host options. A default DMZ host is a node on the inside to which all unknown traffic is redirected by changing the destination IPv4 address in the traffic header. During this operation, the checksums in the Layer 3 and Layer 4 header (UDP and TCP) are recalculated. 

Unknown traffic in NAT represent all unmatched traffic arriving from the outside (where there is no pinhole or a matching flow record created by traffic initiated from the inside). The purpose of the default DMZ host is to capture and analyze the unknown traffic as part of threat analysis.

The rate of redirected unknown traffic can be restricted by configuration.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

ip-address string
Synopsis IP address of the default DMZ host
Context configure router string nat outside pool string large-scale default-host ip-address string
Treeip-address

Description

This command configures the IP address of the default DMZ host. Redirection to the default DMZ host is achieved by replacing the destination IP address in the traffic header in the unknown traffic initiated from the outside with the one of the default DMZ host.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

rate-limit number
Synopsis Rate limit for unknown traffic sent to default DMZ host
Contextconfigure router string nat outside pool string large-scale default-host rate-limit number
Treerate-limit

Description

This command configures the rate limit of the unknown traffic sent to the default DMZ host.

Unknown traffic sent to the default DMZ host is rate limited by a configurable value expressed in mbps. The rate limit is configurable per NAT pool per ISA, vISA, or ESA-VM.

Range1 to 10000
Unitsmegabps
Default 10
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

deterministic
Synopsis Enter the deterministic context
Contextconfigure router string nat outside pool string large-scale deterministic
Treedeterministic
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

port-reservation number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisNumber of ports per deterministic port-block
Contextconfigure router string nat outside pool string large-scale deterministic port-reservation number
Treeport-reservation
Range1 to 65536
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

watermarks
Synopsis Enable the watermarks context
Context configure router string nat outside pool string large-scale deterministic watermarks
Treewatermarks

Description

Commands in this context monitor extended (dynamic) port-block utilization per outside IP in a NAT pool in deterministic LSN.

High and low thresholds are configured in percentages of total available extended port-blocks per outside IP in a pool. Both values represent extended port-block utilization or occupancy per outside IP in a pool.

For the system to generate those events, the NAT event-id 2045 must be enabled through configuration in the log event-control.

Introduced22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

high number
Synopsis High watermark percentage
Context configure router string nat outside pool string large-scale deterministic watermarks high number
Treehigh

Description

This command configures the high threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

low number
Synopsis Low watermark percentage
Context configure router string nat outside pool string large-scale deterministic watermarks low number
Treelow

Description

This command configures the low threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 22.2.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

flexible-port-allocation
Synopsis Enter the flexible-port-allocation context
Contextconfigure router string nat outside pool string large-scale flexible-port-allocation
Treeflexible-port-allocation

Description

Commands in this context enable LSN44 pool behavior where a subscriber allocates ports individually instead of through port blocks. The port block concept is removed for this application. Static port forwards can be interleaved with dynamically-allocated ports. Port logging in disabled when this application is enabled. A subscriber limit that is the maximum number of subscribers per outside IP address is not supported for this application.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

free-port-limit
Synopsis Enter the free-port-limit context
Contextconfigure router string nat outside pool string large-scale flexible-port-allocation free-port-limit
Treefree-port-limit

Description

Commands in this context configure the minimal number of ports per protocol and per outside IP address in an LSN44 pool with flexible port allocations that must be free to map new subscribers to the outside IP address. This limit avoids rapid port depletion for new subscribers in paired pooling mode, or unnecessary toggling between external IP addresses for existing subscribers in arbitrary pooling mode.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

icmp number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLimit of free ports for ICMP per outside IP address
Contextconfigure router string nat outside pool string large-scale flexible-port-allocation free-port-limit icmp number
Treeicmp

Description

This command configures the minimum number of ports for the ICMP protocol per outside IP address in an LSN44 pool with flexible port allocations that are free so that a new subscriber is mapped to the outside IP address. This limit is set to avoid rapid port depletion for new subscribers in paired pooling mode, or unnecessary toggling between external IP addresses for existing subscribers in arbitrary pooling mode.

Range1 to 10000
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

tcp number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLimit of free ports for TCP per outside IP address
Contextconfigure router string nat outside pool string large-scale flexible-port-allocation free-port-limit tcp number
Treetcp

Description

This command configures the minimum number of ports for TCP protocol per outside IP address in an LSN44 pool with flexible port allocations that are free so that a new subscriber is mapped to the outside IP address. This limit is set to avoid rapid port depletion for new subscribers in paired pooling mode, or unnecessary toggling between external IP addresses for existing subscribers in arbitrary pooling mode.

Range1 to 10000
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

udp number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLimit of free ports for UDP per outside IP address
Contextconfigure router string nat outside pool string large-scale flexible-port-allocation free-port-limit udp number
Treeudp

Description

This command configures the minimum number of ports for UDP protocol per outside IP address in an LSN44 pool with flexible port allocations that are free so that a new subscriber is mapped to the outside IP address. This limit is set to avoid rapid port depletion for new subscribers in paired pooling mode, or unnecessary toggling between external IP addresses for existing subscribers in arbitrary pooling mode.

Range1 to 10000
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

redundancy
Synopsis Enter the redundancy context
Context configure router string nat outside pool string large-scale redundancy
Treeredundancy
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of NAT pool redundancy
Contextconfigure router string nat outside pool string large-scale redundancy admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable

Notes

The following elements are part of a choice: (admin-state, export-route, and monitor-route) or follow.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

export-route string
Synopsis Route to export to the peer
Context configure router string nat outside pool string large-scale redundancy export-route string
Treeexport-route

Notes

The following elements are part of a choice: (admin-state, export-route, and monitor-route) or follow.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

follow
Synopsis Enter the follow context
Context configure router string nat outside pool string large-scale redundancy follow
Treefollow

Notes

The following elements are part of a choice: (admin-state, export-route, and monitor-route) or follow.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

monitor-route string
Synopsis Monitor the peer route
Context configure router string nat outside pool string large-scale redundancy monitor-route string
Treemonitor-route

Notes

The following elements are part of a choice: (admin-state, export-route, and monitor-route) or follow.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

subscriber-limit number
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisMaximum number of subscribers per IP address
Contextconfigure router string nat outside pool string large-scale subscriber-limit number
Treesubscriber-limit
Range1 to 65535 | 4294967295
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

mode keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisMode of operation of this NAT address pool
Contextconfigure router string nat outside pool string mode keyword
Treemode
Optionsauto, napt, one-to-one
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-group reference
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisCreate a NAT group
Contextconfigure router string nat outside pool string nat-group reference
Treenat-group

Reference

configure isa nat-group number

Notes

The following elements are part of a mandatory choice: nat-group or wlan-gw-group.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

port-forwarding
Synopsis Enter the port-forwarding context
Contextconfigure router string nat outside pool string port-forwarding
Treeport-forwarding
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

dynamic-block-reservation boolean
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisReserve dynamic block for subscriber
Contextconfigure router string nat outside pool string port-forwarding dynamic-block-reservation boolean
Treedynamic-block-reservation

Description

When configured to true, the system reserves dynamic port block when the first port forward for the subscriber is created. The dynamic port block allocation is logged only if the block is being used and mappings are created. Dynamic port block reservation due to the port forward creation but without any dynamic mapping, is not logged.

The reserved port block is released only when the last mapping in the block expires and there are no port forwards associated with the subscriber. The de-allocation log (syslog or RADIUS) is generated when the dynamic port block is completely released.

Dynamic port block reservations can be enabled only if the configured maximum number of subscribers per outside IP addresses are less than or equal to the maximum number of configured port blocks per outside IP address.

When configured to false, dynamic port blocks are not reserved when the first port forward for the subscriber is created.

Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

range-end number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisEnd of the wildcard range for port forwards
Contextconfigure router string nat outside pool string port-forwarding range-end number
Treerange-end

Description

This command configures the upper boundary of the wildcard port range dedicated to port forwarding in a NAT pool, whereas the range-start command configures the lower boundary (the starting port) of the wildcard port range dedicated to port forwarding in a NAT pool.

If unconfigured, the range-end implicit value is set to 1023, that represents the end of the well-known port range that is always enabled.

Port forwards are supported only in pools in NAPT mode. Pools in 1:1 mode do not support port-forwards.

Range0 | 1023 to 65535
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

range-start number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisStart of the wildcard range for port forwards
Contextconfigure router string nat outside pool string port-forwarding range-start number
Treerange-start

Description

This command configures the lower boundary (the starting port) of the wildcard port range dedicated to port forwarding in a NAT pool, whereas the range-end command configures the upper boundary of the wildcard port range dedicated to port forwarding in a NAT pool.

Port 0 is always excluded from the port forwarding range.

Port forwards are supported only in pools in Network Address and Port Translation (NAPT) mode. Pools in 1:1 mode do not support configured port forwards.

Range0 | 1 | 1025 to 65535
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

port-reservation
Synopsis Enter the port-reservation context
Contextconfigure router string nat outside pool string port-reservation
Treeport-reservation
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

port-blocks number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisPort block size for NAT subscribers
Contextconfigure router string nat outside pool string port-reservation port-blocks number
Treeport-blocks

Description

In CGN, this command specifies the number of port-blocks per outside IP address in the NAT pool. The available ports per outside IP address (the end port minus the upper bound value of the static port-forwarding range) are divided into the number of port blocks specified in this command. This implicitly determines the size of each port block.

For L2-aware NAT, this command can be configured only if the port block extensions (extended port blocks) are disabled. You must disable the l2-aware port-block-extension hierarchy in the NAT pool.

Range0 to 64512

Notes

The following elements are part of a choice: port-blocks or ports.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

ports number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

SynopsisSize of the port block for NAT subscribers
Contextconfigure router string nat outside pool string port-reservation ports number
Treeports

Description

For carrier-grade NAT (CGN), this command specifies the size of port blocks for NAT subscribers in the NAT pool.

For Layer 2 aware NAT, this command specifies the size of the initial port block of a subscriber in the pool. Additional port blocks (extended port blocks) for the Layer 2 aware subscriber must be explicitly enabled under the l2-aware port-block-extension hierarchy in the NAT pool.

This command does not affect the size of extended port blocks.

For deterministic pools, the port range begins with zero. However, for non-deterministic pools, the port range begins with one.

Range0 to 64512

Notes

The following elements are part of a choice: port-blocks or ports.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

type keyword
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNAT pool type
Contextconfigure router string nat outside pool string type keyword
Treetype
Optionslarge-scale, l2-aware, wlan-gw-anchor

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

watermarks
Synopsis Enable the watermarks context
Context configure router string nat outside pool string watermarks
Treewatermarks

Description

This command configures watermarks for NAT resources.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

high number
Synopsis High watermark percentage
Context configure router string nat outside pool string watermarks high number
Treehigh

Description

This command configures the high threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

low number
Synopsis Low watermark percentage
Context configure router string nat outside pool string watermarks low number
Treelow

Description

This command configures the low threshold value as a percentage of the total port-block space in a NAT pool.

Range0 to 100
Unitspercent

Notes

This element is mandatory.

Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

wlan-gw-group reference
WARNING:

Modifying this element clears ISA state, such as flow state, for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisCreate a WLAN GW group for NAT
Contextconfigure router string nat outside pool string wlan-gw-group reference
Treewlan-gw-group

Reference

configure isa wlan-gw-group number

Notes

The following elements are part of a mandatory choice: nat-group or wlan-gw-group.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

network-domains

Synopsis Enter the network-domains context
Contextconfigure router string network-domains
Treenetwork-domains
Introduced16.0.R4

Platforms

All

network-domain [domain-name] string
Synopsis Enter the network-domain list instance
Contextconfigure router string network-domains network-domain string
Treenetwork-domain
Max. Instances5
Introduced16.0.R4

Platforms

All

origin-validation

Synopsis Enter the origin-validation context
Contextconfigure router string origin-validation
Treeorigin-validation
Introduced19.5.R1

Platforms

All

rpki-session [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the rpki-session list instance
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone)
Treerpki-session
Introduced19.5.R1

Platforms

All

[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IPv4 or IPv6 address for the RPKI local cache server
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone)
Treerpki-session

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

local-address (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal address for the TCP connection setup
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone) local-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treelocal-address
Introduced19.5.R1

Platforms

All

port number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDestination port number used to contact cache server
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone) port number
Treeport
Range0 to 65535
Default323
Introduced 19.5.R1

Platforms

All

refresh-time
Synopsis Enter the refresh-time context
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone) refresh-time
Treerefresh-time
Introduced19.5.R1

Platforms

All

value number
Synopsis Periodic Serial Query PDUs sent for liveness detection
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone) refresh-time value number
Treevalue
Range30 to 32767
Unitsseconds
Default 300
Introduced19.5.R1

Platforms

All

stale-time number
Synopsis Maximum time prefix origin validation remains usable
Contextconfigure router string origin-validation rpki-session (ipv4-address-no-zone | ipv6-address-no-zone) stale-time number
Treestale-time
Range60 to 3600
Unitsseconds
Default 3600
Introduced19.5.R1

Platforms

All

static-entry [ip-prefix] (ipv4-prefix | ipv6-prefix) upto number origin-as number
Synopsis Enter the static-entry list instance
Contextconfigure router string origin-validation static-entry (ipv4-prefix | ipv6-prefix) upto number origin-as number
Treestatic-entry
Introduced19.5.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IPv4 or IPv6 address with the minimum prefix and length
Contextconfigure router string origin-validation static-entry (ipv4-prefix | ipv6-prefix) upto number origin-as number
Treestatic-entry

Notes

This element is part of a list key.

Introduced19.5.R1

Platforms

All

ospf [ospf-instance] number

Synopsis Enter the ospf list instance
Context configure router string ospf number
Treeospf
Max. Instances32
Introduced16.0.R1

Platforms

All

[ospf-instance] number
Synopsis Value for the integrated OSPF instance
Contextconfigure router string ospf number
Treeospf
Range0 to 31
MD-CLI Default0

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the OSPF instance
Contextconfigure router string ospf number admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

area [area-id] string
Synopsis Enter the area list instance
Context configure router string ospf number area string
Treearea
Introduced16.0.R1

Platforms

All

[area-id] string
Synopsis Area-ID attribute
Context configure router string ospf number area string
Treearea

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

area-range [ip-prefix-mask] string
Synopsis Enter the area-range list instance
Contextconfigure router string ospf number area string area-range string
Treearea-range
Introduced16.0.R1

Platforms

All

[ip-prefix-mask] string
Synopsis IP prefix and subnet mask for the range used by the ABR
Contextconfigure router string ospf number area string area-range string
Treearea-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertise boolean
Synopsis Advertise summarized range of addresses to other areas
Contextconfigure router string ospf number area string area-range string advertise boolean
Treeadvertise
Defaulttrue
Introduced16.0.R1

Platforms

All

bier
Synopsis Enter the bier context
Context configure router string ospf number area string bier
Treebier

Description

Commands in this context configure the administrative state of BIER and the BIER template assigned to the OSPF area.

Introduced20.5.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of BIER
Context configure router string ospf number area string bier admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced20.5.R1

Platforms

All

interface [interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string ospf number area string interface string
Treeinterface

Description

Commands in this context configure the attributes of the OSPF area interface.

Unless they are explicitly configured, interfaces are not activated by default in any interior gateway protocol such as OSPF.

Introduced16.0.R1

Platforms

All

[interface-name] string
Synopsis Router interface name
Context configure router string ospf number area string interface string
Treeinterface

Description

This command specifies the IP interface name. Interface names must be unique within the group of defined IP interfaces for configure router interface and configure service ies interface commands. An interface name cannot be in the form of an IP address. Interface names can be a string composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

If the IP interface name does not exist or does not have an IP address configured, an error message is returned.

If the IP interface exists in a different area it is moved to this area.

String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adjacency-set [id] reference
Synopsis Add a list entry for adjacency-set
Contextconfigure router string ospf number area string interface string adjacency-set reference
Treeadjacency-set
Max. Instances1024
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the OSPF interface
Contextconfigure router string ospf number area string interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

bfd-liveness
Synopsis Enable the bfd-liveness context
Contextconfigure router string ospf number area string interface string bfd-liveness
Treebfd-liveness
Introduced16.0.R1

Platforms

All

strict boolean
Synopsis Enable BFD strict mode
Context configure router string ospf number area string interface string bfd-liveness strict boolean
Treestrict

Description

When configured to true, the system uses BFD strict-mode. BFD strict-mode mandates that an active BFD session must exist between the OSPF neighbors before establishing a full adjacency. When configured to true, the router uses Link-Local Signaling (LLS) with the B-flag set to instruct the OSPF neighbors that BFD must be enabled on the link. BFD strict-mode requires both sides to have the B-flag set.

During OSPFv3 BFD strict-mode operations, the router advertises the local interface IPv4 address TLV using LLS, but the SR OS router continues to use IPv6-based BFD sessions for both the IPv4 and IPv6 address families.

Defaultfalse
Introduced23.3.R1

Platforms

All

strict-mode-holddown number
Synopsis Adjacency up time delay after BFD session establishment
Contextconfigure router string ospf number area string interface string bfd-liveness strict-mode-holddown number
Treestrict-mode-holddown

Description

This command configures a delay timer before bringing up the OSPF adjacency after the BFD session establishment. Holddown helps mitigate potential routing churn when BFD sessions are unstable. The holddown timer is reset when a BFD session operationally toggles.

Range1 to 600
Unitsseconds
Introduced 23.3.R1

Platforms

All

dead-interval number
Synopsis OSPF wait time for Hellos before neighbor declared down
Contextconfigure router string ospf number area string interface string dead-interval number
Treedead-interval
Range2 to 65535
Unitsseconds
Introduced 16.0.R1

Platforms

All

flex-algo [flex-algo-id] number
Synopsis Enter the flex-algo list instance
Contextconfigure router string ospf number area string interface string flex-algo number
Treeflex-algo

Description

Commands in this context configure the attributes of OSPFv2 flexible algorithms interface.

Max. Instances7
Introduced21.7.R1

Platforms

All

[flex-algo-id] number
Synopsis Flexible algorithm ID
Context configure router string ospf number area string interface string flex-algo number
Treeflex-algo
Range128 to 255

Notes

This element is part of a list key.

Introduced21.7.R1

Platforms

All

node-sid
Synopsis Enable the node-sid context
Context configure router string ospf number area string interface string flex-algo number node-sid
Treenode-sid
Introduced21.7.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string ospf number area string interface string flex-algo number node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced21.7.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string ospf number area string interface string flex-algo number node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced21.7.R1

Platforms

All

hello-interval number
Synopsis Time between OSPF Hellos of this interface
Contextconfigure router string ospf number area string interface string hello-interval number
Treehello-interval
Range1 to 65535
Unitsseconds
Default 10
Introduced16.0.R1

Platforms

All

interface-type keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisInterface type
Contextconfigure router string ospf number area string interface string interface-type keyword
Treeinterface-type

Description

This command specifies the interface type.

broadcast - Broadcast network

To significantly improve adjacency forming and network convergence, configure a network as point-to-point if only two routers are connected, even if the network is a broadcast media such as Ethernet.

non-broadcast - Non-broadcast network

point-to-point - Point-to-point link

Set the interface type of an Ethernet link to point-to-point to avoid having to carry the broadcast adjacency maintenance overhead if the Ethernet link provided is used as a point-to-point.

p2mp-nbma - Point-to-multipoint on a link without broadcast or multicast support

No designated router or backup designated router is elected on this type of interface and all OSPF neighbors connect through individual point-to-point links. Only VPRN and IES services interfaces support this interface type.

secondary - Multiple secondary adjacencies allowed

A secondary interface allows multiple secondary adjacencies, in addition to the primary adjacency, to be established over a single IP interface. This interface type can also be applied to the system interface and to loopback interfaces to allow them to participate in multiple areas, although no adjacencies are formed over these types of interfaces.

Optionsbroadcast, non-broadcast, point-to-point, secondary, p2mp-nbma
Introduced16.0.R1

Platforms

All

loopfree-alternate
Synopsis Enter the loopfree-alternate context
Contextconfigure router string ospf number area string interface string loopfree-alternate
Treeloopfree-alternate
Introduced16.0.R3

Platforms

All

policy-map
Synopsis Enable the policy-map context
Context configure router string ospf number area string interface string loopfree-alternate policy-map
Treepolicy-map
Introduced16.0.R3

Platforms

All

lsa-filter-out keyword
Synopsis LSA flooding reduction
Context configure router string ospf number area string interface string lsa-filter-out keyword
Treelsa-filter-out
Optionsnone, all, except-own-rtrlsa, except-own-rtrlsa-and-defaults
Defaultnone
Introduced16.0.R1

Platforms

All

message-digest-key [key-id] number
Synopsis Enter the message-digest-key list instance
Contextconfigure router string ospf number area string interface string message-digest-key number
Treemessage-digest-key
Introduced16.0.R1

Platforms

All

metric number
Synopsis Route cost metric for the interface
Context configure router string ospf number area string interface string metric number
Treemetric
Range1 to 65535
Introduced16.0.R1

Platforms

All

mtu number
Synopsis MTU for the OSPF to use on the interface
Contextconfigure router string ospf number area string interface string mtu number
Treemtu
Range512 to 9786
Introduced16.0.R1

Platforms

All

neighbor [address] string
Synopsis Add a list entry for neighbor
Context configure router string ospf number area string interface string neighbor string
Treeneighbor
Introduced16.0.R1

Platforms

All

[address] string
Synopsis IPv4 address of the OSPFv2 neighbor
Context configure router string ospf number area string interface string neighbor string
Treeneighbor

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

node-sid
Synopsis Enable the node-sid context
Context configure router string ospf number area string interface string node-sid
Treenode-sid

Description

Commands in this context configure a node SID index or label value for the prefix representing the primary address of a network interface of type system or loopback. A separate SID value can be configured for each IPv4 and IPv6 primary address of the interface. The secondary address of an IPv4 interface cannot be assigned a node SID index and does not inherit the SID of the primary IPv4 address.

In OSPFv2 and OSPFv3, the node SID is configured in the primary area but is inherited in any other area in which the interface is added as secondary.

This command fails if the network interface is not a loopback type or if the interface is defined in an IES or VPRN context. Assigning the same SID index or label value to the same interface in two different IGP instances is not allowed within the same node.

The value of the label or index SID is taken from the range configured for this IGP instance. When using the global mode of operation, the segment routing module checks that the same index or label value is not assigned to more than one loopback interface address. When using the per-instance mode of operation, this check is not required because the index and, therefore, the label ranges of IGP instances are not allowed to overlap.

The clear-n-flag option allows the user to clear the N-flag (node-sid flag) in an OSPF or OSPF3 prefix SID sub-TLV originated for the prefix of a loopback interface on the system. By default, the prefix SID sub-TLV for the prefix of a loopback interface is tagged as a node SID; that is, it belongs to this node only. However, to configure and advertise an anycast SID using the same loopback interface prefix on multiple nodes, the user must clear the N-flag to assure interoperability with third-party implementations. This may perform a strict check on the receive end and drop duplicate prefix SID sub-TLVs when the N-flag is set.

The SR OS implementation is relaxed on the receive end and accepts duplicate prefix SIDs with the N-flag set or clear. SR OS resolves to the closest owner, or owners if ECMP, of the prefix SID cost-wise.

Introduced16.0.R1

Platforms

All

clear-n-flag boolean
Synopsis Clear the N-flag in an OSPF prefix
Context configure router string ospf number area string interface string node-sid clear-n-flag boolean
Treeclear-n-flag

Description

When configured to true, this command allows the user to clear the N-flag in an OSPF prefix SID sub-TLV originated for the prefix of a loopback interface on the system.

When configured to false, the N-flag in an OSPF prefix SID sub-TLV originated for the prefix of a loopback interface on the system is not cleared.

When the user wants to configure and advertise an anycast SID using the same loopback interface prefix on multiple nodes, the user must clear the N-flag to assure interoperability with third-party implementations. This may perform a strict check on the receive end and drop duplicate prefix SID sub-TLVs when the N-flag is set.

Defaultfalse
Introduced16.0.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string ospf number area string interface string node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string ospf number area string interface string node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

passive boolean
Synopsis Advertise passive interfaces as OSPF interfaces
Contextconfigure router string ospf number area string interface string passive boolean
Treepassive
Introduced16.0.R1

Platforms

All

poll-interval number
Synopsis Interval for Hellos to non-adjacent OSPF NBMA neighbor
Contextconfigure router string ospf number area string interface string poll-interval number
Treepoll-interval
Max. Range0 to 4294967295
Unitsseconds
Default120
Introduced 16.0.R1

Platforms

All

priority number
Synopsis Interface priority in the DR election on the subnet
Contextconfigure router string ospf number area string interface string priority number
Treepriority
Range0 to 255
Default1
Introduced 16.0.R1

Platforms

All

nssa
Synopsis Enable the nssa context
Context configure router string ospf number area string nssa
Treenssa
Introduced16.0.R1

Platforms

All

area-range [ip-prefix-mask] string
Synopsis Enter the area-range list instance
Contextconfigure router string ospf number area string nssa area-range string
Treearea-range
Introduced16.0.R1

Platforms

All

[ip-prefix-mask] string
Synopsis IP prefix and subnet mask for the range used by the ABR
Contextconfigure router string ospf number area string nssa area-range string
Treearea-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertise boolean
Synopsis Advertise summarized range of addresses to other areas
Contextconfigure router string ospf number area string nssa area-range string advertise boolean
Treeadvertise
Defaulttrue
Introduced16.0.R1

Platforms

All

originate-default-route
Synopsis Enable the originate-default-route context
Contextconfigure router string ospf number area string nssa originate-default-route
Treeoriginate-default-route
Introduced16.0.R1

Platforms

All

summaries boolean
Synopsis Send summary (Type 3) LSAs into the NSSA on an ABR
Contextconfigure router string ospf number area string nssa summaries boolean
Treesummaries
Defaulttrue
Introduced16.0.R1

Platforms

All

stub
Synopsis Enable the stub context
Context configure router string ospf number area string stub
Treestub
Introduced16.0.R1

Platforms

All

default-metric number
Synopsis Metric used by ABR for default route into the stub area
Contextconfigure router string ospf number area string stub default-metric number
Treedefault-metric
Range1 to 16777214
Default1
Introduced 16.0.R1

Platforms

All

summaries boolean
Synopsis Send summary (Type 3) LSAs into the stub area on an ABR
Contextconfigure router string ospf number area string stub summaries boolean
Treesummaries
Defaulttrue
Introduced16.0.R1

Platforms

All

virtual-link [router-id] string transit-area reference
Synopsis Enter the virtual-link list instance
Contextconfigure router string ospf number area string virtual-link string transit-area reference
Treevirtual-link
Introduced16.0.R1

Platforms

All

[router-id] string
Synopsis Router identity of the virtual link neighbor
Contextconfigure router string ospf number area string virtual-link string transit-area reference
Treevirtual-link

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

transit-area reference
Synopsis Transit area linking the backbone to not-connected area
Contextconfigure router string ospf number area string virtual-link string transit-area reference
Treevirtual-link

Reference

configure router string ospf number area string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

message-digest-key [key-id] number
Synopsis Enter the message-digest-key list instance
Contextconfigure router string ospf number area string virtual-link string transit-area reference message-digest-key number
Treemessage-digest-key
Introduced16.0.R1

Platforms

All

asbr
Synopsis Enable the asbr context
Context configure router string ospf number asbr
Treeasbr
Introduced16.0.R1

Platforms

All

trace-path (number | keyword)
Synopsis Domain identity
Context configure router string ospf number asbr trace-path (number | keyword)
Treetrace-path
Range0 to 31
Optionsnone
Defaultnone
Introduced16.0.R1

Platforms

All

database-export
Synopsis Enable the database-export context
Contextconfigure router string ospf number database-export
Treedatabase-export
Introduced16.0.R1

Platforms

All

igp-identifier number
Synopsis IGP instance in the BGP-LS NLRI
Context configure router string ospf number database-export igp-identifier number
Treeigp-identifier

Description

This command identifies the IGP instance in the BGP-LS NLRI when a router has interfaces participating in multiple IGP instances. The concept of an instance ID specified for OSPF is local subnet significant (RFC 6549). An IGP identifier value can be configured to be unique within a given IGP domain when the router sends the IGP link state information using BGP-LS.

Max. Range0 to 18446744073709551615
Introduced16.0.R1

Platforms

All

export-limit
Synopsis Enable the export-limit context
Contextconfigure router string ospf number export-limit
Treeexport-limit
Introduced16.0.R1

Platforms

All

number number
Synopsis Maximum routes or prefixes exported from route table
Contextconfigure router string ospf number export-limit number number
Treenumber
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

export-policy reference
Synopsis Export policies that determine exported routes
Contextconfigure router string ospf number export-policy reference
Treeexport-policy

Description

This command configures export routing policies for the routes exported from the routing table to IS-IS.

If the export policy is undefined, the system does not export non IS-IS routes from the routing table manager to IS-IS.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

If the aggregate command is also configured in the configure router context, the aggregation is applied before the export policy is applied.

Routing policies are created in the configure router policy-options context.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

external-db-overflow
Synopsis Enable the external-db-overflow context
Contextconfigure router string ospf number external-db-overflow
Treeexternal-db-overflow
Introduced16.0.R1

Platforms

All

interval number
Synopsis Time during which the router operates in overload
Contextconfigure router string ospf number external-db-overflow interval number
Treeinterval
Range0 to 2147483647
Unitsseconds
Default 0
Introduced16.0.R1

Platforms

All

limit number
Synopsis Number of external LSA at which overload is triggered
Contextconfigure router string ospf number external-db-overflow limit number
Treelimit
Range0 to 2147483647
Default0
Introduced 16.0.R1

Platforms

All

flexible-algorithms
Synopsis Enter the flexible-algorithms context
Contextconfigure router string ospf number flexible-algorithms
Treeflexible-algorithms

Description

Commands in this context configure the OSPFv2 parameters for flexible algorithm participation.

Introduced21.7.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of flexible algorithm support
Contextconfigure router string ospf number flexible-algorithms admin-state keyword
Treeadmin-state

Description

This command specifies the administrative state of the support of flexible algorithm IGP LSDB extensions.

Optionsenable, disable
Default disable
Introduced21.7.R1

Platforms

All

advertise-admin-group keyword
Synopsis Administrative group TLV to advertise
Contextconfigure router string ospf number flexible-algorithms advertise-admin-group keyword
Treeadvertise-admin-group

Description

This command configures the type of Administrative Group TLV the router advertises as an IGP link attribute. This command is configured for this IGP instance.

Optionsprefer-ag, eag-only, ag-eag
Defaultprefer-ag
Introduced23.3.R1

Platforms

All

flex-algo [flex-algo-id] number
Synopsis Enter the flex-algo list instance
Contextconfigure router string ospf number flexible-algorithms flex-algo number
Treeflex-algo

Description

Commands in this context configure the attributes of the OSPFv2 flexible algorithm.

The maximum unique flexible algorithms can be configured on a router across all configured OSPFv2 instances. In each OSPF flexible algorithm configuration context, the OSPFv2 instance participation can be either enabled or disabled, and it configures the advertising of a locally-configured flexible algorithm definition.

When flexible algorithm is enabled in an OSPF instance, it is enabled for all areas within the OSPF instance.

Max. Instances7
Introduced21.7.R1

Platforms

All

[flex-algo-id] number
Synopsis Flexible algorithm ID
Context configure router string ospf number flexible-algorithms flex-algo number
Treeflex-algo
Range128 to 255

Notes

This element is part of a list key.

Introduced21.7.R1

Platforms

All

advertise reference
Synopsis Flexible Algorithm Definition advertisement
Contextconfigure router string ospf number flexible-algorithms flex-algo number advertise reference
Treeadvertise

Description

This command enables the advertisement of a locally configured Flexible Algorithm Definition (FAD).

The winning FAD that a router uses must be consistent with the winning FAD on all other routers, which avoids routing loops and traffic blackholing. The winning FAD is selected using a tiebreaker algorithm that first selects the highest advertised FAD priority followed by the highest system ID.

Reference

configure routing-options flexible-algorithm-definitions flex-algo string

Introduced21.7.R1

Platforms

All

micro-loop-avoidance
Synopsis Enable the micro-loop-avoidance context
Contextconfigure router string ospf number flexible-algorithms flex-algo number micro-loop-avoidance
Treemicro-loop-avoidance

Description

When configured, the system enables micro-loop avoidance for an SR-OSPF flexible algorithm, and consequently, inherits the FIB delay timer from the SR-OSPF configure router ospf segment-routing context.

When this command is configured, FIB updates are delayed before the system programs new primary next hops to avoid micro-loops.

When configured, the feature applies to the following contexts:

  • OSPFv2 SR-OSPF IPv4 tunnel (node SID)

  • IPv4 and IPv6 SR-TE LSPs that use a node SID in their segment list

  • IPv4 and IPv6 SR policies that use a node SID in their segment list

When micro-loop-avoidance is disabled (by removing this command from the configuration), the system forces any running FIB delay to expire immediately and programs the new next hops for all impacted node SIDs. When disabled, micro-loop avoidance is disabled instantaneously and will be disabled for the next SPF runs. Micro-loop avoidance remains disabled until it is re-enabled.

Introduced24.3.R1

Platforms

All

participate boolean
Synopsis Allow participation in the Flexible Algorithm
Contextconfigure router string ospf number flexible-algorithms flex-algo number participate boolean
Treeparticipate

Description

When configured to true, the router advertises the capability to participate in a flexible algorithm within the IS-IS Router Capability TLV. A router only advertises participation when the winning FAD can be supported, which includes segment routing support.

When configured to false, flexible algorithm participation is not enabled.

Defaultfalse
Introduced21.7.R1

Platforms

All

graceful-restart
Synopsis Enable the graceful-restart context
Contextconfigure router string ospf number graceful-restart
Treegraceful-restart
Introduced16.0.R1

Platforms

All

igp-shortcut
Synopsis Enter the igp-shortcut context
Contextconfigure router string ospf number igp-shortcut
Treeigp-shortcut
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the IGP shortcuts
Contextconfigure router string ospf number igp-shortcut admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

allow-sr-over-srte boolean
Synopsis Enable SR over SR-TE LSPs
Context configure router string ospf number igp-shortcut allow-sr-over-srte boolean
Treeallow-sr-over-srte

Description

When configured to true, the router only allows SR-MPLS SRv4 and SRv6 IGP shortcuts to use SR-TE LSPs with allow-sr-over-srte explicitly enabled with an adjacency SID as top SID in the SR-TE LSP. IPv4 and IPv6 addresses can use all available SR-TE LSPs as IGP shortcuts regardless of the explicit allow-sr-over-srte configuration.

Under ECMP, when this command is configured to true, preference is given to the SR-TE LSPs with allow-sr-over-srte explicitly configured over the LSPs that do not have allow-sr-over-srte configured.

Defaultfalse
Introduced23.3.R1

Platforms

All

tunnel-next-hop
Synopsis Enter the tunnel-next-hop context
Contextconfigure router string ospf number igp-shortcut tunnel-next-hop
Treetunnel-next-hop
Introduced16.0.R1

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string ospf number igp-shortcut tunnel-next-hop family keyword
Treefamily
Introduced16.0.R1

Platforms

All

[family-type] keyword
Synopsis Address family type for tunnel next-hop
Contextconfigure router string ospf number igp-shortcut tunnel-next-hop family keyword
Treefamily
Optionsipv4, srv4

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

resolution-filter
Synopsis Enter the resolution-filter context
Contextconfigure router string ospf number igp-shortcut tunnel-next-hop family keyword resolution-filter
Treeresolution-filter
Introduced16.0.R1

Platforms

All

ldp-over-rsvp boolean
Synopsis Allow LSP over RSVP in this OSPF instance
Contextconfigure router string ospf number ldp-over-rsvp boolean
Treeldp-over-rsvp
Defaultfalse
Introduced16.0.R1

Platforms

All

ldp-sync boolean
Synopsis Configure IGP-LDP synchronization for interfaces
Contextconfigure router string ospf number ldp-sync boolean
Treeldp-sync
Defaulttrue
Introduced16.0.R1

Platforms

All

loopfree-alternate
Synopsis Enable the loopfree-alternate context
Contextconfigure router string ospf number loopfree-alternate
Treeloopfree-alternate
Introduced16.0.R1

Platforms

All

augment-route-table boolean
Synopsis Attach remote LFA information to RTM entries
Contextconfigure router string ospf number loopfree-alternate augment-route-table boolean
Treeaugment-route-table

Description

When configured to true, this command enables IS-IS to attach remote LFA-specific information to RTM entries for use by protocols such as LDP.

When configured to false, rLFA-specific information is not added to RTM entries.

Defaultfalse
Introduced21.10.R1

Platforms

All

exclude
Synopsis Enter the exclude context
Context configure router string ospf number loopfree-alternate exclude
Treeexclude
Introduced16.0.R3

Platforms

All

prefix-policy reference
Synopsis Policy to exclude prefixes from LFA SPF calculation
Contextconfigure router string ospf number loopfree-alternate exclude prefix-policy reference
Treeprefix-policy

Description

This command specifies the name of the policy for the prefixes to exclude from the LFA SPF calculation.

An excluded prefix is not included in LFA calculation regardless of its priority. The prefix tag is, however, used in the main SPF.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R3

Platforms

All

multi-homed-prefix
Synopsis Enable the multi-homed-prefix context
Contextconfigure router string ospf number loopfree-alternate multi-homed-prefix
Treemulti-homed-prefix

Description

Commands in this context configure a multihomed prefix LFA for both RTM routes (IP FRR) and SR-OSPF tunnels. SR-OSPF tunnels enable multihomed prefix extension in both algorithm 0 and flexible-algorithm numbers.

This feature makes use of the multihomed prefix model described in RFC 8518 to compute a backup IP next hop using an alternate ABR or ASBR for external prefixes and to an alternate router owner for local anycast prefixes.

This feature further enhances the multihomed prefix backup path calculation beyond RFC 8518 with the addition of repair tunnels that make use of a PQ node or a P-Q set to reach the alternate exit ABR or ASBR of external prefixes or the alternate owner router of local anycast prefixes.

The computed IP next-hop based backup path is added to OSPF routes of external /32 prefixes (OSPFv2 routes types 3, 4, 5, and 7) and local /32 anycast prefixes in the RTM if the prefix is not protected by base LFA or if the user set leaf preference value to all. The user must enable the ip-fast-reroute leaf to have these backup paths programmed into the FIB in datapath.

The computed IP next hop or repair tunnel based backup path is also programmed for SR-OSPF node SID tunnels of external /32 prefixes and to /32 prefixes in same area as the computing node S and which are advertised by multiple routers (anycast prefix) in both algorithm 0 and flexible-algorithm numbers.

Introduced22.2.R1

Platforms

All

remote-lfa
Synopsis Enable the remote-lfa context
Context configure router string ospf number loopfree-alternate remote-lfa
Treeremote-lfa
Introduced16.0.R1

Platforms

All

ti-lfa
Synopsis Enable the ti-lfa context
Context configure router string ospf number loopfree-alternate ti-lfa
Treeti-lfa

Description

Commands in this context configure the Topology Independent Loop-Free Alternate (TI-LFA) algorithm used in the LFA Shortest Path First (SPF) calculation for this OSPF instance.

Introduced16.0.R1

Platforms

All

max-sr-frr-labels number
Synopsis Maximum number of labels the TI-LFA backup path can use
Contextconfigure router string ospf number loopfree-alternate ti-lfa max-sr-frr-labels number
Treemax-sr-frr-labels

Description

This command configures the maximum number of labels allowed in the segment list of the TI-LFA repair tunnel. A higher value results in better coverage by TI-LFA at the expense of increased packet encapsulation overhead. The TI-LFA algorithm uses this value to limit the search for the Q-node from the P-node on the post-convergence path.

Range0 to 3
Default2
Introduced 16.0.R1

Platforms

All

multi-instance boolean
Synopsis Enable OSPF Multi Instance Extensions
Contextconfigure router string ospf number multi-instance boolean
Treemulti-instance

Description

When configured to true, the Base router supports RFC 6549, OSPFv2 Multi-Instance Extensions.

This support is enabled per instance and allows flexibility when migrating a particular instance from classic OSPFv2 to a multi-instance OSPFv2.

Defaultfalse
Introduced19.10.R1

Platforms

All

multicast-import boolean
Synopsis Submit routes into the multicast Route Table Manager
Contextconfigure router string ospf number multicast-import boolean
Treemulticast-import
Defaultfalse
Introduced16.0.R1

Platforms

All

overload boolean
Synopsis Change local router state to appear overloaded
Contextconfigure router string ospf number overload boolean
Treeoverload
Defaultfalse
Introduced16.0.R1

Platforms

All

preference number
Synopsis Preference for OSPF internal routes
Context configure router string ospf number preference number
Treepreference
Range1 to 255
Default10
Introduced 16.0.R1

Platforms

All

reference-bandwidth number
Synopsis Bandwidth to reference default costing of interfaces
Contextconfigure router string ospf number reference-bandwidth number
Treereference-bandwidth
Range1 to 18446744073709551615
Unitskilobps
Default100000000
Introduced 16.0.R1

Platforms

All

rib-priority
Synopsis Enter the rib-priority context
Contextconfigure router string ospf number rib-priority
Treerib-priority
Introduced16.0.R1

Platforms

All

router-id string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUnique router ID for the OSPF instance
Contextconfigure router string ospf number router-id string
Treerouter-id
Introduced16.0.R1

Platforms

All

rtr-adv-lsa-limit
Synopsis Enable the rtr-adv-lsa-limit context
Contextconfigure router string ospf number rtr-adv-lsa-limit
Treertr-adv-lsa-limit
Introduced16.0.R1

Platforms

All

overload-timeout (number | keyword)
Synopsis Maximum time in overload after LSA limit is reached
Contextconfigure router string ospf number rtr-adv-lsa-limit overload-timeout (number | keyword)
Treeoverload-timeout
Range1 to 1800
Unitsseconds
Options forever
Defaultforever
Introduced 16.0.R1

Platforms

All

segment-routing
Synopsis Enter the segment-routing context
Contextconfigure router string ospf number segment-routing
Treesegment-routing
Introduced16.0.R1

Platforms

All

adj-sid-hold (number | keyword)
Synopsis Adjacency SID hold time
Context configure router string ospf number segment-routing adj-sid-hold (number | keyword)
Treeadj-sid-hold

Description

This command configures a timer to hold the ILM or LTN of an adjacency SID following a failure of the adjacency.

When an adjacency to a neighbor fails, the following procedure is followed for both an LFA protected and the LFA unprotected SID of this adjacency in SR-MPLS. An adjacency can have both types of SIDs assigned by configuration. An LFA protected adjacency SID is eligible for LFA protection, however, the following procedure applies even if an LFA backup is not programmed at the time of the failure. An LFA unprotected adjacency SID is not eligible for LFA protection.

  • IGP withdraws the advertisement of the link TLV as well as its adjacency SID sub-TLV.

  • The adjacency SID hold timer starts.

  • The LTN and ILM records of the adjacency are kept in the datapath for as long as the adjacency SID hold time is running. This allows packets to flow over the LFA backup path, when the adjacency is protected, and allows the ingress LER or PCE time to compute a new path of the SR-TE LSP after IGP converges.

  • If the adjacency is restored while the adjacency SID hold timer is running, the timer is aborted, and the adjacency SID remains programmed in the datapath with the retained SID values. However, the backup NHLFE may change if a new LFA SPF runs while the adjacency SID hold timer running. An update to the backup NHLFE is performed immediately following the LFA SPF. In all cases, the adjacency keeps its assigned SID label value.

  • If the adjacency SID hold timer expires before the adjacency is restored, the SID is deprogrammed from the datapath and the label returned into the common pool where it was drawn from. Users of the adjacency (for example, SR policy and SR-TE LSP) are also informed. When the adjacency is subsequently restored, it gets assigned its allocated static-label value or a new dynamic-label value.

  • A new PG-ID is assigned each time an adjacency comes back up. This PG-ID is used by the ILM and LTN of the adjacency SID and of all downstream node SIDs that resolve to a next hop over this adjacency.

Range1 to 1800
Unitsseconds
Options none
Default 15
Introduced16.0.R1

Platforms

All

adjacency-set [id] number
Synopsis Enter the adjacency-set list instance
Contextconfigure router string ospf number segment-routing adjacency-set number
Treeadjacency-set
Introduced16.0.R1

Platforms

All

[id] number
Synopsis Non-zero identifier for a given adjacency set
Contextconfigure router string ospf number segment-routing adjacency-set number
Treeadjacency-set
Range1 to 4294967295

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

adjacency-sid
Synopsis Enter the adjacency-sid context
Contextconfigure router string ospf number segment-routing adjacency-sid
Treeadjacency-sid
Introduced22.7.R1

Platforms

All

allocate-dual-sids boolean
Synopsis Allocate dual adjacency SIDs per interface
Contextconfigure router string ospf number segment-routing adjacency-sid allocate-dual-sids boolean
Treeallocate-dual-sids

Description

When configured to true, the router supports two SR-MPLS adjacency SIDs per interface. A protected and unprotected adjacency SID is instantiated and advertised. If an SR-MPLS adjacency SID already exists, an additional complementary (protected or unprotected) adjacency SID is created on the interface.

When configured to false, the router disables the support of two SR-MPLS adjacency SIDs per interface.

Defaultfalse
Introduced22.7.R1

Platforms

All

backup-node-sid
Synopsis Enable the backup-node-sid context
Contextconfigure router string ospf number segment-routing backup-node-sid
Treebackup-node-sid
Introduced16.0.R1

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string ospf number segment-routing backup-node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string ospf number segment-routing backup-node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R1

Platforms

All

class-forwarding boolean
Synopsis Allow CBF with ECMP over RSVP-TE LSPs as IGP shortcuts
Contextconfigure router string ospf number segment-routing class-forwarding boolean
Treeclass-forwarding

Description

When configured to true, this command enables Class-Based Forwarding (CBF) with ECMP for SR-OSPF resolved to RSVP-TE LSPs as IGP shortcuts.

For CBF with ECMP to be effective, a class forwarding policy must be defined, as well as FC to set associations and RSVP-TE LSPs to set associations.

When configured to false, CBF over IGP shortcuts is disabled.

Defaultfalse
Introduced20.5.R1

Platforms

All

egress-statistics
Synopsis Enter the egress-statistics context
Contextconfigure router string ospf number segment-routing egress-statistics
Treeegress-statistics
Introduced19.10.R1

Platforms

All

adj-set boolean
Synopsis Enable the allocation of statistics on adjacency sets
Contextconfigure router string ospf number segment-routing egress-statistics adj-set boolean
Treeadj-set

Description

When configured to true, this command enables the allocation of statistic indices to each adjacency set. All adjacencies of a set share the same statistics index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

adj-sid boolean
Synopsis Enable the allocation of statistics on adjacency SIDs
Contextconfigure router string ospf number segment-routing egress-statistics adj-sid boolean
Treeadj-sid

Description

When configured to true, this command enables the allocation of statistic indexes to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

ingress-statistics
Synopsis Enter the ingress-statistics context
Contextconfigure router string ospf number segment-routing ingress-statistics
Treeingress-statistics
Introduced19.10.R1

Platforms

All

adj-set boolean
Synopsis Enable the allocation of statistics on adjacency sets
Contextconfigure router string ospf number segment-routing ingress-statistics adj-set boolean
Treeadj-set

Description

When configured to true, this command enables the allocation of statistic indices to each adjacency set. All adjacencies of a set share the same statistics index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

adj-sid boolean
Synopsis Enable the allocation of statistics on adjacency SIDs
Contextconfigure router string ospf number segment-routing ingress-statistics adj-sid boolean
Treeadj-sid

Description

When configured to true, this command enables the allocation of statistic indexes to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

mapping-server
Synopsis Enter the mapping-server context
Contextconfigure router string ospf number segment-routing mapping-server
Treemapping-server
Introduced16.0.R1

Platforms

All

node-sid-map [sid-index] number
Synopsis Enter the node-sid-map list instance
Contextconfigure router string ospf number segment-routing mapping-server node-sid-map number
Treenode-sid-map
Introduced16.0.R1

Platforms

All

ip-prefix string
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisStarting prefix of the mapping
Contextconfigure router string ospf number segment-routing mapping-server node-sid-map number ip-prefix string
Treeip-prefix

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

range number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNumber of prefixes mapped by Extended Range Prefix TLV
Contextconfigure router string ospf number segment-routing mapping-server node-sid-map number range number
Treerange
Range1 to 65535
Default1
Introduced 16.0.R1

Platforms

All

scope
Synopsis Enter the scope context
Context configure router string ospf number segment-routing mapping-server node-sid-map number scope
Treescope
Introduced16.0.R1

Platforms

All

maximum-sid-depth
Synopsis Enter the maximum-sid-depth context
Contextconfigure router string ospf number segment-routing maximum-sid-depth
Treemaximum-sid-depth
Introduced20.2.R1

Platforms

All

override-bmi number
Synopsis Value to override the announced node MSD-BMI value
Contextconfigure router string ospf number segment-routing maximum-sid-depth override-bmi number
Treeoverride-bmi

Description

This command overrides the announced MSD node Base MPLS Imposition (BMI) value. The MSD-BMI value announced by a router can be used by recipients to understand the number of MPLS labels that can be imposed inclusive of all service, transport, or special labels.

When unconfigured, the router announces the maximum supported BMI of the node assuming the most simple services and Layer 2 encapsulation.

Range0 to 12
Introduced20.2.R1

Platforms

All

override-erld number
Synopsis Value to override the announced node MSD-ERLD value
Contextconfigure router string ospf number segment-routing maximum-sid-depth override-erld number
Treeoverride-erld

Description

This command configures the override Entropy Readable Label Depth (ERLD) Maximum Sid Depth (MSD) value. Information about the capability of each intermediate LSR of reading the maximum label stack depth is used by ingress LSRs to perform EL-based load balancing.

When unconfigured, the router announces the node maximum supported ERLD assuming the most simple Layer 2 encapsulation.

Range0 to 15
Introduced20.2.R1

Platforms

All

micro-loop-avoidance
Synopsis Enable the micro-loop-avoidance context
Contextconfigure router string ospf number segment-routing micro-loop-avoidance
Treemicro-loop-avoidance

Description

Commands in this context configure micro-loop avoidance for SR-OSPF.

Introduced24.3.R1

Platforms

All

fib-delay number
Synopsis FIB delay
Contextconfigure router string ospf number segment-routing micro-loop-avoidance fib-delay number
Treefib-delay

Description

This command configures the FIB delay before programming new primary next hops.

Configure the FIB delay timer to a value that corresponds to the worst-case IGP convergence in a network domain. The default FIB delay timer value corresponds to a network with a nominal convergence time.

When configured, the feature applies to the following contexts:

  • SPFv2 SR-OSPF IPv4 tunnel (node SID)

  • IPv4 and IPv6 SR-TE LSPs that use a node SID in their segment list

  • IPv4 and IPv6 SR policies that use a node SID in their segment list

When micro-loop avoidance is disabled, the system forces any running FIB delay to expire immediately and the system programs new next hops for all impacted node SIDs. When disabled, micro-loop avoidance is disabled instantaneously and will be disabled for the next SPF runs. Micro-loop avoidance remains disabled until it is re-enabled.

Range1 to 300
Unitsdeciseconds
Default 15
Introduced24.3.R1

Platforms

All

prefix-sid-range
Synopsis Enable the prefix-sid-range context
Contextconfigure router string ospf number segment-routing prefix-sid-range
Treeprefix-sid-range

Description

Commands in this context configure the label block BGP segment routing can use.

Introduced16.0.R1

Platforms

All

global
Synopsis Allocate labels from the SRBG space
Context configure router string ospf number segment-routing prefix-sid-range global
Treeglobal

Description

When configured, the system allows BGP to allocate labels from the SRGB space, as defined under the configure router mpls-labels sr-labels context.

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R1

Platforms

All

max-index number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUpper bound value for the local SID index
Contextconfigure router string ospf number segment-routing prefix-sid-range max-index number
Treemax-index
Range0 to 524287
Default1

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R1

Platforms

All

start-label number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLower bound value for the local label offset
Contextconfigure router string ospf number segment-routing prefix-sid-range start-label number
Treestart-label
Range0 to 524287
Default0

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R1

Platforms

All

tunnel-table-pref number
Synopsis Preference of SR tunnels created by the IGP instance
Contextconfigure router string ospf number segment-routing tunnel-table-pref number
Treetunnel-table-pref

Description

This command configures the TTM preference of shortest path SR tunnels created by the IGP instance. This is used for BGP shortcuts, VPRN auto-bind, or BGP transport tunnel when the tunnel binding commands are configured to the any value, which parses the TTM for tunnels in the protocol preference order. The user can choose to either accept the global TTM preference or explicitly list the tunnel types they want to use. If the user lists the tunnel type explicitly, the TTM preference is still used to select one type over the other. In both cases, a fallback to the next preferred tunnel type is performed if the selected type fails. A reversion to a more preferred tunnel type is performed as soon as one is available.

The segment routing module adds to the TTM an SR tunnel entry for each resolved remote node SID prefix and programs the data path having the corresponding LTN with the push operation pointing to the primary and LFA backup NHLFEs.

The default preference for shortest path SR tunnels in the TTM is set lower than LDP tunnels but higher than BGP tunnels to allow controlled migration of customers without disrupting their current deployment when they enable segment routing. The following is the value of the default preference for the various tunnel types. This includes the preference of SR tunnels based on shortest path (referred to as SR-ISIS and SR-OSPF).

Note: The preference of an SR-TE LSP is not configurable and is the second most preferred tunnel type after RSVP-TE. The preference is the same whether if the SR-TE LSP was resolved in IS-IS or OSPF.

The global default TTM preference for the tunnel types is as follows:

  • ROUTE_PREF_RSVP 7

  • ROUTE_PREF_SR_TE 8

  • ROUTE_PREF_LDP 9

  • ROUTE_PREF_OSPF_TTM 10

  • ROUTE_PREF_ISIS_TTM 11

  • ROUTE_PREF_BGP_TTM 12

  • ROUTE_PREF_GRE 255

The default value for SR-ISIS or SR-OSPF is the same regardless if one or more IS-IS or OSPF instances programmed a tunnel for the same prefix. The selection of a SR tunnel in this case will be based on the lowest IGP instance ID. Similarly, IPv6 SR-ISIS and SR-OSPF3 tunnels are programmed into TTMv6 with the same default preference value as IPv4 SR-ISIS and IPv4 SR-OSPF respectively.

Nokia recommends not to set two or more tunnel types to the same preference value. In such a situation, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default10
Introduced 16.0.R1

Platforms

All

timers
Synopsis Enter the timers context
Context configure router string ospf number timers
Treetimers
Introduced16.0.R1

Platforms

All

lsa-accumulate number
Synopsis Delay to gather LSAs before advertising to neighbors
Contextconfigure router string ospf number timers lsa-accumulate number
Treelsa-accumulate
Range0 to 1000
Unitsmilliseconds
Default 1000
Introduced16.0.R1

Platforms

All

lsa-arrival number
Synopsis Minimum delay between receipt of same LSAs
Contextconfigure router string ospf number timers lsa-arrival number
Treelsa-arrival
Range0 to 600000
Unitsmilliseconds
Default 1000
Introduced16.0.R1

Platforms

All

lsa-generate
Synopsis Enter the lsa-generate context
Contextconfigure router string ospf number timers lsa-generate
Treelsa-generate
Introduced16.0.R1

Platforms

All

spf-wait
Synopsis Enter the spf-wait context
Context configure router string ospf number timers spf-wait
Treespf-wait
Introduced16.0.R1

Platforms

All

spf-max-wait number
Synopsis Maximum interval between consecutive SPF calculations
Contextconfigure router string ospf number timers spf-wait spf-max-wait number
Treespf-max-wait
Range10 to 120000
Unitsmilliseconds
Default10000
Introduced 16.0.R1

Platforms

All

traffic-engineering-options
Synopsis Enter the traffic-engineering-options context
Contextconfigure router string ospf number traffic-engineering-options
Treetraffic-engineering-options
Introduced20.7.R1

Platforms

All

advertise-delay boolean
Synopsis Enable the advertisement of link delay for TE
Contextconfigure router string ospf number traffic-engineering-options advertise-delay boolean
Treeadvertise-delay

Description

When configured to true, the router advertises link delay in the IGP LSDB within the OSPF-TE TLV attribute or when the Application-Specific Link Attribute (ASLA) is enabled within SR-TE ASLA.

When the router is configured under the configure router ospf traffic-engineering-options sr-te application-specific-link-attributes command to generate SR-TE ASLA attributes, link delay is advertised as a legacy RFC 3630 TLV when RSVP-TE is enabled and as an ASLA RFC 8920 TLV for SR-TE when MPLS is enabled for an interface.

SR OS accepts and handles both legacy RSVP-TE TLVs and ASLAs for the RSVP application. However, SR OS only advertises RFC 3630 legacy RSVP-TE TLVs (as recommended by RFC 8920) to avoid compatibility issues.

When configured to false, the router disables link delay advertisement.

Defaultfalse
Introduced22.10.R1

Platforms

All

sr-te keyword
Synopsis Advertisement of link attributes for SR-TE
Contextconfigure router string ospf number traffic-engineering-options sr-te keyword
Treesr-te

Description

This command specifies the advertisement of TE attributes of each link on a per-application basis for RSVP-TE and SR-TE applications.

Optionsfalse, legacy, application-specific-link-attributes
Defaultfalse
Introduced20.7.R1

Platforms

All

unicast-import boolean
Synopsis Submit routes into the unicast Route Table Manager
Contextconfigure router string ospf number unicast-import boolean
Treeunicast-import
Defaulttrue
Introduced16.0.R1

Platforms

All

ospf3 [ospf-instance] number

Synopsis Enter the ospf3 list instance
Context configure router string ospf3 number
Treeospf3
Max. Instances32
Introduced16.0.R1

Platforms

All

[ospf-instance] number
Synopsis Value for the integrated OSPF instance
Contextconfigure router string ospf3 number
Treeospf3
Range0 to 31 | 64 to 95
MD-CLI Default0

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the OSPF instance
Contextconfigure router string ospf3 number admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

area [area-id] string
Synopsis Enter the area list instance
Context configure router string ospf3 number area string
Treearea
Introduced16.0.R1

Platforms

All

[area-id] string
Synopsis Area-ID attribute
Context configure router string ospf3 number area string
Treearea

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

area-range [ip-prefix-mask] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the area-range list instance
Contextconfigure router string ospf3 number area string area-range (ipv4-prefix | ipv6-prefix)
Treearea-range
Introduced16.0.R1

Platforms

All

[ip-prefix-mask] (ipv4-prefix | ipv6-prefix)
Synopsis Address ranges to create on an ABR for route summarization or suppression
Contextconfigure router string ospf3 number area string area-range (ipv4-prefix | ipv6-prefix)
Treearea-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertise boolean
Synopsis Advertise summarized range of addresses to other areas
Contextconfigure router string ospf3 number area string area-range (ipv4-prefix | ipv6-prefix) advertise boolean
Treeadvertise
Defaulttrue
Introduced16.0.R1

Platforms

All

extended-lsa keyword
Synopsis Extended LSA format in an OSPFv3 area
Contextconfigure router string ospf3 number area string extended-lsa keyword
Treeextended-lsa
Optionsonly
Introduced16.0.R1

Platforms

All

interface [interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string ospf3 number area string interface string
Treeinterface
Introduced16.0.R1

Platforms

All

[interface-name] string
Synopsis Router interface name
Context configure router string ospf3 number area string interface string
Treeinterface

Description

This command specifies the IP interface name. Interface names must be unique within the group of defined IP interfaces for configure router interface and configure service ies interface commands. An interface name cannot be in the form of an IP address. Interface names can be a string composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

If the IP interface name does not exist or does not have an IP address configured, an error message is returned.

If the IP interface exists in a different area it is moved to this area.

String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the OSPF interface
Contextconfigure router string ospf3 number area string interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

authentication
Synopsis Enable the authentication context
Contextconfigure router string ospf3 number area string interface string authentication
Treeauthentication
Introduced16.0.R6

Platforms

All

bfd-liveness
Synopsis Enable the bfd-liveness context
Contextconfigure router string ospf3 number area string interface string bfd-liveness
Treebfd-liveness
Introduced16.0.R1

Platforms

All

strict boolean
Synopsis Enable BFD strict mode
Context configure router string ospf3 number area string interface string bfd-liveness strict boolean
Treestrict

Description

When configured to true, the system uses BFD strict-mode. BFD strict-mode mandates that an active BFD session must exist between the OSPF neighbors before establishing a full adjacency. When configured to true, the router uses Link-Local Signaling (LLS) with the B-flag set to instruct the OSPF neighbors that BFD must be enabled on the link. BFD strict-mode requires both sides to have the B-flag set.

During OSPFv3 BFD strict-mode operations, the router advertises the local interface IPv4 address TLV using LLS, but the SR OS router continues to use IPv6-based BFD sessions for both the IPv4 and IPv6 address families.

Defaultfalse
Introduced23.3.R1

Platforms

All

strict-mode-holddown number
Synopsis Adjacency up time delay after BFD session establishment
Contextconfigure router string ospf3 number area string interface string bfd-liveness strict-mode-holddown number
Treestrict-mode-holddown

Description

This command configures a delay timer before bringing up the OSPF adjacency after the BFD session establishment. Holddown helps mitigate potential routing churn when BFD sessions are unstable. The holddown timer is reset when a BFD session operationally toggles.

Range1 to 600
Unitsseconds
Introduced 23.3.R1

Platforms

All

dead-interval number
Synopsis OSPF wait time for Hellos before neighbor declared down
Contextconfigure router string ospf3 number area string interface string dead-interval number
Treedead-interval
Range2 to 65535
Unitsseconds
Introduced 16.0.R1

Platforms

All

interface-type keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisInterface type
Contextconfigure router string ospf3 number area string interface string interface-type keyword
Treeinterface-type

Description

This command specifies the interface type.

broadcast - Broadcast network

To significantly improve adjacency forming and network convergence, configure a network as point-to-point if only two routers are connected, even if the network is a broadcast media such as Ethernet.

non-broadcast - Non-broadcast network

point-to-point - Point-to-point link

Set the interface type of an Ethernet link to point-to-point to avoid having to carry the broadcast adjacency maintenance overhead if the Ethernet link provided is used as a point-to-point.

p2mp-nbma - Point-to-multipoint on a link without broadcast or multicast support

No designated router or backup designated router is elected on this type of interface and all OSPF neighbors connect through individual point-to-point links. Only VPRN and IES services interfaces support this interface type.

secondary - Multiple secondary adjacencies allowed

A secondary interface allows multiple secondary adjacencies, in addition to the primary adjacency, to be established over a single IP interface. This interface type can also be applied to the system interface and to loopback interfaces to allow them to participate in multiple areas, although no adjacencies are formed over these types of interfaces.

Optionsbroadcast, non-broadcast, point-to-point, secondary, p2mp-nbma
Introduced16.0.R1

Platforms

All

loopfree-alternate
Synopsis Enter the loopfree-alternate context
Contextconfigure router string ospf3 number area string interface string loopfree-alternate
Treeloopfree-alternate
Introduced16.0.R3

Platforms

All

policy-map
Synopsis Enable the policy-map context
Context configure router string ospf3 number area string interface string loopfree-alternate policy-map
Treepolicy-map
Introduced16.0.R3

Platforms

All

lsa-filter-out keyword
Synopsis LSA flooding reduction
Context configure router string ospf3 number area string interface string lsa-filter-out keyword
Treelsa-filter-out
Optionsnone, all, except-own-rtrlsa, except-own-rtrlsa-and-defaults
Defaultnone
Introduced16.0.R1

Platforms

All

metric number
Synopsis Route cost metric for the interface
Context configure router string ospf3 number area string interface string metric number
Treemetric
Range1 to 65535
Introduced16.0.R1

Platforms

All

mtu number
Synopsis MTU for the OSPF to use on the interface
Contextconfigure router string ospf3 number area string interface string mtu number
Treemtu
Range512 to 9786
Introduced16.0.R1

Platforms

All

neighbor [address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Add a list entry for neighbor
Context configure router string ospf3 number area string interface string neighbor (ipv4-address-no-zone | ipv6-address-no-zone)
Treeneighbor
Introduced16.0.R1

Platforms

All

[address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Neighbor link local address
Context configure router string ospf3 number area string interface string neighbor (ipv4-address-no-zone | ipv6-address-no-zone)
Treeneighbor

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

node-sid
Synopsis Enable the node-sid context
Context configure router string ospf3 number area string interface string node-sid
Treenode-sid

Description

Commands in this context configure a node SID index or label value for the prefix representing the primary address of a network interface of type system or loopback. A separate SID value can be configured for each IPv4 and IPv6 primary address of the interface. The secondary address of an IPv4 interface cannot be assigned a node SID index and does not inherit the SID of the primary IPv4 address.

In OSPFv2 and OSPFv3, the node SID is configured in the primary area but is inherited in any other area in which the interface is added as secondary.

This command fails if the network interface is not a loopback type or if the interface is defined in an IES or VPRN context. Assigning the same SID index or label value to the same interface in two different IGP instances is not allowed within the same node.

The value of the label or index SID is taken from the range configured for this IGP instance. When using the global mode of operation, the segment routing module checks that the same index or label value is not assigned to more than one loopback interface address. When using the per-instance mode of operation, this check is not required because the index and, therefore, the label ranges of IGP instances are not allowed to overlap.

The clear-n-flag option allows the user to clear the N-flag (node-sid flag) in an OSPF or OSPF3 prefix SID sub-TLV originated for the prefix of a loopback interface on the system. By default, the prefix SID sub-TLV for the prefix of a loopback interface is tagged as a node SID; that is, it belongs to this node only. However, to configure and advertise an anycast SID using the same loopback interface prefix on multiple nodes, the user must clear the N-flag to assure interoperability with third-party implementations. This may perform a strict check on the receive end and drop duplicate prefix SID sub-TLVs when the N-flag is set.

The SR OS implementation is relaxed on the receive end and accepts duplicate prefix SIDs with the N-flag set or clear. SR OS resolves to the closest owner, or owners if ECMP, of the prefix SID cost-wise.

Introduced16.0.R4

Platforms

All

clear-n-flag boolean
Synopsis Clear the N-flag in an OSPF3 prefix
Context configure router string ospf3 number area string interface string node-sid clear-n-flag boolean
Treeclear-n-flag

Description

When configured to true, this command allows the user to clear the N-flag in an OSPF3 prefix SID sub-TLV originated for the prefix of a loopback interface on the system.

When configured to false, the N-flag in an OSPF3 prefix SID sub-TLV originated for the prefix of a loopback interface on the system is not cleared.

When the user wants to configure and advertise an anycast SID using the same loopback interface prefix on multiple nodes, the user must clear the N-flag to assure interoperability with third-party implementations. This may perform a strict check on the receive end and drop duplicate prefix SID sub-TLVs when the N-flag is set.

Defaultfalse
Introduced16.0.R5

Platforms

All

index number
Synopsis Node SID index for this interface
Context configure router string ospf3 number area string interface string node-sid index number
Treeindex
Range0 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R4

Platforms

All

label number
Synopsis Label value for the node SID
Context configure router string ospf3 number area string interface string node-sid label number
Treelabel
Range1 to 4294967295

Notes

The following elements are part of a choice: index or label.

Introduced16.0.R4

Platforms

All

passive boolean
Synopsis Advertise passive interfaces as OSPF interfaces
Contextconfigure router string ospf3 number area string interface string passive boolean
Treepassive
Introduced16.0.R1

Platforms

All

poll-interval number
Synopsis Interval for Hellos to non-adjacent OSPF NBMA neighbor
Contextconfigure router string ospf3 number area string interface string poll-interval number
Treepoll-interval
Max. Range0 to 4294967295
Unitsseconds
Default120
Introduced 16.0.R1

Platforms

All

priority number
Synopsis Interface priority in the DR election on the subnet
Contextconfigure router string ospf3 number area string interface string priority number
Treepriority
Range0 to 255
Default1
Introduced 16.0.R1

Platforms

All

nssa
Synopsis Enable the nssa context
Context configure router string ospf3 number area string nssa
Treenssa
Introduced16.0.R1

Platforms

All

area-range [ip-prefix-mask] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the area-range list instance
Contextconfigure router string ospf3 number area string nssa area-range (ipv4-prefix | ipv6-prefix)
Treearea-range
Introduced16.0.R1

Platforms

All

[ip-prefix-mask] (ipv4-prefix | ipv6-prefix)
Synopsis Addresses on ABR for route summarization or suppression
Contextconfigure router string ospf3 number area string nssa area-range (ipv4-prefix | ipv6-prefix)
Treearea-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

advertise boolean
Synopsis Advertise summarized range of addresses to other areas
Contextconfigure router string ospf3 number area string nssa area-range (ipv4-prefix | ipv6-prefix) advertise boolean
Treeadvertise
Defaulttrue
Introduced16.0.R1

Platforms

All

originate-default-route
Synopsis Enable the originate-default-route context
Contextconfigure router string ospf3 number area string nssa originate-default-route
Treeoriginate-default-route
Introduced16.0.R1

Platforms

All

summaries boolean
Synopsis Send summary (Type 3) LSAs into the NSSA on an ABR
Contextconfigure router string ospf3 number area string nssa summaries boolean
Treesummaries
Defaulttrue
Introduced16.0.R1

Platforms

All

stub
Synopsis Enable the stub context
Context configure router string ospf3 number area string stub
Treestub
Introduced16.0.R1

Platforms

All

default-metric number
Synopsis Metric used by ABR for default route into the stub area
Contextconfigure router string ospf3 number area string stub default-metric number
Treedefault-metric
Range1 to 16777214
Default1
Introduced 16.0.R1

Platforms

All

summaries boolean
Synopsis Send summary (Type 3) LSAs into the stub area on an ABR
Contextconfigure router string ospf3 number area string stub summaries boolean
Treesummaries
Defaulttrue
Introduced16.0.R1

Platforms

All

virtual-link [router-id] string transit-area reference
Synopsis Enter the virtual-link list instance
Contextconfigure router string ospf3 number area string virtual-link string transit-area reference
Treevirtual-link
Introduced16.0.R1

Platforms

All

[router-id] string
Synopsis Router ID of the virtual link neighbor
Contextconfigure router string ospf3 number area string virtual-link string transit-area reference
Treevirtual-link

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

transit-area reference
Synopsis Transit area linking backbone and non-connected area
Contextconfigure router string ospf3 number area string virtual-link string transit-area reference
Treevirtual-link

Reference

configure router string ospf3 number area string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

authentication
Synopsis Enable the authentication context
Contextconfigure router string ospf3 number area string virtual-link string transit-area reference authentication
Treeauthentication
Introduced16.0.R6

Platforms

All

asbr
Synopsis Enable the asbr context
Context configure router string ospf3 number asbr
Treeasbr
Introduced16.0.R1

Platforms

All

database-export
Synopsis Enable the database-export context
Contextconfigure router string ospf3 number database-export
Treedatabase-export
Introduced16.0.R4

Platforms

All

igp-identifier number
Synopsis IGP instance in the BGP-LS NLRI
Context configure router string ospf3 number database-export igp-identifier number
Treeigp-identifier

Description

This command identifies the IGP instance in the BGP-LS NLRI when a router has interfaces participating in multiple IGP instances. The concept of an instance ID specified for OSPF is local subnet significant (RFC 6549). An IGP identifier value can be configured to be unique within a given IGP domain when the router sends the IGP link state information using BGP-LS.

Max. Range0 to 18446744073709551615
Introduced16.0.R4

Platforms

All

export-limit
Synopsis Enable the export-limit context
Contextconfigure router string ospf3 number export-limit
Treeexport-limit
Introduced16.0.R1

Platforms

All

number number
Synopsis Maximum routes or prefixes exported from route table
Contextconfigure router string ospf3 number export-limit number number
Treenumber
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

export-policy reference
Synopsis Export policies that determine exported routes
Contextconfigure router string ospf3 number export-policy reference
Treeexport-policy

Description

This command configures export routing policies for the routes exported from the routing table to IS-IS.

If the export policy is undefined, the system does not export non IS-IS routes from the routing table manager to IS-IS.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

If the aggregate command is also configured in the configure router context, the aggregation is applied before the export policy is applied.

Routing policies are created in the configure router policy-options context.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

extended-lsa keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisExtended LSA format in an OSPFv3 area
Contextconfigure router string ospf3 number extended-lsa keyword
Treeextended-lsa
Optionssparse, only
Default sparse
Introduced16.0.R1

Platforms

All

external-db-overflow
Synopsis Enable the external-db-overflow context
Contextconfigure router string ospf3 number external-db-overflow
Treeexternal-db-overflow
Introduced16.0.R1

Platforms

All

interval number
Synopsis Time during which the router operates in overload
Contextconfigure router string ospf3 number external-db-overflow interval number
Treeinterval
Range0 to 2147483647
Unitsseconds
Default 0
Introduced16.0.R1

Platforms

All

limit number
Synopsis Number of external LSA at which overload is triggered
Contextconfigure router string ospf3 number external-db-overflow limit number
Treelimit
Range0 to 2147483647
Default0
Introduced 16.0.R1

Platforms

All

graceful-restart
Synopsis Enable the graceful-restart context
Contextconfigure router string ospf3 number graceful-restart
Treegraceful-restart
Introduced16.0.R1

Platforms

All

igp-shortcut
Synopsis Enter the igp-shortcut context
Contextconfigure router string ospf3 number igp-shortcut
Treeigp-shortcut
Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the IGP shortcuts
Contextconfigure router string ospf3 number igp-shortcut admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

All

tunnel-next-hop
Synopsis Enter the tunnel-next-hop context
Contextconfigure router string ospf3 number igp-shortcut tunnel-next-hop
Treetunnel-next-hop
Introduced16.0.R4

Platforms

All

family [family-type] keyword
Synopsis Enter the family list instance
Contextconfigure router string ospf3 number igp-shortcut tunnel-next-hop family keyword
Treefamily
Introduced16.0.R4

Platforms

All

[family-type] keyword
Synopsis Address family type for the tunnel next hop
Contextconfigure router string ospf3 number igp-shortcut tunnel-next-hop family keyword
Treefamily
Optionsipv4, ipv6, srv4, srv6

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

resolution-filter
Synopsis Enter the resolution-filter context
Contextconfigure router string ospf3 number igp-shortcut tunnel-next-hop family keyword resolution-filter
Treeresolution-filter
Introduced16.0.R4

Platforms

All

ldp-sync boolean
Synopsis Configure IGP-LDP synchronization for interfaces
Contextconfigure router string ospf3 number ldp-sync boolean
Treeldp-sync
Defaulttrue
Introduced16.0.R1

Platforms

All

loopfree-alternate
Synopsis Enable the loopfree-alternate context
Contextconfigure router string ospf3 number loopfree-alternate
Treeloopfree-alternate
Introduced16.0.R1

Platforms

All

exclude
Synopsis Enter the exclude context
Context configure router string ospf3 number loopfree-alternate exclude
Treeexclude
Introduced16.0.R3

Platforms

All

prefix-policy reference
Synopsis Policy to exclude prefixes from LFA SPF calculation
Contextconfigure router string ospf3 number loopfree-alternate exclude prefix-policy reference
Treeprefix-policy

Description

This command specifies the name of the policy for the prefixes to exclude from the LFA SPF calculation.

An excluded prefix is not included in LFA calculation regardless of its priority. The prefix tag is, however, used in the main SPF.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R3

Platforms

All

remote-lfa
Synopsis Enable the remote-lfa context
Context configure router string ospf3 number loopfree-alternate remote-lfa
Treeremote-lfa
Introduced16.0.R4

Platforms

All

ti-lfa
Synopsis Enable the ti-lfa context
Context configure router string ospf3 number loopfree-alternate ti-lfa
Treeti-lfa

Description

Commands in this context configure the Topology Independent Loop-Free Alternate (TI-LFA) algorithm used in the LFA Shortest Path First (SPF) calculation for this OSPFv3 instance.

Introduced16.0.R5

Platforms

All

max-sr-frr-labels number
Synopsis Maximum number of labels the TI-LFA backup path can use
Contextconfigure router string ospf3 number loopfree-alternate ti-lfa max-sr-frr-labels number
Treemax-sr-frr-labels

Description

This command configures the maximum number of labels allowed in the segment list of the TI-LFA repair tunnel. A higher value results in better coverage by TI-LFA at the expense of increased packet encapsulation overhead. The TI-LFA algorithm uses this value to limit the search for the Q-node from the P-node on the post-convergence path.

Range0 to 3
Default2
Introduced 16.0.R5

Platforms

All

multicast-import boolean
Synopsis Submit routes into the multicast Route Table Manager
Contextconfigure router string ospf3 number multicast-import boolean
Treemulticast-import
Defaultfalse
Introduced16.0.R1

Platforms

All

overload boolean
Synopsis Change local router state to appear overloaded
Contextconfigure router string ospf3 number overload boolean
Treeoverload
Defaultfalse
Introduced16.0.R1

Platforms

All

preference number
Synopsis Preference for OSPF internal routes
Context configure router string ospf3 number preference number
Treepreference
Range1 to 255
Default10
Introduced 16.0.R1

Platforms

All

reference-bandwidth number
Synopsis Bandwidth to reference default costing of interfaces
Contextconfigure router string ospf3 number reference-bandwidth number
Treereference-bandwidth
Range1 to 18446744073709551615
Unitskilobps
Default100000000
Introduced 16.0.R1

Platforms

All

rib-priority
Synopsis Enter the rib-priority context
Contextconfigure router string ospf3 number rib-priority
Treerib-priority
Introduced16.0.R1

Platforms

All

router-id string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUnique router ID for the OSPF instance
Contextconfigure router string ospf3 number router-id string
Treerouter-id
Introduced16.0.R1

Platforms

All

rtr-adv-lsa-limit
Synopsis Enable the rtr-adv-lsa-limit context
Contextconfigure router string ospf3 number rtr-adv-lsa-limit
Treertr-adv-lsa-limit
Introduced16.0.R1

Platforms

All

overload-timeout (number | keyword)
Synopsis Maximum time in overload after LSA limit is reached
Contextconfigure router string ospf3 number rtr-adv-lsa-limit overload-timeout (number | keyword)
Treeoverload-timeout
Range1 to 1800
Unitsseconds
Options forever
Defaultforever
Introduced 16.0.R1

Platforms

All

segment-routing
Synopsis Enter the segment-routing context
Contextconfigure router string ospf3 number segment-routing
Treesegment-routing
Introduced16.0.R4

Platforms

All

adj-sid-hold (number | keyword)
Synopsis Adjacency SID hold time
Context configure router string ospf3 number segment-routing adj-sid-hold (number | keyword)
Treeadj-sid-hold

Description

This command configures a timer to hold the ILM or LTN of an adjacency SID following a failure of the adjacency.

When an adjacency to a neighbor fails, the following procedure is followed for both an LFA protected and the LFA unprotected SID of this adjacency in SR-MPLS. An adjacency can have both types of SIDs assigned by configuration. An LFA protected adjacency SID is eligible for LFA protection, however, the following procedure applies even if an LFA backup is not programmed at the time of the failure. An LFA unprotected adjacency SID is not eligible for LFA protection.

  • IGP withdraws the advertisement of the link TLV as well as its adjacency SID sub-TLV.

  • The adjacency SID hold timer starts.

  • The LTN and ILM records of the adjacency are kept in the datapath for as long as the adjacency SID hold time is running. This allows packets to flow over the LFA backup path, when the adjacency is protected, and allows the ingress LER or PCE time to compute a new path of the SR-TE LSP after IGP converges.

  • If the adjacency is restored while the adjacency SID hold timer is running, the timer is aborted, and the adjacency SID remains programmed in the datapath with the retained SID values. However, the backup NHLFE may change if a new LFA SPF runs while the adjacency SID hold timer running. An update to the backup NHLFE is performed immediately following the LFA SPF. In all cases, the adjacency keeps its assigned SID label value.

  • If the adjacency SID hold timer expires before the adjacency is restored, the SID is deprogrammed from the datapath and the label returned into the common pool where it was drawn from. Users of the adjacency (for example, SR policy and SR-TE LSP) are also informed. When the adjacency is subsequently restored, it gets assigned its allocated static-label value or a new dynamic-label value.

  • A new PG-ID is assigned each time an adjacency comes back up. This PG-ID is used by the ILM and LTN of the adjacency SID and of all downstream node SIDs that resolve to a next hop over this adjacency.

Range1 to 1800
Unitsseconds
Options none
Default 15
Introduced16.0.R4

Platforms

All

adjacency-sid
Synopsis Enter the adjacency-sid context
Contextconfigure router string ospf3 number segment-routing adjacency-sid
Treeadjacency-sid
Introduced22.7.R1

Platforms

All

allocate-dual-sids boolean
Synopsis Allocate dual adjacency SIDs per interface
Contextconfigure router string ospf3 number segment-routing adjacency-sid allocate-dual-sids boolean
Treeallocate-dual-sids

Description

When configured to true, the router supports two SR-MPLS adjacency SIDs per interface. A protected and unprotected adjacency SID is instantiated and advertised. If an SR-MPLS adjacency SID already exists, an additional complementary (protected or unprotected) adjacency SID is created on the interface.

When configured to false, the router disables the support of two SR-MPLS adjacency SIDs per interface.

Defaultfalse
Introduced22.7.R1

Platforms

All

egress-statistics
Synopsis Enter the egress-statistics context
Contextconfigure router string ospf3 number segment-routing egress-statistics
Treeegress-statistics
Introduced19.10.R1

Platforms

All

adj-sid boolean
Synopsis Enable the allocation of statistics on adjacency SIDs
Contextconfigure router string ospf3 number segment-routing egress-statistics adj-sid boolean
Treeadj-sid

Description

When configured to true, this command enables the allocation of statistic indexes to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

ingress-statistics
Synopsis Enter the ingress-statistics context
Contextconfigure router string ospf3 number segment-routing ingress-statistics
Treeingress-statistics
Introduced19.10.R1

Platforms

All

adj-sid boolean
Synopsis Enable the allocation of statistics on adjacency SIDs
Contextconfigure router string ospf3 number segment-routing ingress-statistics adj-sid boolean
Treeadj-sid

Description

When configured to true, this command enables the allocation of statistic indexes to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails and the system retries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

Defaultfalse
Introduced19.10.R1

Platforms

All

prefix-sid-range
Synopsis Enable the prefix-sid-range context
Contextconfigure router string ospf3 number segment-routing prefix-sid-range
Treeprefix-sid-range

Description

Commands in this context configure the label block BGP segment routing can use.

Introduced16.0.R4

Platforms

All

global
Synopsis Allocate labels from the SRBG space
Context configure router string ospf3 number segment-routing prefix-sid-range global
Treeglobal

Description

When configured, the system allows BGP to allocate labels from the SRGB space, as defined under the configure router mpls-labels sr-labels context.

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R4

Platforms

All

max-index number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUpper bound value for the local SID index
Contextconfigure router string ospf3 number segment-routing prefix-sid-range max-index number
Treemax-index
Range0 to 524287
Default1

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R4

Platforms

All

start-label number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLower bound value for the local label offset
Contextconfigure router string ospf3 number segment-routing prefix-sid-range start-label number
Treestart-label
Range0 to 524287
Default0

Notes

The following elements are part of a choice: global or (max-index and start-label).

Introduced16.0.R4

Platforms

All

tunnel-table-pref number
Synopsis Preference of SR tunnels created by the IGP instance
Contextconfigure router string ospf3 number segment-routing tunnel-table-pref number
Treetunnel-table-pref

Description

This command configures the TTM preference of shortest path SR tunnels created by the IGP instance. This is used for BGP shortcuts, VPRN auto-bind, or BGP transport tunnel when the tunnel binding commands are configured to the any value, which parses the TTM for tunnels in the protocol preference order. The user can choose to either accept the global TTM preference or explicitly list the tunnel types they want to use. If the user lists the tunnel type explicitly, the TTM preference is still used to select one type over the other. In both cases, a fallback to the next preferred tunnel type is performed if the selected type fails. A reversion to a more preferred tunnel type is performed as soon as one is available.

The segment routing module adds to the TTM an SR tunnel entry for each resolved remote node SID prefix and programs the data path having the corresponding LTN with the push operation pointing to the primary and LFA backup NHLFEs.

The default preference for shortest path SR tunnels in the TTM is set lower than LDP tunnels but higher than BGP tunnels to allow controlled migration of customers without disrupting their current deployment when they enable segment routing. The following is the value of the default preference for the various tunnel types. This includes the preference of SR tunnels based on shortest path (referred to as SR-ISIS and SR-OSPF).

Note: The preference of an SR-TE LSP is not configurable and is the second most preferred tunnel type after RSVP-TE. The preference is the same whether if the SR-TE LSP was resolved in IS-IS or OSPF.

The global default TTM preference for the tunnel types is as follows:

  • ROUTE_PREF_RSVP 7

  • ROUTE_PREF_SR_TE 8

  • ROUTE_PREF_LDP 9

  • ROUTE_PREF_OSPF_TTM 10

  • ROUTE_PREF_ISIS_TTM 11

  • ROUTE_PREF_BGP_TTM 12

  • ROUTE_PREF_GRE 255

The default value for SR-ISIS or SR-OSPF is the same regardless if one or more IS-IS or OSPF instances programmed a tunnel for the same prefix. The selection of a SR tunnel in this case will be based on the lowest IGP instance ID. Similarly, IPv6 SR-ISIS and SR-OSPF3 tunnels are programmed into TTMv6 with the same default preference value as IPv4 SR-ISIS and IPv4 SR-OSPF respectively.

Nokia recommends not to set two or more tunnel types to the same preference value. In such a situation, the tunnel table prefers the tunnel type which was first introduced in SR OS implementation historically.

Range1 to 255
Default10
Introduced 16.0.R4

Platforms

All

timers
Synopsis Enter the timers context
Context configure router string ospf3 number timers
Treetimers
Introduced16.0.R1

Platforms

All

lsa-accumulate number
Synopsis Delay to gather LSAs before advertising to neighbors
Contextconfigure router string ospf3 number timers lsa-accumulate number
Treelsa-accumulate
Range0 to 1000
Unitsmilliseconds
Default 1000
Introduced16.0.R1

Platforms

All

lsa-arrival number
Synopsis Minimum delay between receipt of same LSAs
Contextconfigure router string ospf3 number timers lsa-arrival number
Treelsa-arrival
Range0 to 600000
Unitsmilliseconds
Default 1000
Introduced16.0.R1

Platforms

All

lsa-generate
Synopsis Enter the lsa-generate context
Contextconfigure router string ospf3 number timers lsa-generate
Treelsa-generate
Introduced16.0.R1

Platforms

All

spf-wait
Synopsis Enter the spf-wait context
Context configure router string ospf3 number timers spf-wait
Treespf-wait
Introduced16.0.R1

Platforms

All

spf-max-wait number
Synopsis Maximum interval between consecutive SPF calculations
Contextconfigure router string ospf3 number timers spf-wait spf-max-wait number
Treespf-max-wait
Range10 to 120000
Unitsmilliseconds
Default10000
Introduced 16.0.R1

Platforms

All

unicast-import boolean
Synopsis Submit routes into the unicast Route Table Manager
Contextconfigure router string ospf3 number unicast-import boolean
Treeunicast-import
Defaulttrue
Introduced16.0.R1

Platforms

All

p2mp-sr-tree

Synopsis Enable the p2mp-sr-tree context
Contextconfigure router string p2mp-sr-tree
Treep2mp-sr-tree
Introduced21.5.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the P2MP SR tree
Contextconfigure router string p2mp-sr-tree admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced21.5.R1

Platforms

All

bfd-liveness keyword
Synopsis BFD tracking
Contextconfigure router string p2mp-sr-tree bfd-liveness keyword
Treebfd-liveness

Description

This command specifies the type of BFD tracking at the P2MP SR tree level, which means that all next hops of the replication segments that use a BFD-enabled Layer 3 interface register with the BFD module.

Optionsipv4, ipv6
Max. Instances 2
Introduced21.5.R1

Platforms

All

p2mp-policy [p2mp-policy-name] string
Synopsis Enter the p2mp-policy list instance
Contextconfigure router string p2mp-sr-tree p2mp-policy string
Treep2mp-policy
Introduced21.5.R1

Platforms

All

[p2mp-policy-name] string
Synopsis P2MP policy name
Context configure router string p2mp-sr-tree p2mp-policy string
Treep2mp-policy
String Length1 to 32

Notes

This element is part of a list key.

Introduced21.5.R1

Platforms

All

candidate-path [candidate-path-name] string
Synopsis Enter the candidate-path list instance
Contextconfigure router string p2mp-sr-tree p2mp-policy string candidate-path string
Treecandidate-path

Description

Commands in this context configure a candidate path in the P2MP policy entry for the P2MP SR tree.

A P2MP SR policy can contain multiple candidate paths, which are redundant trees. Each candidate path represents a P2MP SR tree with its own traffic engineering constraints. Each candidate path has its own preference and the candidate path with the highest preference is the active P2MP SR tunnel.

Introduced21.5.R1

Platforms

All

path-instances [index] number
Synopsis Enter the path-instances list instance
Contextconfigure router string p2mp-sr-tree p2mp-policy string candidate-path string path-instances number
Treepath-instances

Description

Commands in this context configure the instance entries of the candidate path as primary or secondary.

Multiple path instances can exist in a candidate path for the P2MP SR tree. Each path instance is a P2MP LSP and has an instance ID. Path instances can be used for global optimization of the active candidate path.

Introduced21.5.R1

Platforms

All

preference number
Synopsis Candidate path preference
Context configure router string p2mp-sr-tree p2mp-policy string candidate-path string preference number
Treepreference

Description

This command configures the candidate path preference for the P2MP SR tree. The candidate path with the highest preference is the active candidate path.

Range0 to 1024
Default100
Introduced 21.5.R1

Platforms

All

root-address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Root node address for the P2MP policy
Contextconfigure router string p2mp-sr-tree p2mp-policy string root-address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeroot-address
Default0.0.0.0
Introduced21.5.R1

Platforms

All

tree-id number
Synopsis Tree ID for the P2MP policy
Context configure router string p2mp-sr-tree p2mp-policy string tree-id number
Treetree-id

Description

This command configures the P2MP SR tree ID on the root node of the P2MP policy.

The root tree ID and the root address uniquely identify the P2MP policy on the root node.

Range0 | 8193 to 16286
Default0
Introduced 21.5.R1

Platforms

All

replication-segment [policy-name] string
Synopsis Enter the replication-segment list instance
Contextconfigure router string p2mp-sr-tree replication-segment string
Treereplication-segment
Introduced21.5.R1

Platforms

All

segment-routing-mpls
Synopsis Enter the segment-routing-mpls context
Contextconfigure router string p2mp-sr-tree replication-segment string segment-routing-mpls
Treesegment-routing-mpls

Description

Commands in this context configure the SR-MPLS options for the P2MP tree.

Introduced24.3.R1

Platforms

All

downstream-nodes [downstream-index] number
Synopsis Enter the downstream-nodes list instance
Contextconfigure router string p2mp-sr-tree replication-segment string segment-routing-mpls downstream-nodes number
Treedownstream-nodes
Introduced24.3.R1

Platforms

All

label
Synopsis Enter the label context
Context configure router string p2mp-sr-tree replication-segment string segment-routing-mpls downstream-nodes number label
Treelabel

Description

Commands in this context configure the segment identifiers for the downstream node in the replication segment.

Introduced24.3.R1

Platforms

All

sid-list [index] number
Synopsis Enter the sid-list list instance
Contextconfigure router string p2mp-sr-tree replication-segment string segment-routing-mpls downstream-nodes number label sid-list number
Treesid-list
Introduced24.3.R1

Platforms

All

pcep

Synopsis Enter the pcep context
Context configure router string pcep
Treepcep
Introduced16.0.R4

Platforms

All

pcc
Synopsis Enable the pcc context
Context configure router string pcep pcc
Treepcc
Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the PCEP session element
Contextconfigure router string pcep pcc admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

All

dead-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure dead timer
Contextconfigure router string pcep pcc dead-timer number
Treedead-timer
Range1 to 255
Unitsseconds
Default 120
Introduced16.0.R4

Platforms

All

keepalive number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure keepalive
Contextconfigure router string pcep pcc keepalive number
Treekeepalive
Range1 to 255
Unitsseconds
Default 30
Introduced16.0.R4

Platforms

All

local-address string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal IPv4 address of the PCEP speaker
Contextconfigure router string pcep pcc local-address string
Treelocal-address

Description

This command configures the local IPv4 address of the PCEP speaker.

See "PCEP session establishment and maintenance" in the 7750 SR and 7950 XRS Segment Routing and PCE User Guide for more information about configuring a PCEP local IPv4 address to establish a PCEP session.

Introduced16.0.R4

Platforms

All

local-address-ipv6 string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal IPv6 address of the PCEP speaker
Contextconfigure router string pcep pcc local-address-ipv6 string
Treelocal-address-ipv6

Description

This command configures the local IPv6 address of the PCEP speaker.

See "PCEP session establishment and maintenance" in the 7750 SR and 7950 XRS Segment Routing and PCE User Guide for more information about configuring a PCEP local IPv6 address to establish a PCEP session.

Introduced20.2.R1

Platforms

All

max-srte-pce-init-lsps number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure max sr te pce init LSP
Contextconfigure router string pcep pcc max-srte-pce-init-lsps number
Treemax-srte-pce-init-lsps
Range0 to 8191
Default8191
Introduced 16.0.R5

Platforms

All

pce-associations
Synopsis Enter the pce-associations context
Contextconfigure router string pcep pcc pce-associations
Treepce-associations

Description

Commands in this context configure PCE association groups.

Introduced22.5.R1

Platforms

All

diversity [assoc-name] string
Synopsis Enter the diversity list instance
Contextconfigure router string pcep pcc pce-associations diversity string
Treediversity

Description

Commands in this context create a named diversity association from which the parameters for the specified diversity association are configured.

Introduced22.5.R1

Platforms

All

[assoc-name] string
Synopsis Name of the association group
Context configure router string pcep pcc pce-associations diversity string
Treediversity
String Length1 to 32

Notes

This element is part of a list key.

Introduced22.5.R1

Platforms

All

association-id number
Synopsis Association ID for the diversity association group
Contextconfigure router string pcep pcc pce-associations diversity string association-id number
Treeassociation-id

Description

This command configures the diversity association ID. The user must specify an association ID.

Range0 to 65535
Default0
Introduced 22.5.R1

Platforms

All

disjointness-reference boolean
Synopsis Configure P-flag in the disjointness configuration TLV
Contextconfigure router string pcep pcc pce-associations diversity string disjointness-reference boolean
Treedisjointness-reference

Description

When configured to true, the router sets the P-flag in the disjointness configuration TLV. When the P-flag is set, it indicates that this LSP path is the reference path for the disjoint set of paths. The PCE must first compute the path of this LSP and then apply the requested disjointness type to compute the path of all other paths in the same diversity association ID.

When configured to false, the router does not set the P-flag in the disjointness configuration TLV.

Defaultfalse
Introduced22.5.R1

Platforms

All

diversity-type keyword
Synopsis Diversity type for the association group
Contextconfigure router string pcep pcc pce-associations diversity string diversity-type keyword
Treediversity-type

Description

This command configures the diversity type for the association group.

Optionsnone, link, node, srlg-link, srlg-node
Defaultnone
Introduced22.5.R1

Platforms

All

policy [assoc-name] string
Synopsis Enter the policy list instance
Contextconfigure router string pcep pcc pce-associations policy string
Treepolicy

Description

Commands in this context create a named policy association from which the parameters for the specified policy association are configured.

Introduced22.5.R1

Platforms

All

[assoc-name] string
Synopsis Name of the association group
Context configure router string pcep pcc pce-associations policy string
Treepolicy
String Length1 to 32

Notes

This element is part of a list key.

Introduced22.5.R1

Platforms

All

association-id number
Synopsis Association ID for the policy association group
Contextconfigure router string pcep pcc pce-associations policy string association-id number
Treeassociation-id

Description

This command configures the policy association ID. The user must specify an association ID.

Range0 to 65535
Default0
Introduced 22.5.R1

Platforms

All

association-source (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Source IP address for the association
Contextconfigure router string pcep pcc pce-associations policy string association-source (ipv4-address-no-zone | ipv6-address-no-zone)
Treeassociation-source

Description

This command configures the source IP address of the policy association.

Introduced22.5.R1

Platforms

All

peer [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the peer list instance
Context configure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer
Max. Instances2
Introduced16.0.R4

Platforms

All

[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Destination IP address of a PCE peer in a PCEP session
Contextconfigure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone)
Treepeer

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the PCC peer
Context configure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone) admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

All

preference number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisPreference value of the peer
Contextconfigure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone) preference number
Treepreference
Range0 to 100
Default0
Introduced 16.0.R4

Platforms

All

route-preference keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisRoute preference to reach the PCE server
Contextconfigure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone) route-preference keyword
Treeroute-preference

Description

This command specifies the routing preference to reach the PCE server. If the configured option is to use both in-band and out-of-band routes, the out-of-band routes in the management routing instance are used to reach the PCE server before the in-band routes in the Base routing instance.

Optionsinband, outband, both
Defaultboth
Introduced21.10.R1

Platforms

All

tls-client-profile reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTLS client profile name assigned to this PCC peer
Contextconfigure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone) tls-client-profile reference
Treetls-client-profile

Reference

configure system security tls client-tls-profile string

Introduced21.10.R1

Platforms

All

tls-wait-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTime the PCC waits until declaring handshake failure
Contextconfigure router string pcep pcc peer (ipv4-address-no-zone | ipv6-address-no-zone) tls-wait-timer number
Treetls-wait-timer
Range60 to 255
Unitsseconds
Default 60
Introduced21.10.R1

Platforms

All

state-timer
Synopsis Enter the state-timer context
Context configure router string pcep pcc state-timer
Treestate-timer
Introduced16.0.R4

Platforms

All

timer number
Synopsis Configure state-timer
Context configure router string pcep pcc state-timer timer number
Treetimer
Range1 to 3600
Unitsseconds
Default 180
Introduced16.0.R4

Platforms

All

pce
Synopsis Enable the pce context
Context configure router string pcep pce
Treepce
Introduced16.0.R4

Platforms

VSR-NRC

admin-state keyword
Synopsis Administrative state of the PCEP session element
Contextconfigure router string pcep pce admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

VSR-NRC

dead-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure dead timer
Contextconfigure router string pcep pce dead-timer number
Treedead-timer
Range1 to 255
Unitsseconds
Default 120
Introduced16.0.R4

Platforms

VSR-NRC

keepalive number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure keepalive
Contextconfigure router string pcep pce keepalive number
Treekeepalive
Range1 to 255
Unitsseconds
Default 30
Introduced16.0.R4

Platforms

VSR-NRC

local-address string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal IPv4 address of the PCEP speaker
Contextconfigure router string pcep pce local-address string
Treelocal-address

Description

This command configures the local IPv4 address of the PCEP speaker.

See "PCEP session establishment and maintenance" in the 7750 SR and 7950 XRS Segment Routing and PCE User Guide for more information about configuring a PCEP local IPv4 address to establish a PCEP session.

Introduced16.0.R4

Platforms

VSR-NRC

local-address-ipv6 string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLocal IPv6 address of the PCEP speaker
Contextconfigure router string pcep pce local-address-ipv6 string
Treelocal-address-ipv6

Description

This command configures the local IPv6 address of the PCEP speaker.

See "PCEP session establishment and maintenance" in the 7750 SR and 7950 XRS Segment Routing and PCE User Guide for more information about configuring a PCEP local IPv6 address to establish a PCEP session.

Introduced20.2.R1

Platforms

VSR-NRC

tls-wait-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure tls-wait-timer
Contextconfigure router string pcep pce tls-wait-timer number
Treetls-wait-timer
Range60 to 255
Unitsseconds
Default 60
Introduced21.10.R1

Platforms

VSR-NRC

pcp

Synopsis Enter the pcp context
Context configure router string pcp
Treepcp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

server [name] string
Synopsis Enter the server list instance
Contextconfigure router string pcp server string
Treeserver
Max. Instances8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis PCP server name
Context configure router string pcp server string
Treeserver
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the PCP server
Contextconfigure router string pcp server string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string pcp server string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

fwd-inside-router string
Synopsis PCP forwarding inside virtual router instance
Contextconfigure router string pcp server string fwd-inside-router string
Treefwd-inside-router
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

interface [name] reference
Synopsis Add a list entry for interface
Contextconfigure router string pcp server string interface reference
Treeinterface
Max. Instances32
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

[name] reference
Synopsis Interface name
Contextconfigure router string pcp server string interface reference
Treeinterface

Reference

configure router string interface string

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

pim

Synopsis Enable the pim context
Context configure router string pim
Treepim
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of PIM
Context configure router string pim admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

apply-to keyword
Synopsis IES and non-IES interfaces to create in PIM
Contextconfigure router string pim apply-to keyword
Treeapply-to
Optionsies, non-ies, all, none
Default none
Introduced16.0.R1

Platforms

All

import
Synopsis Enter the import context
Context configure router string pim import
Treeimport
Introduced16.0.R1

Platforms

All

interface [interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string pim interface string
Treeinterface
Introduced16.0.R1

Platforms

All

[interface-name] string
Synopsis Router interface name
Context configure router string pim interface string
Treeinterface
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the PIM interface
Contextconfigure router string pim interface string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

assert-period number
Synopsis Time for periodic refreshes of PIM Assert messages on an interface
Contextconfigure router string pim interface string assert-period number
Treeassert-period
Range1 to 300
Default60
Introduced 16.0.R1

Platforms

All

bfd-liveness
Synopsis Enter the bfd-liveness context
Contextconfigure router string pim interface string bfd-liveness
Treebfd-liveness
Introduced16.0.R1

Platforms

All

ipv4 boolean
Synopsis Use Bidirectional Forwarding Detection for IPv4 on PIM interface
Contextconfigure router string pim interface string bfd-liveness ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6 boolean
Synopsis Use Bidirectional Forwarding Detection for IPv6 on PIM interface
Contextconfigure router string pim interface string bfd-liveness ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

All

bier-signaling-type
Synopsis Enter the bier-signaling-type context
Contextconfigure router string pim interface string bier-signaling-type
Treebier-signaling-type
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv4 boolean
Synopsis Enable PIM IPv4 signaling through a BIER domain
Contextconfigure router string pim interface string bier-signaling-type ipv4 boolean
Treeipv4
Defaultfalse
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv6 boolean
Synopsis Enable PIM IPv6 signaling through a BIER domain
Contextconfigure router string pim interface string bier-signaling-type ipv6 boolean
Treeipv6
Defaultfalse
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

hello-interval number
Synopsis Frequency at which PIM Hello messages are sent over this interface
Contextconfigure router string pim interface string hello-interval number
Treehello-interval
Range0 to 255
Default30
Introduced 16.0.R1

Platforms

All

instant-prune-echo boolean
Synopsis Allow PIM to send an instant prune echo when router starts the prune pending timer for PIM interface
Contextconfigure router string pim interface string instant-prune-echo boolean
Treeinstant-prune-echo
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string pim interface string ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

monitor-oper-group
Synopsis Enter the monitor-oper-group context
Contextconfigure router string pim interface string ipv4 monitor-oper-group
Treemonitor-oper-group
Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string pim interface string ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

monitor-oper-group
Synopsis Enter the monitor-oper-group context
Contextconfigure router string pim interface string ipv6 monitor-oper-group
Treemonitor-oper-group
Introduced16.0.R1

Platforms

All

max-groups number
Synopsis Maximum number of groups for the interface
Contextconfigure router string pim interface string max-groups number
Treemax-groups
Range0 | 1 to 16000
Default0
Introduced 16.0.R1

Platforms

All

mcac
Synopsis Enter the mcac context
Context configure router string pim interface string mcac
Treemcac
Introduced16.0.R1

Platforms

All

bandwidth
Synopsis Enter the bandwidth context
Context configure router string pim interface string mcac bandwidth
Treebandwidth
Introduced16.0.R1

Platforms

All

mandatory (number | keyword)
Synopsis Pre-reserved bandwidth for all mandatory channels
Contextconfigure router string pim interface string mcac bandwidth mandatory (number | keyword)
Treemandatory
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

All

total (number | keyword)
Synopsis Maximum allowed bandwidth
Context configure router string pim interface string mcac bandwidth total (number | keyword)
Treetotal
Range0 to 2147483647
Optionsunlimited
Defaultunlimited
Introduced16.0.R1

Platforms

All

mc-constraints
Synopsis Enter the mc-constraints context
Contextconfigure router string pim interface string mcac mc-constraints
Treemc-constraints
Introduced16.0.R1

Platforms

All

level [level-id] number
Synopsis Enter the level list instance
Context configure router string pim interface string mcac mc-constraints level number
Treelevel
Introduced16.0.R1

Platforms

All

[level-id] number
Synopsis Bandwidth level ID for an MCAC constraint
Contextconfigure router string pim interface string mcac mc-constraints level number
Treelevel
Range1 to 8

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

number-down [number-lag-port-down] number
Synopsis Enter the number-down list instance
Contextconfigure router string pim interface string mcac mc-constraints number-down number
Treenumber-down
Introduced16.0.R1

Platforms

All

level number
Synopsis Level ID to associate with number of down LAG ports
Contextconfigure router string pim interface string mcac mc-constraints number-down number level number
Treelevel

Description

This command specifies the bandwidth for a given level. Level 1 has the highest priority and level 8 has the lowest priority.

Range1 to 8

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

use-lag-port-weight boolean
Synopsis Use LAG port weight in calculating MCAC constraints
Contextconfigure router string pim interface string mcac mc-constraints use-lag-port-weight boolean
Treeuse-lag-port-weight

Description

When configured to true, port weight is used when determining available bandwidth per level when LAG ports go down or come up. This command is required for proper operation on mixed port-speed LAGs and can also be used for unmixed port-speed LAGs.

Defaultfalse
Introduced16.0.R1

Platforms

All

policy reference
Synopsis Multicast CAC policy name
Context configure router string pim interface string mcac policy reference
Treepolicy

Description

This command configures the name of the global channel bandwidth definition policy that is used for (H)MCAC and HQoS adjustment.

Within the scope of HQoS adjustment, the channel definition policy under the group interface is used if redirection is unconfigured. In this case, the HQoS adjustment can be applied to IPoE subscribers in per-SAP replication mode.

If redirection is configured, the channel bandwidth definition policy applied under the Layer 3 redirected interface is in effect.

Hierarchical MCAC (HMCAC) is supported on two levels simultaneously:

  • subscriber level and redirected interface when redirection is configured

  • subscriber level and group-interface level when redirection is unconfigured

In HMCAC, the subscriber is checked against its bandwidth limits first, then against the bandwidth limits of the redirected or group interface. If redirection is configured but the policy is referenced only under the group interface, no admission control is executed (HMCAC or MCAC).

Reference

configure mcac policy string

Introduced16.0.R1

Platforms

All

p2mp-ldp-tree-join
Synopsis Enter the p2mp-ldp-tree-join context
Contextconfigure router string pim interface string p2mp-ldp-tree-join
Treep2mp-ldp-tree-join
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv4 boolean
Synopsis Allow dynamic mLDP in-band signaling for IPv4 PIM joins
Contextconfigure router string pim interface string p2mp-ldp-tree-join ipv4 boolean
Treeipv4
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipv6 boolean
Synopsis Allow dynamic mLDP in-band signaling for IPv6 PIM joins
Contextconfigure router string pim interface string p2mp-ldp-tree-join ipv6 boolean
Treeipv6
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

priority number
Synopsis DR election priority for this interface
Contextconfigure router string pim interface string priority number
Treepriority
Range1 to 4294967295
Default1
Introduced 16.0.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string pim ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of PIM operation for IPv4
Contextconfigure router string pim ipv4 admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

gtm
Synopsis Enter the gtm context
Context configure router string pim ipv4 gtm
Treegtm
Introduced16.0.R1

Platforms

All

rpf-table keyword
Synopsis Route tables for RPF lookup
Context configure router string pim ipv4 rpf-table keyword
Treerpf-table
Optionsrtable-m, rtable-u, both
Defaultrtable-u
Introduced16.0.R1

Platforms

All

source-address
Synopsis Enter the source-address context
Contextconfigure router string pim ipv4 source-address
Treesource-address

Description

Commands in this context configure the source IP address for PIM messages.

Introduced23.3.R1

Platforms

All

register-message string
Synopsis Source IPv4 address for PIM register messages
Contextconfigure router string pim ipv4 source-address register-message string
Treeregister-message

Description

This command configures the source IPv4 address for register messages in this PIM instance. The IP address can be set to any unicast address, regardless of whether it resides on the node. Ensure that the specified IP address is configured on the router as a loopback or interface IP address.

When unconfigured, the source IP address for register messages is selected by choosing the smallest IP address from available interfaces on the node.

Introduced23.3.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string pim ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of PIM operation for IPv6
Contextconfigure router string pim ipv6 admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

rpf-table keyword
Synopsis Route tables for RPF lookup
Context configure router string pim ipv6 rpf-table keyword
Treerpf-table
Optionsrtable-m, rtable-u, both
Defaultrtable-u
Introduced16.0.R1

Platforms

All

source-address
Synopsis Enter the source-address context
Contextconfigure router string pim ipv6 source-address
Treesource-address

Description

Commands in this context configure the source IP address for PIM messages.

Introduced23.3.R1

Platforms

All

register-message string
Synopsis Source IPv6 address for PIM register messages
Contextconfigure router string pim ipv6 source-address register-message string
Treeregister-message

Description

This command configures the source IPv6 address for register messages in this PIM instance. The IP address can be set to any unicast address, regardless of whether it resides on the node. Ensure that the specified IP address is configured on the router as a loopback or interface IP address.

When unconfigured, the source IP address for register messages is selected by choosing the smallest IP address from available interfaces on the node.

Introduced23.3.R1

Platforms

All

mc-ecmp-balance boolean
Synopsis Enable multicast balancing of traffic over ECMP links
Contextconfigure router string pim mc-ecmp-balance boolean
Treemc-ecmp-balance
Defaulttrue
Introduced16.0.R1

Platforms

All

mc-ecmp-hashing
Synopsis Enable the mc-ecmp-hashing context
Contextconfigure router string pim mc-ecmp-hashing
Treemc-ecmp-hashing
Introduced16.0.R1

Platforms

All

rebalance boolean
Synopsis Rebalance flows to newly added links immediately instead of waiting until they are pruned
Contextconfigure router string pim mc-ecmp-hashing rebalance boolean
Treerebalance
Defaultfalse
Introduced16.0.R1

Platforms

All

mdt-spt boolean
Synopsis Use SPT switchover for default MDT
Context configure router string pim mdt-spt boolean
Treemdt-spt
Defaultfalse
Introduced16.0.R1

Platforms

All

pim-ssm-scaling boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable PIM-SSM scaling
Contextconfigure router string pim pim-ssm-scaling boolean
Treepim-ssm-scaling

Description

When configured to true, this command enables an increase of PIM SSM (S,G) scaling to a maximum of 256000 per system. The total maximum multicast capacity is, however, constrained by the lowest-performance FP.

When the maximum link capacity from the fabric to the lowest-performance FP is reached, the link to that FP is overloaded, resulting in packet loss for all FPs. This capacity constraint is independent of whether the lowest-performance FP has a receiver on it or not. If the multicast management chassis per-plane total capacity is configured to an explicit value larger than that supported by the lowest-performance FP, then IMPM believes that there is more plane capacity available than there actually is and the result is (S,G) packet loss instead of blackholing. By setting the multicast management chassis per-plane total capacity to dynamic, the system automatically sets the switch fabric multicast plane capacity to the minimum value supported by the fabric and all line cards in the system.

When PIM SSM scaling is enabled, the following multicast features are disabled:• DM• MoFRR• JP policy• SSM groups• InBand features (BIER and MLDP)• Extranet• ASM

When configured to false, there is no increase of PIM SSM (S,G) scaling.

Defaultfalse
Introduced19.7.R1

Platforms

All

rp
Synopsis Enter the rp context
Context configure router string pim rp
Treerp
Introduced16.0.R1

Platforms

All

bootstrap
Synopsis Enter the bootstrap context
Context configure router string pim rp bootstrap
Treebootstrap
Introduced16.0.R1

Platforms

All

ipv4
Synopsis Enter the ipv4 context
Context configure router string pim rp ipv4
Treeipv4
Introduced16.0.R1

Platforms

All

anycast [ipv4-address] string rp-set-peer string
Synopsis Add a list entry for anycast
Context configure router string pim rp ipv4 anycast string rp-set-peer string
Treeanycast
Introduced16.0.R1

Platforms

All

[ipv4-address] string
Synopsis Loopback IP address shared by routes in RP set
Contextconfigure router string pim rp ipv4 anycast string rp-set-peer string
Treeanycast

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

rp-set-peer string
Synopsis Configure a peer in the anycast rp-set.
Contextconfigure router string pim rp ipv4 anycast string rp-set-peer string
Treeanycast

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

auto-rp-discovery boolean
Synopsis Enable auto-RP discovery mode and auto-RP listener
Contextconfigure router string pim rp ipv4 auto-rp-discovery boolean
Treeauto-rp-discovery

Description

When configured to true, the system enables the auto-RP protocol in discovery mode and the auto-RP listener functionality.

See "Automatic discovery of group-to-RP mappings (auto-RP)" in the 7450 ESS, 7750 SR, 7950 XRS, and VSR Multicast Routing Protocols Guide for more information about the auto-RP protocol and configuration guidelines.

Defaultfalse
Introduced16.0.R1

Platforms

All

bsr-candidate
Synopsis Enter the bsr-candidate context
Contextconfigure router string pim rp ipv4 bsr-candidate
Treebsr-candidate
Introduced16.0.R1

Platforms

All

candidate boolean
Synopsis Enable auto-RP to advertise candidate RP information
Contextconfigure router string pim rp ipv4 candidate boolean
Treecandidate

Description

When configured to true, the auto-RP is enabled to advertise the candidate RP information. The auto-RP candidate RP announces the candidate RP messages on the 224.0.1.39 multicast address. This functionality is in addition to the listener functionality enabled by the auto RP discovery.

When configured to false, the candidate RP information is not specified.

Defaultfalse
Introduced20.10.R1

Platforms

All

mapping-agent boolean
Synopsis Enable the mapping agent on the node
Context configure router string pim rp ipv4 mapping-agent boolean
Treemapping-agent

Description

When configured to true, the mapping agent is enabled on the node. The auto-RP MA observes the auto-rp-announcement messages, selects the RP and generates the RP discovery 224.0.1.40 messages. This functionality is in addition to the auto-RP discovery functionality.

Defaultfalse
Introduced20.10.R1

Platforms

All

rp-candidate
Synopsis Enter the rp-candidate context
Contextconfigure router string pim rp ipv4 rp-candidate
Treerp-candidate
Introduced16.0.R1

Platforms

All

address string
Synopsis Local RP address
Context configure router string pim rp ipv4 rp-candidate address string
Treeaddress

Description

This command specifies the local RP address that is sent in the RP candidate advertisements to the Bootstrap Router.

Introduced16.0.R1

Platforms

All

holdtime number
Synopsis Time during which the neighboring router considers this router to be up
Contextconfigure router string pim rp ipv4 rp-candidate holdtime number
Treeholdtime
Range5 to 255
Unitsseconds
Default 150
Introduced16.0.R1

Platforms

All

static
Synopsis Enter the static context
Context configure router string pim rp ipv4 static
Treestatic
Introduced16.0.R1

Platforms

All

address [ipv4-address] string
Synopsis Enter the address list instance
Contextconfigure router string pim rp ipv4 static address string
Treeaddress
Introduced16.0.R1

Platforms

All

[ipv4-address] string
Synopsis IPv4 address for the static RP
Context configure router string pim rp ipv4 static address string
Treeaddress

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

override boolean
Synopsis Change the precedence for static RP over dynamically learnt RP
Contextconfigure router string pim rp ipv4 static address string override boolean
Treeoverride
Defaultfalse
Introduced16.0.R1

Platforms

All

ipv6
Synopsis Enter the ipv6 context
Context configure router string pim rp ipv6
Treeipv6
Introduced16.0.R1

Platforms

All

anycast [ipv6-address] string rp-set-peer string
Synopsis Add a list entry for anycast
Context configure router string pim rp ipv6 anycast string rp-set-peer string
Treeanycast
Introduced16.0.R1

Platforms

All

[ipv6-address] string
Synopsis Loopback IP address shared by routes in RP set
Contextconfigure router string pim rp ipv6 anycast string rp-set-peer string
Treeanycast

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

rp-set-peer string
Synopsis Peer in the anycast RP set
Context configure router string pim rp ipv6 anycast string rp-set-peer string
Treeanycast

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

bsr-candidate
Synopsis Enter the bsr-candidate context
Contextconfigure router string pim rp ipv6 bsr-candidate
Treebsr-candidate
Introduced16.0.R1

Platforms

All

embedded-rp
Synopsis Enable the embedded-rp context
Contextconfigure router string pim rp ipv6 embedded-rp
Treeembedded-rp
Introduced16.0.R1

Platforms

All

rp-candidate
Synopsis Enter the rp-candidate context
Contextconfigure router string pim rp ipv6 rp-candidate
Treerp-candidate
Introduced16.0.R1

Platforms

All

holdtime number
Synopsis Time during which the neighboring router considers this router to be up
Contextconfigure router string pim rp ipv6 rp-candidate holdtime number
Treeholdtime
Range5 to 255
Unitsseconds
Default 150
Introduced16.0.R1

Platforms

All

static
Synopsis Enter the static context
Context configure router string pim rp ipv6 static
Treestatic
Introduced16.0.R1

Platforms

All

address [ipv6-address] string
Synopsis Enter the address list instance
Contextconfigure router string pim rp ipv6 static address string
Treeaddress
Introduced16.0.R1

Platforms

All

[ipv6-address] string
Synopsis Static IP address of the RP
Context configure router string pim rp ipv6 static address string
Treeaddress

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

override boolean
Synopsis Change the precedence for static RP over dynamically learnt RP
Contextconfigure router string pim rp ipv6 static address string override boolean
Treeoverride
Defaultfalse
Introduced16.0.R1

Platforms

All

rpfv
Synopsis Enter the rpfv context
Context configure router string pim rpfv
Treerpfv
Introduced16.0.R1

Platforms

All

core boolean
Synopsis Include proxy RPF vector for core
Context configure router string pim rpfv core boolean
Treecore
Defaultfalse
Introduced16.0.R1

Platforms

All

mvpn boolean
Synopsis Include proxy RPF vector for Inter-AS Rosen MVPN
Contextconfigure router string pim rpfv mvpn boolean
Treemvpn
Defaultfalse
Introduced16.0.R1

Platforms

All

spt-switchover [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the spt-switchover list instance
Contextconfigure router string pim spt-switchover (ipv4-prefix | ipv6-prefix)
Treespt-switchover
Introduced16.0.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP address and mask length
Context configure router string pim spt-switchover (ipv4-prefix | ipv6-prefix)
Treespt-switchover

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

threshold (number | keyword)
Synopsis SPT switchover threshold
Context configure router string pim spt-switchover (ipv4-prefix | ipv6-prefix) threshold (number | keyword)
Treethreshold
Range1 to 4294967294
Unitskilobps
Options infinity

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

ssm-groups
Synopsis Enter the ssm-groups context
Context configure router string pim ssm-groups
Treessm-groups
Introduced16.0.R1

Platforms

All

group-range [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Add a list entry for group-range
Contextconfigure router string pim ssm-groups group-range (ipv4-prefix | ipv6-prefix)
Treegroup-range
Introduced16.0.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP address and mask length
Context configure router string pim ssm-groups group-range (ipv4-prefix | ipv6-prefix)
Treegroup-range

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

radius

Synopsis Enter the radius context
Context configure router string radius
Treeradius
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

proxy [name] string
Synopsis Enter the proxy list instance
Context configure router string radius proxy string
Treeproxy
Max. Instances8
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis RADIUS proxy name
Context configure router string radius proxy string
Treeproxy
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of RADIUS proxy
Context configure router string radius proxy string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-matching
Synopsis Enter the attribute-matching context
Contextconfigure router string radius proxy string attribute-matching
Treeattribute-matching
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

entry [index] number
Synopsis Enter the entry list instance
Context configure router string radius proxy string attribute-matching entry number
Treeentry
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[index] number
Synopsis Index of this entry
Context configure router string radius proxy string attribute-matching entry number
Treeentry
Range1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

type number
Synopsis Matching attribute type to RADIUS server policy
Contextconfigure router string radius proxy string attribute-matching type number
Treetype
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis Matching Vendor ID to RADIUS server policy
Contextconfigure router string radius proxy string attribute-matching vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

cache
Synopsis Enter the cache context
Context configure router string radius proxy string cache
Treecache
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the RADIUS proxy cache
Contextconfigure router string radius proxy string cache admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

key
Synopsis Enable the key context
Context configure router string radius proxy string cache key
Treekey
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-type number
Synopsis RADIUS attribute type to cache for this RADIUS proxy server
Contextconfigure router string radius proxy string cache key attribute-type number
Treeattribute-type
Range1 to 255

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

packet-type keyword
Synopsis Packet type of the RADIUS messages
Context configure router string radius proxy string cache key packet-type keyword
Treepacket-type
Optionsaccess-request, access-accept

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis RADIUS Vendor ID
Context configure router string radius proxy string cache key vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

timeout number
Synopsis Idle timeout value
Context configure router string radius proxy string cache timeout number
Treetimeout
Range60 to 3600
Unitsseconds
Default 300
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

track-accounting
Synopsis Enter the track-accounting context
Contextconfigure router string radius proxy string cache track-accounting
Treetrack-accounting
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

start boolean
Synopsis Update host with client that generated accounting-start
Contextconfigure router string radius proxy string cache track-accounting start boolean
Treestart
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

stop boolean
Synopsis Remove ESM host and forward accounting-stop packet
Contextconfigure router string radius proxy string cache track-accounting stop boolean
Treestop
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

track-authentication
Synopsis Enter the track-authentication context
Contextconfigure router string radius proxy string cache track-authentication
Treetrack-authentication
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

defaults
Synopsis Enter the defaults context
Context configure router string radius proxy string defaults
Treedefaults
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string radius proxy string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

interface [interface-name] string
Synopsis Add a list entry for interface
Contextconfigure router string radius proxy string interface string
Treeinterface
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[interface-name] string
Synopsis IP interface name
Context configure router string radius proxy string interface string
Treeinterface
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

load-balance-key
Synopsis Enter the load-balance-key context
Contextconfigure router string radius proxy string load-balance-key
Treeload-balance-key
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-1
Synopsis Enter the attribute-1 context
Context configure router string radius proxy string load-balance-key attribute-1
Treeattribute-1

Notes

The following elements are part of a choice: (attribute-1, attribute-2, attribute-3, attribute-4, and attribute-5) or source-ip-udp.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

type number
Synopsis Attribute type to cache for this RADIUS Proxy server
Contextconfigure router string radius proxy string load-balance-key attribute-1 type number
Treetype
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis Vendor-Id attribute
Context configure router string radius proxy string load-balance-key attribute-1 vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-2
Synopsis Enter the attribute-2 context
Context configure router string radius proxy string load-balance-key attribute-2
Treeattribute-2

Notes

The following elements are part of a choice: (attribute-1, attribute-2, attribute-3, attribute-4, and attribute-5) or source-ip-udp.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

type number
Synopsis Attribute type to cache for this RADIUS Proxy server
Contextconfigure router string radius proxy string load-balance-key attribute-2 type number
Treetype
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis Vendor-Id attribute
Context configure router string radius proxy string load-balance-key attribute-2 vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-3
Synopsis Enter the attribute-3 context
Context configure router string radius proxy string load-balance-key attribute-3
Treeattribute-3

Notes

The following elements are part of a choice: (attribute-1, attribute-2, attribute-3, attribute-4, and attribute-5) or source-ip-udp.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

type number
Synopsis Attribute type to cache for this RADIUS Proxy server
Contextconfigure router string radius proxy string load-balance-key attribute-3 type number
Treetype
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis Vendor-Id attribute
Context configure router string radius proxy string load-balance-key attribute-3 vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-4
Synopsis Enter the attribute-4 context
Context configure router string radius proxy string load-balance-key attribute-4
Treeattribute-4

Notes

The following elements are part of a choice: (attribute-1, attribute-2, attribute-3, attribute-4, and attribute-5) or source-ip-udp.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

type number
Synopsis Attribute type to cache for this RADIUS Proxy server
Contextconfigure router string radius proxy string load-balance-key attribute-4 type number
Treetype
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis Vendor-Id attribute
Context configure router string radius proxy string load-balance-key attribute-4 vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

attribute-5
Synopsis Enter the attribute-5 context
Context configure router string radius proxy string load-balance-key attribute-5
Treeattribute-5

Notes

The following elements are part of a choice: (attribute-1, attribute-2, attribute-3, attribute-4, and attribute-5) or source-ip-udp.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

type number
Synopsis Attribute type to cache for this RADIUS Proxy server
Contextconfigure router string radius proxy string load-balance-key attribute-5 type number
Treetype
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

vendor (number | keyword)
Synopsis Vendor-Id attribute
Context configure router string radius proxy string load-balance-key attribute-5 vendor (number | keyword)
Treevendor
Range1 to 16777215
Optionsnokia
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

source-ip-udp
Synopsis Key to consist of the source IP address and source UDP port of the RADIUS message
Contextconfigure router string radius proxy string load-balance-key source-ip-udp
Treesource-ip-udp

Notes

The following elements are part of a choice: (attribute-1, attribute-2, attribute-3, attribute-4, and attribute-5) or source-ip-udp.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

purpose keyword
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisPurpose of the RADIUS proxy
Contextconfigure router string radius proxy string purpose keyword
Treepurpose
Optionsaccounting, authentication, accounting-authentication

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

secret string
Synopsis Format of the secret key to access the RADIUS proxy server
Contextconfigure router string radius proxy string secret string
Treesecret
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

wlan-gw
Synopsis Enter the wlan-gw context
Context configure router string radius proxy string wlan-gw
Treewlan-gw
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

address string
Synopsis IPv4 address of the distributed RADIUS proxy server
Contextconfigure router string radius proxy string wlan-gw address string
Treeaddress

Description

This command configures the IPv4 address of the distributed RADIUS proxy server for use by the access points.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

ipv6-address string
Synopsis IPv6 address of the distributed RADIUS proxy server
Contextconfigure router string radius proxy string wlan-gw ipv6-address string
Treeipv6-address

Description

This command configures the IPv6 address of the distributed RADIUS proxy server for use by the access points.

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

wlan-gw-group reference
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisISA WLAN gateway group
Contextconfigure router string radius proxy string wlan-gw-group reference
Treewlan-gw-group

Reference

configure isa wlan-gw-group number

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

server [name] string
Synopsis Enter the server list instance
Contextconfigure router string radius server string
Treeserver
Max. Instances64
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis External RADIUS server name
Context configure router string radius server string
Treeserver
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

accept-coa boolean
Synopsis Process Change of Authorization (CoA) messages
Contextconfigure router string radius server string accept-coa boolean
Treeaccept-coa
Defaultfalse
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

acct-port number
Synopsis UDP port number of the RADIUS for accounting events
Contextconfigure router string radius server string acct-port number
Treeacct-port
Range1 to 65535
Default1813
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the RADIUS server
Context configure router string radius server string address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeaddress

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

auth-port number
Synopsis UDP port number of the RADIUS to be used as match criteria
Contextconfigure router string radius server string auth-port number
Treeauth-port
Range1 to 65535
Default1812
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

description string
Synopsis Text description
Context configure router string radius server string description string
Treedescription
String Length1 to 80
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

secret string
Synopsis Secret key associated with this RADIUS server
Contextconfigure router string radius server string secret string
Treesecret
String Length1 to 115

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

reassembly

Synopsis Enable the reassembly context
Context configure router string reassembly
Treereassembly
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

nat-group number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisNAT group (including WLAN Gateway group) that executes the reassembly
Contextconfigure router string reassembly nat-group number
Treenat-group
Max. Range0 to 4294967295
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

to-base-network boolean
Synopsis Allow reassembled traffic sent to network interface
Contextconfigure router string reassembly to-base-network boolean
Treeto-base-network
Defaultfalse
Introduced19.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-e, 7750 SR-s, VSR

rib-api

Synopsis Enter the rib-api context
Context configure router string rib-api
Treerib-api
Introduced16.0.R4

Platforms

All

mpls
Synopsis Enter the mpls context
Context configure router string rib-api mpls
Treempls
Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of MPLS for RIB-API gRPC service
Contextconfigure router string rib-api mpls admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

All

label-name reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisConfigure reserved label block.
Contextconfigure router string rib-api mpls label-name reference
Treelabel-name

Reference

configure router string mpls-labels reserved-label-block string

Introduced16.0.R4

Platforms

All

rip

Synopsis Enable the rip context
Context configure router string rip
Treerip
Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the RIP instance
Contextconfigure router string rip admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

authentication-key string
Synopsis Authentication password passed between RIP neighbors
Contextconfigure router string rip authentication-key string
Treeauthentication-key

Description

This command sets the authentication password to be passed between RIP neighbors. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The authentication type and authentication key must match exactly for the RIP message to be considered authentic and processed.

When unconfigured, this command removes the authentication password from the configuration and disables authentication.

String Length1 to 51
Introduced16.0.R4

Platforms

All

authentication-type keyword
Synopsis Authentication type used between RIP neighbors
Contextconfigure router string rip authentication-type keyword
Treeauthentication-type

Description

This command sets the type of authentication to be used between RIP neighbors.

The authentication type and authentication key must match exactly for the RIP message to be considered authentic and processed.

When unconfigured, this command removes the authentication type from the configuration and effectively disables authentication.

Optionsnone, password, md5, md20
Default none
Introduced16.0.R4

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD to control the state of protocol adjacency
Contextconfigure router string rip bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables BFD to control the state of the associated protocol adjacency.

When configured to false, this command removes BFD from the associated protocol adjacency.

Defaultfalse
Introduced16.0.R4

Platforms

All

check-zero boolean
Synopsis Enable checking of mandatory zero fields
Contextconfigure router string rip check-zero boolean
Treecheck-zero

Description

When configured to true, this command enables checking of the mandatory zero fields in the RIPv1 and RIPv2 specifications and rejecting non-compliant RIP messages.

When configured to false, this command disables the check and allows the receipt of RIP messages even if the mandatory zero fields are non-zero.

Defaultfalse
Introduced16.0.R4

Platforms

All

description string
Synopsis Text description
Context configure router string rip description string
Treedescription
String Length1 to 80
Introduced16.0.R4

Platforms

All

export-limit
Synopsis Enable the export-limit context
Contextconfigure router string rip export-limit
Treeexport-limit
Introduced16.0.R4

Platforms

All

number number
Synopsis Maximum routes or prefixes exported from route table
Contextconfigure router string rip export-limit number number
Treenumber
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R4

Platforms

All

group [group-name] string
Synopsis Enter the group list instance
Context configure router string rip group string
Treegroup
Introduced16.0.R4

Platforms

All

[group-name] string
Synopsis RIP group name
Contextconfigure router string rip group string
Treegroup
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of RIP neighbor interface group
Contextconfigure router string rip group string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

authentication-key string
Synopsis Authentication password passed between RIP neighbors
Contextconfigure router string rip group string authentication-key string
Treeauthentication-key

Description

This command sets the authentication password to be passed between RIP neighbors. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The authentication type and authentication key must match exactly for the RIP message to be considered authentic and processed.

When unconfigured, the authentication password is removed from the configuration and authentication is disabled.

String Length1 to 51
Introduced16.0.R4

Platforms

All

authentication-type keyword
Synopsis Authentication type
Context configure router string rip group string authentication-type keyword
Treeauthentication-type

Description

This command configures the type of authentication to be used.

The authentication type and authentication key must match exactly for the RIP message to be considered authentic and processed.

When unconfigured, this command removes the authentication type from the configuration and effectively disables authentication.

Optionsnone, password, md5, md20
Introduced 16.0.R4

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD to control the state of protocol adjacency
Contextconfigure router string rip group string bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables BFD to control the state of the associated protocol adjacency.

When configured to false, this command removes BFD from the associated protocol adjacency.

Introduced16.0.R4

Platforms

All

check-zero boolean
Synopsis Enable checking of mandatory zero fields
Contextconfigure router string rip group string check-zero boolean
Treecheck-zero

Description

When configured to true, this command enables checking of the mandatory zero fields in the RIPv1 and RIPv2 specifications and rejecting non-compliant RIP messages.

When configured to false, this command disables the check and allows the receipt of RIP messages even if the mandatory zero fields are non-zero.

Introduced16.0.R4

Platforms

All

description string
Synopsis Text description
Context configure router string rip group string description string
Treedescription
String Length1 to 80
Introduced16.0.R4

Platforms

All

export-policy reference
Synopsis Policies used to rule which routes are exported to RIP
Contextconfigure router string rip group string export-policy reference
Treeexport-policy

Description

This command specifies the export route policies used to determine which routes are exported to RIP.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

import-policy reference
Synopsis Policies to decide routes accepted from RIP neighbors
Contextconfigure router string rip group string import-policy reference
Treeimport-policy

Description

This command configures import route policies to determine which routes are accepted from RIP neighbors.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

message-size number
Synopsis Maximum number of routes per RIP update message
Contextconfigure router string rip group string message-size number
Treemessage-size
Range25 to 255
Introduced16.0.R4

Platforms

All

metric-in number
Synopsis Metric added to routes received from a RIP neighbor
Contextconfigure router string rip group string metric-in number
Treemetric-in
Range1 to 16
Introduced16.0.R4

Platforms

All

metric-out number
Synopsis Metric added to routes exported into RIP
Contextconfigure router string rip group string metric-out number
Treemetric-out
Range1 to 16
Introduced16.0.R4

Platforms

All

neighbor [interface-name] string
Synopsis Enter the neighbor list instance
Contextconfigure router string rip group string neighbor string
Treeneighbor
Introduced16.0.R4

Platforms

All

[interface-name] string
Synopsis Neighbor added through the interface to the RIP group
Contextconfigure router string rip group string neighbor string
Treeneighbor
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the RIP neighbor interface
Contextconfigure router string rip group string neighbor string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

authentication-key string
Synopsis Authentication password passed between RIP neighbors
Contextconfigure router string rip group string neighbor string authentication-key string
Treeauthentication-key

Description

This command sets the authentication password to be passed between RIP neighbors. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The authentication type and authentication key must match exactly for the RIP message to be considered authentic and processed.

When unconfigured, this command removes the authentication password from the configuration and disables authentication.

String Length1 to 51
Introduced16.0.R4

Platforms

All

authentication-type keyword
Synopsis Authentication type
Context configure router string rip group string neighbor string authentication-type keyword
Treeauthentication-type

Description

This command configures the type of authentication to be used.

The authentication type and authentication key must match exactly for the RIP message to be considered authentic and processed.

When unconfigured, this command removes the authentication type from the configuration and effectively disables authentication.

Optionsnone, password, md5, md20
Introduced 16.0.R4

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD to control the state of protocol adjacency
Contextconfigure router string rip group string neighbor string bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables BFD to control the state of the associated protocol adjacency.

When configured to false, this command removes BFD from the associated protocol adjacency.

Introduced16.0.R4

Platforms

All

check-zero boolean
Synopsis Enable checking of mandatory zero fields
Contextconfigure router string rip group string neighbor string check-zero boolean
Treecheck-zero

Description

When configured to true, this command enables checking of the mandatory zero fields in the RIPv1 and RIPv2 specifications and rejecting non-compliant RIP messages.

When configured to false, this command disables the check and allows the receipt of RIP messages even if the mandatory zero fields are non-zero.

Introduced16.0.R4

Platforms

All

export-policy reference
Synopsis Policies used to rule which routes are exported to RIP
Contextconfigure router string rip group string neighbor string export-policy reference
Treeexport-policy

Description

This command specifies the export route policies used to determine which routes are exported to RIP.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

import-policy reference
Synopsis Policies to decide routes accepted from RIP neighbors
Contextconfigure router string rip group string neighbor string import-policy reference
Treeimport-policy

Description

This command configures import route policies to determine which routes are accepted from RIP neighbors.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

metric-in number
Synopsis Metric added to routes received from a RIP neighbor
Contextconfigure router string rip group string neighbor string metric-in number
Treemetric-in
Range1 to 16
Introduced16.0.R4

Platforms

All

receive keyword
Synopsis Accepted version on received packets
Context configure router string rip group string neighbor string receive keyword
Treereceive
Optionsversion-1, version-2, both, none
Introduced 16.0.R4

Platforms

All

send keyword
Synopsis RIP version and method used to send RIP updates
Contextconfigure router string rip group string neighbor string send keyword
Treesend
Optionsnone, version-1, broadcast, multicast, unicast
Introduced16.0.R4

Platforms

All

split-horizon boolean
Synopsis Enable split horizon and poison reverse
Contextconfigure router string rip group string neighbor string split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split horizon with poison reverse. Split-horizon with poison reverse means that routes learned from a neighbor through a given interface are advertised in updates out of the same interface but with a metric of 16 (infinity).

When configured to false. this command enables split horizon without poison reverse. This allows the routes to be re-advertised on interfaces other than the interface that learned the route, with the advertised metric equaling an increment of the metric-in value.

Introduced16.0.R4

Platforms

All

timers
Synopsis Enable the timers context
Context configure router string rip group string neighbor string timers
Treetimers
Introduced16.0.R4

Platforms

All

flush number
Synopsis RIP flush timer
Context configure router string rip group string neighbor string timers flush number
Treeflush

Description

This command specifies the time a route is maintained in the RIP database after it has been declared invalid. When the timer expires, the route is flushed from the RIP database completely.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

timeout number
Synopsis RIP timeout timer
Context configure router string rip group string neighbor string timers timeout number
Treetimeout

Description

This command specifies the RIP timeout timer. If a route is not updated by the time the timer expires, the route is declared invalid, but the route is maintained in the RIP database.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

update number
Synopsis Timer that controls the frequency of updates
Contextconfigure router string rip group string neighbor string timers update number
Treeupdate
Range1 to 600
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

preference number
Synopsis Route preference
Context configure router string rip group string preference number
Treepreference
Range1 to 255
Introduced16.0.R4

Platforms

All

receive keyword
Synopsis Accepted version on received packets
Context configure router string rip group string receive keyword
Treereceive
Optionsversion-1, version-2, both, none
Introduced 16.0.R4

Platforms

All

send keyword
Synopsis RIP version and method used to send RIP updates
Contextconfigure router string rip group string send keyword
Treesend
Optionsnone, version-1, broadcast, multicast
Introduced 16.0.R4

Platforms

All

split-horizon boolean
Synopsis Enable split horizon and poison reverse
Contextconfigure router string rip group string split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split horizon with poison reverse. Split-horizon with poison reverse means that routes learned from a neighbor through a given interface are advertised in updates out of the same interface but with a metric of 16 (infinity).

When configured to false. this command enables split horizon without poison reverse. This allows the routes to be re-advertised on interfaces other than the interface that learned the route, with the advertised metric equaling an increment of the metric-in value.

Introduced16.0.R4

Platforms

All

timers
Synopsis Enable the timers context
Context configure router string rip group string timers
Treetimers
Introduced16.0.R4

Platforms

All

flush number
Synopsis RIP flush timer
Context configure router string rip group string timers flush number
Treeflush

Description

This command specifies the time a route is maintained in the RIP database after it has been declared invalid. When the timer expires, the route is flushed from the RIP database completely.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

timeout number
Synopsis RIP timeout timer
Context configure router string rip group string timers timeout number
Treetimeout

Description

This command specifies the RIP timeout timer. If a route is not updated by the time the timer expires, the route is declared invalid, but the route is maintained in the RIP database.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

update number
Synopsis Timer that controls the frequency of updates
Contextconfigure router string rip group string timers update number
Treeupdate
Range1 to 600
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

message-size number
Synopsis Maximum number of routes in the RIP message
Contextconfigure router string rip message-size number
Treemessage-size
Range25 to 255
Default25
Introduced 16.0.R4

Platforms

All

metric-in number
Synopsis Metric added to routes received from a RIP neighbor
Contextconfigure router string rip metric-in number
Treemetric-in
Range1 to 16
Default1
Introduced 16.0.R4

Platforms

All

metric-out number
Synopsis Metric added to routes exported into RIP
Contextconfigure router string rip metric-out number
Treemetric-out
Range1 to 16
Default1
Introduced 16.0.R4

Platforms

All

preference number
Synopsis Route preference
Context configure router string rip preference number
Treepreference
Range1 to 255
Default100
Introduced 16.0.R4

Platforms

All

receive keyword
Synopsis Accepted version on received packets
Context configure router string rip receive keyword
Treereceive
Optionsversion-1, version-2, both, none
Default both
Introduced16.0.R4

Platforms

All

send keyword
Synopsis RIP version and method used to send RIP updates
Contextconfigure router string rip send keyword
Treesend
Optionsnone, version-1, broadcast, multicast
Default broadcast
Introduced16.0.R4

Platforms

All

split-horizon boolean
Synopsis Enable split horizon and poison reverse
Contextconfigure router string rip split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split horizon with poison reverse. Split-horizon with poison reverse means that routes learned from a neighbor through a given interface are advertised in updates out of the same interface but with a metric of 16 (infinity).

When configured to false. this command enables split horizon without poison reverse. This allows the routes to be re-advertised on interfaces other than the interface that learned the route, with the advertised metric equaling an increment of the metric-in value.

Defaulttrue
Introduced16.0.R4

Platforms

All

timers
Synopsis Enable the timers context
Context configure router string rip timers
Treetimers
Introduced16.0.R4

Platforms

All

flush number
Synopsis RIP flush timer
Context configure router string rip timers flush number
Treeflush

Description

This command specifies the time a route is maintained in the RIP database after it has been declared invalid. When the timer expires, the route is flushed from the RIP database completely.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

timeout number
Synopsis RIP timeout timer
Context configure router string rip timers timeout number
Treetimeout

Description

This command specifies the RIP timeout timer. If a route is not updated by the time the timer expires, the route is declared invalid, but the route is maintained in the RIP database.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

update number
Synopsis Timer that controls the frequency of updates
Contextconfigure router string rip timers update number
Treeupdate
Range1 to 600
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

ripng

Synopsis Enable the ripng context
Context configure router string ripng
Treeripng
Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the RIPng instance
Contextconfigure router string ripng admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD to control the state of protocol adjacency
Contextconfigure router string ripng bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables BFD to control the state of the associated protocol adjacency.

When configured to false, this command removes BFD from the associated protocol adjacency.

Defaultfalse
Introduced16.0.R4

Platforms

All

check-zero boolean
Synopsis Enable checking of mandatory zero fields
Contextconfigure router string ripng check-zero boolean
Treecheck-zero

Description

When configured to true, this command enables checking of the mandatory zero fields in the RIPv1 and RIPv2 specifications and rejecting non-compliant RIP messages.

When configured to false, this command disables the check and allows the receipt of RIP messages even if the mandatory zero fields are non-zero.

Defaultfalse
Introduced16.0.R4

Platforms

All

description string
Synopsis Text description
Context configure router string ripng description string
Treedescription
String Length1 to 80
Introduced16.0.R4

Platforms

All

export-limit
Synopsis Enable the export-limit context
Contextconfigure router string ripng export-limit
Treeexport-limit
Introduced16.0.R4

Platforms

All

number number
Synopsis Maximum routes or prefixes exported from route table
Contextconfigure router string ripng export-limit number number
Treenumber
Range1 to 4294967295

Notes

This element is mandatory.

Introduced16.0.R4

Platforms

All

group [group-name] string
Synopsis Enter the group list instance
Context configure router string ripng group string
Treegroup
Introduced16.0.R4

Platforms

All

[group-name] string
Synopsis RIP group name
Contextconfigure router string ripng group string
Treegroup
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of RIPng neighbor interface group
Contextconfigure router string ripng group string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD to control the state of protocol adjacency
Contextconfigure router string ripng group string bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables BFD to control the state of the associated protocol adjacency.

When configured to false, this command removes BFD from the associated protocol adjacency.

Introduced16.0.R4

Platforms

All

check-zero boolean
Synopsis Enable checking of mandatory zero fields
Contextconfigure router string ripng group string check-zero boolean
Treecheck-zero

Description

When configured to true, this command enables checking of the mandatory zero fields in the RIPv1 and RIPv2 specifications and rejecting non-compliant RIP messages.

When configured to false, this command disables the check and allows the receipt of RIP messages even if the mandatory zero fields are non-zero.

Introduced16.0.R4

Platforms

All

export-policy reference
Synopsis Policies used to rule which routes are exported to RIP
Contextconfigure router string ripng group string export-policy reference
Treeexport-policy

Description

This command specifies the export route policies used to determine which routes are exported to RIP.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

import-policy reference
Synopsis Policies to decide routes accepted from RIP neighbors
Contextconfigure router string ripng group string import-policy reference
Treeimport-policy

Description

This command configures import route policies to determine which routes are accepted from RIP neighbors.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

message-size number
Synopsis Maximum number of routes in the message
Contextconfigure router string ripng group string message-size number
Treemessage-size
Range25 to 255
Introduced16.0.R4

Platforms

All

metric-in number
Synopsis Metric added to routes received from the neighbor
Contextconfigure router string ripng group string metric-in number
Treemetric-in
Range1 to 16
Introduced16.0.R4

Platforms

All

metric-out number
Synopsis Metric added to routes exported into RIPng
Contextconfigure router string ripng group string metric-out number
Treemetric-out
Range1 to 16
Introduced16.0.R4

Platforms

All

neighbor [interface-name] string
Synopsis Enter the neighbor list instance
Contextconfigure router string ripng group string neighbor string
Treeneighbor
Introduced16.0.R4

Platforms

All

[interface-name] string
Synopsis Neighbor added to the RIPng group through the interface
Contextconfigure router string ripng group string neighbor string
Treeneighbor
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

All

admin-state keyword
Synopsis Administrative state of the RIPng neighbor
Contextconfigure router string ripng group string neighbor string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R4

Platforms

All

bfd-liveness boolean
Synopsis Enable BFD to control the state of protocol adjacency
Contextconfigure router string ripng group string neighbor string bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables BFD to control the state of the associated protocol adjacency.

When configured to false, this command removes BFD from the associated protocol adjacency.

Introduced16.0.R4

Platforms

All

check-zero boolean
Synopsis Enable checking of mandatory zero fields
Contextconfigure router string ripng group string neighbor string check-zero boolean
Treecheck-zero

Description

When configured to true, this command enables checking of the mandatory zero fields in the RIPv1 and RIPv2 specifications and rejecting non-compliant RIP messages.

When configured to false, this command disables the check and allows the receipt of RIP messages even if the mandatory zero fields are non-zero.

Introduced16.0.R4

Platforms

All

export-policy reference
Synopsis Policies used to rule which routes are exported to RIP
Contextconfigure router string ripng group string neighbor string export-policy reference
Treeexport-policy

Description

This command specifies the export route policies used to determine which routes are exported to RIP.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

import-policy reference
Synopsis Policies to decide routes accepted from RIP neighbors
Contextconfigure router string ripng group string neighbor string import-policy reference
Treeimport-policy

Description

This command configures import route policies to determine which routes are accepted from RIP neighbors.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied.

Reference

configure policy-options policy-statement string

Max. Instances5

Notes

This element is ordered by the user.

Introduced16.0.R4

Platforms

All

metric-in number
Synopsis Metric added to routes received from the neighbor
Contextconfigure router string ripng group string neighbor string metric-in number
Treemetric-in
Range1 to 16
Introduced16.0.R4

Platforms

All

receive keyword
Synopsis Accepted version on received packets
Context configure router string ripng group string neighbor string receive keyword
Treereceive
Optionsnone, ripng
Introduced 16.0.R4

Platforms

All

send keyword
Synopsis RIPng version and method used to send RIPng updates
Contextconfigure router string ripng group string neighbor string send keyword
Treesend
Optionsnone, ripng, unicast
Introduced16.0.R4

Platforms

All

split-horizon boolean
Synopsis Enable split horizon and poison reverse
Contextconfigure router string ripng group string neighbor string split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split horizon with poison reverse. Split-horizon with poison reverse means that routes learned from a neighbor through a given interface are advertised in updates out of the same interface but with a metric of 16 (infinity).

When configured to false. this command enables split horizon without poison reverse. This allows the routes to be re-advertised on interfaces other than the interface that learned the route, with the advertised metric equaling an increment of the metric-in value.

Introduced16.0.R4

Platforms

All

timers
Synopsis Enable the timers context
Context configure router string ripng group string neighbor string timers
Treetimers
Introduced16.0.R4

Platforms

All

flush number
Synopsis RIP flush timer
Context configure router string ripng group string neighbor string timers flush number
Treeflush

Description

This command specifies the time a route is maintained in the RIP database after it has been declared invalid. When the timer expires, the route is flushed from the RIP database completely.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

timeout number
Synopsis RIP timeout timer
Context configure router string ripng group string neighbor string timers timeout number
Treetimeout

Description

This command specifies the RIP timeout timer. If a route is not updated by the time the timer expires, the route is declared invalid, but the route is maintained in the RIP database.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

update number
Synopsis Timer that controls the frequency of updates
Contextconfigure router string ripng group string neighbor string timers update number
Treeupdate
Range1 to 600
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

receive keyword
Synopsis Accepted version on received packets
Context configure router string ripng group string receive keyword
Treereceive
Optionsnone, ripng
Introduced 16.0.R4

Platforms

All

send keyword
Synopsis RIPng version and method used to send RIPng updates
Contextconfigure router string ripng group string send keyword
Treesend
Optionsnone, ripng
Introduced 16.0.R4

Platforms

All

split-horizon boolean
Synopsis Enable split horizon and poison reverse
Contextconfigure router string ripng group string split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split horizon with poison reverse. Split-horizon with poison reverse means that routes learned from a neighbor through a given interface are advertised in updates out of the same interface but with a metric of 16 (infinity).

When configured to false. this command enables split horizon without poison reverse. This allows the routes to be re-advertised on interfaces other than the interface that learned the route, with the advertised metric equaling an increment of the metric-in value.

Introduced16.0.R4

Platforms

All

timers
Synopsis Enable the timers context
Context configure router string ripng group string timers
Treetimers
Introduced16.0.R4

Platforms

All

flush number
Synopsis RIP flush timer
Context configure router string ripng group string timers flush number
Treeflush

Description

This command specifies the time a route is maintained in the RIP database after it has been declared invalid. When the timer expires, the route is flushed from the RIP database completely.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

timeout number
Synopsis RIP timeout timer
Context configure router string ripng group string timers timeout number
Treetimeout

Description

This command specifies the RIP timeout timer. If a route is not updated by the time the timer expires, the route is declared invalid, but the route is maintained in the RIP database.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

update number
Synopsis Timer that controls the frequency of updates
Contextconfigure router string ripng group string timers update number
Treeupdate
Range1 to 600
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

message-size number
Synopsis Maximum number of routes in the message
Contextconfigure router string ripng message-size number
Treemessage-size
Range25 to 255
Default25
Introduced 16.0.R4

Platforms

All

metric-in number
Synopsis Metric added to routes received from the neighbor
Contextconfigure router string ripng metric-in number
Treemetric-in
Range1 to 16
Default1
Introduced 16.0.R4

Platforms

All

metric-out number
Synopsis Metric added to routes exported into RIPng
Contextconfigure router string ripng metric-out number
Treemetric-out
Range1 to 16
Default1
Introduced 16.0.R4

Platforms

All

preference number
Synopsis Route preference
Context configure router string ripng preference number
Treepreference
Range1 to 255
Default100
Introduced 16.0.R4

Platforms

All

receive keyword
Synopsis Accepted version on received packets
Context configure router string ripng receive keyword
Treereceive
Optionsnone, ripng
Default ripng
Introduced16.0.R4

Platforms

All

send keyword
Synopsis RIPng version and method used to send RIPng updates
Contextconfigure router string ripng send keyword
Treesend
Optionsnone, ripng
Default ripng
Introduced16.0.R4

Platforms

All

split-horizon boolean
Synopsis Enable split horizon and poison reverse
Contextconfigure router string ripng split-horizon boolean
Treesplit-horizon

Description

When configured to true, this command enables the use of split horizon with poison reverse. Split-horizon with poison reverse means that routes learned from a neighbor through a given interface are advertised in updates out of the same interface but with a metric of 16 (infinity).

When configured to false, this command enables split horizon without poison reverse. This allows the routes to be re-advertised on interfaces other than the interface that learned the route, with the advertised metric equaling an increment of the metric-in value.

Defaulttrue
Introduced16.0.R4

Platforms

All

timers
Synopsis Enable the timers context
Context configure router string ripng timers
Treetimers
Introduced16.0.R4

Platforms

All

flush number
Synopsis RIP flush timer
Context configure router string ripng timers flush number
Treeflush

Description

This command specifies the time a route is maintained in the RIP database after it has been declared invalid. When the timer expires, the route is flushed from the RIP database completely.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

timeout number
Synopsis RIP timeout timer
Context configure router string ripng timers timeout number
Treetimeout

Description

This command specifies the RIP timeout timer. If a route is not updated by the time the timer expires, the route is declared invalid, but the route is maintained in the RIP database.

Range1 to 1200
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

update number
Synopsis Timer that controls the frequency of updates
Contextconfigure router string ripng timers update number
Treeupdate
Range1 to 600
Unitsseconds

Notes

This element is mandatory.

Introduced 16.0.R4

Platforms

All

router-id string

Synopsis Unique router ID for the router in the AS
Contextconfigure router string router-id string
Treerouter-id
Introduced16.0.R1

Platforms

All

rsvp

Synopsis Enable the rsvp context
Context configure router string rsvp
Treersvp
Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of RSVP
Context configure router string rsvp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

All

authentication-over-bypass boolean
Synopsis Enable MD5 authentication over bypass LSP of PLR and MP
Contextconfigure router string rsvp authentication-over-bypass boolean
Treeauthentication-over-bypass

Description

When configured to true, this command configures the MD5 authentication over the bypass LSP of all Point of Local Repairs (PLRs) and Merge Points (MPs) on the router. Only enable this command when the TE interfaces in the RSVP-TE network use the same MD5 authentication parameters.

When a Point of Local Repair (PLR) activates a bypass LSP towards a Merge Point (MP), by default, the INTEGRITY object corresponding to the bypass LSP interface is not added to a transmitted RSVP message except for packets of routed RSVP messages (Resv, Srefresh, and ACK), and only when the packet is intended for a bypass LSP endpoint (PLR or MP) that is a directly connected neighbor.

When this command is enabled, the INTEGRITY object of the interface corresponding to the bypass LSP is added to a transmitted RSVP message regardless of whether the bypass LSP endpoint (PLR or MP) is a directly connected RSVP neighbor. The INTEGRITY object is included with the following RSVP messages: Path, PathTear, PathErr, Resv, ResvTear, ResvErr, Srefresh, and ACK.

In all cases, an RSVP message received from a PLR or a MP (sender address in the SenderTemplate oe FilterSpec is different from an Extended Tunnel Id in a Session Object), and which includes the INTEGRITY object is authenticated against the bypass LSP interface. An RSVP message received from a PLR or MP without the INTEGRITY object is also accepted.

When configured to false, the router disables MD5 authentication over bypass LSP of the PLRs and MPs.

Defaultfalse
Introduced22.10.R1

Platforms

All

dbw-accounting
Synopsis Enable the dbw-accounting context
Contextconfigure router string rsvp dbw-accounting
Treedbw-accounting
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

down-threshold
Synopsis Enter the down-threshold context
Contextconfigure router string rsvp dbw-accounting down-threshold
Treedown-threshold
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

bw number
Synopsis Minimum difference in MRLB or MRB to trigger an update
Contextconfigure router string rsvp dbw-accounting down-threshold bw number
Treebw
Range0 to 1000000
Unitsmegabps
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

percent number
Synopsis Minimum difference in percent between dark bandwidth and sampled data rate, to trigger IGP-TE update
Contextconfigure router string rsvp dbw-accounting down-threshold percent number
Treepercent
Range0 to 100
Unitspercent
Default 0
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

up-threshold
Synopsis Enter the up-threshold context
Contextconfigure router string rsvp dbw-accounting up-threshold
Treeup-threshold
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

bw number
Synopsis Minimum difference in MRLB or MRB to trigger an update
Contextconfigure router string rsvp dbw-accounting up-threshold bw number
Treebw
Range0 to 1000000
Unitsmegabps
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

percent number
Synopsis Minimum difference in percent between dark bandwidth and sampled data rate, to trigger IGP-TE update
Contextconfigure router string rsvp dbw-accounting up-threshold percent number
Treepercent
Range0 to 100
Unitspercent
Default 0
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

diffserv-te
Synopsis Enable the diffserv-te context
Contextconfigure router string rsvp diffserv-te
Treediffserv-te
Introduced16.0.R1

Platforms

All

class-type-bw
Synopsis Enter the class-type-bw context
Contextconfigure router string rsvp diffserv-te class-type-bw
Treeclass-type-bw
Introduced16.0.R1

Platforms

All

ct0 number
Synopsis RSVP interface bandwidth percentage for class type 0
Contextconfigure router string rsvp diffserv-te class-type-bw ct0 number
Treect0
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct1 number
Synopsis RSVP interface bandwidth percentage for class type 1
Contextconfigure router string rsvp diffserv-te class-type-bw ct1 number
Treect1
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct2 number
Synopsis RSVP interface bandwidth percentage for class type 2
Contextconfigure router string rsvp diffserv-te class-type-bw ct2 number
Treect2
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct3 number
Synopsis RSVP interface bandwidth percentage for class type 3
Contextconfigure router string rsvp diffserv-te class-type-bw ct3 number
Treect3
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct4 number
Synopsis RSVP interface bandwidth percentage for class type 4
Contextconfigure router string rsvp diffserv-te class-type-bw ct4 number
Treect4
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct5 number
Synopsis RSVP interface bandwidth percentage for class type 5
Contextconfigure router string rsvp diffserv-te class-type-bw ct5 number
Treect5
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct6 number
Synopsis RSVP interface bandwidth percentage for class type 6
Contextconfigure router string rsvp diffserv-te class-type-bw ct6 number
Treect6
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

ct7 number
Synopsis RSVP interface bandwidth percentage for class type 7
Contextconfigure router string rsvp diffserv-te class-type-bw ct7 number
Treect7
Range0 to 100
Default0
Introduced 16.0.R1

Platforms

All

fc [fc-name] keyword
Synopsis Enter the fc list instance
Context configure router string rsvp diffserv-te fc keyword
Treefc
Introduced16.0.R1

Platforms

All

[fc-name] keyword
Synopsis Forwarding class for this mapping
Context configure router string rsvp diffserv-te fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

class-type number
Synopsis Diff-Serv Class Type (CT) for an LSP
Context configure router string rsvp diffserv-te fc keyword class-type number
Treeclass-type
Range0 to 7

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

te-class [te-class-number] number
Synopsis Enter the te-class list instance
Contextconfigure router string rsvp diffserv-te te-class number
Treete-class
Introduced16.0.R1

Platforms

All

[te-class-number] number
Synopsis TE class number
Context configure router string rsvp diffserv-te te-class number
Treete-class
Range0 to 7

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

class-type number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisClass type (CT) associated with the TE class
Contextconfigure router string rsvp diffserv-te te-class number class-type number
Treeclass-type
Range0 to 7

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

priority number
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisTE class priority
Contextconfigure router string rsvp diffserv-te te-class number priority number
Treepriority
Range0 to 7

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

graceful-restart
Synopsis Enter the graceful-restart context
Contextconfigure router string rsvp graceful-restart
Treegraceful-restart
Introduced16.0.R1

Platforms

All

max-recovery number
Synopsis Maximum time to wait before a graceful helper recovers the session
Contextconfigure router string rsvp graceful-restart max-recovery number
Treemax-recovery
Range1 to 1800
Unitsseconds
Default 300
Introduced16.0.R1

Platforms

All

max-restart number
Synopsis Maximum time that a graceful helper waits for session restart after the neighbor is considered down
Contextconfigure router string rsvp graceful-restart max-restart number
Treemax-restart
Range1 to 300
Unitsseconds
Default 120
Introduced16.0.R1

Platforms

All

graceful-shutdown boolean
Synopsis Initiate a graceful shutdown of all RSVP interfaces on the node
Contextconfigure router string rsvp graceful-shutdown boolean
Treegraceful-shutdown
Defaultfalse
Introduced16.0.R1

Platforms

All

implicit-null-label boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSignal the implicit null option for all RSVP LSPs
Contextconfigure router string rsvp implicit-null-label boolean
Treeimplicit-null-label
Defaultfalse
Introduced16.0.R1

Platforms

All

interface [interface-name] reference
Synopsis Enter the interface list instance
Contextconfigure router string rsvp interface reference
Treeinterface

Description

Commands in this context configure the attributes of the RSVP protocol support on an IP interface. RSVP commands are not executed on an IP interface if RSVP is not enabled.

The RSVP interface must be administratively disabled before it can be deleted. 

A corresponding MPLS interface must also be configured. The RSVP interface cannot be deleted without also deleting the MPLS interface.

Introduced16.0.R1

Platforms

All

[interface-name] reference
Synopsis Index for router RSVP interface
Context configure router string rsvp interface reference
Treeinterface

Reference

configure router string interface string

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of RSVP on the IP interface
Contextconfigure router string rsvp interface reference admin-state keyword
Treeadmin-state
Optionsenable, disable
Default enable
Introduced16.0.R1

Platforms

All

authentication-key string
Synopsis Authentication or hash key string
Context configure router string rsvp interface reference authentication-key string
Treeauthentication-key

Description

This command configures the authentication key for use between RSVP neighbors to authenticate RSVP messages. Authentication uses the MD5 message-based digest.

When enabled on an RSVP interface, authentication of RSVP messages operates in both directions of the interface. A router maintains a security association using one authentication key for each interface to an RSVP neighbor.

An RSVP neighbor transmits an authenticating digest of the RSVP message that is computed using the shared authentication key and a keyed-hash algorithm. The message digest is included in an INTEGRITY object, which also contains a flags field, a key identifier field, and a sequence number field. An RSVP neighbor uses the key together with the authentication algorithm to process received RSVP messages. The RSVP MD5 authentication complies to the procedures for RSVP message generation in RFC 2747, RSVP Cryptographic Authentication.

The MD5 implementation does not support the authentication challenge procedures in RFC 2747.

String Length1 to 51
Introduced16.0.R1

Platforms

All

class-type-bw
Synopsis Enable the class-type-bw context
Contextconfigure router string rsvp interface reference class-type-bw
Treeclass-type-bw
Introduced16.0.R1

Platforms

All

ct0 number
Synopsis Percentage of link bandwidth for class type (CT) 0
Contextconfigure router string rsvp interface reference class-type-bw ct0 number
Treect0
Range0 to 100
Introduced16.0.R1

Platforms

All

ct1 number
Synopsis Percentage of link bandwidth for class type (CT) 1
Contextconfigure router string rsvp interface reference class-type-bw ct1 number
Treect1
Range0 to 100
Introduced16.0.R1

Platforms

All

ct2 number
Synopsis Percentage of link bandwidth for class type (CT) 2
Contextconfigure router string rsvp interface reference class-type-bw ct2 number
Treect2
Range0 to 100
Introduced16.0.R1

Platforms

All

ct3 number
Synopsis Percentage of link bandwidth for class type (CT) 3
Contextconfigure router string rsvp interface reference class-type-bw ct3 number
Treect3
Range0 to 100
Introduced16.0.R1

Platforms

All

ct4 number
Synopsis Percentage of link bandwidth for class type (CT) 4
Contextconfigure router string rsvp interface reference class-type-bw ct4 number
Treect4
Range0 to 100
Introduced16.0.R1

Platforms

All

ct5 number
Synopsis Percentage of link bandwidth for class type (CT) 5
Contextconfigure router string rsvp interface reference class-type-bw ct5 number
Treect5
Range0 to 100
Introduced16.0.R1

Platforms

All

ct6 number
Synopsis Percentage of link bandwidth for class type (CT) 6
Contextconfigure router string rsvp interface reference class-type-bw ct6 number
Treect6
Range0 to 100
Introduced16.0.R1

Platforms

All

ct7 number
Synopsis Percentage of link bandwidth for class type (CT) 7
Contextconfigure router string rsvp interface reference class-type-bw ct7 number
Treect7
Range0 to 100
Introduced16.0.R1

Platforms

All

dbw-down-threshold
Synopsis Enable the dbw-down-threshold context
Contextconfigure router string rsvp interface reference dbw-down-threshold
Treedbw-down-threshold
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

bw number
Synopsis Minimum difference in MRLB or MRB to trigger an update
Contextconfigure router string rsvp interface reference dbw-down-threshold bw number
Treebw
Range0 to 1000000
Unitsmegabps
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

percent number
Synopsis Minimum difference in percent between dark bandwidth and sampled data rate, to trigger IGP-TE update
Contextconfigure router string rsvp interface reference dbw-down-threshold percent number
Treepercent
Range0 to 100
Unitspercent
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

dbw-multiplier number
Synopsis Configure the Dark Bandwidth multiplier.
Contextconfigure router string rsvp interface reference dbw-multiplier number
Treedbw-multiplier
Range0 to 1000
Unitspercent
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

dbw-up-threshold
Synopsis Enable the dbw-up-threshold context
Contextconfigure router string rsvp interface reference dbw-up-threshold
Treedbw-up-threshold
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

bw number
Synopsis Minimum difference in MRLB or MRB to trigger an update
Contextconfigure router string rsvp interface reference dbw-up-threshold bw number
Treebw
Range0 to 1000000
Unitsmegabps
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

percent number
Synopsis Minimum difference in percent between dark bandwidth and sampled data rate, to trigger IGP-TE update
Contextconfigure router string rsvp interface reference dbw-up-threshold percent number
Treepercent
Range0 to 100
Unitspercent
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-s, 7950 XRS, VSR

implicit-null-label boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSignal the implicit null label value for all LSPs
Contextconfigure router string rsvp interface reference implicit-null-label boolean
Treeimplicit-null-label
Introduced16.0.R1

Platforms

All

subscription number
Synopsis Percentage of the link bandwidth to use for reservation
Contextconfigure router string rsvp interface reference subscription number
Treesubscription
Range0 to 1000
Default100
Introduced 16.0.R1

Platforms

All

keep-multiplier number
Synopsis Value for the keep-multiplier to declare a reservation or neighbor as down
Contextconfigure router string rsvp keep-multiplier number
Treekeep-multiplier
Range1 to 255
Default3
Introduced 16.0.R1

Platforms

All

msg-pacing
Synopsis Enable the msg-pacing context
Context configure router string rsvp msg-pacing
Treemsg-pacing
Introduced16.0.R1

Platforms

All

max-burst number
Synopsis Maximum RSVP messages that are sent over a specified period when message pacing is enabled
Contextconfigure router string rsvp msg-pacing max-burst number
Treemax-burst
Range100 to 1000
Default650
Introduced 16.0.R1

Platforms

All

period number
Synopsis Time for RSVP message pacing
Context configure router string rsvp msg-pacing period number
Treeperiod
Range100 to 1000
Unitsmilliseconds
Default 100
Introduced16.0.R1

Platforms

All

preemption-timer number
Synopsis Preemption timer for the MPLS instance
Contextconfigure router string rsvp preemption-timer number
Treepreemption-timer
Range0 to 1800
Unitsseconds
Default 300
Introduced16.0.R1

Platforms

All

rapid-retransmit-time number
Synopsis Rapid retransmission interval to reliably deliver RSVP messages
Contextconfigure router string rsvp rapid-retransmit-time number
Treerapid-retransmit-time
Range1 to 100
Unitsdeciseconds
Default 5
Introduced16.0.R1

Platforms

All

rapid-retry-limit number
Synopsis Rapid retry limit to reliably deliver RSVP messages
Contextconfigure router string rsvp rapid-retry-limit number
Treerapid-retry-limit
Range1 to 6
Default3
Introduced 16.0.R1

Platforms

All

refresh-time number
Synopsis Interval between refresh messages
Context configure router string rsvp refresh-time number
Treerefresh-time
Range1 to 65535
Unitsseconds
Default 30
Introduced16.0.R1

Platforms

All

te-down-threshold number
Synopsis Value for the te-down-threshold
Context configure router string rsvp te-down-threshold number
Treete-down-threshold
Range0 to 100
Max. Instances16

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

te-threshold-update
Synopsis Enable the te-threshold-update context
Contextconfigure router string rsvp te-threshold-update
Treete-threshold-update
Introduced16.0.R1

Platforms

All

te-up-threshold number
Synopsis Value for the te-up-threshold
Context configure router string rsvp te-up-threshold number
Treete-up-threshold
Range0 to 100
Max. Instances16

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

segment-routing

Synopsis Enter the segment-routing context
Contextconfigure router string segment-routing
Treesegment-routing
Introduced16.0.R1

Platforms

All

maintenance-policy [policy-name] string
Synopsis Enter the maintenance-policy list instance
Contextconfigure router string segment-routing maintenance-policy string
Treemaintenance-policy

Description

Commands in this context configure a named maintenance policy that can be applied to SR policy candidate paths that are either statically configured or imported via BGP.

Introduced20.10.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the maintenance policy
Contextconfigure router string segment-routing maintenance-policy string admin-state keyword
Treeadmin-state

Description

This command sets the administrative state of the maintenance policy.

A maintenance policy must be administratively disabled to change any of the parameters.

When a maintenance template is administratively disabled, all applicable candidate paths are removed from the data path.

Optionsenable, disable
Default disable
Introduced20.10.R1

Platforms

All

bfd-liveness boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable seamless BFD for segment lists of candidate path
Contextconfigure router string segment-routing maintenance-policy string bfd-liveness boolean
Treebfd-liveness

Description

When configured to true, this command enables seamless BFD on every segment list of an SR policy candidate path to which the maintenance policy is applied. The BFD template configures the parameters for the BFD session.

When configured to false, seamless BFD is disabled.

Defaultfalse
Introduced20.10.R1

Platforms

All

bfd-template reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisBFD template to be used by seamless BFD
Contextconfigure router string segment-routing maintenance-policy string bfd-template reference
Treebfd-template

Description

This command references a named BFD template to be used by seamless BFD. A BFD template must exist on the system before being referenced from a maintenance policy. The template specifies parameters that are used by the BFD session, such as the minimum transmit and receive control packet timer intervals.

Reference

configure bfd bfd-template string

Introduced20.10.R1

Platforms

All

hold-down-timer number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisHold down timer for SR policy candidate paths
Contextconfigure router string segment-routing maintenance-policy string hold-down-timer number
Treehold-down-timer

Description

This command configures the hold down timer for the maintenance policy. The purpose of the timer is to prevent bouncing of the SR policy path state if S-BFD sessions associated with the segment lists flap, causing the threshold to be repeatedly crossed in a short period of time.

The timer is started when the number of up S-BFD sessions drops below the threshold. The SR policy path is not considered to be up again until the hold down timer has expired and the number of up S-BFD sessions reaches or exceeds the threshold and the internal hold timer is not running.

If the revert timer is also configured, the revert timer is not started until after the number of up S-BFD sessions equals or exceeds the threshold and the hold down timer for the primary candidate path has expired.

Range0 to 5000
Unitsdeciseconds
Default 0
Introduced20.10.R1

Platforms

All

mode keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisProtection mode for SR policy candidate paths
Contextconfigure router string segment-routing maintenance-policy string mode keyword
Treemode

Description

This command specifies the data path programming and protection mechanism for SR policy candidate paths to which the maintenance policy is applied.

Optionsnone, ecmp-protected, linear
Defaultnone
Introduced20.10.R1

Platforms

All

return-path-label number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisS-BFD return-path label
Contextconfigure router string segment-routing maintenance-policy string return-path-label number
Treereturn-path-label

Description

This command configures the S-BFD session to echo mode and adds an additional MPLS label to the bottom of the label stack for the S-BFD packet. 

The command applies to the initiator of the S-BFD sessions. The return-path label may be a binding SID for an SR policy or other MPLS path configured on the reflector router. Instead of being routed through the IGP path, the S-BFD packet returns to the initiator through this MPLS return path. 

If the command is deleted, S-BFD returns to asynchronous mode and no return-path label is pushed by the initiator node. Any S-BFD packets for this LSP or path that the reflector receives are routed through the IGP path.

Range32 to 1048512
Introduced22.10.R1

Platforms

All

revert-timer number
Synopsis Revert timer for SR policy candidate paths
Contextconfigure router string segment-routing maintenance-policy string revert-timer number
Treerevert-timer

Description

This command configures the revert timer for SR Policy candidate paths.

The revert timer is started when the primary path recovers (the number of S-BFD sessions that are up equals or exceeds the threshold value and the hold down timer has expired). When the timer expires, the system reverts to the primary path.

Range0 to 4320
Unitsminutes
Introduced 20.10.R1

Platforms

All

threshold number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMinimum number of up S-BFD sessions for up path status
Contextconfigure router string segment-routing maintenance-policy string threshold number
Treethreshold

Description

This command configures the minimum number of S-BFD sessions that must be up for the SR policy candidate path to be considered up. If the number of up sessions is below this threshold value, the policy candidate path is marked as BFD degraded by the system.

This command is only valid in the ecmp-protected mode.

Range1 to 32
Default1
Introduced 20.10.R1

Platforms

All

segment-routing-v6
Synopsis Enable the segment-routing-v6 context
Contextconfigure router string segment-routing segment-routing-v6
Treesegment-routing-v6
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

base-routing-instance
Synopsis Enter the base-routing-instance context
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance
Treebase-routing-instance

Description

Commands in this context configure SRv6 SID functions for End, End.X, and service SIDs for IPv4 and IPv6 prefixes in the base routing instance.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

locator [locator-name] reference
Synopsis Enter the locator list instance
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance locator reference
Treelocator
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

function
Synopsis Enter the function context
Context configure router string segment-routing segment-routing-v6 base-routing-instance locator reference function
Treefunction

Description

Commands in this context configure the function value of SRv6 SIDs.

The end-dt46 command is mutually exclusive with the end-dt4 and end-dt6 commands.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

end [value] number
Synopsis Enter the end list instance
Context configure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end number
Treeend

Description

Commands in this context configure the attributes of SRv6 End SID function. The End SID functions for each SRH mode must be statically allocated. The value is not automatically allocated by default for a locator. 

Max. Instances8
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

end-dt4
Synopsis Enable the end-dt4 context
Context configure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end-dt4
Treeend-dt4
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

end-dt46
Synopsis Enable the end-dt46 context
Context configure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end-dt46
Treeend-dt46

Description

Commands in this context assign a value for IPv4 and IPV6 routes in the VPRN service instance.  

This command and the end-dt4 command are mutually exclusive.

This command and the end-dt6 command are mutually exclusive.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

end-dt6
Synopsis Enable the end-dt6 context
Context configure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end-dt6
Treeend-dt6
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

end-x [value] number
Synopsis Enter the end-x list instance
Context configure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end-x number
Treeend-x

Description

Commands in this context configure the attributes of the End.X SID function associated with a P2P interface.

A static function value can be configured for each combination of SRH mode and protection type. For a specific interface, the static function value associated with the same combination of protection type and SRH mode overrides any corresponding function value that is automatically allocated (end.x-auto-allocate list configuration).

If more than one value is configured for an interface and combination of SRH mode and protection type, they are all advertised in IS-IS.

When used in remote TI-LFA repair tunnel programming, IS-IS uses rules to select one End.X value from the multiple values received in IS-IS link advertisements. 

Values assigned to loopback and system interfaces are not advertised in IS-IS.

End.X SID functions for adjacencies over broadcast interfaces are always automatically allocated based on the configuration of the end.x-auto-allocate list.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

end-x-auto-allocate [srh-mode] keyword protection keyword
Synopsis Add a list entry for end-x-auto-allocate
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end-x-auto-allocate keyword protection keyword
Treeend-x-auto-allocate

Description

This command adds a list entry for the automatic allocation of the End.X SID function for all adjacencies over all network interfaces on the router (P2P and broadcast interfaces).

A list entry is a combination of the protection type and the SRH mode. Any combinations in addition to the maximum supported by this command must be allocated statically under each P2P interface (end.x configuration).

When no list entries are configured, no End.X function values are automatically allocated by default for a locator.

Max. Instances2
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

protection keyword
Synopsis Adjacency protection for automatic SID function
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance locator reference function end-x-auto-allocate keyword protection keyword
Treeend-x-auto-allocate

Description

This command specifies the adjacency protection for the automatically allocated SID function.

Optionsunprotected, protected

Notes

This element is part of a list key.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

micro-segment-locator [locator-name] reference
Synopsis Enter the micro-segment-locator list instance
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference
Treemicro-segment-locator
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[locator-name] reference
Synopsis SRv6 micro-segment locator name
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference
Treemicro-segment-locator

Description

This command references a micro-segment locator name defined in the configure router segment-routing segment-routing-v6 context. This command assigns a micro-segment locator to BGP for use with Base router routes.

Reference

configure router string segment-routing segment-routing-v6 micro-segment-locator string

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

function
Synopsis Enter the function context
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function
Treefunction
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

ua [value] number
Synopsis Enter the ua list instance
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function ua number
Treeua

Description

Commands in this context configure the attributes of the uA micro-SID function associated with a P2P interface. The uA micro-SID function encodes the behavior of an adjacency SID.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

ua-auto-allocate [srh-mode] keyword protection keyword
Synopsis Add a list entry for ua-auto-allocate
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function ua-auto-allocate keyword protection keyword
Treeua-auto-allocate

Description

Commands in this context define a list entry for the automatic allocation of the uA micro-SID function for all adjacencies over all network interfaces on the router (P2P and broadcast interfaces).

Max. Instances2
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[srh-mode] keyword
Synopsis Segment Routing Header (SRH) mode
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function ua-auto-allocate keyword protection keyword
Treeua-auto-allocate

Description

This command specifies the popping mode for the automatically allocated SID.

Optionspsp, usp, psp-usd, usp-usd, psp-usp-usd

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

protection keyword
Synopsis Adjacency protection for automatic SID function
Contextconfigure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function ua-auto-allocate keyword protection keyword
Treeua-auto-allocate

Description

This command specifies the adjacency protection for the automatically allocated SID function.

Optionsunprotected, protected

Notes

This element is part of a list key.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

udt4
Synopsis Enable the udt4 context
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function udt4
Treeudt4
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

udt46
Synopsis Enable the udt46 context
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function udt46
Treeudt46
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

udt6
Synopsis Enable the udt6 context
Context configure router string segment-routing segment-routing-v6 base-routing-instance micro-segment-locator reference function udt6
Treeudt6
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

locator [locator-name] string
Synopsis Enter the locator list instance
Contextconfigure router string segment-routing segment-routing-v6 locator string
Treelocator
Max. Instances16
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

[locator-name] string
Synopsis SRv6 locator name
Context configure router string segment-routing segment-routing-v6 locator string
Treelocator
String Length1 to 64

Notes

This element is part of a list key.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

algorithm number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIGP flexible algorithm ID
Contextconfigure router string segment-routing segment-routing-v6 locator string algorithm number
Treealgorithm

Description

This command configures an IGP flexible algorithm for a locator. A locator can only be part of one algorithm but it can be used in multiple IGP instances.

Range128 to 255
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

argument-length number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSRv6 locator argument length
Contextconfigure router string segment-routing segment-routing-v6 locator string argument-length number
Treeargument-length

Description

This command configures the SRv6 locator argument length.

The sum of the function length, argument length, and the locator prefix length must not exceed 128 bits.

The following commands are used to configure the function length and locator prefix length:

  • configure router segment-routing segment-routing-v6 locator function-length

  • configure router segment-routing segment-routing-v6 locator prefix ip-prefix

Range0 | 16
Default0
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

block-length number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSRv6 locator block address length
Contextconfigure router string segment-routing segment-routing-v6 locator string block-length number
Treeblock-length
Range0 to 96
Default0
Introduced 21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

function-length number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisFunction length
Contextconfigure router string segment-routing segment-routing-v6 locator string function-length number
Treefunction-length

Description

This command configures the size of the function length. The sum of the function length and the locator prefix length must not exceed 128 bits. Operators can configure the locator level label-block command before they configure a function length of 16. If the function length is configured as 16, the locator level label-block must be configured rather than the static-function level label-block. The validation occurs when committed.

Range16 | 20 to 96
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

prefix
Synopsis Enter the prefix context
Context configure router string segment-routing segment-routing-v6 locator string prefix
Treeprefix
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

ip-prefix string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSRv6 locator prefix
Contextconfigure router string segment-routing segment-routing-v6 locator string prefix ip-prefix string
Treeip-prefix

Description

This command configures the IPv6 prefix for the locator.  

For regular SRv6, the locator prefix length range is the sum of the length of the block field and the length of the node ID field. For micro-segment SRv6, the locator prefix length must be equal to the micro-SID block length.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

static-function
Synopsis Enter the static-function context
Contextconfigure router string segment-routing segment-routing-v6 locator string static-function
Treestatic-function

Description

Commands in this context configure the attributes of the function field range reserved for static End.d, End.X, and service SID assignment.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

max-entries number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of static SID functions
Contextconfigure router string segment-routing segment-routing-v6 locator string static-function max-entries number
Treemax-entries

Description

This command configures the maximum number of values that are reserved from the function field to assign to static SID functions.

Range1 to 1048575
Default1
Introduced 21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

termination-fpe reference
Synopsis List of the SRv6 termination FPE
Context configure router string segment-routing segment-routing-v6 locator string termination-fpe reference
Treetermination-fpe

Description

This command associates the Forwarding Path Extension (FPE) with the locator for terminating SRv6 in local services. Multiple locators can share the same FPE or each locator can use a different FPE. The FPE can be the same or different from the origination FPE.

Reference

configure fwd-path-ext fpe number

Max. Instances1
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

micro-segment
Synopsis Enable the micro-segment context
Contextconfigure router string segment-routing segment-routing-v6 micro-segment
Treemicro-segment
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

argument-length number
Synopsis Micro-segment argument length
Context configure router string segment-routing segment-routing-v6 micro-segment argument-length number
Treeargument-length

Description

This command configures the micro-segment argument length.

The sum of the function length, argument length, and the locator prefix length must not exceed 128 bits.

The following commands are used to configure the function length and locator prefix length:

  • configure router segment-routing segment-routing-v6 locator function-length

  • configure router segment-routing segment-routing-v6 locator prefix ip-prefix

Range0 | 16
Default0
Introduced 23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

block [block-name] string
Synopsis Enter the block list instance
Context configure router string segment-routing segment-routing-v6 micro-segment block string
Treeblock
Max. Instances16
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

label-block reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisReserved label block
Contextconfigure router string segment-routing segment-routing-v6 micro-segment block string label-block reference
Treelabel-block

Description

This command associates a pre-configured reserved label block with the micro-SID block. 

Reference

configure router string mpls-labels reserved-label-block string

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

prefix
Synopsis Enter the prefix context
Context configure router string segment-routing segment-routing-v6 micro-segment block string prefix
Treeprefix

Description

Commands in this context configure the IPv6 prefix for an SRv6 micro-segment locator.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

ip-prefix string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSRv6 locator prefix
Contextconfigure router string segment-routing segment-routing-v6 micro-segment block string prefix ip-prefix string
Treeip-prefix

Description

This command configures the IPv6 prefix for the locator.  

For regular SRv6, the locator prefix length range is the sum of the length of the block field and the length of the node ID field. For micro-segment SRv6, the locator prefix length must be equal to the micro-SID block length.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

static-function
Synopsis Enter the static-function context
Contextconfigure router string segment-routing segment-routing-v6 micro-segment block string static-function
Treestatic-function

Description

Commands in this context configure the function field parameters of a static uA or service micro-SID assignment.

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

max-entries number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisMaximum number of static SID functions
Contextconfigure router string segment-routing segment-routing-v6 micro-segment block string static-function max-entries number
Treemax-entries

Description

This command configures the maximum number of values that are reserved from the function field to assign to static SID functions.

Range1 to 1048575
Default1
Introduced 22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

global-sid-entries number
Synopsis Maximum number of micro-segment locators network wide
Contextconfigure router string segment-routing segment-routing-v6 micro-segment global-sid-entries number
Treeglobal-sid-entries

Description

This command defines the maximum number of unique micro-segment locators that can be configured network wide. The value is expressed in multiples of 1024 and must be the same on every platform network wide. 

Range4 to 60
Default16
Introduced 22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

micro-segment-locator [locator-name] string
Synopsis Enter the micro-segment-locator list instance
Contextconfigure router string segment-routing segment-routing-v6 micro-segment-locator string
Treemicro-segment-locator
Max. Instances16
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

algorithm number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIGP flexible algorithm ID
Contextconfigure router string segment-routing segment-routing-v6 micro-segment-locator string algorithm number
Treealgorithm

Description

This command configures an IGP flexible algorithm for a locator. A locator can only be part of one algorithm but it can be used in multiple IGP instances.

Range128 to 255
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

block reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisPre-defined micro-SID block
Contextconfigure router string segment-routing segment-routing-v6 micro-segment-locator string block reference
Treeblock

Description

This command associates a pre-defined micro-SID block with the micro-segment SRv6 locator.

Reference

configure router string segment-routing segment-routing-v6 micro-segment block string

Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

un
Synopsis Enter the un context
Context configure router string segment-routing segment-routing-v6 micro-segment-locator string un
Treeun
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

srh-mode keyword
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSegment Routing Header (SRH) mode
Contextconfigure router string segment-routing segment-routing-v6 micro-segment-locator string un srh-mode keyword
Treesrh-mode

Description

This command configures the popping mode for the SID.

Optionspsp, usp, psp-usd, usp-usd, psp-usp-usd
Defaultpsp
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

value number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisSRv6 function value
Contextconfigure router string segment-routing segment-routing-v6 micro-segment-locator string un value number
Treevalue
Range1 to 1048575
Introduced22.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

origination-fpe reference
Synopsis List of the SRv6 origination FPEs
Context configure router string segment-routing segment-routing-v6 origination-fpe reference
Treeorigination-fpe

Description

This command configures the origination Forwarding Path Extension (FPE) for SRv6 tunnels on local services. The origination FPE must be different from any of the SRv6 termination FPEs.

Reference

configure fwd-path-ext fpe number

Max. Instances1
Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

source-address string
Synopsis Source address used in the SRv6 packet
Contextconfigure router string segment-routing segment-routing-v6 source-address string
Treesource-address

Description

This command specifies the global default source IPv6 address used in the SA field of the outerIPv6 header of the SRv6 encapsulated packet.  

The value is inherited in the BGP and services contexts (for example, configure router "base" bgp segment-routing-v6 source-address and configure service vprn bgp-ipvpn segment-routing-v6 source-address), but is overwritten by the value configured in those contexts.  

A source IPv6 address must be configured in the global context or in the BGP or services context. 

The system does not check if the entered address is a valid local address.

Introduced21.5.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

sr-mpls
Synopsis Enter the sr-mpls context
Context configure router string segment-routing sr-mpls
Treesr-mpls
Introduced21.10.R1

Platforms

All

prefix-sids [interface-name] reference
Synopsis Enter the prefix-sids list instance
Contextconfigure router string segment-routing sr-mpls prefix-sids reference
Treeprefix-sids

Description

Commands in this context configure the prefix SIDs for an interface.

Introduced21.10.R1

Platforms

All

ipv4-sid
Synopsis Enable the ipv4-sid context
Context configure router string segment-routing sr-mpls prefix-sids reference ipv4-sid
Treeipv4-sid
Introduced21.10.R1

Platforms

All

ipv6-sid
Synopsis Enable the ipv6-sid context
Context configure router string segment-routing sr-mpls prefix-sids reference ipv6-sid
Treeipv6-sid
Introduced21.10.R1

Platforms

All

sr-policies
Synopsis Enter the sr-policies context
Context configure router string segment-routing sr-policies
Treesr-policies
Introduced16.0.R1

Platforms

All

egress-statistics
Synopsis Enable the egress-statistics context
Contextconfigure router string segment-routing sr-policies egress-statistics
Treeegress-statistics

Description

Commands in this context configure the collection of egress traffic statistics for all segment routing policies.

Introduced19.10.R1

Platforms

All

static-policy [name] string
Synopsis Enter the static-policy list instance
Contextconfigure router string segment-routing sr-policies static-policy string
Treestatic-policy
Max. Instances32768
Introduced16.0.R1

Platforms

All

color number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisTraffic flows to be steered by this policy
Contextconfigure router string segment-routing sr-policies static-policy string color number
Treecolor
Range0 to 4294967295
Introduced16.0.R1

Platforms

All

endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisDestination of the source-routed path
Contextconfigure router string segment-routing sr-policies static-policy string endpoint (ipv4-address-no-zone | ipv6-address-no-zone)
Treeendpoint
Introduced16.0.R1

Platforms

All

head-end (ipv4-address-no-zone | ipv6-address-no-zone | keyword)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisHead end address for this static policy
Contextconfigure router string segment-routing sr-policies static-policy string head-end (ipv4-address-no-zone | ipv6-address-no-zone | keyword)
Treehead-end
Optionslocal
Introduced16.0.R1

Platforms

All

preference number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisPreference value of this static policy
Contextconfigure router string segment-routing sr-policies static-policy string preference number
Treepreference
Max. Range0 to 4294967295
Default100
Introduced16.0.R1

Platforms

All

segment-list [seg-list-index] number
Synopsis Enter the segment-list list instance
Contextconfigure router string segment-routing sr-policies static-policy string segment-list number
Treesegment-list
Max. Instances32
Introduced16.0.R1

Platforms

All

segment [segment-index] number
Synopsis Enter the segment list instance
Contextconfigure router string segment-routing sr-policies static-policy string segment-list number segment number
Treesegment

Description

Commands in this context configure a segment inside a segment-list of a statically-defined segment routing policy candidate path.

A segment list of a statically-defined SR policy candidate path of type sr-mpls can only accept a segment of type mpls-label.

A segment list of a statically-defined SR policy candidate path of type srv6 can only accept a segment of type srv6-sid. However, you can mix SRv6 segments derived from both classic SRv6 and micro-segment SRv6 locators.

Max. Instances24
Introduced16.0.R1

Platforms

All

[segment-index] number
Synopsis Index for identifying a segment in a segment list
Contextconfigure router string segment-routing sr-policies static-policy string segment-list number segment number
Treesegment

Description

This command configures the index for identifying a segment in a segment list.

Each segment list can have up to 11 segments for SR-MPLS policies, and 24 segments for an SRv6 segment list which only includes micro-segments. For an SRv6 segment list that mixes regular and micro-segments, up to 7 regular segments can be configured.

Range1 to 24

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

behavior-and-structure
Synopsis Enable the behavior-and-structure context
Contextconfigure router string segment-routing sr-policies static-policy string segment-list number segment number behavior-and-structure
Treebehavior-and-structure

Description

Commands in this context configure the behavior and structure of the SRv6 policy micro-segment.

Behavior and structure are necessary (but not sufficient) for the SRv6 policy micro-segment to be compressed by a head-end.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

behavior keyword
Synopsis Behavior of the SRv6 uSID
Context configure router string segment-routing sr-policies static-policy string segment-list number segment number behavior-and-structure behavior keyword
Treebehavior

Description

This command configures the behavior of the SRv6 policy micro-segment (uSID).

The only allowed values are flavorless behaviors of NEXT-CSID. The compression algorithm however supports all flavors.

Although END.T with NEXT-CSID is a configurable value, SR OS does not support this behavior for locally-instantiated SIDs. However, configuring this value allows a traffic-engineered path to be built that includes nodes that would support such behavior.

Optionsend-next-csid, end-x-next-csid, end-t-next-csid, end-b6-encaps-next-csid, end-b6-encaps-red-next-csid

Notes

This element is mandatory.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

weight number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisWeight of this segment list
Contextconfigure router string segment-routing sr-policies static-policy string segment-list number weight number
Treeweight
Max. Range0 to 4294967295
Default1
Introduced 16.0.R1

Platforms

All

segment-routing-v6
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisEnable the segment-routing-v6 context
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6
Treesegment-routing-v6

Description

Commands in this context configure a static SRv6 policy.

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

binding-sid [index] number
Synopsis Enter the binding-sid list instance
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number
Treebinding-sid
Max. Instances1
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

ip-address string
Synopsis Remote SRv6 binding SID
Context configure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number ip-address string
Treeip-address

Description

This command configures an SRv6 binding SID for a remote SRv6 policy. The command cannot be used with a local head-end location (configure router segment-routing sr-policies static-policy head-end local).

This command and the configure router segment-routing sr-policies static-policy segment-routing-v6 binding-sid locator command or the configure router segment-routing sr-policies static-policy segment-routing-v6 binding-sid micro-segment-locator command are mutually exclusive.

If the remote head-end is an SR OS system, the binding SID can either be a regular SID or uSID. If it is a uSID, it must be configured with a node ID in the following format: <block><uN><uB6>::)

The format of the binding SID is a 128-bit IPv6 address.

Notes

The following elements are part of a choice: ip-address or (locator and micro-segment-locator).

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

locator
Synopsis Enable the locator context
Context configure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number locator
Treelocator

Description

Commands in this context configure a binding SID locator for a local SRv6 policy. This command and the configure router segment-routing sr-policies static-policy segment-routing-v6 binding-sid ip-address command for a non-local SRv6 policy are mutually exclusive.

Notes

The following elements are part of a choice: ip-address or (locator and micro-segment-locator).

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

function-value number
Synopsis Value of the local SRv6 regular binding SID
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number locator function-value number
Treefunction-value

Description

This command configures the function value of the local SRv6 regular binding SID.

If this command is not configured, the system automatically selects a value within the range of the dynamic SID function values.

The value must be within the range of static SID function values, and must be available.

Range1 to 1048575
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

locator-name reference
Synopsis Name of the locator of the local SRv6 regular binding SID
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number locator locator-name reference
Treelocator-name

Description

This command configures the name of the locator of the local SRv6 regular binding SID.

The locator must exist on the system.

Reference

configure router string segment-routing segment-routing-v6 locator string

Notes

This element is mandatory.

Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

micro-segment-locator
Synopsis Enable the micro-segment-locator context
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number micro-segment-locator
Treemicro-segment-locator

Description

Commands in this context configure the local SRv6 microbinding SID. This command and the configure router segment-routing sr-policies static-policy segment-routing-v6 binding-sid ip-address command for a non-local SRv6 policy are mutually exclusive.

Notes

The following elements are part of a choice: ip-address or (locator and micro-segment-locator).

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

function-value number
Synopsis Value of the local SRv6 microbinding SID
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number micro-segment-locator function-value number
Treefunction-value

Description

This command configures the function value of the local SRv6 microbinding SID.

If this command is not configured, the system automatically selects a value within the range of local and dynamic SID function values.

The value must be within the range of local and static SID function values, and must be available.

Range1 to 65535
Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

locator-name reference
Synopsis Name of the locator of the local SRv6 microbinding SID
Contextconfigure router string segment-routing sr-policies static-policy string segment-routing-v6 binding-sid number micro-segment-locator locator-name reference
Treelocator-name

Description

This command configures the name of the locator of the local SRv6 microbinding SID.

The locator must be a micro-segment locator and must exist on the system.

Reference

configure router string segment-routing segment-routing-v6 micro-segment-locator string

Notes

This element is mandatory.

Introduced23.10.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

type keyword
Synopsis Static policy type
Context configure router string segment-routing sr-policies static-policy string type keyword
Treetype

Description

This command configures the type of static policy. Only commands relevant to the type of the static policy can be executed. The type of the static policy can only be changed to a new type if there is no configuration present for the old type, or if all configuration for the old type is deleted.

Optionssr-mpls, srv6
Default sr-mpls
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS, VSR

selective-fib boolean

Synopsis Enable selective FIB
Context configure router string selective-fib boolean
Treeselective-fib
Defaulttrue
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

sfm-overload

Synopsis Enable the sfm-overload context
Contextconfigure router string sfm-overload
Treesfm-overload
Introduced16.0.R2

Platforms

7450 ESS, 7750 SR-1, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7750 SR-2s, 7750 SR-2se, 7750 SR-7s, 7750 SR-14s, 7950 XRS, VSR

holdoff-time number
Synopsis Delay in detecting SFM failures and setting overload
Contextconfigure router string sfm-overload holdoff-time number
Treeholdoff-time
Range1 to 600
Unitsseconds
Introduced 16.0.R2

Platforms

7450 ESS, 7750 SR-1, 7750 SR-7/12/12e, 7750 SR-a, 7750 SR-e, 7750 SR-2s, 7750 SR-2se, 7750 SR-7s, 7750 SR-14s, 7950 XRS, VSR

sgt-qos

Synopsis Enter the sgt-qos context
Context configure router string sgt-qos
Treesgt-qos
Introduced16.0.R1

Platforms

All

dot1p
Synopsis Enter the dot1p context
Context configure router string sgt-qos dot1p
Treedot1p
Introduced16.0.R1

Platforms

All

application [dot1p-app-name] keyword
Synopsis Enter the application list instance
Contextconfigure router string sgt-qos dot1p application keyword
Treeapplication
Introduced16.0.R1

Platforms

All

[dot1p-app-name] keyword
Synopsis Dot1p application ID that generates control traffic
Contextconfigure router string sgt-qos dot1p application keyword
Treeapplication
Optionsarp, isis, pppoe

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

dot1p (keyword | number)
Synopsis Dot1p value to the traffic generated by this application
Contextconfigure router string sgt-qos dot1p application keyword dot1p (keyword | number)
Treedot1p
Range0 to 7
Optionsbe, l2, af, l1, h2, ef, h1, nc
Introduced16.0.R1

Platforms

All

dscp
Synopsis Enter the dscp context
Context configure router string sgt-qos dscp
Treedscp
Introduced16.0.R1

Platforms

All

application [dscp-app-name] keyword
Synopsis Enter the application list instance
Contextconfigure router string sgt-qos dscp application keyword
Treeapplication
Introduced16.0.R1

Platforms

All

[dscp-app-name] keyword
Synopsis DSCP application identifier on the NOKIA SR OS router that generates control traffic over IP
Contextconfigure router string sgt-qos dscp application keyword
Treeapplication
Optionsbgp, cflowd, dhcp, dns, ftp, icmp, igmp, l2tp, ldp, mld, msdp, ndis, ntp, ospf, pim, radius, rip, rsvp, snmp, snmp-notification, srrp, ssh, syslog, tacplus, telnet, tftp, traceroute, vrrp, ptp, igmp-reporter, gtp, sflow, diameter, pcep, call-trace, bmp, grpc, mtrace2, http, mpls-udp-return, pfcp, ibcp, bfd

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

dscp (keyword | number)
Synopsis DSCP value to the traffic generated by this application
Contextconfigure router string sgt-qos dscp application keyword dscp (keyword | number)
Treedscp
Range0 to 63
Optionsbe, cp1, cp2, cp3, cp4, cp5, cp6, cp7, cs1, cp9, af11, cp11, af12, cp13, af13, cp15, cs2, cp17, af21, cp19, af22, cp21, af23, cp23, cs3, cp25, af31, cp27, af32, cp29, af33, cp31, cs4, cp33, af41, cp35, af42, cp37, af43, cp39, cs5, cp41, cp42, cp43, cp44, cp45, ef, cp47, nc1, cp49, cp50, cp51, cp52, cp53, cp54, cp55, nc2, cp57, cp58, cp59, cp60, cp61, cp62, cp63
Introduced16.0.R1

Platforms

All

dscp-map [dscp-name] keyword
Synopsis Enter the dscp-map list instance
Contextconfigure router string sgt-qos dscp dscp-map keyword
Treedscp-map
Introduced16.0.R2

Platforms

All

[dscp-name] keyword
Synopsis DSCP name mapped to forwarding class
Context configure router string sgt-qos dscp dscp-map keyword
Treedscp-map
Optionsbe, cp1, cp2, cp3, cp4, cp5, cp6, cp7, cs1, cp9, af11, cp11, af12, cp13, af13, cp15, cs2, cp17, af21, cp19, af22, cp21, af23, cp23, cs3, cp25, af31, cp27, af32, cp29, af33, cp31, cs4, cp33, af41, cp35, af42, cp37, af43, cp39, cs5, cp41, cp42, cp43, cp44, cp45, ef, cp47, nc1, cp49, cp50, cp51, cp52, cp53, cp54, cp55, nc2, cp57, cp58, cp59, cp60, cp61, cp62, cp63

Notes

This element is part of a list key.

Introduced16.0.R2

Platforms

All

fc keyword
Synopsis Value for the forwarding class for this mapping
Contextconfigure router string sgt-qos dscp dscp-map keyword fc keyword
Treefc
Optionsbe, l2, af, l1, h2, ef, h1, nc
Introduced 16.0.R2

Platforms

All

static-routes

Synopsis Enter the static-routes context
Contextconfigure router string static-routes
Treestatic-routes
Introduced16.0.R1

Platforms

All

hold-down
Synopsis Enable the hold-down context
Context configure router string static-routes hold-down
Treehold-down

Description

Commands in this context enable the hold-down time feature globally for static routes in the system.

The static route hold-down time is a mechanism to protect from rapid, fluctuating state changes of static routes resulting from issues with reachability because of link flap.

The commands in this context apply to all static routes in the VPRN and the base router instance in which this hold-down time is configured in.

Introduced16.0.R1

Platforms

All

initial number
Synopsis Value for the initial hold-down time
Context configure router string static-routes hold-down initial number
Treeinitial

Description

This command specifies the initial value of the hold-down time globally for static routes in the system.

When a static route is ready to become active, it remains inactive for the hold-down time before activating the static-route. If, during this hold-down period, the static route becomes inactive again because of factors such as interface failure, the hold-down timer is reset, effectively postponing the activation of the route until the next opportunity.

Range1 to 65535

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

max-value number
Synopsis Maximum value of the hold-down time
Context configure router string static-routes hold-down max-value number
Treemax-value

Description

This command specifies the maximum value of the hold-down time globally for static routes in the system.

Range1 to 65535

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

multiplier number
Synopsis Multiplier of the previous hold-down time
Contextconfigure router string static-routes hold-down multiplier number
Treemultiplier

Description

This command specifies the multiplier value by which the previous hold-down time is multiplied to calculate the new one. This value applies globally for static routes in the system.

Range1 to 10

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

All

route [ip-prefix] (ipv4-prefix | ipv6-prefix) route-type keyword
Synopsis Enter the route list instance
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword
Treeroute
Introduced16.0.R1

Platforms

All

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis IP prefix and prefix length for the static routes
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword
Treeroute

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

route-type keyword
Synopsis Static route type for unicast or multicast RPF
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword
Treeroute
Optionsunicast, multicast

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

backup-tag number
Synopsis Static route backup tag
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword backup-tag number
Treebackup-tag

Description

This command associates a 4-byte backup route tag with the static route when the backup next-hop functionality is activated. The tag value is used in route policies to control distribution of the static route into other protocols when the backup next-hop function is activated for the associated static route.

The tag specified at this level of the static route causes the tag values that are configured under the next-hop, black-hole, and indirect contexts of the static route to be ignored.

Range1 to 4294967295
Introduced21.2.R1

Platforms

All

blackhole
Synopsis Enable the blackhole context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword blackhole
Treeblackhole
Introduced16.0.R1

Platforms

All

prefix-list
Synopsis Enter the prefix-list context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword blackhole prefix-list
Treeprefix-list
Introduced16.0.R1

Platforms

All

community string
Synopsis Community ID associated with the static route
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword community string
Treecommunity
String Length1 to 72
Max. Instances12

Notes

This element is ordered by the user.

Introduced16.0.R1

Platforms

All

indirect [ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the indirect list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone)
Treeindirect
Introduced16.0.R1

Platforms

All

[ip-address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Next-hop IP address used to reach the destination
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone)
Treeindirect

Description

This command specifies the next-hop IP address used to reach the destination. The specified IP address can be either on the network side or the access side and is typically at least one hop away from the node.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the static route operation
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) admin-state keyword
Treeadmin-state
Optionsenable, disable
Introduced 16.0.R1

Platforms

All

community string
Synopsis Community ID associated with the static route
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) community string
Treecommunity
String Length1 to 72
Introduced16.0.R1

Platforms

All

cpe-check [address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the cpe-check list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone)
Treecpe-check

Description

When configured, this command enables the Customer Premises Equipment (CPE) check feature and specifies the IP address of the target CPE device.

This option initiates a background ICMP ping test to the configured target IP address. The IP address can either be an IPv4 address for IPv4 static routes or an IPv6 address for IPv6 static routes. To avoid possible circular references, the target IP address cannot exist in the same subnet as the static route subnet. This command is mutually exclusive with BFD support on a specific static route.

Note: A node that is sourcing CPE-check packets waits an additional full interval before taking action, which gives the CPE time to respond. For example, with a drop-count of 3 and an interval of 1s, three CPE-check packets are sent out and the node waits for the duration of another interval before acting on the loss. Failure declaration may take extra time depending on the load, interval, and other factors. In line with multitasking, multi-priority operating principles of the node, and the relative priority of cpe-ping, the node paces these minor events.

Max. Instances1
Introduced16.0.R1

Platforms

All

[address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the target CPE device
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone)
Treecpe-check

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

drop-count number
Synopsis Consecutive ping replies missed before CPE deemed down
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) drop-count number
Treedrop-count
Range1 to 255
Default3
Introduced 16.0.R1

Platforms

All

interval number
Synopsis Interval between ICMP pings to target CPE IP address
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) interval number
Treeinterval
Range1 to 255
Unitsseconds
Default 1
Introduced16.0.R1

Platforms

All

log boolean
Synopsis Log CPE connectivity checks transitions
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) log boolean
Treelog
Defaultfalse
Introduced16.0.R1

Platforms

All

padding-size number
Synopsis Padding size for CPE connectivity checks
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) padding-size number
Treepadding-size
Range0 to 16384
Unitsbytes
Default 56
Introduced16.0.R1

Platforms

All

metric number
Synopsis Static route metric
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) metric number
Treemetric
Range0 to 65535
Default1
Introduced 16.0.R1

Platforms

All

preference number
Synopsis Priority of this static route over the routes from different sources
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) preference number
Treepreference
Range1 to 255
Default5
Introduced 16.0.R1

Platforms

All

prefix-list
Synopsis Enter the prefix-list context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) prefix-list
Treeprefix-list
Introduced16.0.R1

Platforms

All

flag keyword
Synopsis Static route match condition from prefix list
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) prefix-list flag keyword
Treeflag
Optionsany, all, none
Defaultany
Introduced16.0.R1

Platforms

All

qos
Synopsis Enter the qos context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) qos
Treeqos
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

forwarding-class keyword
Synopsis Forwarding class associated with the static route
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) qos forwarding-class keyword
Treeforwarding-class
Optionsbe, l2, af, l1, h2, ef, h1, nc
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

priority keyword
Synopsis Static route priority
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) qos priority keyword
Treepriority
Optionslow, high
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

source-class number
Synopsis Source class for the static route
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) source-class number
Treesource-class
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

tag number
Synopsis Static route tag
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tag number
Treetag
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

tunnel-next-hop
Synopsis Enter the tunnel-next-hop context
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tunnel-next-hop
Treetunnel-next-hop
Introduced16.0.R1

Platforms

All

resolution-filter
Synopsis Enter the resolution-filter context
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tunnel-next-hop resolution-filter
Treeresolution-filter
Introduced16.0.R1

Platforms

All

rsvp-te
Synopsis Enable the rsvp-te context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tunnel-next-hop resolution-filter rsvp-te
Treersvp-te
Introduced16.0.R1

Platforms

All

lsp [lsp-name] string
Synopsis Add a list entry for lsp
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tunnel-next-hop resolution-filter rsvp-te lsp string
Treelsp
Introduced16.0.R1

Platforms

All

sr-te
Synopsis Enable the sr-te context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tunnel-next-hop resolution-filter sr-te
Treesr-te
Introduced16.0.R1

Platforms

All

lsp [lsp-name] string
Synopsis Add a list entry for lsp
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword indirect (ipv4-address-no-zone | ipv6-address-no-zone) tunnel-next-hop resolution-filter sr-te lsp string
Treelsp
Introduced16.0.R1

Platforms

All

interface [interface-name] string
Synopsis Enter the interface list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string
Treeinterface
Introduced16.0.R1

Platforms

All

[interface-name] string
Synopsis Router interface name
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string
Treeinterface
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

cpe-check [address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the cpe-check list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string cpe-check (ipv4-address-no-zone | ipv6-address-no-zone)
Treecpe-check
Max. Instances1
Introduced16.0.R1

Platforms

All

[address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the target CPE device
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string cpe-check (ipv4-address-no-zone | ipv6-address-no-zone)
Treecpe-check

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

interval number
Synopsis Interval between ICMP pings to target CPE IP address
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) interval number
Treeinterval
Range1 to 255
Unitsseconds
Default 1
Introduced16.0.R1

Platforms

All

log boolean
Synopsis Log CPE connectivity checks transitions
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) log boolean
Treelog
Defaultfalse
Introduced16.0.R1

Platforms

All

prefix-list
Synopsis Enter the prefix-list context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string prefix-list
Treeprefix-list
Introduced16.0.R1

Platforms

All

qos
Synopsis Enter the qos context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword interface string qos
Treeqos
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

ipsec-tunnel [ipsec-tunnel-name] string
Synopsis Enter the ipsec-tunnel list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword ipsec-tunnel string
Treeipsec-tunnel
Introduced22.7.R1

Platforms

VSR

next-hop [ip-address] (ipv4-address-with-zone | ipv6-address-with-zone)
Synopsis Enter the next-hop list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone)
Treenext-hop
Introduced16.0.R1

Platforms

All

[ip-address] (ipv4-address-with-zone | ipv6-address-with-zone)
Synopsis IP address of the directly-connected next hop
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone)
Treenext-hop

Description

This command specifies the IP address of the directly-connected next hop. The IP address can either be on the network side or the access side on the node. The address must be associated with a network directly connected to a network configured on the node.

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

admin-state keyword
Synopsis Administrative state of the static route operation
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) admin-state keyword
Treeadmin-state
Optionsenable, disable
Introduced 16.0.R1

Platforms

All

backup-next-hop
Synopsis Enter the backup-next-hop context
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) backup-next-hop
Treebackup-next-hop

Description

Commands in this context configure static route entry fast failover.

Introduced21.2.R1

Platforms

All

address (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Backup next-hop IP address
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) backup-next-hop address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeaddress

Description

This command specifies the backup IP forwarding address that is used for static route Fast ReRoute (FRR). The configured address, if reachable, acts as pre-installed backup forwarding information that can be used when the primary IP next-hop suddenly fails.

The configured backup next-hop IP address can be directly or indirectly connected (using an IGP or tunnel) to the node. The backup next-hop forwarding information or the Next-hop Label Forwarding Entry (NHLFE) tunnel forwarding information from the IP Routing Table Manager (RTM) is used to preconfigure an IP fast-reroute backup path.

One backup next-hop address can protect a single primary static route entry next-hop address without ECMP and it is only activated when the primary next-hop has no active ECMP.

The configured IP address can be either on the network or the access side.

Introduced21.2.R1

Platforms

All

community string
Synopsis Community ID associated with the static route
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) community string
Treecommunity
String Length1 to 72
Introduced16.0.R1

Platforms

All

cpe-check [address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis Enter the cpe-check list instance
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone)
Treecpe-check

Description

When configured, this command enables the Customer Premises Equipment (CPE) check feature and specifies the IP address of the target CPE device.

This option initiates a background ICMP ping test to the configured target IP address. The IP address can either be an IPv4 address for IPv4 static routes or an IPv6 address for IPv6 static routes. To avoid possible circular references, the target IP address cannot exist in the same subnet as the static route subnet. This command is mutually exclusive with BFD support on a specific static route.

Note: A node that is sourcing CPE-check packets waits an additional full interval before taking action, which gives the CPE time to respond. For example, with a drop-count of 3 and an interval of 1s, three CPE-check packets are sent out and the node waits for the duration of another interval before acting on the loss. Failure declaration may take extra time depending on the load, interval, and other factors. In line with multitasking, multi-priority operating principles of the node, and the relative priority of cpe-ping, the node paces these minor events.

Max. Instances1
Introduced16.0.R1

Platforms

All

[address] (ipv4-address-no-zone | ipv6-address-no-zone)
Synopsis IP address of the target CPE device
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone)
Treecpe-check

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

drop-count number
Synopsis Consecutive ping replies missed before CPE deemed down
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) drop-count number
Treedrop-count
Range1 to 255
Default3
Introduced 16.0.R1

Platforms

All

interval number
Synopsis Interval between ICMP pings to target CPE IP address
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) interval number
Treeinterval
Range1 to 255
Unitsseconds
Default 1
Introduced16.0.R1

Platforms

All

log boolean
Synopsis Log CPE connectivity checks transitions
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) log boolean
Treelog
Defaultfalse
Introduced16.0.R1

Platforms

All

padding-size number
Synopsis Padding size for CPE connectivity checks
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) cpe-check (ipv4-address-no-zone | ipv6-address-no-zone) padding-size number
Treepadding-size
Range0 to 16384
Unitsbytes
Default 56
Introduced16.0.R1

Platforms

All

ldp-sync boolean
Synopsis Use LDP synchronization feature for a static route
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) ldp-sync boolean
Treeldp-sync
Defaultfalse
Introduced16.0.R1

Platforms

All

metric number
Synopsis Static route metric
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) metric number
Treemetric
Range0 to 65535
Default1
Introduced 16.0.R1

Platforms

All

preference number
Synopsis Priority of this static route over the routes from different sources
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) preference number
Treepreference
Range1 to 255
Default5
Introduced 16.0.R1

Platforms

All

prefix-list
Synopsis Enter the prefix-list context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) prefix-list
Treeprefix-list
Introduced16.0.R1

Platforms

All

flag keyword
Synopsis Static route match condition from prefix list
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) prefix-list flag keyword
Treeflag
Optionsany, all, none
Defaultany
Introduced16.0.R1

Platforms

All

qos
Synopsis Enter the qos context
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) qos
Treeqos
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

forwarding-class keyword
Synopsis Forwarding class associated with the static route
Contextconfigure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) qos forwarding-class keyword
Treeforwarding-class
Optionsbe, l2, af, l1, h2, ef, h1, nc
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

priority keyword
Synopsis Static route priority
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) qos priority keyword
Treepriority
Optionslow, high
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

source-class number
Synopsis Source class for the static route
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) source-class number
Treesource-class
Range1 to 255
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-s, 7950 XRS

tag number
Synopsis Static route tag
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword next-hop (ipv4-address-with-zone | ipv6-address-with-zone) tag number
Treetag
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

tag number
Synopsis Static route tag
Context configure router string static-routes route (ipv4-prefix | ipv6-prefix) route-type keyword tag number
Treetag
Range1 to 4294967295
Introduced16.0.R1

Platforms

All

subscriber-mgmt

Synopsis Enter the subscriber-mgmt context
Contextconfigure router string subscriber-mgmt
Treesubscriber-mgmt
Introduced23.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

dhcpv4
Synopsis Enter the dhcpv4 context
Context configure router string subscriber-mgmt dhcpv4
Treedhcpv4
Introduced23.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

routed-subnet-transparent-forward boolean
Synopsis Transparently forward DHCPv4 from CPE LAN over IPoE
Contextconfigure router string subscriber-mgmt dhcpv4 routed-subnet-transparent-forward boolean
Treerouted-subnet-transparent-forward

Description

When configured to true, the router transparently forwards DHCPv4 packets received on a subscriber interface with a source IP in a routed subnet that is associated with a routed IPoE session or host.

Supported routed subnets are:

  • RADIUS and NASREQ framed routes

  • routes learned via an ESM dynamic BGP peer

  • managed routes that are associated with a static IPv4 host

When configured to false, the system disables transparent forwarding of DHCPv4 packets.

Defaultfalse
Introduced23.3.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

triggered-policy boolean

Synopsis Trigger route policy re-evaluation
Context configure router string triggered-policy boolean
Treetriggered-policy
Defaultfalse
Introduced16.0.R1

Platforms

All

ttl-propagate

Synopsis Enter the ttl-propagate context
Contextconfigure router string ttl-propagate
Treettl-propagate
Introduced16.0.R1

Platforms

All

vprn-local keyword
Synopsis TTL propagation from IP header into label stack for VPRN local packets
Contextconfigure router string ttl-propagate vprn-local keyword
Treevprn-local
Optionsnone, all, vc-only
Defaultvc-only
Introduced16.0.R1

Platforms

All

vprn-transit keyword
Synopsis TTL propagation from IP header into label stack for VPRN transit packets
Contextconfigure router string ttl-propagate vprn-transit keyword
Treevprn-transit
Optionsnone, all, vc-only
Defaultvc-only
Introduced16.0.R1

Platforms

All

tunnel-interface

Synopsis Enter the tunnel-interface context
Contextconfigure router string tunnel-interface
Treetunnel-interface
Introduced16.0.R1

Platforms

All

ldp-p2mp-leaf [p2mp-id] number sender-address string
Synopsis Enter the ldp-p2mp-leaf list instance
Contextconfigure router string tunnel-interface ldp-p2mp-leaf number sender-address string
Treeldp-p2mp-leaf
Introduced16.0.R1

Platforms

All

ldp-p2mp-root [p2mp-id] number sender-address string
Synopsis Enter the ldp-p2mp-root list instance
Contextconfigure router string tunnel-interface ldp-p2mp-root number sender-address string
Treeldp-p2mp-root
Introduced16.0.R1

Platforms

All

rsvp-p2mp-leaf [lsp-name] string sender-address string
Synopsis Enter the rsvp-p2mp-leaf list instance
Contextconfigure router string tunnel-interface rsvp-p2mp-leaf string sender-address string
Treersvp-p2mp-leaf
Introduced16.0.R1

Platforms

All

rsvp-p2mp-root [lsp-name] string
Synopsis Enter the rsvp-p2mp-root list instance
Contextconfigure router string tunnel-interface rsvp-p2mp-root string
Treersvp-p2mp-root
Introduced16.0.R1

Platforms

All

[lsp-name] string
Synopsis LSP name of the P2MP RSVP tunnel interface
Contextconfigure router string tunnel-interface rsvp-p2mp-root string
Treersvp-p2mp-root
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

All

twamp-light

Synopsis Enter the twamp-light context
Context configure router string twamp-light
Treetwamp-light
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

reflector
Synopsis Enable the reflector context
Context configure router string twamp-light reflector
Treereflector
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

admin-state keyword
Synopsis Administrative state of TWAMP Light functionality
Contextconfigure router string twamp-light reflector admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

allow-ipv6-udp-checksum-zero boolean
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisProcess IPv6 packets with a zero UDP checksum
Contextconfigure router string twamp-light reflector allow-ipv6-udp-checksum-zero boolean
Treeallow-ipv6-udp-checksum-zero

Description

When configured to true, this command allows the processing of IPv6 packets that arrive with a UDP checksum of zero. The destination UDP ports that are registered as TWAMP Test packets as part of this template allow this behavior. 

When configured to false, IPv6 packets that arrive with a UDP checksum of zero are discarded.

Defaultfalse
Introduced21.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

description string
Synopsis Text description
Context configure router string twamp-light reflector description string
Treedescription
String Length1 to 80
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

prefix [ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Enter the prefix list instance
Contextconfigure router string twamp-light reflector prefix (ipv4-prefix | ipv6-prefix)
Treeprefix
Max. Instances50
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

[ip-prefix] (ipv4-prefix | ipv6-prefix)
Synopsis Source prefix for the TWAMP-Light reflector
Contextconfigure router string twamp-light reflector prefix (ipv4-prefix | ipv6-prefix)
Treeprefix

Notes

This element is part of a list key.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

description string
Synopsis Text description
Context configure router string twamp-light reflector prefix (ipv4-prefix | ipv6-prefix) description string
Treedescription
String Length1 to 80
Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

type keyword
Synopsis Processing behavior type for the reflector
Contextconfigure router string twamp-light reflector type keyword
Treetype

Description

This command configures the processing behavior of the TWAMP Light reflector. When the value is twamp-light the reflector does not check the received PDU as a traditional base TWAMP Light packet without TLV processing. When the value is stamp, the reflector attempts to find and process supported STAMP TLVs that follow the base STAMP packet. 

In mixed environments where different types of Session-Senders may be targeting a common TWAMP Light reflector, set the value to stamp. When the reflector is operating in stamp mode, the primary parsing is based on STAMP, checking and processing known TLVs, or determining if the arriving PDU is a TWAMP Light PDU. A Session-Sender launching a TWAMP Light-based packet must use all zeros padding pattern when the pad size is non zero.

Optionsstamp, twamp-light
Default twamp-light
Introduced22.7.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

udp-port number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUDP port on which the specified TWAMP-Light reflector listens for TWAMP PDUs
Contextconfigure router string twamp-light reflector udp-port number
Treeudp-port
Range862 | 64364 to 64373

Notes

This element is mandatory.

Introduced16.0.R4

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, 7950 XRS

vrgw

Synopsis Enter the vrgw context
Context configure router string vrgw
Treevrgw
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

lanext
Synopsis Enable the lanext context
Context configure router string vrgw lanext
Treelanext
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of Home LAN Extension
Contextconfigure router string vrgw lanext admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

vxlan-port number
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUDP port to be used by local or remote VXLAN VTEP
Contextconfigure router string vrgw lanext vxlan-port number
Treevxlan-port
Range4789 | 8472
Default4789
Introduced 16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

vxlan-vtep-range
Synopsis Enter the vxlan-vtep-range context
Contextconfigure router string vrgw lanext vxlan-vtep-range
Treevxlan-vtep-range
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

end (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisUpper bound of the VXLAN VTEP range
Contextconfigure router string vrgw lanext vxlan-vtep-range end (ipv4-address-no-zone | ipv6-address-no-zone)
Treeend
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

start (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisLower bound of the VXLAN VTEP range
Contextconfigure router string vrgw lanext vxlan-vtep-range start (ipv4-address-no-zone | ipv6-address-no-zone)
Treestart
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

wlan-gw-group reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisWLAN-GW group used for Home LAN Extension
Contextconfigure router string vrgw lanext wlan-gw-group reference
Treewlan-gw-group

Reference

configure isa wlan-gw-group number

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

weighted-ecmp keyword

Synopsis Weighted load-balancing capability for ECMP routes
Contextconfigure router string weighted-ecmp keyword
Treeweighted-ecmp
Optionsfalse, true, strict
Defaultfalse
Introduced16.0.R1

Platforms

All

wlan-gw

Synopsis Enable the wlan-gw context
Context configure router string wlan-gw
Treewlan-gw
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

distributed-subscriber-mgmt
Synopsis Enter the distributed-subscriber-mgmt context
Contextconfigure router string wlan-gw distributed-subscriber-mgmt
Treedistributed-subscriber-mgmt
Introduced16.0.R4

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

mobility-triggered-accounting
Synopsis Enter the mobility-triggered-accounting context
Contextconfigure router string wlan-gw mobility-triggered-accounting
Treemobility-triggered-accounting
Introduced16.0.R4

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

xconnect
Synopsis Enter the xconnect context
Context configure router string wlan-gw xconnect
Treexconnect
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the WLAN-GW cross-connect
Contextconfigure router string wlan-gw xconnect admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

tunnel-source-ip string
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisIPv6 address and prefix for the tunnel source
Contextconfigure router string wlan-gw xconnect tunnel-source-ip string
Treetunnel-source-ip
Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

wlan-gw-group reference
WARNING:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

SynopsisISA WLAN-GW Group
Contextconfigure router string wlan-gw xconnect wlan-gw-group reference
Treewlan-gw-group

Reference

configure isa wlan-gw-group number

Introduced16.0.R1

Platforms

7750 SR, 7750 SR-e, 7750 SR-s, VSR

wpp

Synopsis Enable the wpp context
Context configure router string wpp
Treewpp
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of WPP
Context configure router string wpp admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

portal [name] string
Synopsis Enter the portal list instance
Contextconfigure router string wpp portal string
Treeportal
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

[name] string
Synopsis Web portal name
Context configure router string wpp portal string
Treeportal
String Length1 to 32

Notes

This element is part of a list key.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ack-auth-retry-count number
Synopsis Number of retransmissions of an ACK_OUT message
Contextconfigure router string wpp portal string ack-auth-retry-count number
Treeack-auth-retry-count
Range0 to 5
Default5
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

address (ipv4-address-no-zone | ipv6-address-no-zone)
WARNING:

Modifying this element recreates the parent element automatically for the new value to take effect.

SynopsisWPP portal address
Contextconfigure router string wpp portal string address (ipv4-address-no-zone | ipv6-address-no-zone)
Treeaddress

Notes

This element is mandatory.

Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

admin-state keyword
Synopsis Administrative state of the WPP portal server
Contextconfigure router string wpp portal string admin-state keyword
Treeadmin-state
Optionsenable, disable
Default disable
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

ntf-logout-retry-count number
Synopsis Number of retransmissions of an NTF_LOGOUT message
Contextconfigure router string wpp portal string ntf-logout-retry-count number
Treentf-logout-retry-count
Range0 to 5
Default5
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

port-format keyword
Synopsis Format of the port in the ACK_INO message
Contextconfigure router string wpp portal string port-format keyword
Treeport-format
Optionsstandard, vendor-specific
Defaultstandard
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

retry-interval number
Synopsis Time between two consecutive retransmissions
Contextconfigure router string wpp portal string retry-interval number
Treeretry-interval
Range10 to 2000
Unitsmilliseconds
Default 2000
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

secret string
Synopsis Message authentication between portal and BRAS by applying the secret used by WPPv2
Contextconfigure router string wpp portal string secret string
Treesecret
String Length1 to 115
Introduced16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR

version number
Synopsis Protocol version to be expected by the WPP portal
Contextconfigure router string wpp portal string version number
Treeversion
Range1 | 2
Default1
Introduced 16.0.R1

Platforms

7450 ESS, 7750 SR, 7750 SR-a, 7750 SR-e, 7750 SR-s, VSR