Command reference

This section references all BGP commands available in the Turbo IPsec CLI. You can undo any command by prefixing it with delete.

Routing global configuration

CLI command Description
bgp multiple-instance Enable BGP multiple instance
ip as-path access-list NAME RMAP_ACTION (REG_EXP){1,*} Configure BGP autonomous system path filter
ip community-list EXTNUM|(expanded NAME) deny|permit (WORD){1,*} Add an exanded community-list entry
ip community-list STDNUM|(standard NAME) deny|permit (CATT|AANN){1,*} Add a community list entry
ip extcommunity-list EXTNUM|(expanded NAME) deny|permit (WORD){1,*} Add an extended community-list entry
ip extcommunity-list STDNUM|(standard NAME) deny|permit (TYPE AANN){1,*} Add an extended community list entry

Tokens help:

CATT
Community attribute: internet, local-AS, no-advertise or no-export.
EXTNUM
Extpanded community list number [100-500].
NAME
List name.
RMAP_ACTION
permit or deny set operations.
REG_EXP
A regular-expression to match.
STDNUM
Standard community list number [1-99].
TYPE
Extended community type: soo or rt.

Route maps global configuration

CLI command Description
match as-path AS_NAME Match BGP AS path list
match community <1-99>|<100-500>|WORD [exact-match] Match BGP community list
match extcommunity <1-99>|<100-500>|WORD Match BGP/VPN extended community list
match ip address <1-199>|<1300-2699>|WORD Match address of route
match ip address prefix-list WORD Match address of route
match ip next-hop <1-199>|<1300-2699>|WORD Match next-hop address of route
match ip next-hop prefix-list WORD Match next-hop address of route
match ip route-source <1-199>|<1300-2699>|WORD Match advertising source address of route
match ip route-source prefix-list WORD Match advertising source address of route
match ipv6 address [prefix-list] NAME Match entries of prefix-lists or access-list
match ipv6 next-hop X:X::X Match IPv6 next-hop address of route
match local-preference VAL Match local-preference of route
match metric VAL Match metric of route
match origin (egp|igp|incomplete) Match BGP originator ID attribute
match probability <0-100> Match portion of routes defined by percentage value
match peer local|A.B.C.D|X:X::X Match peer address
match tag VAL Match tag of route
set aggregator as VAL A.B.C.D Set BGP aggregator attributes
set as-path prepend (AS{1,*})|(last-as 1-10) Transform BGP as-path attribute
set atomic-aggregate Set BGP atomic aggregate attribute
set comm-list <1-99>|<100-500>|WORD delete set BGP community list (for deletion)
set community
(local-AS|no-advertise|no-export|internet|additive|AS:NN){1,*}
Set BGP community attributes
set as-path exclude AS{1,*} Transform BGP as-path attribute
set extcommunity soo ((AS:NN)|(A.B.C.D:NN)){1, *} BGP extended community Site-of-Origin extended attribute
set extcommunity rt ((AS:NN)|(A.B.C.D:NN)){1, *} BGP extended community Route Target extended attribute
set ipv6 next-hop (local|global X:X::X:X)|peer-address Set IPv6 next-hop address
set local-preference VAL Set BGP local preference path attribute
set metric VAL|+VAL|-VAL|rtt|+rtt|-rtt Set metric value for destination routing protocol
set origin (egp|igp|incomplete) Set BGP origin code
set originator-id A.B.C.D Set BGP originator ID attribute
set tag VAL Set tag value for routing protocol
set vpnv4 next-hop A.B.C.D Set VPNv4 next-hop address
set weight VAL Set BGP weight for routing table
set src A.B.C.D Set source address for route

Tokens help:

AS
AS number.
AS_NAME
AS path access-list name.
A.B.C.D
IPv4 address.
X:X::X
IPv6 address.
NAME
Prefix-list or access-list name.
VAL
Integer value.
rtt
Round trip time.

BGP global configuration

CLI command Description
address-family ipv4 multicast Enter address family ipv4 context
address-family ipv6 [multicast]|[unicast] Enter address family ipv6 context
address-family vpnv4 [unicast] Enter address family vpnv4 context
address-family encapv4 Enter address family encapv4 context
address-family encapv6 Enter address family encapv6 context
aggregate-address (A.B.C.D MASK)|A.B.C.D/M [summary-only] [as-set] Configure BGP4 aggregate entries
aggregate-address X:X::X/M [summary-only] Configure BGP4+ aggregate entries
bgp bestpath as-path confed Compare path lengths including confederation sets and sequences in selecting a route
bgp bestpath as-path ignore Ignore as-path length in selecting a route
bgp bestpath as-path multipath-relax Allow load sharing across routes that have different AS paths (but same length)
bgp bestpath med MED_ATTR{1,2} Change the default bestpath MED selection
bgp bestpath compare-routerid Compare router-id for identical EBGP paths
bgp cluster-id A.B.C.D|ID Configure the Route-Reflector cluster identifier
bgp confederation identifier CONFAS BGP confederation identifier command
bgp confederation peers CONFAS{1,100} BGP confederation peers command
bgp dampening [<1-45> [<1-20000> <1-20000> <1-255>]] Enable route-flap dampening
bgp default local-preference DEFAULT_PREF BGP default local-preference command
bgp deterministic-med Pick the best-MED path among paths advertised from the neighboring AS
bgp enforce-first-as Enforce the first AS for EBGP routes
bgp fast-external-failover Immediately reset session if a link to a directly connected external peer goes down
bgp graceful-restart Graceful restart capability
bgp graceful-restart restart-time TIMER Set the time to wait to delete stale routes before a BGP open message is received
bgp graceful-restart stalepath-time TIMER Set the max time to hold onto restarting peer’s stale paths
bgp log-neighbor-changes Log neighbor up/down and reset reason
bgp network import-check Enable to check if the BGP network route exists in IGP
bgp router-id A.B.C.D BGP router-id commands
bgp route-reflector allow-outbound-policy Allow modifications made by out route-map on ibgp neighbors
bgp update-delay DELAY Update delay
distance bgp EXT INT LOC Define the BGP administrative distance
distance DIST A.B.C.D/M [WORD] Define an administrative distance
distance DIST X:X::X/M [WORD] Define an administrative distance
maximum-paths [ibgp] NUM Forward packets over multiple paths
network A.B.C.D/M [backdoor|route-map WORD] Specify a network to announce via BGP
network A.B.C.D [backdoor|route-map WORD] Specify a network to announce via BGP
network A.B.C.D mask A.B.C.D [backdoor|route-map WORD] Specify a network to announce via BGP
network A.B.C.D/M rd RD_VAL tag TAG_VAL Specify a network to announce via BGP
network X:X::X/M [route-map WORD] Specify a network to announce via BGP
redistribute PROTOCOL [metric VAL] [route-map WORD] Redistribute information from another routing protocol
timers bgp KEEPALIVE HOLDTIME Adjust routing timers

Token help:

A.B.C.D
IPv4 address.
MASK
IP address mask.
A.B.C.D/M
IPv4 address (with mask).
X:X::X/M
IPv6 address (with mask).
CONFAS
Routing domain confederation AS (1-65535).
DEFAULT_PREF
Default local preference value (1-2147483647).
DELAY
Update delay (1-65535).
DIST
Administrative distance (1-255).
EXT
Distance for routes external to the AS (1-255).
HOLDTIME
Holdtime timer (0-65535).
ID
Cluster identifier as 32 bit quantity (automatically translated as an IPv4 address).
INT
Distance for routes internal to the AS (1-255).
KEEPALIVE
Keepalive interval timer (0-65535).
LOC
Distance for local routes (1-255).
MED_ATTR
  • confed: Compare MED among confederation paths
  • missing-as-worst: Treat missing MED as the least preferred one
METRIC
The route metric ([0-4294967295]).
PROTOCOL
IPv4 protocols: ospf, rip. IPv6 protocols: ospf6, ripng. IPv4/IPv6 protocols: connected, kernel, static.
RD_VAL
Route Distinguisher value (ASN:NN or IP:NN).
TAG_VAL
BGP tag ([1-1048575]).
TIMER
Time in seconds (1-3600).

BGP neighbors configuration

CLI command Description
neighbor A.B.C.D|X:X::X|PGNAME remote-as ASN Specify a BGP neighbor
neighbor PGNAME peer-group Configure peer-group
neighbor A.B.C.D|X:X::X peer-group PGNAME Member of the peer-group
neighbor A.B.C.D|X:X::X|PGNAME activate Enable the address family for this neighbor
neighbor A.B.C.D|X:X::X|PGNAME deactivate Disable the address family for this neighbor
neighbor A.B.C.D|X:X::X|PGNAME advertisement-interval SECONDS Specify neighbor advertisement interval
neighbor A.B.C.D|X:X::X|PGNAME allowas-in [<1-10>] Accept as-path with my AS present in it
neighbor A.B.C.D|X:X::X|PGNAME attribute-unchanged (ATTR_TYPE){0,3} BGP attribute is propagated unchanged to this neighbor
neighbor A.B.C.D|X:X::X|PGNAME capability dynamic Advertise dynamic capability to this neighbor
neighbor A.B.C.D|X:X::X|PGNAME capability orf prefix-list both Capability to SEND and RECEIVE the ORF to/from this neighbor
neighbor A.B.C.D|X:X::X|PGNAME capability orf prefix-list receive Capability to SEND the ORF to this neighbor
neighbor A.B.C.D|X:X::X|PGNAME capability orf prefix-list send Capability to RECEIVE the ORF from this neighbor
neighbor A.B.C.D|X:X::X|PGNAME default-originate [route-map WORD] Enable to originate a default route to a neighbor
neighbor A.B.C.D|X:X::X|PGNAME description LINE Neighbor specific description
neighbor A.B.C.D|X:X::X|PGNAME disable-connected-check One-hop away EBGP peer using loopback address
neighbor A.B.C.D|X:X::X|PGNAME distribute-list
(DIST_STD|DIST_EXP|DIST_NAME) (in|out)
Specify neighbor distribute list
neighbor A.B.C.D|X:X::X|PGNAME dont-capability-negotiate Do not perform capability negotiation
neighbor A.B.C.D|X:X::X|PGNAME ebgp-multihop [HOP_COUNT] Allow EBGP neighbors not on directly connected networks
neighbor A.B.C.D|X:X::X|PGNAME filter-list WORD (in|out) Establish BGP filters routes
neighbor A.B.C.D|X:X::X|PGNAME interface IFNAME Specify neighbor router interface
neighbor A.B.C.D|X:X::X|PGNAME local-as ASN [no-prepend [replace-as]] Specify a local-as number and options
neighbor A.B.C.D|X:X::X|PGNAME maximum-prefix
MAX[ THRESHOLD]
Specify maximum number of prefix accept from this neighbor
neighbor A.B.C.D|X:X::X|PGNAME maximum-prefix
MAX[ THRESHOLD] restart INTERVAL
Specify maximum number of prefix and estart bgp connection after limit is exceeded
neighbor A.B.C.D|X:X::X|PGNAME maximum-prefix
MAX[ THRESHOLD] warning-only
Specify maximum number of prefix but only give warning message when limit is exceeded
neighbor A.B.C.D|X:X::X|PGNAME next-hop-self [all] Disable the next hop calculation for this neighbor (It can be applied also to ibgp-learned routes when acting as a route reflector if all is set)
neighbor A.B.C.D|X:X::X|PGNAME nexthop-local unchanged Configure treatment of outgoing link-local nexthop attribute
neighbor A.B.C.D|X:X::X|PGNAME override-capability Override capability negotiation result
neighbor A.B.C.D|X:X::X|PGNAME passive Don’t send open messages to this neighbor
neighbor A.B.C.D|X:X::X|PGNAME password PASSWORD Specify neighbor password
neighbor A.B.C.D|X:X::X|PGNAME port PORT Configure neighbor’s BGP TCP port
neighbor A.B.C.D|X:X::X|PGNAME prefix-list PREFIX_NAME (in|out) Specify neighbor prefix list
neighbor A.B.C.D|X:X::X|PGNAME remove-private-AS Remove private AS number from outbound updates
neighbor A.B.C.D|X:X::X|PGNAME route-map RNAME in|out|import|export Specify neighbor route map
neighbor A.B.C.D|X:X::X|PGNAME route-reflector-client Configure a neighbor as route reflector client
neighbor A.B.C.D|X:X::X|PGNAME route-server-client Configure a neighbor as Route Server client
neighbor A.B.C.D|X:X::X|PGNAME send-community both Send Standard and Extended Community attributes
neighbor A.B.C.D|X:X::X|PGNAME send-community extended Send Extended Community attributes only
neighbor A.B.C.D|X:X::X|PGNAME send-community standard Send Standard Community attributes only
neighbor A.B.C.D|X:X::X|PGNAME shutdown Specify neighbor shutdown
neighbor A.B.C.D|X:X::X|PGNAME soft-reconfiguration inbound Enable inbound soft reconfiguration for a neighbor
neighbor A.B.C.D|X:X::X|PGNAME strict-capability-match Strict capability negotiation match
neighbor A.B.C.D|PGNAME timers connect TIMER Specify neighbor timers connect
neighbor A.B.C.D|X:X::X|PGNAME timers KEEPALIVE HOLDTIME Specify neighbor timers
neighbor A.B.C.D|X:X::X|PGNAME ttl-security hops HOPS Specify the maximum number of hops to the BGP peer
neighbor A.B.C.D|X:X::X|PGNAME unsuppress-map WORD Specify route-map to selectively unsuppress suppressed routes
neighbor A.B.C.D|X:X::X|PGNAME update-source UPSOURCE Specify source of routing updates
neighbor A.B.C.D|X:X::X|PGNAME weight WEIGHT Set default weight for routes from this neighbor

Tokens help:

ASN
Instance ID of BGP (0-65535).
ATTR_TYPE
as-path or next-hop or med.
A.B.C.D|X:X::X
IPv4 or IPv6 neighbor address.
DIST_EXP
IP access-list number (expanded range) (1300-2699).
DIST_NAME
IP Access-list name.
DIST_STD
IP access-list number (1-199).
HOLDTIME
Holdtime timer (0-65535).
HOP_COUNT
Maximum hop count (1-255).
IFNAME
Interface name.
KEEPALIVE
Keepalive interval timer (0-65535).
LINE
String with spaces.
PASSWORD
Neighbor password.
PGNAME
A peer group name.
PORT
TCP port (0-65535).
PREFIX_MANE
Name of a prefix updates.
RNAME
Name of the route map.
SECONDS
Time in seconds (0-600).
TIMER
Connect timer (0-65535).
UPSOURCE
The IPv4, IPv6 or the peer group name of the routing updates source.
WEIGHT
weight (0-65535).