5.15. BGP Command Reference

5.15.1. Command Hierarchies

5.15.1.1. Global BGP Commands

config
— router [router-name]
confederation confed-as-num members as-number [as-number]
— no confederation [confed-as-num members as-number [as-number]]
router-id id-address
— no router-id
[no] bgp
[no] add-paths
ipv4 send send-limit receive [none]
ipv4 send send-limit
— no ipv4
ipv6 send send-limit receive [none]
ipv6 end send-limit
— no ipv6
label-ipv4 send send-limit [receive [none]]
— no label-ipv4
label-ipv6 send send-limit [receive [none]]
— no label-ipv6
vpn-ipv4 [send send-limit receive [none]
vpn-ipv4 end send-limit
— no vpn-ipv4
vpn-ipv6 send send-limit receive [none]
vpn-ipv6 end send-limit
— no vpn-ipv6
[no] advertise-external [ipv4] [label-ipv4] [ipv6] [label-ipv6]
auth-keychain name
authentication-key [authentication-key | hash-key] [hash | hash2]
[no] backup-path [ipv4] [label-ipv4] [ipv6] [label-ipv6]
always-compare-med {zero | infinity}
always-compare-med strict-as {zero | infinity}
as-path-ignore [ipv4] [label-ipv4] [vpn-ipv4] [label-ipv6] [ipv6] [vpn-ipv6] [mcast-ipv4] [mvpn-ipv4] [l2-vpn] [mvpn-ipv6] [mcast-ipv6]
ebgp-ibgp-equal [ipv4] [ipv6] [label-ipv4] [label-ipv6] [vpn-ipv4] [vpn-ipv6]
ignore-router-id include-internal family [family]
[no] bfd-enable
cluster ip-address [orr-location location-id [allow-local-fallback]]
— no cluster
connect-retry seconds
damp-peer-oscillations [idle-hold-time initial-wait second-wait max-wait] [error-interval minutes]
[no] damping
description description-string
disable-communities [standard] [extended]
export plcy-or-long-expr [plcy-or-expr [plcy-or-expr]]
— no export
family [ipv4] [label-ipv4] [vpn-ipv4] [ipv6] [label-ipv6] [vpn-ipv6] [mcast-ipv4] [l2-vpn] [mvpn-ipv4] [mvpn-ipv6] [mdt-safi] [ms-pw] [flow-ipv4] [flow-ipv6] [route-target] [mcast-vpn-ipv4] [evpn] [mcast-ipv6] [bgp-ls]
— no family
restart-time seconds
hold-time seconds [min seconds2]
— no hold-time
import plcy-or-long-expr [plcy-or-expr [plcy-or-expr]]
— no import
keepalive seconds
— no keepalive
local-as as-number [private] [no-prepend-global-as]
— no local-as
local-preference local-preference
loop-detect {drop-peer | discard-route | ignore-loop | off}
med-out {number | igp-cost}
— no med-out
[no] mp-bgp-keep
multihop ttl-value
— no multihop
multipath max-paths [ebgp ebgp-max-paths] [ibgp ibgp-max-paths] [restrict {same-neighbor-as | exact-as-path}]
— no multipath
[no] allow-static
family {label-ipv4 | label-ipv6 | vpn}
resolution {any | filter | disabled}
[no] bgp
[no] ldp
[no] rsvp
[no] sr-isis
[no] sr-ospf
[no] sr-te
policy policy-name
— no policy
family {ipv4}
[no] disallow-igp
resolution {any | filter | disabled}
[no] bgp
[no] ldp
[no] rsvp
[no] sr-isis
[no] sr-ospf
[no] sr-te
location location-id
primary-ip-address ipv4-address
secondary-ip-address ipv4-address
tertiary-ip-address ipv4-address
spf-wait max-wait [initial-wait initial-wait] [second-wait second-wait]
— no spf-wait
[no] accept-orf
send-orf [comm-id]
— no send-orf comm-id
peer-tracking-policy policy-name
preference preference
— no preference
purge-timer minutes
rapid-update [l2-vpn] [mdt-safi] [mvpn-ipv4] [mvpn-ipv6] [mdt-safi] [evpn] [label-ipv4] [label-ipv6] [mcast-vpn-ipv4] [mcast-vpn-ipv6]
— no rapid-update
[no] remove-private [limited] [skip-peer-as]
— ipv4
leak-import plcy-or-long-expr [plcy-or-expr]
route-table-import policy-name
— ipv6
leak-import plcy-or-long-expr [plcy-or-expr]
route-table-import policy-name
— label-ipv4
leak-import plcy-or-long-expr [plcy-or-expr]
route-table-import policy-name
— label-ipv6
route-table-import policy-name
route-target-list comm-id [comm-id]
— no route-target-list [comm-id]
router-id ip-address
— no router-id
[no] shutdown
[no] split-horizon

5.15.1.2. Group BGP Commands

config
— router [router-name]
[no] bgp
[no] group name
[no] add-paths
ipv4 send send-limit receive [none]
ipv4 send send-limit
— no ipv4
ipv6 send send-limit receive [none]
ipv6 end send-limit
— no ipv6
label-ipv4 send send-limit [receive [none]]
— no label-ipv4
label-ipv6 send send-limit [receive [none]]
— no label-ipv6
vpn-ipv4 [send send-limit receive [none]
vpn-ipv4 end send-limit
— no vpn-ipv4
vpn-ipv6 send send-limit receive [none]
vpn-ipv6 end send-limit
— no vpn-ipv6
[no] aigp
authentication-key [authentication-key | hash-key] [hash | hash2]
auth-keychain name
[no] bfd-enable
cluster ip-address [orr-location location-id [allow-local-fallback]]
— no cluster
connect-retry seconds
[no] damp-peer-oscillations [idle-hold-time initial-wait second-wait max-wait] [error-interval minutes]
[no] damping
description description-string
disable-communities [standard] [extended]
[no] prefix ip-prefix/prefix-length
ebgp-link-bandwidth [ipv4] [label-ipv4] [vpn-ipv4] [label-ipv6] [ipv6] [vpn-ipv6]
enable-origin-validation [ipv4] [label-ipv4] [label-ipv6] [ipv6]
export plcy-or-long-expr [plcy-or-expr [plcy-or-expr]]
— no export
family [ipv4] [label-ipv4] [vpn-ipv4] [label-ipv6] [ipv6] [vpn-ipv6] [mcast-ipv4] [l2-vpn] [mvpn-ipv4] [mvpn-ipv6] [flow-ipv4] [flow-ipv6] [mdt-safi] [route target] [mcast-vpn-ipv4] [evpn] [mcast-ipv6] [bgp-ls]
— no family
restart-time seconds
hold-time seconds [min seconds2]
— no hold-time
import plcy-or-long-expr [plcy-or-expr [plcy-or-expr]]
— no import
keepalive seconds
— no keepalive
local-address ip-address
local-as as-number [private] [no-prepend-global-as]
— no local-as
local-preference local preference
loop-detect {drop-peer | discard-route | ignore-loop | off}
med-out {number | igp-cost}
— no med-out
multihop ttl-value
— no multihop
[no] next-hop-self
next-hop-unchanged [label-ipv4] [label-ipv6]
[no] accept-orf
send-orf [comm-id]
— no send-orf [comm-id]
[no] passive
peer-as as-number
— no peer-as
preference preference
— no preference
prefix-limit family limit [log-only] [threshold percentage] [idle-timeout {minutes | forever}] [post-import]
— no prefix-limit family
[no] remove-private {limited} {skip-peer-as}
[no] shutdown
[no] split-horizon
ttl-security min-ttl-value
type {internal | external}
— no type

5.15.1.3. Neighbor BGP Commands

config
— router [router-name]
[no] bgp
[no] group name
[no] neighbor ip-address
[no] add-paths
ipv4 send send-limit receive [none]
ipv4 send send-limit
— no ipv4
ipv6 send send-limit receive [none]
ipv6 end send-limit
— no ipv6
label-ipv4 send send-limit [receive [none]]
— no label-ipv4
label-ipv6 send send-limit [receive [none]]
— no label-ipv6
vpn-ipv4 [send send-limit receive [none]
vpn-ipv4 end send-limit
— no vpn-ipv4
vpn-ipv6 send send-limit receive [none]
vpn-ipv6 end send-limit
— no vpn-ipv6
[no] aigp
auth-keychain name
authentication-key [authentication-key | hash-key] [hash | hash2]
[no] bfd-enable
cluster ip-address [orr-location location-id [allow-local-fallback]]
— no cluster
connect-retry seconds
[no] damp-peer-oscillations [idle-hold-time initial-wait second-wait max-wait] [error-interval minutes]
[no] damping
description description-string
disable-communities [standard] [extended]
ebgp-link-bandwidth family [family]
enable-origin-validation [ipv4] [ipv6] [label-ipv4] [label-ipv6]
export plcy-or-long-expr [plcy-or-expr [plcy-or-expr]]
— no export
family [ipv4] [label-ipv4] [vpn-ipv4] [label-ipv6] [ipv6] [vpn-ipv6] [mcast-ipv4] [mvpn-ipv6] [flow-ipv4] [flow-ipv6] [mdt-safi] [route-target] [mcast-vpn-ipv4] [evpn] [mcast-ipv6] [bgp-ls]
— no family
restart-time seconds
hold-time seconds [strict]
— no hold-time
import plcy-or-long-expr [plcy-or-expr [plcy-or-expr]]
— no import
keepalive seconds
— no keepalive
local-address ip-address
local-as as-number [private] [no-prepend-global-as]
— no local-as
local-preference local-preference
loop-detect {drop-peer | discard-route | ignore-loop | off}
med-out {number | igp-cost}
— no med-out
multihop ttl-value
— no multihop
[no] next-hop-self
next-hop-unchanged [label-ipv4] [label-ipv6]
[no] accept-orf
send-orf [comm-id]
— no send-orf [comm-id]
[no] passive
peer-as as-number
— no peer-as
preference preference
— no preference
prefix-limit family limit [log-only] [threshold percentage] [idle-timeout {minutes | forever}] [post-import]
— no prefix-limit family
[no] remove-private {limited} {skip-peer-as}
[no] shutdown
[no] split-horizon
ttl-security min-ttl-value
type {internal | external}
— no type

5.15.1.4. Other BGP-Related Commands

config
— router [router-name]
autonomous-system as-number
router-id ip-address
— no router-id

5.15.2. Command Descriptions

5.15.2.1. Generic Commands

shutdown

Syntax 
[no] shutdown
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command administratively disables an entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.

The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they may be deleted.

The no form of this command administratively enables an entity.

Unlike other commands and parameters where the default state is not indicated in the configuration file, the shutdown and no shutdown states are always indicated in system generated configuration files.

Default administrative states for services and service entities are described in Special Cases.

The no form of the command places an entity in an administratively enabled state.

Special Cases 
BGP Global—
The BGP protocol is created in the no shutdown state.
BGP Group—
BGP groups are created in the no shutdown state.
BGP Neighbor—
BGP neighbors/peers are created in the no shutdown state.

description

Syntax 
description description-string
no description
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command creates a text description stored in the configuration file for a configuration context.

The no form of the command removes the description string from the context.

Default 

no description

Parameters 
string—
The description character string. Allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

5.15.2.2. BGP Commands

bgp

Syntax 
[no] bgp
Context 
config>router
Description 

This command creates the BGP protocol instance and BGP configuration context. BGP is administratively enabled upon creation.

The no form of the command deletes the BGP protocol instance and removes all configuration parameters for the BGP instance. BGP must be shutdown before deleting the BGP instance. An error occurs if BGP is not shutdown first.

add-paths

Syntax 
[no] add-paths
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command allows adds the add-paths node to be the configured for one or more families configuration of the BGP instance, a group or a neighbor. The BGP add-paths capability allows the router to send and/or receive multiple paths per prefix to/from a peer.The add-paths command without additional parameters is equivalent to removing Add-Paths support for all address families, which causes sessions that previously negotiated the add-paths capability for one or more address families to go down and come back up without the add-paths capability.

The no form of the command (no add-paths) removes add-paths from the configuration of BGP, the group or the neighbor, causing sessions established using add-paths to go down and come back up without the add-paths capability.

Default 

no add-paths

ipv4

Syntax 
ipv4 send send-limit receive [none]
ipv4 send send-limit
no ipv4
Context 
config>router>bgp>add-paths
config>router>bgp>group>add-paths
config>router>bgp>group>neighbor>add-paths
Description 

This command is used to configure the add-paths capability for unlabeled IPv4 unicast routes. By default, add-paths is not enabled for unlabeled IPv4 unicast routes.

The maximum number of unlabeled unicast paths per IPv4 prefix to send is the configured send limit, which is a mandatory parameter. The capability to receive multiple unlabeled IPv4 unicast paths per prefix from a peer is configurable using the receive keyword, which is optional. If the receive keyword is not included in the command the receive capability is enabled by default.

The no form of the command disables add-paths support for unlabeled IPv4 unicast routes, causing sessions established using add-paths for unlabeled IPv4 unicast to go down and come back up without the add-paths capability.

Default 

no ipv4

Parameters 
send send-limit
The maximum number of paths per unlabeled IPv4 unicast prefix that are allowed to be advertised to add-paths peers. (The actual number of advertised routes may be less.) If the value is none, the router does not negotiate the send capability with respect to IPv4 AFI/SAFI.
Values—
1 to 16, none

 

receive —
The router negotiates to receive multiple unlabeled unicast routes per IPv4 prefix.
none—
The router does not negotiate to receive multiple unlabeled unicast routes per IPv4 prefix.

ipv6

Syntax 
ipv6 send send-limit receive [none]
ipv6 send send-limit
no ipv6
Context 
config>router>bgp>add-paths
config>router>bgp>group>add-paths
config>router>bgp>group>neighbor>add-paths
Description 

This command is used to configure the add-paths capability for unlabeled IPv6 unicast routes. By default, add-paths is not enabled for unlabeled IPv6 unicast routes.

The maximum number of unlabeled unicast paths per IPv6 prefix to send is the configured send limit, which is a mandatory parameter. The capability to receive multiple unlabeled IPv6 unicast paths per prefix from a peer is configurable using the receive keyword, which is optional. If the receive keyword is not included in the command the receive capability is enabled by default.

The no form of the command disables add-paths support for unlabeled IPv6 unicast routes, causing sessions established using add-paths for unlabeled IPv6 unicast to go down and come back up without the add-paths capability.

Default 

no ipv6

Parameters 
send send-limit
The maximum number of paths per unlabeled IPv6 unicast prefix that are allowed to be advertised to add-paths peers. (The actual number of advertised routes may be less.) If the value is none, the router does not negotiate the send capability with respect to IPv6 AFI/SAFI.
Values—
1 to 16, none

 

receive —
The router negotiates to receive multiple unlabeled unicast routes per IPv6 prefix.
none—
The router does not negotiate to receive multiple unlabeled unicast routes per IPv6 prefix.

label-ipv4

Syntax 
label-ipv4 send send-limit receive [none]
label-ipv4 send send-limit
no label-ipv4
Context 
config>router>bgp>add-paths
config>router>bgp>group>add-paths
config>router>bgp>group>neighbor>add-paths
Description 

This command is used to configure the add-paths capability for labeled-unicast IPv4 routes. By default, add-paths is not enabled for labeled-unicast IPv4 routes.

The maximum number of labeled-unicast paths per IPv4 prefix to send is the configured send-limit, which is a mandatory parameter. The capability to receive multiple labeled-unicast paths per prefix from a peer is configurable using the receive keyword, which is optional. If the receive keyword is not included in the command, receive capability is enabled by default.

The no form of the command disables add-paths support for labeled-unicast IPv4 routes, causing sessions established using add-paths for labeled-unicast IPv4 to go down and come back up without the add-paths capability.

Default 

no label-ipv4

Parameters 
send-limit—
The maximum number of paths per labeled-unicast IPv4 prefix that are allowed to be advertised to add-paths peers. (The actual number of advertised routes may be less.) If the value is none, the router does not negotiate the send capability with respect to label-IPv4 AFI/SAFI.
Values—
1 to 16, none

 

receive —
The router negotiates to receive multiple labeled-unicast routes per IPv4 prefix.
none—
The router does not negotiate to receive multiple labeled-unicast routes per IPv4 prefix.

label-ipv6

Syntax 
label-ipv6 send send-limit receive [none]
label-ipv6 send send-limit
no label-ipv6
Context 
config>router>bgp>add-paths
config>router>bgp>group>add-paths
config>router>bgp>group>neighbor>add-paths
Description 

This command is used to configure the add-paths capability for labeled-unicast IPv6 routes. By default, add-paths is not enabled for labeled-unicast IPv6 routes.

The maximum number of labeled-unicast paths per IPv6 prefix to send is the configured send-limit, which is a mandatory parameter. The capability to receive multiple labeled-unicast paths per prefix from a peer is configurable using the receive keyword, which is optional. If the receive keyword is not included in the command, receive capability is enabled by default.

The no form of the command disables add-paths support for labeled-unicast IPv6 routes, causing sessions established using add-paths for labeled-unicast IPv6 to go down and come back up without the add-paths capability.

Default 

no label-ipv6

Parameters 
send-limit—
The maximum number of paths per labeled-unicast IPv6 prefix that are allowed to be advertised to add-paths peers. (The actual number of advertised routes may be less.) If the value is none, the router does not negotiate the send capability with respect to label-IPv6 AFI/SAFI.
Values—
1 to 16, none

 

receive —
The router negotiates to receive multiple labeled-unicast routes per IPv6 prefix.
none—
The router does not negotiate to receive multiple labeled-unicast routes per IPv6 prefix.

vpn-ipv4

Syntax 
vpn-ipv4 send send-limit receive [none]
vpn-ipv4 send send-limit
no vpn-ipv4
Context 
config>router>bgp>add-paths
config>router>bgp>group>add-paths
config>router>bgp>group>neighbor>add-paths
Description 

This command is used to configure the add-paths capability for VPN-IPv4 routes. By default, add-paths is not enabled for VPN-IPv4 routes.

The maximum number of paths per VPN-IPv4 NLRI to send is the configured send-limit, which is a mandatory parameter. The capability to receive multiple paths per prefix from a peer is configurable using the receive keyword, which is optional. If the receive keyword is not included in the command the receive capability is enabled by default.

The no form of the command disables add-paths support for VPN-IPv4 routes, causing sessions established using add-paths for VPN-IPv4 to go down and come back up without the add-paths capability.

Default 

no vpn-ipv4

Parameters 
send-limit—
The maximum number of paths per VPN-IPv4 NLRI that are allowed to be advertised to add-paths peers (the actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies and/or route advertisement rules).
Values—
1 to 16, none

 

receive —
The router negotiates the add-paths receive capability for VPN-IPv4 routes with its peers
none—
The router does not negotiate the Add-Paths receive capability for VPN-IPv4 routes with its peers.

vpn-ipv6

Syntax 
vpn-ipv6 send send-limit receive [none]
vpn-ipv6 send send-limit
no vpn-ipv6
Context 
config>router>bgp>add-paths
config>router>bgp>group>add-paths
config>router>bgp>group>neighbor>add-paths
Description 

This command is used to configure the add-paths capability for VPN-IPv6 routes. By default, add-paths is not enabled for VPN-IPv6 routes.

The maximum number of paths per VPN-IPv6 NLRI to send is the configured send-limit, which is a mandatory parameter. The capability to receive multiple paths per prefix from a peer is configurable using the receive keyword, which is optional. If the receive keyword is not included in the command the receive capability is enabled by default.

The no form of the command disables add-paths support for VPN-IPv6 routes, causing sessions established using add-paths for VPN-IPv6 to go down and come back up without the add-paths capability.

Default 

no vpn-ipv6

Parameters 
send-limit —
The maximum number of paths per VPN-IPv6 NLRI that are allowed to be advertised to add-paths peers (the actual number of advertised routes may be less depending on the next-hop diversity requirement, other configuration options, route policies and/or route advertisement rules).
Values—
1 to 16, none

 

receive —
The router negotiates the add-paths receive capability for VPN-IPv6 routes with its peers
none—
The router does not negotiate the add-paths receive capability for VPN-IPv6 routes with its peers.

advertise-external

Syntax 
[no] advertise-external [ipv4] [ipv6] [label-ipv4] [label-ipv6]
Context 
config>router>bgp
Description 

This command allows BGP to advertise its best external route to a destination even when its best overall route is an internal route. Entering the command (or its no form) with no address family parameters is equivalent to specifying all supported address families.

The no form of the command disables Advertise Best External for the BGP family.

Default 

no advertise-external

Parameters 
ipv4 —
Enable/disable best-external advertisement for unlabeled unicast IPv4 routes.
ipv6 —
Enable/disable best-external advertisement for unlabeled unicast IPv6 routes.
label-ipv4 —
Enable/disable best-external advertisement for labeled-unicast IPv4 routes.
label-ipv6 —
Enable/disable best-external advertisement for labeled-unicast IPv6 routes.

advertise-inactive

Syntax 
[no] advertise-inactive
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables the advertising of inactive BGP routes to other BGP peers. By default, BGP only advertises BGP routes to other BGP peers if a given BGP route is chosen by the route table manager as the most preferred route within the system and is active in the forwarding plane. This command allows system administrators to advertise a BGP route even though it is not the most preferred route within the system for a given destination.

The no form of the command disables the advertising of inactive BGP routers to other BGP peers.

Default 

no advertise-inactive

advertise-ldp-prefix

Syntax 
[no] advertise-ldp-prefix
Context 
config>router>bgp>group>neighbor
Description 

This command, when configured for a session that supports the IPv4 labeled-unicast address family, allows (subject to BGP export policies) active /32 LDP FEC prefixes to be advertised to the BGP peer with an RFC 3107 label, even though there may be BGP paths for the same prefix.

Default 

no advertise-ldp-prefix

aggregator-id-zero

Syntax 
[no] aggregator-id-zero
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command is used to set the router ID in the BGP aggregator path attribute to zero when BGP aggregates routes. This prevents different routers within an AS from creating aggregate routes that contain different AS paths.

When BGP is aggregating routes, it adds the aggregator path attribute to the BGP update messages. By default, BGP adds the AS number and router ID to the aggregator path attribute.

When this command is enabled, BGP adds the router ID to the aggregator path attribute. This command is used at the group level to revert to the value defined under the global level, while this command is used at the neighbor level to revert to the value defined under the group level.

The no form of the command used at the global level reverts to default where BGP adds the AS number and router ID to the aggregator path attribute.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no aggregator-id-zero

aigp

Syntax 
[no] aigp
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables or disables 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.

The effect of disabling AIGP (using the no form of the command or implicit) is to remove the AIGP attribute from advertised routes, if present, and to ignore the AIGP attribute in received routes.

Default 

no aigp

always-compare-med

Syntax 
always-compare-med {zero | infinity}
no always-compare-med strict-as {zero | infinity}
no always-compare-med
Context 
config>router>bgp>best-path-selection
config>service>vprn>bgp>best-path-selection
Description 

This command configures the comparison of BGP routes based on the MED attribute. The default behavior of SR-OS (equivalent to the no form of the command) is to only compare two routes on the basis of MED if they have the same neighbor AS (the first non-confed AS in the received AS_PATH attribute). Also by default, a route without a MED attribute is handled the same as though it had a MED attribute with the value 0. The always-compare-med command without the strict-as keyword allows MED to be compared even if the paths have a different neighbor AS; in this case, if neither zero or infinity is specified, the zero option is inferred, meaning a route without a MED is handled the same as though it had a MED attribute with the value 0. When the strict-as keyword is present, MED is only compared between paths from the same neighbor AS, and in this case, zero or infinity is mandatory and tells BGP how to interpret paths without a MED attribute.

Default 

no always-compare-med

Parameters 
zero—
Specifies that for routes learned without a MED attribute that a zero (0) value is used in the MED comparison. The routes with the lowest metric are the most preferred.
infinity—
Specifies for routes learned without a MED attribute that a value of infinity (2^32-1) is used in the MED comparison. This in effect makes these routes the least desirable.
strict-as—
Specifies BGP paths to be compared even with different neighbor AS.

as-path-ignore

Syntax 
as-path-ignore [ipv4] [label-ipv4] [vpn-ipv4] [ipv6] [label-ipv6] [vpn-ipv6] [mcast-ipv4] [mcast-ipv6] [mvpn-ipv4] [mvpn-ipv6] [l2-vpn]
no as-path-ignore
Context 
config>router>bgp>best-path-selection
Description 

This command configures whether AS path length is considered in the selection of the best BGP route for a prefix.

If an address family is listed in this command, then the length of AS paths is not a factor in the route selection process for routes of that address family.

The no form of the command removes the parameter from the configuration.

Default 

no as-path-ignore

Parameters 
ipv4—
Specifies that the AS-path length will be ignored for all unlabeled unicast IPv4 routes.
label-ipv4—
Specifies that the AS-path length will be ignored for all labeled-unicast IPv4 routes.
vpn-ipv4—
Specifies that the length AS-path will be ignored for all IPv4 VPRN (SAFI 128) routes.
ipv6—
Specifies that the AS-path length will be ignored for all unlabeled unicast IPv6 routes.
label-ipv6—
Specifies that the AS-path length will be ignored for all labeled-unicast IPv6 routes.
vpn-ipv6—
Specifies that the AS-path length will be ignored for all IPv6 VPRN (SAFI 128) routes.
mcast-ipv4—
Specifies that the AS-path length will be ignored for all IPv4 multicast routes.
mcast-ipv6—
Specifies that the AS-path length will be ignored for all IPv6 multicast routes.
mvpn-ipv4—
Specifies that the AS-path length will be ignored for all IPv4 MVPN routes.
mvpn-ipv6—
Specifies that the AS-path length will be ignored for all IPv6 MVPN routes.
l2-vpn —
The AS-path length will be ignored for all L2-VPN NLRIs.

compare-origin-validation-state

Syntax 
compare-origin-validation-state
no compare-origin-validation-state
Context 
config>router>bgp>best-path-selection
Description 

When this command is configured, a new step is inserted in the BGP decision process after removal of invalid routes and before the comparison of Local Preference. The new step compares the origin validation state so that a BGP route with a ‘Valid’ state is preferred over a BGP route with a ‘Not-Found’ state, and a BGP route with a ‘Not-Found’ state is preferred over a BGP route with an ‘Invalid’ state assuming that these routes are considered ‘usable’.

The new step is skipped when no compare-origin-validation-state is configured.

Default 

no compare-origin-validation-state

deterministic-med

Syntax 
[no] deterministic-med
Context 
config>router>bgp>best-path-selection
Description 

This command controls how the BGP decision process compares routes on the basis of MED. When deterministic-med is configured, BGP groups paths that are equal up to the MED comparison step based on neighbor AS, and then compares the best path from each group to arrive at the overall best path. This change to the BGP decision process makes best path selection completely deterministic in all cases. Without deterministic-med, the overall best path selection is sometimes dependent on the order of the route arrival because of the rule that MED cannot be compared in routes from different neighbor AS.

Default 

no deterministic-med

ebgp-ibgp-equal

Syntax 
ebgp-ibgp-equal [ipv4] [ipv6] [label-ipv4] [label-ipv6] [vpn-ipv4] [vpn-ipv6]
no ebgp-ibgp-equal
Context 
config>router>bgp>best-path-selection
Description 

This command instructs the BGP decision process to ignore the difference between EBGP and IBGP routes in selecting the best path and eligible multipaths (if multipath and ECMP are enabled). The result is a form of EIBGP load-balancing in a multipath scenario.

By default (with the no form of the command), the BGP decision process prefers an EBGP learned route over an IBGP learned route.

The behavior can be applied selectively to only certain types of routes by specifying one or more address family names in the command. If no families are specified, the command applies to IPv4, IPv6, label-IPv4, label-IPv6, VPN-IPv4, and VPN-IPv6 routes.

Default 

no ebgp-ibg-equal

Parameters 
ipv4—
Specifies that the command should be applied to unlabeled unicast IPv4 routes.
ipv6—
Specifies that the command should be applied to unlabeled unicast IPv6 routes.
label-ipv4—
Specifies that the command should be applied to labeled unicast IPv4 routes.
label-ipv6—
Specifies that the command should be applied to labeled unicast IPv6 routes.
vpn-ipv4—
Specifies that the command should be applied to IPv4 VPN routes.
vpn-ipv6—
Specifies that the command should be applied to IPv6 VPN routes.

auth-keychain

Syntax 
auth-keychain name
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures a TCP authentication keychain to use for the session. The keychain allows the rollover of authentication keys during the lifetime of a session.

Default 

no auth-keychain

Parameters 
name
Specifies the name of the keychain, up to 32 characters, to use for the specified TCP session or sessions.

authentication-key

Syntax 
authentication-key [authentication-key | hash-key] [hash | hash2]
no authentication-key
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the BGP authentication key.

Authentication is performed between neighboring routers before setting up the BGP session by verifying the password. Authentication is performed using the MD-5 message based digest.

The authentication key can be any combination of ASCII characters up to 255 characters long.

The no form of the command reverts to the default value.

Default 

no authentication-key

Parameters 
authentication-key—
The authentication key. The key can be any combination of ASCII characters up to 255 characters in length (unencrypted). If spaces are used in the string, enclose the entire string in quotation marks (“ ”).
hash-key—
The hash key. The key can be any combination of ASCII characters up to 342 characters in length (encrypted). If spaces are used in the string, enclose the entire string in quotation marks (“ ”).

This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.

hash—
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified
hash2—
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.

backup-path

Syntax 
[no] backup-path [ipv4] [ipv6] [label-ipv4] [label-ipv6]
Context 
config>router>bgp
Description 

This command enables the computation and use of a backup path for IPv4 and/or IPv6 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 also the same backup path, the time to 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.

Default 

no backup-path

Parameters 
ipv4 —
Enables BGP fast reroute for unlabeled unicast IPv4 routes.
ipv6 —
Enables BGP fast reroute for unlabeled unicast IPv6 routes.
label-ipv4 —
Enables BGP fast reroute for labeled-unicast IPv4 routes.
label-ipv6 —
Enables BGP fast reroute for labeled-unicast IPv6 routes.

best-path-selection

Syntax 
best-path-selection
Context 
config>router>bgp
Description 

This command enables path selection configuration.

bfd-enable

Syntax 
[no] bfd-enable
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables the use of bi-directional forwarding (BFD) to control the state of the associated protocol interface. By enabling BFD on a given protocol interface, the state of the protocol interface is tied to the state of the BFD session between the local node and the remote node. The parameters used for the BFD are set via the BFD command under the IP interface.

The no form of this command removes BFD from the associated IGP/BGP protocol adjacency.

Default 

no bfd-enable

cluster

Syntax 
cluster ip-address [orr-location location-id [allow-local-fallback]]
no cluster
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the cluster ID for a route reflector server ID and implicitly configures the associated BGP sessions as route reflector clients of the BGP instance. If an ORR location ID is specified with the cluster ID, the clients in that cluster receive routes optimal for that specific location; see draft-ietf-idr-bgp-optimal-route-reflection for more information.

Route reflectors are used to reduce the number of IBGP sessions required within an AS. Normally, all BGP speakers within an AS must have a BGP peering with every other BGP speaker in an AS. A route reflector and its clients form a cluster. Peers that are not part of the cluster are considered to be non-clients.

When a route reflector receives best path from a non-client peer, it sends the route to all clients. When the route reflector receives a best path from a client peer it sends the route to all non-client and all client peers except the originator.

With optimal route reflection, the best path advertised to a client takes location ID into account, which means that 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, IS-IS, or BGP-LS information in the TE DB.

The no form of the command deletes the cluster ID and effectively disables route reflection for the group.

Default 

no cluster

Parameters 
ip-address—
The route reflector cluster ID is expressed in dot decimal notation.
Values—
Any 32 bit number in dot decimal notation. (0.0.0.1 to 255.255.255.255)

 

orr-location location-id—
The optimal route reflection location index for this set of route reflector clients.
Values—
1 to 16

 

allow-local-fallback
Controls the behavior when there are no BGP routes to advertise to the RR clients that are reachable from the perspective of their ORR location. If this option is configured, the RR is allowed (in this circumstance only), to advertise the best reachable BGP path from its own topology location. If this option is not configured and this situation applies, then no route is advertised to the clients.

confederation

Syntax 
confederation confed-as-num members member-as-num
no confederation confed-as-num [members member-as-num]
Context 
config>router
Description 

This command creates confederation autonomous systems within an AS.

This technique is used to reduce the number of IBGP sessions required within an AS. Route reflection is the other technique that is commonly deployed to reduce the number of IBGP sessions.

The no form of the command deletes the specified member AS from the confederation.

When members are not specified in the no statement, the entire list is removed and confederations is disabled.

When the last member of the list is removed, confederations is disabled.

Default 

no confederation

Parameters 
confed-as-num—
The confederation AS number expressed as a decimal integer.
Values—
1 to 65535

 

members member-as-num
The AS number(s) of members that are part of the confederation expressed as a decimal integer. Configure up to 15 members per confed-as-num.

connect-retry

Syntax 
connect-retry seconds
no connect-retry
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the BGP connect retry timer value in seconds.

When this timer expires, BGP tries to reconnect to the configured peer. This configuration parameter can be set at three levels: global level (applies to all peers), peer-group level (applies to all peers in group) or neighbor level (only applies to specified peer). The most specific value is used.

The no form of the command used at the global level reverts to the default value.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

120

Parameters 
seconds—
The BGP Connect Retry timer value in seconds expressed as a decimal integer.
Values—
1 to 65535

 

damp-peer-oscillations

Syntax 
damp-peer-oscillations [idle-hold-time initial-wait second-wait max-wait] [error-interval minutes]
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command controls 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 a short while after each session reset cause longer and longer hold times in the idle state. This command supports the DampPeerOscillations FSM behavior described in section 8.1 of RFC 4271, A Border Gateway Protocol 4 (BGP-4).

The default behavior, which applies when no damp-peer-oscillations is configured, is to immediately transition out of the idle-state after every reset.

Default 

no damp-peer-oscillations

Parameters 
initial-wait—
The amount of time, in minutes, that a session remains in the idle-state after it has been stable for a while.
Values—
0 to 2048

 

Default—
0
second-wait—
A period of time, in minutes, that is doubled after each repeated session failure that occurs within a relatively short span of time.
Values—
1 to 2048

 

Default—
5
max-wait—
The maximum amount of time, in minutes, that a session remains in the idle-state after it has experienced repeated instability.
Values—
1 to 2048

 

Default—
60
minutes —
The interval of time, in minutes after a session reset, during which the session must be error-free in order to reset the penalty counter and return to idle-hold-time to initial-wait.
Values—
0 to 2048

 

Default—
30

damping

Syntax 
[no] damping
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables BGP route damping for learned routes which are defined within the route policy. Use 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. Damping parameters are set via route policy definition.

The no form of the command used at the global level reverts route damping.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

When damping is enabled and the route policy does not specify a damping profile, the default damping profile is used. This profile is always present and consists of the following parameters:

  1. Half-life: 15 minutes
  2. Max-suppress: 60 minutes
  3. Suppress-threshold: 3000
  4. Reuse-threshold: 750
Default 

no damping

default-route-target

Syntax 
[no] default-route-target
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command originates the default RTC route (zero prefix length) towards the selected peers.

Default 

no default-route-target

disable-4byte-asn

Syntax 
[no] disable-4byte-asn
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command disables the use of 4-byte ASNs. It can be configured at all 3 level of the hierarchy so it can be specified down to the per peer basis.

If this command is enabled 4-byte ASN support should not be negotiated with the associated remote peers.

The no form of the command resets the behavior to the default which is to enable the use of 4-byte ASN.

disable-capability-negotiation

Syntax 
[no] disable-capability-negotiation
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command disables capability negotiation. When the command is enabled and after the peering is flapped, any new capabilities are not negotiated and will strictly support IPv4 routing exchanges with that peer.

The no form of the command removes this command from the configuration and restores the normal behavior.

Default 

no disable-capability-negotiation

disable-client-reflect

Syntax 
[no] disable-client-reflect
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command disables the reflection of routes by the route reflector to the clients in a specific group or neighbor.

This only disables the reflection of routes from other client peers. Routes learned from non-client peers are still reflected to all clients.

The no form re-enables client reflection of routes.

Default 

no disable-client-reflect

disable-communities

Syntax 
disable-communities [standard] [extended]
no disable-communities
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures BGP to disable sending communities.

Parameters 
standard—
Specifies standard communities that existed before VPRNs or 2547.
extended—
Specifies BGP communities used were expanded after the concept of 2547 was introduced, to include handling the VRF target.

disable-fast-external-failover

Syntax 
[no] disable-fast-external-failover
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures BGP fast external failover.

disable-route-table-install

Syntax 
[no] disable-route-table-install
Context 
config>router>bgp
Description 

This command specifies whether to disable the installation of all (labeled and unlabeled) IPv4 and IPv6 BGP routes into RTM (Routing Table Manager) and the FIB (Forwarding Information Base) on the base router instance.

dynamic-neighbor-limit

Syntax 
dynamic-neighbor-limit peers
no dynamic-neighbor-limit
Context 
config>router>bgp
config>router>bgp>group
Description 

This command configures the maximum number of dynamic BGP sessions that will be accepted from remote peers associated with the entire BGP instance or a specific peer group. If accepting a new dynamic session would cause either the group limit or the instance limit to be exceeded, then the new session attempt is rejected and a Notification message is sent back to the remote peer.

The no form of the command removes the limit on the number of dynamic sessions.

Default 

no dynamic-neighbor-limit

Parameters 
peers—
The maximum number of dynamic BGP sessions
Values—
1 to 8192

 

dynamic-neighbor

Syntax 
dynamic-neighbor
Context 
config>router>bgp>group
Description 

This command enables the context to configure dynamic BGP sessions for a peer group.

prefix

Syntax 
[no] prefix ip-prefix/prefix-length
Context 
config>router>bgp>group>dynamic-neighbor
Description 

This command configures a prefix from which to accept dynamic BGP sessions; particularly, sessions from source IP addresses not matching any configured neighbor addresses. A dynamic session is associated with the group having the longest match prefix entry for the source IP address of the peer. The group association determines local parameters that apply to the session, including the local AS, the local IP address, the peer AS, the MP-BGP families, the import and export policies, and so on.

The no form of the command removes a prefix entry.

Parameters 
ip-prefix/prefix-length—
Specifies a prefix from which to accept dynamic BGP sessions
Values—
ipv4-prefix — a.b.c.d (host bits must be 0)
ipv4-prefix-length — 0 to 32
ipv6-prefix — x:x:x:x:x:x:x:x (eight 16-bit pieces)
                      x:x:x:x:x:x:d.d.d.d
                      x — [0..FFFF]H
                      d — [0..255]D
ipv6-prefix-length — 0 to 128

 

ebgp-link-bandwidth

Syntax 
ebgp-link-bandwidth [ipv4] [label-ipv4] [vpn-ipv4] [label-ipv6] [ipv6] [vpn-ipv6]
no ebgp-link-bandwidth
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

When the egp-link-bandwidth command is configured, BGP automatically adds a link-bandwidth extended community to every route (of the selected types) received from directly connected (single-hop) EBGP peers within the scope of the command.

The link-bandwidth extended community added by this command encodes the local-AS number of receiving BGP instance and the bandwidth of the interface to the directly connected EBGP peer.

The no form of this command means that no link bandwidth extended community is automatically added to received BGP routes.

Default 

no egp-link-bandwidth

Parameters 
ipv4—
Adds a link-bandwidth extended community to unlabeled unicast IPv4 routes.
label-ipv4—
Adds a link-bandwidth extended community to labeled-unicast IPv4 routes.
vpn-ipv4—
Adds a link-bandwidth extended community to IPv4 VPN (SAFI 128) routes.
ipv6—
Adds a link-bandwidth extended community to unlabeled unicast IPv6 routes.
label-ipv6—
Adds a link-bandwidth extended community to labeled-unicast IPv6 routes.
vpn-ipv6—
Adds a link-bandwidth extended community to IPv6 VPN (SAFI 128) routes.

enable-origin-validation

Syntax 
enable-origin-validation [ipv4] [ipv6] [label-ipv4] [label-ipv6]
no enable-origin-validation
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

When the enable-origin-validation command is added to the configuration of a group or neighbor, it causes every inbound IPv4 and/or IPv6 route from that peer to be marked with one of the 3 following origin validation states:

  1. Valid (0)
  2. Not-Found (1)
  3. Invalid (2)

By default (when neither the ipv4 or ipv6 option is present in the command) or when both the ipv4 and ipv6 options are specified, all unicast IPv4 (AFI1/SAFI1), label-IPv4 (AFI1/SAFI4), unicast IPv6 (AFI2/SAFI1), and label-IPv6 (AFI2/SAFI4) routes are evaluated to determine their origin validation states. When only the ipv4 or ipv6 option is present, only the corresponding address family routes (unlabeled and labeled) are evaluated.

The enable-origin-validation command applies to all types of BGP peers, but as a general rule, it should only be applied to EBGP peers and groups that contain only EBGP peers.

Default 

no enable-origin-validation

Parameters 
ipv4—
Enables origin validation processing for unlabeled unicast IPv4 routes.
ipv6—
Enables origin validation processing for unlabeled unicast IPv6 routes.
label-ipv4—
Enables origin validation processing for labeled IPv4 routes.
label-ipv6—
Enables origin validation processing for labeled IPv6 routes.

enable-inter-as-vpn

Syntax 
[no] enable-inter-as-vpn
Context 
config>router>bgp
Description 

This command specifies whether VPNs can exchange routes across autonomous system boundaries, providing model B connectivity

The no form of the command disallows ASBRs to advertise VPRN routes to their peers in other autonomous systems.

Default 

no enable-inter-as-vpn

enable-peer-tracking

Syntax 
[no] enable-peer-tracking
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables BGP peer tracking. BGP peer tracking allows a BGP peer to be dropped immediately if the route used to resolve the BGP peer address is removed from the IP routing table and there is no alternative available. The BGP peer will not wait for the holdtimer to expire; therefore, the BGP re-convergence process is accelerated.

The no form of the command disables peer tracking.

Default 

no enable-peer-tracking

enable-rr-vpn-forwarding

Syntax 
[no] enable-rr-vpn-forwarding
Context 
config>router>bgp
Description 

When this command is configured all received VPN-IP routes, regardless of route target, are imported into the dummy VRF, where the BGP next-hops are resolved. The label-route-transport-tunnel under config>router>bgp>next-hop-resolution 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 best so that it can be re-advertised to an IBGP peer Y, AND the BGP next-hop is modified towards 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) then 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:

  1. from X (client) to Y (client)
  2. from X (client) to Y (non-client)
  3. from X (non-client) to Y (client)

The no form of the command causes the re-advertisement of a VPN-IP route between one IBGP peer and another IBGP peer does not cause a new VPRN service label value to be signaled and programmed even if the BGP next-hop is changed through group/neighbor configuration or policy.

Nokia recommends leaving this command disabled for scaling and convergence reasons.

Default 

no enable-rr-vpn-forwarding

export

Syntax 
export plcy-or-long-expr [plcy-or-expr [plcy-or-expr…(up to 14 max)]]
no export [plcy-or-long-expr]
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command is used to specify route policies that control the handling of outbound routes transmitted to certain peers. Route policies are configured in the config>router>policy-options context.

This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific level is used.

The export command can reference up to 15 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 15 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). The first of the 15 objects has a maximum length of 255 characters; the remaining 14 objects have a maximum length of 64 characters each.

When multiple export commands are issued, the last command entered overrides the previous command.

When an export policy is not specified, BGP-learned routes are advertised by default and non-BGP routes are not advertised.

The no form of the command removes the policy association.

Default 

no export

Parameters 
plcy-or-long-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 255 characters long). Allowed values are any string up to 255 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
plcy-or-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 64 characters long). Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

family

Syntax 
family [ipv4] [label-ipv4] [vpn-ipv4] [ipv6] [label-ipv6] [vpn-ipv6] [mcast-ipv4] [l2-vpn] [mvpn-ipv4] [mvpn-ipv6] [mdt-safi] [ms-pw] [flow-ipv4] [flow-ipv6] [route-target] [mcast-vpn-ipv4] [evpn] [bgp-ls] [mcast-ipv6]
no family
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the set of BGP address families (AFI plus SAFI) to be supported by the applicable base router BGP sessions.

The no form of the command restores the default, which corresponds to unlabeled IPv4 unicast routes (AFI 1, SAFI 1) only.

Default 

family ipv4

Parameters 
ipv4—
Adds support for the IPv4 unicast (unlabeled) address family.
label-ipv4—
Adds support for the IPv4 unicast (labeled) address family.
vpn-ipv4—
Adds support for the IPv4 VPN (SAFI 128) address family.
ipv6—
Adds support for the IPv6 unicast (unlabeled) address family.
label-ipv6—
Adds support for the IPv6 unicast (labeled) address family.
mcast-ipv4—
Adds support for the IPv4 multicast SAFI address family.
l2-vpn—
Adds support for the L2 VPN address family.
mvpn-ipv4—
Adds support for the IPv4 multicast VPN address family.
mvpn-ipv6—
Adds support for the IPv6 multicast VPN address family.
flow-ipv4—
Adds support for the IPv4 flowspec address family.
flow-ipv6—
Adds support for the IPv6 flowspec address family.
mdt-safi—
Adds support for the MDT SAFI address family.
ms-pw —
Adds support for the multi-segment pseudowire address family.
route-target—
Adds support for the address family for RT constrain routes.
mcast-vpn-ipv4—
Adds support for the IPv4 VPN multicast (SAFI 129) address family.
evpn—
Adds support for the EVPN address family.
bgp-ls—
Enables the advertisement of BGP-LS address family to the associated BGP neighbors.
mcast-ipv6—
Adds support for the IPv6 multicast SAFI address family.

flowspec

Syntax 
flowspec
Context 
config>router>bgp
Description 

This command enables the context to enable and disable flowspec validations.

validate-dest-prefix

Syntax 
validate-dest-prefix
no validate-dest-prefix
Context 
config>router>bgp>flowspec
Description 

This command enables or disables 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:

  1. it was originated outside the local AS of the receiving BGP router
  2. 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.

The no form of the command disables the validation procedure based on destination-prefix.

Default 

no validate-dest-prefix

route-target-list

Syntax 
route-target-list comm-id [comm-id ..[up to 15 max]]
no route-target-list [comm-id]
Context 
config>router>bgp
Description 

This command specifies the route target(s) to be accepted from or advertised to peers. If the route-target-list is a non-null list, only routes with one or more of the given route targets are accepted from or advertised to peers.

The route-target-list is assigned at the global level and applies to all peers connected to the system.

This command is only applicable if the router is a route-reflector server.

The no form of the command with a specified route target community removes the specified community from the route-target-list. The no form of the command entered without a route target community removes all communities from the list.

Default 

no route-target-list

Parameters 
comm-id—
Specifies the route target community.
Values—
[target: {ip-address:comm-val | 2byte-asnumber:ext-comm-val | 4byte-asnumber:comm-val}
where:
  1. ip-address — a.b.c.d
  2. comm-val — 0 to 65535
  3. 2byte-asnumber — 0 to 65535
  4. ext-comm-val — 0 to 4294967295
  5. 4byte-asnumber — 0 to 4294967295

 

third-party-nexthop

Syntax 
third-party-nexthop
no third-party-nexthop
Context 
config>router>bgp
config>router>bgp>group>neighbor
Description 

Use this command to enable the router to send third-party next-hop to EBGP peers in the same subnet as the source peer, as described in RFC 4271. If enabled 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. Third-party next-hop is not done if the address family of the transport does not match the address family of the route.

The no form of the command prevents BGP from performing any third party next-hop processing toward any single-hop EBGP peers within the scope of the command. No third-party next-hop means the next-hop will always carry the IP address of the interface used to establish the TCP connection to the peer.

Default 

no third-party-nexthop

vpn-apply-export

Syntax 
[no] vpn-apply-export
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command causes the base instance BGP export route policies to be applied to vpn-ipv4/6, mvpn-ipv4/6, l2-vpn, mdt-safi, mcast-vpn-ipv4, and evpn routes.

The no form of the command disables the application of the base instance BGP route policies to vpn-ipv4/6, mvpn-ipv4/6, l2-vpn, mdt-safi, mcast-vpn-ipv4, and evpn routes.

Default 

no vpn-apply-export

vpn-apply-import

Syntax 
[no] vpn-apply-import
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command causes the base instance BGP import route policies to be applied to vpn-ipv4/6, mvpn-ipv4/6, l2-vpn, mdt-safi, mcast-vpn-ipv4, and evpn routes.

The no form of the command disables the application of the base instance BGP import route policies to vpn-ipv4/6, mvpn-ipv4/6, l2-vpn, mdt-safi, mcast-vpn-ipv4, and evpn routes.

Default 

no vpn-apply-import

leak-import

Syntax 
leak-import plcy-or-long-expr [plcy-or-expr ... (up to 14 max)]
no leak-import
Context 
config>router>bgp>rib-management>ipv4
config>router>bgp>rib-management>label-ipv4
config>router>bgp>rib-management>ipv6
Description 

This command is used to specify route policies that control the importation of leak-eligible routes from the BGP RIB of another routing instance into the unlabeled-IPv4, unlabeled-IPv6, or 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.

The leak-import command can reference up to 15 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 final action to accept or reject the route.

Only one of the 15 objects referenced by the leak-import command is allowed to be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT). The first of the 15 objects has a maximum length of 255 characters while the remaining 14 objects have a maximum length of 64 characters each.

When multiple leak-import commands are issued, the last command entered overrides the previous command.

When a leak-import policy is not specified, no BGP routes from other routing instances are leaked into the base router BGP RIB.

The no form of the command removes the policy association.

Default 

no leak-import

Parameters 
plcy-or-long-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 255 characters long). Allowed values are any string up to 255 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
plcy-or-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 64 characters long). Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

route-table-import

Syntax 
route-table-import policy-name
no route-table-import
Context 
config>router>bgp>rib-management>ipv4
config>router>bgp>rib-management>label-ipv4
config>router>bgp>rib-management>ipv6
config>router>bgp>rib-management>label-ipv6
Description 

This command specifies the name of a route to control the importation of active routes from the IP route table into one of the BGP RIBs.

If the route-table-import 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.

If the route-table-import 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 the route-table-import policy, 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 the route-table-import policy.

Route modifications specified in the actions of a route-table-import policy are ignored and have no effect on the imported routes.

Default 

no route-table-import

Parameters 
policy-name—
Specifies the name of a policy-statement (up to 64 characters).

graceful-restart

Syntax 
[no] graceful-restart
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables BGP graceful restart helper procedures (the “receiving router” role defined in the standard) for address families included in the GR capabilities of both peers. SR OS can support GR helper functionality for IPv4, IPv6, VPN-IPv4, VPN-IPv6, Label-IPv4, Label-IPv6, L2-VPN, Route-Target (RTC), Flow-IPv4 (IPv4 flow-spec) and Flow-IPv6 (IPv6 flow-spec) routes.

If a neighbor covered by the GR helper mode restarts its control plane, forwarding can continue uninterrupted while the session is re-established and routes are re-learned.

The no form of the command disables graceful restart.

Default 

no graceful-restart

error-handling

Syntax 
error-handling
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command specifies whether updated BGP error handling procedures should be applied.

update-fault-tolerance

Syntax 
[no] update-fault-tolerance
Context 
config>router>bgp>update-error-handling
config>router>bgp>group> update-error-handling
config>router>bgp>group>neighbor> update-error-handling
Description 

This command enables treat-as-withdraw and other similarly non-disruptive approaches for handling a wide range of UPDATE message errors, as long as there are no length errors that prevent all of the NLRI fields from being correctly identified and parsed.

Default 

no fault-tolerance

enable-notification

Syntax 
enable-notification
no enable-notification
Context 
config>router>bgp>graceful-restart
config>router>bgp>group>graceful-restart
config>router>bgp>group>neighbor>graceful-restart
Description 

When this command is present, the graceful restart capability sent by this router indicates support for NOTIFICATION messages. If the peer also supports this capability then the session can be restarted gracefully (while preserving forwarding) if either peer needs to sends a NOTIFICATION message due to some type of event or error.

Default 

no enable-notification

restart-time

Syntax 
restart-time seconds
no restart-time
Context 
config>router>bgp>graceful-restart
config>router>bgp>group>graceful-restart
config>router>bgp>group>neighbor>graceful-restart
Description 

This command sets the value of the restart-time that is advertised in the router’s graceful-restart capability. If this command is not configured.

Default 

no restart time

Parameters 
seconds—
The restart-time that is advertised in the router’s graceful-restart capability.
Values—
0 to 4095 seconds

 

Default—
config>router>bgp>graceful-restart: 120 seconds
config>router>bgp>group>graceful-restart: 300 seconds
config>router>bgp>group>neighbor>graceful-restart: 300 seconds

stale-routes-time

Syntax 
stale-routes-time time
no stale-routes-time
Context 
config>router>bgp>graceful-restart
config>router>bgp>group>graceful-restart
config>router>bgp>group>neighbor>graceful-restart
Description 

This command configures the maximum amount of time in seconds that stale routes should be maintained after a graceful restart is initiated.

The no form of the command resets the stale routes time back to the default of 360 seconds.

Default 

no restart time

Parameters 
time—
Specify the amount of time that stale routes should be maintained after a graceful restart is initiated.
Values—
1 to 3600 seconds

 

group

Syntax 
[no] group name
Context 
config>router>bgp
Description 

This command creates a context to configure a BGP peer group.

The no form of the command deletes the specified peer group and all configurations associated with the peer group. The group must be shutdown before it can be deleted.

Default 

no group

Parameters 
name—
The peer group name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

hold-time

Syntax 
hold-time seconds [min seconds2]
no hold-time
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the BGP hold time, expressed in seconds.

The BGP hold time specifies the maximum time BGP waits between successive messages (either keepalive or update) from its peer, before closing the connection. This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in group) or neighbor level (only applies to specified peer). The most specific value is used.

Even though the implementation allows setting the keepalive time separately, the configured keepalive timer is overridden by the hold-time value under the following circumstances:

  1. 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.
  2. If the hold-time is set to zero, then 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.

The no form of the command used at the global level reverts to the default value.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

90

Parameters 
seconds—
The hold-time, in seconds, expressed as a decimal integer. A value of 0 indicates the connection to the peer is up permanently.
Values—
0, 3 to 65535

 

min seconds2
The minimum hold-time that will be accepted for the session. If the peer proposes a hold-time lower than this value, the session attempt will be rejected.

ibgp-multipath

Syntax 
[no] ibgp-multipath
Context 
config>router>bgp
Description 

This command enables IBGP multipath load balancing when adding BGP routes to the route table if the route resolving the BGP nexthop offers multiple nexthops.

The no form of the command disables the IBGP multipath load balancing feature.

Default 

no ibgp-multipath

ignore-nh-metric

Syntax 
ignore-nh-metric
no ignore-nh-metric
Context 
config>router>bgp>best-path-selection
config>service>vprn
config>service>vprn>bgp>best-path-selection
Description 

This command instructs BGP to disregard the resolved distance to the BGP next-hop in its decision process for selecting the best route to a destination. When configured in the config>router>bgp>best-path-selection context, this command applies to the comparison of two BGP routes with the same NLRI learned from base router BGP peers. When configured in the config>service>vprn context, this command applies to the comparison of two BGP-VPN routes for the same IP prefix imported into the VPRN from the base router BGP instance. When configured in the config>service>vprn>bgp>best-path-selection context, this command applies to the comparison of two BGP routes for the same IP prefix learned from VPRN BGP peers.

The no form of the command (no ignore-nh-metric) restores the default behavior whereby BGP factors distance to the next-hop into its decision process.

Default 

no ignore-nh-metric

ignore-router-id

Syntax 
ignore-router-id include-internal family [family ... (up to 2 max)]
[no] ignore-router-id
Context 
config>router>bgp>best-path-selection
config>service>vprn>bgp>best-path-selection
Description 

When the ignore-router-id command is present, and the current best path to a destination was learned from EBGP peer X with BGP identifier x and a new path is received from EBGP peer Y with BGP identifier y, the best path remains unchanged if the new path is equivalent to the current best path up to the BGP identifier comparison – even if y is less than x.

The no form of the command restores the default behavior of selecting the route with the lowest BGP identifier (y) as best.

Default 

no ignore-router-id

Parameters 
family—
specifies the internal families to be included in this configuration
Values—
mvpn-ipv4 | mvpn-ipv6

 

origin-invalid-unusable

Syntax 
origin-invalid-unusable
no origin-invalid-unusable
Context 
config>router>bgp>best-path-selection
Description 

When origin-invalid-unusable is configured, all routes that have an origin validation state of ‘Invalid’ are considered unusable by the best path selection algorithm, meaning they are not used for forwarding and not advertised to BGP peers.

With the default of no origin-invalid-unusable, routes with an origin validation state of ‘Invalid’ are compared to other ‘usable’ routes for the same prefix according to the BGP decision process.

Default 

no origin-invalid-unusable

import

Syntax 
import plcy-or-long-expr [plcy-or-expr [plcy-or-expr…(up to 14 max)]]
no import
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command specifies route policies that control the handling of inbound routes received from certain peers. Route policies are configured in the config>router>policy-options context.

This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific level is used.

The import command can reference up to 15 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 15 objects referenced by the import command is allowed to be a policy logical expression consisting of policy names (enclosed in square brackets) and logical operators (AND, OR, NOT). The first of the 15 objects has a maximum length of 255 characters; the remaining 14 objects have a maximum length of 64 characters each.

When multiple import commands are issued, the last command entered overrides the previous command.

When an import policy is not specified, BGP routes are accepted by default.

The no form of the command removes the policy association.

Default 

no import

Parameters 
plcy-or-long-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 255 characters long). Allowed values are any string up to 255 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
plcy-or-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 64 characters long). Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

keepalive

Syntax 
keepalive seconds
no keepalive
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

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

The keepalive parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific value is used.

The keepalive value is generally one-third of the hold-time interval. Even though the implementation allows the 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 value:

  1. If the specified keepalive value is greater than the configured hold-time, then the specified value is ignored, and the keepalive is set to one third of the current hold-time value.
  2. If the specified hold-time interval is less than the configured keepalive value, then the keepalive value is reset to one third of the specified hold-time interval.
  3. If the hold-time interval is set to zero, then the configured value of the keepalive value is ignored. This means that the connection with the peer is up permanently and no keepalive packets are sent to the peer.

The no form of the command used at the global level reverts to the default value

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

30

Parameters 
seconds—
The keepalive timer in seconds expressed as a decimal integer.
Values—
0 to 21845

 

local-address

Syntax 
local-address ip-address
no local-address
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

Configures the local IP address used by the group or neighbor when communicating with BGP peers.

Outgoing connections use the local-address as the source of the TCP connection when initiating connections with a peer.

When a local address is not specified, the router uses the system IP address when communicating with IBGP peers and uses the interface address for directly connected EBGP peers. This command is used at the neighbor level to revert to the value defined under the group level.

The no form of the command removes the configured local-address for BGP.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no local-address

Parameters 
ip-address—
The local address expressed in dotted decimal notation. Allowed value is a valid routable IP address on the router, either an interface or system IP address.
Values—
ipv4-address:
  1. a.b.c.d (host bits must be 0)
ipv6-address:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D

 

label-preference

Syntax 
label-preference value
no label-preference
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the route preference for routes learned from labeled-unicast peers.

This command can be configured at three levels:

  1. Global level — applies to all peers
  2. Group level — applies to all peers in the peer-group
  3. Neighbor level — applies only to the specified peer

The most specific value is used.

The lower the preference, the higher the chance of the route being the active route.

The no form of the command used at the global level reverts to the default value of 170.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no label-preference

Parameters 
value—
Specifies the route preference value.
Values—
1 to 255

 

link-state-export-enable

Syntax 
[no] link-state-export-enable
Context 
config>router>bgp
Description 

This command enables the export of link-state information into the BGP-LS address family for advertisement to other BGP neighbors.

The no form of this command disables the export of link state information into the BGP-LS address family.

Default 

no link-state-export-enable

local-as

Syntax 
local-as as-number [private] [no-prepend-global-as]
no local-as
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures a BGP local autonomous system (AS) number. In addition to the global AS number configured for BGP using the autonomous-system command, a local AS number can be configured to support various AS number migration scenarios.

When the local-as command is applied to a BGP neighbor and the local-as is different from the peer-as, the session comes up as EBGP and by default the global-AS number and then (in that order) the local-as number are prepended to the AS_PATH attribute in outbound routes sent to the peer. In received routes from the EBGP peer, the local AS is prepended to the AS path by default, but this can be disabled with the private option.

When the local-as command is applied to a BGP neighbor and the local-as is the same as the peer-as, the session comes up as IBGP, and by default, the global-AS number is prepended to the AS_PATH attribute in outbound routes sent to the peer.

This configuration parameter can be set at three levels: global level (applies to all BGP peers), group level (applies to all BGP peers in group) or neighbor level (only applies to one specific BGP neighbor). Thus by specifying this at the neighbor level, it is possible to have a separate local-as for each BGP session.

When the optional no-prepend-global-as command is configured, the global-as number is not added in outbound routes sent to an IBGP or EBGP peer.

When a command is entered multiple times for the same AS, the last command entered is used in the configuration. The private option can be added or removed dynamically by reissuing the command. Changing the local AS at the global level in an active BGP instance causes the BGP instance to restart with the new local AS number. Changing the local AS at the global level in an active BGP instance causes BGP to re-establish the peer relationships with all peers in the group with the new local AS number. Changing the local AS at the neighbor level in an active BGP instance causes BGP to re-establish the peer relationship with the new local AS number.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no local-as

Parameters 
as-number—
The virtual autonomous system number expressed as a decimal integer.
Values—
1 to 4294967295

 

private—
Specifies the local-as is hidden in paths learned from the peering.
no-prepend-global-as—
Specifies that the global-as is hidden in paths announced to the BGP peer.

local-preference

Syntax 
local-preference local-preference
no local-preference
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables setting the BGP local-preference attribute in incoming routes if not specified and configures the default value for the attribute.

This value is used if the BGP route arrives from a BGP peer without the local-preference integer set.

The specified value can be overridden by any value set via a route policy. This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific value is used.

The no form of the command at the global level specifies that incoming routes with local-preference set are not overridden and routes arriving without local-preference set are interpreted as if the route had local-preference value of 100.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no local-preference

Parameters 
local-preference—
The local preference value to be used as the override value expressed as a decimal integer.
Values—
0 to 4294967295

 

loop-detect

Syntax 
loop-detect {drop-peer | discard-route | ignore-loop | off}
no loop-detect
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures how the BGP peer session handles loop detection in the AS path.

This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific value is used.

Note:

Dynamic configuration changes of loop-detect are not recognized.

The no form of the command used at the global level reverts to default, which is loop-detect ignore-loop.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

loop-detect ignore-loop

Parameters 
drop-peer—
Sends a notification to the remote peer and drops the session.
discard-route—
Discards routes received from a peer with the same AS number as the router itself. This option prevents routes looped back to the router from being added to the routing information base and consuming memory. When this option is changed, the change will not be active for an established peer until the connection is re-established for the peer.
ignore-loop—
Ignores routes with loops in the AS path but maintains peering.
off—
Disables loop detection.

mdt-safi

Syntax 
[no] mdt-safi
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables peer capability to exchange MDT-SAFI address family advertisements.

med-out

Syntax 
med-out {number | igp-cost}
no med-out
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables advertising the Multi-Exit Discriminator (MED) and assigns the value used for the path attribute for the MED advertised to BGP peers if the MED is not already set.

The specified value can be overridden by any value set via a route policy.

This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific value is used.

The no form of the command used at the global level reverts to default where the MED is not advertised.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no med-out

Parameters 
number—
The MED path attribute value expressed as a decimal integer.
Values—
0 to 4294967295

 

igp-cost—
The MED is set to the IGP cost of the given IP prefix.

min-route-advertisement

Syntax 
min-route-advertisement seconds
no min-route-advertisement
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the minimum interval, in seconds, between successive updates of a prefix towards a peer.

This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group), or neighbor level (only applies to specified peer). The most specific value is used.

The no form of the command used at the global level reverts to default.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

The rapid-update command can be used to override the peer-level min-route-advertisement time and applies the minimum setting (0 seconds) to routes belonging to address families specified by the rapid-update command; routes of other address families continue to be advertised according to the session-level MRAI setting.

The rapid-update and rapid-withdrawal commands may result in the routes being sent before the peer-level MRAI timer expires.

Default 

min-route-advertisement 30

Parameters 
seconds—
The minimum route advertising interval, in seconds, expressed as a decimal integer.
Values—
1 to 255

 

mp-bgp-keep

Syntax 
[no] mp-bgp-keep
Context 
config>router>bgp
Description 

As a result of enabling this command, route refresh messages are no longer needed, or issued when VPN route policy changes are made; RIB-IN will retain all MP-BGP routes.

The no form of the command is used to disable this feature.

multihop

Syntax 
multihop ttl-value
no multihop
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
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.

The no form of the command is used to convey to the BGP instance that the EBGP peers are directly connected.

The no form of the command used at the global level reverts to default.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

1 — EBGP peers are directly connected.

64 — IBGP

Parameters 
ttl-value—
The TTL value expressed as a decimal integer.
Values—
1 to 255

 

multipath

Syntax 
multipath max-paths [ebgp ebgp-max-paths] [ibgp ibgp-max-paths] [restrict {same-neighbor-as | exact-as-path}]
no multipath
Context 
config>router>bgp
Description 

This command enables BGP multipath for all address families that support ECMP forwarding.

When multipath is enabled, traffic to the destination is load-shared across a set of paths (BGP routes) that the BGP decision process considers “equal” to the best path. The actual distribution of traffic over the multiple paths may be equal or unequal (that is, based on weights derived from the Link Bandwidth Extended Community).

To qualify as a multipath, a non-best route must meet the following criteria (some criteria are controlled by this command).

  1. The route must be the same type of route as the best path (same AFI/SAFI and, in some cases, same next-hop resolution method)
  2. The route must be tied with the best path for all criteria of equal or greater importance than IGP cost to reach the BGP next-hop, except for criteria that are configured to be ignored
  3. The route must not have the same BGP next-hop as the best path or any other multipath
  4. The route must not cause the ECMP limit of the routing instance to be exceeded (configured using the ecmp command to a value in the range 1 to 64)
  5. The route must not cause the configured max-paths limit of the BGP instance to be exceeded
    If the best path is an EBGP learned route and the ebgp option is used, the ebgp-max-paths limit overrides the max-paths limit. If the best path is an IBGP learned route and the ibgp option is used, the ibgp-max-paths limit overrides the max-paths limit.
    All path limits are configurable up to a maximum of 64. Multipath is effectively disabled if a value is set to 1.
  6. The route must have the same neighbor AS in its AS path as the best path if the restrict same-neighbor-as option is configured. By default, any path with the same AS path length as the best path (regardless of neighbor AS) is eligible for multipath.
  7. The route must have the same AS path as the best path if the restrict exact-as-path option is configured. By default, any path with the same AS path length as the best path (regardless of the actual AS numbers) is eligible for multipath.

The no form of the command disables BGP multipath (equivalent to multipath 1).

Default 

no multipath

Parameters 
max-paths—
the maximum number of multipaths per prefix/NLRI if ebgp-max-paths or ibgp-max-paths does not apply
Values—
1 to 64

 

egp-max-paths
the maximum number of multipaths per prefix/NLRI when the best path is an EBGP learned route
Values—
1 to 64

 

ibgp-max-paths
the maximum number of multipaths per prefix/NLRI when the best path is an IBGP learned route
Values—
1 to 64

 

restrict same-neighbor-as—
specifies that the non-best path must have the same neighbor AS in its AS path as the best path
restrict exact-as-path-as—
specifies that the non-best path must have the same AS path as the best path

mvpn-vrf-import-subtype-new

Syntax 
[no] mvpn-vrf-import-subtype-new
Context 
config>router>bgp
Description 

When enabled, the type/subtype in advertised routes is encoded as 0x010b.

The no form of the command (the default) encodes the type/subtype as 0x010a (to preserve backwards compatibility).

next-hop-resolution

Syntax 
next-hop-resolution
Context 
config>router>bgp
Description 

This command enables the context to configure next-hop resolution parameters.

labeled-routes

Syntax 
labeled-routes
Context 
config>router>bgp>next-hop-res
Description 

This command enables the context to configure labeled route options for next-hop resolution.

allow-static

Syntax 
allow-static
no allow-static
Context 
config>router>bgp>next-hop-res>labeled-routes
Description 

This command allows the BGP next-hop of label-IPv4, label-IPv6, VPN-IPv4, and VPN-IPv6 routes received from any EBGP or IBGP peer to 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 more preferred than other IGP routes or tunnels.

Note:

A label-IPv4 or label-IPv6 route can be resolved by a static blackhole route, even when the allow-static command is not configured, but only if the static blackhole route is the longest prefix match (LPM) static route for the BGP next-hop address.

Default 

no allow-static

rr-use-route-table

Syntax 
rr-use-route-table
no rr-use-route-table
Context 
config>router>bgp>next-hop-res>labeled-routes
Description 

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.

Configure the disable-route-table-install command before you configure the rr-use-route-table command because forwarding would otherwise be incorrect for cases where label routes are resolved this way.

Default 

no rr-use-route-table

transport-tunnel

Syntax 
transport-tunnel
Context 
config>router>bgp>next-hop-res>labeled-routes
Description 

This command enables the context to configure options for the next-hop resolution of BGP labeled routes (VPN-IP and labeled-unicast) using tunnels in TTM. The context allows the selection of different tunnel resolution options for different types of BGP labeled routes: label-unicast IPv4, label-unicast IPv6, and VPN-IP routes (both VPN-IPv4 and VPN-IPv6).

By default (if this context and the resolution options are not configured), these routes resolved to LDP tunnels: IPv4 label routes, IPv6 label routes, and VPN-IP routes not imported into a user-configured VPRN.

If the resolution option is explicitly set to disabled, the default binding to LDP tunnel resumes. If resolution is set to any, then any supported tunnel type is allowed and the selection is based on the lowest numerical TTM preference value.

The following tunnel types are supported in a BGP label route context (in order of preference from most to least preferred): RSVP, LDP, BGP, SR-ISIS, SR-OSPF, and SR-TE.

The ldp value instructs BGP to search for an LDP LSP with a FEC prefix corresponding to the address of the BGP next-hop.

The rsvp value instructs BGP to search for the best metric RSVP LSP to the BGP next-hop address. The address can correspond to the system interface or to another loopback used by the BGP instance on the remote node. The LSP metric is provided by MPLS in the tunnel table. In the case of multiple RSVP LSPs with the same lowest metric, BGP selects the LSP with the lowest tunnel-id.

The sr-te value initiates a search for the best metric SR-TE LSP to the BGP next-hop address. The LSP metric is provided by MPLS in the tunnel table. If multiple SR-TE LSPs with the same lowest metric are found, BGP selects the LSP with the lowest tunnel ID.

When the sr-isis (sr-ospf) value is enabled, a tunnel to the BGP next-hop is selected in the TTM from the lowest numbered IS-IS or OSPF instance.

The bgp value instructs BGP to search for a BGP LSP with a destination matching the address of the BGP next-hop.

If one or more explicit tunnel types are specified using the resolution-filter option, then only these tunnel types will be selected again following the TTM preference.

The resolution must be set to filter to activate the list of tunnel types configured under resolution-filter.

family

Syntax 
family {label-ipv4 | label-ipv6 | vpn}
Context 
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel
Description 

This command configures the address family context for configuring next-hop resolution of BGP label routes.

Parameters 
label-ipv4—
Enters the context for configuring next-hop-resolution options for labeled-unicast IPv4 routes.
label-ipv6—
Enters the context for configuring next-hop-resolution options for labeled-unicast IPv6 routes.
vpn—
Enters the context for configuring next-hop-resolution options for VPN-IPv4 and VPN-IPv6 routes when they are not imported into any VPRN service.

resolution

Syntax 
resolution {any | filter | disabled}
Context 
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family
Description 

This command configures the resolution mode in the resolution of BGP label routes using tunnels to BGP peers.

Parameters 
any—
enables the binding to any supported tunnel type in BGP label route context following TTM preference.
filter—
enables the binding to the subset of tunnel types configured under resolution-filter.
disabled—
disables the resolution of BGP label routes using tunnels to BGP peers.

resolution-filter

Syntax 
resolution-filter
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family
Description 

This command enables the context to configure the subset of tunnel types that can be used in the resolution of BGP label routes using tunnels to BGP peers.

The supported tunnel types in a BGP label route context listed in order of preference are: RSVP, LDP, BGP, and Segment Routing (SR).

bgp

Syntax 
bgp
no bgp
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family>resolution-filter
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family>resolution-filter
Description 

This command selects BGP tunneling for next-hop resolution.

ldp

Syntax 
ldp
no ldp
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family>resolution-filter
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family>resolution-filter
Description 

This command selects LDP tunneling for next-hop resolution.

rsvp

Syntax 
rsvp
no rsvp
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family>resolution-filter
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family>resolution-filter
Description 

This command selects RSVP tunneling for next-hop resolution.

sr-isis

Syntax 
sr-isis
no sr-isis
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family>resolution-filter
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family>resolution-filter
Description 

This command selects the Segment Routing (SR) tunnel type programmed by an IS-IS instance in TTM for next-hop resolution.

sr-ospf

Syntax 
sr-ospf
no sr-ospf
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family>resolution-filter
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family>resolution-filter
Description 

This command selects the Segment Routing (SR) tunnel type programmed by an OSPF instance in TTM for next-hop resolution.

sr-te

Syntax 
sr-te
no sr-te
Context 
config>router>bgp>next-hop-resolution>shortcut-tunn>family>resolution-filter
config>router>bgp>next-hop-resolution>labeled-routes>transport-tunnel>family>resolution-filter
Description 

This command selects the Segment Routing (SR) tunnel type programmed by a traffic engineered (TE) instance in TTM for next-hop resolution.

policy

Syntax 
policy policy-name
no policy
Context 
config>router>bgp>next-hop-resolution
Description 

This command specifies the name of a policy statement to use with the BGP next-hop resolution process. The policy controls which IP routes in RTM are eligible to resolve the BGP next-hop addresses of IPv4 and IPv6 routes. The policy has no effect on the resolution of BGP next-hops to MPLS tunnels. If a BGP next-hop of an IPv4 or IPv6 route R is resolved in RTM and the longest matching route for the next-hop address is an IP route N that is rejected by the policy then route R is unresolved; if the route N is accepted by the policy then it becomes the resolving route for R.

The default next-hop resolution policy (when the no policy command is configured) is to use the longest matching active route in RTM that is not a BGP route (unless use-bgp-routes is configured), an aggregate route or a subscriber management route.

Default 

no policy

Parameters 
policy-name—
The route policy name. Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Route policies are configured in the config>router>policy-options context.

shortcut-tunnel

Syntax 
shortcut-tunnel
Context 
config>router>bgp>next-hop-res
Description 

This command enables the context to configure the resolution of BGP prefixes using tunnels to BGP next-hops in TTM.

The shortcut-tunnel and family nodes are simply contexts to configure the binding of BGP unlabeled routes to tunnels.

The default resolution of a BGP unlabeled route is performed in RTM. The user must configure the resolution option to enable resolution to tunnels in TTM. If the resolution option is explicitly set to disabled, the binding to tunnel is removed and resolution resumes in RTM to IP next-hops.

If resolution is set to any, any supported tunnel type in BGP shortcut context will be selected following TTM preference. If one or more explicit tunnel types are specified using the resolution-filter option, then only these tunnel types will be selected again following the TTM preference.

The following tunnel types are supported in a BGP shortcut context and in order of preference: RSVP, LDP, SR-ISIS, SR-OSPF, SR-TE, and BGP.

The ldp value instructs BGP to search for an LDP LSP with a FEC prefix corresponding to the address of the BGP next-hop.

The bgp value instructs BGP to search for a BGP LSP with a RFC 107 label route prefix matching the address of the BGP next-hop.

The rsvp value instructs BGP to search for 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 used by the BGP instance on the remote node. The LSP metric is provided by MPLS in the tunnel table. In the case of multiple RSVP LSPs with the same lowest metric, BGP selects the LSP with the lowest tunnel-id. The bgp value instructs BGP to search for a BGP LSP with a RFC 107 label route prefix matching the address of the BGP next-hop.

When the sr-isis (sr-ospf) value is enabled, a tunnel to the BGP next-hop is selected in the TTM from the lowest numbered ISIS (OSPF) instance. The sr-te value instructs the code to search for the best metric SR-TE LSP to the address of the BGP next-hop. The LSP metric is provided by MPLS in the tunnel table. In the case of multiple SR-TE LSPs with the same lowest metric, BGP selects the LSP with the lowest tunnel-id.

The user must set resolution to filter to activate the list of tunnel-types configured under resolution-filter.

If disallow-igp is enabled, the BGP route will not be activated using IP next-hops in RTM if no tunnel next-hops are found in TTM.

family

Syntax 
family ipv4
Context 
config>router>bgp>next-hop-res>shortcut-tunnel
Description 

This command configures the address family for configuring the resolution of BGP prefixes using tunnels to BGP peers.

Parameters 
ipv4—
selects the IPv4 address family for configuring the resolution of BGP prefixes using tunnels to BGP peers.

resolution

Syntax 
resolution {any | filter | disabled}
Context 
config>router>bgp>next-hop-res>shortcut-tunn>family
Description 

This command configures the resolution mode in the resolution of BGP prefixes using tunnels to BGP peers.

Parameters 
any—
enables the binding to any supported tunnel type in BGP shortcut context following TTM preference.
filter—
enables the binding to the subset of tunnel types configured under resolution-filter.
disabled—
disables the resolution of BGP prefixes using tunnels to BGP peers.

resolution-filter

Syntax 
resolution-filter [bgp] [ldp] [rsvp] [sr-isis] [sr-ospf] [sr-te]
Context 
config>router>bgp>next-hop-res>shortcut-tunn>family
Description 

This command configures the subset of tunnel types which can be used in the resolution of BGP label routes using tunnels to BGP peers.

The following tunnel types are supported in a BGP label route context and in order of preference: RSVP, LDP, and Segment Routing (SR).

Parameters 
bgp—
selects the BGP label route tunnel type.
ldp —
selects the LDP tunnel type.
rsvp—
selects the RSVP-TE tunnel type.
sr-isis—
selects the Segment Routing (SR) tunnel type programmed by an IS-IS instance in TTM.
sr-ospf—
selects the Segment Routing (SR) tunnel type programmed by an OSPF instance in TTM.
sr-te—
selects the Segment Routing (SR) tunnel type programmed by a TE instance in TTM.

peer-tracking-policy

Syntax 
peer-tracking-policy policy-name
no peer-tracking-policy
Context 
config>router>bgp
Description 

This command specifies the name of a policy statement to use with the BGP peer-tracking function on the BGP sessions where this is enabled. The policy controls which IP routes in RTM are eligible to indicate reachability of IPv4 and IPv6 BGP neighbor addresses. If the longest matching route in RTM for a BGP neighbor address is an IP route that is rejected by the policy, or it is a BGP route accepted by the policy, or if there is no matching route, the neighbor is considered unreachable and BGP tears down the peering session and holds it in the idle state until a valid route is once again available and accepted by the policy.

The default peer-tracking policy (when the no peer-tracking-policy command is configured) is to use the longest matching active route in RTM that is not an LDP shortcut route or an aggregate route.

Note:

When peer-tracking is configured, the peer-tracking policy should only permit one of direct-interface or direct routes to be advertised to a BGP peer. Advertising both routes will cause the best route to oscillate.

Default 

no peer-tracking-policy

Parameters 
policy-name—
The route policy name. Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Route policies are configured in the config>router>policy-options context.

use-bgp-routes

Syntax 
[no] use-bgp-routes
Context 
config>router>bgp>next-hop-res
Description 

This command specifies whether to use BGP routes to resolve BGP nexthop for IPv4 and IPv6 families on this router instance.

Default 

no use-bgp-routes

optimal-route-reflection

Syntax 
optimal-route-reflection
Context 
config>router>bgp
Description 

This command creates the optimal route reflection context.

spf-wait

Syntax 
spf-wait max-wait [initial-wait initial-wait] [second-wait second-wait]
no spf-wait
Context 
config>router>bgp>optimal-route-reflection
Description 

This command controls the interval between consecutive SPF calculations performed by the TE DB in support of BGP optimal route reflection. The time parameters of this command implement an exponential back-off algorithm.

The no form of this command causes a return to default values.

Default 

no spf-wait

Parameters 
max-wait—
Specifies the maximum interval in seconds between two consecutive SPF calculations.
Values—
1 to 600

 

Default—
60
initial-wait initial-wait—
Specifies the initial SPF calculation delay in seconds after a topology change.
Values—
1 to 300

 

Default—
5
second-wait second-wait—
Specifies the delay in seconds between the first and second SPF calculation and the exponential delay increment.
Values—
1 to 300

 

Default—
15

location

Syntax 
location location-id
Context 
config>router>bgp>optimal-route-reflection
Description 

This command configures the location ID for the for the route reflector.

Parameters 
location-id—
Specifies the location ID.
Values—
1 to 16

 

primary-ip-address

Syntax 
primary-ip-address ipv4-address
no primary-ip-address
Context 
config>router>bgp>optimal-route-reflection>location
Description 

This command specifies the primary IP address of a reference location used for BGP optimal route reflection. Up to three IPv4 addresses can be specified per location.

If the TE DB is unable find a node in its topology database with a loopback interface that has the primary IPv4 address of the location, then it tries to find a node with the secondary IPv4 address. If this attempt also fails, the TE DB tries to find a node with the tertiary IPv4 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.

The no form of this command removes the primary IP address information.

Default 

no primary-ip-address

Parameters 
ipv4-address—
The primary IPv4 address of a location expressed in dotted decimal notation.
Values—
a.b.c.d

 

secondary-ip-address

Syntax 
secondary-ip-address ipv4-address
no secondary-ip-address
Context 
config>router>bgp>optimal-route-reflection>location
Description 

This command specifies the secondary IP address of a reference location used for BGP optimal route reflection. Up to three IPv4 addresses can be specified per location.

If the TE DB is unable to find a node in its topology database with a loopback interface that has the primary IPv4 address of the location, then it tries to find a node with the secondary IPv4 address. If this attempt also fails, the TE DB then tries to find a node with the tertiary IPv4 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.

The no form of this command removes the secondary IP address information.

Default 

no secondary-ip-address

Parameters 
ipv4-address—
The secondary IPv4 address of a location expressed in dotted decimal notation.
Values—
a.b.c.d

 

tertiary-ip-address

Syntax 
tertiary-ip-address ipv4-address
no tertiary-ip-address
Context 
config>router>bgp>optimal-route-reflection>location
Description 

This command specifies the tertiary IP address of a reference location used for BGP optimal route reflection. Up to three IPv4 addresses can be specified per location.

If the TE DB is unable to find a node in its topology database with a loopback interface that has the primary IPv4 address of the location, then it tries to find a node with the secondary IPv4 address. If this attempt also fails, the TE DB then tries to find a node with the tertiary IPv4 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.

The no form of this command removes the tertiary IP address information.

Default 

no tertiary-ip-address

Parameters 
ipv4-address—
The tertiary IPv4 address of a location expressed in dotted decimal notation.
Values—
a.b.c.d

 

outbound-route-filtering

Syntax 
[no] outbound-route-filtering
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command opens the configuration tree for sending or accepting BGP filter lists from peers (outbound route filtering).

Default 

no outbound-route-filtering

extended-community

Syntax 
[no] extended-community
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

The extended-community command opens the configuration tree for sending or accepting extended-community based BGP filters.

In order for the no version of the command to work, all sub-commands (send-orf, accept-orf) must be removed first.

Default 

no extended-community

accept-orf

Syntax 
[no] accept-orf
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command instructs the router to negotiate the receive capability in the BGP ORF negotiation with a peer, and to accept filters that the peer wishes to send.

The no form of the command causes the router to remove the accept capability in the BGP ORF negotiation with a peer, and to clear any existing ORF filters that are currently in place.

Default 

no accept-orf

send-orf

Syntax 
send-orf [comm-id...(up to 32 max)]
no send-orf [comm-id]
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command instructs the router to negotiate the send capability in the BGP outbound route filtering (ORF) negotiation with a peer.

This command 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.

The no form of this command causes the router to remove the send capability in the BGP ORF negotiation with a peer.

The no form also causes the router to send an ORF remove action for a community filter, prefix filter, or AS path filter configured as an inbound filter on the BGP session to its peer.

If the comm-id parameters are not exclusively route target communities then the router will extract appropriate route targets and use those. If, for some reason, the comm-id parameters specified contain no route targets, then the router will not send an ORF.

Default 

no send-orf

Parameters 
comm-id—
Any community policy which consists exclusively of route target extended communities. If it is not specified, then the ORF policy is automatically generated from configured route target lists, accepted client route target ORFs and locally configured route targets.
Values—
[target: {ip-address:comm-val | 2byte-asnumber:ext-comm-val | 4byte-asnumber:comm-val}
where:
  1. ip-address — a.b.c.d
  2. comm-val — 0 to 65535
  3. 2byte-asnumber — 0 to 65535
  4. ext-comm-val — 0 to 4294967295
  5. 4byte-asnumber — 0 to 4294967295

 

neighbor

Syntax 
[no] neighbor ip-address
Context 
config>router>bgp>group
Description 

This command creates a BGP peer/neighbor instance within the context of the BGP group.

This command can be issued repeatedly to create multiple peers and their associated configuration.

The no form of the command is used to remove the specified neighbor and the entire configuration associated with the neighbor. The neighbor must be administratively shutdown before attempting to delete it. If the neighbor is not shutdown, the command will not result in any action except a warning message on the console indicating that neighbor is still administratively up.

Default 

no neighbor

Parameters 
ip-address—
The IP address of the BGP peer router in dotted decimal notation.
Values—
ipv4-address:
  1. a.b.c.d (host bits must be 0)
ipv6-address:
  1. x:x:x:x:x:x:x:x [-interface]
  2. x:x:x:x:x:x:d.d.d.d [-interface]
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D
  5. interface: 32 characters maximum, mandatory for link local addresses

 

next-hop-self

Syntax 
[no] next-hop-self
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures BGP to advertise routes to members of a group or to a specific neighbor using a local address of the BGP instance as the BGP next-hop address. Note that next-hop-self 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 enable-rr-vpn-forwarding command should also be configured.

The no form of the command uses protocol standard behavior to decide whether or not to set next-hop-self in advertised routes.

Default 

no next-hop-self

next-hop-unchanged

Syntax 
next-hop-unchanged [label-ipv4] [label-ipv6]
no next-hop-unchanged
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables unchanged BGP next-hops when sending BGP routes to peers in this group.

The no form of the command disables unchanged BGP next-hops.

override-tunnel-elc

Syntax 
[no] override-tunnel-elc
Context 
config>router>bgp
Description 

This command enables or disables entropy label capability (ELC) on BGP tunnels.

When this command is enabled, the system assumes that all far ends for BGP tunnels are 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, since entropy label capability may differ between domains.

Default 

no override-tunnel-elc

passive

Syntax 
[no] passive
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

Enables/disables passive mode for the BGP group or neighbor.

When in passive mode, BGP will not attempt to actively connect to the configured BGP peers but responds only when it receives a connect open request from the peer.

The no form of the command used at the group level disables passive mode where BGP actively attempts to connect to its peers.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no passive

peer-as

Syntax 
peer-as as-number
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the autonomous system number for the remote 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.

This is required command for each configured peer. This may be configured under the group level for all neighbors in a particular group.

Parameters 
as-number—
The autonomous system number expressed as a decimal integer.
Values—
1 to 4294967295

 

path-mtu-discovery

Syntax 
[no] path-mtu-discovery
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables path MTU discovery for the associated TCP connections. In doing so, the MTU for the associated TCP session will be initially set to the egress interface MTU. The DF bit will also be set so that if a router along the path of the TCP connection cannot handle a packet of a particular size without fragmenting, it will send back and ICMP message to set the path MTU for the given session to a lower value that can be forwarded without fragmenting.

The no form of the command disables path MTU discovery.

Default 

no path-mtu-discovery

preference

Syntax 
[no] preference preference
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the route preference for routes learned from the configured peer(s).

This configuration parameter can be set at three levels: global level (applies to all peers), group level (applies to all peers in peer-group) or neighbor level (only applies to specified peer). The most specific value is used.

The lower the preference the higher the chance of the route being the active route. The router assigns BGP routes highest default preference compared to routes that are direct, static or learned via MPLS or OSPF.

The no form of the command used at the global level reverts to default value.

The no form of the command used at the group level reverts to the value defined at the global level.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

170

Parameters 
preference—
The route preference expressed as a decimal integer.
Values—
1 to 255

 

purge-timer

Syntax 
purge-timer minutes
no purge-timer
Context 
config>router>bgp
Description 

When the system sends a VPN-IP Route-Refresh to a peer it sets all the VPN-IP routes received from that peer (in the RIB-IN) to stale and starts the purge-timer. If the routes are not updated (refreshed) before the purge-timer has expired then the routes are removed.

The BGP purge timer configures the time before stale routes are purged.

The no form of the command reverts to the default.

Default 

10

Parameters 
minutes—
Specifies the maximum time before stale routes are purged.
Values—
1 to 60

 

rapid-update

Syntax 
rapid-update [l2-vpn] [mvpn-ipv4] [mvpn-ipv6] [mdt-safi] [evpn] [label-ipv4] [label-ipv6] [vpn-ipv4] [vpn-ipv6] [mcast-vpn-ipv4] [mcast-vpn-ipv6]
no rapid-update
Context 
config>router>bgp
Description 

This command enables and disables BGP rapid update for specified address families.

If rapid update is enabled for a set of address families, and a route belonging to a family in that set is received by the router and chosen for propagation to certain BGP peers, the remaining time on the MRAI timer of these peers is ignored and the route is transmitted immediately, along with all other pending routes for these peers (including routes of address families not specified in the rapid-update command).

The rapid-update command overrides the peer-level min-route-advertisement time and applies the minimum setting (0 seconds) to routes belonging to specified address families; routes of other address families continue to be advertised according to the session-level MRAI setting.

The no form of the command disables rapid update for all address families.

Default 

no rapid-update

Parameters 
l2-vpn—
Specifies the BGP rapid update for the 12-byte Virtual Switch Instance identifier (VSI-ID) value consisting of the 8-byte route distinguisher (RD) followed by a 4-byte value.
mvpn-ipv4—
Specifies BGP rapid update for the mvpn-ipv4 address family. The mvpn-pv4 address is a variable size value consisting of the 1-byte route type, 1-byte length and variable size that is route type specific. Route type defines encoding for the route type specific field. Length indicates the length in octets of the route type specific field.
mdt-safi—
Specifies BGP rapid update for the mdt-safi address family. The address is a 16-byte value consisting of 12-byte route distinguisher (RD) followed by a 4-byte group address.
mvpn-ipv6—
Specifies BGP rapid update for the mvpn-ipv6 address family.
evpn—
Specifies BGP rapid update for the evpn address family by including or removing EVPN routes from the set of routes that can trigger rapid update.
label-ipv4—
Includes or removes label-ipv4 routes from the set of routes that can trigger rapid update.
label-ipv6—
Includes or removes label-ipv6 routes from the set of routes that can trigger rapid update.
vpn-ipv4—
Includes or removes vpn-ipv4 routes from the set of routes that can trigger rapid update.
vpn-ipv6—
Includes or removes vpn-ipv6 routes from the set of routes that can trigger rapid update.
mcast-vpn-ipv4—
Includes or removes mcast-vpn-ipv4 routes from the set of routes that can trigger rapid update.
mcast-vpn-ipv6—
Includes or removes mcast-vpn-ipv6 routes from the set of routes that can trigger rapid update.

rapid-withdrawal

Syntax 
[no] rapid-withdrawal
Context 
config>router>bgp
Description 

This command disables the delay (Minimum Route Advertisement) on sending BGP withdrawals. Normal route withdrawals may be delayed up to the minimum route advertisement to allow for efficient packing of BGP updates.

The no form of the command removes this command from the configuration and returns withdrawal processing to the normal behavior.

Default 

no rapid-withdrawal

prefix-limit

Syntax 
prefix-limit family limit [log-only] [threshold percentage] [idle-timeout {minutes | forever}] [post-import]
no prefix-limit family
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures the maximum number of BGP routes that can be received from a peer before some administrative action is taken. The administrative action can be the generation of a log event or taking down the session. If a session is taken down, then it can be brought back up automatically after an idle-timeout period, or else it can be configured to stay down ('forever') until the operator performs a reset.

No prefix limits for any address family are configured by default.

The prefix-limit command allows each address family to have its own limit; a set of address family limits can be applied to one neighbor or to all neighbors in a group.

The no form of the command removes the prefix-limit.

Parameters 
log-only—
Enables the warning message to be sent at the specified threshold percentage, and also when the limit is reached. However, the BGP session is not taken down.
percentage—
The threshold value (as a percentage) that triggers a warning message to be sent.
Values—
1 to 100

 

family—
The address family to which the limit applies.
Values—
ipv4, label-ipv4, vpn-ipv4, ipv6, label-ipv6, vpn-ipv6, mcast-ipv4, l2-vpn, mvpn-ipv4, mdt-safi, ms-pw, flow-ipv4, route-target, mcast-vpn-ipv4, mvpn-ipv6, flow-ipv6, evpn, mcast-ipv6, bgp-ls

 

limit—
The number of routes that can be learned from a peer expressed as a decimal integer.
Values—
1 to 4294967295

 

minutes—
Specifies duration in minutes before automatically re-establishing a session.
Values—
1 to 1024

 

forever—
Specifies that the session is reestablished only after clear router bgp command is executed.
post-import—
Specifies that the limit should be applied only to the number of routes that are accepted by import policies.

remove-private

Syntax 
remove-private [limited] [skip-peer-as]
no remove-private
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command allows private AS numbers to be removed from the AS path before advertising them to BGP peers.

When the remove-private parameter is set at the global level, it applies to all peers regardless of group or neighbor configuration. When the parameter is set at the group level, it applies to all peers in the group regardless of the neighbor configuration.

The router software recognizes the set of AS numbers that are defined by IANA as private. These are AS numbers in the range 64512 through 65535, inclusive.

The no form of the command used at the global level reverts to default value. The no form of the command used at the group level reverts to the value defined at the global level. The no form of the command used at the neighbor level reverts to the value defined at the group level.

Parameters 
limited—
This optional keyword removes private ASNs up to the first public ASN encountered. It then stops removing private ASNs.
skip-peer-as—
This optional keyword causes this command to not remove a private ASN from the AS-Path if that ASN is the same as the BGP peer AS number.

rib-management

Syntax 
rib-management
Context 
config>router>bgp
Description 

This command enables the context to configure RIB management parameters.

router-id

Syntax 
router-id ip-address
no router-id
Context 
config>router>bgp
Description 

This command specifies the router ID to be used with this BGP instance.

Changing the BGP router ID on an active BGP instance causes the BGP instance to restart with the new router ID. The router ID must be set to a valid host address.

It is possible to configure an SR OS to operate with an IPv6 only BOF and no IPv4 system interface address. When configured in this manner, the operator must explicitly define IPv4 router IDs for protocols such as OSPF and BGP as there is no mechanism to derive the router ID from an IPv6 system interface address.

When no router-id is configured for BGP, the system interface IP address is used.

Default 

no router-id

Parameters 
ip-address—
The router ID expressed in dotted decimal notation. Allowed value is a valid routable IP address on the router, either an interface or system IP address. It is highly recommended that this address be the system IP address.

split-horizon

Syntax 
[no] split-horizon
Context 
config>router>bgp
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command enables the use of split-horizon. Split-horizon 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.

The configuration default is no split-horizon, meaning that no effort is taken to prevent a best route from being reflected back to the sending peer.

Default 

no split-horizon

ttl-security

Syntax 
ttl-security min-ttl-value
no ttl-security
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command configures TTL security parameters for incoming packets. When the feature is enabled, BGP will accept incoming IP packets from a peer only if the TTL value in the packet is greater than or equal to the minimum TTL value configured for that peer.

The no form of the command disables TTL security.

Parameters 
min-ttl-value—
Specify the minimum TTL value for an incoming packet.
Values—
1 to 255

 

Default—
1

type

Syntax 
[no] type {internal | external}
Context 
config>router>bgp>group
config>router>bgp>group>neighbor
Description 

This command designates the BGP peer as type internal or external.

The type of internal indicates the peer is an IBGP peer while the type of external indicates that the peer is an EBGP peer.

By default, the router derives the type of neighbor based on the local AS specified. If the local AS specified is the same as the AS of the router, the peer is considered internal. If the local AS is different, then the peer is considered external.

The no form of the command used at the group level reverts to the default value.

The no form of the command used at the neighbor level reverts to the value defined at the group level.

Default 

no type

Parameters 
internal—
Configures the peer as internal.
external—
Configures the peer as external.

5.15.2.3. Other BGP-Related Commands

autonomous-system

Syntax 
autonomous-system autonomous-system-number
no autonomous-system
Context 
config>router
Description 

This command configures the autonomous system (AS) number for the router. A router can only belong to one AS. An AS number is a globally unique number with an AS. This number is used to exchange exterior routing information with neighboring ASs and as an identifier of the AS itself.

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 either by administratively disabling/enabling (shutdown/no shutdown) the BGP instance or rebooting the system with the new configuration.

Default 

no autonomous-system

Parameters 
autonomous-system-number—
The autonomous system number expressed as a decimal integer.
Values—
1 to 4294967295

 

router-id

Syntax 
router-id router-id
no router-id
Context 
config>router
Description 

This command configures the router ID for the router instance.

The router ID is used by both OSPF and BGP routing protocols in this instance of the routing table manager. IS-IS uses the router ID value as its system ID.

When configuring a new router ID, protocols are not automatically restarted with the new router ID. The next time a protocol is initialized, the new router ID is used. This can result in an interim period of time when different protocols use different router IDs.

To force the new router ID to be used, issue the shutdown and no shutdown commands for each protocol that uses the router ID, or restart the entire router.

The no form of the command to reverts to the default value.

Default 

The system uses the system interface address (which is also the loopback address). If a system interface address is not configured, use the last 32 bits of the chassis MAC address.

Parameters 
router-id—
The 32 bit router ID expressed in dotted decimal notation or as a decimal value.