7 :abbr:`BGP` stands for Border Gateway Protocol. The latest BGP version is 4.
8 BGP-4 is one of the Exterior Gateway Protocols and the de facto standard
9 interdomain routing protocol. BGP-4 is described in :rfc:`1771` and updated by
10 :rfc:`4271`. :rfc:`2858` adds multiprotocol support to BGP-4.
17 The default configuration file of *bgpd* is :file:`bgpd.conf`. *bgpd* searches
18 the current directory first, followed by |INSTALL_PREFIX_ETC|/bgpd.conf. All of
19 *bgpd*'s commands must be configured in :file:`bgpd.conf` when the integrated
20 config is not being used.
22 *bgpd* specific invocation options are described below. Common options may also
23 be specified (:ref:`common-invocation-options`).
27 .. option:: -p, --bgp_port <port>
29 Set the bgp protocol's port number. When port number is 0, that means do not
32 .. option:: -l, --listenon
34 Specify a specific IP address for bgpd to listen on, rather than its default
35 of ``0.0.0.0`` / ``::``. This can be useful to constrain bgpd to an internal
36 address, or to run multiple bgpd processes on one host.
38 .. _bgp-basic-concepts:
43 .. _bgp-autonomous-systems:
50 An AS is a connected group of one or more IP prefixes run by one or more
51 network operators which has a SINGLE and CLEARLY DEFINED routing policy.
53 Each AS has an identifying number associated with it called an :abbr:`ASN
54 (Autonomous System Number)`. This is a two octet value ranging in value from 1
55 to 65535. The AS numbers 64512 through 65535 are defined as private AS numbers.
56 Private AS numbers must not be advertised on the global Internet.
58 The :abbr:`ASN (Autonomous System Number)` is one of the essential elements of
59 BGP. BGP is a distance vector routing protocol, and the AS-Path framework
60 provides distance vector metric and loop detection to BGP.
62 .. seealso:: :rfc:`1930`
64 .. _bgp-address-families:
69 Multiprotocol extensions enable BGP to carry routing information for multiple
70 network layer protocols. BGP supports an Address Family Identifier (AFI) for
71 IPv4 and IPv6. Support is also provided for multiple sets of per-AFI
72 information via the BGP Subsequent Address Family Identifier (SAFI). FRR
73 supports SAFIs for unicast information, labeled information (:rfc:`3107` and
74 :rfc:`8277`), and Layer 3 VPN information (:rfc:`4364` and :rfc:`4659`).
76 .. _bgp-route-selection:
81 The route selection process used by FRR's BGP implementation uses the following
82 decision criterion, starting at the top of the list and going towards the
83 bottom until one of the factors can be used.
87 Prefer higher local weight routes to lower routes.
89 2. **Local preference check**
91 Prefer higher local preference routes to lower.
93 3. **Local route check**
95 Prefer local routes (statics, aggregates, redistributed) to received routes.
97 4. **AS path length check**
99 Prefer shortest hop-count AS_PATHs.
103 Prefer the lowest origin type route. That is, prefer IGP origin routes to
104 EGP, to Incomplete routes.
108 Where routes with a MED were received from the same AS, prefer the route
109 with the lowest MED. :ref:`bgp-med`.
111 7. **External check**
113 Prefer the route received from an external, eBGP peer over routes received
114 from other types of peers.
116 8. **IGP cost check**
118 Prefer the route with the lower IGP cost.
120 9. **Multi-path check**
122 If multi-pathing is enabled, then check whether the routes not yet
123 distinguished in preference may be considered equal. If
124 :clicmd:`bgp bestpath as-path multipath-relax` is set, all such routes are
125 considered equal, otherwise routes received via iBGP with identical AS_PATHs
126 or routes received from eBGP neighbours in the same AS are considered equal.
128 10. **Already-selected external check**
130 Where both routes were received from eBGP peers, then prefer the route
131 which is already selected. Note that this check is not applied if
132 :clicmd:`bgp bestpath compare-routerid` is configured. This check can
133 prevent some cases of oscillation.
135 11. **Router-ID check**
137 Prefer the route with the lowest `router-ID`. If the route has an
138 `ORIGINATOR_ID` attribute, through iBGP reflection, then that router ID is
139 used, otherwise the `router-ID` of the peer the route was received from is
142 12. **Cluster-List length check**
144 The route with the shortest cluster-list length is used. The cluster-list
145 reflects the iBGP reflection path the route has taken.
149 Prefer the route received from the peer with the higher transport layer
150 address, as a last-resort tie-breaker.
152 .. _bgp-capability-negotiation:
154 Capability Negotiation
155 ----------------------
157 When adding IPv6 routing information exchange feature to BGP. There were some
158 proposals. :abbr:`IETF (Internet Engineering Task Force)`
159 :abbr:`IDR (Inter Domain Routing)` adopted a proposal called Multiprotocol
160 Extension for BGP. The specification is described in :rfc:`2283`. The protocol
161 does not define new protocols. It defines new attributes to existing BGP. When
162 it is used exchanging IPv6 routing information it is called BGP-4+. When it is
163 used for exchanging multicast routing information it is called MBGP.
165 *bgpd* supports Multiprotocol Extension for BGP. So if a remote peer supports
166 the protocol, *bgpd* can exchange IPv6 and/or multicast routing information.
168 Traditional BGP did not have the feature to detect a remote peer's
169 capabilities, e.g. whether it can handle prefix types other than IPv4 unicast
170 routes. This was a big problem using Multiprotocol Extension for BGP in an
171 operational network. :rfc:`2842` adopted a feature called Capability
172 Negotiation. *bgpd* use this Capability Negotiation to detect the remote peer's
173 capabilities. If a peer is only configured as an IPv4 unicast neighbor, *bgpd*
174 does not send these Capability Negotiation packets (at least not unless other
175 optional BGP features require capability negotiation).
177 By default, FRR will bring up peering with minimal common capability for the
178 both sides. For example, if the local router has unicast and multicast
179 capabilities and the remote router only has unicast capability the local router
180 will establish the connection with unicast only capability. When there are no
181 common capabilities, FRR sends Unsupported Capability error and then resets the
184 .. _bgp-router-configuration:
186 BGP Router Configuration
187 ========================
192 First of all you must configure BGP router with the :clicmd:`router bgp ASN`
193 command. The AS number is an identifier for the autonomous system. The BGP
194 protocol uses the AS number for detecting whether the BGP connection is
195 internal or external.
197 .. index:: router bgp ASN
198 .. clicmd:: router bgp ASN
200 Enable a BGP protocol process with the specified ASN. After
201 this statement you can input any `BGP Commands`.
203 .. index:: no router bgp ASN
204 .. clicmd:: no router bgp ASN
206 Destroy a BGP protocol process with the specified ASN.
208 .. index:: bgp router-id A.B.C.D
209 .. clicmd:: bgp router-id A.B.C.D
211 This command specifies the router-ID. If *bgpd* connects to *zebra* it gets
212 interface and address information. In that case default router ID value is
213 selected as the largest IP Address of the interfaces. When `router zebra` is
214 not enabled *bgpd* can't get interface information so `router-id` is set to
215 0.0.0.0. So please set router-id by hand.
218 .. _bgp-multiple-autonomous-systems:
220 Multiple Autonomous Systems
221 ---------------------------
223 FRR's BGP implementation is capable of running multiple autonomous systems at
224 once. Each configured AS corresponds to a :ref:`zebra-vrf`. In the past, to get
225 the same functionality the network administrator had to run a new *bgpd*
226 process; using VRFs allows multiple autonomous systems to be handled in a
229 When using multiple autonomous systems, all router config blocks after the
230 first one must specify a VRF to be the target of BGP's route selection. This
231 VRF must be unique within respect to all other VRFs being used for the same
232 purpose, i.e. two different autonomous systems cannot use the same VRF.
233 However, the same AS can be used with different VRFs.
237 The separated nature of VRFs makes it possible to peer a single *bgpd*
238 process to itself, on one machine. Note that this can be done fully within
239 BGP without a corresponding VRF in the kernel or Zebra, which enables some
240 practical use cases such as :ref:`route reflectors <bgp-route-reflector>`
243 Configuration of additional autonomous systems, or of a router that targets a
244 specific VRF, is accomplished with the following command:
246 .. index:: router bgp ASN vrf VRFNAME
247 .. clicmd:: router bgp ASN vrf VRFNAME
249 ``VRFNAME`` is matched against VRFs configured in the kernel. When ``vrf
250 VRFNAME`` is not specified, the BGP protocol process belongs to the default
253 An example configuration with multiple autonomous systems might look like this:
258 neighbor 10.0.0.1 remote-as 20
259 neighbor 10.0.0.2 remote-as 30
261 router bgp 2 vrf blue
262 neighbor 10.0.0.3 remote-as 40
263 neighbor 10.0.0.4 remote-as 50
266 neighbor 10.0.0.5 remote-as 60
267 neighbor 10.0.0.6 remote-as 70
270 In the past this feature done differently and the following commands were
271 required to enable the functionality. They are now deprecated.
274 This command is deprecated and may be safely removed from the config.
276 .. index:: bgp multiple-instance
277 .. clicmd:: bgp multiple-instance
279 Enable BGP multiple instance feature. Because this is now the default
280 configuration this command will not be displayed in the running
284 This command is deprecated and may be safely removed from the config.
286 .. index:: no bgp multiple-instance
287 .. clicmd:: no bgp multiple-instance
289 In previous versions of FRR, this command disabled the BGP multiple instance
290 feature. This functionality is automatically turned on when BGP multiple
291 instances or views exist so this command no longer does anything.
293 .. seealso:: :ref:`bgp-vrf-route-leaking`
294 .. seealso:: :ref:`zebra-vrf`
302 In addition to supporting multiple autonomous systems, FRR's BGP implementation
303 also supports *views*.
305 BGP views are almost the same as normal BGP processes, except that routes
306 selected by BGP are not installed into the kernel routing table. Each BGP view
307 provides an independent set of routing information which is only distributed
308 via BGP. Multiple views can be supported, and BGP view information is always
309 independent from other routing protocols and Zebra/kernel routes. BGP views use
310 the core instance (i.e., default VRF) for communication with peers.
312 .. index:: router bgp AS-NUMBER view NAME
313 .. clicmd:: router bgp AS-NUMBER view NAME
315 Make a new BGP view. You can use an arbitrary word for the ``NAME``. Routes
316 selected by the view are not installed into the kernel routing table.
318 With this command, you can setup Route Server like below.
324 neighbor 10.0.0.1 remote-as 2
325 neighbor 10.0.0.2 remote-as 3
328 neighbor 10.0.0.3 remote-as 4
329 neighbor 10.0.0.4 remote-as 5
331 .. index:: show [ip] bgp view NAME
332 .. clicmd:: show [ip] bgp view NAME
334 Display the routing table of BGP view ``NAME``.
340 .. index:: bgp bestpath as-path confed
341 .. clicmd:: bgp bestpath as-path confed
343 This command specifies that the length of confederation path sets and
344 sequences should should be taken into account during the BGP best path
347 .. index:: bgp bestpath as-path multipath-relax
348 .. clicmd:: bgp bestpath as-path multipath-relax
350 This command specifies that BGP decision process should consider paths
351 of equal AS_PATH length candidates for multipath computation. Without
352 the knob, the entire AS_PATH must match for multipath computation.
354 .. clicmd:: bgp bestpath compare-routerid
356 Ensure that when comparing routes where both are equal on most metrics,
357 including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken
360 If this option is enabled, then the already-selected check, where
361 already selected eBGP routes are preferred, is skipped.
363 If a route has an `ORIGINATOR_ID` attribute because it has been reflected,
364 that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the
365 route was received from will be used.
367 The advantage of this is that the route-selection (at this point) will be
368 more deterministic. The disadvantage is that a few or even one lowest-ID
369 router may attract all traffic to otherwise-equal paths because of this
370 check. It may increase the possibility of MED or IGP oscillation, unless
371 other measures were taken to avoid these. The exact behaviour will be
372 sensitive to the iBGP and reflection topology.
376 Administrative Distance Metrics
377 -------------------------------
379 .. index:: distance bgp (1-255) (1-255) (1-255)
380 .. clicmd:: distance bgp (1-255) (1-255) (1-255)
382 This command change distance value of BGP. The arguments are the distance
383 values for for external routes, internal routes and local routes
386 .. index:: distance (1-255) A.B.C.D/M
387 .. clicmd:: distance (1-255) A.B.C.D/M
389 .. index:: distance (1-255) A.B.C.D/M WORD
390 .. clicmd:: distance (1-255) A.B.C.D/M WORD
392 Sets the administrative distance for a particular route.
394 .. _bgp-route-flap-dampening:
399 .. clicmd:: bgp dampening (1-45) (1-20000) (1-20000) (1-255)
401 This command enables BGP route-flap dampening and specifies dampening parameters.
404 Half-life time for the penalty
407 Value to start reusing a route
410 Value to start suppressing a route
413 Maximum duration to suppress a stable route
415 The route-flap damping algorithm is compatible with :rfc:`2439`. The use of
416 this command is not recommended nowadays.
419 https://www.ripe.net/publications/docs/ripe-378
423 Multi-Exit Discriminator
424 ------------------------
426 The BGP :abbr:`MED (Multi-Exit Discriminator)` attribute has properties which
427 can cause subtle convergence problems in BGP. These properties and problems
428 have proven to be hard to understand, at least historically, and may still not
429 be widely understood. The following attempts to collect together and present
430 what is known about MED, to help operators and FRR users in designing and
431 configuring their networks.
433 The BGP :abbr:`MED` attribute is intended to allow one AS to indicate its
434 preferences for its ingress points to another AS. The MED attribute will not be
435 propagated on to another AS by the receiving AS - it is 'non-transitive' in the
438 E.g., if AS X and AS Y have 2 different BGP peering points, then AS X might set
439 a MED of 100 on routes advertised at one and a MED of 200 at the other. When AS
440 Y selects between otherwise equal routes to or via AS X, AS Y should prefer to
441 take the path via the lower MED peering of 100 with AS X. Setting the MED
442 allows an AS to influence the routing taken to it within another, neighbouring
445 In this use of MED it is not really meaningful to compare the MED value on
446 routes where the next AS on the paths differs. E.g., if AS Y also had a route
447 for some destination via AS Z in addition to the routes from AS X, and AS Z had
448 also set a MED, it wouldn't make sense for AS Y to compare AS Z's MED values to
449 those of AS X. The MED values have been set by different administrators, with
450 different frames of reference.
452 The default behaviour of BGP therefore is to not compare MED values across
453 routes received from different neighbouring ASes. In FRR this is done by
454 comparing the neighbouring, left-most AS in the received AS_PATHs of the routes
455 and only comparing MED if those are the same.
457 Unfortunately, this behaviour of MED, of sometimes being compared across routes
458 and sometimes not, depending on the properties of those other routes, means MED
459 can cause the order of preference over all the routes to be undefined. That is,
460 given routes A, B, and C, if A is preferred to B, and B is preferred to C, then
461 a well-defined order should mean the preference is transitive (in the sense of
462 orders [#med-transitivity-rant]_) and that A would be preferred to C.
464 However, when MED is involved this need not be the case. With MED it is
465 possible that C is actually preferred over A. So A is preferred to B, B is
466 preferred to C, but C is preferred to A. This can be true even where BGP
467 defines a deterministic 'most preferred' route out of the full set of A,B,C.
468 With MED, for any given set of routes there may be a deterministically
469 preferred route, but there need not be any way to arrange them into any order
470 of preference. With unmodified MED, the order of preference of routes literally
473 That MED can induce non-transitive preferences over routes can cause issues.
474 Firstly, it may be perceived to cause routing table churn locally at speakers;
475 secondly, and more seriously, it may cause routing instability in iBGP
476 topologies, where sets of speakers continually oscillate between different
479 The first issue arises from how speakers often implement routing decisions.
480 Though BGP defines a selection process that will deterministically select the
481 same route as best at any given speaker, even with MED, that process requires
482 evaluating all routes together. For performance and ease of implementation
483 reasons, many implementations evaluate route preferences in a pair-wise fashion
484 instead. Given there is no well-defined order when MED is involved, the best
485 route that will be chosen becomes subject to implementation details, such as
486 the order the routes are stored in. That may be (locally) non-deterministic,
487 e.g.: it may be the order the routes were received in.
489 This indeterminism may be considered undesirable, though it need not cause
490 problems. It may mean additional routing churn is perceived, as sometimes more
491 updates may be produced than at other times in reaction to some event .
493 This first issue can be fixed with a more deterministic route selection that
494 ensures routes are ordered by the neighbouring AS during selection.
495 :clicmd:`bgp deterministic-med`. This may reduce the number of updates as routes
496 are received, and may in some cases reduce routing churn. Though, it could
497 equally deterministically produce the largest possible set of updates in
498 response to the most common sequence of received updates.
500 A deterministic order of evaluation tends to imply an additional overhead of
501 sorting over any set of n routes to a destination. The implementation of
502 deterministic MED in FRR scales significantly worse than most sorting
503 algorithms at present, with the number of paths to a given destination. That
504 number is often low enough to not cause any issues, but where there are many
505 paths, the deterministic comparison may quickly become increasingly expensive
508 Deterministic local evaluation can *not* fix the second, more major, issue of
509 MED however. Which is that the non-transitive preference of routes MED can
510 cause may lead to routing instability or oscillation across multiple speakers
511 in iBGP topologies. This can occur with full-mesh iBGP, but is particularly
512 problematic in non-full-mesh iBGP topologies that further reduce the routing
513 information known to each speaker. This has primarily been documented with iBGP
514 :ref:`route-reflection <bgp-route-reflector>` topologies. However, any
515 route-hiding technologies potentially could also exacerbate oscillation with MED.
517 This second issue occurs where speakers each have only a subset of routes, and
518 there are cycles in the preferences between different combinations of routes -
519 as the undefined order of preference of MED allows - and the routes are
520 distributed in a way that causes the BGP speakers to 'chase' those cycles. This
521 can occur even if all speakers use a deterministic order of evaluation in route
524 E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and from
525 speaker 3 in AS Y; while speaker 5 in AS A might receive that route from
526 speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 at speaker
527 3. I.e, using ASN:ID:MED to label the speakers:
533 X:2------|--A:4-------A:5--|-Y:1:200
539 Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then based
540 on the RFC4271 decision process speaker 4 will choose X:2 over Y:3:100, based
541 on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. Speaker 5 will
542 continue to prefer Y:1:200 based on the ID, and advertise this to speaker 4.
543 Speaker 4 will now have the full set of routes, and the Y:1:200 it receives
544 from 5 will beat X:2, but when speaker 4 compares Y:1:200 to Y:3:100 the MED
545 check now becomes active as the ASes match, and now Y:3:100 is preferred.
546 Speaker 4 therefore now advertises Y:3:100 to 5, which will also agrees that
547 Y:3:100 is preferred to Y:1:200, and so withdraws the latter route from 4.
548 Speaker 4 now has only X:2 and Y:3:100, and X:2 beats Y:3:100, and so speaker 4
549 implicitly updates its route to speaker 5 to X:2. Speaker 5 sees that Y:1:200
550 beats X:2 based on the ID, and advertises Y:1:200 to speaker 4, and the cycle
553 The root cause is the lack of a clear order of preference caused by how MED
554 sometimes is and sometimes is not compared, leading to this cycle in the
555 preferences between the routes:
560 /---> X:2 ---beats---> Y:3:100 --\\
563 \\---beats--- Y:1:200 <---beats---/
567 This particular type of oscillation in full-mesh iBGP topologies can be
568 avoided by speakers preferring already selected, external routes rather than
569 choosing to update to new a route based on a post-MED metric (e.g. router-ID),
570 at the cost of a non-deterministic selection process. FRR implements this, as
571 do many other implementations, so long as it is not overridden by setting
572 :clicmd:`bgp bestpath compare-routerid`, and see also
573 :ref:`bgp-route-selection`.
575 However, more complex and insidious cycles of oscillation are possible with
576 iBGP route-reflection, which are not so easily avoided. These have been
577 documented in various places. See, e.g.:
579 - [bgp-route-osci-cond]_
580 - [stable-flexible-ibgp]_
581 - [ibgp-correctness]_
583 for concrete examples and further references.
585 There is as of this writing *no* known way to use MED for its original purpose;
586 *and* reduce routing information in iBGP topologies; *and* be sure to avoid the
587 instability problems of MED due the non-transitive routing preferences it can
588 induce; in general on arbitrary networks.
590 There may be iBGP topology specific ways to reduce the instability risks, even
591 while using MED, e.g.: by constraining the reflection topology and by tuning
592 IGP costs between route-reflector clusters, see :rfc:`3345` for details. In the
593 near future, the Add-Path extension to BGP may also solve MED oscillation while
594 still allowing MED to be used as intended, by distributing "best-paths per
595 neighbour AS". This would be at the cost of distributing at least as many
596 routes to all speakers as a full-mesh iBGP would, if not more, while also
597 imposing similar CPU overheads as the "Deterministic MED" feature at each
600 More generally, the instability problems that MED can introduce on more
601 complex, non-full-mesh, iBGP topologies may be avoided either by:
603 - Setting :clicmd:`bgp always-compare-med`, however this allows MED to be compared
604 across values set by different neighbour ASes, which may not produce
605 coherent desirable results, of itself.
606 - Effectively ignoring MED by setting MED to the same value (e.g.: 0) using
607 :clicmd:`set metric METRIC` on all received routes, in combination with
608 setting :clicmd:`bgp always-compare-med` on all speakers. This is the simplest
609 and most performant way to avoid MED oscillation issues, where an AS is happy
610 not to allow neighbours to inject this problematic metric.
612 As MED is evaluated after the AS_PATH length check, another possible use for
613 MED is for intra-AS steering of routes with equal AS_PATH length, as an
614 extension of the last case above. As MED is evaluated before IGP metric, this
615 can allow cold-potato routing to be implemented to send traffic to preferred
616 hand-offs with neighbours, rather than the closest hand-off according to the
619 Note that even if action is taken to address the MED non-transitivity issues,
620 other oscillations may still be possible. E.g., on IGP cost if iBGP and IGP
621 topologies are at cross-purposes with each other - see the Flavel and Roughan
622 paper above for an example. Hence the guideline that the iBGP topology should
623 follow the IGP topology.
625 .. index:: bgp deterministic-med
626 .. clicmd:: bgp deterministic-med
628 Carry out route-selection in way that produces deterministic answers
629 locally, even in the face of MED and the lack of a well-defined order of
630 preference it can induce on routes. Without this option the preferred route
631 with MED may be determined largely by the order that routes were received
634 Setting this option will have a performance cost that may be noticeable when
635 there are many routes for each destination. Currently in FRR it is
636 implemented in a way that scales poorly as the number of routes per
637 destination increases.
639 The default is that this option is not set.
641 Note that there are other sources of indeterminism in the route selection
642 process, specifically, the preference for older and already selected routes
643 from eBGP peers, :ref:`bgp-route-selection`.
645 .. index:: bgp always-compare-med
646 .. clicmd:: bgp always-compare-med
648 Always compare the MED on routes, even when they were received from
649 different neighbouring ASes. Setting this option makes the order of
650 preference of routes more defined, and should eliminate MED induced
653 If using this option, it may also be desirable to use
654 :clicmd:`set metric METRIC` to set MED to 0 on routes received from external
657 This option can be used, together with :clicmd:`set metric METRIC` to use
658 MED as an intra-AS metric to steer equal-length AS_PATH routes to, e.g.,
666 .. index:: network A.B.C.D/M
667 .. clicmd:: network A.B.C.D/M
669 This command adds the announcement network.
674 address-family ipv4 unicast
678 This configuration example says that network 10.0.0.0/8 will be
679 announced to all neighbors. Some vendors' routers don't advertise
680 routes if they aren't present in their IGP routing tables; `bgpd`
681 doesn't care about IGP routes when announcing its routes.
683 .. index:: no network A.B.C.D/M
684 .. clicmd:: no network A.B.C.D/M
686 .. _bgp-route-aggregation:
691 .. index:: aggregate-address A.B.C.D/M
692 .. clicmd:: aggregate-address A.B.C.D/M
694 This command specifies an aggregate address.
696 .. index:: aggregate-address A.B.C.D/M as-set
697 .. clicmd:: aggregate-address A.B.C.D/M as-set
699 This command specifies an aggregate address. Resulting routes include
702 .. index:: aggregate-address A.B.C.D/M summary-only
703 .. clicmd:: aggregate-address A.B.C.D/M summary-only
705 This command specifies an aggregate address. Aggregated routes will
708 .. index:: no aggregate-address A.B.C.D/M
709 .. clicmd:: no aggregate-address A.B.C.D/M
711 .. _bgp-redistribute-to-bgp:
716 .. index:: redistribute kernel
717 .. clicmd:: redistribute kernel
719 Redistribute kernel route to BGP process.
721 .. index:: redistribute static
722 .. clicmd:: redistribute static
724 Redistribute static route to BGP process.
726 .. index:: redistribute connected
727 .. clicmd:: redistribute connected
729 Redistribute connected route to BGP process.
731 .. index:: redistribute rip
732 .. clicmd:: redistribute rip
734 Redistribute RIP route to BGP process.
736 .. index:: redistribute ospf
737 .. clicmd:: redistribute ospf
739 Redistribute OSPF route to BGP process.
741 .. index:: redistribute vpn
742 .. clicmd:: redistribute vpn
744 Redistribute VNC routes to BGP process.
746 .. index:: update-delay MAX-DELAY
747 .. clicmd:: update-delay MAX-DELAY
749 .. index:: update-delay MAX-DELAY ESTABLISH-WAIT
750 .. clicmd:: update-delay MAX-DELAY ESTABLISH-WAIT
752 This feature is used to enable read-only mode on BGP process restart or when
753 BGP process is cleared using 'clear ip bgp \*'. When applicable, read-only
754 mode would begin as soon as the first peer reaches Established status and a
755 timer for max-delay seconds is started.
757 During this mode BGP doesn't run any best-path or generate any updates to its
758 peers. This mode continues until:
760 1. All the configured peers, except the shutdown peers, have sent explicit EOR
761 (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached
762 Established is considered an implicit-EOR.
763 If the establish-wait optional value is given, then BGP will wait for
764 peers to reach established from the beginning of the update-delay till the
765 establish-wait period is over, i.e. the minimum set of established peers for
766 which EOR is expected would be peers established during the establish-wait
767 window, not necessarily all the configured neighbors.
768 2. max-delay period is over.
770 On hitting any of the above two conditions, BGP resumes the decision process
771 and generates updates to its peers.
773 Default max-delay is 0, i.e. the feature is off by default.
775 .. index:: table-map ROUTE-MAP-NAME
776 .. clicmd:: table-map ROUTE-MAP-NAME
778 This feature is used to apply a route-map on route updates from BGP to
779 Zebra. All the applicable match operations are allowed, such as match on
780 prefix, next-hop, communities, etc. Set operations for this attach-point are
781 limited to metric and next-hop only. Any operation of this feature does not
782 affect BGPs internal RIB.
784 Supported for ipv4 and ipv6 address families. It works on multi-paths as
785 well, however, metric setting is based on the best-path only.
792 .. _bgp-defining-peers:
797 .. index:: neighbor PEER remote-as ASN
798 .. clicmd:: neighbor PEER remote-as ASN
800 Creates a new neighbor whose remote-as is ASN. PEER can be an IPv4 address
801 or an IPv6 address or an interface to use for the connection.
806 neighbor 10.0.0.1 remote-as 2
808 In this case my router, in AS-1, is trying to peer with AS-2 at 10.0.0.1.
810 This command must be the first command used when configuring a neighbor. If
811 the remote-as is not specified, *bgpd* will complain like this: ::
813 can't find neighbor 10.0.0.1
815 .. index:: neighbor PEER remote-as internal
816 .. clicmd:: neighbor PEER remote-as internal
818 Create a peer as you would when you specify an ASN, except that if the
819 peers ASN is different than mine as specified under the :clicmd:`router bgp ASN`
820 command the connection will be denied.
822 .. index:: neighbor PEER remote-as external
823 .. clicmd:: neighbor PEER remote-as external
825 Create a peer as you would when you specify an ASN, except that if the
826 peers ASN is the same as mine as specified under the :clicmd:`router bgp ASN`
827 command the connection will be denied.
829 .. _bgp-configuring-peers:
834 .. index:: [no] neighbor PEER shutdown
835 .. clicmd:: [no] neighbor PEER shutdown
837 Shutdown the peer. We can delete the neighbor's configuration by
838 ``no neighbor PEER remote-as ASN`` but all configuration of the neighbor
839 will be deleted. When you want to preserve the configuration, but want to
840 drop the BGP peer, use this syntax.
842 .. index:: [no] neighbor PEER disable-connected-check
843 .. clicmd:: [no] neighbor PEER disable-connected-check
845 Allow peerings between directly connected eBGP peers using loopback
848 .. index:: [no] neighbor PEER ebgp-multihop
849 .. clicmd:: [no] neighbor PEER ebgp-multihop
851 .. index:: [no] neighbor PEER description ...
852 .. clicmd:: [no] neighbor PEER description ...
854 Set description of the peer.
856 .. index:: [no] neighbor PEER version VERSION
857 .. clicmd:: [no] neighbor PEER version VERSION
859 Set up the neighbor's BGP version. `version` can be `4`, `4+` or `4-`. BGP
860 version `4` is the default value used for BGP peering. BGP version `4+`
861 means that the neighbor supports Multiprotocol Extensions for BGP-4. BGP
862 version `4-` is similar but the neighbor speaks the old Internet-Draft
863 revision 00's Multiprotocol Extensions for BGP-4. Some routing software is
864 still using this version.
866 .. index:: [no] neighbor PEER interface IFNAME
867 .. clicmd:: [no] neighbor PEER interface IFNAME
869 When you connect to a BGP peer over an IPv6 link-local address, you have to
870 specify the IFNAME of the interface used for the connection. To specify
871 IPv4 session addresses, see the ``neighbor PEER update-source`` command
874 This command is deprecated and may be removed in a future release. Its use
877 .. index:: [no] neighbor PEER next-hop-self [all]
878 .. clicmd:: [no] neighbor PEER next-hop-self [all]
880 This command specifies an announced route's nexthop as being equivalent to
881 the address of the bgp router if it is learned via eBGP. If the optional
882 keyword `all` is specified the modification is done also for routes learned
885 .. index:: [no] neighbor PEER update-source <IFNAME|ADDRESS>
886 .. clicmd:: [no] neighbor PEER update-source <IFNAME|ADDRESS>
888 Specify the IPv4 source address to use for the :abbr:`BGP` session to this
889 neighbour, may be specified as either an IPv4 address directly or as an
890 interface name (in which case the *zebra* daemon MUST be running in order
891 for *bgpd* to be able to retrieve interface state).
896 neighbor foo update-source 192.168.0.1
897 neighbor bar update-source lo0
900 .. index:: [no] neighbor PEER default-originate
901 .. clicmd:: [no] neighbor PEER default-originate
903 *bgpd*'s default is to not announce the default route (0.0.0.0/0) even if it
904 is in routing table. When you want to announce default routes to the peer,
907 .. index:: neighbor PEER port PORT
908 .. clicmd:: neighbor PEER port PORT
910 .. index:: neighbor PEER send-community
911 .. clicmd:: neighbor PEER send-community
913 .. index:: [no] neighbor PEER weight WEIGHT
914 .. clicmd:: [no] neighbor PEER weight WEIGHT
916 This command specifies a default `weight` value for the neighbor's routes.
918 .. index:: [no] neighbor PEER maximum-prefix NUMBER
919 .. clicmd:: [no] neighbor PEER maximum-prefix NUMBER
921 .. index:: [no] neighbor PEER local-as AS-NUMBER no-prepend
922 .. clicmd:: [no] neighbor PEER local-as AS-NUMBER no-prepend
924 .. index:: [no] neighbor PEER local-as AS-NUMBER no-prepend replace-as
925 .. clicmd:: [no] neighbor PEER local-as AS-NUMBER no-prepend replace-as
927 .. index:: [no] neighbor PEER local-as AS-NUMBER
928 .. clicmd:: [no] neighbor PEER local-as AS-NUMBER
930 Specify an alternate AS for this BGP process when interacting with the
931 specified peer. With no modifiers, the specified local-as is prepended to
932 the received AS_PATH when receiving routing updates from the peer, and
933 prepended to the outgoing AS_PATH (after the process local AS) when
934 transmitting local routes to the peer.
936 If the no-prepend attribute is specified, then the supplied local-as is not
937 prepended to the received AS_PATH.
939 If the replace-as attribute is specified, then only the supplied local-as is
940 prepended to the AS_PATH when transmitting local-route updates to this peer.
942 Note that replace-as can only be specified if no-prepend is.
944 This command is only allowed for eBGP peers.
946 .. index:: [no] neighbor PEER ttl-security hops NUMBER
947 .. clicmd:: [no] neighbor PEER ttl-security hops NUMBER
949 This command enforces Generalized TTL Security Mechanism (GTSM), as
950 specified in RFC 5082. With this command, only neighbors that are the
951 specified number of hops away will be allowed to become neighbors. This
952 command is mutually exclusive with *ebgp-multihop*.
954 .. index:: [no] neighbor PEER capability extended-nexthop
955 .. clicmd:: [no] neighbor PEER capability extended-nexthop
957 Allow bgp to negotiate the extended-nexthop capability with it's peer.
958 If you are peering over a v6 LL address then this capability is turned
959 on automatically. If you are peering over a v6 Global Address then
960 turning on this command will allow BGP to install v4 routes with
961 v6 nexthops if you do not have v4 configured on interfaces.
963 .. index:: [no] bgp fast-external-failover
964 .. clicmd:: [no] bgp fast-external-failover
966 This command causes bgp to not take down ebgp peers immediately
967 when a link flaps. `bgp fast-external-failover` is the default
968 and will not be displayed as part of a `show run`. The no form
969 of the command turns off this ability.
971 .. index:: [no] bgp default ipv4-unicast
972 .. clicmd:: [no] bgp default ipv4-unicast
974 This command allows the user to specify that v4 peering is turned
975 on by default or not. This command defaults to on and is not displayed.
976 The `no bgp default ipv4-unicast` form of the command is displayed.
978 .. _bgp-peer-filtering:
983 .. index:: neighbor PEER distribute-list NAME [in|out]
984 .. clicmd:: neighbor PEER distribute-list NAME [in|out]
986 This command specifies a distribute-list for the peer. `direct` is
989 .. index:: neighbor PEER prefix-list NAME [in|out]
990 .. clicmd:: neighbor PEER prefix-list NAME [in|out]
992 .. index:: neighbor PEER filter-list NAME [in|out]
993 .. clicmd:: neighbor PEER filter-list NAME [in|out]
995 .. index:: neighbor PEER route-map NAME [in|out]
996 .. clicmd:: neighbor PEER route-map NAME [in|out]
998 Apply a route-map on the neighbor. `direct` must be `in` or `out`.
1000 .. index:: bgp route-reflector allow-outbound-policy
1001 .. clicmd:: bgp route-reflector allow-outbound-policy
1003 By default, attribute modification via route-map policy out is not reflected
1004 on reflected routes. This option allows the modifications to be reflected as
1005 well. Once enabled, it affects all reflected routes.
1012 Peer groups are used to help improve scaling by generating the same
1013 update information to all members of a peer group. Note that this means
1014 that the routes generated by a member of a peer group will be sent back
1015 to that originating peer with the originator identifier attribute set to
1016 indicated the originating peer. All peers not associated with a
1017 specific peer group are treated as belonging to a default peer group,
1018 and will share updates.
1020 .. index:: neighbor WORD peer-group
1021 .. clicmd:: neighbor WORD peer-group
1023 This command defines a new peer group.
1025 .. index:: neighbor PEER peer-group WORD
1026 .. clicmd:: neighbor PEER peer-group WORD
1028 This command bind specific peer to peer group WORD.
1030 .. index:: neighbor PEER solo
1031 .. clicmd:: neighbor PEER solo
1033 This command is used to indicate that routes advertised by the peer
1034 should not be reflected back to the peer. This command only is only
1035 meaningful when there is a single peer defined in the peer-group.
1037 Capability Negotiation
1038 ^^^^^^^^^^^^^^^^^^^^^^
1040 .. index:: neighbor PEER strict-capability-match
1041 .. clicmd:: neighbor PEER strict-capability-match
1043 .. index:: no neighbor PEER strict-capability-match
1044 .. clicmd:: no neighbor PEER strict-capability-match
1046 Strictly compares remote capabilities and local capabilities. If
1047 capabilities are different, send Unsupported Capability error then reset
1050 You may want to disable sending Capability Negotiation OPEN message optional
1051 parameter to the peer when remote peer does not implement Capability
1052 Negotiation. Please use *dont-capability-negotiate* command to disable the
1055 .. index:: neighbor PEER dont-capability-negotiate
1056 .. clicmd:: neighbor PEER dont-capability-negotiate
1058 .. index:: no neighbor PEER dont-capability-negotiate
1059 .. clicmd:: no neighbor PEER dont-capability-negotiate
1061 Suppress sending Capability Negotiation as OPEN message optional parameter
1062 to the peer. This command only affects the peer is configured other than
1063 IPv4 unicast configuration.
1065 When remote peer does not have capability negotiation feature, remote peer
1066 will not send any capabilities at all. In that case, bgp configures the peer
1067 with configured capabilities.
1069 You may prefer locally configured capabilities more than the negotiated
1070 capabilities even though remote peer sends capabilities. If the peer is
1071 configured by *override-capability*, *bgpd* ignores received capabilities
1072 then override negotiated capabilities with configured values.
1074 .. index:: neighbor PEER override-capability
1075 .. clicmd:: neighbor PEER override-capability
1077 .. index:: no neighbor PEER override-capability
1078 .. clicmd:: no neighbor PEER override-capability
1080 Override the result of Capability Negotiation with local configuration.
1081 Ignore remote peer's capability value.
1083 .. _bgp-as-path-access-lists:
1085 AS Path Access Lists
1086 --------------------
1088 AS path access list is user defined AS path.
1090 .. index:: ip as-path access-list WORD permit|deny LINE
1091 .. clicmd:: ip as-path access-list WORD permit|deny LINE
1093 This command defines a new AS path access list.
1095 .. index:: no ip as-path access-list WORD
1096 .. clicmd:: no ip as-path access-list WORD
1098 .. index:: no ip as-path access-list WORD permit|deny LINE
1099 .. clicmd:: no ip as-path access-list WORD permit|deny LINE
1101 .. _bgp-using-as-path-in-route-map:
1103 Using AS Path in Route Map
1104 --------------------------
1106 .. index:: match as-path WORD
1107 .. clicmd:: match as-path WORD
1110 .. index:: set as-path prepend AS-PATH
1111 .. clicmd:: set as-path prepend AS-PATH
1113 Prepend the given string of AS numbers to the AS_PATH.
1115 .. index:: set as-path prepend last-as NUM
1116 .. clicmd:: set as-path prepend last-as NUM
1118 Prepend the existing last AS number (the leftmost ASN) to the AS_PATH.
1120 .. _bgp-communities-attribute:
1122 Communities Attribute
1123 ---------------------
1125 The BGP communities attribute is widely used for implementing policy routing.
1126 Network operators can manipulate BGP communities attribute based on their
1127 network policy. BGP communities attribute is defined in :rfc:`1997` and
1128 :rfc:`1998`. It is an optional transitive attribute, therefore local policy can
1129 travel through different autonomous system.
1131 The communities attribute is a set of communities values. Each community value
1132 is 4 octet long. The following format is used to define the community value.
1135 This format represents 4 octet communities value. ``AS`` is high order 2
1136 octet in digit format. ``VAL`` is low order 2 octet in digit format. This
1137 format is useful to define AS oriented policy value. For example,
1138 ``7675:80`` can be used when AS 7675 wants to pass local policy value 80 to
1142 ``internet`` represents well-known communities value 0.
1144 ``graceful-shutdown``
1145 ``graceful-shutdown`` represents well-known communities value
1146 ``GRACEFUL_SHUTDOWN`` ``0xFFFF0000`` ``65535:0``. :rfc:`8326` implements
1147 the purpose Graceful BGP Session Shutdown to reduce the amount of
1148 lost traffic when taking BGP sessions down for maintenance. The use
1149 of the community needs to be supported from your peers side to
1150 actually have any effect.
1153 ``accept-own`` represents well-known communities value ``ACCEPT_OWN``
1154 ``0xFFFF0001`` ``65535:1``. :rfc:`7611` implements a way to signal
1155 to a router to accept routes with a local nexthop address. This
1156 can be the case when doing policing and having traffic having a
1157 nexthop located in another VRF but still local interface to the
1158 router. It is recommended to read the RFC for full details.
1160 ``route-filter-translated-v4``
1161 ``route-filter-translated-v4`` represents well-known communities value
1162 ``ROUTE_FILTER_TRANSLATED_v4`` ``0xFFFF0002`` ``65535:2``.
1165 ``route-filter-v4`` represents well-known communities value
1166 ``ROUTE_FILTER_v4`` ``0xFFFF0003`` ``65535:3``.
1168 ``route-filter-translated-v6``
1169 ``route-filter-translated-v6`` represents well-known communities value
1170 ``ROUTE_FILTER_TRANSLATED_v6`` ``0xFFFF0004`` ``65535:4``.
1173 ``route-filter-v6`` represents well-known communities value
1174 ``ROUTE_FILTER_v6`` ``0xFFFF0005`` ``65535:5``.
1177 ``llgr-stale`` represents well-known communities value ``LLGR_STALE``
1178 ``0xFFFF0006`` ``65535:6``.
1179 Assigned and intended only for use with routers supporting the
1180 Long-lived Graceful Restart Capability as described in
1181 [Draft-IETF-uttaro-idr-bgp-persistence]_.
1182 Routers receiving routes with this community may (depending on
1183 implementation) choose allow to reject or modify routes on the
1184 presence or absence of this community.
1187 ``no-llgr`` represents well-known communities value ``NO_LLGR``
1188 ``0xFFFF0007`` ``65535:7``.
1189 Assigned and intended only for use with routers supporting the
1190 Long-lived Graceful Restart Capability as described in
1191 [Draft-IETF-uttaro-idr-bgp-persistence]_.
1192 Routers receiving routes with this community may (depending on
1193 implementation) choose allow to reject or modify routes on the
1194 presence or absence of this community.
1196 ``accept-own-nexthop``
1197 ``accept-own-nexthop`` represents well-known communities value
1198 ``accept-own-nexthop`` ``0xFFFF0008`` ``65535:8``.
1199 [Draft-IETF-agrewal-idr-accept-own-nexthop]_ describes
1200 how to tag and label VPN routes to be able to send traffic between VRFs
1201 via an internal layer 2 domain on the same PE device. Refer to
1202 [Draft-IETF-agrewal-idr-accept-own-nexthop]_ for full details.
1205 ``blackhole`` represents well-known communities value ``BLACKHOLE``
1206 ``0xFFFF029A`` ``65535:666``. :rfc:`7999` documents sending prefixes to
1207 EBGP peers and upstream for the purpose of blackholing traffic.
1208 Prefixes tagged with the this community should normally not be
1209 re-advertised from neighbors of the originating network. It is
1210 recommended upon receiving prefixes tagged with this community to
1211 add ``NO_EXPORT`` and ``NO_ADVERTISE``.
1214 ``no-export`` represents well-known communities value ``NO_EXPORT``
1215 ``0xFFFFFF01``. All routes carry this value must not be advertised to
1216 outside a BGP confederation boundary. If neighboring BGP peer is part of BGP
1217 confederation, the peer is considered as inside a BGP confederation
1218 boundary, so the route will be announced to the peer.
1221 ``no-advertise`` represents well-known communities value ``NO_ADVERTISE``
1222 ``0xFFFFFF02``. All routes carry this value must not be advertise to other
1226 ``local-AS`` represents well-known communities value ``NO_EXPORT_SUBCONFED``
1227 ``0xFFFFFF03``. All routes carry this value must not be advertised to
1228 external BGP peers. Even if the neighboring router is part of confederation,
1229 it is considered as external BGP peer, so the route will not be announced to
1233 ``no-peer`` represents well-known communities value ``NOPEER``
1234 ``0xFFFFFF04`` ``65535:65284``. :rfc:`3765` is used to communicate to
1235 another network how the originating network want the prefix propagated.
1237 When the communities attribute is received duplicate community values in the
1238 attribute are ignored and value is sorted in numerical order.
1240 .. [Draft-IETF-uttaro-idr-bgp-persistence] <https://tools.ietf.org/id/draft-uttaro-idr-bgp-persistence-04.txt>
1241 .. [Draft-IETF-agrewal-idr-accept-own-nexthop] <https://tools.ietf.org/id/draft-agrewal-idr-accept-own-nexthop-00.txt>
1243 .. _bgp-community-lists:
1247 Community lists are user defined lists of community attribute values. These
1248 lists can be used for matching or manipulating the communities attribute in
1251 There are two types of community list:
1254 This type accepts an explicit value for the attribute.
1257 This type accepts a regular expression. Because the regex must be
1258 interpreted on each use expanded community lists are slower than standard
1261 .. index:: ip community-list standard NAME permit|deny COMMUNITY
1262 .. clicmd:: ip community-list standard NAME permit|deny COMMUNITY
1264 This command defines a new standard community list. ``COMMUNITY`` is
1265 communities value. The ``COMMUNITY`` is compiled into community structure.
1266 We can define multiple community list under same name. In that case match
1267 will happen user defined order. Once the community list matches to
1268 communities attribute in BGP updates it return permit or deny by the
1269 community list definition. When there is no matched entry, deny will be
1270 returned. When ``COMMUNITY`` is empty it matches to any routes.
1272 .. index:: ip community-list expanded NAME permit|deny COMMUNITY
1273 .. clicmd:: ip community-list expanded NAME permit|deny COMMUNITY
1275 This command defines a new expanded community list. ``COMMUNITY`` is a
1276 string expression of communities attribute. ``COMMUNITY`` can be a regular
1277 expression (:ref:`bgp-regular-expressions`) to match the communities
1278 attribute in BGP updates. The expanded community is only used to filter,
1282 It is recommended to use the more explicit versions of this command.
1284 .. index:: ip community-list NAME permit|deny COMMUNITY
1285 .. clicmd:: ip community-list NAME permit|deny COMMUNITY
1287 When the community list type is not specified, the community list type is
1288 automatically detected. If ``COMMUNITY`` can be compiled into communities
1289 attribute, the community list is defined as a standard community list.
1290 Otherwise it is defined as an expanded community list. This feature is left
1291 for backward compatibility. Use of this feature is not recommended.
1294 .. index:: no ip community-list [standard|expanded] NAME
1295 .. clicmd:: no ip community-list [standard|expanded] NAME
1297 Deletes the community list specified by ``NAME``. All community lists share
1298 the same namespace, so it's not necessary to specify ``standard`` or
1299 ``expanded``; these modifiers are purely aesthetic.
1301 .. index:: show ip community-list [NAME]
1302 .. clicmd:: show ip community-list [NAME]
1304 Displays community list information. When ``NAME`` is specified the
1305 specified community list's information is shown.
1309 # show ip community-list
1310 Named Community standard list CLIST
1311 permit 7675:80 7675:100 no-export
1313 Named Community expanded list EXPAND
1316 # show ip community-list CLIST
1317 Named Community standard list CLIST
1318 permit 7675:80 7675:100 no-export
1322 .. _bgp-numbered-community-lists:
1324 Numbered Community Lists
1325 ^^^^^^^^^^^^^^^^^^^^^^^^
1327 When number is used for BGP community list name, the number has
1328 special meanings. Community list number in the range from 1 and 99 is
1329 standard community list. Community list number in the range from 100
1330 to 199 is expanded community list. These community lists are called
1331 as numbered community lists. On the other hand normal community lists
1332 is called as named community lists.
1334 .. index:: ip community-list (1-99) permit|deny COMMUNITY
1335 .. clicmd:: ip community-list (1-99) permit|deny COMMUNITY
1337 This command defines a new community list. The argument to (1-99) defines
1338 the list identifier.
1340 .. index:: ip community-list (100-199) permit|deny COMMUNITY
1341 .. clicmd:: ip community-list (100-199) permit|deny COMMUNITY
1343 This command defines a new expanded community list. The argument to
1344 (100-199) defines the list identifier.
1346 .. _bgp-using-communities-in-route-map:
1348 Using Communities in Route Maps
1349 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1351 In :ref:`route-map` we can match on or set the BGP communities attribute. Using
1352 this feature network operator can implement their network policy based on BGP
1353 communities attribute.
1355 The ollowing commands can be used in route maps:
1357 .. index:: match community WORD exact-match [exact-match]
1358 .. clicmd:: match community WORD exact-match [exact-match]
1360 This command perform match to BGP updates using community list WORD. When
1361 the one of BGP communities value match to the one of communities value in
1362 community list, it is match. When `exact-match` keyword is specified, match
1363 happen only when BGP updates have completely same communities value
1364 specified in the community list.
1366 .. index:: set community <none|COMMUNITY> additive
1367 .. clicmd:: set community <none|COMMUNITY> additive
1369 This command sets the community value in BGP updates. If the attribute is
1370 already configured, the newly provided value replaces the old one unless the
1371 ``additive`` keyword is specified, in which case the new value is appended
1372 to the existing value.
1374 If ``none`` is specified as the community value, the communities attribute
1377 It is not possible to set an expanded community list.
1379 .. index:: set comm-list WORD delete
1380 .. clicmd:: set comm-list WORD delete
1382 This command remove communities value from BGP communities attribute. The
1383 ``word`` is community list name. When BGP route's communities value matches
1384 to the community list ``word``, the communities value is removed. When all
1385 of communities value is removed eventually, the BGP update's communities
1386 attribute is completely removed.
1388 .. _bgp-communities-example:
1390 Example Configuration
1391 ^^^^^^^^^^^^^^^^^^^^^
1393 The following configuration is exemplary of the most typical usage of BGP
1394 communities attribute. In the example, AS 7675 provides an upstream Internet
1395 connection to AS 100. When the following configuration exists in AS 7675, the
1396 network operator of AS 100 can set local preference in AS 7675 network by
1397 setting BGP communities attribute to the updates.
1402 neighbor 192.168.0.1 remote-as 100
1403 address-family ipv4 unicast
1404 neighbor 192.168.0.1 route-map RMAP in
1407 ip community-list 70 permit 7675:70
1408 ip community-list 70 deny
1409 ip community-list 80 permit 7675:80
1410 ip community-list 80 deny
1411 ip community-list 90 permit 7675:90
1412 ip community-list 90 deny
1414 route-map RMAP permit 10
1416 set local-preference 70
1418 route-map RMAP permit 20
1420 set local-preference 80
1422 route-map RMAP permit 30
1424 set local-preference 90
1427 The following configuration announces ``10.0.0.0/8`` from AS 100 to AS 7675.
1428 The route has communities value ``7675:80`` so when above configuration exists
1429 in AS 7675, the announced routes' local preference value will be set to 80.
1435 neighbor 192.168.0.2 remote-as 7675
1436 address-family ipv4 unicast
1437 neighbor 192.168.0.2 route-map RMAP out
1440 ip prefix-list PLIST permit 10.0.0.0/8
1442 route-map RMAP permit 10
1443 match ip address prefix-list PLIST
1444 set community 7675:80
1447 The following configuration is an example of BGP route filtering using
1448 communities attribute. This configuration only permit BGP routes which has BGP
1449 communities value ``0:80`` or ``0:90``. The network operator can set special
1450 internal communities value at BGP border router, then limit the BGP route
1451 announcements into the internal network.
1456 neighbor 192.168.0.1 remote-as 100
1457 address-family ipv4 unicast
1458 neighbor 192.168.0.1 route-map RMAP in
1461 ip community-list 1 permit 0:80 0:90
1463 route-map RMAP permit in
1467 The following example filters BGP routes which have a community value of
1468 ``1:1``. When there is no match community-list returns ``deny``. To avoid
1469 filtering all routes, a ``permit`` line is set at the end of the
1475 neighbor 192.168.0.1 remote-as 100
1476 address-family ipv4 unicast
1477 neighbor 192.168.0.1 route-map RMAP in
1480 ip community-list standard FILTER deny 1:1
1481 ip community-list standard FILTER permit
1483 route-map RMAP permit 10
1484 match community FILTER
1487 The communities value keyword ``internet`` has special meanings in standard
1488 community lists. In the below example ``internet`` matches all BGP routes even
1489 if the route does not have communities attribute at all. So community list
1490 ``INTERNET`` is the same as ``FILTER`` in the previous example.
1494 ip community-list standard INTERNET deny 1:1
1495 ip community-list standard INTERNET permit internet
1498 The following configuration is an example of communities value deletion. With
1499 this configuration the community values ``100:1`` and ``100:2`` are removed
1500 from BGP updates. For communities value deletion, only ``permit``
1501 community-list is used. ``deny`` community-list is ignored.
1506 neighbor 192.168.0.1 remote-as 100
1507 address-family ipv4 unicast
1508 neighbor 192.168.0.1 route-map RMAP in
1511 ip community-list standard DEL permit 100:1 100:2
1513 route-map RMAP permit 10
1514 set comm-list DEL delete
1517 .. _bgp-extended-communities-attribute:
1519 Extended Communities Attribute
1520 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1522 BGP extended communities attribute is introduced with MPLS VPN/BGP technology.
1523 MPLS VPN/BGP expands capability of network infrastructure to provide VPN
1524 functionality. At the same time it requires a new framework for policy routing.
1525 With BGP Extended Communities Attribute we can use Route Target or Site of
1526 Origin for implementing network policy for MPLS VPN/BGP.
1528 BGP Extended Communities Attribute is similar to BGP Communities Attribute. It
1529 is an optional transitive attribute. BGP Extended Communities Attribute can
1530 carry multiple Extended Community value. Each Extended Community value is
1533 BGP Extended Communities Attribute provides an extended range compared with BGP
1534 Communities Attribute. Adding to that there is a type field in each value to
1535 provides community space structure.
1537 There are two format to define Extended Community value. One is AS based format
1538 the other is IP address based format.
1541 This is a format to define AS based Extended Community value. ``AS`` part
1542 is 2 octets Global Administrator subfield in Extended Community value.
1543 ``VAL`` part is 4 octets Local Administrator subfield. ``7675:100``
1544 represents AS 7675 policy value 100.
1547 This is a format to define IP address based Extended Community value.
1548 ``IP-Address`` part is 4 octets Global Administrator subfield. ``VAL`` part
1549 is 2 octets Local Administrator subfield.
1551 .. _bgp-extended-community-lists:
1553 Extended Community Lists
1554 ^^^^^^^^^^^^^^^^^^^^^^^^
1556 .. index:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY
1557 .. clicmd:: ip extcommunity-list standard NAME permit|deny EXTCOMMUNITY
1559 This command defines a new standard extcommunity-list. `extcommunity` is
1560 extended communities value. The `extcommunity` is compiled into extended
1561 community structure. We can define multiple extcommunity-list under same
1562 name. In that case match will happen user defined order. Once the
1563 extcommunity-list matches to extended communities attribute in BGP updates
1564 it return permit or deny based upon the extcommunity-list definition. When
1565 there is no matched entry, deny will be returned. When `extcommunity` is
1566 empty it matches to any routes.
1568 .. index:: ip extcommunity-list expanded NAME permit|deny LINE
1569 .. clicmd:: ip extcommunity-list expanded NAME permit|deny LINE
1571 This command defines a new expanded extcommunity-list. `line` is a string
1572 expression of extended communities attribute. `line` can be a regular
1573 expression (:ref:`bgp-regular-expressions`) to match an extended communities
1574 attribute in BGP updates.
1576 .. index:: no ip extcommunity-list NAME
1577 .. clicmd:: no ip extcommunity-list NAME
1579 .. index:: no ip extcommunity-list standard NAME
1580 .. clicmd:: no ip extcommunity-list standard NAME
1582 .. index:: no ip extcommunity-list expanded NAME
1583 .. clicmd:: no ip extcommunity-list expanded NAME
1585 These commands delete extended community lists specified by `name`. All of
1586 extended community lists shares a single name space. So extended community
1587 lists can be removed simply specifying the name.
1589 .. index:: show ip extcommunity-list
1590 .. clicmd:: show ip extcommunity-list
1592 .. index:: show ip extcommunity-list NAME
1593 .. clicmd:: show ip extcommunity-list NAME
1595 This command displays current extcommunity-list information. When `name` is
1596 specified the community list's information is shown.::
1598 # show ip extcommunity-list
1601 .. _bgp-extended-communities-in-route-map:
1603 BGP Extended Communities in Route Map
1604 """""""""""""""""""""""""""""""""""""
1606 .. index:: match extcommunity WORD
1607 .. clicmd:: match extcommunity WORD
1609 .. index:: set extcommunity rt EXTCOMMUNITY
1610 .. clicmd:: set extcommunity rt EXTCOMMUNITY
1612 This command set Route Target value.
1614 .. index:: set extcommunity soo EXTCOMMUNITY
1615 .. clicmd:: set extcommunity soo EXTCOMMUNITY
1617 This command set Site of Origin value.
1620 Note that the extended expanded community is only used for `match` rule, not for
1623 .. _bgp-large-communities-attribute:
1625 Large Communities Attribute
1626 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1628 The BGP Large Communities attribute was introduced in Feb 2017 with
1631 The BGP Large Communities Attribute is similar to the BGP Communities Attribute
1632 except that it has 3 components instead of two and each of which are 4 octets
1633 in length. Large Communities bring additional functionality and convenience
1634 over traditional communities, specifically the fact that the ``GLOBAL`` part
1635 below is now 4 octets wide allowing seamless use in networks using 4-byte ASNs.
1637 ``GLOBAL:LOCAL1:LOCAL2``
1638 This is the format to define Large Community values. Referencing :rfc:`8195`
1639 the values are commonly referred to as follows:
1641 - The ``GLOBAL`` part is a 4 octet Global Administrator field, commonly used
1642 as the operators AS number.
1643 - The ``LOCAL1`` part is a 4 octet Local Data Part 1 subfield referred to as
1645 - The ``LOCAL2`` part is a 4 octet Local Data Part 2 field and referred to
1646 as the parameter subfield.
1648 As an example, ``65551:1:10`` represents AS 65551 function 1 and parameter
1649 10. The referenced RFC above gives some guidelines on recommended usage.
1651 .. _bgp-large-community-lists:
1653 Large Community Lists
1654 """""""""""""""""""""
1656 Two types of large community lists are supported, namely `standard` and
1659 .. index:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY
1660 .. clicmd:: ip large-community-list standard NAME permit|deny LARGE-COMMUNITY
1662 This command defines a new standard large-community-list. `large-community`
1663 is the Large Community value. We can add multiple large communities under
1664 same name. In that case the match will happen in the user defined order.
1665 Once the large-community-list matches the Large Communities attribute in BGP
1666 updates it will return permit or deny based upon the large-community-list
1667 definition. When there is no matched entry, a deny will be returned. When
1668 `large-community` is empty it matches any routes.
1670 .. index:: ip large-community-list expanded NAME permit|deny LINE
1671 .. clicmd:: ip large-community-list expanded NAME permit|deny LINE
1673 This command defines a new expanded large-community-list. Where `line` is a
1674 string matching expression, it will be compared to the entire Large
1675 Communities attribute as a string, with each large-community in order from
1676 lowest to highest. `line` can also be a regular expression which matches
1677 this Large Community attribute.
1679 .. index:: no ip large-community-list NAME
1680 .. clicmd:: no ip large-community-list NAME
1682 .. index:: no ip large-community-list standard NAME
1683 .. clicmd:: no ip large-community-list standard NAME
1685 .. index:: no ip large-community-list expanded NAME
1686 .. clicmd:: no ip large-community-list expanded NAME
1688 These commands delete Large Community lists specified by `name`. All Large
1689 Community lists share a single namespace. This means Large Community lists
1690 can be removed by simply specifying the name.
1692 .. index:: show ip large-community-list
1693 .. clicmd:: show ip large-community-list
1695 .. index:: show ip large-community-list NAME
1696 .. clicmd:: show ip large-community-list NAME
1698 This command display current large-community-list information. When
1699 `name` is specified the community list information is shown.
1701 .. index:: show ip bgp large-community-info
1702 .. clicmd:: show ip bgp large-community-info
1704 This command displays the current large communities in use.
1706 .. _bgp-large-communities-in-route-map:
1708 Large Communities in Route Map
1709 """"""""""""""""""""""""""""""
1711 .. index:: match large-community LINE
1712 .. clicmd:: match large-community LINE
1714 Where `line` can be a simple string to match, or a regular expression. It
1715 is very important to note that this match occurs on the entire
1716 large-community string as a whole, where each large-community is ordered
1717 from lowest to highest.
1719 .. index:: set large-community LARGE-COMMUNITY
1720 .. clicmd:: set large-community LARGE-COMMUNITY
1722 .. index:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY
1723 .. clicmd:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY
1725 .. index:: set large-community LARGE-COMMUNITY additive
1726 .. clicmd:: set large-community LARGE-COMMUNITY additive
1728 These commands are used for setting large-community values. The first
1729 command will overwrite any large-communities currently present.
1730 The second specifies two large-communities, which overwrites the current
1731 large-community list. The third will add a large-community value without
1732 overwriting other values. Multiple large-community values can be specified.
1734 Note that the large expanded community is only used for `match` rule, not for
1742 *bgpd* supports :abbr:`L3VPN (Layer 3 Virtual Private Networks)` :abbr:`VRFs
1743 (Virtual Routing and Forwarding)` for IPv4 :rfc:`4364` and IPv6 :rfc:`4659`.
1744 L3VPN routes, and their associated VRF MPLS labels, can be distributed to VPN
1745 SAFI neighbors in the *default*, i.e., non VRF, BGP instance. VRF MPLS labels
1746 are reached using *core* MPLS labels which are distributed using LDP or BGP
1747 labeled unicast. *bgpd* also supports inter-VRF route leaking.
1750 .. _bgp-vrf-route-leaking:
1755 BGP routes may be leaked (i.e. copied) between a unicast VRF RIB and the VPN
1756 SAFI RIB of the default VRF for use in MPLS-based L3VPNs. Unicast routes may
1757 also be leaked between any VRFs (including the unicast RIB of the default BGP
1758 instanced). A shortcut syntax is also available for specifying leaking from one
1759 VRF to another VRF using the default instance's VPN RIB as the intemediary. A
1760 common application of the VRF-VRF feature is to connect a customer's private
1761 routing domain to a provider's VPN service. Leaking is configured from the
1762 point of view of an individual VRF: ``import`` refers to routes leaked from VPN
1763 to a unicast VRF, whereas ``export`` refers to routes leaked from a unicast VRF
1769 Routes exported from a unicast VRF to the VPN RIB must be augmented by two
1772 - an :abbr:`RD (Route Distinguisher)`
1773 - an :abbr:`RTLIST (Route-target List)`
1775 Configuration for these exported routes must, at a minimum, specify these two
1778 Routes imported from the VPN RIB to a unicast VRF are selected according to
1779 their RTLISTs. Routes whose RTLIST contains at least one route-target in
1780 common with the configured import RTLIST are leaked. Configuration for these
1781 imported routes must specify an RTLIST to be matched.
1783 The RD, which carries no semantic value, is intended to make the route unique
1784 in the VPN RIB among all routes of its prefix that originate from all the
1785 customers and sites that are attached to the provider's VPN service.
1786 Accordingly, each site of each customer is typically assigned an RD that is
1787 unique across the entire provider network.
1789 The RTLIST is a set of route-target extended community values whose purpose is
1790 to specify route-leaking policy. Typically, a customer is assigned a single
1791 route-target value for import and export to be used at all customer sites. This
1792 configuration specifies a simple topology wherein a customer has a single
1793 routing domain which is shared across all its sites. More complex routing
1794 topologies are possible through use of additional route-targets to augment the
1795 leaking of sets of routes in various ways.
1797 When using the shortcut syntax for vrf-to-vrf leaking, the RD and RT are
1800 General configuration
1801 ^^^^^^^^^^^^^^^^^^^^^
1803 Configuration of route leaking between a unicast VRF RIB and the VPN SAFI RIB
1804 of the default VRF is accomplished via commands in the context of a VRF
1807 .. index:: rd vpn export AS:NN|IP:nn
1808 .. clicmd:: rd vpn export AS:NN|IP:nn
1810 Specifies the route distinguisher to be added to a route exported from the
1811 current unicast VRF to VPN.
1813 .. index:: no rd vpn export [AS:NN|IP:nn]
1814 .. clicmd:: no rd vpn export [AS:NN|IP:nn]
1816 Deletes any previously-configured export route distinguisher.
1818 .. index:: rt vpn import|export|both RTLIST...
1819 .. clicmd:: rt vpn import|export|both RTLIST...
1821 Specifies the route-target list to be attached to a route (export) or the
1822 route-target list to match against (import) when exporting/importing between
1823 the current unicast VRF and VPN.
1825 The RTLIST is a space-separated list of route-targets, which are BGP
1826 extended community values as described in
1827 :ref:`bgp-extended-communities-attribute`.
1829 .. index:: no rt vpn import|export|both [RTLIST...]
1830 .. clicmd:: no rt vpn import|export|both [RTLIST...]
1832 Deletes any previously-configured import or export route-target list.
1834 .. index:: label vpn export (0..1048575)|auto
1835 .. clicmd:: label vpn export (0..1048575)|auto
1837 Specifies an optional MPLS label to be attached to a route exported from the
1838 current unicast VRF to VPN. If label is specified as ``auto``, the label
1839 value is automatically assigned from a pool maintained by the zebra
1840 daemon. If zebra is not running, automatic label assignment will not
1841 complete, which will block corresponding route export.
1843 .. index:: no label vpn export [(0..1048575)|auto]
1844 .. clicmd:: no label vpn export [(0..1048575)|auto]
1846 Deletes any previously-configured export label.
1848 .. index:: nexthop vpn export A.B.C.D|X:X::X:X
1849 .. clicmd:: nexthop vpn export A.B.C.D|X:X::X:X
1851 Specifies an optional nexthop value to be assigned to a route exported from
1852 the current unicast VRF to VPN. If left unspecified, the nexthop will be set
1853 to 0.0.0.0 or 0:0::0:0 (self).
1855 .. index:: no nexthop vpn export [A.B.C.D|X:X::X:X]
1856 .. clicmd:: no nexthop vpn export [A.B.C.D|X:X::X:X]
1858 Deletes any previously-configured export nexthop.
1860 .. index:: route-map vpn import|export MAP
1861 .. clicmd:: route-map vpn import|export MAP
1863 Specifies an optional route-map to be applied to routes imported or exported
1864 between the current unicast VRF and VPN.
1866 .. index:: no route-map vpn import|export [MAP]
1867 .. clicmd:: no route-map vpn import|export [MAP]
1869 Deletes any previously-configured import or export route-map.
1871 .. index:: import|export vpn
1872 .. clicmd:: import|export vpn
1874 Enables import or export of routes between the current unicast VRF and VPN.
1876 .. index:: no import|export vpn
1877 .. clicmd:: no import|export vpn
1879 Disables import or export of routes between the current unicast VRF and VPN.
1881 .. index:: import vrf VRFNAME
1882 .. clicmd:: import vrf VRFNAME
1884 Shortcut syntax for specifying automatic leaking from vrf VRFNAME to
1885 the current VRF using the VPN RIB as intermediary. The RD and RT
1886 are auto derived and should not be specified explicitly for either the
1887 source or destination VRF's.
1889 This shortcut syntax mode is not compatible with the explicit
1890 `import vpn` and `export vpn` statements for the two VRF's involved.
1891 The CLI will disallow attempts to configure incompatible leaking
1894 .. index:: no import vrf VRFNAME
1895 .. clicmd:: no import vrf VRFNAME
1897 Disables automatic leaking from vrf VRFNAME to the current VRF using
1898 the VPN RIB as intermediary.
1901 .. _bgp-cisco-compatibility:
1906 FRR has commands that change some configuration syntax and default behavior to
1907 behave more closely to Cisco conventions. These are deprecated and will be
1908 removed in a future version of FRR.
1911 Please transition to using the FRR specific syntax for your configuration.
1913 .. index:: bgp config-type cisco
1914 .. clicmd:: bgp config-type cisco
1916 Cisco compatible BGP configuration output.
1918 When this configuration line is specified:
1920 - ``no synchronization`` is displayed. This command does nothing and is for
1921 display purposes only.
1922 - ``no auto-summary`` is displayed.
1923 - The ``network`` and ``aggregate-address`` arguments are displayed as:
1929 FRR: network 10.0.0.0/8
1930 Cisco: network 10.0.0.0
1932 FRR: aggregate-address 192.168.0.0/24
1933 Cisco: aggregate-address 192.168.0.0 255.255.255.0
1935 Community attribute handling is also different. If no configuration is
1936 specified community attribute and extended community attribute are sent to
1937 the neighbor. If a user manually disables the feature, the community
1938 attribute is not sent to the neighbor. When ``bgp config-type cisco`` is
1939 specified, the community attribute is not sent to the neighbor by default.
1940 To send the community attribute user has to specify
1941 :clicmd:`neighbor A.B.C.D send-community` like so:
1947 neighbor 10.0.0.1 remote-as 1
1948 address-family ipv4 unicast
1949 no neighbor 10.0.0.1 send-community
1953 neighbor 10.0.0.1 remote-as 1
1954 address-family ipv4 unicast
1955 neighbor 10.0.0.1 send-community
1960 Please transition to using the FRR specific syntax for your configuration.
1962 .. index:: bgp config-type zebra
1963 .. clicmd:: bgp config-type zebra
1965 FRR style BGP configuration. This is the default.
1972 .. index:: show debug
1973 .. clicmd:: show debug
1975 Show all enabled debugs.
1977 .. index:: [no] debug bgp neighbor-events
1978 .. clicmd:: [no] debug bgp neighbor-events
1980 Enable or disable debugging for neighbor events. This provides general
1981 information on BGP events such as peer connection / disconnection, session
1982 establishment / teardown, and capability negotiation.
1984 .. index:: [no] debug bgp updates
1985 .. clicmd:: [no] debug bgp updates
1987 Enable or disable debugging for BGP updates. This provides information on
1988 BGP UPDATE messages transmitted and received between local and remote
1991 .. index:: [no] debug bgp keepalives
1992 .. clicmd:: [no] debug bgp keepalives
1994 Enable or disable debugging for BGP keepalives. This provides information on
1995 BGP KEEPALIVE messages transmitted and received between local and remote
1998 .. index:: [no] debug bgp bestpath <A.B.C.D/M|X:X::X:X/M>
1999 .. clicmd:: [no] debug bgp bestpath <A.B.C.D/M|X:X::X:X/M>
2001 Enable or disable debugging for bestpath selection on the specified prefix.
2003 .. index:: [no] debug bgp nht
2004 .. clicmd:: [no] debug bgp nht
2006 Enable or disable debugging of BGP nexthop tracking.
2008 .. index:: [no] debug bgp update-groups
2009 .. clicmd:: [no] debug bgp update-groups
2011 Enable or disable debugging of dynamic update groups. This provides general
2012 information on group creation, deletion, join and prune events.
2014 .. index:: [no] debug bgp zebra
2015 .. clicmd:: [no] debug bgp zebra
2017 Enable or disable debugging of communications between *bgpd* and *zebra*.
2019 Dumping Messages and Routing Tables
2020 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2022 .. index:: dump bgp all PATH [INTERVAL]
2023 .. clicmd:: dump bgp all PATH [INTERVAL]
2025 .. index:: dump bgp all-et PATH [INTERVAL]
2026 .. clicmd:: dump bgp all-et PATH [INTERVAL]
2028 .. index:: no dump bgp all [PATH] [INTERVAL]
2029 .. clicmd:: no dump bgp all [PATH] [INTERVAL]
2031 Dump all BGP packet and events to `path` file.
2032 If `interval` is set, a new file will be created for echo `interval` of
2033 seconds. The path `path` can be set with date and time formatting
2034 (strftime). The type ‘all-et’ enables support for Extended Timestamp Header
2035 (:ref:`packet-binary-dump-format`).
2037 .. index:: dump bgp updates PATH [INTERVAL]
2038 .. clicmd:: dump bgp updates PATH [INTERVAL]
2040 .. index:: dump bgp updates-et PATH [INTERVAL]
2041 .. clicmd:: dump bgp updates-et PATH [INTERVAL]
2043 .. index:: no dump bgp updates [PATH] [INTERVAL]
2044 .. clicmd:: no dump bgp updates [PATH] [INTERVAL]
2046 Dump only BGP updates messages to `path` file.
2047 If `interval` is set, a new file will be created for echo `interval` of
2048 seconds. The path `path` can be set with date and time formatting
2049 (strftime). The type ‘updates-et’ enables support for Extended Timestamp
2050 Header (:ref:`packet-binary-dump-format`).
2052 .. index:: dump bgp routes-mrt PATH
2053 .. clicmd:: dump bgp routes-mrt PATH
2055 .. index:: dump bgp routes-mrt PATH INTERVAL
2056 .. clicmd:: dump bgp routes-mrt PATH INTERVAL
2058 .. index:: no dump bgp route-mrt [PATH] [INTERVAL]
2059 .. clicmd:: no dump bgp route-mrt [PATH] [INTERVAL]
2061 Dump whole BGP routing table to `path`. This is heavy process. The path
2062 `path` can be set with date and time formatting (strftime). If `interval` is
2063 set, a new file will be created for echo `interval` of seconds.
2065 Note: the interval variable can also be set using hours and minutes: 04h20m00.
2068 .. _bgp-other-commands:
2073 .. index:: clear bgp ipv4|ipv6 \*
2074 .. clicmd:: clear bgp ipv4|ipv6 \*
2076 Clear all address family peers.
2078 .. index:: clear bgp ipv4|ipv6 PEER
2079 .. clicmd:: clear bgp ipv4|ipv6 PEER
2081 Clear peers which have addresses of X.X.X.X
2083 .. index:: clear bgp ipv4|ipv6 PEER soft in
2084 .. clicmd:: clear bgp ipv4|ipv6 PEER soft in
2086 Clear peer using soft reconfiguration.
2089 .. _bgp-displaying-bgp-information:
2091 Displaying BGP Information
2092 ==========================
2094 The following four commands display the IPv6 and IPv4 routing tables, depending
2095 on whether or not the ``ip`` keyword is used.
2096 Actually, :clicmd:`show ip bgp` command was used on older `Quagga` routing
2097 daemon project, while :clicmd:`show bgp` command is the new format. The choice
2098 has been done to keep old format with IPv4 routing table, while new format
2099 displays IPv6 routing table.
2101 .. index:: show ip bgp
2102 .. clicmd:: show ip bgp
2104 .. index:: show ip bgp A.B.C.D
2105 .. clicmd:: show ip bgp A.B.C.D
2108 .. clicmd:: show bgp
2110 .. index:: show bgp X:X::X:X
2111 .. clicmd:: show bgp X:X::X:X
2113 These commands display BGP routes. When no route is specified, the default
2114 is to display all BGP routes.
2118 BGP table version is 0, local router ID is 10.1.1.1
2119 Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
2120 Origin codes: i - IGP, e - EGP, ? - incomplete
2122 Network Next Hop Metric LocPrf Weight Path
2123 \*> 1.1.1.1/32 0.0.0.0 0 32768 i
2125 Total number of prefixes 1
2127 Some other commands provide additional options for filtering the output.
2129 .. index:: show [ip] bgp regexp LINE
2130 .. clicmd:: show [ip] bgp regexp LINE
2132 This command displays BGP routes using AS path regular expression
2133 (:ref:`bgp-regular-expressions`).
2135 .. index:: show [ip] bgp summary
2136 .. clicmd:: show [ip] bgp summary
2138 Show a bgp peer summary for the specified address family.
2140 The old command structure :clicmd:`show ip bgp` may be removed in the future
2141 and should no longer be used. In order to reach the other BGP routing tables
2142 other than the IPv6 routing table given by :clicmd:`show bgp`, the new command
2143 structure is extended with :clicmd:`show bgp [afi] [safi]`.
2145 .. index:: show bgp [afi] [safi]
2146 .. clicmd:: show bgp [afi] [safi]
2148 .. index:: show bgp <ipv4|ipv6> <unicast|multicast|vpn|labeled-unicast>
2149 .. clicmd:: show bgp <ipv4|ipv6> <unicast|multicast|vpn|labeled-unicast>
2151 These commands display BGP routes for the specific routing table indicated by
2152 the selected afi and the selected safi. If no afi and no safi value is given,
2153 the command falls back to the default IPv6 routing table
2155 .. index:: show bgp [afi] [safi] summary
2156 .. clicmd:: show bgp [afi] [safi] summary
2158 Show a bgp peer summary for the specified address family, and subsequent
2161 .. index:: show bgp [afi] [safi] neighbor [PEER]
2162 .. clicmd:: show bgp [afi] [safi] neighbor [PEER]
2164 This command shows information on a specific BGP peer of the relevant
2165 afi and safi selected.
2167 .. index:: show bgp [afi] [safi] dampening dampened-paths
2168 .. clicmd:: show bgp [afi] [safi] dampening dampened-paths
2170 Display paths suppressed due to dampening of the selected afi and safi
2173 .. index:: show bgp [afi] [safi] dampening flap-statistics
2174 .. clicmd:: show bgp [afi] [safi] dampening flap-statistics
2176 Display flap statistics of routes of the selected afi and safi selected.
2178 .. _bgp-display-routes-by-community:
2180 Displaying Routes by Community Attribute
2181 ----------------------------------------
2183 The following commands allow displaying routes based on their community
2186 .. index:: show [ip] bgp <ipv4|ipv6> community
2187 .. clicmd:: show [ip] bgp <ipv4|ipv6> community
2189 .. index:: show [ip] bgp <ipv4|ipv6> community COMMUNITY
2190 .. clicmd:: show [ip] bgp <ipv4|ipv6> community COMMUNITY
2192 .. index:: show [ip] bgp <ipv4|ipv6> community COMMUNITY exact-match
2193 .. clicmd:: show [ip] bgp <ipv4|ipv6> community COMMUNITY exact-match
2195 These commands display BGP routes which have the community attribute.
2196 attribute. When ``COMMUNITY`` is specified, BGP routes that match that
2197 community are displayed. When `exact-match` is specified, it display only
2198 routes that have an exact match.
2200 .. index:: show [ip] bgp <ipv4|ipv6> community-list WORD
2201 .. clicmd:: show [ip] bgp <ipv4|ipv6> community-list WORD
2203 .. index:: show [ip] bgp <ipv4|ipv6> community-list WORD exact-match
2204 .. clicmd:: show [ip] bgp <ipv4|ipv6> community-list WORD exact-match
2206 These commands display BGP routes for the address family specified that
2207 match the specified community list. When `exact-match` is specified, it
2208 displays only routes that have an exact match.
2210 .. _bgp-display-routes-by-as-path:
2212 Displaying Routes by AS Path
2213 ----------------------------
2215 .. index:: show bgp ipv4|ipv6 regexp LINE
2216 .. clicmd:: show bgp ipv4|ipv6 regexp LINE
2218 This commands displays BGP routes that matches a regular
2219 expression `line` (:ref:`bgp-regular-expressions`).
2221 .. index:: show [ip] bgp ipv4 vpn
2222 .. clicmd:: show [ip] bgp ipv4 vpn
2224 .. index:: show [ip] bgp ipv6 vpn
2225 .. clicmd:: show [ip] bgp ipv6 vpn
2227 Print active IPV4 or IPV6 routes advertised via the VPN SAFI.
2229 .. index:: show bgp ipv4 vpn summary
2230 .. clicmd:: show bgp ipv4 vpn summary
2232 .. index:: show bgp ipv6 vpn summary
2233 .. clicmd:: show bgp ipv6 vpn summary
2235 Print a summary of neighbor connections for the specified AFI/SAFI combination.
2238 .. _bgp-route-reflector:
2243 BGP routers connected inside the same AS through BGP belong to an internal
2244 BGP session, or IBGP. In order to prevent routing table loops, IBGP does not
2245 advertise IBGP-learned routes to other routers in the same session. As such,
2246 IBGP requires a full mesh of all peers. For large networks, this quickly becomes
2247 unscalable. Introducing route reflectors removes the need for the full-mesh.
2249 When route reflectors are configured, these will reflect the routes announced
2250 by the peers configured as clients. A route reflector client is configured
2253 .. index:: neighbor PEER route-reflector-client
2254 .. clicmd:: neighbor PEER route-reflector-client
2256 .. index:: no neighbor PEER route-reflector-client
2257 .. clicmd:: no neighbor PEER route-reflector-client
2259 To avoid single points of failure, multiple route reflectors can be configured.
2261 A cluster is a collection of route reflectors and their clients, and is used
2262 by route reflectors to avoid looping.
2264 .. index:: bgp cluster-id A.B.C.D
2265 .. clicmd:: bgp cluster-id A.B.C.D
2272 You can set different routing policy for a peer. For example, you can set
2273 different filter for a peer.
2277 bgp multiple-instance
2280 neighbor 10.0.0.1 remote-as 2
2281 address-family ipv4 unicast
2282 neighbor 10.0.0.1 distribute-list 1 in
2286 neighbor 10.0.0.1 remote-as 2
2287 address-family ipv4 unicast
2288 neighbor 10.0.0.1 distribute-list 2 in
2291 This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view 2.
2292 When the update is inserted into view 1, distribute-list 1 is applied. On the
2293 other hand, when the update is inserted into view 2, distribute-list 2 is
2297 .. _bgp-regular-expressions:
2299 BGP Regular Expressions
2300 =======================
2302 BGP regular expressions are based on :t:`POSIX 1003.2` regular expressions. The
2303 following description is just a quick subset of the POSIX regular expressions.
2307 Matches any single character.
2310 Matches 0 or more occurrences of pattern.
2313 Matches 1 or more occurrences of pattern.
2316 Match 0 or 1 occurrences of pattern.
2319 Matches the beginning of the line.
2322 Matches the end of the line.
2325 The ``_`` character has special meanings in BGP regular expressions. It
2326 matches to space and comma , and AS set delimiter ``{`` and ``}`` and AS
2327 confederation delimiter ``(`` and ``)``. And it also matches to the
2328 beginning of the line and the end of the line. So ``_`` can be used for AS
2329 value boundaries match. This character technically evaluates to
2333 .. _bgp-configuration-examples:
2335 Miscellaneous Configuration Examples
2336 ====================================
2338 Example of a session to an upstream, advertising only one prefix to it.
2343 bgp router-id 10.236.87.1
2344 neighbor upstream peer-group
2345 neighbor upstream remote-as 64515
2346 neighbor upstream capability dynamic
2347 neighbor 10.1.1.1 peer-group upstream
2348 neighbor 10.1.1.1 description ACME ISP
2350 address-family ipv4 unicast
2351 network 10.236.87.0/24
2352 neighbor upstream prefix-list pl-allowed-adv out
2355 ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25
2356 ip prefix-list pl-allowed-adv seq 10 deny any
2358 A more complex example including upstream, peer and customer sessions
2359 advertising global prefixes and NO_EXPORT prefixes and providing actions for
2360 customer routes based on community values. Extensive use is made of route-maps
2361 and the 'call' feature to support selective advertising of prefixes. This
2362 example is intended as guidance only, it has NOT been tested and almost
2363 certainly contains silly mistakes, if not serious flaws.
2368 bgp router-id 10.236.87.1
2369 neighbor upstream capability dynamic
2370 neighbor cust capability dynamic
2371 neighbor peer capability dynamic
2372 neighbor 10.1.1.1 remote-as 64515
2373 neighbor 10.1.1.1 peer-group upstream
2374 neighbor 10.2.1.1 remote-as 64516
2375 neighbor 10.2.1.1 peer-group upstream
2376 neighbor 10.3.1.1 remote-as 64517
2377 neighbor 10.3.1.1 peer-group cust-default
2378 neighbor 10.3.1.1 description customer1
2379 neighbor 10.4.1.1 remote-as 64518
2380 neighbor 10.4.1.1 peer-group cust
2381 neighbor 10.4.1.1 description customer2
2382 neighbor 10.5.1.1 remote-as 64519
2383 neighbor 10.5.1.1 peer-group peer
2384 neighbor 10.5.1.1 description peer AS 1
2385 neighbor 10.6.1.1 remote-as 64520
2386 neighbor 10.6.1.1 peer-group peer
2387 neighbor 10.6.1.1 description peer AS 2
2389 address-family ipv4 unicast
2390 network 10.123.456.0/24
2391 network 10.123.456.128/25 route-map rm-no-export
2392 neighbor upstream route-map rm-upstream-out out
2393 neighbor cust route-map rm-cust-in in
2394 neighbor cust route-map rm-cust-out out
2395 neighbor cust send-community both
2396 neighbor peer route-map rm-peer-in in
2397 neighbor peer route-map rm-peer-out out
2398 neighbor peer send-community both
2399 neighbor 10.3.1.1 prefix-list pl-cust1-network in
2400 neighbor 10.4.1.1 prefix-list pl-cust2-network in
2401 neighbor 10.5.1.1 prefix-list pl-peer1-network in
2402 neighbor 10.6.1.1 prefix-list pl-peer2-network in
2405 ip prefix-list pl-default permit 0.0.0.0/0
2407 ip prefix-list pl-upstream-peers permit 10.1.1.1/32
2408 ip prefix-list pl-upstream-peers permit 10.2.1.1/32
2410 ip prefix-list pl-cust1-network permit 10.3.1.0/24
2411 ip prefix-list pl-cust1-network permit 10.3.2.0/24
2413 ip prefix-list pl-cust2-network permit 10.4.1.0/24
2415 ip prefix-list pl-peer1-network permit 10.5.1.0/24
2416 ip prefix-list pl-peer1-network permit 10.5.2.0/24
2417 ip prefix-list pl-peer1-network permit 192.168.0.0/24
2419 ip prefix-list pl-peer2-network permit 10.6.1.0/24
2420 ip prefix-list pl-peer2-network permit 10.6.2.0/24
2421 ip prefix-list pl-peer2-network permit 192.168.1.0/24
2422 ip prefix-list pl-peer2-network permit 192.168.2.0/24
2423 ip prefix-list pl-peer2-network permit 172.16.1/24
2425 ip as-path access-list asp-own-as permit ^$
2426 ip as-path access-list asp-own-as permit _64512_
2428 ! #################################################################
2429 ! Match communities we provide actions for, on routes receives from
2430 ! customers. Communities values of <our-ASN>:X, with X, have actions:
2432 ! 100 - blackhole the prefix
2433 ! 200 - set no_export
2434 ! 300 - advertise only to other customers
2435 ! 400 - advertise only to upstreams
2436 ! 500 - set no_export when advertising to upstreams
2437 ! 2X00 - set local_preference to X00
2439 ! blackhole the prefix of the route
2440 ip community-list standard cm-blackhole permit 64512:100
2442 ! set no-export community before advertising
2443 ip community-list standard cm-set-no-export permit 64512:200
2445 ! advertise only to other customers
2446 ip community-list standard cm-cust-only permit 64512:300
2448 ! advertise only to upstreams
2449 ip community-list standard cm-upstream-only permit 64512:400
2451 ! advertise to upstreams with no-export
2452 ip community-list standard cm-upstream-noexport permit 64512:500
2454 ! set local-pref to least significant 3 digits of the community
2455 ip community-list standard cm-prefmod-100 permit 64512:2100
2456 ip community-list standard cm-prefmod-200 permit 64512:2200
2457 ip community-list standard cm-prefmod-300 permit 64512:2300
2458 ip community-list standard cm-prefmod-400 permit 64512:2400
2459 ip community-list expanded cme-prefmod-range permit 64512:2...
2461 ! Informational communities
2463 ! 3000 - learned from upstream
2464 ! 3100 - learned from customer
2465 ! 3200 - learned from peer
2467 ip community-list standard cm-learnt-upstream permit 64512:3000
2468 ip community-list standard cm-learnt-cust permit 64512:3100
2469 ip community-list standard cm-learnt-peer permit 64512:3200
2471 ! ###################################################################
2472 ! Utility route-maps
2474 ! These utility route-maps generally should not used to permit/deny
2475 ! routes, i.e. they do not have meaning as filters, and hence probably
2476 ! should be used with 'on-match next'. These all finish with an empty
2477 ! permit entry so as not interfere with processing in the caller.
2479 route-map rm-no-export permit 10
2480 set community additive no-export
2481 route-map rm-no-export permit 20
2483 route-map rm-blackhole permit 10
2484 description blackhole, up-pref and ensure it cannot escape this AS
2485 set ip next-hop 127.0.0.1
2486 set local-preference 10
2487 set community additive no-export
2488 route-map rm-blackhole permit 20
2490 ! Set local-pref as requested
2491 route-map rm-prefmod permit 10
2492 match community cm-prefmod-100
2493 set local-preference 100
2494 route-map rm-prefmod permit 20
2495 match community cm-prefmod-200
2496 set local-preference 200
2497 route-map rm-prefmod permit 30
2498 match community cm-prefmod-300
2499 set local-preference 300
2500 route-map rm-prefmod permit 40
2501 match community cm-prefmod-400
2502 set local-preference 400
2503 route-map rm-prefmod permit 50
2505 ! Community actions to take on receipt of route.
2506 route-map rm-community-in permit 10
2507 description check for blackholing, no point continuing if it matches.
2508 match community cm-blackhole
2510 route-map rm-community-in permit 20
2511 match community cm-set-no-export
2514 route-map rm-community-in permit 30
2515 match community cme-prefmod-range
2517 route-map rm-community-in permit 40
2519 ! #####################################################################
2520 ! Community actions to take when advertising a route.
2521 ! These are filtering route-maps,
2523 ! Deny customer routes to upstream with cust-only set.
2524 route-map rm-community-filt-to-upstream deny 10
2525 match community cm-learnt-cust
2526 match community cm-cust-only
2527 route-map rm-community-filt-to-upstream permit 20
2529 ! Deny customer routes to other customers with upstream-only set.
2530 route-map rm-community-filt-to-cust deny 10
2531 match community cm-learnt-cust
2532 match community cm-upstream-only
2533 route-map rm-community-filt-to-cust permit 20
2535 ! ###################################################################
2536 ! The top-level route-maps applied to sessions. Further entries could
2537 ! be added obviously..
2540 route-map rm-cust-in permit 10
2541 call rm-community-in
2543 route-map rm-cust-in permit 20
2544 set community additive 64512:3100
2545 route-map rm-cust-in permit 30
2547 route-map rm-cust-out permit 10
2548 call rm-community-filt-to-cust
2550 route-map rm-cust-out permit 20
2552 ! Upstream transit ASes
2553 route-map rm-upstream-out permit 10
2554 description filter customer prefixes which are marked cust-only
2555 call rm-community-filt-to-upstream
2557 route-map rm-upstream-out permit 20
2558 description only customer routes are provided to upstreams/peers
2559 match community cm-learnt-cust
2562 ! outbound policy is same as for upstream
2563 route-map rm-peer-out permit 10
2564 call rm-upstream-out
2566 route-map rm-peer-in permit 10
2567 set community additive 64512:3200
2570 Example of how to set up a 6-Bone connection.
2574 ! bgpd configuration
2575 ! ==================
2577 ! MP-BGP configuration
2580 bgp router-id 10.0.0.1
2581 neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number`
2584 network 3ffe:506::/32
2585 neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate
2586 neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out
2587 neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number`
2588 neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out
2591 ipv6 access-list all permit any
2593 ! Set output nexthop address.
2595 route-map set-nexthop permit 10
2596 match ipv6 address all
2597 set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225
2598 set ipv6 nexthop local fe80::2c0:4fff:fe68:a225
2604 .. include:: routeserver.rst
2606 .. include:: rpki.rst
2608 .. include:: flowspec.rst
2610 .. [#med-transitivity-rant] For some set of objects to have an order, there *must* be some binary ordering relation that is defined for *every* combination of those objects, and that relation *must* be transitive. I.e.:, if the relation operator is <, and if a < b and b < c then that relation must carry over and it *must* be that a < c for the objects to have an order. The ordering relation may allow for equality, i.e. a < b and b < a may both be true and imply that a and b are equal in the order and not distinguished by it, in which case the set has a partial order. Otherwise, if there is an order, all the objects have a distinct place in the order and the set has a total order)
2611 .. [bgp-route-osci-cond] McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation Condition", IETF RFC3345
2612 .. [stable-flexible-ibgp] Flavel, A. and M. Roughan, "Stable and flexible iBGP", ACM SIGCOMM 2009
2613 .. [ibgp-correctness] Griffin, T. and G. Wilfong, "On the correctness of IBGP configuration", ACM SIGCOMM 2002