]>
Commit | Line | Data |
---|---|---|
0efdf0fe | 1 | .. _bgp: |
42fc5d26 QY |
2 | |
3 | *** | |
4 | BGP | |
5 | *** | |
6 | ||
8fcedbd2 | 7 | :abbr:`BGP` stands for Border Gateway Protocol. The latest BGP version is 4. |
d1e7591e | 8 | BGP-4 is one of the Exterior Gateway Protocols and the de facto standard |
8fcedbd2 QY |
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. | |
42fc5d26 | 11 | |
0efdf0fe | 12 | .. _starting-bgp: |
42fc5d26 QY |
13 | |
14 | Starting BGP | |
15 | ============ | |
16 | ||
8fcedbd2 QY |
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. | |
42fc5d26 | 21 | |
c1a54c05 | 22 | *bgpd* specific invocation options are described below. Common options may also |
0efdf0fe | 23 | be specified (:ref:`common-invocation-options`). |
42fc5d26 | 24 | |
c1a54c05 | 25 | .. program:: bgpd |
42fc5d26 | 26 | |
c9365894 | 27 | .. option:: -p, --bgp_port <port> |
42fc5d26 | 28 | |
db759bb0 | 29 | Set the bgp protocol's port number. When port number is 0, that means do not |
30 | listen bgp port. | |
42fc5d26 | 31 | |
c9365894 | 32 | .. option:: -l, --listenon |
42fc5d26 | 33 | |
d1aed873 | 34 | Specify specific IP addresses for bgpd to listen on, rather than its default |
c0868e8b | 35 | of ``0.0.0.0`` / ``::``. This can be useful to constrain bgpd to an internal |
d1aed873 AMR |
36 | address, or to run multiple bgpd processes on one host. Multiple addresses |
37 | can be specified. | |
38 | ||
39 | In the following example, bgpd is started listening for connections on the | |
40 | addresses 100.0.1.2 and fd00::2:2. The options -d (runs in daemon mode) and | |
41 | -f (uses specific configuration file) are also used in this example as we | |
42 | are likely to run multiple bgpd instances, each one with different | |
43 | configurations, when using -l option. | |
42fc5d26 | 44 | |
c17537f9 MBG |
45 | Note that this option implies the --no_kernel option, and no learned routes will be installed into the linux kernel. |
46 | ||
d1aed873 AMR |
47 | .. code-block:: shell |
48 | ||
49 | # /usr/lib/frr/bgpd -d -f /some-folder/bgpd.conf -l 100.0.1.2 -l fd00::2:2 | |
50 | ||
11a9a236 DS |
51 | .. option:: -n, --no_kernel |
52 | ||
53 | Do not install learned routes into the linux kernel. This option is useful | |
54 | for a route-reflector environment or if you are running multiple bgp | |
55 | processes in the same namespace. This option is different than the --no_zebra | |
56 | option in that a ZAPI connection is made. | |
57 | ||
8dad2243 DS |
58 | This option can also be toggled during runtime by using the |
59 | ``[no] bgp no-rib`` commands in VTY shell. | |
60 | ||
61 | Note that this option will persist after saving the configuration during | |
62 | runtime, unless unset by the ``no bgp no-rib`` command in VTY shell prior to | |
63 | a configuration write operation. | |
64 | ||
11a9a236 DS |
65 | .. option:: -S, --skip_runas |
66 | ||
67 | Skip the normal process of checking capabilities and changing user and group | |
68 | information. | |
69 | ||
70 | .. option:: -e, --ecmp | |
71 | ||
72 | Run BGP with a limited ecmp capability, that is different than what BGP | |
73 | was compiled with. The value specified must be greater than 0 and less | |
74 | than or equal to the MULTIPATH_NUM specified on compilation. | |
75 | ||
76 | .. option:: -Z, --no_zebra | |
77 | ||
78 | Do not communicate with zebra at all. This is different than the --no_kernel | |
79 | option in that we do not even open a ZAPI connection to the zebra process. | |
80 | ||
81 | .. option:: -s, --socket_size | |
82 | ||
83 | When opening tcp connections to our peers, set the socket send buffer | |
84 | size that the kernel will use for the peers socket. This option | |
85 | is only really useful at a very large scale. Experimentation should | |
86 | be done to see if this is helping or not at the scale you are running | |
87 | at. | |
88 | ||
89 | LABEL MANAGER | |
90 | ------------- | |
91 | ||
92 | .. option:: -I, --int_num | |
93 | ||
94 | Set zclient id. This is required when using Zebra label manager in proxy mode. | |
95 | ||
8fcedbd2 | 96 | .. _bgp-basic-concepts: |
42fc5d26 | 97 | |
8fcedbd2 QY |
98 | Basic Concepts |
99 | ============== | |
42fc5d26 | 100 | |
8fcedbd2 | 101 | .. _bgp-autonomous-systems: |
c3c5a71f | 102 | |
8fcedbd2 QY |
103 | Autonomous Systems |
104 | ------------------ | |
42fc5d26 | 105 | |
c0868e8b QY |
106 | From :rfc:`1930`: |
107 | ||
108 | An AS is a connected group of one or more IP prefixes run by one or more | |
109 | network operators which has a SINGLE and CLEARLY DEFINED routing policy. | |
110 | ||
111 | Each AS has an identifying number associated with it called an :abbr:`ASN | |
112 | (Autonomous System Number)`. This is a two octet value ranging in value from 1 | |
113 | to 65535. The AS numbers 64512 through 65535 are defined as private AS numbers. | |
114 | Private AS numbers must not be advertised on the global Internet. | |
115 | ||
116 | The :abbr:`ASN (Autonomous System Number)` is one of the essential elements of | |
8fcedbd2 | 117 | BGP. BGP is a distance vector routing protocol, and the AS-Path framework |
c0868e8b | 118 | provides distance vector metric and loop detection to BGP. |
42fc5d26 | 119 | |
c0868e8b | 120 | .. seealso:: :rfc:`1930` |
42fc5d26 | 121 | |
8fcedbd2 | 122 | .. _bgp-address-families: |
42fc5d26 | 123 | |
8fcedbd2 QY |
124 | Address Families |
125 | ---------------- | |
42fc5d26 | 126 | |
c0868e8b QY |
127 | Multiprotocol extensions enable BGP to carry routing information for multiple |
128 | network layer protocols. BGP supports an Address Family Identifier (AFI) for | |
129 | IPv4 and IPv6. Support is also provided for multiple sets of per-AFI | |
130 | information via the BGP Subsequent Address Family Identifier (SAFI). FRR | |
131 | supports SAFIs for unicast information, labeled information (:rfc:`3107` and | |
132 | :rfc:`8277`), and Layer 3 VPN information (:rfc:`4364` and :rfc:`4659`). | |
c3c5a71f | 133 | |
8fcedbd2 | 134 | .. _bgp-route-selection: |
42fc5d26 | 135 | |
8fcedbd2 QY |
136 | Route Selection |
137 | --------------- | |
42fc5d26 | 138 | |
8fcedbd2 QY |
139 | The route selection process used by FRR's BGP implementation uses the following |
140 | decision criterion, starting at the top of the list and going towards the | |
141 | bottom until one of the factors can be used. | |
42fc5d26 | 142 | |
8fcedbd2 | 143 | 1. **Weight check** |
42fc5d26 | 144 | |
c1a54c05 | 145 | Prefer higher local weight routes to lower routes. |
42fc5d26 | 146 | |
8fcedbd2 QY |
147 | 2. **Local preference check** |
148 | ||
c1a54c05 | 149 | Prefer higher local preference routes to lower. |
42fc5d26 | 150 | |
91e9aee0 DA |
151 | If ``bgp bestpath aigp`` is enabled, and both paths that are compared have |
152 | AIGP attribute, BGP uses AIGP tie-breaking unless both of the paths have the | |
153 | AIGP metric attribute. This means that the AIGP attribute is not evaluated | |
154 | during the best path selection process between two paths when one path does | |
155 | not have the AIGP attribute. | |
156 | ||
8fcedbd2 QY |
157 | 3. **Local route check** |
158 | ||
c1a54c05 | 159 | Prefer local routes (statics, aggregates, redistributed) to received routes. |
42fc5d26 | 160 | |
8fcedbd2 QY |
161 | 4. **AS path length check** |
162 | ||
c1a54c05 | 163 | Prefer shortest hop-count AS_PATHs. |
42fc5d26 | 164 | |
8fcedbd2 QY |
165 | 5. **Origin check** |
166 | ||
c1a54c05 QY |
167 | Prefer the lowest origin type route. That is, prefer IGP origin routes to |
168 | EGP, to Incomplete routes. | |
42fc5d26 | 169 | |
8fcedbd2 QY |
170 | 6. **MED check** |
171 | ||
c1a54c05 | 172 | Where routes with a MED were received from the same AS, prefer the route |
0efdf0fe | 173 | with the lowest MED. :ref:`bgp-med`. |
42fc5d26 | 174 | |
8fcedbd2 QY |
175 | 7. **External check** |
176 | ||
c1a54c05 QY |
177 | Prefer the route received from an external, eBGP peer over routes received |
178 | from other types of peers. | |
42fc5d26 | 179 | |
8fcedbd2 QY |
180 | 8. **IGP cost check** |
181 | ||
c1a54c05 | 182 | Prefer the route with the lower IGP cost. |
42fc5d26 | 183 | |
8fcedbd2 QY |
184 | 9. **Multi-path check** |
185 | ||
c1a54c05 QY |
186 | If multi-pathing is enabled, then check whether the routes not yet |
187 | distinguished in preference may be considered equal. If | |
9e146a81 | 188 | :clicmd:`bgp bestpath as-path multipath-relax` is set, all such routes are |
c1a54c05 QY |
189 | considered equal, otherwise routes received via iBGP with identical AS_PATHs |
190 | or routes received from eBGP neighbours in the same AS are considered equal. | |
42fc5d26 | 191 | |
8fcedbd2 QY |
192 | 10. **Already-selected external check** |
193 | ||
07738543 QY |
194 | Where both routes were received from eBGP peers, then prefer the route |
195 | which is already selected. Note that this check is not applied if | |
196 | :clicmd:`bgp bestpath compare-routerid` is configured. This check can | |
197 | prevent some cases of oscillation. | |
198 | ||
8fcedbd2 QY |
199 | 11. **Router-ID check** |
200 | ||
07738543 QY |
201 | Prefer the route with the lowest `router-ID`. If the route has an |
202 | `ORIGINATOR_ID` attribute, through iBGP reflection, then that router ID is | |
203 | used, otherwise the `router-ID` of the peer the route was received from is | |
204 | used. | |
205 | ||
8fcedbd2 QY |
206 | 12. **Cluster-List length check** |
207 | ||
07738543 QY |
208 | The route with the shortest cluster-list length is used. The cluster-list |
209 | reflects the iBGP reflection path the route has taken. | |
210 | ||
8fcedbd2 QY |
211 | 13. **Peer address** |
212 | ||
07738543 QY |
213 | Prefer the route received from the peer with the higher transport layer |
214 | address, as a last-resort tie-breaker. | |
42fc5d26 | 215 | |
8fcedbd2 QY |
216 | .. _bgp-capability-negotiation: |
217 | ||
218 | Capability Negotiation | |
219 | ---------------------- | |
220 | ||
221 | When adding IPv6 routing information exchange feature to BGP. There were some | |
222 | proposals. :abbr:`IETF (Internet Engineering Task Force)` | |
223 | :abbr:`IDR (Inter Domain Routing)` adopted a proposal called Multiprotocol | |
224 | Extension for BGP. The specification is described in :rfc:`2283`. The protocol | |
225 | does not define new protocols. It defines new attributes to existing BGP. When | |
226 | it is used exchanging IPv6 routing information it is called BGP-4+. When it is | |
227 | used for exchanging multicast routing information it is called MBGP. | |
228 | ||
229 | *bgpd* supports Multiprotocol Extension for BGP. So if a remote peer supports | |
230 | the protocol, *bgpd* can exchange IPv6 and/or multicast routing information. | |
231 | ||
232 | Traditional BGP did not have the feature to detect a remote peer's | |
233 | capabilities, e.g. whether it can handle prefix types other than IPv4 unicast | |
234 | routes. This was a big problem using Multiprotocol Extension for BGP in an | |
235 | operational network. :rfc:`2842` adopted a feature called Capability | |
236 | Negotiation. *bgpd* use this Capability Negotiation to detect the remote peer's | |
237 | capabilities. If a peer is only configured as an IPv4 unicast neighbor, *bgpd* | |
238 | does not send these Capability Negotiation packets (at least not unless other | |
239 | optional BGP features require capability negotiation). | |
240 | ||
241 | By default, FRR will bring up peering with minimal common capability for the | |
242 | both sides. For example, if the local router has unicast and multicast | |
243 | capabilities and the remote router only has unicast capability the local router | |
244 | will establish the connection with unicast only capability. When there are no | |
245 | common capabilities, FRR sends Unsupported Capability error and then resets the | |
246 | connection. | |
247 | ||
8fcedbd2 QY |
248 | .. _bgp-router-configuration: |
249 | ||
250 | BGP Router Configuration | |
251 | ======================== | |
252 | ||
253 | ASN and Router ID | |
254 | ----------------- | |
255 | ||
256 | First of all you must configure BGP router with the :clicmd:`router bgp ASN` | |
e55b0883 PG |
257 | command. The AS number is an identifier for the autonomous system. The AS |
258 | identifier can either be a number or two numbers separated by a period. The | |
259 | BGP protocol uses the AS identifier for detecting whether the BGP connection is | |
8fcedbd2 QY |
260 | internal or external. |
261 | ||
8fcedbd2 QY |
262 | .. clicmd:: router bgp ASN |
263 | ||
264 | Enable a BGP protocol process with the specified ASN. After | |
265 | this statement you can input any `BGP Commands`. | |
266 | ||
8fcedbd2 QY |
267 | .. clicmd:: bgp router-id A.B.C.D |
268 | ||
269 | This command specifies the router-ID. If *bgpd* connects to *zebra* it gets | |
270 | interface and address information. In that case default router ID value is | |
271 | selected as the largest IP Address of the interfaces. When `router zebra` is | |
272 | not enabled *bgpd* can't get interface information so `router-id` is set to | |
273 | 0.0.0.0. So please set router-id by hand. | |
274 | ||
c8a5e5e1 QY |
275 | |
276 | .. _bgp-multiple-autonomous-systems: | |
277 | ||
278 | Multiple Autonomous Systems | |
279 | --------------------------- | |
280 | ||
281 | FRR's BGP implementation is capable of running multiple autonomous systems at | |
282 | once. Each configured AS corresponds to a :ref:`zebra-vrf`. In the past, to get | |
283 | the same functionality the network administrator had to run a new *bgpd* | |
284 | process; using VRFs allows multiple autonomous systems to be handled in a | |
285 | single process. | |
286 | ||
287 | When using multiple autonomous systems, all router config blocks after the | |
288 | first one must specify a VRF to be the target of BGP's route selection. This | |
289 | VRF must be unique within respect to all other VRFs being used for the same | |
290 | purpose, i.e. two different autonomous systems cannot use the same VRF. | |
291 | However, the same AS can be used with different VRFs. | |
292 | ||
293 | .. note:: | |
294 | ||
295 | The separated nature of VRFs makes it possible to peer a single *bgpd* | |
edde3ce9 QY |
296 | process to itself, on one machine. Note that this can be done fully within |
297 | BGP without a corresponding VRF in the kernel or Zebra, which enables some | |
298 | practical use cases such as :ref:`route reflectors <bgp-route-reflector>` | |
299 | and route servers. | |
c8a5e5e1 QY |
300 | |
301 | Configuration of additional autonomous systems, or of a router that targets a | |
302 | specific VRF, is accomplished with the following command: | |
303 | ||
c8a5e5e1 QY |
304 | .. clicmd:: router bgp ASN vrf VRFNAME |
305 | ||
306 | ``VRFNAME`` is matched against VRFs configured in the kernel. When ``vrf | |
307 | VRFNAME`` is not specified, the BGP protocol process belongs to the default | |
308 | VRF. | |
309 | ||
310 | An example configuration with multiple autonomous systems might look like this: | |
311 | ||
312 | .. code-block:: frr | |
313 | ||
314 | router bgp 1 | |
315 | neighbor 10.0.0.1 remote-as 20 | |
316 | neighbor 10.0.0.2 remote-as 30 | |
317 | ! | |
318 | router bgp 2 vrf blue | |
319 | neighbor 10.0.0.3 remote-as 40 | |
320 | neighbor 10.0.0.4 remote-as 50 | |
321 | ! | |
322 | router bgp 3 vrf red | |
323 | neighbor 10.0.0.5 remote-as 60 | |
324 | neighbor 10.0.0.6 remote-as 70 | |
325 | ... | |
326 | ||
c8a5e5e1 QY |
327 | .. seealso:: :ref:`bgp-vrf-route-leaking` |
328 | .. seealso:: :ref:`zebra-vrf` | |
329 | ||
330 | ||
331 | .. _bgp-views: | |
332 | ||
333 | Views | |
334 | ----- | |
335 | ||
336 | In addition to supporting multiple autonomous systems, FRR's BGP implementation | |
337 | also supports *views*. | |
338 | ||
339 | BGP views are almost the same as normal BGP processes, except that routes | |
195c7461 QY |
340 | selected by BGP are not installed into the kernel routing table. Each BGP view |
341 | provides an independent set of routing information which is only distributed | |
342 | via BGP. Multiple views can be supported, and BGP view information is always | |
343 | independent from other routing protocols and Zebra/kernel routes. BGP views use | |
344 | the core instance (i.e., default VRF) for communication with peers. | |
edde3ce9 | 345 | |
c8a5e5e1 QY |
346 | .. clicmd:: router bgp AS-NUMBER view NAME |
347 | ||
348 | Make a new BGP view. You can use an arbitrary word for the ``NAME``. Routes | |
349 | selected by the view are not installed into the kernel routing table. | |
350 | ||
351 | With this command, you can setup Route Server like below. | |
352 | ||
353 | .. code-block:: frr | |
354 | ||
355 | ! | |
356 | router bgp 1 view 1 | |
357 | neighbor 10.0.0.1 remote-as 2 | |
358 | neighbor 10.0.0.2 remote-as 3 | |
359 | ! | |
360 | router bgp 2 view 2 | |
361 | neighbor 10.0.0.3 remote-as 4 | |
362 | neighbor 10.0.0.4 remote-as 5 | |
363 | ||
c8a5e5e1 QY |
364 | .. clicmd:: show [ip] bgp view NAME |
365 | ||
366 | Display the routing table of BGP view ``NAME``. | |
367 | ||
368 | ||
8fcedbd2 QY |
369 | Route Selection |
370 | --------------- | |
c3c5a71f | 371 | |
29adcd50 | 372 | .. clicmd:: bgp bestpath as-path confed |
42fc5d26 | 373 | |
c1a54c05 QY |
374 | This command specifies that the length of confederation path sets and |
375 | sequences should should be taken into account during the BGP best path | |
376 | decision process. | |
42fc5d26 | 377 | |
29adcd50 | 378 | .. clicmd:: bgp bestpath as-path multipath-relax |
42fc5d26 | 379 | |
c1a54c05 QY |
380 | This command specifies that BGP decision process should consider paths |
381 | of equal AS_PATH length candidates for multipath computation. Without | |
382 | the knob, the entire AS_PATH must match for multipath computation. | |
c3c5a71f | 383 | |
29adcd50 | 384 | .. clicmd:: bgp bestpath compare-routerid |
42fc5d26 | 385 | |
c1a54c05 QY |
386 | Ensure that when comparing routes where both are equal on most metrics, |
387 | including local-pref, AS_PATH length, IGP cost, MED, that the tie is broken | |
388 | based on router-ID. | |
42fc5d26 | 389 | |
c1a54c05 QY |
390 | If this option is enabled, then the already-selected check, where |
391 | already selected eBGP routes are preferred, is skipped. | |
42fc5d26 | 392 | |
c1a54c05 QY |
393 | If a route has an `ORIGINATOR_ID` attribute because it has been reflected, |
394 | that `ORIGINATOR_ID` will be used. Otherwise, the router-ID of the peer the | |
395 | route was received from will be used. | |
42fc5d26 | 396 | |
c1a54c05 QY |
397 | The advantage of this is that the route-selection (at this point) will be |
398 | more deterministic. The disadvantage is that a few or even one lowest-ID | |
d1e7591e | 399 | router may attract all traffic to otherwise-equal paths because of this |
c1a54c05 QY |
400 | check. It may increase the possibility of MED or IGP oscillation, unless |
401 | other measures were taken to avoid these. The exact behaviour will be | |
402 | sensitive to the iBGP and reflection topology. | |
42fc5d26 | 403 | |
ee88563a JM |
404 | .. clicmd:: bgp bestpath peer-type multipath-relax |
405 | ||
406 | This command specifies that BGP decision process should consider paths | |
407 | from all peers for multipath computation. If this option is enabled, | |
408 | paths learned from any of eBGP, iBGP, or confederation neighbors will | |
409 | be multipath if they are otherwise considered equal cost. | |
410 | ||
91e9aee0 DA |
411 | .. clicmd:: bgp bestpath aigp |
412 | ||
413 | Use the bgp bestpath aigp command to evaluate the AIGP attribute during | |
414 | the best path selection process between two paths that have the AIGP | |
415 | attribute. | |
416 | ||
417 | When bgp bestpath aigp is disabled, BGP does not use AIGP tie-breaking | |
418 | rules unless paths have the AIGP attribute. | |
419 | ||
420 | Disabled by default. | |
421 | ||
4a09f22f DS |
422 | .. clicmd:: maximum-paths (1-128) |
423 | ||
424 | Sets the maximum-paths value used for ecmp calculations for this | |
425 | bgp instance in EBGP. The maximum value listed, 128, can be limited by | |
426 | the ecmp cli for bgp or if the daemon was compiled with a lower | |
427 | ecmp value. This value can also be set in ipv4/ipv6 unicast/labeled | |
428 | unicast to only affect those particular afi/safi's. | |
429 | ||
430 | .. clicmd:: maximum-paths ibgp (1-128) [equal-cluster-length] | |
431 | ||
432 | Sets the maximum-paths value used for ecmp calculations for this | |
433 | bgp instance in IBGP. The maximum value listed, 128, can be limited by | |
434 | the ecmp cli for bgp or if the daemon was compiled with a lower | |
435 | ecmp value. This value can also be set in ipv4/ipv6 unicast/labeled | |
436 | unicast to only affect those particular afi/safi's. | |
437 | ||
8fcedbd2 QY |
438 | .. _bgp-distance: |
439 | ||
440 | Administrative Distance Metrics | |
441 | ------------------------------- | |
442 | ||
8fcedbd2 QY |
443 | .. clicmd:: distance bgp (1-255) (1-255) (1-255) |
444 | ||
f563acec TS |
445 | This command changes distance value of BGP. The arguments are the distance |
446 | values for external routes, internal routes and local routes | |
8fcedbd2 QY |
447 | respectively. |
448 | ||
8fcedbd2 QY |
449 | .. clicmd:: distance (1-255) A.B.C.D/M |
450 | ||
8fcedbd2 QY |
451 | .. clicmd:: distance (1-255) A.B.C.D/M WORD |
452 | ||
453 | Sets the administrative distance for a particular route. | |
42fc5d26 | 454 | |
713c64dd DA |
455 | .. _bgp-requires-policy: |
456 | ||
457 | Require policy on EBGP | |
458 | ------------------------------- | |
459 | ||
03750f1e | 460 | .. clicmd:: bgp ebgp-requires-policy |
713c64dd | 461 | |
8955d9e5 | 462 | This command requires incoming and outgoing filters to be applied |
b56f274a DS |
463 | for eBGP sessions as part of RFC-8212 compliance. Without the incoming |
464 | filter, no routes will be accepted. Without the outgoing filter, no | |
465 | routes will be announced. | |
8955d9e5 | 466 | |
b56f274a DS |
467 | This is enabled by default for the traditional configuration and |
468 | turned off by default for datacenter configuration. | |
713c64dd | 469 | |
b3cbe765 DA |
470 | When you enable/disable this option you MUST clear the session. |
471 | ||
62c42b0e DA |
472 | When the incoming or outgoing filter is missing you will see |
473 | "(Policy)" sign under ``show bgp summary``: | |
474 | ||
475 | .. code-block:: frr | |
476 | ||
477 | exit1# show bgp summary | |
478 | ||
6cac2fcc | 479 | IPv4 Unicast Summary (VRF default): |
62c42b0e DA |
480 | BGP router identifier 10.10.10.1, local AS number 65001 vrf-id 0 |
481 | BGP table version 4 | |
482 | RIB entries 7, using 1344 bytes of memory | |
483 | Peers 2, using 43 KiB of memory | |
484 | ||
b8f950d2 | 485 | Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt Desc |
486 | 192.168.0.2 4 65002 8 10 0 0 0 00:03:09 5 (Policy) N/A | |
487 | fe80:1::2222 4 65002 9 11 0 0 0 00:03:09 (Policy) (Policy) N/A | |
62c42b0e | 488 | |
b56f274a DS |
489 | Additionally a `show bgp neighbor` command would indicate in the `For address family:` |
490 | block that: | |
491 | ||
492 | .. code-block:: frr | |
493 | ||
494 | exit1# show bgp neighbor | |
495 | ... | |
496 | For address family: IPv4 Unicast | |
497 | Update group 1, subgroup 1 | |
498 | Packet Queue length 0 | |
499 | Inbound soft reconfiguration allowed | |
500 | Community attribute sent to this neighbor(all) | |
501 | Inbound updates discarded due to missing policy | |
502 | Outbound updates discarded due to missing policy | |
503 | 0 accepted prefixes | |
504 | ||
f0c81afe | 505 | Reject routes with AS_SET or AS_CONFED_SET types |
5031d886 | 506 | ------------------------------------------------ |
f0c81afe | 507 | |
03750f1e | 508 | .. clicmd:: bgp reject-as-sets |
f0c81afe DA |
509 | |
510 | This command enables rejection of incoming and outgoing routes having AS_SET or AS_CONFED_SET type. | |
511 | ||
105227af DA |
512 | Suppress duplicate updates |
513 | -------------------------- | |
514 | ||
03750f1e | 515 | .. clicmd:: bgp suppress-duplicates |
105227af DA |
516 | |
517 | For example, BGP routers can generate multiple identical announcements with | |
518 | empty community attributes if stripped at egress. This is an undesired behavior. | |
519 | Suppress duplicate updates if the route actually not changed. | |
520 | Default: enabled. | |
521 | ||
1ae314be DA |
522 | Send Hard Reset CEASE Notification for Administrative Reset |
523 | ----------------------------------------------------------- | |
524 | ||
525 | .. clicmd:: bgp hard-administrative-reset | |
526 | ||
527 | Send Hard Reset CEASE Notification for 'Administrative Reset' events. | |
528 | ||
529 | When disabled, and Graceful Restart Notification capability is exchanged | |
530 | between the peers, Graceful Restart procedures apply, and routes will be | |
531 | retained. | |
532 | ||
533 | Enabled by default. | |
534 | ||
835e9c5d DA |
535 | Disable checking if nexthop is connected on EBGP sessions |
536 | --------------------------------------------------------- | |
537 | ||
03750f1e | 538 | .. clicmd:: bgp disable-ebgp-connected-route-check |
835e9c5d DA |
539 | |
540 | This command is used to disable the connection verification process for EBGP peering sessions | |
541 | that are reachable by a single hop but are configured on a loopback interface or otherwise | |
542 | configured with a non-directly connected IP address. | |
543 | ||
0efdf0fe | 544 | .. _bgp-route-flap-dampening: |
42fc5d26 | 545 | |
8fcedbd2 QY |
546 | Route Flap Dampening |
547 | -------------------- | |
42fc5d26 | 548 | |
a30fec23 | 549 | .. clicmd:: bgp dampening (1-45) (1-20000) (1-50000) (1-255) |
c1a54c05 | 550 | |
a5c1e103 | 551 | This command enables BGP route-flap dampening and specifies dampening parameters. |
42fc5d26 | 552 | |
c1a54c05 | 553 | half-life |
a5c1e103 | 554 | Half-life time for the penalty |
42fc5d26 | 555 | |
c1a54c05 | 556 | reuse-threshold |
a5c1e103 | 557 | Value to start reusing a route |
42fc5d26 | 558 | |
c1a54c05 | 559 | suppress-threshold |
a5c1e103 | 560 | Value to start suppressing a route |
42fc5d26 | 561 | |
c1a54c05 | 562 | max-suppress |
a5c1e103 | 563 | Maximum duration to suppress a stable route |
42fc5d26 | 564 | |
c1a54c05 | 565 | The route-flap damping algorithm is compatible with :rfc:`2439`. The use of |
a5c1e103 | 566 | this command is not recommended nowadays. |
42fc5d26 | 567 | |
319a7d06 DA |
568 | At the moment, route-flap dampening is not working per VRF and is working only |
569 | for IPv4 unicast and multicast. | |
570 | ||
c1a54c05 | 571 | .. seealso:: |
8fcedbd2 | 572 | https://www.ripe.net/publications/docs/ripe-378 |
42fc5d26 | 573 | |
0efdf0fe | 574 | .. _bgp-med: |
42fc5d26 | 575 | |
8fcedbd2 QY |
576 | Multi-Exit Discriminator |
577 | ------------------------ | |
42fc5d26 | 578 | |
8fcedbd2 | 579 | The BGP :abbr:`MED (Multi-Exit Discriminator)` attribute has properties which |
c1a54c05 QY |
580 | can cause subtle convergence problems in BGP. These properties and problems |
581 | have proven to be hard to understand, at least historically, and may still not | |
582 | be widely understood. The following attempts to collect together and present | |
583 | what is known about MED, to help operators and FRR users in designing and | |
584 | configuring their networks. | |
42fc5d26 | 585 | |
07a17e6d QY |
586 | The BGP :abbr:`MED` attribute is intended to allow one AS to indicate its |
587 | preferences for its ingress points to another AS. The MED attribute will not be | |
588 | propagated on to another AS by the receiving AS - it is 'non-transitive' in the | |
589 | BGP sense. | |
42fc5d26 | 590 | |
c1a54c05 QY |
591 | E.g., if AS X and AS Y have 2 different BGP peering points, then AS X might set |
592 | a MED of 100 on routes advertised at one and a MED of 200 at the other. When AS | |
593 | Y selects between otherwise equal routes to or via AS X, AS Y should prefer to | |
594 | take the path via the lower MED peering of 100 with AS X. Setting the MED | |
595 | allows an AS to influence the routing taken to it within another, neighbouring | |
596 | AS. | |
42fc5d26 QY |
597 | |
598 | In this use of MED it is not really meaningful to compare the MED value on | |
c1a54c05 QY |
599 | routes where the next AS on the paths differs. E.g., if AS Y also had a route |
600 | for some destination via AS Z in addition to the routes from AS X, and AS Z had | |
601 | also set a MED, it wouldn't make sense for AS Y to compare AS Z's MED values to | |
602 | those of AS X. The MED values have been set by different administrators, with | |
603 | different frames of reference. | |
42fc5d26 QY |
604 | |
605 | The default behaviour of BGP therefore is to not compare MED values across | |
dc1046f7 | 606 | routes received from different neighbouring ASes. In FRR this is done by |
c1a54c05 QY |
607 | comparing the neighbouring, left-most AS in the received AS_PATHs of the routes |
608 | and only comparing MED if those are the same. | |
609 | ||
610 | Unfortunately, this behaviour of MED, of sometimes being compared across routes | |
611 | and sometimes not, depending on the properties of those other routes, means MED | |
612 | can cause the order of preference over all the routes to be undefined. That is, | |
613 | given routes A, B, and C, if A is preferred to B, and B is preferred to C, then | |
614 | a well-defined order should mean the preference is transitive (in the sense of | |
013f9762 | 615 | orders [#med-transitivity-rant]_) and that A would be preferred to C. |
42fc5d26 | 616 | |
c3c5a71f QY |
617 | However, when MED is involved this need not be the case. With MED it is |
618 | possible that C is actually preferred over A. So A is preferred to B, B is | |
619 | preferred to C, but C is preferred to A. This can be true even where BGP | |
c1a54c05 QY |
620 | defines a deterministic 'most preferred' route out of the full set of A,B,C. |
621 | With MED, for any given set of routes there may be a deterministically | |
622 | preferred route, but there need not be any way to arrange them into any order | |
623 | of preference. With unmodified MED, the order of preference of routes literally | |
624 | becomes undefined. | |
42fc5d26 | 625 | |
c3c5a71f | 626 | That MED can induce non-transitive preferences over routes can cause issues. |
c1a54c05 QY |
627 | Firstly, it may be perceived to cause routing table churn locally at speakers; |
628 | secondly, and more seriously, it may cause routing instability in iBGP | |
629 | topologies, where sets of speakers continually oscillate between different | |
630 | paths. | |
42fc5d26 | 631 | |
c3c5a71f | 632 | The first issue arises from how speakers often implement routing decisions. |
c1a54c05 QY |
633 | Though BGP defines a selection process that will deterministically select the |
634 | same route as best at any given speaker, even with MED, that process requires | |
635 | evaluating all routes together. For performance and ease of implementation | |
636 | reasons, many implementations evaluate route preferences in a pair-wise fashion | |
637 | instead. Given there is no well-defined order when MED is involved, the best | |
638 | route that will be chosen becomes subject to implementation details, such as | |
639 | the order the routes are stored in. That may be (locally) non-deterministic, | |
640 | e.g.: it may be the order the routes were received in. | |
42fc5d26 QY |
641 | |
642 | This indeterminism may be considered undesirable, though it need not cause | |
c1a54c05 QY |
643 | problems. It may mean additional routing churn is perceived, as sometimes more |
644 | updates may be produced than at other times in reaction to some event . | |
42fc5d26 QY |
645 | |
646 | This first issue can be fixed with a more deterministic route selection that | |
c3c5a71f | 647 | ensures routes are ordered by the neighbouring AS during selection. |
9e146a81 | 648 | :clicmd:`bgp deterministic-med`. This may reduce the number of updates as routes |
c1a54c05 QY |
649 | are received, and may in some cases reduce routing churn. Though, it could |
650 | equally deterministically produce the largest possible set of updates in | |
651 | response to the most common sequence of received updates. | |
42fc5d26 QY |
652 | |
653 | A deterministic order of evaluation tends to imply an additional overhead of | |
c3c5a71f | 654 | sorting over any set of n routes to a destination. The implementation of |
dc1046f7 | 655 | deterministic MED in FRR scales significantly worse than most sorting |
c1a54c05 QY |
656 | algorithms at present, with the number of paths to a given destination. That |
657 | number is often low enough to not cause any issues, but where there are many | |
658 | paths, the deterministic comparison may quickly become increasingly expensive | |
659 | in terms of CPU. | |
660 | ||
661 | Deterministic local evaluation can *not* fix the second, more major, issue of | |
662 | MED however. Which is that the non-transitive preference of routes MED can | |
663 | cause may lead to routing instability or oscillation across multiple speakers | |
664 | in iBGP topologies. This can occur with full-mesh iBGP, but is particularly | |
665 | problematic in non-full-mesh iBGP topologies that further reduce the routing | |
666 | information known to each speaker. This has primarily been documented with iBGP | |
749afd7d RF |
667 | :ref:`route-reflection <bgp-route-reflector>` topologies. However, any |
668 | route-hiding technologies potentially could also exacerbate oscillation with MED. | |
c1a54c05 QY |
669 | |
670 | This second issue occurs where speakers each have only a subset of routes, and | |
671 | there are cycles in the preferences between different combinations of routes - | |
672 | as the undefined order of preference of MED allows - and the routes are | |
673 | distributed in a way that causes the BGP speakers to 'chase' those cycles. This | |
674 | can occur even if all speakers use a deterministic order of evaluation in route | |
675 | selection. | |
676 | ||
677 | E.g., speaker 4 in AS A might receive a route from speaker 2 in AS X, and from | |
678 | speaker 3 in AS Y; while speaker 5 in AS A might receive that route from | |
679 | speaker 1 in AS Y. AS Y might set a MED of 200 at speaker 1, and 100 at speaker | |
680 | 3. I.e, using ASN:ID:MED to label the speakers: | |
42fc5d26 QY |
681 | |
682 | :: | |
683 | ||
c1a54c05 QY |
684 | . |
685 | /---------------\\ | |
42fc5d26 | 686 | X:2------|--A:4-------A:5--|-Y:1:200 |
c1a54c05 QY |
687 | Y:3:100--|-/ | |
688 | \\---------------/ | |
c3c5a71f | 689 | |
42fc5d26 | 690 | |
42fc5d26 | 691 | |
c1a54c05 QY |
692 | Assuming all other metrics are equal (AS_PATH, ORIGIN, 0 IGP costs), then based |
693 | on the RFC4271 decision process speaker 4 will choose X:2 over Y:3:100, based | |
694 | on the lower ID of 2. Speaker 4 advertises X:2 to speaker 5. Speaker 5 will | |
695 | continue to prefer Y:1:200 based on the ID, and advertise this to speaker 4. | |
696 | Speaker 4 will now have the full set of routes, and the Y:1:200 it receives | |
697 | from 5 will beat X:2, but when speaker 4 compares Y:1:200 to Y:3:100 the MED | |
698 | check now becomes active as the ASes match, and now Y:3:100 is preferred. | |
699 | Speaker 4 therefore now advertises Y:3:100 to 5, which will also agrees that | |
700 | Y:3:100 is preferred to Y:1:200, and so withdraws the latter route from 4. | |
701 | Speaker 4 now has only X:2 and Y:3:100, and X:2 beats Y:3:100, and so speaker 4 | |
702 | implicitly updates its route to speaker 5 to X:2. Speaker 5 sees that Y:1:200 | |
703 | beats X:2 based on the ID, and advertises Y:1:200 to speaker 4, and the cycle | |
704 | continues. | |
42fc5d26 QY |
705 | |
706 | The root cause is the lack of a clear order of preference caused by how MED | |
707 | sometimes is and sometimes is not compared, leading to this cycle in the | |
708 | preferences between the routes: | |
709 | ||
710 | :: | |
711 | ||
c1a54c05 QY |
712 | . |
713 | /---> X:2 ---beats---> Y:3:100 --\\ | |
714 | | | | |
715 | | | | |
716 | \\---beats--- Y:1:200 <---beats---/ | |
c3c5a71f | 717 | |
42fc5d26 | 718 | |
42fc5d26 QY |
719 | |
720 | This particular type of oscillation in full-mesh iBGP topologies can be | |
721 | avoided by speakers preferring already selected, external routes rather than | |
c1a54c05 QY |
722 | choosing to update to new a route based on a post-MED metric (e.g. router-ID), |
723 | at the cost of a non-deterministic selection process. FRR implements this, as | |
724 | do many other implementations, so long as it is not overridden by setting | |
9e146a81 | 725 | :clicmd:`bgp bestpath compare-routerid`, and see also |
8fcedbd2 | 726 | :ref:`bgp-route-selection`. |
42fc5d26 QY |
727 | |
728 | However, more complex and insidious cycles of oscillation are possible with | |
c3c5a71f | 729 | iBGP route-reflection, which are not so easily avoided. These have been |
c1a54c05 QY |
730 | documented in various places. See, e.g.: |
731 | ||
732 | - [bgp-route-osci-cond]_ | |
733 | - [stable-flexible-ibgp]_ | |
734 | - [ibgp-correctness]_ | |
735 | ||
736 | for concrete examples and further references. | |
737 | ||
738 | There is as of this writing *no* known way to use MED for its original purpose; | |
739 | *and* reduce routing information in iBGP topologies; *and* be sure to avoid the | |
740 | instability problems of MED due the non-transitive routing preferences it can | |
741 | induce; in general on arbitrary networks. | |
742 | ||
743 | There may be iBGP topology specific ways to reduce the instability risks, even | |
744 | while using MED, e.g.: by constraining the reflection topology and by tuning | |
013f9762 | 745 | IGP costs between route-reflector clusters, see :rfc:`3345` for details. In the |
c1a54c05 QY |
746 | near future, the Add-Path extension to BGP may also solve MED oscillation while |
747 | still allowing MED to be used as intended, by distributing "best-paths per | |
748 | neighbour AS". This would be at the cost of distributing at least as many | |
749 | routes to all speakers as a full-mesh iBGP would, if not more, while also | |
750 | imposing similar CPU overheads as the "Deterministic MED" feature at each | |
751 | Add-Path reflector. | |
42fc5d26 QY |
752 | |
753 | More generally, the instability problems that MED can introduce on more | |
754 | complex, non-full-mesh, iBGP topologies may be avoided either by: | |
755 | ||
013f9762 | 756 | - Setting :clicmd:`bgp always-compare-med`, however this allows MED to be compared |
42fc5d26 QY |
757 | across values set by different neighbour ASes, which may not produce |
758 | coherent desirable results, of itself. | |
4b44467c | 759 | - Effectively ignoring MED by setting MED to the same value (e.g.: 0) using |
013f9762 QY |
760 | :clicmd:`set metric METRIC` on all received routes, in combination with |
761 | setting :clicmd:`bgp always-compare-med` on all speakers. This is the simplest | |
42fc5d26 QY |
762 | and most performant way to avoid MED oscillation issues, where an AS is happy |
763 | not to allow neighbours to inject this problematic metric. | |
764 | ||
42fc5d26 QY |
765 | As MED is evaluated after the AS_PATH length check, another possible use for |
766 | MED is for intra-AS steering of routes with equal AS_PATH length, as an | |
c1a54c05 QY |
767 | extension of the last case above. As MED is evaluated before IGP metric, this |
768 | can allow cold-potato routing to be implemented to send traffic to preferred | |
769 | hand-offs with neighbours, rather than the closest hand-off according to the | |
770 | IGP metric. | |
771 | ||
772 | Note that even if action is taken to address the MED non-transitivity issues, | |
773 | other oscillations may still be possible. E.g., on IGP cost if iBGP and IGP | |
774 | topologies are at cross-purposes with each other - see the Flavel and Roughan | |
775 | paper above for an example. Hence the guideline that the iBGP topology should | |
776 | follow the IGP topology. | |
777 | ||
29adcd50 | 778 | .. clicmd:: bgp deterministic-med |
42fc5d26 | 779 | |
c1a54c05 QY |
780 | Carry out route-selection in way that produces deterministic answers |
781 | locally, even in the face of MED and the lack of a well-defined order of | |
782 | preference it can induce on routes. Without this option the preferred route | |
783 | with MED may be determined largely by the order that routes were received | |
784 | in. | |
42fc5d26 | 785 | |
c1a54c05 QY |
786 | Setting this option will have a performance cost that may be noticeable when |
787 | there are many routes for each destination. Currently in FRR it is | |
788 | implemented in a way that scales poorly as the number of routes per | |
789 | destination increases. | |
42fc5d26 | 790 | |
c1a54c05 | 791 | The default is that this option is not set. |
42fc5d26 QY |
792 | |
793 | Note that there are other sources of indeterminism in the route selection | |
794 | process, specifically, the preference for older and already selected routes | |
8fcedbd2 | 795 | from eBGP peers, :ref:`bgp-route-selection`. |
42fc5d26 | 796 | |
29adcd50 | 797 | .. clicmd:: bgp always-compare-med |
42fc5d26 | 798 | |
c1a54c05 QY |
799 | Always compare the MED on routes, even when they were received from |
800 | different neighbouring ASes. Setting this option makes the order of | |
801 | preference of routes more defined, and should eliminate MED induced | |
802 | oscillations. | |
42fc5d26 | 803 | |
c1a54c05 | 804 | If using this option, it may also be desirable to use |
9e146a81 | 805 | :clicmd:`set metric METRIC` to set MED to 0 on routes received from external |
c1a54c05 | 806 | neighbours. |
42fc5d26 | 807 | |
9e146a81 QY |
808 | This option can be used, together with :clicmd:`set metric METRIC` to use |
809 | MED as an intra-AS metric to steer equal-length AS_PATH routes to, e.g., | |
810 | desired exit points. | |
42fc5d26 | 811 | |
efcb2ebb | 812 | |
813 | .. _bgp-graceful-restart: | |
814 | ||
815 | Graceful Restart | |
816 | ---------------- | |
817 | ||
818 | BGP graceful restart functionality as defined in | |
819 | `RFC-4724 <https://tools.ietf.org/html/rfc4724/>`_ defines the mechanisms that | |
820 | allows BGP speaker to continue to forward data packets along known routes | |
821 | while the routing protocol information is being restored. | |
822 | ||
823 | ||
824 | Usually, when BGP on a router restarts, all the BGP peers detect that the | |
825 | session went down and then came up. This "down/up" transition results in a | |
826 | "routing flap" and causes BGP route re-computation, generation of BGP routing | |
827 | updates, and unnecessary churn to the forwarding tables. | |
828 | ||
829 | The following functionality is provided by graceful restart: | |
830 | ||
831 | 1. The feature allows the restarting router to indicate to the helping peer the | |
832 | routes it can preserve in its forwarding plane during control plane restart | |
833 | by sending graceful restart capability in the OPEN message sent during | |
834 | session establishment. | |
835 | 2. The feature allows helping router to advertise to all other peers the routes | |
836 | received from the restarting router which are preserved in the forwarding | |
837 | plane of the restarting router during control plane restart. | |
838 | ||
839 | ||
840 | :: | |
841 | ||
842 | ||
843 | ||
844 | (R1)-----------------------------------------------------------------(R2) | |
845 | ||
846 | 1. BGP Graceful Restart Capability exchanged between R1 & R2. | |
847 | ||
848 | <---------------------------------------------------------------------> | |
849 | ||
850 | 2. Kill BGP Process at R1. | |
851 | ||
852 | ----------------------------------------------------------------------> | |
853 | ||
854 | 3. R2 Detects the above BGP Restart & verifies BGP Restarting | |
855 | Capability of R1. | |
856 | ||
857 | 4. Start BGP Process at R1. | |
858 | ||
859 | 5. Re-establish the BGP session between R1 & R2. | |
860 | ||
861 | <---------------------------------------------------------------------> | |
862 | ||
863 | 6. R2 Send initial route updates, followed by End-Of-Rib. | |
864 | ||
865 | <---------------------------------------------------------------------- | |
866 | ||
867 | 7. R1 was waiting for End-Of-Rib from R2 & which has been received | |
868 | now. | |
869 | ||
870 | 8. R1 now runs BGP Best-Path algorithm. Send Initial BGP Update, | |
871 | followed by End-Of Rib | |
872 | ||
873 | <---------------------------------------------------------------------> | |
874 | ||
875 | ||
4907bcd8 | 876 | .. _bgp-GR-preserve-forwarding-state: |
877 | ||
878 | BGP-GR Preserve-Forwarding State | |
879 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
880 | ||
881 | BGP OPEN message carrying optional capabilities for Graceful Restart has | |
882 | 8 bit “Flags for Address Family” for given AFI and SAFI. This field contains | |
883 | bit flags relating to routes that were advertised with the given AFI and SAFI. | |
884 | ||
885 | .. code-block:: frr | |
886 | ||
887 | 0 1 2 3 4 5 6 7 | |
888 | +-+-+-+-+-+-+-+-+ | |
889 | |F| Reserved | | |
890 | +-+-+-+-+-+-+-+-+ | |
891 | ||
892 | The most significant bit is defined as the Forwarding State (F) bit, which | |
893 | can be used to indicate whether the forwarding state for routes that were | |
894 | advertised with the given AFI and SAFI has indeed been preserved during the | |
895 | previous BGP restart. When set (value 1), the bit indicates that the | |
896 | forwarding state has been preserved. | |
897 | The remaining bits are reserved and MUST be set to zero by the sender and | |
898 | ignored by the receiver. | |
899 | ||
4907bcd8 | 900 | .. clicmd:: bgp graceful-restart preserve-fw-state |
901 | ||
902 | FRR gives us the option to enable/disable the "F" flag using this specific | |
903 | vty command. However, it doesn't have the option to enable/disable | |
904 | this flag only for specific AFI/SAFI i.e. when this command is used, it | |
905 | applied to all the supported AFI/SAFI combinations for this peer. | |
906 | ||
efcb2ebb | 907 | .. _bgp-end-of-rib-message: |
908 | ||
909 | End-of-RIB (EOR) message | |
910 | ^^^^^^^^^^^^^^^^^^^^^^^^ | |
911 | ||
912 | An UPDATE message with no reachable Network Layer Reachability Information | |
913 | (NLRI) and empty withdrawn NLRI is specified as the End-of-RIB marker that can | |
914 | be used by a BGP speaker to indicate to its peer the completion of the initial | |
915 | routing update after the session is established. | |
916 | ||
917 | For the IPv4 unicast address family, the End-of-RIB marker is an UPDATE message | |
918 | with the minimum length. For any other address family, it is an UPDATE message | |
919 | that contains only the MP_UNREACH_NLRI attribute with no withdrawn routes for | |
920 | that <AFI, SAFI>. | |
921 | ||
922 | Although the End-of-RIB marker is specified for the purpose of BGP graceful | |
923 | restart, it is noted that the generation of such a marker upon completion of | |
924 | the initial update would be useful for routing convergence in general, and thus | |
925 | the practice is recommended. | |
926 | ||
927 | .. _bgp-route-selection-deferral-timer: | |
928 | ||
929 | Route Selection Deferral Timer | |
930 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
931 | ||
932 | Specifies the time the restarting router defers the route selection process | |
933 | after restart. | |
934 | ||
935 | Restarting Router : The usage of route election deferral timer is specified | |
936 | in https://tools.ietf.org/html/rfc4724#section-4.1 | |
937 | ||
938 | Once the session between the Restarting Speaker and the Receiving Speaker is | |
939 | re-established, the Restarting Speaker will receive and process BGP messages | |
940 | from its peers. | |
941 | ||
942 | However, it MUST defer route selection for an address family until it either. | |
943 | ||
944 | 1. Receives the End-of-RIB marker from all its peers (excluding the ones with | |
945 | the "Restart State" bit set in the received capability and excluding the ones | |
946 | that do not advertise the graceful restart capability). | |
947 | 2. The Selection_Deferral_Timer timeout. | |
948 | ||
efcb2ebb | 949 | .. clicmd:: bgp graceful-restart select-defer-time (0-3600) |
950 | ||
951 | This is command, will set deferral time to value specified. | |
952 | ||
953 | ||
efcb2ebb | 954 | .. clicmd:: bgp graceful-restart rib-stale-time (1-3600) |
955 | ||
956 | This is command, will set the time for which stale routes are kept in RIB. | |
957 | ||
dcbebfd3 DA |
958 | .. clicmd:: bgp graceful-restart restart-time (0-4095) |
959 | ||
960 | Set the time to wait to delete stale routes before a BGP open message | |
961 | is received. | |
962 | ||
963 | Using with Long-lived Graceful Restart capability, this is recommended | |
964 | setting this timer to 0 and control stale routes with | |
965 | ``bgp long-lived-graceful-restart stale-time``. | |
966 | ||
967 | Default value is 120. | |
968 | ||
2b3de9e5 DA |
969 | .. clicmd:: bgp graceful-restart stalepath-time (1-4095) |
970 | ||
971 | This is command, will set the max time (in seconds) to hold onto | |
972 | restarting peer's stale paths. | |
973 | ||
974 | It also controls Enhanced Route-Refresh timer. | |
975 | ||
976 | If this command is configured and the router does not receive a Route-Refresh EoRR | |
977 | message, the router removes the stale routes from the BGP table after the timer | |
978 | expires. The stale path timer is started when the router receives a Route-Refresh | |
979 | BoRR message. | |
980 | ||
f2ca5c5b DA |
981 | .. clicmd:: bgp graceful-restart notification |
982 | ||
983 | Indicate Graceful Restart support for BGP NOTIFICATION messages. | |
984 | ||
985 | After changing this parameter, you have to reset the peers in order to advertise | |
986 | N-bit in Graceful Restart capability. | |
987 | ||
19f98055 DA |
988 | Without Graceful-Restart Notification capability (N-bit not set), GR is not |
989 | activated when receiving CEASE/HOLDTIME expire notifications. | |
990 | ||
991 | When sending ``CEASE/Administrative Reset`` (``clear bgp``), the session is closed | |
992 | and routes are not retained. When N-bit is set and ``bgp hard-administrative-reset`` | |
993 | is turned off Graceful-Restart is activated and routes are retained. | |
994 | ||
f2ca5c5b DA |
995 | Enabled by default. |
996 | ||
efcb2ebb | 997 | .. _bgp-per-peer-graceful-restart: |
998 | ||
999 | BGP Per Peer Graceful Restart | |
1000 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1001 | ||
1002 | Ability to enable and disable graceful restart, helper and no GR at all mode | |
1003 | functionality at peer level. | |
1004 | ||
1005 | So bgp graceful restart can be enabled at modes global BGP level or at per | |
1006 | peer level. There are two FSM, one for BGP GR global mode and other for peer | |
1007 | per GR. | |
1008 | ||
1009 | Default global mode is helper and default peer per mode is inherit from global. | |
1010 | If per peer mode is configured, the GR mode of this particular peer will | |
1011 | override the global mode. | |
1012 | ||
2ba1fe69 | 1013 | .. _bgp-GR-global-mode-cmd: |
efcb2ebb | 1014 | |
1015 | BGP GR Global Mode Commands | |
1016 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1017 | ||
efcb2ebb | 1018 | .. clicmd:: bgp graceful-restart |
1019 | ||
f563acec | 1020 | This command will enable BGP graceful restart functionality at the global |
efcb2ebb | 1021 | level. |
1022 | ||
efcb2ebb | 1023 | .. clicmd:: bgp graceful-restart disable |
1024 | ||
1025 | This command will disable both the functionality graceful restart and helper | |
1026 | mode. | |
1027 | ||
1028 | ||
1029 | .. _bgp-GR-peer-mode-cmd: | |
1030 | ||
1031 | BGP GR Peer Mode Commands | |
1032 | ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1033 | ||
efcb2ebb | 1034 | .. clicmd:: neighbor A.B.C.D graceful-restart |
1035 | ||
f563acec | 1036 | This command will enable BGP graceful restart functionality at the peer |
efcb2ebb | 1037 | level. |
1038 | ||
efcb2ebb | 1039 | .. clicmd:: neighbor A.B.C.D graceful-restart-helper |
1040 | ||
1041 | This command will enable BGP graceful restart helper only functionality | |
1042 | at the peer level. | |
1043 | ||
efcb2ebb | 1044 | .. clicmd:: neighbor A.B.C.D graceful-restart-disable |
1045 | ||
1046 | This command will disable the entire BGP graceful restart functionality | |
1047 | at the peer level. | |
1048 | ||
1049 | ||
8606be87 DA |
1050 | Long-lived Graceful Restart |
1051 | --------------------------- | |
1052 | ||
1053 | Currently, only restarter mode is supported. This capability is advertised only | |
1054 | if graceful restart capability is negotiated. | |
1055 | ||
5970204c | 1056 | .. clicmd:: bgp long-lived-graceful-restart stale-time (1-16777215) |
8606be87 DA |
1057 | |
1058 | Specifies the maximum time to wait before purging long-lived stale routes for | |
1059 | helper routers. | |
1060 | ||
7f8a9a24 DA |
1061 | Default is 0, which means the feature is off by default. Only graceful |
1062 | restart takes into account. | |
8606be87 | 1063 | |
df465afe DS |
1064 | .. _bgp-shutdown: |
1065 | ||
1066 | Administrative Shutdown | |
1067 | ----------------------- | |
1068 | ||
03750f1e | 1069 | .. clicmd:: bgp shutdown [message MSG...] |
df465afe DS |
1070 | |
1071 | Administrative shutdown of all peers of a bgp instance. Drop all BGP peers, | |
1072 | but preserve their configurations. The peers are notified in accordance with | |
1073 | `RFC 8203 <https://tools.ietf.org/html/rfc8203/>`_ by sending a | |
1074 | ``NOTIFICATION`` message with error code ``Cease`` and subcode | |
1075 | ``Administrative Shutdown`` prior to terminating connections. This global | |
1076 | shutdown is independent of the neighbor shutdown, meaning that individually | |
1077 | shut down peers will not be affected by lifting it. | |
1078 | ||
1079 | An optional shutdown message `MSG` can be specified. | |
1080 | ||
1081 | ||
0efdf0fe | 1082 | .. _bgp-network: |
42fc5d26 | 1083 | |
8fcedbd2 QY |
1084 | Networks |
1085 | -------- | |
42fc5d26 | 1086 | |
c1a54c05 | 1087 | .. clicmd:: network A.B.C.D/M |
42fc5d26 | 1088 | |
9eb95b3b | 1089 | This command adds the announcement network. |
c3c5a71f | 1090 | |
9eb95b3b QY |
1091 | .. code-block:: frr |
1092 | ||
1093 | router bgp 1 | |
1094 | address-family ipv4 unicast | |
1095 | network 10.0.0.0/8 | |
1096 | exit-address-family | |
42fc5d26 | 1097 | |
c1a54c05 QY |
1098 | This configuration example says that network 10.0.0.0/8 will be |
1099 | announced to all neighbors. Some vendors' routers don't advertise | |
1100 | routes if they aren't present in their IGP routing tables; `bgpd` | |
1101 | doesn't care about IGP routes when announcing its routes. | |
c3c5a71f | 1102 | |
42fc5d26 | 1103 | |
03750f1e | 1104 | .. clicmd:: bgp network import-check |
f990a416 DS |
1105 | |
1106 | This configuration modifies the behavior of the network statement. | |
1107 | If you have this configured the underlying network must exist in | |
1108 | the rib. If you have the [no] form configured then BGP will not | |
1109 | check for the networks existence in the rib. For versions 7.3 and | |
1110 | before frr defaults for datacenter were the network must exist, | |
1111 | traditional did not check for existence. For versions 7.4 and beyond | |
1112 | both traditional and datacenter the network must exist. | |
1113 | ||
ef1b6319 | 1114 | .. _bgp-ipv6-support: |
547ba033 MH |
1115 | |
1116 | IPv6 Support | |
1117 | ------------ | |
1118 | ||
03750f1e | 1119 | .. clicmd:: neighbor A.B.C.D activate |
547ba033 | 1120 | |
ef1b6319 | 1121 | This configuration modifies whether to enable an address family for a |
547ba033 MH |
1122 | specific neighbor. By default only the IPv4 unicast address family is |
1123 | enabled. | |
1124 | ||
1125 | .. code-block:: frr | |
1126 | ||
1127 | router bgp 1 | |
1128 | address-family ipv6 unicast | |
1129 | neighbor 2001:0DB8::1 activate | |
1130 | network 2001:0DB8:5009::/64 | |
1131 | exit-address-family | |
1132 | ||
1133 | This configuration example says that network 2001:0DB8:5009::/64 will be | |
1134 | announced and enables the neighbor 2001:0DB8::1 to receive this announcement. | |
1135 | ||
547ba033 MH |
1136 | By default, only the IPv4 unicast address family is announced to all |
1137 | neighbors. Using the 'no bgp default ipv4-unicast' configuration overrides | |
1138 | this default so that all address families need to be enabled explicitly. | |
1139 | ||
1140 | .. code-block:: frr | |
1141 | ||
1142 | router bgp 1 | |
1143 | no bgp default ipv4-unicast | |
1144 | neighbor 10.10.10.1 remote-as 2 | |
1145 | neighbor 2001:0DB8::1 remote-as 3 | |
1146 | address-family ipv4 unicast | |
1147 | neighbor 10.10.10.1 activate | |
1148 | network 192.168.1.0/24 | |
1149 | exit-address-family | |
1150 | address-family ipv6 unicast | |
1151 | neighbor 2001:0DB8::1 activate | |
1152 | network 2001:0DB8:5009::/64 | |
1153 | exit-address-family | |
1154 | ||
1155 | This configuration demonstrates how the 'no bgp default ipv4-unicast' might | |
1156 | be used in a setup with two upstreams where each of the upstreams should only | |
f563acec | 1157 | receive either IPv4 or IPv6 announcements. |
547ba033 | 1158 | |
2c853e5e DA |
1159 | Using the ``bgp default ipv6-unicast`` configuration, IPv6 unicast |
1160 | address family is enabled by default for all new neighbors. | |
1161 | ||
547ba033 | 1162 | |
8fcedbd2 | 1163 | .. _bgp-route-aggregation: |
42fc5d26 QY |
1164 | |
1165 | Route Aggregation | |
1166 | ----------------- | |
1167 | ||
5101fece | 1168 | .. _bgp-route-aggregation-ipv4: |
1169 | ||
1170 | Route Aggregation-IPv4 Address Family | |
1171 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1172 | ||
c1a54c05 | 1173 | .. clicmd:: aggregate-address A.B.C.D/M |
c3c5a71f | 1174 | |
c1a54c05 | 1175 | This command specifies an aggregate address. |
42fc5d26 | 1176 | |
9a339b7f DA |
1177 | In order to advertise an aggregated prefix, a more specific (longer) prefix |
1178 | MUST exist in the BGP table. For example, if you want to create an | |
1179 | ``aggregate-address 10.0.0.0/24``, you should make sure you have something | |
1180 | like ``10.0.0.5/32`` or ``10.0.0.0/26``, or any other smaller prefix in the | |
1181 | BGP table. The routing information table (RIB) is not enough, you have to | |
1182 | redistribute them into the BGP table. | |
1183 | ||
ac2201bb DA |
1184 | .. clicmd:: aggregate-address A.B.C.D/M route-map NAME |
1185 | ||
1186 | Apply a route-map for an aggregated prefix. | |
1187 | ||
a87d2ef7 DA |
1188 | .. clicmd:: aggregate-address A.B.C.D/M origin <egp|igp|incomplete> |
1189 | ||
1190 | Override ORIGIN for an aggregated prefix. | |
1191 | ||
c1a54c05 | 1192 | .. clicmd:: aggregate-address A.B.C.D/M as-set |
42fc5d26 | 1193 | |
c1a54c05 QY |
1194 | This command specifies an aggregate address. Resulting routes include |
1195 | AS set. | |
42fc5d26 | 1196 | |
c1a54c05 | 1197 | .. clicmd:: aggregate-address A.B.C.D/M summary-only |
c3c5a71f | 1198 | |
9a339b7f DA |
1199 | This command specifies an aggregate address. |
1200 | ||
1201 | Longer prefixes advertisements of more specific routes to all neighbors are suppressed. | |
42fc5d26 | 1202 | |
01338ba1 RZ |
1203 | .. clicmd:: aggregate-address A.B.C.D/M matching-MED-only |
1204 | ||
1205 | Configure the aggregated address to only be created when the routes MED | |
1206 | match, otherwise no aggregated route will be created. | |
1207 | ||
8fbb9c95 RZ |
1208 | .. clicmd:: aggregate-address A.B.C.D/M suppress-map NAME |
1209 | ||
1210 | Similar to `summary-only`, but will only suppress more specific routes that | |
1211 | are matched by the selected route-map. | |
1212 | ||
ac2201bb | 1213 | |
03750f1e QY |
1214 | This configuration example sets up an ``aggregate-address`` under the ipv4 |
1215 | address-family. | |
5101fece | 1216 | |
1217 | .. code-block:: frr | |
1218 | ||
1219 | router bgp 1 | |
1220 | address-family ipv4 unicast | |
1221 | aggregate-address 10.0.0.0/8 | |
1222 | aggregate-address 20.0.0.0/8 as-set | |
1223 | aggregate-address 40.0.0.0/8 summary-only | |
ac2201bb | 1224 | aggregate-address 50.0.0.0/8 route-map aggr-rmap |
5101fece | 1225 | exit-address-family |
1226 | ||
1227 | ||
1228 | .. _bgp-route-aggregation-ipv6: | |
1229 | ||
1230 | Route Aggregation-IPv6 Address Family | |
1231 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1232 | ||
5101fece | 1233 | .. clicmd:: aggregate-address X:X::X:X/M |
1234 | ||
1235 | This command specifies an aggregate address. | |
1236 | ||
ac2201bb DA |
1237 | .. clicmd:: aggregate-address X:X::X:X/M route-map NAME |
1238 | ||
1239 | Apply a route-map for an aggregated prefix. | |
1240 | ||
a87d2ef7 DA |
1241 | .. clicmd:: aggregate-address X:X::X:X/M origin <egp|igp|incomplete> |
1242 | ||
1243 | Override ORIGIN for an aggregated prefix. | |
1244 | ||
5101fece | 1245 | .. clicmd:: aggregate-address X:X::X:X/M as-set |
1246 | ||
1247 | This command specifies an aggregate address. Resulting routes include | |
1248 | AS set. | |
1249 | ||
5101fece | 1250 | .. clicmd:: aggregate-address X:X::X:X/M summary-only |
1251 | ||
9a339b7f DA |
1252 | This command specifies an aggregate address. |
1253 | ||
1254 | Longer prefixes advertisements of more specific routes to all neighbors are suppressed | |
5101fece | 1255 | |
01338ba1 RZ |
1256 | .. clicmd:: aggregate-address X:X::X:X/M matching-MED-only |
1257 | ||
1258 | Configure the aggregated address to only be created when the routes MED | |
1259 | match, otherwise no aggregated route will be created. | |
1260 | ||
8fbb9c95 RZ |
1261 | .. clicmd:: aggregate-address X:X::X:X/M suppress-map NAME |
1262 | ||
1263 | Similar to `summary-only`, but will only suppress more specific routes that | |
1264 | are matched by the selected route-map. | |
01338ba1 | 1265 | |
5101fece | 1266 | |
03750f1e QY |
1267 | This configuration example sets up an ``aggregate-address`` under the ipv6 |
1268 | address-family. | |
5101fece | 1269 | |
1270 | .. code-block:: frr | |
1271 | ||
1272 | router bgp 1 | |
1273 | address-family ipv6 unicast | |
1274 | aggregate-address 10::0/64 | |
ac2201bb DA |
1275 | aggregate-address 20::0/64 as-set |
1276 | aggregate-address 40::0/64 summary-only | |
1277 | aggregate-address 50::0/64 route-map aggr-rmap | |
5101fece | 1278 | exit-address-family |
c3c5a71f | 1279 | |
03750f1e | 1280 | |
8fcedbd2 | 1281 | .. _bgp-redistribute-to-bgp: |
42fc5d26 | 1282 | |
8fcedbd2 QY |
1283 | Redistribution |
1284 | -------------- | |
42fc5d26 | 1285 | |
a874b986 QY |
1286 | Redistribution configuration should be placed under the ``address-family`` |
1287 | section for the specific AF to redistribute into. Protocol availability for | |
1288 | redistribution is determined by BGP AF; for example, you cannot redistribute | |
1289 | OSPFv3 into ``address-family ipv4 unicast`` as OSPFv3 supports IPv6. | |
1290 | ||
1291 | .. clicmd:: redistribute <babel|connected|eigrp|isis|kernel|openfabric|ospf|ospf6|rip|ripng|sharp|static|table> [metric (0-4294967295)] [route-map WORD] | |
1292 | ||
03750f1e | 1293 | Redistribute routes from other protocols into BGP. |
42fc5d26 | 1294 | |
245d354f DA |
1295 | .. clicmd:: redistribute vnc-direct |
1296 | ||
1297 | Redistribute VNC direct (not via zebra) routes to BGP process. | |
1298 | ||
d70583f7 D |
1299 | .. clicmd:: bgp update-delay MAX-DELAY |
1300 | ||
d70583f7 D |
1301 | .. clicmd:: bgp update-delay MAX-DELAY ESTABLISH-WAIT |
1302 | ||
1303 | This feature is used to enable read-only mode on BGP process restart or when | |
1304 | a BGP process is cleared using 'clear ip bgp \*'. Note that this command is | |
1305 | configured at the global level and applies to all bgp instances/vrfs. It | |
1306 | cannot be used at the same time as the "update-delay" command described below, | |
1307 | which is entered in each bgp instance/vrf desired to delay update installation | |
1308 | and advertisements. The global and per-vrf approaches to defining update-delay | |
1309 | are mutually exclusive. | |
1310 | ||
1311 | When applicable, read-only mode would begin as soon as the first peer reaches | |
1312 | Established status and a timer for max-delay seconds is started. During this | |
1313 | mode BGP doesn't run any best-path or generate any updates to its peers. This | |
1314 | mode continues until: | |
1315 | ||
1316 | 1. All the configured peers, except the shutdown peers, have sent explicit EOR | |
1317 | (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached | |
1318 | Established is considered an implicit-EOR. | |
1319 | If the establish-wait optional value is given, then BGP will wait for | |
1320 | peers to reach established from the beginning of the update-delay till the | |
1321 | establish-wait period is over, i.e. the minimum set of established peers for | |
1322 | which EOR is expected would be peers established during the establish-wait | |
1323 | window, not necessarily all the configured neighbors. | |
1324 | 2. max-delay period is over. | |
1325 | ||
1326 | On hitting any of the above two conditions, BGP resumes the decision process | |
1327 | and generates updates to its peers. | |
1328 | ||
1329 | Default max-delay is 0, i.e. the feature is off by default. | |
1330 | ||
1331 | ||
c1a54c05 | 1332 | .. clicmd:: update-delay MAX-DELAY |
c3c5a71f | 1333 | |
c1a54c05 | 1334 | .. clicmd:: update-delay MAX-DELAY ESTABLISH-WAIT |
c3c5a71f | 1335 | |
c1a54c05 | 1336 | This feature is used to enable read-only mode on BGP process restart or when |
d70583f7 | 1337 | a BGP process is cleared using 'clear ip bgp \*'. Note that this command is |
f563acec | 1338 | configured under the specific bgp instance/vrf that the feature is enabled for. |
d70583f7 D |
1339 | It cannot be used at the same time as the global "bgp update-delay" described |
1340 | above, which is entered at the global level and applies to all bgp instances. | |
1341 | The global and per-vrf approaches to defining update-delay are mutually | |
1342 | exclusive. | |
1343 | ||
1344 | When applicable, read-only mode would begin as soon as the first peer reaches | |
1345 | Established status and a timer for max-delay seconds is started. During this | |
1346 | mode BGP doesn't run any best-path or generate any updates to its peers. This | |
1347 | mode continues until: | |
42fc5d26 | 1348 | |
c1a54c05 QY |
1349 | 1. All the configured peers, except the shutdown peers, have sent explicit EOR |
1350 | (End-Of-RIB) or an implicit-EOR. The first keep-alive after BGP has reached | |
1351 | Established is considered an implicit-EOR. | |
1352 | If the establish-wait optional value is given, then BGP will wait for | |
d1e7591e | 1353 | peers to reach established from the beginning of the update-delay till the |
c1a54c05 QY |
1354 | establish-wait period is over, i.e. the minimum set of established peers for |
1355 | which EOR is expected would be peers established during the establish-wait | |
1356 | window, not necessarily all the configured neighbors. | |
1357 | 2. max-delay period is over. | |
42fc5d26 | 1358 | |
c1a54c05 QY |
1359 | On hitting any of the above two conditions, BGP resumes the decision process |
1360 | and generates updates to its peers. | |
42fc5d26 | 1361 | |
c1a54c05 | 1362 | Default max-delay is 0, i.e. the feature is off by default. |
c3c5a71f | 1363 | |
c1a54c05 | 1364 | .. clicmd:: table-map ROUTE-MAP-NAME |
42fc5d26 | 1365 | |
c1a54c05 QY |
1366 | This feature is used to apply a route-map on route updates from BGP to |
1367 | Zebra. All the applicable match operations are allowed, such as match on | |
1368 | prefix, next-hop, communities, etc. Set operations for this attach-point are | |
1369 | limited to metric and next-hop only. Any operation of this feature does not | |
1370 | affect BGPs internal RIB. | |
42fc5d26 | 1371 | |
c1a54c05 QY |
1372 | Supported for ipv4 and ipv6 address families. It works on multi-paths as |
1373 | well, however, metric setting is based on the best-path only. | |
42fc5d26 | 1374 | |
8fcedbd2 | 1375 | .. _bgp-peers: |
42fc5d26 | 1376 | |
8fcedbd2 QY |
1377 | Peers |
1378 | ----- | |
42fc5d26 | 1379 | |
8fcedbd2 | 1380 | .. _bgp-defining-peers: |
42fc5d26 | 1381 | |
8fcedbd2 QY |
1382 | Defining Peers |
1383 | ^^^^^^^^^^^^^^ | |
42fc5d26 | 1384 | |
c1a54c05 | 1385 | .. clicmd:: neighbor PEER remote-as ASN |
42fc5d26 | 1386 | |
c1a54c05 | 1387 | Creates a new neighbor whose remote-as is ASN. PEER can be an IPv4 address |
9eb95b3b | 1388 | or an IPv6 address or an interface to use for the connection. |
76bd1499 | 1389 | |
9eb95b3b QY |
1390 | .. code-block:: frr |
1391 | ||
1392 | router bgp 1 | |
1393 | neighbor 10.0.0.1 remote-as 2 | |
76bd1499 | 1394 | |
c1a54c05 | 1395 | In this case my router, in AS-1, is trying to peer with AS-2 at 10.0.0.1. |
76bd1499 | 1396 | |
c1a54c05 | 1397 | This command must be the first command used when configuring a neighbor. If |
9eb95b3b | 1398 | the remote-as is not specified, *bgpd* will complain like this: :: |
76bd1499 | 1399 | |
c1a54c05 | 1400 | can't find neighbor 10.0.0.1 |
c3c5a71f | 1401 | |
5413757f DS |
1402 | .. clicmd:: neighbor PEER remote-as internal |
1403 | ||
1404 | Create a peer as you would when you specify an ASN, except that if the | |
1405 | peers ASN is different than mine as specified under the :clicmd:`router bgp ASN` | |
1406 | command the connection will be denied. | |
1407 | ||
5413757f DS |
1408 | .. clicmd:: neighbor PEER remote-as external |
1409 | ||
1410 | Create a peer as you would when you specify an ASN, except that if the | |
1411 | peers ASN is the same as mine as specified under the :clicmd:`router bgp ASN` | |
1412 | command the connection will be denied. | |
42fc5d26 | 1413 | |
03750f1e | 1414 | .. clicmd:: bgp listen range <A.B.C.D/M|X:X::X:X/M> peer-group PGNAME |
d79e0e08 QY |
1415 | |
1416 | Accept connections from any peers in the specified prefix. Configuration | |
1417 | from the specified peer-group is used to configure these peers. | |
1418 | ||
1419 | .. note:: | |
1420 | ||
1421 | When using BGP listen ranges, if the associated peer group has TCP MD5 | |
1422 | authentication configured, your kernel must support this on prefixes. On | |
1423 | Linux, this support was added in kernel version 4.14. If your kernel does | |
1424 | not support this feature you will get a warning in the log file, and the | |
1425 | listen range will only accept connections from peers without MD5 configured. | |
1426 | ||
1427 | Additionally, we have observed that when using this option at scale (several | |
1428 | hundred peers) the kernel may hit its option memory limit. In this situation | |
1429 | you will see error messages like: | |
1430 | ||
1431 | ``bgpd: sockopt_tcp_signature: setsockopt(23): Cannot allocate memory`` | |
1432 | ||
1433 | In this case you need to increase the value of the sysctl | |
1434 | ``net.core.optmem_max`` to allow the kernel to allocate the necessary option | |
1435 | memory. | |
1436 | ||
5b1b6b8b PG |
1437 | .. clicmd:: bgp listen limit <1-65535> |
1438 | ||
1439 | Define the maximum number of peers accepted for one BGP instance. This | |
1440 | limit is set to 100 by default. Increasing this value will really be | |
1441 | possible if more file descriptors are available in the BGP process. This | |
1442 | value is defined by the underlying system (ulimit value), and can be | |
f563acec | 1443 | overridden by `--limit-fds`. More information is available in chapter |
5b1b6b8b PG |
1444 | (:ref:`common-invocation-options`). |
1445 | ||
03750f1e | 1446 | .. clicmd:: coalesce-time (0-4294967295) |
ced26d3d DS |
1447 | |
1448 | The time in milliseconds that BGP will delay before deciding what peers | |
1449 | can be put into an update-group together in order to generate a single | |
1450 | update for them. The default time is 1000. | |
91052810 | 1451 | |
8fcedbd2 | 1452 | .. _bgp-configuring-peers: |
42fc5d26 | 1453 | |
8fcedbd2 QY |
1454 | Configuring Peers |
1455 | ^^^^^^^^^^^^^^^^^ | |
42fc5d26 | 1456 | |
03750f1e | 1457 | .. clicmd:: neighbor PEER shutdown [message MSG...] [rtt (1-65535) [count (1-255)]] |
c3c5a71f | 1458 | |
c1a54c05 QY |
1459 | Shutdown the peer. We can delete the neighbor's configuration by |
1460 | ``no neighbor PEER remote-as ASN`` but all configuration of the neighbor | |
1461 | will be deleted. When you want to preserve the configuration, but want to | |
1462 | drop the BGP peer, use this syntax. | |
c3c5a71f | 1463 | |
70335e0a RZ |
1464 | Optionally you can specify a shutdown message `MSG`. |
1465 | ||
56c07345 | 1466 | Also, you can specify optionally ``rtt`` in milliseconds to automatically |
91052810 DA |
1467 | shutdown the peer if round-trip-time becomes higher than defined. |
1468 | ||
56c07345 | 1469 | Additional ``count`` parameter is the number of keepalive messages to count |
91052810 DA |
1470 | before shutdown the peer if round-trip-time becomes higher than defined. |
1471 | ||
03750f1e | 1472 | .. clicmd:: neighbor PEER disable-connected-check |
c3c5a71f | 1473 | |
c0868e8b QY |
1474 | Allow peerings between directly connected eBGP peers using loopback |
1475 | addresses. | |
c3c5a71f | 1476 | |
8dbe9214 DA |
1477 | .. clicmd:: neighbor PEER disable-link-bw-encoding-ieee |
1478 | ||
1479 | By default bandwidth in extended communities is carried encoded as IEEE | |
1480 | floating-point format, which is according to the draft. | |
1481 | ||
1482 | Older versions have the implementation where extended community bandwidth | |
1483 | value is carried encoded as uint32. To enable backward compatibility we | |
1484 | need to disable IEEE floating-point encoding option per-peer. | |
1485 | ||
ad7d219d DA |
1486 | .. clicmd:: neighbor PEER extended-optional-parameters |
1487 | ||
1488 | Force Extended Optional Parameters Length format to be used for OPEN messages. | |
1489 | ||
1490 | By default, it's disabled. If the standard optional parameters length is | |
1491 | higher than one-octet (255), then extended format is enabled automatically. | |
1492 | ||
1493 | For testing purposes, extended format can be enabled with this command. | |
1494 | ||
03750f1e | 1495 | .. clicmd:: neighbor PEER ebgp-multihop |
42fc5d26 | 1496 | |
164786a9 QY |
1497 | Specifying ``ebgp-multihop`` allows sessions with eBGP neighbors to |
1498 | establish when they are multiple hops away. When the neighbor is not | |
1499 | directly connected and this knob is not enabled, the session will not | |
1500 | establish. | |
1501 | ||
15e6881e DA |
1502 | If the peer's IP address is not in the RIB and is reachable via the |
1503 | default route, then you have to enable ``ip nht resolve-via-default``. | |
1504 | ||
03750f1e | 1505 | .. clicmd:: neighbor PEER description ... |
42fc5d26 | 1506 | |
c1a54c05 | 1507 | Set description of the peer. |
42fc5d26 | 1508 | |
03750f1e | 1509 | .. clicmd:: neighbor PEER interface IFNAME |
42fc5d26 | 1510 | |
c1a54c05 QY |
1511 | When you connect to a BGP peer over an IPv6 link-local address, you have to |
1512 | specify the IFNAME of the interface used for the connection. To specify | |
1513 | IPv4 session addresses, see the ``neighbor PEER update-source`` command | |
1514 | below. | |
42fc5d26 | 1515 | |
da4d6777 QY |
1516 | .. clicmd:: neighbor PEER interface remote-as <internal|external|ASN> |
1517 | ||
1518 | Configure an unnumbered BGP peer. ``PEER`` should be an interface name. The | |
1519 | session will be established via IPv6 link locals. Use ``internal`` for iBGP | |
1520 | and ``external`` for eBGP sessions, or specify an ASN if you wish. | |
1521 | ||
42d623ac | 1522 | .. clicmd:: neighbor PEER next-hop-self [force] |
42fc5d26 | 1523 | |
c1a54c05 | 1524 | This command specifies an announced route's nexthop as being equivalent to |
42d623ac TA |
1525 | the address of the bgp router if it is learned via eBGP. This will also |
1526 | bypass third-party next-hops in favor of the local bgp address. If the | |
1527 | optional keyword ``force`` is specified the modification is done also for | |
1528 | routes learned via iBGP. | |
42fc5d26 | 1529 | |
8b0d734b | 1530 | .. clicmd:: neighbor PEER attribute-unchanged [{as-path|next-hop|med}] |
1531 | ||
1532 | This command specifies attributes to be left unchanged for advertisements | |
1533 | sent to a peer. Use this to leave the next-hop unchanged in ipv6 | |
1534 | configurations, as the route-map directive to leave the next-hop unchanged | |
1535 | is only available for ipv4. | |
1536 | ||
03750f1e | 1537 | .. clicmd:: neighbor PEER update-source <IFNAME|ADDRESS> |
42fc5d26 | 1538 | |
c1a54c05 QY |
1539 | Specify the IPv4 source address to use for the :abbr:`BGP` session to this |
1540 | neighbour, may be specified as either an IPv4 address directly or as an | |
1541 | interface name (in which case the *zebra* daemon MUST be running in order | |
9eb95b3b QY |
1542 | for *bgpd* to be able to retrieve interface state). |
1543 | ||
1544 | .. code-block:: frr | |
42fc5d26 | 1545 | |
c1a54c05 QY |
1546 | router bgp 64555 |
1547 | neighbor foo update-source 192.168.0.1 | |
1548 | neighbor bar update-source lo0 | |
42fc5d26 | 1549 | |
42fc5d26 | 1550 | |
91342239 | 1551 | .. clicmd:: neighbor PEER default-originate [route-map WORD] |
42fc5d26 | 1552 | |
4da7fda3 QY |
1553 | *bgpd*'s default is to not announce the default route (0.0.0.0/0) even if it |
1554 | is in routing table. When you want to announce default routes to the peer, | |
1555 | use this command. | |
42fc5d26 | 1556 | |
91342239 DA |
1557 | If ``route-map`` keyword is specified, then the default route will be |
1558 | originated only if route-map conditions are met. For example, announce | |
1559 | the default route only if ``10.10.10.10/32`` route exists and set an | |
1560 | arbitrary community for a default route. | |
1561 | ||
1562 | .. code-block:: frr | |
1563 | ||
1564 | router bgp 64555 | |
1565 | address-family ipv4 unicast | |
1566 | neighbor 192.168.255.1 default-originate route-map default | |
1567 | ! | |
1568 | ip prefix-list p1 seq 5 permit 10.10.10.10/32 | |
1569 | ! | |
1570 | route-map default permit 10 | |
1571 | match ip address prefix-list p1 | |
1572 | set community 123:123 | |
1573 | ! | |
1574 | ||
c1a54c05 | 1575 | .. clicmd:: neighbor PEER port PORT |
42fc5d26 | 1576 | |
03750f1e | 1577 | .. clicmd:: neighbor PEER password PASSWORD |
e7c105a7 DS |
1578 | |
1579 | Set a MD5 password to be used with the tcp socket that is being used | |
1580 | to connect to the remote peer. Please note if you are using this | |
1581 | command with a large number of peers on linux you should consider | |
1582 | modifying the `net.core.optmem_max` sysctl to a larger value to | |
1583 | avoid out of memory errors from the linux kernel. | |
1584 | ||
c1a54c05 | 1585 | .. clicmd:: neighbor PEER send-community |
42fc5d26 | 1586 | |
03750f1e | 1587 | .. clicmd:: neighbor PEER weight WEIGHT |
42fc5d26 | 1588 | |
c1a54c05 | 1589 | This command specifies a default `weight` value for the neighbor's routes. |
42fc5d26 | 1590 | |
03750f1e | 1591 | .. clicmd:: neighbor PEER maximum-prefix NUMBER [force] |
42fc5d26 | 1592 | |
886026c8 QY |
1593 | Sets a maximum number of prefixes we can receive from a given peer. If this |
1594 | number is exceeded, the BGP session will be destroyed. | |
1595 | ||
1596 | In practice, it is generally preferable to use a prefix-list to limit what | |
1597 | prefixes are received from the peer instead of using this knob. Tearing down | |
1598 | the BGP session when a limit is exceeded is far more destructive than merely | |
1599 | rejecting undesired prefixes. The prefix-list method is also much more | |
1600 | granular and offers much smarter matching criterion than number of received | |
1601 | prefixes, making it more suited to implementing policy. | |
1602 | ||
56c07345 | 1603 | If ``force`` is set, then ALL prefixes are counted for maximum instead of |
c1bcac1d DA |
1604 | accepted only. This is useful for cases where an inbound filter is applied, |
1605 | but you want maximum-prefix to act on ALL (including filtered) prefixes. This | |
1606 | option requires `soft-reconfiguration inbound` to be enabled for the peer. | |
1607 | ||
03750f1e | 1608 | .. clicmd:: neighbor PEER maximum-prefix-out NUMBER |
edf98aa3 DA |
1609 | |
1610 | Sets a maximum number of prefixes we can send to a given peer. | |
1611 | ||
f5399474 DA |
1612 | Since sent prefix count is managed by update-groups, this option |
1613 | creates a separate update-group for outgoing updates. | |
1614 | ||
03750f1e | 1615 | .. clicmd:: neighbor PEER local-as AS-NUMBER [no-prepend] [replace-as] |
42fc5d26 | 1616 | |
c1a54c05 QY |
1617 | Specify an alternate AS for this BGP process when interacting with the |
1618 | specified peer. With no modifiers, the specified local-as is prepended to | |
1619 | the received AS_PATH when receiving routing updates from the peer, and | |
1620 | prepended to the outgoing AS_PATH (after the process local AS) when | |
1621 | transmitting local routes to the peer. | |
42fc5d26 | 1622 | |
c1a54c05 QY |
1623 | If the no-prepend attribute is specified, then the supplied local-as is not |
1624 | prepended to the received AS_PATH. | |
c3c5a71f | 1625 | |
c1a54c05 QY |
1626 | If the replace-as attribute is specified, then only the supplied local-as is |
1627 | prepended to the AS_PATH when transmitting local-route updates to this peer. | |
c3c5a71f | 1628 | |
c1a54c05 | 1629 | Note that replace-as can only be specified if no-prepend is. |
c3c5a71f | 1630 | |
c1a54c05 | 1631 | This command is only allowed for eBGP peers. |
c3c5a71f | 1632 | |
03750f1e | 1633 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> as-override |
252c5590 RZ |
1634 | |
1635 | Override AS number of the originating router with the local AS number. | |
1636 | ||
1637 | Usually this configuration is used in PEs (Provider Edge) to replace | |
1638 | the incoming customer AS number so the connected CE (Customer Edge) | |
1639 | can use the same AS number as the other customer sites. This allows | |
1640 | customers of the provider network to use the same AS number across | |
1641 | their sites. | |
1642 | ||
1643 | This command is only allowed for eBGP peers. | |
1644 | ||
03750f1e | 1645 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> allowas-in [<(1-10)|origin>] |
ae1e0f32 RZ |
1646 | |
1647 | Accept incoming routes with AS path containing AS number with the same value | |
1648 | as the current system AS. | |
1649 | ||
1650 | This is used when you want to use the same AS number in your sites, but you | |
1651 | can't connect them directly. This is an alternative to | |
1652 | `neighbor WORD as-override`. | |
1653 | ||
f563acec | 1654 | The parameter `(1-10)` configures the amount of accepted occurrences of the |
ae1e0f32 RZ |
1655 | system AS number in AS path. |
1656 | ||
1657 | The parameter `origin` configures BGP to only accept routes originated with | |
1658 | the same AS number as the system. | |
1659 | ||
1660 | This command is only allowed for eBGP peers. | |
1661 | ||
03750f1e | 1662 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> addpath-tx-all-paths |
e03bf6fc RZ |
1663 | |
1664 | Configure BGP to send all known paths to neighbor in order to preserve multi | |
1665 | path capabilities inside a network. | |
1666 | ||
03750f1e | 1667 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> addpath-tx-bestpath-per-AS |
e03bf6fc RZ |
1668 | |
1669 | Configure BGP to send best known paths to neighbor in order to preserve multi | |
1670 | path capabilities inside a network. | |
1671 | ||
7cb0494d DA |
1672 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> disable-addpath-rx |
1673 | ||
1674 | Do not accept additional paths from this neighbor. | |
1675 | ||
03750f1e | 1676 | .. clicmd:: neighbor PEER ttl-security hops NUMBER |
c3c5a71f | 1677 | |
c1a54c05 QY |
1678 | This command enforces Generalized TTL Security Mechanism (GTSM), as |
1679 | specified in RFC 5082. With this command, only neighbors that are the | |
1680 | specified number of hops away will be allowed to become neighbors. This | |
d1e7591e | 1681 | command is mutually exclusive with *ebgp-multihop*. |
42fc5d26 | 1682 | |
03750f1e | 1683 | .. clicmd:: neighbor PEER capability extended-nexthop |
19f2b5e8 DS |
1684 | |
1685 | Allow bgp to negotiate the extended-nexthop capability with it's peer. | |
1686 | If you are peering over a v6 LL address then this capability is turned | |
1687 | on automatically. If you are peering over a v6 Global Address then | |
1688 | turning on this command will allow BGP to install v4 routes with | |
1689 | v6 nexthops if you do not have v4 configured on interfaces. | |
1690 | ||
46dbf9d0 DA |
1691 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> accept-own |
1692 | ||
1693 | Enable handling of self-originated VPN routes containing ``accept-own`` community. | |
1694 | ||
1695 | This feature allows you to handle self-originated VPN routes, which a BGP speaker | |
1696 | receives from a route-reflector. A 'self-originated' route is one that was | |
1697 | originally advertised by the speaker itself. As per :rfc:`4271`, a BGP speaker rejects | |
1698 | advertisements that originated the speaker itself. However, the BGP ACCEPT_OWN | |
1699 | mechanism enables a router to accept the prefixes it has advertised, when reflected | |
1700 | from a route-reflector that modifies certain attributes of the prefix. | |
1701 | ||
1702 | A special community called ``accept-own`` is attached to the prefix by the | |
1703 | route-reflector, which is a signal to the receiving router to bypass the ORIGINATOR_ID | |
1704 | and NEXTHOP/MP_REACH_NLRI check. | |
1705 | ||
1706 | Default: disabled. | |
1707 | ||
563212ee DA |
1708 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> path-attribute discard (1-255)... |
1709 | ||
1710 | Drops specified path attributes from BGP UPDATE messages from the specified neighbor. | |
1711 | ||
1712 | If you do not want specific attributes, you can drop them using this command, and | |
1713 | let the BGP proceed by ignoring those attributes. | |
1714 | ||
70a029ef DA |
1715 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> path-attribute treat-as-withdraw (1-255)... |
1716 | ||
1717 | Received BGP UPDATES that contain specified path attributes are treat-as-withdraw. If | |
1718 | there is an existing prefix in the BGP routing table, it will be removed. | |
1719 | ||
4f770cf1 DA |
1720 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> graceful-shutdown |
1721 | ||
1722 | Mark all routes from this neighbor as less preferred by setting ``graceful-shutdown`` | |
1723 | community, and local-preference to 0. | |
1724 | ||
03750f1e | 1725 | .. clicmd:: bgp fast-external-failover |
eb938189 | 1726 | |
52fb7e96 | 1727 | This command causes bgp to take down ebgp peers immediately |
eb938189 DS |
1728 | when a link flaps. `bgp fast-external-failover` is the default |
1729 | and will not be displayed as part of a `show run`. The no form | |
1730 | of the command turns off this ability. | |
1731 | ||
03750f1e | 1732 | .. clicmd:: bgp default ipv4-unicast |
bc132029 | 1733 | |
5441ad10 TA |
1734 | This command allows the user to specify that the IPv4 Unicast address |
1735 | family is turned on by default or not. This command defaults to on | |
1736 | and is not displayed. | |
bc132029 DS |
1737 | The `no bgp default ipv4-unicast` form of the command is displayed. |
1738 | ||
5441ad10 TA |
1739 | .. clicmd:: bgp default ipv4-multicast |
1740 | ||
1741 | This command allows the user to specify that the IPv4 Multicast address | |
1742 | family is turned on by default or not. This command defaults to off | |
1743 | and is not displayed. | |
1744 | The `bgp default ipv4-multicast` form of the command is displayed. | |
1745 | ||
1746 | .. clicmd:: bgp default ipv4-vpn | |
1747 | ||
1748 | This command allows the user to specify that the IPv4 MPLS VPN address | |
1749 | family is turned on by default or not. This command defaults to off | |
1750 | and is not displayed. | |
1751 | The `bgp default ipv4-vpn` form of the command is displayed. | |
1752 | ||
1753 | .. clicmd:: bgp default ipv4-flowspec | |
1754 | ||
1755 | This command allows the user to specify that the IPv4 Flowspec address | |
1756 | family is turned on by default or not. This command defaults to off | |
1757 | and is not displayed. | |
1758 | The `bgp default ipv4-flowspec` form of the command is displayed. | |
1759 | ||
2c853e5e DA |
1760 | .. clicmd:: bgp default ipv6-unicast |
1761 | ||
5441ad10 TA |
1762 | This command allows the user to specify that the IPv6 Unicast address |
1763 | family is turned on by default or not. This command defaults to off | |
1764 | and is not displayed. | |
2c853e5e DA |
1765 | The `bgp default ipv6-unicast` form of the command is displayed. |
1766 | ||
5441ad10 TA |
1767 | .. clicmd:: bgp default ipv6-multicast |
1768 | ||
1769 | This command allows the user to specify that the IPv6 Multicast address | |
1770 | family is turned on by default or not. This command defaults to off | |
1771 | and is not displayed. | |
1772 | The `bgp default ipv6-multicast` form of the command is displayed. | |
1773 | ||
1774 | .. clicmd:: bgp default ipv6-vpn | |
1775 | ||
1776 | This command allows the user to specify that the IPv6 MPLS VPN address | |
1777 | family is turned on by default or not. This command defaults to off | |
1778 | and is not displayed. | |
1779 | The `bgp default ipv6-vpn` form of the command is displayed. | |
1780 | ||
1781 | .. clicmd:: bgp default ipv6-flowspec | |
1782 | ||
1783 | This command allows the user to specify that the IPv6 Flowspec address | |
1784 | family is turned on by default or not. This command defaults to off | |
1785 | and is not displayed. | |
1786 | The `bgp default ipv6-flowspec` form of the command is displayed. | |
1787 | ||
1788 | .. clicmd:: bgp default l2vpn-evpn | |
1789 | ||
1790 | This command allows the user to specify that the L2VPN EVPN address | |
1791 | family is turned on by default or not. This command defaults to off | |
1792 | and is not displayed. | |
1793 | The `bgp default l2vpn-evpn` form of the command is displayed. | |
1794 | ||
03750f1e | 1795 | .. clicmd:: bgp default show-hostname |
7d981695 DA |
1796 | |
1797 | This command shows the hostname of the peer in certain BGP commands | |
1798 | outputs. It's easier to troubleshoot if you have a number of BGP peers. | |
1799 | ||
03750f1e | 1800 | .. clicmd:: bgp default show-nexthop-hostname |
7d981695 DA |
1801 | |
1802 | This command shows the hostname of the next-hop in certain BGP commands | |
1803 | outputs. It's easier to troubleshoot if you have a number of BGP peers | |
1804 | and a number of routes to check. | |
1805 | ||
03750f1e | 1806 | .. clicmd:: neighbor PEER advertisement-interval (0-600) |
e10dda57 DS |
1807 | |
1808 | Setup the minimum route advertisement interval(mrai) for the | |
1809 | peer in question. This number is between 0 and 600 seconds, | |
1810 | with the default advertisement interval being 0. | |
1811 | ||
0c969c0f QY |
1812 | .. clicmd:: neighbor PEER timers (0-65535) (0-65535) |
1813 | ||
1814 | Set keepalive and hold timers for a neighbor. The first value is keepalive | |
1815 | and the second is hold time. | |
1816 | ||
d7cd3d09 | 1817 | .. clicmd:: neighbor PEER timers connect (1-65535) |
0c969c0f QY |
1818 | |
1819 | Set connect timer for a neighbor. The connect timer controls how long BGP | |
1820 | waits between connection attempts to a neighbor. | |
1821 | ||
03750f1e | 1822 | .. clicmd:: neighbor PEER timers delayopen (1-240) |
94abf9b4 DS |
1823 | |
1824 | This command allows the user enable the | |
1825 | `RFC 4271 <https://tools.ietf.org/html/rfc4271/>` DelayOpenTimer with the | |
1826 | specified interval or disable it with the negating command for the peer. By | |
1827 | default, the DelayOpenTimer is disabled. The timer interval may be set to a | |
1828 | duration of 1 to 240 seconds. | |
1829 | ||
b042667a TI |
1830 | .. clicmd:: bgp minimum-holdtime (1-65535) |
1831 | ||
1832 | This command allows user to prevent session establishment with BGP peers | |
1833 | with lower holdtime less than configured minimum holdtime. | |
1834 | When this command is not set, minimum holdtime does not work. | |
1835 | ||
d1adb448 PG |
1836 | .. clicmd:: bgp tcp-keepalive (1-65535) (1-65535) (1-30) |
1837 | ||
1838 | This command allows user to configure TCP keepalive with new BGP peers. | |
1839 | Each parameter respectively stands for TCP keepalive idle timer (seconds), | |
1840 | interval (seconds), and maximum probes. By default, TCP keepalive is | |
1841 | disabled. | |
1842 | ||
4e853678 DS |
1843 | Displaying Information about Peers |
1844 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1845 | ||
200631aa | 1846 | .. clicmd:: show bgp <afi> <safi> neighbors WORD bestpath-routes [detail] [json] [wide] |
4e853678 DS |
1847 | |
1848 | For the given neighbor, WORD, that is specified list the routes selected | |
1849 | by BGP as having the best path. | |
1850 | ||
200631aa TA |
1851 | If ``detail`` option is specified, the detailed version of all routes |
1852 | will be displayed. The same format as ``show [ip] bgp [afi] [safi] PREFIX`` | |
1853 | will be used, but for the whole table of received, advertised or filtered | |
1854 | prefixes. | |
1855 | ||
1856 | If ``json`` option is specified, output is displayed in JSON format. | |
1857 | ||
1858 | If ``wide`` option is specified, then the prefix table's width is increased | |
1859 | to fully display the prefix and the nexthop. | |
1860 | ||
8fcedbd2 | 1861 | .. _bgp-peer-filtering: |
42fc5d26 | 1862 | |
8fcedbd2 QY |
1863 | Peer Filtering |
1864 | ^^^^^^^^^^^^^^ | |
42fc5d26 | 1865 | |
c1a54c05 | 1866 | .. clicmd:: neighbor PEER distribute-list NAME [in|out] |
42fc5d26 | 1867 | |
c1a54c05 QY |
1868 | This command specifies a distribute-list for the peer. `direct` is |
1869 | ``in`` or ``out``. | |
42fc5d26 | 1870 | |
29adcd50 | 1871 | .. clicmd:: neighbor PEER prefix-list NAME [in|out] |
42fc5d26 | 1872 | |
29adcd50 | 1873 | .. clicmd:: neighbor PEER filter-list NAME [in|out] |
42fc5d26 | 1874 | |
c1a54c05 | 1875 | .. clicmd:: neighbor PEER route-map NAME [in|out] |
42fc5d26 | 1876 | |
c1a54c05 | 1877 | Apply a route-map on the neighbor. `direct` must be `in` or `out`. |
42fc5d26 | 1878 | |
29adcd50 | 1879 | .. clicmd:: bgp route-reflector allow-outbound-policy |
42fc5d26 | 1880 | |
c1a54c05 QY |
1881 | By default, attribute modification via route-map policy out is not reflected |
1882 | on reflected routes. This option allows the modifications to be reflected as | |
1883 | well. Once enabled, it affects all reflected routes. | |
42fc5d26 | 1884 | |
03750f1e | 1885 | .. clicmd:: neighbor PEER sender-as-path-loop-detection |
583a9fd4 RZ |
1886 | |
1887 | Enable the detection of sender side AS path loops and filter the | |
1888 | bad routes before they are sent. | |
1889 | ||
1890 | This setting is disabled by default. | |
1891 | ||
0efdf0fe | 1892 | .. _bgp-peer-group: |
42fc5d26 | 1893 | |
8fcedbd2 QY |
1894 | Peer Groups |
1895 | ^^^^^^^^^^^ | |
42fc5d26 | 1896 | |
199ad5c4 LB |
1897 | Peer groups are used to help improve scaling by generating the same |
1898 | update information to all members of a peer group. Note that this means | |
1899 | that the routes generated by a member of a peer group will be sent back | |
1900 | to that originating peer with the originator identifier attribute set to | |
1901 | indicated the originating peer. All peers not associated with a | |
1902 | specific peer group are treated as belonging to a default peer group, | |
1903 | and will share updates. | |
1904 | ||
c1a54c05 | 1905 | .. clicmd:: neighbor WORD peer-group |
42fc5d26 | 1906 | |
c1a54c05 | 1907 | This command defines a new peer group. |
42fc5d26 | 1908 | |
d7b9898c | 1909 | .. clicmd:: neighbor PEER peer-group PGNAME |
c3c5a71f | 1910 | |
c1a54c05 | 1911 | This command bind specific peer to peer group WORD. |
42fc5d26 | 1912 | |
199ad5c4 LB |
1913 | .. clicmd:: neighbor PEER solo |
1914 | ||
1915 | This command is used to indicate that routes advertised by the peer | |
1916 | should not be reflected back to the peer. This command only is only | |
1917 | meaningful when there is a single peer defined in the peer-group. | |
1918 | ||
65c0fc12 DA |
1919 | .. clicmd:: show [ip] bgp peer-group [json] |
1920 | ||
1921 | This command displays configured BGP peer-groups. | |
1922 | ||
1923 | .. code-block:: frr | |
1924 | ||
1925 | exit1-debian-9# show bgp peer-group | |
1926 | ||
1927 | BGP peer-group test1, remote AS 65001 | |
1928 | Peer-group type is external | |
1929 | Configured address-families: IPv4 Unicast; IPv6 Unicast; | |
1930 | 1 IPv4 listen range(s) | |
1931 | 192.168.100.0/24 | |
1932 | 2 IPv6 listen range(s) | |
1933 | 2001:db8:1::/64 | |
1934 | 2001:db8:2::/64 | |
1935 | Peer-group members: | |
1936 | 192.168.200.1 Active | |
1937 | 2001:db8::1 Active | |
1938 | ||
1939 | BGP peer-group test2 | |
1940 | Peer-group type is external | |
1941 | Configured address-families: IPv4 Unicast; | |
1942 | ||
1943 | Optional ``json`` parameter is used to display JSON output. | |
1944 | ||
1945 | .. code-block:: frr | |
1946 | ||
1947 | { | |
1948 | "test1":{ | |
1949 | "remoteAs":65001, | |
1950 | "type":"external", | |
1951 | "addressFamiliesConfigured":[ | |
1952 | "IPv4 Unicast", | |
1953 | "IPv6 Unicast" | |
1954 | ], | |
1955 | "dynamicRanges":{ | |
1956 | "IPv4":{ | |
1957 | "count":1, | |
1958 | "ranges":[ | |
1959 | "192.168.100.0\/24" | |
1960 | ] | |
1961 | }, | |
1962 | "IPv6":{ | |
1963 | "count":2, | |
1964 | "ranges":[ | |
1965 | "2001:db8:1::\/64", | |
1966 | "2001:db8:2::\/64" | |
1967 | ] | |
1968 | } | |
1969 | }, | |
1970 | "members":{ | |
1971 | "192.168.200.1":{ | |
1972 | "status":"Active" | |
1973 | }, | |
1974 | "2001:db8::1":{ | |
1975 | "status":"Active" | |
1976 | } | |
1977 | } | |
1978 | }, | |
1979 | "test2":{ | |
1980 | "type":"external", | |
1981 | "addressFamiliesConfigured":[ | |
1982 | "IPv4 Unicast" | |
1983 | ] | |
1984 | } | |
1985 | } | |
1986 | ||
8fcedbd2 QY |
1987 | Capability Negotiation |
1988 | ^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 | 1989 | |
8fcedbd2 | 1990 | .. clicmd:: neighbor PEER strict-capability-match |
42fc5d26 | 1991 | |
c1a54c05 | 1992 | |
8fcedbd2 QY |
1993 | Strictly compares remote capabilities and local capabilities. If |
1994 | capabilities are different, send Unsupported Capability error then reset | |
1995 | connection. | |
42fc5d26 | 1996 | |
8fcedbd2 QY |
1997 | You may want to disable sending Capability Negotiation OPEN message optional |
1998 | parameter to the peer when remote peer does not implement Capability | |
1999 | Negotiation. Please use *dont-capability-negotiate* command to disable the | |
2000 | feature. | |
42fc5d26 | 2001 | |
03750f1e | 2002 | .. clicmd:: neighbor PEER dont-capability-negotiate |
42fc5d26 | 2003 | |
8fcedbd2 QY |
2004 | Suppress sending Capability Negotiation as OPEN message optional parameter |
2005 | to the peer. This command only affects the peer is configured other than | |
2006 | IPv4 unicast configuration. | |
42fc5d26 | 2007 | |
8fcedbd2 QY |
2008 | When remote peer does not have capability negotiation feature, remote peer |
2009 | will not send any capabilities at all. In that case, bgp configures the peer | |
2010 | with configured capabilities. | |
42fc5d26 | 2011 | |
8fcedbd2 QY |
2012 | You may prefer locally configured capabilities more than the negotiated |
2013 | capabilities even though remote peer sends capabilities. If the peer is | |
2014 | configured by *override-capability*, *bgpd* ignores received capabilities | |
2015 | then override negotiated capabilities with configured values. | |
42fc5d26 | 2016 | |
7cdc9530 DS |
2017 | Additionally the operator should be reminded that this feature fundamentally |
2018 | disables the ability to use widely deployed BGP features. BGP unnumbered, | |
2019 | hostname support, AS4, Addpath, Route Refresh, ORF, Dynamic Capabilities, | |
2020 | and graceful restart. | |
2021 | ||
8fcedbd2 | 2022 | .. clicmd:: neighbor PEER override-capability |
42fc5d26 | 2023 | |
8fcedbd2 QY |
2024 | Override the result of Capability Negotiation with local configuration. |
2025 | Ignore remote peer's capability value. | |
42fc5d26 | 2026 | |
234f6fd4 DA |
2027 | .. clicmd:: neighbor PEER capability software-version |
2028 | ||
2029 | Send the software version in the BGP OPEN message to the neighbor. This is | |
2030 | very useful in environments with a large amount of peers with different | |
2031 | versions of FRR or any other vendor. | |
2032 | ||
2033 | Disabled by default. | |
2034 | ||
05dbe644 DA |
2035 | .. clicmd:: neighbor PEER aigp |
2036 | ||
2037 | Send and receive AIGP attribute for this neighbor. This is valid only for | |
2038 | eBGP neighbors. | |
2039 | ||
2040 | Disabled by default. iBGP neighbors have this option enabled implicitly. | |
2041 | ||
8fcedbd2 | 2042 | .. _bgp-as-path-access-lists: |
42fc5d26 | 2043 | |
8fcedbd2 QY |
2044 | AS Path Access Lists |
2045 | -------------------- | |
42fc5d26 QY |
2046 | |
2047 | AS path access list is user defined AS path. | |
2048 | ||
e6e62ee5 | 2049 | .. clicmd:: bgp as-path access-list WORD [seq (0-4294967295)] permit|deny LINE |
42fc5d26 | 2050 | |
c1a54c05 | 2051 | This command defines a new AS path access list. |
42fc5d26 | 2052 | |
b15e8360 | 2053 | .. clicmd:: show bgp as-path-access-list [json] |
42fc5d26 | 2054 | |
b15e8360 RW |
2055 | Display all BGP AS Path access lists. |
2056 | ||
2057 | If the ``json`` option is specified, output is displayed in JSON format. | |
2058 | ||
2059 | .. clicmd:: show bgp as-path-access-list WORD [json] | |
2060 | ||
2061 | Display the specified BGP AS Path access list. | |
2062 | ||
2063 | If the ``json`` option is specified, output is displayed in JSON format. | |
42fc5d26 | 2064 | |
125cec1a DA |
2065 | .. _bgp-bogon-filter-example: |
2066 | ||
2067 | Bogon ASN filter policy configuration example | |
2068 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
2069 | ||
2070 | .. code-block:: frr | |
2071 | ||
2072 | bgp as-path access-list 99 permit _0_ | |
2073 | bgp as-path access-list 99 permit _23456_ | |
2074 | bgp as-path access-list 99 permit _1310[0-6][0-9]_|_13107[0-1]_ | |
e6e62ee5 | 2075 | bgp as-path access-list 99 seq 20 permit ^65 |
125cec1a | 2076 | |
8fcedbd2 | 2077 | .. _bgp-using-as-path-in-route-map: |
42fc5d26 QY |
2078 | |
2079 | Using AS Path in Route Map | |
2080 | -------------------------- | |
2081 | ||
03750f1e | 2082 | .. clicmd:: match as-path WORD |
42fc5d26 | 2083 | |
eb1f303d DS |
2084 | For a given as-path, WORD, match it on the BGP as-path given for the prefix |
2085 | and if it matches do normal route-map actions. The no form of the command | |
2086 | removes this match from the route-map. | |
42fc5d26 | 2087 | |
03750f1e | 2088 | .. clicmd:: set as-path prepend AS-PATH |
42fc5d26 | 2089 | |
eb1f303d DS |
2090 | Prepend the given string of AS numbers to the AS_PATH of the BGP path's NLRI. |
2091 | The no form of this command removes this set operation from the route-map. | |
42fc5d26 | 2092 | |
03750f1e | 2093 | .. clicmd:: set as-path prepend last-as NUM |
c1a54c05 QY |
2094 | |
2095 | Prepend the existing last AS number (the leftmost ASN) to the AS_PATH. | |
eb1f303d | 2096 | The no form of this command removes this set operation from the route-map. |
42fc5d26 | 2097 | |
77e3d821 DA |
2098 | .. clicmd:: set as-path replace <any|ASN> |
2099 | ||
2100 | Replace a specific AS number to local AS number. ``any`` replaces each | |
2101 | AS number in the AS-PATH with the local AS number. | |
2102 | ||
0efdf0fe | 2103 | .. _bgp-communities-attribute: |
42fc5d26 | 2104 | |
8fcedbd2 QY |
2105 | Communities Attribute |
2106 | --------------------- | |
42fc5d26 | 2107 | |
8fcedbd2 | 2108 | The BGP communities attribute is widely used for implementing policy routing. |
c1a54c05 QY |
2109 | Network operators can manipulate BGP communities attribute based on their |
2110 | network policy. BGP communities attribute is defined in :rfc:`1997` and | |
2111 | :rfc:`1998`. It is an optional transitive attribute, therefore local policy can | |
2112 | travel through different autonomous system. | |
2113 | ||
8fcedbd2 QY |
2114 | The communities attribute is a set of communities values. Each community value |
2115 | is 4 octet long. The following format is used to define the community value. | |
c1a54c05 | 2116 | |
8fcedbd2 | 2117 | ``AS:VAL`` |
c1a54c05 QY |
2118 | This format represents 4 octet communities value. ``AS`` is high order 2 |
2119 | octet in digit format. ``VAL`` is low order 2 octet in digit format. This | |
2120 | format is useful to define AS oriented policy value. For example, | |
2121 | ``7675:80`` can be used when AS 7675 wants to pass local policy value 80 to | |
2122 | neighboring peer. | |
2123 | ||
cae770d3 C |
2124 | ``graceful-shutdown`` |
2125 | ``graceful-shutdown`` represents well-known communities value | |
2126 | ``GRACEFUL_SHUTDOWN`` ``0xFFFF0000`` ``65535:0``. :rfc:`8326` implements | |
2127 | the purpose Graceful BGP Session Shutdown to reduce the amount of | |
56f0bea7 | 2128 | lost traffic when taking BGP sessions down for maintenance. The use |
cae770d3 C |
2129 | of the community needs to be supported from your peers side to |
2130 | actually have any effect. | |
2131 | ||
2132 | ``accept-own`` | |
2133 | ``accept-own`` represents well-known communities value ``ACCEPT_OWN`` | |
2134 | ``0xFFFF0001`` ``65535:1``. :rfc:`7611` implements a way to signal | |
2135 | to a router to accept routes with a local nexthop address. This | |
2136 | can be the case when doing policing and having traffic having a | |
2137 | nexthop located in another VRF but still local interface to the | |
2138 | router. It is recommended to read the RFC for full details. | |
2139 | ||
2140 | ``route-filter-translated-v4`` | |
2141 | ``route-filter-translated-v4`` represents well-known communities value | |
2142 | ``ROUTE_FILTER_TRANSLATED_v4`` ``0xFFFF0002`` ``65535:2``. | |
2143 | ||
2144 | ``route-filter-v4`` | |
2145 | ``route-filter-v4`` represents well-known communities value | |
2146 | ``ROUTE_FILTER_v4`` ``0xFFFF0003`` ``65535:3``. | |
2147 | ||
2148 | ``route-filter-translated-v6`` | |
2149 | ``route-filter-translated-v6`` represents well-known communities value | |
2150 | ``ROUTE_FILTER_TRANSLATED_v6`` ``0xFFFF0004`` ``65535:4``. | |
2151 | ||
2152 | ``route-filter-v6`` | |
2153 | ``route-filter-v6`` represents well-known communities value | |
2154 | ``ROUTE_FILTER_v6`` ``0xFFFF0005`` ``65535:5``. | |
2155 | ||
2156 | ``llgr-stale`` | |
2157 | ``llgr-stale`` represents well-known communities value ``LLGR_STALE`` | |
2158 | ``0xFFFF0006`` ``65535:6``. | |
56f0bea7 | 2159 | Assigned and intended only for use with routers supporting the |
cae770d3 | 2160 | Long-lived Graceful Restart Capability as described in |
49606d58 | 2161 | [Draft-IETF-uttaro-idr-bgp-persistence]_. |
56f0bea7 | 2162 | Routers receiving routes with this community may (depending on |
cae770d3 C |
2163 | implementation) choose allow to reject or modify routes on the |
2164 | presence or absence of this community. | |
2165 | ||
2166 | ``no-llgr`` | |
2167 | ``no-llgr`` represents well-known communities value ``NO_LLGR`` | |
2168 | ``0xFFFF0007`` ``65535:7``. | |
56f0bea7 | 2169 | Assigned and intended only for use with routers supporting the |
cae770d3 | 2170 | Long-lived Graceful Restart Capability as described in |
49606d58 | 2171 | [Draft-IETF-uttaro-idr-bgp-persistence]_. |
56f0bea7 | 2172 | Routers receiving routes with this community may (depending on |
cae770d3 C |
2173 | implementation) choose allow to reject or modify routes on the |
2174 | presence or absence of this community. | |
2175 | ||
2176 | ``accept-own-nexthop`` | |
2177 | ``accept-own-nexthop`` represents well-known communities value | |
2178 | ``accept-own-nexthop`` ``0xFFFF0008`` ``65535:8``. | |
49606d58 | 2179 | [Draft-IETF-agrewal-idr-accept-own-nexthop]_ describes |
cae770d3 C |
2180 | how to tag and label VPN routes to be able to send traffic between VRFs |
2181 | via an internal layer 2 domain on the same PE device. Refer to | |
49606d58 | 2182 | [Draft-IETF-agrewal-idr-accept-own-nexthop]_ for full details. |
cae770d3 C |
2183 | |
2184 | ``blackhole`` | |
2185 | ``blackhole`` represents well-known communities value ``BLACKHOLE`` | |
2186 | ``0xFFFF029A`` ``65535:666``. :rfc:`7999` documents sending prefixes to | |
2187 | EBGP peers and upstream for the purpose of blackholing traffic. | |
2188 | Prefixes tagged with the this community should normally not be | |
10ae708b DA |
2189 | re-advertised from neighbors of the originating network. Upon receiving |
2190 | ``BLACKHOLE`` community from a BGP speaker, ``NO_ADVERTISE`` community | |
2191 | is added automatically. | |
cae770d3 | 2192 | |
8fcedbd2 | 2193 | ``no-export`` |
c1a54c05 QY |
2194 | ``no-export`` represents well-known communities value ``NO_EXPORT`` |
2195 | ``0xFFFFFF01``. All routes carry this value must not be advertised to | |
2196 | outside a BGP confederation boundary. If neighboring BGP peer is part of BGP | |
2197 | confederation, the peer is considered as inside a BGP confederation | |
2198 | boundary, so the route will be announced to the peer. | |
2199 | ||
8fcedbd2 | 2200 | ``no-advertise`` |
c1a54c05 QY |
2201 | ``no-advertise`` represents well-known communities value ``NO_ADVERTISE`` |
2202 | ``0xFFFFFF02``. All routes carry this value must not be advertise to other | |
2203 | BGP peers. | |
2204 | ||
8fcedbd2 | 2205 | ``local-AS`` |
c1a54c05 QY |
2206 | ``local-AS`` represents well-known communities value ``NO_EXPORT_SUBCONFED`` |
2207 | ``0xFFFFFF03``. All routes carry this value must not be advertised to | |
2208 | external BGP peers. Even if the neighboring router is part of confederation, | |
2209 | it is considered as external BGP peer, so the route will not be announced to | |
2210 | the peer. | |
2211 | ||
cae770d3 C |
2212 | ``no-peer`` |
2213 | ``no-peer`` represents well-known communities value ``NOPEER`` | |
2214 | ``0xFFFFFF04`` ``65535:65284``. :rfc:`3765` is used to communicate to | |
2215 | another network how the originating network want the prefix propagated. | |
2216 | ||
aa9eafa4 QY |
2217 | When the communities attribute is received duplicate community values in the |
2218 | attribute are ignored and value is sorted in numerical order. | |
42fc5d26 | 2219 | |
49606d58 PG |
2220 | .. [Draft-IETF-uttaro-idr-bgp-persistence] <https://tools.ietf.org/id/draft-uttaro-idr-bgp-persistence-04.txt> |
2221 | .. [Draft-IETF-agrewal-idr-accept-own-nexthop] <https://tools.ietf.org/id/draft-agrewal-idr-accept-own-nexthop-00.txt> | |
2222 | ||
0efdf0fe | 2223 | .. _bgp-community-lists: |
42fc5d26 | 2224 | |
8fcedbd2 QY |
2225 | Community Lists |
2226 | ^^^^^^^^^^^^^^^ | |
aa9eafa4 QY |
2227 | Community lists are user defined lists of community attribute values. These |
2228 | lists can be used for matching or manipulating the communities attribute in | |
2229 | UPDATE messages. | |
42fc5d26 | 2230 | |
aa9eafa4 | 2231 | There are two types of community list: |
c1a54c05 | 2232 | |
aa9eafa4 | 2233 | standard |
56f0bea7 | 2234 | This type accepts an explicit value for the attribute. |
aa9eafa4 QY |
2235 | |
2236 | expanded | |
2237 | This type accepts a regular expression. Because the regex must be | |
2238 | interpreted on each use expanded community lists are slower than standard | |
2239 | lists. | |
42fc5d26 | 2240 | |
a64e0ee5 | 2241 | .. clicmd:: bgp community-list standard NAME permit|deny COMMUNITY |
42fc5d26 | 2242 | |
aa9eafa4 QY |
2243 | This command defines a new standard community list. ``COMMUNITY`` is |
2244 | communities value. The ``COMMUNITY`` is compiled into community structure. | |
2245 | We can define multiple community list under same name. In that case match | |
2246 | will happen user defined order. Once the community list matches to | |
2247 | communities attribute in BGP updates it return permit or deny by the | |
2248 | community list definition. When there is no matched entry, deny will be | |
2249 | returned. When ``COMMUNITY`` is empty it matches to any routes. | |
42fc5d26 | 2250 | |
a64e0ee5 | 2251 | .. clicmd:: bgp community-list expanded NAME permit|deny COMMUNITY |
42fc5d26 | 2252 | |
aa9eafa4 QY |
2253 | This command defines a new expanded community list. ``COMMUNITY`` is a |
2254 | string expression of communities attribute. ``COMMUNITY`` can be a regular | |
2255 | expression (:ref:`bgp-regular-expressions`) to match the communities | |
47f47873 PG |
2256 | attribute in BGP updates. The expanded community is only used to filter, |
2257 | not `set` actions. | |
42fc5d26 | 2258 | |
aa9eafa4 QY |
2259 | .. deprecated:: 5.0 |
2260 | It is recommended to use the more explicit versions of this command. | |
42fc5d26 | 2261 | |
a64e0ee5 | 2262 | .. clicmd:: bgp community-list NAME permit|deny COMMUNITY |
aa9eafa4 QY |
2263 | |
2264 | When the community list type is not specified, the community list type is | |
2265 | automatically detected. If ``COMMUNITY`` can be compiled into communities | |
2266 | attribute, the community list is defined as a standard community list. | |
2267 | Otherwise it is defined as an expanded community list. This feature is left | |
2268 | for backward compatibility. Use of this feature is not recommended. | |
42fc5d26 | 2269 | |
03750f1e QY |
2270 | Note that all community lists share the same namespace, so it's not |
2271 | necessary to specify ``standard`` or ``expanded``; these modifiers are | |
2272 | purely aesthetic. | |
42fc5d26 | 2273 | |
36dc43aa | 2274 | .. clicmd:: show bgp community-list [NAME detail] |
42fc5d26 | 2275 | |
aa9eafa4 QY |
2276 | Displays community list information. When ``NAME`` is specified the |
2277 | specified community list's information is shown. | |
c3c5a71f | 2278 | |
c1a54c05 | 2279 | :: |
76bd1499 | 2280 | |
a64e0ee5 | 2281 | # show bgp community-list |
c1a54c05 QY |
2282 | Named Community standard list CLIST |
2283 | permit 7675:80 7675:100 no-export | |
2284 | deny internet | |
2285 | Named Community expanded list EXPAND | |
2286 | permit : | |
76bd1499 | 2287 | |
36dc43aa | 2288 | # show bgp community-list CLIST detail |
c1a54c05 QY |
2289 | Named Community standard list CLIST |
2290 | permit 7675:80 7675:100 no-export | |
2291 | deny internet | |
42fc5d26 | 2292 | |
42fc5d26 | 2293 | |
8fcedbd2 | 2294 | .. _bgp-numbered-community-lists: |
42fc5d26 | 2295 | |
8fcedbd2 QY |
2296 | Numbered Community Lists |
2297 | ^^^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 QY |
2298 | |
2299 | When number is used for BGP community list name, the number has | |
c3e69122 | 2300 | special meanings. Community list number in the range from 1 to 99 is |
c3c5a71f | 2301 | standard community list. Community list number in the range from 100 |
0757efc0 | 2302 | to 500 is expanded community list. These community lists are called |
c3c5a71f | 2303 | as numbered community lists. On the other hand normal community lists |
42fc5d26 QY |
2304 | is called as named community lists. |
2305 | ||
a64e0ee5 | 2306 | .. clicmd:: bgp community-list (1-99) permit|deny COMMUNITY |
42fc5d26 | 2307 | |
aa9eafa4 QY |
2308 | This command defines a new community list. The argument to (1-99) defines |
2309 | the list identifier. | |
42fc5d26 | 2310 | |
0757efc0 | 2311 | .. clicmd:: bgp community-list (100-500) permit|deny COMMUNITY |
42fc5d26 | 2312 | |
aa9eafa4 | 2313 | This command defines a new expanded community list. The argument to |
0757efc0 | 2314 | (100-500) defines the list identifier. |
42fc5d26 | 2315 | |
6a89dd1e DA |
2316 | .. _bgp-community-alias: |
2317 | ||
2318 | Community alias | |
2319 | ^^^^^^^^^^^^^^^ | |
2320 | ||
2321 | BGP community aliases are useful to quickly identify what communities are set | |
2322 | for a specific prefix in a human-readable format. Especially handy for a huge | |
2323 | amount of communities. Accurately defined aliases can help you faster spot | |
2324 | things on the wire. | |
2325 | ||
2326 | .. clicmd:: bgp community alias NAME ALIAS | |
2327 | ||
2328 | This command creates an alias name for a community that will be used | |
2329 | later in various CLI outputs in a human-readable format. | |
2330 | ||
2331 | .. code-block:: frr | |
2332 | ||
2333 | ~# vtysh -c 'show run' | grep 'bgp community alias' | |
2334 | bgp community alias 65001:14 community-1 | |
2335 | bgp community alias 65001:123:1 lcommunity-1 | |
2336 | ||
2337 | ~# vtysh -c 'show ip bgp 172.16.16.1/32' | |
2338 | BGP routing table entry for 172.16.16.1/32, version 21 | |
2339 | Paths: (2 available, best #2, table default) | |
2340 | Advertised to non peer-group peers: | |
2341 | 65030 | |
2342 | 192.168.0.2 from 192.168.0.2 (172.16.16.1) | |
2343 | Origin incomplete, metric 0, valid, external, best (Neighbor IP) | |
2344 | Community: 65001:12 65001:13 community-1 65001:65534 | |
2345 | Large Community: lcommunity-1 65001:123:2 | |
2346 | Last update: Fri Apr 16 12:51:27 2021 | |
2347 | ||
9f977b2d DA |
2348 | .. clicmd:: show bgp [afi] [safi] [all] alias WORD [wide|json] |
2349 | ||
2350 | Display prefixes with matching BGP community alias. | |
2351 | ||
8fcedbd2 | 2352 | .. _bgp-using-communities-in-route-map: |
42fc5d26 | 2353 | |
8fcedbd2 QY |
2354 | Using Communities in Route Maps |
2355 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 | 2356 | |
aa9eafa4 QY |
2357 | In :ref:`route-map` we can match on or set the BGP communities attribute. Using |
2358 | this feature network operator can implement their network policy based on BGP | |
2359 | communities attribute. | |
42fc5d26 | 2360 | |
b91bf5bd | 2361 | The following commands can be used in route maps: |
42fc5d26 | 2362 | |
80dd0954 DA |
2363 | .. clicmd:: match alias WORD |
2364 | ||
2365 | This command performs match to BGP updates using community alias WORD. When | |
2366 | the one of BGP communities value match to the one of community alias value in | |
2367 | community alias, it is match. | |
2368 | ||
aa9eafa4 | 2369 | .. clicmd:: match community WORD exact-match [exact-match] |
42fc5d26 | 2370 | |
c1a54c05 QY |
2371 | This command perform match to BGP updates using community list WORD. When |
2372 | the one of BGP communities value match to the one of communities value in | |
d1e7591e | 2373 | community list, it is match. When `exact-match` keyword is specified, match |
c1a54c05 QY |
2374 | happen only when BGP updates have completely same communities value |
2375 | specified in the community list. | |
42fc5d26 | 2376 | |
aa9eafa4 | 2377 | .. clicmd:: set community <none|COMMUNITY> additive |
42fc5d26 | 2378 | |
aa9eafa4 QY |
2379 | This command sets the community value in BGP updates. If the attribute is |
2380 | already configured, the newly provided value replaces the old one unless the | |
2381 | ``additive`` keyword is specified, in which case the new value is appended | |
2382 | to the existing value. | |
42fc5d26 | 2383 | |
aa9eafa4 QY |
2384 | If ``none`` is specified as the community value, the communities attribute |
2385 | is not sent. | |
42fc5d26 | 2386 | |
47f47873 PG |
2387 | It is not possible to set an expanded community list. |
2388 | ||
29adcd50 | 2389 | .. clicmd:: set comm-list WORD delete |
c1a54c05 | 2390 | |
aa9eafa4 QY |
2391 | This command remove communities value from BGP communities attribute. The |
2392 | ``word`` is community list name. When BGP route's communities value matches | |
2393 | to the community list ``word``, the communities value is removed. When all | |
2394 | of communities value is removed eventually, the BGP update's communities | |
2395 | attribute is completely removed. | |
42fc5d26 | 2396 | |
8fcedbd2 | 2397 | .. _bgp-communities-example: |
c1a54c05 | 2398 | |
8fcedbd2 QY |
2399 | Example Configuration |
2400 | ^^^^^^^^^^^^^^^^^^^^^ | |
9eb95b3b | 2401 | |
8fcedbd2 QY |
2402 | The following configuration is exemplary of the most typical usage of BGP |
2403 | communities attribute. In the example, AS 7675 provides an upstream Internet | |
2404 | connection to AS 100. When the following configuration exists in AS 7675, the | |
2405 | network operator of AS 100 can set local preference in AS 7675 network by | |
2406 | setting BGP communities attribute to the updates. | |
9eb95b3b QY |
2407 | |
2408 | .. code-block:: frr | |
c1a54c05 QY |
2409 | |
2410 | router bgp 7675 | |
2411 | neighbor 192.168.0.1 remote-as 100 | |
2412 | address-family ipv4 unicast | |
2413 | neighbor 192.168.0.1 route-map RMAP in | |
2414 | exit-address-family | |
2415 | ! | |
a64e0ee5 | 2416 | bgp community-list 70 permit 7675:70 |
a64e0ee5 | 2417 | bgp community-list 80 permit 7675:80 |
a64e0ee5 | 2418 | bgp community-list 90 permit 7675:90 |
c1a54c05 QY |
2419 | ! |
2420 | route-map RMAP permit 10 | |
2421 | match community 70 | |
2422 | set local-preference 70 | |
2423 | ! | |
2424 | route-map RMAP permit 20 | |
2425 | match community 80 | |
2426 | set local-preference 80 | |
2427 | ! | |
2428 | route-map RMAP permit 30 | |
2429 | match community 90 | |
2430 | set local-preference 90 | |
c3c5a71f | 2431 | |
42fc5d26 | 2432 | |
8fcedbd2 QY |
2433 | The following configuration announces ``10.0.0.0/8`` from AS 100 to AS 7675. |
2434 | The route has communities value ``7675:80`` so when above configuration exists | |
2435 | in AS 7675, the announced routes' local preference value will be set to 80. | |
9eb95b3b QY |
2436 | |
2437 | .. code-block:: frr | |
c1a54c05 QY |
2438 | |
2439 | router bgp 100 | |
2440 | network 10.0.0.0/8 | |
2441 | neighbor 192.168.0.2 remote-as 7675 | |
2442 | address-family ipv4 unicast | |
2443 | neighbor 192.168.0.2 route-map RMAP out | |
2444 | exit-address-family | |
2445 | ! | |
2446 | ip prefix-list PLIST permit 10.0.0.0/8 | |
2447 | ! | |
2448 | route-map RMAP permit 10 | |
2449 | match ip address prefix-list PLIST | |
2450 | set community 7675:80 | |
c3c5a71f | 2451 | |
42fc5d26 | 2452 | |
8fcedbd2 QY |
2453 | The following configuration is an example of BGP route filtering using |
2454 | communities attribute. This configuration only permit BGP routes which has BGP | |
8d80b8e2 DA |
2455 | communities value (``0:80`` and ``0:90``) or ``0:100``. The network operator can |
2456 | set special internal communities value at BGP border router, then limit the | |
2457 | BGP route announcements into the internal network. | |
9eb95b3b QY |
2458 | |
2459 | .. code-block:: frr | |
42fc5d26 | 2460 | |
c1a54c05 QY |
2461 | router bgp 7675 |
2462 | neighbor 192.168.0.1 remote-as 100 | |
2463 | address-family ipv4 unicast | |
2464 | neighbor 192.168.0.1 route-map RMAP in | |
2465 | exit-address-family | |
2466 | ! | |
a64e0ee5 | 2467 | bgp community-list 1 permit 0:80 0:90 |
8d80b8e2 | 2468 | bgp community-list 1 permit 0:100 |
c1a54c05 QY |
2469 | ! |
2470 | route-map RMAP permit in | |
2471 | match community 1 | |
c3c5a71f | 2472 | |
42fc5d26 | 2473 | |
8fcedbd2 QY |
2474 | The following example filters BGP routes which have a community value of |
2475 | ``1:1``. When there is no match community-list returns ``deny``. To avoid | |
2476 | filtering all routes, a ``permit`` line is set at the end of the | |
2477 | community-list. | |
9eb95b3b QY |
2478 | |
2479 | .. code-block:: frr | |
42fc5d26 | 2480 | |
c1a54c05 QY |
2481 | router bgp 7675 |
2482 | neighbor 192.168.0.1 remote-as 100 | |
2483 | address-family ipv4 unicast | |
2484 | neighbor 192.168.0.1 route-map RMAP in | |
2485 | exit-address-family | |
2486 | ! | |
a64e0ee5 DA |
2487 | bgp community-list standard FILTER deny 1:1 |
2488 | bgp community-list standard FILTER permit | |
c1a54c05 QY |
2489 | ! |
2490 | route-map RMAP permit 10 | |
2491 | match community FILTER | |
c3c5a71f | 2492 | |
42fc5d26 | 2493 | |
8fcedbd2 QY |
2494 | The following configuration is an example of communities value deletion. With |
2495 | this configuration the community values ``100:1`` and ``100:2`` are removed | |
2496 | from BGP updates. For communities value deletion, only ``permit`` | |
2497 | community-list is used. ``deny`` community-list is ignored. | |
9eb95b3b QY |
2498 | |
2499 | .. code-block:: frr | |
42fc5d26 | 2500 | |
c1a54c05 QY |
2501 | router bgp 7675 |
2502 | neighbor 192.168.0.1 remote-as 100 | |
2503 | address-family ipv4 unicast | |
2504 | neighbor 192.168.0.1 route-map RMAP in | |
2505 | exit-address-family | |
2506 | ! | |
a64e0ee5 | 2507 | bgp community-list standard DEL permit 100:1 100:2 |
c1a54c05 QY |
2508 | ! |
2509 | route-map RMAP permit 10 | |
2510 | set comm-list DEL delete | |
c3c5a71f | 2511 | |
42fc5d26 | 2512 | |
0efdf0fe | 2513 | .. _bgp-extended-communities-attribute: |
42fc5d26 | 2514 | |
8fcedbd2 QY |
2515 | Extended Communities Attribute |
2516 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 | 2517 | |
c1a54c05 QY |
2518 | BGP extended communities attribute is introduced with MPLS VPN/BGP technology. |
2519 | MPLS VPN/BGP expands capability of network infrastructure to provide VPN | |
2520 | functionality. At the same time it requires a new framework for policy routing. | |
2521 | With BGP Extended Communities Attribute we can use Route Target or Site of | |
2522 | Origin for implementing network policy for MPLS VPN/BGP. | |
42fc5d26 | 2523 | |
c1a54c05 QY |
2524 | BGP Extended Communities Attribute is similar to BGP Communities Attribute. It |
2525 | is an optional transitive attribute. BGP Extended Communities Attribute can | |
2526 | carry multiple Extended Community value. Each Extended Community value is | |
2527 | eight octet length. | |
42fc5d26 | 2528 | |
c1a54c05 QY |
2529 | BGP Extended Communities Attribute provides an extended range compared with BGP |
2530 | Communities Attribute. Adding to that there is a type field in each value to | |
2531 | provides community space structure. | |
42fc5d26 | 2532 | |
c1a54c05 QY |
2533 | There are two format to define Extended Community value. One is AS based format |
2534 | the other is IP address based format. | |
42fc5d26 | 2535 | |
8fcedbd2 QY |
2536 | ``AS:VAL`` |
2537 | This is a format to define AS based Extended Community value. ``AS`` part | |
2538 | is 2 octets Global Administrator subfield in Extended Community value. | |
2539 | ``VAL`` part is 4 octets Local Administrator subfield. ``7675:100`` | |
2540 | represents AS 7675 policy value 100. | |
42fc5d26 | 2541 | |
8fcedbd2 | 2542 | ``IP-Address:VAL`` |
c1a54c05 | 2543 | This is a format to define IP address based Extended Community value. |
8fcedbd2 QY |
2544 | ``IP-Address`` part is 4 octets Global Administrator subfield. ``VAL`` part |
2545 | is 2 octets Local Administrator subfield. | |
42fc5d26 | 2546 | |
0efdf0fe | 2547 | .. _bgp-extended-community-lists: |
42fc5d26 | 2548 | |
8fcedbd2 QY |
2549 | Extended Community Lists |
2550 | ^^^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 | 2551 | |
a64e0ee5 | 2552 | .. clicmd:: bgp extcommunity-list standard NAME permit|deny EXTCOMMUNITY |
42fc5d26 | 2553 | |
4da7fda3 QY |
2554 | This command defines a new standard extcommunity-list. `extcommunity` is |
2555 | extended communities value. The `extcommunity` is compiled into extended | |
2556 | community structure. We can define multiple extcommunity-list under same | |
2557 | name. In that case match will happen user defined order. Once the | |
2558 | extcommunity-list matches to extended communities attribute in BGP updates | |
2559 | it return permit or deny based upon the extcommunity-list definition. When | |
2560 | there is no matched entry, deny will be returned. When `extcommunity` is | |
2561 | empty it matches to any routes. | |
42fc5d26 | 2562 | |
a64e0ee5 | 2563 | .. clicmd:: bgp extcommunity-list expanded NAME permit|deny LINE |
42fc5d26 | 2564 | |
4da7fda3 QY |
2565 | This command defines a new expanded extcommunity-list. `line` is a string |
2566 | expression of extended communities attribute. `line` can be a regular | |
2567 | expression (:ref:`bgp-regular-expressions`) to match an extended communities | |
2568 | attribute in BGP updates. | |
42fc5d26 | 2569 | |
03750f1e QY |
2570 | Note that all extended community lists shares a single name space, so it's |
2571 | not necessary to specify their type when creating or destroying them. | |
42fc5d26 | 2572 | |
03750f1e | 2573 | .. clicmd:: show bgp extcommunity-list [NAME detail] |
c1a54c05 | 2574 | |
4da7fda3 | 2575 | This command displays current extcommunity-list information. When `name` is |
03750f1e | 2576 | specified the community list's information is shown. |
c3c5a71f | 2577 | |
42fc5d26 | 2578 | |
0efdf0fe | 2579 | .. _bgp-extended-communities-in-route-map: |
42fc5d26 QY |
2580 | |
2581 | BGP Extended Communities in Route Map | |
8fcedbd2 | 2582 | """"""""""""""""""""""""""""""""""""" |
42fc5d26 | 2583 | |
29adcd50 | 2584 | .. clicmd:: match extcommunity WORD |
42fc5d26 | 2585 | |
48753f73 DA |
2586 | .. clicmd:: set extcommunity none |
2587 | ||
2588 | This command resets the extended community value in BGP updates. If the attribute is | |
2589 | already configured or received from the peer, the attribute is discarded and set to | |
2590 | none. This is useful if you need to strip incoming extended communities. | |
2591 | ||
29adcd50 | 2592 | .. clicmd:: set extcommunity rt EXTCOMMUNITY |
42fc5d26 | 2593 | |
8ef15909 DA |
2594 | This command sets Route Target value. |
2595 | ||
2596 | .. clicmd:: set extcommunity nt EXTCOMMUNITY | |
2597 | ||
2598 | This command sets Node Target value. | |
2599 | ||
2600 | If the receiving BGP router supports Node Target Extended Communities, | |
2601 | it will install the route with the community that contains it's own | |
2602 | local BGP Identifier. Otherwise, it's not installed. | |
42fc5d26 | 2603 | |
29adcd50 | 2604 | .. clicmd:: set extcommunity soo EXTCOMMUNITY |
c1a54c05 | 2605 | |
8ef15909 | 2606 | This command sets Site of Origin value. |
42fc5d26 | 2607 | |
ed647ed2 | 2608 | .. clicmd:: set extcommunity bandwidth <(1-25600) | cumulative | num-multipaths> [non-transitive] |
2609 | ||
2610 | This command sets the BGP link-bandwidth extended community for the prefix | |
2611 | (best path) for which it is applied. The link-bandwidth can be specified as | |
2612 | an ``explicit value`` (specified in Mbps), or the router can be told to use | |
2613 | the ``cumulative bandwidth`` of all multipaths for the prefix or to compute | |
2614 | it based on the ``number of multipaths``. The link bandwidth extended | |
2615 | community is encoded as ``transitive`` unless the set command explicitly | |
2616 | configures it as ``non-transitive``. | |
2617 | ||
2618 | .. seealso:: :ref:`wecmp_linkbw` | |
47f47873 PG |
2619 | |
2620 | Note that the extended expanded community is only used for `match` rule, not for | |
2621 | `set` actions. | |
2622 | ||
0efdf0fe | 2623 | .. _bgp-large-communities-attribute: |
42fc5d26 | 2624 | |
8fcedbd2 QY |
2625 | Large Communities Attribute |
2626 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 QY |
2627 | |
2628 | The BGP Large Communities attribute was introduced in Feb 2017 with | |
c1a54c05 | 2629 | :rfc:`8092`. |
42fc5d26 | 2630 | |
8fcedbd2 QY |
2631 | The BGP Large Communities Attribute is similar to the BGP Communities Attribute |
2632 | except that it has 3 components instead of two and each of which are 4 octets | |
2633 | in length. Large Communities bring additional functionality and convenience | |
2634 | over traditional communities, specifically the fact that the ``GLOBAL`` part | |
2635 | below is now 4 octets wide allowing seamless use in networks using 4-byte ASNs. | |
2636 | ||
2637 | ``GLOBAL:LOCAL1:LOCAL2`` | |
2638 | This is the format to define Large Community values. Referencing :rfc:`8195` | |
2639 | the values are commonly referred to as follows: | |
2640 | ||
2641 | - The ``GLOBAL`` part is a 4 octet Global Administrator field, commonly used | |
2642 | as the operators AS number. | |
2643 | - The ``LOCAL1`` part is a 4 octet Local Data Part 1 subfield referred to as | |
2644 | a function. | |
2645 | - The ``LOCAL2`` part is a 4 octet Local Data Part 2 field and referred to | |
2646 | as the parameter subfield. | |
2647 | ||
2648 | As an example, ``65551:1:10`` represents AS 65551 function 1 and parameter | |
2649 | 10. The referenced RFC above gives some guidelines on recommended usage. | |
42fc5d26 | 2650 | |
0efdf0fe | 2651 | .. _bgp-large-community-lists: |
42fc5d26 | 2652 | |
8fcedbd2 QY |
2653 | Large Community Lists |
2654 | """"""""""""""""""""" | |
42fc5d26 QY |
2655 | |
2656 | Two types of large community lists are supported, namely `standard` and | |
2657 | `expanded`. | |
2658 | ||
a64e0ee5 | 2659 | .. clicmd:: bgp large-community-list standard NAME permit|deny LARGE-COMMUNITY |
42fc5d26 | 2660 | |
4da7fda3 QY |
2661 | This command defines a new standard large-community-list. `large-community` |
2662 | is the Large Community value. We can add multiple large communities under | |
2663 | same name. In that case the match will happen in the user defined order. | |
2664 | Once the large-community-list matches the Large Communities attribute in BGP | |
2665 | updates it will return permit or deny based upon the large-community-list | |
2666 | definition. When there is no matched entry, a deny will be returned. When | |
2667 | `large-community` is empty it matches any routes. | |
42fc5d26 | 2668 | |
a64e0ee5 | 2669 | .. clicmd:: bgp large-community-list expanded NAME permit|deny LINE |
42fc5d26 | 2670 | |
4da7fda3 QY |
2671 | This command defines a new expanded large-community-list. Where `line` is a |
2672 | string matching expression, it will be compared to the entire Large | |
2673 | Communities attribute as a string, with each large-community in order from | |
2674 | lowest to highest. `line` can also be a regular expression which matches | |
2675 | this Large Community attribute. | |
42fc5d26 | 2676 | |
03750f1e QY |
2677 | Note that all community lists share the same namespace, so it's not |
2678 | necessary to specify ``standard`` or ``expanded``; these modifiers are | |
2679 | purely aesthetic. | |
42fc5d26 | 2680 | |
a64e0ee5 | 2681 | .. clicmd:: show bgp large-community-list |
42fc5d26 | 2682 | |
36dc43aa | 2683 | .. clicmd:: show bgp large-community-list NAME detail |
42fc5d26 | 2684 | |
c1a54c05 QY |
2685 | This command display current large-community-list information. When |
2686 | `name` is specified the community list information is shown. | |
42fc5d26 | 2687 | |
29adcd50 | 2688 | .. clicmd:: show ip bgp large-community-info |
c1a54c05 QY |
2689 | |
2690 | This command displays the current large communities in use. | |
42fc5d26 | 2691 | |
0efdf0fe | 2692 | .. _bgp-large-communities-in-route-map: |
42fc5d26 | 2693 | |
8fcedbd2 QY |
2694 | Large Communities in Route Map |
2695 | """""""""""""""""""""""""""""" | |
42fc5d26 | 2696 | |
03ff9a14 | 2697 | .. clicmd:: match large-community LINE [exact-match] |
42fc5d26 | 2698 | |
4da7fda3 QY |
2699 | Where `line` can be a simple string to match, or a regular expression. It |
2700 | is very important to note that this match occurs on the entire | |
c1a54c05 | 2701 | large-community string as a whole, where each large-community is ordered |
03ff9a14 | 2702 | from lowest to highest. When `exact-match` keyword is specified, match |
2703 | happen only when BGP updates have completely same large communities value | |
2704 | specified in the large community list. | |
42fc5d26 | 2705 | |
29adcd50 | 2706 | .. clicmd:: set large-community LARGE-COMMUNITY |
42fc5d26 | 2707 | |
29adcd50 | 2708 | .. clicmd:: set large-community LARGE-COMMUNITY LARGE-COMMUNITY |
42fc5d26 | 2709 | |
29adcd50 | 2710 | .. clicmd:: set large-community LARGE-COMMUNITY additive |
c1a54c05 QY |
2711 | |
2712 | These commands are used for setting large-community values. The first | |
2713 | command will overwrite any large-communities currently present. | |
2714 | The second specifies two large-communities, which overwrites the current | |
2715 | large-community list. The third will add a large-community value without | |
2716 | overwriting other values. Multiple large-community values can be specified. | |
42fc5d26 | 2717 | |
47f47873 PG |
2718 | Note that the large expanded community is only used for `match` rule, not for |
2719 | `set` actions. | |
b572f826 | 2720 | |
d864dd9e EB |
2721 | .. _bgp-roles-and-only-to-customers: |
2722 | ||
2723 | BGP Roles and Only to Customers | |
2724 | ------------------------------- | |
2725 | ||
2726 | BGP roles are defined in :rfc:`9234` and provide an easy way to route leaks | |
2727 | prevention, detection and mitigation. | |
2728 | ||
2729 | To enable its mechanics, you must set your local role to reflect your type of | |
2730 | peering relationship with your neighbor. Possible values of ``LOCAL-ROLE`` are: | |
8f2d6021 EB |
2731 | |
2732 | - provider | |
2733 | - rs-server | |
2734 | - rs-client | |
2735 | - customer | |
2736 | - peer | |
d864dd9e EB |
2737 | |
2738 | The local Role value is negotiated with the new BGP Role capability with a | |
2739 | built-in check of the corresponding value. In case of mismatch the new OPEN | |
2740 | Roles Mismatch Notification <2, 11> would be sent. | |
2741 | ||
2742 | The correct Role pairs are: | |
2743 | ||
2744 | * Provider - Customer | |
2745 | * Peer - Peer | |
2746 | * RS-Server - RS-Client | |
2747 | ||
2748 | .. code-block:: shell | |
2749 | ||
2750 | ~# vtysh -c 'show bgp neighbor' | grep 'Role' | |
2751 | Local Role: customer | |
2752 | Neighbor Role: provider | |
2753 | Role: advertised and received | |
2754 | ||
2755 | If strict-mode is set BGP session won't become established until BGP neighbor | |
8f2d6021 | 2756 | set local Role on its side. This configuration parameter is defined in |
d864dd9e | 2757 | :rfc:`9234` and used to enforce corresponding configuration at your |
8f2d6021 | 2758 | counter-part side. Default value - disabled. |
d864dd9e EB |
2759 | |
2760 | Routes that sent from provider, rs-server, or peer local-role (or if received | |
2761 | by customer, rs-clinet, or peer local-role) will be marked with a new | |
2762 | Only to Customer (OTC) attribute. | |
2763 | ||
2764 | Routes with this attribute can only be sent to your neighbor if your | |
2765 | local-role is provider or rs-server. Routes with this attribute can be | |
2766 | received only if your local-role is customer or rs-client. | |
2767 | ||
8f2d6021 | 2768 | In case of peer-peer relationship routes can be received only if |
d864dd9e EB |
2769 | OTC value is equal to your neighbor AS number. |
2770 | ||
2771 | All these rules with OTC help to detect and mitigate route leaks and | |
2772 | happened automatically if local-role is set. | |
2773 | ||
2774 | .. clicmd:: neighbor PEER local-role LOCAL-ROLE [strict-mode] | |
2775 | ||
2776 | This command set your local-role to ``LOCAL-ROLE``: | |
2777 | <provider|rs-server|rs-client|customer|peer>. | |
2778 | ||
8f2d6021 | 2779 | This role helps to detect and prevent route leaks. |
d864dd9e EB |
2780 | |
2781 | If ``strict-mode`` is set, your neighbor must send you Capability with the | |
2782 | value of his role (by setting local-role on his side). Otherwise, a Role | |
2783 | Mismatch Notification will be sent. | |
2784 | ||
7ee70320 PG |
2785 | Labeled unicast |
2786 | --------------- | |
2787 | ||
2788 | *bgpd* supports labeled information, as per :rfc:`3107`. | |
2789 | ||
cf1c7e30 | 2790 | .. clicmd:: bgp labeled-unicast <explicit-null|ipv4-explicit-null|ipv6-explicit-null> |
7ee70320 PG |
2791 | |
2792 | By default, locally advertised prefixes use the `implicit-null` label to | |
2793 | encode in the outgoing NLRI. The following command uses the `explicit-null` | |
2794 | label value for all the BGP instances. | |
2795 | ||
c8a5e5e1 | 2796 | .. _bgp-l3vpn-vrfs: |
b572f826 | 2797 | |
c8a5e5e1 QY |
2798 | L3VPN VRFs |
2799 | ---------- | |
b572f826 | 2800 | |
c8a5e5e1 QY |
2801 | *bgpd* supports :abbr:`L3VPN (Layer 3 Virtual Private Networks)` :abbr:`VRFs |
2802 | (Virtual Routing and Forwarding)` for IPv4 :rfc:`4364` and IPv6 :rfc:`4659`. | |
2803 | L3VPN routes, and their associated VRF MPLS labels, can be distributed to VPN | |
2804 | SAFI neighbors in the *default*, i.e., non VRF, BGP instance. VRF MPLS labels | |
2805 | are reached using *core* MPLS labels which are distributed using LDP or BGP | |
2806 | labeled unicast. *bgpd* also supports inter-VRF route leaking. | |
b572f826 | 2807 | |
b572f826 | 2808 | |
1bb550b6 PG |
2809 | L3VPN over GRE interfaces |
2810 | ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
2811 | ||
2812 | In MPLS-VPN or SRv6-VPN, an L3VPN next-hop entry requires that the path | |
2813 | chosen respectively contains a labelled path or a valid SID IPv6 address. | |
2814 | Otherwise the L3VPN entry will not be installed. It is possible to ignore | |
2815 | that check when the path chosen by the next-hop uses a GRE interface, and | |
2816 | there is a route-map configured at inbound side of ipv4-vpn or ipv6-vpn | |
2817 | address family with following syntax: | |
2818 | ||
2819 | .. clicmd:: set l3vpn next-hop encapsulation gre | |
2820 | ||
2821 | The incoming BGP L3VPN entry is accepted, provided that the next hop of the | |
2822 | L3VPN entry uses a path that takes the GRE tunnel as outgoing interface. The | |
2823 | remote endpoint should be configured just behind the GRE tunnel; remote | |
2824 | device configuration may vary depending whether it acts at edge endpoint or | |
2825 | not: in any case, the expectation is that incoming MPLS traffic received at | |
2826 | this endpoint should be considered as a valid path for L3VPN. | |
2827 | ||
c8a5e5e1 | 2828 | .. _bgp-vrf-route-leaking: |
8fcedbd2 QY |
2829 | |
2830 | VRF Route Leaking | |
c8a5e5e1 | 2831 | ----------------- |
8fcedbd2 QY |
2832 | |
2833 | BGP routes may be leaked (i.e. copied) between a unicast VRF RIB and the VPN | |
f90115c5 LB |
2834 | SAFI RIB of the default VRF for use in MPLS-based L3VPNs. Unicast routes may |
2835 | also be leaked between any VRFs (including the unicast RIB of the default BGP | |
2836 | instanced). A shortcut syntax is also available for specifying leaking from one | |
f563acec | 2837 | VRF to another VRF using the default instance's VPN RIB as the intermediary. A |
f90115c5 | 2838 | common application of the VRF-VRF feature is to connect a customer's private |
8fcedbd2 QY |
2839 | routing domain to a provider's VPN service. Leaking is configured from the |
2840 | point of view of an individual VRF: ``import`` refers to routes leaked from VPN | |
2841 | to a unicast VRF, whereas ``export`` refers to routes leaked from a unicast VRF | |
2842 | to VPN. | |
2843 | ||
2844 | Required parameters | |
c8a5e5e1 | 2845 | ^^^^^^^^^^^^^^^^^^^ |
b572f826 | 2846 | |
4da7fda3 QY |
2847 | Routes exported from a unicast VRF to the VPN RIB must be augmented by two |
2848 | parameters: | |
2849 | ||
2850 | - an :abbr:`RD (Route Distinguisher)` | |
2851 | - an :abbr:`RTLIST (Route-target List)` | |
2852 | ||
2853 | Configuration for these exported routes must, at a minimum, specify these two | |
2854 | parameters. | |
2855 | ||
2856 | Routes imported from the VPN RIB to a unicast VRF are selected according to | |
2857 | their RTLISTs. Routes whose RTLIST contains at least one route-target in | |
2858 | common with the configured import RTLIST are leaked. Configuration for these | |
2859 | imported routes must specify an RTLIST to be matched. | |
2860 | ||
2861 | The RD, which carries no semantic value, is intended to make the route unique | |
2862 | in the VPN RIB among all routes of its prefix that originate from all the | |
2863 | customers and sites that are attached to the provider's VPN service. | |
2864 | Accordingly, each site of each customer is typically assigned an RD that is | |
2865 | unique across the entire provider network. | |
2866 | ||
2867 | The RTLIST is a set of route-target extended community values whose purpose is | |
2868 | to specify route-leaking policy. Typically, a customer is assigned a single | |
2869 | route-target value for import and export to be used at all customer sites. This | |
2870 | configuration specifies a simple topology wherein a customer has a single | |
2871 | routing domain which is shared across all its sites. More complex routing | |
2872 | topologies are possible through use of additional route-targets to augment the | |
2873 | leaking of sets of routes in various ways. | |
b572f826 | 2874 | |
e967a1d0 DS |
2875 | When using the shortcut syntax for vrf-to-vrf leaking, the RD and RT are |
2876 | auto-derived. | |
fb3d9f3e | 2877 | |
8fcedbd2 | 2878 | General configuration |
c8a5e5e1 | 2879 | ^^^^^^^^^^^^^^^^^^^^^ |
b572f826 | 2880 | |
f90115c5 | 2881 | Configuration of route leaking between a unicast VRF RIB and the VPN SAFI RIB |
4da7fda3 QY |
2882 | of the default VRF is accomplished via commands in the context of a VRF |
2883 | address-family: | |
b572f826 | 2884 | |
b572f826 PZ |
2885 | .. clicmd:: rd vpn export AS:NN|IP:nn |
2886 | ||
4da7fda3 QY |
2887 | Specifies the route distinguisher to be added to a route exported from the |
2888 | current unicast VRF to VPN. | |
b572f826 | 2889 | |
b572f826 PZ |
2890 | .. clicmd:: rt vpn import|export|both RTLIST... |
2891 | ||
4da7fda3 QY |
2892 | Specifies the route-target list to be attached to a route (export) or the |
2893 | route-target list to match against (import) when exporting/importing between | |
2894 | the current unicast VRF and VPN. | |
b572f826 | 2895 | |
4da7fda3 QY |
2896 | The RTLIST is a space-separated list of route-targets, which are BGP |
2897 | extended community values as described in | |
b572f826 PZ |
2898 | :ref:`bgp-extended-communities-attribute`. |
2899 | ||
3daa4dd5 PG |
2900 | .. clicmd:: label vpn export allocation-mode per-vrf|per-nexthop |
2901 | ||
2902 | Select how labels are allocated in the given VRF. By default, the `per-vrf` | |
2903 | mode is selected, and one label is used for all prefixes from the VRF. The | |
2904 | `per-nexthop` will use a unique label for all prefixes that are reachable | |
2905 | via the same nexthop. | |
2906 | ||
e70e9f8e | 2907 | .. clicmd:: label vpn export (0..1048575)|auto |
b572f826 | 2908 | |
8a2124f7 | 2909 | Enables an MPLS label to be attached to a route exported from the current |
2910 | unicast VRF to VPN. If the value specified is ``auto``, the label value is | |
2911 | automatically assigned from a pool maintained by the Zebra daemon. If Zebra | |
2912 | is not running, or if this command is not configured, automatic label | |
2913 | assignment will not complete, which will block corresponding route export. | |
b572f826 | 2914 | |
b572f826 PZ |
2915 | .. clicmd:: nexthop vpn export A.B.C.D|X:X::X:X |
2916 | ||
4da7fda3 QY |
2917 | Specifies an optional nexthop value to be assigned to a route exported from |
2918 | the current unicast VRF to VPN. If left unspecified, the nexthop will be set | |
2919 | to 0.0.0.0 or 0:0::0:0 (self). | |
b572f826 | 2920 | |
b572f826 PZ |
2921 | .. clicmd:: route-map vpn import|export MAP |
2922 | ||
4da7fda3 | 2923 | Specifies an optional route-map to be applied to routes imported or exported |
d1e7591e | 2924 | between the current unicast VRF and VPN. |
b572f826 | 2925 | |
b572f826 PZ |
2926 | .. clicmd:: import|export vpn |
2927 | ||
d1e7591e | 2928 | Enables import or export of routes between the current unicast VRF and VPN. |
b572f826 | 2929 | |
fb3d9f3e DS |
2930 | .. clicmd:: import vrf VRFNAME |
2931 | ||
e967a1d0 DS |
2932 | Shortcut syntax for specifying automatic leaking from vrf VRFNAME to |
2933 | the current VRF using the VPN RIB as intermediary. The RD and RT | |
2934 | are auto derived and should not be specified explicitly for either the | |
2935 | source or destination VRF's. | |
2936 | ||
2937 | This shortcut syntax mode is not compatible with the explicit | |
2938 | `import vpn` and `export vpn` statements for the two VRF's involved. | |
2939 | The CLI will disallow attempts to configure incompatible leaking | |
2940 | modes. | |
fb3d9f3e | 2941 | |
a486300b PG |
2942 | .. clicmd:: bgp retain route-target all |
2943 | ||
2944 | It is possible to retain or not VPN prefixes that are not imported by local | |
2945 | VRF configuration. This can be done via the following command in the context | |
2946 | of the global VPNv4/VPNv6 family. This command defaults to on and is not | |
2947 | displayed. | |
2948 | The `no bgp retain route-target all` form of the command is displayed. | |
2949 | ||
01da2d26 DA |
2950 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> soo EXTCOMMUNITY |
2951 | ||
2952 | Without this command, SoO extended community attribute is configured using | |
2953 | an inbound route map that sets the SoO value during the update process. | |
2954 | With the introduction of the new BGP per-neighbor Site-of-Origin (SoO) feature, | |
2955 | two new commands configured in sub-modes under router configuration mode | |
2956 | simplify the SoO value configuration. | |
2957 | ||
2958 | If we configure SoO per neighbor at PEs, the SoO community is automatically | |
2959 | added for all routes from the CPEs. Routes are validated and prevented from | |
2960 | being sent back to the same CPE (e.g.: multi-site). This is especially needed | |
2961 | when using ``as-override`` or ``allowas-in`` to prevent routing loops. | |
2962 | ||
4cd690ae PG |
2963 | .. clicmd:: mpls bgp forwarding |
2964 | ||
2965 | It is possible to permit BGP install VPN prefixes without transport labels, | |
2966 | by issuing the following command under the interface configuration context. | |
2967 | This configuration will install VPN prefixes originated from an e-bgp session, | |
2968 | and with the next-hop directly connected. | |
2969 | ||
4ccd4033 HS |
2970 | .. _bgp-l3vpn-srv6: |
2971 | ||
2972 | L3VPN SRv6 | |
2973 | ---------- | |
2974 | ||
2975 | .. clicmd:: segment-routing srv6 | |
2976 | ||
2977 | Use SRv6 backend with BGP L3VPN, and go to its configuration node. | |
2978 | ||
2979 | .. clicmd:: locator NAME | |
2980 | ||
2981 | Specify the SRv6 locator to be used for SRv6 L3VPN. The Locator name must | |
2982 | be set in zebra, but user can set it in any order. | |
42fc5d26 | 2983 | |
2d8c098a CS |
2984 | General configuration |
2985 | ^^^^^^^^^^^^^^^^^^^^^ | |
2986 | ||
2987 | Configuration of the SRv6 SID used to advertise a L3VPN for both IPv4 and IPv6 | |
2988 | is accomplished via the following command in the context of a VRF: | |
2989 | ||
8265cbc7 | 2990 | .. clicmd:: sid vpn per-vrf export (1..1048575)|auto |
2d8c098a CS |
2991 | |
2992 | Enables a SRv6 SID to be attached to a route exported from the current | |
2993 | unicast VRF to VPN. A single SID is used for both IPv4 and IPv6 address | |
2994 | families. If you want to set a SID for only IPv4 address family or IPv6 | |
8265cbc7 | 2995 | address family, you need to use the command ``sid vpn export (1..1048575)|auto`` |
2d8c098a CS |
2996 | in the context of an address-family. If the value specified is ``auto``, |
2997 | the SID value is automatically assigned from a pool maintained by the Zebra | |
2998 | daemon. If Zebra is not running, or if this command is not configured, automatic | |
2999 | SID assignment will not complete, which will block corresponding route export. | |
3000 | ||
b6c34e85 CS |
3001 | .. _bgp-evpn: |
3002 | ||
3003 | Ethernet Virtual Network - EVPN | |
3004 | ------------------------------- | |
3005 | ||
0a4e0034 JAG |
3006 | Note: When using EVPN features and if you have a large number of hosts, make |
3007 | sure to adjust the size of the arp neighbor cache to avoid neighbor table | |
3008 | overflow and/or excessive garbage collection. On Linux, the size of the table | |
3009 | and garbage collection frequency can be controlled via the following | |
3010 | sysctl configurations: | |
3011 | ||
3012 | .. code-block:: shell | |
3013 | ||
3014 | net.ipv4.neigh.default.gc_thresh1 | |
3015 | net.ipv4.neigh.default.gc_thresh2 | |
3016 | net.ipv4.neigh.default.gc_thresh3 | |
3017 | ||
3018 | net.ipv6.neigh.default.gc_thresh1 | |
3019 | net.ipv6.neigh.default.gc_thresh2 | |
3020 | net.ipv6.neigh.default.gc_thresh3 | |
3021 | ||
3022 | For more information, see ``man 7 arp``. | |
3023 | ||
433d9566 TA |
3024 | .. _bgp-enabling-evpn: |
3025 | ||
3026 | Enabling EVPN | |
3027 | ^^^^^^^^^^^^^ | |
3028 | ||
3029 | EVPN should be enabled on the BGP instance corresponding to the VRF acting as | |
3030 | the underlay for the VXLAN tunneling. In most circumstances this will be the | |
3031 | default VRF. The command to enable EVPN for a BGP instance is | |
3032 | ``advertise-all-vni`` which lives under ``address-family l2vpn evpn``: | |
3033 | ||
3034 | .. code-block:: frr | |
3035 | ||
3036 | router bgp 65001 | |
3037 | ! | |
3038 | address-family l2vpn evpn | |
3039 | advertise-all-vni | |
3040 | ||
3041 | A more comprehensive configuration example can be found in the :ref:`evpn` page. | |
3042 | ||
0f33e6df SW |
3043 | .. _bgp-evpn-l3-route-targets: |
3044 | ||
3045 | EVPN L3 Route-Targets | |
3046 | ^^^^^^^^^^^^^^^^^^^^^ | |
3047 | ||
3048 | .. clicmd:: route-target <import|export|both> <RTLIST|auto> | |
3049 | ||
133c000c | 3050 | Modify the route-target set for EVPN advertised type-2/type-5 routes. |
0f33e6df SW |
3051 | RTLIST is a list of any of matching |
3052 | ``(A.B.C.D:MN|EF:OPQR|GHJK:MN|*:OPQR|*:MN)`` where ``*`` indicates wildcard | |
3053 | matching for the AS number. It will be set to match any AS number. This is | |
3054 | useful in datacenter deployments with Downstream VNI. ``auto`` is used to | |
3055 | retain the autoconfigure that is default behavior for L3 RTs. | |
3056 | ||
b6c34e85 CS |
3057 | .. _bgp-evpn-advertise-pip: |
3058 | ||
3059 | EVPN advertise-PIP | |
3060 | ^^^^^^^^^^^^^^^^^^ | |
3061 | ||
3062 | In a EVPN symmetric routing MLAG deployment, all EVPN routes advertised | |
3063 | with anycast-IP as next-hop IP and anycast MAC as the Router MAC (RMAC - in | |
3064 | BGP EVPN Extended-Community). | |
3065 | EVPN picks up the next-hop IP from the VxLAN interface's local tunnel IP and | |
3066 | the RMAC is obtained from the MAC of the L3VNI's SVI interface. | |
3067 | Note: Next-hop IP is used for EVPN routes whether symmetric routing is | |
3068 | deployed or not but the RMAC is only relevant for symmetric routing scenario. | |
3069 | ||
3070 | Current behavior is not ideal for Prefix (type-5) and self (type-2) | |
3071 | routes. This is because the traffic from remote VTEPs routed sub optimally | |
3072 | if they land on the system where the route does not belong. | |
3073 | ||
3074 | The advertise-pip feature advertises Prefix (type-5) and self (type-2) | |
3075 | routes with system's individual (primary) IP as the next-hop and individual | |
3076 | (system) MAC as Router-MAC (RMAC), while leaving the behavior unchanged for | |
3077 | other EVPN routes. | |
3078 | ||
3079 | To support this feature there needs to have ability to co-exist a | |
3080 | (system-MAC, system-IP) pair with a (anycast-MAC, anycast-IP) pair with the | |
3081 | ability to terminate VxLAN-encapsulated packets received for either pair on | |
0a4e0034 | 3082 | the same L3VNI (i.e associated VLAN). This capability is needed per tenant |
b6c34e85 CS |
3083 | VRF instance. |
3084 | ||
0a4e0034 | 3085 | To derive the system-MAC and the anycast MAC, there must be a |
b6c34e85 CS |
3086 | separate/additional MAC-VLAN interface corresponding to L3VNI’s SVI. |
3087 | The SVI interface’s MAC address can be interpreted as system-MAC | |
3088 | and MAC-VLAN interface's MAC as anycast MAC. | |
3089 | ||
3090 | To derive system-IP and anycast-IP, the default BGP instance's router-id is used | |
3091 | as system-IP and the VxLAN interface’s local tunnel IP as the anycast-IP. | |
3092 | ||
3093 | User has an option to configure the system-IP and/or system-MAC value if the | |
3094 | auto derived value is not preferred. | |
3095 | ||
3096 | Note: By default, advertise-pip feature is enabled and user has an option to | |
0a4e0034 | 3097 | disable the feature via configuration CLI. Once the feature is disabled under |
b6c34e85 CS |
3098 | bgp vrf instance or MAC-VLAN interface is not configured, all the routes follow |
3099 | the same behavior of using same next-hop and RMAC values. | |
3100 | ||
03750f1e | 3101 | .. clicmd:: advertise-pip [ip <addr> [mac <addr>]] |
b6c34e85 | 3102 | |
f563acec | 3103 | Enables or disables advertise-pip feature, specify system-IP and/or system-MAC |
b6c34e85 CS |
3104 | parameters. |
3105 | ||
a927f5bc JAG |
3106 | EVPN advertise-svi-ip |
3107 | ^^^^^^^^^^^^^^^^^^^^^ | |
0a4e0034 | 3108 | Typically, the SVI IP address is reused on VTEPs across multiple racks. However, |
a927f5bc | 3109 | if you have unique SVI IP addresses that you want to be reachable you can use the |
0a4e0034 JAG |
3110 | advertise-svi-ip option. This option advertises the SVI IP/MAC address as a type-2 |
3111 | route and eliminates the need for any flooding over VXLAN to reach the IP from a | |
3112 | remote VTEP. | |
3113 | ||
a927f5bc | 3114 | .. clicmd:: advertise-svi-ip |
0a4e0034 JAG |
3115 | |
3116 | Note that you should not enable both the advertise-svi-ip and the advertise-default-gw | |
3117 | at the same time. | |
3118 | ||
40f4507d AD |
3119 | .. _bgp-evpn-overlay-index-gateway-ip: |
3120 | ||
3121 | EVPN Overlay Index Gateway IP | |
3122 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
d272105a MC |
3123 | RFC https://datatracker.ietf.org/doc/html/rfc9136 explains the use of overlay |
3124 | indexes for recursive route resolution for EVPN type-5 route. | |
40f4507d AD |
3125 | |
3126 | We support gateway IP overlay index. | |
3127 | A gateway IP, advertised with EVPN prefix route, is used to find an EVPN MAC/IP | |
3128 | route with its IP field same as the gateway IP. This MAC/IP entry provides the | |
3129 | nexthop VTEP and the tunnel information required for the VxLAN encapsulation. | |
3130 | ||
3131 | Functionality: | |
3132 | ||
3133 | :: | |
3134 | ||
3135 | . +--------+ BGP +--------+ BGP +--------+ +--------+ | |
3136 | SN1 | | IPv4 | | EVPN | | | | | |
3137 | ======+ Host1 +------+ PE1 +------+ PE2 +------+ Host2 + | |
3138 | | | | | | | | | | |
3139 | +--------+ +--------+ +--------+ +--------+ | |
3140 | ||
3141 | Consider above topology where prefix SN1 is connected behind host1. Host1 | |
3142 | advertises SN1 to PE1 over BGP IPv4 session. PE1 advertises SN1 to PE2 using | |
3143 | EVPN type-5 route with host1 IP as the gateway IP. PE1 also advertises | |
3144 | Host1 MAC/IP as type-2 route which is used to resolve host1 gateway IP. | |
3145 | ||
3146 | PE2 receives this type-5 route and imports it into the vrf based on route | |
3147 | targets. BGP prefix imported into the vrf uses gateway IP as its BGP nexthop. | |
3148 | This route is installed into zebra if following conditions are satisfied: | |
7aa6fb2d | 3149 | |
40f4507d AD |
3150 | 1. Gateway IP nexthop is L3 reachable. |
3151 | 2. PE2 has received EVPN type-2 route with IP field set to gateway IP. | |
3152 | ||
3153 | Topology requirements: | |
7aa6fb2d | 3154 | |
40f4507d AD |
3155 | 1. This feature is supported for asymmetric routing model only. While |
3156 | sending packets to SN1, ingress PE (PE2) performs routing and | |
3157 | egress PE (PE1) performs only bridging. | |
f563acec | 3158 | 2. This feature supports only traditional(non vlan-aware) bridge model. Bridge |
40f4507d AD |
3159 | interface associated with L2VNI is an L3 interface. i.e., this interface is |
3160 | configured with an address in the L2VNI subnet. Note that the gateway IP | |
3161 | should also have an address in the same subnet. | |
3162 | 3. As this feature works in asymmetric routing model, all L2VNIs and corresponding | |
3163 | VxLAN and bridge interfaces should be present at all the PEs. | |
3164 | 4. L3VNI configuration is required to generate and import EVPN type-5 routes. | |
3165 | L3VNI VxLAN and bridge interfaces also should be present. | |
3166 | ||
3167 | A PE can use one of the following two mechanisms to advertise an EVPN type-5 | |
3168 | route with gateway IP. | |
3169 | ||
3170 | 1. CLI to add gateway IP while generating EVPN type-5 route from a BGP IPv4/IPv6 | |
3171 | prefix: | |
3172 | ||
5c54512e | 3173 | .. clicmd:: advertise <ipv4|ipv6> unicast [gateway-ip] |
40f4507d AD |
3174 | |
3175 | When this CLI is configured for a BGP vrf under L2VPN EVPN address family, EVPN | |
3176 | type-5 routes are generated for BGP prefixes in the vrf. Nexthop of the BGP | |
3177 | prefix becomes the gateway IP of the corresponding type-5 route. | |
3178 | ||
3179 | If the above command is configured without the "gateway-ip" keyword, type-5 | |
3180 | routes are generated without overlay index. | |
3181 | ||
3182 | 2. Add gateway IP to EVPN type-5 route using a route-map: | |
3183 | ||
5c54512e | 3184 | .. clicmd:: set evpn gateway-ip <ipv4|ipv6> <addr> |
40f4507d AD |
3185 | |
3186 | When route-map with above set clause is applied as outbound policy in BGP, it | |
3187 | will set the gateway-ip in EVPN type-5 NLRI. | |
3188 | ||
3189 | Example configuration: | |
3190 | ||
3191 | .. code-block:: frr | |
3192 | ||
3193 | router bgp 100 | |
3194 | neighbor 192.168.0.1 remote-as 101 | |
3195 | ! | |
3196 | address-family ipv4 l2vpn evpn | |
3197 | neighbor 192.168.0.1 route-map RMAP out | |
3198 | exit-address-family | |
3199 | ! | |
3200 | route-map RMAP permit 10 | |
3201 | set evpn gateway-ip 10.0.0.1 | |
3202 | set evpn gateway-ip 10::1 | |
3203 | ||
3204 | A PE that receives a type-5 route with gateway IP overlay index should have | |
3205 | "enable-resolve-overlay-index" configuration enabled to recursively resolve the | |
3206 | overlay index nexthop and install the prefix into zebra. | |
3207 | ||
5c54512e | 3208 | .. clicmd:: enable-resolve-overlay-index |
40f4507d AD |
3209 | |
3210 | Example configuration: | |
3211 | ||
3212 | .. code-block:: frr | |
3213 | ||
3214 | router bgp 65001 | |
3215 | bgp router-id 192.168.100.1 | |
3216 | no bgp ebgp-requires-policy | |
3217 | neighbor 10.0.1.2 remote-as 65002 | |
3218 | ! | |
3219 | address-family l2vpn evpn | |
3220 | neighbor 10.0.1.2 activate | |
3221 | advertise-all-vni | |
3222 | enable-resolve-overlay-index | |
3223 | exit-address-family | |
3224 | ! | |
3225 | ||
92396068 AK |
3226 | .. _bgp-evpn-mh: |
3227 | ||
77457939 AK |
3228 | EVPN Multihoming |
3229 | ^^^^^^^^^^^^^^^^ | |
3230 | ||
3231 | All-Active Multihoming is used for redundancy and load sharing. Servers | |
3232 | are attached to two or more PEs and the links are bonded (link-aggregation). | |
3233 | This group of server links is referred to as an Ethernet Segment. | |
3234 | ||
3235 | Ethernet Segments | |
3236 | """"""""""""""""" | |
3237 | An Ethernet Segment can be configured by specifying a system-MAC and a | |
c52de8c1 | 3238 | local discriminator or a complete ESINAME against the bond interface on the |
3239 | PE (via zebra) - | |
77457939 | 3240 | |
c52de8c1 | 3241 | .. clicmd:: evpn mh es-id <(1-16777215)|ESINAME> |
77457939 | 3242 | |
03750f1e | 3243 | .. clicmd:: evpn mh es-sys-mac X:X:X:X:X:X |
77457939 AK |
3244 | |
3245 | The sys-mac and local discriminator are used for generating a 10-byte, | |
c52de8c1 | 3246 | Type-3 Ethernet Segment ID. ESINAME is a 10-byte, Type-0 Ethernet Segment ID - |
3247 | "00:AA:BB:CC:DD:EE:FF:GG:HH:II". | |
77457939 | 3248 | |
c12d5f20 | 3249 | Type-1 (EAD-per-ES and EAD-per-EVI) routes are used to advertise the locally |
77457939 AK |
3250 | attached ESs and to learn off remote ESs in the network. Local Type-2/MAC-IP |
3251 | routes are also advertised with a destination ESI allowing for MAC-IP syncing | |
3252 | between Ethernet Segment peers. | |
3253 | Reference: RFC 7432, RFC 8365 | |
3254 | ||
3255 | EVPN-MH is intended as a replacement for MLAG or Anycast VTEPs. In | |
3256 | multihoming each PE has an unique VTEP address which requires the introduction | |
3257 | of a new dataplane construct, MAC-ECMP. Here a MAC/FDB entry can point to a | |
3258 | list of remote PEs/VTEPs. | |
3259 | ||
3260 | BUM handling | |
3261 | """""""""""" | |
3262 | Type-4 (ESR) routes are used for Designated Forwarder (DF) election. DFs | |
3263 | forward BUM traffic received via the overlay network. This implementation | |
3264 | uses a preference based DF election specified by draft-ietf-bess-evpn-pref-df. | |
3265 | The DF preference is configurable per-ES (via zebra) - | |
3266 | ||
03750f1e | 3267 | .. clicmd:: evpn mh es-df-pref (1-16777215) |
77457939 AK |
3268 | |
3269 | BUM traffic is rxed via the overlay by all PEs attached to a server but | |
3270 | only the DF can forward the de-capsulated traffic to the access port. To | |
f563acec | 3271 | accommodate that non-DF filters are installed in the dataplane to drop |
77457939 AK |
3272 | the traffic. |
3273 | ||
3274 | Similarly traffic received from ES peers via the overlay cannot be forwarded | |
3275 | to the server. This is split-horizon-filtering with local bias. | |
3276 | ||
fe8293c3 AK |
3277 | Knobs for interop |
3278 | """"""""""""""""" | |
3279 | Some vendors do not send EAD-per-EVI routes. To interop with them we | |
3280 | need to relax the dependency on EAD-per-EVI routes and activate a remote | |
3281 | ES-PE based on just the EAD-per-ES route. | |
3282 | ||
3283 | Note that by default we advertise and expect EAD-per-EVI routes. | |
3284 | ||
03750f1e | 3285 | .. clicmd:: disable-ead-evi-rx |
fe8293c3 | 3286 | |
03750f1e | 3287 | .. clicmd:: disable-ead-evi-tx |
fe8293c3 | 3288 | |
77457939 AK |
3289 | Fast failover |
3290 | """"""""""""" | |
3291 | As the primary purpose of EVPN-MH is redundancy keeping the failover efficient | |
3292 | is a recurring theme in the implementation. Following sub-features have | |
3293 | been introduced for the express purpose of efficient ES failovers. | |
3294 | ||
3295 | - Layer-2 Nexthop Groups and MAC-ECMP via L2NHG. | |
3296 | ||
3297 | - Host routes (for symmetric IRB) via L3NHG. | |
3298 | On dataplanes that support layer3 nexthop groups the feature can be turned | |
3299 | on via the following BGP config - | |
3300 | ||
03750f1e | 3301 | .. clicmd:: use-es-l3nhg |
77457939 AK |
3302 | |
3303 | - Local ES (MAC/Neigh) failover via ES-redirect. | |
3304 | On dataplanes that do not have support for ES-redirect the feature can be | |
3305 | turned off via the following zebra config - | |
3306 | ||
03750f1e | 3307 | .. clicmd:: evpn mh redirect-off |
77457939 AK |
3308 | |
3309 | Uplink/Core tracking | |
3310 | """""""""""""""""""" | |
3311 | When all the underlay links go down the PE no longer has access to the VxLAN | |
3312 | +overlay. To prevent blackholing of traffic the server/ES links are | |
3313 | protodowned on the PE. A link can be setup for uplink tracking via the | |
3314 | following zebra configuration - | |
3315 | ||
03750f1e | 3316 | .. clicmd:: evpn mh uplink |
77457939 AK |
3317 | |
3318 | Proxy advertisements | |
3319 | """""""""""""""""""" | |
3320 | To handle hitless upgrades support for proxy advertisement has been added | |
3321 | as specified by draft-rbickhart-evpn-ip-mac-proxy-adv. This allows a PE | |
3322 | (say PE1) to proxy advertise a MAC-IP rxed from an ES peer (say PE2). When | |
3323 | the ES peer (PE2) goes down PE1 continues to advertise hosts learnt from PE2 | |
3324 | for a holdtime during which it attempts to establish local reachability of | |
3325 | the host. This holdtime is configurable via the following zebra commands - | |
3326 | ||
03750f1e | 3327 | .. clicmd:: evpn mh neigh-holdtime (0-86400) |
77457939 | 3328 | |
03750f1e | 3329 | .. clicmd:: evpn mh mac-holdtime (0-86400) |
77457939 AK |
3330 | |
3331 | Startup delay | |
3332 | """"""""""""" | |
3333 | When a switch is rebooted we wait for a brief period to allow the underlay | |
3334 | and EVPN network to converge before enabling the ESs. For this duration the | |
3335 | ES bonds are held protodown. The startup delay is configurable via the | |
3336 | following zebra command - | |
3337 | ||
03750f1e | 3338 | .. clicmd:: evpn mh startup-delay (0-3600) |
77457939 | 3339 | |
92396068 AK |
3340 | EAD-per-ES fragmentation |
3341 | """""""""""""""""""""""" | |
3342 | The EAD-per-ES route carries the EVI route targets for all the broadcast | |
3343 | domains associated with the ES. Depending on the EVI scale the EAD-per-ES | |
3344 | route maybe fragmented. | |
3345 | ||
3346 | The number of EVIs per-EAD route can be configured via the following | |
3347 | BGP command - | |
3348 | ||
c12d5f20 | 3349 | .. clicmd:: [no] ead-es-frag evi-limit (1-1000) |
92396068 AK |
3350 | |
3351 | Sample Configuration | |
3352 | ^^^^^^^^^^^^^^^^^^^^^ | |
3353 | .. code-block:: frr | |
3354 | ||
3355 | ! | |
3356 | router bgp 5556 | |
3357 | ! | |
3358 | address-family l2vpn evpn | |
3359 | ead-es-frag evi-limit 200 | |
3360 | exit-address-family | |
3361 | ! | |
3362 | ! | |
3363 | ||
3364 | EAD-per-ES route-target | |
3365 | """"""""""""""""""""""" | |
3366 | The EAD-per-ES route by default carries all the EVI route targets. Depending | |
3367 | on EVI scale that can result in route fragmentation. In some cases it maybe | |
3368 | necessary to avoid this fragmentation and that can be done via the following | |
3369 | workaround - | |
3370 | 1. Configure a single supplementary BD per-tenant VRF. This SBD needs to | |
3371 | be provisioned on all EVPN PEs associated with the tenant-VRF. | |
3372 | 2. Config the SBD's RT as the EAD-per-ES route's export RT. | |
3373 | ||
3374 | Sample Configuration | |
3375 | ^^^^^^^^^^^^^^^^^^^^^ | |
3376 | .. code-block:: frr | |
3377 | ||
3378 | ! | |
3379 | router bgp 5556 | |
3380 | ! | |
3381 | address-family l2vpn evpn | |
3382 | ead-es-route-target export 5556:1001 | |
3383 | ead-es-route-target export 5556:1004 | |
3384 | ead-es-route-target export 5556:1008 | |
3385 | exit-address-family | |
3386 | ! | |
3387 | ||
b58393f6 | 3388 | Support with VRF network namespace backend |
3389 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
ee9d0f09 PG |
3390 | It is possible to separate overlay networks contained in VXLAN interfaces from |
3391 | underlay networks by using VRFs. VRF-lite and VRF-netns backends can be used for | |
3392 | that. In the latter case, it is necessary to set both bridge and vxlan interface | |
3393 | in the same network namespace, as below example illustrates: | |
3394 | ||
3395 | .. code-block:: shell | |
3396 | ||
3397 | # linux shell | |
3398 | ip netns add vrf1 | |
3399 | ip link add name vxlan101 type vxlan id 101 dstport 4789 dev eth0 local 10.1.1.1 | |
3400 | ip link set dev vxlan101 netns vrf1 | |
3401 | ip netns exec vrf1 ip link set dev lo up | |
3402 | ip netns exec vrf1 brctl addbr bridge101 | |
3403 | ip netns exec vrf1 brctl addif bridge101 vxlan101 | |
3404 | ||
3405 | This makes it possible to separate not only layer 3 networks like VRF-lite networks. | |
3406 | Also, VRF netns based make possible to separate layer 2 networks on separate VRF | |
3407 | instances. | |
89b97c33 | 3408 | |
7f7940e6 MK |
3409 | .. _bgp-conditional-advertisement: |
3410 | ||
3411 | BGP Conditional Advertisement | |
3412 | ----------------------------- | |
3413 | The BGP conditional advertisement feature uses the ``non-exist-map`` or the | |
3414 | ``exist-map`` and the ``advertise-map`` keywords of the neighbor advertise-map | |
3415 | command in order to track routes by the route prefix. | |
3416 | ||
3417 | ``non-exist-map`` | |
3418 | 1. If a route prefix is not present in the output of non-exist-map command, | |
3419 | then advertise the route specified by the advertise-map command. | |
3420 | ||
3421 | 2. If a route prefix is present in the output of non-exist-map command, | |
3422 | then do not advertise the route specified by the addvertise-map command. | |
3423 | ||
3424 | ``exist-map`` | |
3425 | 1. If a route prefix is present in the output of exist-map command, | |
3426 | then advertise the route specified by the advertise-map command. | |
3427 | ||
3428 | 2. If a route prefix is not present in the output of exist-map command, | |
3429 | then do not advertise the route specified by the advertise-map command. | |
3430 | ||
3431 | This feature is useful when some prefixes are advertised to one of its peers | |
3432 | only if the information from the other peer is not present (due to failure in | |
3433 | peering session or partial reachability etc). | |
3434 | ||
3435 | The conditional BGP announcements are sent in addition to the normal | |
3436 | announcements that a BGP router sends to its peer. | |
3437 | ||
3438 | The conditional advertisement process is triggered by the BGP scanner process, | |
389e4f92 QY |
3439 | which runs every 60 by default. This means that the maximum time for the |
3440 | conditional advertisement to take effect is the value of the process timer. | |
3441 | ||
3442 | As an optimization, while the process always runs on each timer expiry, it | |
3443 | determines whether or not the conditional advertisement policy or the routing | |
3444 | table has changed; if neither have changed, no processing is necessary and the | |
3445 | scanner exits early. | |
7f7940e6 | 3446 | |
03750f1e | 3447 | .. clicmd:: neighbor A.B.C.D advertise-map NAME [exist-map|non-exist-map] NAME |
7f7940e6 | 3448 | |
fa36596c | 3449 | This command enables BGP scanner process to monitor routes specified by |
7f7940e6 | 3450 | exist-map or non-exist-map command in BGP table and conditionally advertises |
fa36596c | 3451 | the routes specified by advertise-map command. |
7f7940e6 | 3452 | |
389e4f92 QY |
3453 | .. clicmd:: bgp conditional-advertisement timer (5-240) |
3454 | ||
3455 | Set the period to rerun the conditional advertisement scanner process. The | |
3456 | default is 60 seconds. | |
3457 | ||
7f7940e6 MK |
3458 | Sample Configuration |
3459 | ^^^^^^^^^^^^^^^^^^^^^ | |
3460 | .. code-block:: frr | |
3461 | ||
fa36596c MK |
3462 | interface enp0s9 |
3463 | ip address 10.10.10.2/24 | |
3464 | ! | |
3465 | interface enp0s10 | |
3466 | ip address 10.10.20.2/24 | |
3467 | ! | |
7f7940e6 | 3468 | interface lo |
fa36596c | 3469 | ip address 203.0.113.1/32 |
7f7940e6 MK |
3470 | ! |
3471 | router bgp 2 | |
3472 | bgp log-neighbor-changes | |
3473 | no bgp ebgp-requires-policy | |
3474 | neighbor 10.10.10.1 remote-as 1 | |
3475 | neighbor 10.10.20.3 remote-as 3 | |
3476 | ! | |
3477 | address-family ipv4 unicast | |
7f7940e6 | 3478 | neighbor 10.10.10.1 soft-reconfiguration inbound |
7f7940e6 | 3479 | neighbor 10.10.20.3 soft-reconfiguration inbound |
fa36596c | 3480 | neighbor 10.10.20.3 advertise-map ADV-MAP non-exist-map EXIST-MAP |
7f7940e6 MK |
3481 | exit-address-family |
3482 | ! | |
fa36596c MK |
3483 | ip prefix-list DEFAULT seq 5 permit 192.0.2.5/32 |
3484 | ip prefix-list DEFAULT seq 10 permit 192.0.2.1/32 | |
3485 | ip prefix-list EXIST seq 5 permit 10.10.10.10/32 | |
3486 | ip prefix-list DEFAULT-ROUTE seq 5 permit 0.0.0.0/0 | |
3487 | ip prefix-list IP1 seq 5 permit 10.139.224.0/20 | |
3488 | ! | |
3489 | bgp community-list standard DC-ROUTES seq 5 permit 64952:3008 | |
3490 | bgp community-list standard DC-ROUTES seq 10 permit 64671:501 | |
3491 | bgp community-list standard DC-ROUTES seq 15 permit 64950:3009 | |
3492 | bgp community-list standard DEFAULT-ROUTE seq 5 permit 65013:200 | |
7f7940e6 | 3493 | ! |
fa36596c MK |
3494 | route-map ADV-MAP permit 10 |
3495 | match ip address prefix-list IP1 | |
7f7940e6 | 3496 | ! |
fa36596c MK |
3497 | route-map ADV-MAP permit 20 |
3498 | match community DC-ROUTES | |
3499 | ! | |
3500 | route-map EXIST-MAP permit 10 | |
3501 | match community DEFAULT-ROUTE | |
3502 | match ip address prefix-list DEFAULT-ROUTE | |
7f7940e6 MK |
3503 | ! |
3504 | ||
3505 | Sample Output | |
3506 | ^^^^^^^^^^^^^ | |
3507 | ||
fa36596c | 3508 | When default route is present in R2'2 BGP table, 10.139.224.0/20 and 192.0.2.1/32 are not advertised to R3. |
7f7940e6 MK |
3509 | |
3510 | .. code-block:: frr | |
3511 | ||
3512 | Router2# show ip bgp | |
fa36596c | 3513 | BGP table version is 20, local router ID is 203.0.113.1, vrf id 0 |
7f7940e6 MK |
3514 | Default local pref 100, local AS 2 |
3515 | Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, | |
3516 | i internal, r RIB-failure, S Stale, R Removed | |
3517 | Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self | |
3518 | Origin codes: i - IGP, e - EGP, ? - incomplete | |
0bcfc1a3 | 3519 | RPKI validation codes: V valid, I invalid, N Not found |
7f7940e6 | 3520 | |
fa36596c MK |
3521 | Network Next Hop Metric LocPrf Weight Path |
3522 | *> 0.0.0.0/0 10.10.10.1 0 0 1 i | |
3523 | *> 10.139.224.0/20 10.10.10.1 0 0 1 ? | |
3524 | *> 192.0.2.1/32 10.10.10.1 0 0 1 i | |
3525 | *> 192.0.2.5/32 10.10.10.1 0 0 1 i | |
7f7940e6 MK |
3526 | |
3527 | Displayed 4 routes and 4 total paths | |
fa36596c | 3528 | Router2# show ip bgp neighbors 10.10.20.3 |
7f7940e6 MK |
3529 | |
3530 | !--- Output suppressed. | |
3531 | ||
3532 | For address family: IPv4 Unicast | |
fa36596c | 3533 | Update group 7, subgroup 7 |
7f7940e6 MK |
3534 | Packet Queue length 0 |
3535 | Inbound soft reconfiguration allowed | |
3536 | Community attribute sent to this neighbor(all) | |
fa36596c MK |
3537 | Condition NON_EXIST, Condition-map *EXIST-MAP, Advertise-map *ADV-MAP, status: Withdraw |
3538 | 0 accepted prefixes | |
7f7940e6 MK |
3539 | |
3540 | !--- Output suppressed. | |
3541 | ||
fa36596c MK |
3542 | Router2# show ip bgp neighbors 10.10.20.3 advertised-routes |
3543 | BGP table version is 20, local router ID is 203.0.113.1, vrf id 0 | |
7f7940e6 MK |
3544 | Default local pref 100, local AS 2 |
3545 | Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, | |
fa36596c | 3546 | i internal, r RIB-failure, S Stale, R Removed |
7f7940e6 MK |
3547 | Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self |
3548 | Origin codes: i - IGP, e - EGP, ? - incomplete | |
0bcfc1a3 | 3549 | RPKI validation codes: V valid, I invalid, N Not found |
7f7940e6 | 3550 | |
fa36596c MK |
3551 | Network Next Hop Metric LocPrf Weight Path |
3552 | *> 0.0.0.0/0 0.0.0.0 0 1 i | |
3553 | *> 192.0.2.5/32 0.0.0.0 0 1 i | |
7f7940e6 | 3554 | |
fa36596c | 3555 | Total number of prefixes 2 |
7f7940e6 | 3556 | |
fa36596c | 3557 | When default route is not present in R2'2 BGP table, 10.139.224.0/20 and 192.0.2.1/32 are advertised to R3. |
7f7940e6 MK |
3558 | |
3559 | .. code-block:: frr | |
3560 | ||
3561 | Router2# show ip bgp | |
fa36596c | 3562 | BGP table version is 21, local router ID is 203.0.113.1, vrf id 0 |
7f7940e6 MK |
3563 | Default local pref 100, local AS 2 |
3564 | Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, | |
3565 | i internal, r RIB-failure, S Stale, R Removed | |
3566 | Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self | |
3567 | Origin codes: i - IGP, e - EGP, ? - incomplete | |
0bcfc1a3 | 3568 | RPKI validation codes: V valid, I invalid, N Not found |
7f7940e6 | 3569 | |
fa36596c MK |
3570 | Network Next Hop Metric LocPrf Weight Path |
3571 | *> 10.139.224.0/20 10.10.10.1 0 0 1 ? | |
3572 | *> 192.0.2.1/32 10.10.10.1 0 0 1 i | |
3573 | *> 192.0.2.5/32 10.10.10.1 0 0 1 i | |
7f7940e6 MK |
3574 | |
3575 | Displayed 3 routes and 3 total paths | |
7f7940e6 | 3576 | |
fa36596c | 3577 | Router2# show ip bgp neighbors 10.10.20.3 |
7f7940e6 MK |
3578 | |
3579 | !--- Output suppressed. | |
3580 | ||
3581 | For address family: IPv4 Unicast | |
fa36596c | 3582 | Update group 7, subgroup 7 |
7f7940e6 MK |
3583 | Packet Queue length 0 |
3584 | Inbound soft reconfiguration allowed | |
3585 | Community attribute sent to this neighbor(all) | |
fa36596c MK |
3586 | Condition NON_EXIST, Condition-map *EXIST-MAP, Advertise-map *ADV-MAP, status: Advertise |
3587 | 0 accepted prefixes | |
7f7940e6 MK |
3588 | |
3589 | !--- Output suppressed. | |
3590 | ||
fa36596c MK |
3591 | Router2# show ip bgp neighbors 10.10.20.3 advertised-routes |
3592 | BGP table version is 21, local router ID is 203.0.113.1, vrf id 0 | |
7f7940e6 MK |
3593 | Default local pref 100, local AS 2 |
3594 | Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, | |
3595 | i internal, r RIB-failure, S Stale, R Removed | |
3596 | Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self | |
3597 | Origin codes: i - IGP, e - EGP, ? - incomplete | |
0bcfc1a3 | 3598 | RPKI validation codes: V valid, I invalid, N Not found |
7f7940e6 | 3599 | |
fa36596c MK |
3600 | Network Next Hop Metric LocPrf Weight Path |
3601 | *> 10.139.224.0/20 0.0.0.0 0 1 ? | |
3602 | *> 192.0.2.1/32 0.0.0.0 0 1 i | |
3603 | *> 192.0.2.5/32 0.0.0.0 0 1 i | |
7f7940e6 MK |
3604 | |
3605 | Total number of prefixes 3 | |
fa36596c | 3606 | Router2# |
7f7940e6 | 3607 | |
8fcedbd2 QY |
3608 | .. _bgp-debugging: |
3609 | ||
3610 | Debugging | |
3611 | --------- | |
42fc5d26 | 3612 | |
29adcd50 | 3613 | .. clicmd:: show debug |
42fc5d26 | 3614 | |
8fcedbd2 | 3615 | Show all enabled debugs. |
42fc5d26 | 3616 | |
54422b46 DS |
3617 | .. clicmd:: show bgp listeners |
3618 | ||
3619 | Display Listen sockets and the vrf that created them. Useful for debugging of when | |
3620 | listen is not working and this is considered a developer debug statement. | |
3621 | ||
8666265e DS |
3622 | .. clicmd:: debug bgp allow-martian |
3623 | ||
3624 | Enable or disable BGP accepting martian nexthops from a peer. Please note | |
3625 | this is not an actual debug command and this command is also being deprecated | |
3626 | and will be removed soon. The new command is :clicmd:`bgp allow-martian-nexthop` | |
3627 | ||
81313f43 RZ |
3628 | .. clicmd:: debug bgp bfd |
3629 | ||
3630 | Enable or disable debugging for BFD events. This will show BFD integration | |
3631 | library messages and BGP BFD integration messages that are mostly state | |
3632 | transitions and validation problems. | |
3633 | ||
8093d799 MK |
3634 | .. clicmd:: debug bgp conditional-advertisement |
3635 | ||
3636 | Enable or disable debugging of BGP conditional advertisement. | |
3637 | ||
03750f1e | 3638 | .. clicmd:: debug bgp neighbor-events |
42fc5d26 | 3639 | |
8fcedbd2 QY |
3640 | Enable or disable debugging for neighbor events. This provides general |
3641 | information on BGP events such as peer connection / disconnection, session | |
3642 | establishment / teardown, and capability negotiation. | |
42fc5d26 | 3643 | |
03750f1e | 3644 | .. clicmd:: debug bgp updates |
42fc5d26 | 3645 | |
8fcedbd2 QY |
3646 | Enable or disable debugging for BGP updates. This provides information on |
3647 | BGP UPDATE messages transmitted and received between local and remote | |
3648 | instances. | |
42fc5d26 | 3649 | |
03750f1e | 3650 | .. clicmd:: debug bgp keepalives |
42fc5d26 | 3651 | |
8fcedbd2 QY |
3652 | Enable or disable debugging for BGP keepalives. This provides information on |
3653 | BGP KEEPALIVE messages transmitted and received between local and remote | |
3654 | instances. | |
c1a54c05 | 3655 | |
03750f1e | 3656 | .. clicmd:: debug bgp bestpath <A.B.C.D/M|X:X::X:X/M> |
42fc5d26 | 3657 | |
8fcedbd2 | 3658 | Enable or disable debugging for bestpath selection on the specified prefix. |
42fc5d26 | 3659 | |
03750f1e | 3660 | .. clicmd:: debug bgp nht |
4da7fda3 | 3661 | |
8fcedbd2 | 3662 | Enable or disable debugging of BGP nexthop tracking. |
4da7fda3 | 3663 | |
03750f1e | 3664 | .. clicmd:: debug bgp update-groups |
4b44467c | 3665 | |
8fcedbd2 QY |
3666 | Enable or disable debugging of dynamic update groups. This provides general |
3667 | information on group creation, deletion, join and prune events. | |
4b44467c | 3668 | |
03750f1e | 3669 | .. clicmd:: debug bgp zebra |
42fc5d26 | 3670 | |
8fcedbd2 | 3671 | Enable or disable debugging of communications between *bgpd* and *zebra*. |
c3c5a71f | 3672 | |
8fcedbd2 QY |
3673 | Dumping Messages and Routing Tables |
3674 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
42fc5d26 | 3675 | |
8fcedbd2 | 3676 | .. clicmd:: dump bgp all PATH [INTERVAL] |
42fc5d26 | 3677 | |
8fcedbd2 | 3678 | .. clicmd:: dump bgp all-et PATH [INTERVAL] |
c3c5a71f | 3679 | |
42fc5d26 | 3680 | |
8fcedbd2 QY |
3681 | Dump all BGP packet and events to `path` file. |
3682 | If `interval` is set, a new file will be created for echo `interval` of | |
3683 | seconds. The path `path` can be set with date and time formatting | |
3684 | (strftime). The type ‘all-et’ enables support for Extended Timestamp Header | |
3685 | (:ref:`packet-binary-dump-format`). | |
c3c5a71f | 3686 | |
8fcedbd2 | 3687 | .. clicmd:: dump bgp updates PATH [INTERVAL] |
42fc5d26 | 3688 | |
8fcedbd2 | 3689 | .. clicmd:: dump bgp updates-et PATH [INTERVAL] |
42fc5d26 | 3690 | |
42fc5d26 | 3691 | |
8fcedbd2 QY |
3692 | Dump only BGP updates messages to `path` file. |
3693 | If `interval` is set, a new file will be created for echo `interval` of | |
3694 | seconds. The path `path` can be set with date and time formatting | |
3695 | (strftime). The type ‘updates-et’ enables support for Extended Timestamp | |
3696 | Header (:ref:`packet-binary-dump-format`). | |
42fc5d26 | 3697 | |
8fcedbd2 | 3698 | .. clicmd:: dump bgp routes-mrt PATH |
c3c5a71f | 3699 | |
8fcedbd2 | 3700 | .. clicmd:: dump bgp routes-mrt PATH INTERVAL |
42fc5d26 | 3701 | |
42fc5d26 | 3702 | |
8fcedbd2 QY |
3703 | Dump whole BGP routing table to `path`. This is heavy process. The path |
3704 | `path` can be set with date and time formatting (strftime). If `interval` is | |
3705 | set, a new file will be created for echo `interval` of seconds. | |
42fc5d26 | 3706 | |
8fcedbd2 | 3707 | Note: the interval variable can also be set using hours and minutes: 04h20m00. |
42fc5d26 | 3708 | |
c3c5a71f | 3709 | |
8fcedbd2 | 3710 | .. _bgp-other-commands: |
42fc5d26 | 3711 | |
8fcedbd2 QY |
3712 | Other BGP Commands |
3713 | ------------------ | |
42fc5d26 | 3714 | |
e312b6c6 QY |
3715 | The following are available in the top level *enable* mode: |
3716 | ||
dc912615 DS |
3717 | .. clicmd:: clear bgp \* |
3718 | ||
3719 | Clear all peers. | |
3720 | ||
8fcedbd2 | 3721 | .. clicmd:: clear bgp ipv4|ipv6 \* |
42fc5d26 | 3722 | |
dc912615 DS |
3723 | Clear all peers with this address-family activated. |
3724 | ||
dc912615 DS |
3725 | .. clicmd:: clear bgp ipv4|ipv6 unicast \* |
3726 | ||
3727 | Clear all peers with this address-family and sub-address-family activated. | |
42fc5d26 | 3728 | |
8fcedbd2 | 3729 | .. clicmd:: clear bgp ipv4|ipv6 PEER |
42fc5d26 | 3730 | |
dc912615 DS |
3731 | Clear peers with address of X.X.X.X and this address-family activated. |
3732 | ||
dc912615 DS |
3733 | .. clicmd:: clear bgp ipv4|ipv6 unicast PEER |
3734 | ||
3735 | Clear peer with address of X.X.X.X and this address-family and sub-address-family activated. | |
3736 | ||
dc912615 DS |
3737 | .. clicmd:: clear bgp ipv4|ipv6 PEER soft|in|out |
3738 | ||
3739 | Clear peer using soft reconfiguration in this address-family. | |
42fc5d26 | 3740 | |
dc912615 | 3741 | .. clicmd:: clear bgp ipv4|ipv6 unicast PEER soft|in|out |
42fc5d26 | 3742 | |
dc912615 | 3743 | Clear peer using soft reconfiguration in this address-family and sub-address-family. |
42fc5d26 | 3744 | |
33bbb2e7 DS |
3745 | .. clicmd:: clear bgp [ipv4|ipv6] [unicast] PEER|\* message-stats |
3746 | ||
3747 | Clear BGP message statistics for a specified peer or for all peers, | |
3748 | optionally filtered by activated address-family and sub-address-family. | |
3749 | ||
e312b6c6 QY |
3750 | The following are available in the ``router bgp`` mode: |
3751 | ||
e312b6c6 QY |
3752 | .. clicmd:: write-quanta (1-64) |
3753 | ||
3754 | BGP message Tx I/O is vectored. This means that multiple packets are written | |
3755 | to the peer socket at the same time each I/O cycle, in order to minimize | |
3756 | system call overhead. This value controls how many are written at a time. | |
3757 | Under certain load conditions, reducing this value could make peer traffic | |
3758 | less 'bursty'. In practice, leave this settings on the default (64) unless | |
3759 | you truly know what you are doing. | |
3760 | ||
dad83b67 | 3761 | .. clicmd:: read-quanta (1-10) |
e312b6c6 QY |
3762 | |
3763 | Unlike Tx, BGP Rx traffic is not vectored. Packets are read off the wire one | |
3764 | at a time in a loop. This setting controls how many iterations the loop runs | |
3765 | for. As with write-quanta, it is best to leave this setting on the default. | |
42fc5d26 | 3766 | |
05bd726c | 3767 | The following command is available in ``config`` mode as well as in the |
3768 | ``router bgp`` mode: | |
3769 | ||
05bd726c | 3770 | .. clicmd:: bgp graceful-shutdown |
3771 | ||
3772 | The purpose of this command is to initiate BGP Graceful Shutdown which | |
3773 | is described in :rfc:`8326`. The use case for this is to minimize or | |
3774 | eliminate the amount of traffic loss in a network when a planned | |
3775 | maintenance activity such as software upgrade or hardware replacement | |
3776 | is to be performed on a router. The feature works by re-announcing | |
3777 | routes to eBGP peers with the GRACEFUL_SHUTDOWN community included. | |
3778 | Peers are then expected to treat such paths with the lowest preference. | |
3779 | This happens automatically on a receiver running FRR; with other | |
3780 | routing protocol stacks, an inbound policy may have to be configured. | |
3781 | In FRR, triggering graceful shutdown also results in announcing a | |
3782 | LOCAL_PREF of 0 to iBGP peers. | |
3783 | ||
3784 | Graceful shutdown can be configured per BGP instance or globally for | |
3785 | all of BGP. These two options are mutually exclusive. The no form of | |
3786 | the command causes graceful shutdown to be stopped, and routes will | |
3787 | be re-announced without the GRACEFUL_SHUTDOWN community and/or with | |
3788 | the usual LOCAL_PREF value. Note that if this option is saved to | |
3789 | the startup configuration, graceful shutdown will remain in effect | |
3790 | across restarts of *bgpd* and will need to be explicitly disabled. | |
3791 | ||
a0b937de SW |
3792 | .. clicmd:: bgp input-queue-limit (1-4294967295) |
3793 | ||
3794 | Set the BGP Input Queue limit for all peers when messaging parsing. Increase | |
3795 | this only if you have the memory to handle large queues of messages at once. | |
3796 | ||
963b7ee4 DS |
3797 | .. clicmd:: bgp output-queue-limit (1-4294967295) |
3798 | ||
3799 | Set the BGP Output Queue limit for all peers when messaging parsing. Increase | |
3800 | this only if you have the memory to handle large queues of messages at once. | |
3801 | ||
8fcedbd2 | 3802 | .. _bgp-displaying-bgp-information: |
42fc5d26 | 3803 | |
8fcedbd2 QY |
3804 | Displaying BGP Information |
3805 | ========================== | |
42fc5d26 | 3806 | |
e6f59415 PG |
3807 | The following four commands display the IPv6 and IPv4 routing tables, depending |
3808 | on whether or not the ``ip`` keyword is used. | |
3809 | Actually, :clicmd:`show ip bgp` command was used on older `Quagga` routing | |
3810 | daemon project, while :clicmd:`show bgp` command is the new format. The choice | |
3811 | has been done to keep old format with IPv4 routing table, while new format | |
3812 | displays IPv6 routing table. | |
3813 | ||
4c92d818 | 3814 | .. clicmd:: show ip bgp [all] [wide|json [detail]] |
42fc5d26 | 3815 | |
96f3485c | 3816 | .. clicmd:: show ip bgp A.B.C.D [json] |
c1a54c05 | 3817 | |
4c92d818 | 3818 | .. clicmd:: show bgp [all] [wide|json [detail]] |
e6f59415 | 3819 | |
96f3485c | 3820 | .. clicmd:: show bgp X:X::X:X [json] |
42fc5d26 | 3821 | |
8fcedbd2 | 3822 | These commands display BGP routes. When no route is specified, the default |
e6f59415 | 3823 | is to display all BGP routes. |
42fc5d26 | 3824 | |
8fcedbd2 | 3825 | :: |
c1a54c05 | 3826 | |
8fcedbd2 QY |
3827 | BGP table version is 0, local router ID is 10.1.1.1 |
3828 | Status codes: s suppressed, d damped, h history, * valid, > best, i - internal | |
3829 | Origin codes: i - IGP, e - EGP, ? - incomplete | |
42fc5d26 | 3830 | |
8fcedbd2 QY |
3831 | Network Next Hop Metric LocPrf Weight Path |
3832 | \*> 1.1.1.1/32 0.0.0.0 0 32768 i | |
42fc5d26 | 3833 | |
8fcedbd2 | 3834 | Total number of prefixes 1 |
4da7fda3 | 3835 | |
56c07345 | 3836 | If ``wide`` option is specified, then the prefix table's width is increased |
986b0fc3 DA |
3837 | to fully display the prefix and the nexthop. |
3838 | ||
3839 | This is especially handy dealing with IPv6 prefixes and | |
3840 | if :clicmd:`[no] bgp default show-nexthop-hostname` is enabled. | |
3841 | ||
56c07345 | 3842 | If ``all`` option is specified, ``ip`` keyword is ignored, show bgp all and |
96f3485c MK |
3843 | show ip bgp all commands display routes for all AFIs and SAFIs. |
3844 | ||
56c07345 | 3845 | If ``json`` option is specified, output is displayed in JSON format. |
96f3485c | 3846 | |
4c92d818 DA |
3847 | If ``detail`` option is specified after ``json``, more verbose JSON output |
3848 | will be displayed. | |
3849 | ||
e6f59415 PG |
3850 | Some other commands provide additional options for filtering the output. |
3851 | ||
e6f59415 | 3852 | .. clicmd:: show [ip] bgp regexp LINE |
42fc5d26 | 3853 | |
8fcedbd2 QY |
3854 | This command displays BGP routes using AS path regular expression |
3855 | (:ref:`bgp-regular-expressions`). | |
42fc5d26 | 3856 | |
28b25b6b | 3857 | .. clicmd:: show [ip] bgp [all] summary [wide] [json] |
42fc5d26 | 3858 | |
8fcedbd2 | 3859 | Show a bgp peer summary for the specified address family. |
42fc5d26 | 3860 | |
e6f59415 PG |
3861 | The old command structure :clicmd:`show ip bgp` may be removed in the future |
3862 | and should no longer be used. In order to reach the other BGP routing tables | |
3863 | other than the IPv6 routing table given by :clicmd:`show bgp`, the new command | |
3864 | structure is extended with :clicmd:`show bgp [afi] [safi]`. | |
3865 | ||
28b25b6b DA |
3866 | ``wide`` option gives more output like ``LocalAS`` and extended ``Desc`` to |
3867 | 64 characters. | |
3868 | ||
3869 | .. code-block:: frr | |
3870 | ||
3871 | exit1# show ip bgp summary wide | |
3872 | ||
6cac2fcc | 3873 | IPv4 Unicast Summary (VRF default): |
28b25b6b DA |
3874 | BGP router identifier 192.168.100.1, local AS number 65534 vrf-id 0 |
3875 | BGP table version 3 | |
3876 | RIB entries 5, using 920 bytes of memory | |
3877 | Peers 1, using 27 KiB of memory | |
3878 | ||
3879 | Neighbor V AS LocalAS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt Desc | |
3880 | 192.168.0.2 4 65030 123 15 22 0 0 0 00:07:00 0 1 us-east1-rs1.frrouting.org | |
3881 | ||
3882 | Total number of neighbors 1 | |
3883 | exit1# | |
3884 | ||
96f3485c | 3885 | .. clicmd:: show bgp [afi] [safi] [all] [wide|json] |
e6f59415 | 3886 | |
5bfa8013 CS |
3887 | .. clicmd:: show bgp vrfs [<VRFNAME$vrf_name>] [json] |
3888 | ||
3889 | The command displays all bgp vrf instances basic info like router-id, | |
3890 | configured and established neighbors, | |
3891 | evpn related basic info like l3vni, router-mac, vxlan-interface. | |
3892 | User can get that information as JSON format when ``json`` keyword | |
3893 | at the end of cli is presented. | |
3894 | ||
3895 | .. code-block:: frr | |
3896 | ||
3897 | torc-11# show bgp vrfs | |
3898 | Type Id routerId #PeersCfg #PeersEstb Name | |
3899 | L3-VNI RouterMAC Interface | |
3900 | DFLT 0 17.0.0.6 3 3 default | |
3901 | 0 00:00:00:00:00:00 unknown | |
3902 | VRF 21 17.0.0.6 0 0 sym_1 | |
3903 | 8888 34:11:12:22:22:01 vlan4034_l3 | |
3904 | VRF 32 17.0.0.6 0 0 sym_2 | |
3905 | 8889 34:11:12:22:22:01 vlan4035_l3 | |
3906 | ||
3907 | Total number of VRFs (including default): 3 | |
3908 | ||
22bfb2a6 | 3909 | .. clicmd:: show bgp [<ipv4|ipv6> <unicast|multicast|vpn|labeled-unicast|flowspec> | l2vpn evpn] |
e6f59415 PG |
3910 | |
3911 | These commands display BGP routes for the specific routing table indicated by | |
3912 | the selected afi and the selected safi. If no afi and no safi value is given, | |
6cfd16ad | 3913 | the command falls back to the default IPv6 routing table. |
6cfd16ad | 3914 | |
6cfd16ad TA |
3915 | .. clicmd:: show bgp l2vpn evpn route [type <macip|2|multicast|3|es|4|prefix|5>] |
3916 | ||
22bfb2a6 | 3917 | EVPN prefixes can also be filtered by EVPN route type. |
e6f59415 | 3918 | |
83856649 KQ |
3919 | .. clicmd:: show bgp l2vpn evpn route [detail] [type <ead|1|macip|2|multicast|3|es|4|prefix|5>] self-originate [json] |
3920 | ||
3921 | Display self-originated EVPN prefixes which can also be filtered by EVPN route type. | |
3922 | ||
8476d11c SW |
3923 | .. clicmd:: show bgp vni <all|VNI> [vtep VTEP] [type <ead|1|macip|2|multicast|3>] [<detail|json>] |
3924 | ||
3925 | Display per-VNI EVPN routing table in bgp. Filter route-type, vtep, or VNI. | |
3926 | ||
96f3485c | 3927 | .. clicmd:: show bgp [afi] [safi] [all] summary [json] |
e6f59415 PG |
3928 | |
3929 | Show a bgp peer summary for the specified address family, and subsequent | |
3930 | address-family. | |
3931 | ||
96f3485c | 3932 | .. clicmd:: show bgp [afi] [safi] [all] summary failed [json] |
3577f1c5 | 3933 | |
f563acec | 3934 | Show a bgp peer summary for peers that are not successfully exchanging routes |
3577f1c5 DD |
3935 | for the specified address family, and subsequent address-family. |
3936 | ||
96f3485c | 3937 | .. clicmd:: show bgp [afi] [safi] [all] summary established [json] |
1c027267 | 3938 | |
f563acec | 3939 | Show a bgp peer summary for peers that are successfully exchanging routes |
1c027267 DA |
3940 | for the specified address family, and subsequent address-family. |
3941 | ||
8c1d4cd5 LS |
3942 | .. clicmd:: show bgp [afi] [safi] [all] summary neighbor [PEER] [json] |
3943 | ||
3944 | Show a bgp summary for the specified peer, address family, and | |
3945 | subsequent address-family. The neighbor filter can be used in combination | |
3946 | with the failed, established filters. | |
3947 | ||
3948 | .. clicmd:: show bgp [afi] [safi] [all] summary remote-as <internal|external|ASN> [json] | |
3949 | ||
3950 | Show a bgp peer summary for the specified remote-as ASN or type (``internal`` | |
3951 | for iBGP and ``external`` for eBGP sessions), address family, and subsequent | |
3952 | address-family. The remote-as filter can be used in combination with the | |
3953 | failed, established filters. | |
3954 | ||
96c81f66 LS |
3955 | .. clicmd:: show bgp [afi] [safi] [all] summary terse [json] |
3956 | ||
3957 | Shorten the output. Do not show the following information about the BGP | |
3958 | instances: the number of RIB entries, the table version and the used memory. | |
3959 | The ``terse`` option can be used in combination with the remote-as, neighbor, | |
3960 | failed and established filters, and with the ``wide`` option as well. | |
3961 | ||
bda4a612 | 3962 | .. clicmd:: show bgp [afi] [safi] [neighbor [PEER] [routes|advertised-routes|received-routes] [<A.B.C.D/M|X:X::X:X/M> | detail] [json] |
9eb95b3b | 3963 | |
e6f59415 PG |
3964 | This command shows information on a specific BGP peer of the relevant |
3965 | afi and safi selected. | |
c1a54c05 | 3966 | |
22bfb2a6 TA |
3967 | The ``routes`` keyword displays only routes in this address-family's BGP |
3968 | table that were received by this peer and accepted by inbound policy. | |
3969 | ||
3970 | The ``advertised-routes`` keyword displays only the routes in this | |
3971 | address-family's BGP table that were permitted by outbound policy and | |
3972 | advertised to to this peer. | |
3973 | ||
3974 | The ``received-routes`` keyword displays all routes belonging to this | |
3975 | address-family (prior to inbound policy) that were received by this peer. | |
3976 | ||
bda4a612 TA |
3977 | If a specific prefix is specified, the detailed version of that prefix will |
3978 | be displayed. | |
3979 | ||
1b9d2d60 TA |
3980 | If ``detail`` option is specified, the detailed version of all routes |
3981 | will be displayed. The same format as ``show [ip] bgp [afi] [safi] PREFIX`` | |
3982 | will be used, but for the whole table of received, advertised or filtered | |
3983 | prefixes. | |
3984 | ||
3985 | If ``json`` option is specified, output is displayed in JSON format. | |
3986 | ||
d3120452 IR |
3987 | .. clicmd:: show bgp [<view|vrf> VIEWVRFNAME] [afi] [safi] neighbors PEER received prefix-filter [json] |
3988 | ||
3989 | Display Address Prefix ORFs received from this peer. | |
3990 | ||
96f3485c | 3991 | .. clicmd:: show bgp [afi] [safi] [all] dampening dampened-paths [wide|json] |
42fc5d26 | 3992 | |
e6f59415 PG |
3993 | Display paths suppressed due to dampening of the selected afi and safi |
3994 | selected. | |
42fc5d26 | 3995 | |
96f3485c | 3996 | .. clicmd:: show bgp [afi] [safi] [all] dampening flap-statistics [wide|json] |
c1a54c05 | 3997 | |
e6f59415 | 3998 | Display flap statistics of routes of the selected afi and safi selected. |
42fc5d26 | 3999 | |
fe0f234d RW |
4000 | .. clicmd:: show bgp [afi] [safi] [all] dampening parameters [json] |
4001 | ||
4002 | Display details of configured dampening parameters of the selected afi and | |
4003 | safi. | |
4004 | ||
4005 | If the ``json`` option is specified, output is displayed in JSON format. | |
4006 | ||
244e6cab DA |
4007 | .. clicmd:: show bgp [afi] [safi] [all] version (1-4294967295) [wide|json] |
4008 | ||
4009 | Display prefixes with matching version numbers. The version number and | |
4010 | above having prefixes will be listed here. | |
4011 | ||
4012 | It helps to identify which prefixes were installed at some point. | |
4013 | ||
4014 | Here is an example of how to check what prefixes were installed starting | |
05653f49 | 4015 | with an arbitrary version: |
244e6cab | 4016 | |
01af2696 | 4017 | .. code-block:: shell |
244e6cab | 4018 | |
01af2696 DS |
4019 | # vtysh -c 'show bgp ipv4 unicast json' | jq '.tableVersion' |
4020 | 9 | |
4021 | # vtysh -c 'show ip bgp version 9 json' | jq -r '.routes | keys[]' | |
4022 | 192.168.3.0/24 | |
4023 | # vtysh -c 'show ip bgp version 8 json' | jq -r '.routes | keys[]' | |
4024 | 192.168.2.0/24 | |
4025 | 192.168.3.0/24 | |
244e6cab | 4026 | |
620e23e8 PG |
4027 | .. clicmd:: show bgp [afi] [safi] statistics |
4028 | ||
4029 | Display statistics of routes of the selected afi and safi. | |
4030 | ||
620e23e8 PG |
4031 | .. clicmd:: show bgp statistics-all |
4032 | ||
4033 | Display statistics of routes of all the afi and safi. | |
4034 | ||
96f3485c MK |
4035 | .. clicmd:: show [ip] bgp [afi] [safi] [all] cidr-only [wide|json] |
4036 | ||
4037 | Display routes with non-natural netmasks. | |
4038 | ||
6deaf579 RW |
4039 | .. clicmd:: show [ip] bgp [afi] [safi] [all] prefix-list WORD [wide|json] |
4040 | ||
4041 | Display routes that match the specified prefix-list. | |
4042 | ||
4043 | If ``wide`` option is specified, then the prefix table's width is increased | |
4044 | to fully display the prefix and the nexthop. | |
4045 | ||
4046 | If the ``json`` option is specified, output is displayed in JSON format. | |
4047 | ||
61216286 DA |
4048 | .. clicmd:: show [ip] bgp [afi] [safi] [all] access-list WORD [wide|json] |
4049 | ||
4050 | Display routes that match the specified access-list. | |
4051 | ||
a7129347 RW |
4052 | .. clicmd:: show [ip] bgp [afi] [safi] [all] filter-list WORD [wide|json] |
4053 | ||
4054 | Display routes that match the specified AS-Path filter-list. | |
4055 | ||
4056 | If ``wide`` option is specified, then the prefix table's width is increased | |
4057 | to fully display the prefix and the nexthop. | |
4058 | ||
4059 | If the ``json`` option is specified, output is displayed in JSON format. | |
4060 | ||
bf1a944a RW |
4061 | .. clicmd:: show [ip] bgp [afi] [safi] [all] route-map WORD [wide|json] |
4062 | ||
4063 | Display routes that match the specified route-map. | |
4064 | ||
4065 | If ``wide`` option is specified, then the prefix table's width is increased | |
4066 | to fully display the prefix and the nexthop. | |
4067 | ||
4068 | If the ``json`` option is specified, output is displayed in JSON format. | |
4069 | ||
39c3c736 RW |
4070 | .. clicmd:: show [ip] bgp [afi] [safi] [all] <A.B.C.D/M|X:X::X:X/M> longer-prefixes [wide|json] |
4071 | ||
4072 | Displays the specified route and all more specific routes. | |
4073 | ||
4074 | If ``wide`` option is specified, then the prefix table's width is increased | |
4075 | to fully display the prefix and the nexthop. | |
4076 | ||
4077 | If the ``json`` option is specified, output is displayed in JSON format. | |
4078 | ||
83856649 KQ |
4079 | .. clicmd:: show [ip] bgp [afi] [safi] [all] self-originate [wide|json] |
4080 | ||
4081 | Display self-originated routes. | |
4082 | ||
4083 | If ``wide`` option is specified, then the prefix table's width is increased | |
4084 | to fully display the prefix and the nexthop. | |
4085 | ||
4086 | If the ``json`` option is specified, output is displayed in JSON format. | |
4087 | ||
bda4a612 | 4088 | .. clicmd:: show [ip] bgp [afi] [safi] [all] neighbors A.B.C.D [advertised-routes|received-routes|filtered-routes] [<A.B.C.D/M|X:X::X:X/M> | detail] [json|wide] |
96f3485c MK |
4089 | |
4090 | Display the routes advertised to a BGP neighbor or received routes | |
4091 | from neighbor or filtered routes received from neighbor based on the | |
4092 | option specified. | |
4093 | ||
56c07345 | 4094 | If ``wide`` option is specified, then the prefix table's width is increased |
96f3485c MK |
4095 | to fully display the prefix and the nexthop. |
4096 | ||
4097 | This is especially handy dealing with IPv6 prefixes and | |
4098 | if :clicmd:`[no] bgp default show-nexthop-hostname` is enabled. | |
4099 | ||
56c07345 | 4100 | If ``all`` option is specified, ``ip`` keyword is ignored and, |
96f3485c | 4101 | routes displayed for all AFIs and SAFIs. |
56c07345 | 4102 | if afi is specified, with ``all`` option, routes will be displayed for |
96f3485c MK |
4103 | each SAFI in the selcted AFI |
4104 | ||
bda4a612 TA |
4105 | If a specific prefix is specified, the detailed version of that prefix will |
4106 | be displayed. | |
4107 | ||
1b9d2d60 TA |
4108 | If ``detail`` option is specified, the detailed version of all routes |
4109 | will be displayed. The same format as ``show [ip] bgp [afi] [safi] PREFIX`` | |
4110 | will be used, but for the whole table of received, advertised or filtered | |
4111 | prefixes. | |
4112 | ||
56c07345 | 4113 | If ``json`` option is specified, output is displayed in JSON format. |
96f3485c | 4114 | |
711835d9 DA |
4115 | .. clicmd:: show [ip] bgp [afi] [safi] [all] detail-routes |
4116 | ||
4117 | Display the detailed version of all routes. The same format as using | |
4118 | ``show [ip] bgp [afi] [safi] PREFIX``, but for the whole BGP table. | |
4119 | ||
4120 | If ``all`` option is specified, ``ip`` keyword is ignored and, | |
4121 | routes displayed for all AFIs and SAFIs. | |
4122 | ||
4123 | If ``afi`` is specified, with ``all`` option, routes will be displayed for | |
4124 | each SAFI in the selected AFI. | |
4125 | ||
57e65a80 RR |
4126 | .. clicmd:: show [ip] bgp [<view|vrf> VIEWVRFNAME] [afi] [safi] detail [json] |
4127 | ||
4128 | Display the detailed version of all routes from the specified bgp vrf table | |
4129 | for a given afi + safi. | |
4130 | ||
4131 | If no vrf is specified, then it is assumed as a default vrf and routes | |
4132 | are displayed from default vrf table. | |
4133 | ||
4134 | If ``all`` option is specified as vrf name, then all bgp vrf tables routes | |
4135 | from a given afi+safi are displayed in the detailed output of routes. | |
4136 | ||
4137 | If ``json`` option is specified, detailed output is displayed in JSON format. | |
4138 | ||
4139 | Following are sample output for few examples of how to use this command. | |
4140 | ||
4141 | .. code-block:: frr | |
4142 | ||
4143 | torm-23# sh bgp ipv4 unicast detail (OR) sh bgp vrf default ipv4 unicast detail | |
4144 | ||
4145 | !--- Output suppressed. | |
4146 | ||
4147 | BGP routing table entry for 172.16.16.1/32 | |
4148 | Paths: (1 available, best #1, table default) | |
4149 | Not advertised to any peer | |
4150 | Local, (Received from a RR-client) | |
4151 | 172.16.16.1 (metric 20) from torm-22(172.16.16.1) (192.168.0.10) | |
4152 | Origin IGP, metric 0, localpref 100, valid, internal | |
4153 | Last update: Fri May 8 12:54:05 2023 | |
4154 | BGP routing table entry for 172.16.16.2/32 | |
4155 | Paths: (1 available, best #1, table default) | |
4156 | Not advertised to any peer | |
4157 | Local | |
4158 | 0.0.0.0 from 0.0.0.0 (172.16.16.2) | |
4159 | Origin incomplete, metric 0, weight 32768, valid, sourced, bestpath-from-AS Local, best (First path received) | |
4160 | Last update: Wed May 8 12:54:41 2023 | |
4161 | ||
4162 | Displayed 2 routes and 2 total paths | |
4163 | ||
4164 | .. code-block:: frr | |
4165 | ||
4166 | torm-23# sh bgp vrf all detail | |
4167 | ||
4168 | Instance default: | |
4169 | ||
4170 | !--- Output suppressed. | |
4171 | ||
4172 | BGP routing table entry for 172.16.16.1/32 | |
4173 | Paths: (1 available, best #1, table default) | |
4174 | Not advertised to any peer | |
4175 | Local, (Received from a RR-client) | |
4176 | 172.16.16.1 (metric 20) from torm-22(172.16.16.1) (192.168.0.10) | |
4177 | Origin IGP, metric 0, localpref 100, valid, internal | |
4178 | Last update: Fri May 8 12:44:05 2023 | |
4179 | BGP routing table entry for 172.16.16.2/32 | |
4180 | Paths: (1 available, best #1, table default) | |
4181 | Not advertised to any peer | |
4182 | Local | |
4183 | 0.0.0.0 from 0.0.0.0 (172.16.16.2) | |
4184 | Origin incomplete, metric 0, weight 32768, valid, sourced, bestpath-from-AS Local, best (First path received) | |
4185 | Last update: Wed May 8 12:45:01 2023 | |
4186 | ||
4187 | Displayed 2 routes and 2 total paths | |
4188 | ||
4189 | Instance vrf3: | |
4190 | ||
4191 | !--- Output suppressed. | |
4192 | ||
4193 | BGP routing table entry for 192.168.0.2/32 | |
4194 | Paths: (1 available, best #1, vrf vrf3) | |
4195 | Not advertised to any peer | |
4196 | Imported from 172.16.16.1:12:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.0.2], VNI 1008/4003 | |
4197 | Local | |
4198 | 172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self | |
4199 | Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received) | |
4200 | Extended Community: RT:65000:1008 ET:8 Rmac:00:02:00:00:00:58 | |
4201 | Last update: Fri May 8 02:41:55 2023 | |
4202 | BGP routing table entry for 192.168.1.2/32 | |
4203 | Paths: (1 available, best #1, vrf vrf3) | |
4204 | Not advertised to any peer | |
4205 | Imported from 172.16.16.1:13:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.1.2], VNI 1009/4003 | |
4206 | Local | |
4207 | 172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self | |
4208 | Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received) | |
4209 | Extended Community: RT:65000:1009 ET:8 Rmac:00:02:00:00:00:58 | |
4210 | Last update: Fri May 8 02:41:55 2023 | |
4211 | ||
4212 | Displayed 2 routes and 2 total paths | |
4213 | ||
4214 | ||
4215 | .. code-block:: frr | |
4216 | ||
4217 | torm-23# sh bgp vrf vrf3 ipv4 unicast detail | |
4218 | ||
4219 | !--- Output suppressed. | |
4220 | ||
4221 | BGP routing table entry for 192.168.0.2/32 | |
4222 | Paths: (1 available, best #1, vrf vrf3) | |
4223 | Not advertised to any peer | |
4224 | Imported from 172.16.16.1:12:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.0.2], VNI 1008/4003 | |
4225 | Local | |
4226 | 172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self | |
4227 | Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received) | |
4228 | Extended Community: RT:65000:1008 ET:8 Rmac:00:02:00:00:00:58 | |
4229 | Last update: Fri May 8 02:23:35 2023 | |
4230 | BGP routing table entry for 192.168.1.2/32 | |
4231 | Paths: (1 available, best #1, vrf vrf3) | |
4232 | Not advertised to any peer | |
4233 | Imported from 172.16.16.1:13:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.1.2], VNI 1009/4003 | |
4234 | Local | |
4235 | 172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self | |
4236 | Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received) | |
4237 | Extended Community: RT:65000:1009 ET:8 Rmac:00:02:00:00:00:58 | |
4238 | Last update: Fri May 8 02:23:55 2023 | |
4239 | ||
4240 | Displayed 2 routes and 2 total paths | |
4241 | ||
8fcedbd2 | 4242 | .. _bgp-display-routes-by-community: |
42fc5d26 | 4243 | |
8fcedbd2 QY |
4244 | Displaying Routes by Community Attribute |
4245 | ---------------------------------------- | |
42fc5d26 | 4246 | |
8fcedbd2 QY |
4247 | The following commands allow displaying routes based on their community |
4248 | attribute. | |
42fc5d26 | 4249 | |
96f3485c | 4250 | .. clicmd:: show [ip] bgp <ipv4|ipv6> [all] community [wide|json] |
42fc5d26 | 4251 | |
96f3485c | 4252 | .. clicmd:: show [ip] bgp <ipv4|ipv6> [all] community COMMUNITY [wide|json] |
42fc5d26 | 4253 | |
96f3485c | 4254 | .. clicmd:: show [ip] bgp <ipv4|ipv6> [all] community COMMUNITY exact-match [wide|json] |
76bd1499 | 4255 | |
8fcedbd2 QY |
4256 | These commands display BGP routes which have the community attribute. |
4257 | attribute. When ``COMMUNITY`` is specified, BGP routes that match that | |
4258 | community are displayed. When `exact-match` is specified, it display only | |
4259 | routes that have an exact match. | |
c3c5a71f | 4260 | |
70799983 | 4261 | .. clicmd:: show [ip] bgp <ipv4|ipv6> community-list WORD [json] |
42fc5d26 | 4262 | |
70799983 | 4263 | .. clicmd:: show [ip] bgp <ipv4|ipv6> community-list WORD exact-match [json] |
42fc5d26 | 4264 | |
8fcedbd2 QY |
4265 | These commands display BGP routes for the address family specified that |
4266 | match the specified community list. When `exact-match` is specified, it | |
4267 | displays only routes that have an exact match. | |
42fc5d26 | 4268 | |
56c07345 | 4269 | If ``wide`` option is specified, then the prefix table's width is increased |
96f3485c MK |
4270 | to fully display the prefix and the nexthop. |
4271 | ||
4272 | This is especially handy dealing with IPv6 prefixes and | |
4273 | if :clicmd:`[no] bgp default show-nexthop-hostname` is enabled. | |
4274 | ||
56c07345 | 4275 | If ``all`` option is specified, ``ip`` keyword is ignored and, |
96f3485c | 4276 | routes displayed for all AFIs and SAFIs. |
56c07345 | 4277 | if afi is specified, with ``all`` option, routes will be displayed for |
96f3485c MK |
4278 | each SAFI in the selcted AFI |
4279 | ||
56c07345 | 4280 | If ``json`` option is specified, output is displayed in JSON format. |
e3ea6503 | 4281 | |
e3ea6503 PR |
4282 | .. clicmd:: show bgp labelpool <chunks|inuse|ledger|requests|summary> [json] |
4283 | ||
4284 | These commands display information about the BGP labelpool used for | |
4285 | the association of MPLS labels with routes for L3VPN and Labeled Unicast | |
4286 | ||
4287 | If ``chunks`` option is specified, output shows the current list of label | |
4288 | chunks granted to BGP by Zebra, indicating the start and end label in | |
4289 | each chunk | |
4290 | ||
4291 | If ``inuse`` option is specified, output shows the current inuse list of | |
4292 | label to prefix mappings | |
4293 | ||
4294 | If ``ledger`` option is specified, output shows ledger list of all | |
4295 | label requests made per prefix | |
4296 | ||
4297 | If ``requests`` option is specified, output shows current list of label | |
4298 | requests which have not yet been fulfilled by the labelpool | |
4299 | ||
4300 | If ``summary`` option is specified, output is a summary of the counts for | |
4301 | the chunks, inuse, ledger and requests list along with the count of | |
f563acec | 4302 | outstanding chunk requests to Zebra and the number of zebra reconnects |
e3ea6503 PR |
4303 | that have happened |
4304 | ||
4305 | If ``json`` option is specified, output is displayed in JSON format. | |
96f3485c | 4306 | |
36a206db | 4307 | .. _bgp-display-routes-by-lcommunity: |
4308 | ||
4309 | Displaying Routes by Large Community Attribute | |
4310 | ---------------------------------------------- | |
4311 | ||
ac2201bb | 4312 | The following commands allow displaying routes based on their |
36a206db | 4313 | large community attribute. |
4314 | ||
36a206db | 4315 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community |
4316 | ||
36a206db | 4317 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community LARGE-COMMUNITY |
4318 | ||
36a206db | 4319 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community LARGE-COMMUNITY exact-match |
4320 | ||
36a206db | 4321 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community LARGE-COMMUNITY json |
4322 | ||
4323 | These commands display BGP routes which have the large community attribute. | |
4324 | attribute. When ``LARGE-COMMUNITY`` is specified, BGP routes that match that | |
ac2201bb DA |
4325 | large community are displayed. When `exact-match` is specified, it display |
4326 | only routes that have an exact match. When `json` is specified, it display | |
36a206db | 4327 | routes in json format. |
4328 | ||
36a206db | 4329 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community-list WORD |
4330 | ||
36a206db | 4331 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community-list WORD exact-match |
4332 | ||
36a206db | 4333 | .. clicmd:: show [ip] bgp <ipv4|ipv6> large-community-list WORD json |
4334 | ||
4335 | These commands display BGP routes for the address family specified that | |
ac2201bb DA |
4336 | match the specified large community list. When `exact-match` is specified, |
4337 | it displays only routes that have an exact match. When `json` is specified, | |
36a206db | 4338 | it display routes in json format. |
4339 | ||
8fcedbd2 | 4340 | .. _bgp-display-routes-by-as-path: |
42fc5d26 | 4341 | |
36a206db | 4342 | |
8fcedbd2 QY |
4343 | Displaying Routes by AS Path |
4344 | ---------------------------- | |
42fc5d26 | 4345 | |
8fcedbd2 | 4346 | .. clicmd:: show bgp ipv4|ipv6 regexp LINE |
76bd1499 | 4347 | |
8fcedbd2 QY |
4348 | This commands displays BGP routes that matches a regular |
4349 | expression `line` (:ref:`bgp-regular-expressions`). | |
4350 | ||
e6f59415 | 4351 | .. clicmd:: show [ip] bgp ipv4 vpn |
8fcedbd2 | 4352 | |
e6f59415 | 4353 | .. clicmd:: show [ip] bgp ipv6 vpn |
8fcedbd2 QY |
4354 | |
4355 | Print active IPV4 or IPV6 routes advertised via the VPN SAFI. | |
4356 | ||
8fcedbd2 QY |
4357 | .. clicmd:: show bgp ipv4 vpn summary |
4358 | ||
8fcedbd2 QY |
4359 | .. clicmd:: show bgp ipv6 vpn summary |
4360 | ||
4361 | Print a summary of neighbor connections for the specified AFI/SAFI combination. | |
4362 | ||
22bfb2a6 TA |
4363 | Displaying Routes by Route Distinguisher |
4364 | ---------------------------------------- | |
4365 | ||
4366 | .. clicmd:: show bgp [<ipv4|ipv6> vpn | l2vpn evpn [route]] rd <all|RD> | |
4367 | ||
4368 | For L3VPN and EVPN address-families, routes can be displayed on a per-RD | |
4369 | (Route Distinguisher) basis or for all RD's. | |
4370 | ||
4371 | .. clicmd:: show bgp l2vpn evpn rd <all|RD> [overlay | tags] | |
4372 | ||
4373 | Use the ``overlay`` or ``tags`` keywords to display the overlay/tag | |
4374 | information about the EVPN prefixes in the selected Route Distinguisher. | |
4375 | ||
4376 | .. clicmd:: show bgp l2vpn evpn route rd <all|RD> mac <MAC> [ip <MAC>] [json] | |
4377 | ||
4378 | For EVPN Type 2 (macip) routes, a MAC address (and optionally an IP address) | |
4379 | can be supplied to the command to only display matching prefixes in the | |
4380 | specified RD. | |
4381 | ||
09d78f10 DS |
4382 | Displaying Update Group Information |
4383 | ----------------------------------- | |
4384 | ||
6c5be52a | 4385 | .. clicmd:: show bgp update-groups [advertise-queue|advertised-routes|packet-queue] |
09d78f10 DS |
4386 | |
4387 | Display Information about each individual update-group being used. | |
4388 | If SUBGROUP-ID is specified only display about that particular group. If | |
4389 | advertise-queue is specified the list of routes that need to be sent | |
4390 | to the peers in the update-group is displayed, advertised-routes means | |
a64e0ee5 | 4391 | the list of routes we have sent to the peers in the update-group and |
09d78f10 DS |
4392 | packet-queue specifies the list of packets in the queue to be sent. |
4393 | ||
6c5be52a | 4394 | .. clicmd:: show bgp update-groups statistics |
09d78f10 DS |
4395 | |
4396 | Display Information about update-group events in FRR. | |
8fcedbd2 | 4397 | |
bf85e4c5 | 4398 | Displaying Nexthop Information |
57e3f784 | 4399 | ------------------------------ |
071ec807 PJD |
4400 | .. clicmd:: show [ip] bgp [<view|vrf> VIEWVRFNAME] nexthop ipv4 [A.B.C.D] [detail] [json] |
4401 | ||
4402 | .. clicmd:: show [ip] bgp [<view|vrf> VIEWVRFNAME] nexthop ipv6 [X:X::X:X] [detail] [json] | |
bf85e4c5 PJD |
4403 | |
4404 | .. clicmd:: show [ip] bgp [<view|vrf> VIEWVRFNAME] nexthop [<A.B.C.D|X:X::X:X>] [detail] [json] | |
4405 | ||
4406 | .. clicmd:: show [ip] bgp <view|vrf> all nexthop [json] | |
4407 | ||
4408 | Display information about nexthops to bgp neighbors. If a certain nexthop is | |
4409 | specified, also provides information about paths associated with the nexthop. | |
4410 | With detail option provides information about gates of each nexthop. | |
4411 | ||
4412 | .. clicmd:: show [ip] bgp [<view|vrf> VIEWVRFNAME] import-check-table [detail] [json] | |
4413 | ||
4414 | Display information about nexthops from table that is used to check network's | |
4415 | existence in the rib for network statements. | |
4416 | ||
4ccd4033 HS |
4417 | Segment-Routing IPv6 |
4418 | -------------------- | |
4419 | ||
4420 | .. clicmd:: show bgp segment-routing srv6 | |
4421 | ||
4422 | This command displays information about SRv6 L3VPN in bgpd. Specifically, | |
4423 | what kind of Locator is being used, and its Locator chunk information. | |
4424 | And the SID of the SRv6 Function that is actually managed on bgpd. | |
4425 | In the following example, bgpd is using a Locator named loc1, and two SRv6 | |
4426 | Functions are managed to perform VPNv6 VRF redirect for vrf10 and vrf20. | |
4427 | ||
4428 | :: | |
4429 | ||
4430 | router# show bgp segment-routing srv6 | |
4431 | locator_name: loc1 | |
4432 | locator_chunks: | |
4433 | - 2001:db8:1:1::/64 | |
4434 | functions: | |
4435 | - sid: 2001:db8:1:1::100 | |
4436 | locator: loc1 | |
4437 | - sid: 2001:db8:1:1::200 | |
4438 | locator: loc1 | |
4439 | bgps: | |
4440 | - name: default | |
4441 | vpn_policy[AFI_IP].tovpn_sid: none | |
4442 | vpn_policy[AFI_IP6].tovpn_sid: none | |
4443 | - name: vrf10 | |
4444 | vpn_policy[AFI_IP].tovpn_sid: none | |
4445 | vpn_policy[AFI_IP6].tovpn_sid: 2001:db8:1:1::100 | |
4446 | - name: vrf20 | |
4447 | vpn_policy[AFI_IP].tovpn_sid: none | |
4448 | vpn_policy[AFI_IP6].tovpn_sid: 2001:db8:1:1::200 | |
4449 | ||
e55b0883 PG |
4450 | AS-notation support |
4451 | ------------------- | |
4452 | ||
4453 | By default, the ASN value output follows how the BGP ASN instance is | |
4454 | expressed in the configuration. Three as-notation outputs are available: | |
4455 | ||
4456 | - plain output: both AS4B and AS2B use a single number. | |
4457 | ` router bgp 65536`. | |
4458 | ||
4459 | - dot output: AS4B values are using two numbers separated by a period. | |
4460 | `router bgp 1.1` means that the AS number is 65536. | |
4461 | ||
4462 | - dot+ output: AS2B and AS4B values are using two numbers separated by a | |
4463 | period. `router bgp 0.5` means that the AS number is 5. | |
4464 | ||
4465 | The below option permits forcing the as-notation output: | |
4466 | ||
4467 | .. clicmd:: router bgp ASN as-notation dot|dot+|plain | |
4468 | ||
4469 | The chosen as-notation format will override the BGP ASN output. | |
4ccd4033 | 4470 | |
8fcedbd2 QY |
4471 | .. _bgp-route-reflector: |
4472 | ||
4473 | Route Reflector | |
4474 | =============== | |
4475 | ||
749afd7d RF |
4476 | BGP routers connected inside the same AS through BGP belong to an internal |
4477 | BGP session, or IBGP. In order to prevent routing table loops, IBGP does not | |
4478 | advertise IBGP-learned routes to other routers in the same session. As such, | |
4479 | IBGP requires a full mesh of all peers. For large networks, this quickly becomes | |
4480 | unscalable. Introducing route reflectors removes the need for the full-mesh. | |
8fcedbd2 | 4481 | |
749afd7d RF |
4482 | When route reflectors are configured, these will reflect the routes announced |
4483 | by the peers configured as clients. A route reflector client is configured | |
4484 | with: | |
8fcedbd2 | 4485 | |
8fcedbd2 QY |
4486 | .. clicmd:: neighbor PEER route-reflector-client |
4487 | ||
c3c5a71f | 4488 | |
749afd7d RF |
4489 | To avoid single points of failure, multiple route reflectors can be configured. |
4490 | ||
4491 | A cluster is a collection of route reflectors and their clients, and is used | |
4492 | by route reflectors to avoid looping. | |
4493 | ||
749afd7d | 4494 | .. clicmd:: bgp cluster-id A.B.C.D |
42fc5d26 | 4495 | |
03750f1e | 4496 | .. clicmd:: bgp no-rib |
8dad2243 DS |
4497 | |
4498 | To set and unset the BGP daemon ``-n`` / ``--no_kernel`` options during runtime | |
4499 | to disable BGP route installation to the RIB (Zebra), the ``[no] bgp no-rib`` | |
4500 | commands can be used; | |
4501 | ||
4502 | Please note that setting the option during runtime will withdraw all routes in | |
4503 | the daemons RIB from Zebra and unsetting it will announce all routes in the | |
4504 | daemons RIB to Zebra. If the option is passed as a command line argument when | |
4505 | starting the daemon and the configuration gets saved, the option will persist | |
4506 | unless removed from the configuration with the negating command prior to the | |
56b91d10 DS |
4507 | configuration write operation. At this point in time non SAFI_UNICAST BGP |
4508 | data is not properly withdrawn from zebra when this command is issued. | |
8dad2243 | 4509 | |
8666265e DS |
4510 | .. clicmd:: bgp allow-martian-nexthop |
4511 | ||
4512 | When a peer receives a martian nexthop as part of the NLRI for a route | |
4513 | permit the nexthop to be used as such, instead of rejecting and resetting | |
4514 | the connection. | |
4515 | ||
03750f1e | 4516 | .. clicmd:: bgp send-extra-data zebra |
9a06c157 | 4517 | |
870791a3 IR |
4518 | This command turns on the ability of BGP to send extra data to zebra. Currently, |
4519 | it's the AS-Path, communities, and the path selection reason. The default | |
4520 | behavior in BGP is not to send this data. If the routes were sent to zebra and | |
4521 | the option is changed, bgpd doesn't reinstall the routes to comply with the new | |
4522 | setting. | |
9a06c157 | 4523 | |
425bd64b PS |
4524 | .. clicmd:: bgp session-dscp (0-63) |
4525 | ||
4526 | This command allows bgp to control, at a global level, the TCP dscp values | |
4527 | in the TCP header. | |
4528 | ||
1cc55938 S |
4529 | .. _bgp-suppress-fib: |
4530 | ||
4531 | Suppressing routes not installed in FIB | |
4532 | ======================================= | |
4533 | ||
4534 | The FRR implementation of BGP advertises prefixes learnt from a peer to other | |
4535 | peers even if the routes do not get installed in the FIB. There can be | |
4536 | scenarios where the hardware tables in some of the routers (along the path from | |
4537 | the source to destination) is full which will result in all routes not getting | |
4538 | installed in the FIB. If these routes are advertised to the downstream routers | |
4539 | then traffic will start flowing and will be dropped at the intermediate router. | |
4540 | ||
4541 | The solution is to provide a configurable option to check for the FIB install | |
4542 | status of the prefixes and advertise to peers if the prefixes are successfully | |
4543 | installed in the FIB. The advertisement of the prefixes are suppressed if it is | |
4544 | not installed in FIB. | |
4545 | ||
4546 | The following conditions apply will apply when checking for route installation | |
4547 | status in FIB: | |
0ea5223c | 4548 | |
1cc55938 S |
4549 | 1. The advertisement or suppression of routes based on FIB install status |
4550 | applies only for newly learnt routes from peer (routes which are not in | |
4551 | BGP local RIB). | |
4552 | 2. If the route received from peer already exists in BGP local RIB and route | |
4553 | attributes have changed (best path changed), the old path is deleted and | |
4554 | new path is installed in FIB. The FIB install status will not have any | |
4555 | effect. Therefore only when the route is received first time the checks | |
4556 | apply. | |
4557 | 3. The feature will not apply for routes learnt through other means like | |
4558 | redistribution to bgp from other protocols. This is applicable only to | |
4559 | peer learnt routes. | |
4560 | 4. If a route is installed in FIB and then gets deleted from the dataplane, | |
4561 | then routes will not be withdrawn from peers. This will be considered as | |
4562 | dataplane issue. | |
4563 | 5. The feature will slightly increase the time required to advertise the routes | |
4564 | to peers since the route install status needs to be received from the FIB | |
4565 | 6. If routes are received by the peer before the configuration is applied, then | |
4566 | the bgp sessions need to be reset for the configuration to take effect. | |
4567 | 7. If the route which is already installed in dataplane is removed for some | |
4568 | reason, sending withdraw message to peers is not currently supported. | |
4569 | ||
03750f1e | 4570 | .. clicmd:: bgp suppress-fib-pending |
8dad2243 | 4571 | |
4f4ba68c DS |
4572 | This command is applicable at the global level and at an individual |
4573 | bgp level. If applied at the global level all bgp instances will | |
4574 | wait for fib installation before announcing routes and there is no | |
4575 | way to turn it off for a particular bgp vrf. | |
4576 | ||
0efdf0fe | 4577 | .. _routing-policy: |
42fc5d26 | 4578 | |
8fcedbd2 QY |
4579 | Routing Policy |
4580 | ============== | |
42fc5d26 | 4581 | |
4da7fda3 | 4582 | You can set different routing policy for a peer. For example, you can set |
9eb95b3b QY |
4583 | different filter for a peer. |
4584 | ||
4585 | .. code-block:: frr | |
c1a54c05 | 4586 | |
c1a54c05 QY |
4587 | ! |
4588 | router bgp 1 view 1 | |
4589 | neighbor 10.0.0.1 remote-as 2 | |
4590 | address-family ipv4 unicast | |
4591 | neighbor 10.0.0.1 distribute-list 1 in | |
4592 | exit-address-family | |
4593 | ! | |
4594 | router bgp 1 view 2 | |
4595 | neighbor 10.0.0.1 remote-as 2 | |
4596 | address-family ipv4 unicast | |
4597 | neighbor 10.0.0.1 distribute-list 2 in | |
4598 | exit-address-family | |
c3c5a71f | 4599 | |
4da7fda3 QY |
4600 | This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view 2. |
4601 | When the update is inserted into view 1, distribute-list 1 is applied. On the | |
4602 | other hand, when the update is inserted into view 2, distribute-list 2 is | |
4603 | applied. | |
42fc5d26 | 4604 | |
42fc5d26 | 4605 | |
0efdf0fe | 4606 | .. _bgp-regular-expressions: |
42fc5d26 QY |
4607 | |
4608 | BGP Regular Expressions | |
4609 | ======================= | |
4610 | ||
8fcedbd2 QY |
4611 | BGP regular expressions are based on :t:`POSIX 1003.2` regular expressions. The |
4612 | following description is just a quick subset of the POSIX regular expressions. | |
42fc5d26 QY |
4613 | |
4614 | ||
8fcedbd2 | 4615 | .\* |
c1a54c05 | 4616 | Matches any single character. |
42fc5d26 | 4617 | |
8fcedbd2 | 4618 | \* |
c1a54c05 | 4619 | Matches 0 or more occurrences of pattern. |
42fc5d26 | 4620 | |
8fcedbd2 | 4621 | \+ |
c1a54c05 | 4622 | Matches 1 or more occurrences of pattern. |
42fc5d26 QY |
4623 | |
4624 | ? | |
c1a54c05 | 4625 | Match 0 or 1 occurrences of pattern. |
42fc5d26 QY |
4626 | |
4627 | ^ | |
c1a54c05 | 4628 | Matches the beginning of the line. |
42fc5d26 QY |
4629 | |
4630 | $ | |
c1a54c05 | 4631 | Matches the end of the line. |
42fc5d26 QY |
4632 | |
4633 | _ | |
8fcedbd2 QY |
4634 | The ``_`` character has special meanings in BGP regular expressions. It |
4635 | matches to space and comma , and AS set delimiter ``{`` and ``}`` and AS | |
4636 | confederation delimiter ``(`` and ``)``. And it also matches to the | |
4637 | beginning of the line and the end of the line. So ``_`` can be used for AS | |
4638 | value boundaries match. This character technically evaluates to | |
4639 | ``(^|[,{}()]|$)``. | |
42fc5d26 | 4640 | |
42fc5d26 | 4641 | |
c1a54c05 | 4642 | .. _bgp-configuration-examples: |
42fc5d26 | 4643 | |
8fcedbd2 QY |
4644 | Miscellaneous Configuration Examples |
4645 | ==================================== | |
42fc5d26 | 4646 | |
9eb95b3b QY |
4647 | Example of a session to an upstream, advertising only one prefix to it. |
4648 | ||
4649 | .. code-block:: frr | |
42fc5d26 | 4650 | |
c1a54c05 QY |
4651 | router bgp 64512 |
4652 | bgp router-id 10.236.87.1 | |
4653 | neighbor upstream peer-group | |
4654 | neighbor upstream remote-as 64515 | |
4655 | neighbor upstream capability dynamic | |
4656 | neighbor 10.1.1.1 peer-group upstream | |
4657 | neighbor 10.1.1.1 description ACME ISP | |
c3c5a71f | 4658 | |
c1a54c05 QY |
4659 | address-family ipv4 unicast |
4660 | network 10.236.87.0/24 | |
4661 | neighbor upstream prefix-list pl-allowed-adv out | |
4662 | exit-address-family | |
4663 | ! | |
4664 | ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25 | |
4665 | ip prefix-list pl-allowed-adv seq 10 deny any | |
42fc5d26 | 4666 | |
aa9eafa4 QY |
4667 | A more complex example including upstream, peer and customer sessions |
4668 | advertising global prefixes and NO_EXPORT prefixes and providing actions for | |
4669 | customer routes based on community values. Extensive use is made of route-maps | |
4670 | and the 'call' feature to support selective advertising of prefixes. This | |
4671 | example is intended as guidance only, it has NOT been tested and almost | |
4672 | certainly contains silly mistakes, if not serious flaws. | |
42fc5d26 | 4673 | |
9eb95b3b | 4674 | .. code-block:: frr |
42fc5d26 | 4675 | |
c1a54c05 QY |
4676 | router bgp 64512 |
4677 | bgp router-id 10.236.87.1 | |
4678 | neighbor upstream capability dynamic | |
4679 | neighbor cust capability dynamic | |
4680 | neighbor peer capability dynamic | |
4681 | neighbor 10.1.1.1 remote-as 64515 | |
4682 | neighbor 10.1.1.1 peer-group upstream | |
4683 | neighbor 10.2.1.1 remote-as 64516 | |
4684 | neighbor 10.2.1.1 peer-group upstream | |
4685 | neighbor 10.3.1.1 remote-as 64517 | |
4686 | neighbor 10.3.1.1 peer-group cust-default | |
4687 | neighbor 10.3.1.1 description customer1 | |
4688 | neighbor 10.4.1.1 remote-as 64518 | |
4689 | neighbor 10.4.1.1 peer-group cust | |
4690 | neighbor 10.4.1.1 description customer2 | |
4691 | neighbor 10.5.1.1 remote-as 64519 | |
4692 | neighbor 10.5.1.1 peer-group peer | |
4693 | neighbor 10.5.1.1 description peer AS 1 | |
4694 | neighbor 10.6.1.1 remote-as 64520 | |
4695 | neighbor 10.6.1.1 peer-group peer | |
4696 | neighbor 10.6.1.1 description peer AS 2 | |
4697 | ||
4698 | address-family ipv4 unicast | |
4699 | network 10.123.456.0/24 | |
4700 | network 10.123.456.128/25 route-map rm-no-export | |
4701 | neighbor upstream route-map rm-upstream-out out | |
4702 | neighbor cust route-map rm-cust-in in | |
4703 | neighbor cust route-map rm-cust-out out | |
4704 | neighbor cust send-community both | |
4705 | neighbor peer route-map rm-peer-in in | |
4706 | neighbor peer route-map rm-peer-out out | |
4707 | neighbor peer send-community both | |
4708 | neighbor 10.3.1.1 prefix-list pl-cust1-network in | |
4709 | neighbor 10.4.1.1 prefix-list pl-cust2-network in | |
4710 | neighbor 10.5.1.1 prefix-list pl-peer1-network in | |
4711 | neighbor 10.6.1.1 prefix-list pl-peer2-network in | |
4712 | exit-address-family | |
4713 | ! | |
4714 | ip prefix-list pl-default permit 0.0.0.0/0 | |
4715 | ! | |
4716 | ip prefix-list pl-upstream-peers permit 10.1.1.1/32 | |
4717 | ip prefix-list pl-upstream-peers permit 10.2.1.1/32 | |
4718 | ! | |
4719 | ip prefix-list pl-cust1-network permit 10.3.1.0/24 | |
4720 | ip prefix-list pl-cust1-network permit 10.3.2.0/24 | |
4721 | ! | |
4722 | ip prefix-list pl-cust2-network permit 10.4.1.0/24 | |
4723 | ! | |
4724 | ip prefix-list pl-peer1-network permit 10.5.1.0/24 | |
4725 | ip prefix-list pl-peer1-network permit 10.5.2.0/24 | |
4726 | ip prefix-list pl-peer1-network permit 192.168.0.0/24 | |
4727 | ! | |
4728 | ip prefix-list pl-peer2-network permit 10.6.1.0/24 | |
4729 | ip prefix-list pl-peer2-network permit 10.6.2.0/24 | |
4730 | ip prefix-list pl-peer2-network permit 192.168.1.0/24 | |
4731 | ip prefix-list pl-peer2-network permit 192.168.2.0/24 | |
4732 | ip prefix-list pl-peer2-network permit 172.16.1/24 | |
4733 | ! | |
e6e62ee5 CS |
4734 | bgp as-path access-list seq 5 asp-own-as permit ^$ |
4735 | bgp as-path access-list seq 10 asp-own-as permit _64512_ | |
c1a54c05 QY |
4736 | ! |
4737 | ! ################################################################# | |
4738 | ! Match communities we provide actions for, on routes receives from | |
4739 | ! customers. Communities values of <our-ASN>:X, with X, have actions: | |
4740 | ! | |
4741 | ! 100 - blackhole the prefix | |
4742 | ! 200 - set no_export | |
4743 | ! 300 - advertise only to other customers | |
4744 | ! 400 - advertise only to upstreams | |
4745 | ! 500 - set no_export when advertising to upstreams | |
4746 | ! 2X00 - set local_preference to X00 | |
4747 | ! | |
4748 | ! blackhole the prefix of the route | |
a64e0ee5 | 4749 | bgp community-list standard cm-blackhole permit 64512:100 |
c1a54c05 QY |
4750 | ! |
4751 | ! set no-export community before advertising | |
a64e0ee5 | 4752 | bgp community-list standard cm-set-no-export permit 64512:200 |
c1a54c05 QY |
4753 | ! |
4754 | ! advertise only to other customers | |
a64e0ee5 | 4755 | bgp community-list standard cm-cust-only permit 64512:300 |
c1a54c05 QY |
4756 | ! |
4757 | ! advertise only to upstreams | |
a64e0ee5 | 4758 | bgp community-list standard cm-upstream-only permit 64512:400 |
c1a54c05 QY |
4759 | ! |
4760 | ! advertise to upstreams with no-export | |
a64e0ee5 | 4761 | bgp community-list standard cm-upstream-noexport permit 64512:500 |
c1a54c05 QY |
4762 | ! |
4763 | ! set local-pref to least significant 3 digits of the community | |
a64e0ee5 DA |
4764 | bgp community-list standard cm-prefmod-100 permit 64512:2100 |
4765 | bgp community-list standard cm-prefmod-200 permit 64512:2200 | |
4766 | bgp community-list standard cm-prefmod-300 permit 64512:2300 | |
4767 | bgp community-list standard cm-prefmod-400 permit 64512:2400 | |
4768 | bgp community-list expanded cme-prefmod-range permit 64512:2... | |
c1a54c05 QY |
4769 | ! |
4770 | ! Informational communities | |
4771 | ! | |
4772 | ! 3000 - learned from upstream | |
4773 | ! 3100 - learned from customer | |
4774 | ! 3200 - learned from peer | |
4775 | ! | |
a64e0ee5 DA |
4776 | bgp community-list standard cm-learnt-upstream permit 64512:3000 |
4777 | bgp community-list standard cm-learnt-cust permit 64512:3100 | |
4778 | bgp community-list standard cm-learnt-peer permit 64512:3200 | |
c1a54c05 QY |
4779 | ! |
4780 | ! ################################################################### | |
4781 | ! Utility route-maps | |
4782 | ! | |
4783 | ! These utility route-maps generally should not used to permit/deny | |
4784 | ! routes, i.e. they do not have meaning as filters, and hence probably | |
4785 | ! should be used with 'on-match next'. These all finish with an empty | |
4786 | ! permit entry so as not interfere with processing in the caller. | |
4787 | ! | |
4788 | route-map rm-no-export permit 10 | |
4789 | set community additive no-export | |
4790 | route-map rm-no-export permit 20 | |
4791 | ! | |
4792 | route-map rm-blackhole permit 10 | |
f6aa36f5 | 4793 | description blackhole, up-pref and ensure it cannot escape this AS |
c1a54c05 QY |
4794 | set ip next-hop 127.0.0.1 |
4795 | set local-preference 10 | |
4796 | set community additive no-export | |
4797 | route-map rm-blackhole permit 20 | |
4798 | ! | |
4799 | ! Set local-pref as requested | |
4800 | route-map rm-prefmod permit 10 | |
4801 | match community cm-prefmod-100 | |
4802 | set local-preference 100 | |
4803 | route-map rm-prefmod permit 20 | |
4804 | match community cm-prefmod-200 | |
4805 | set local-preference 200 | |
4806 | route-map rm-prefmod permit 30 | |
4807 | match community cm-prefmod-300 | |
4808 | set local-preference 300 | |
4809 | route-map rm-prefmod permit 40 | |
4810 | match community cm-prefmod-400 | |
4811 | set local-preference 400 | |
4812 | route-map rm-prefmod permit 50 | |
4813 | ! | |
4814 | ! Community actions to take on receipt of route. | |
4815 | route-map rm-community-in permit 10 | |
4816 | description check for blackholing, no point continuing if it matches. | |
4817 | match community cm-blackhole | |
4818 | call rm-blackhole | |
4819 | route-map rm-community-in permit 20 | |
4820 | match community cm-set-no-export | |
4821 | call rm-no-export | |
4822 | on-match next | |
4823 | route-map rm-community-in permit 30 | |
4824 | match community cme-prefmod-range | |
4825 | call rm-prefmod | |
4826 | route-map rm-community-in permit 40 | |
4827 | ! | |
4828 | ! ##################################################################### | |
4829 | ! Community actions to take when advertising a route. | |
4830 | ! These are filtering route-maps, | |
4831 | ! | |
4832 | ! Deny customer routes to upstream with cust-only set. | |
4833 | route-map rm-community-filt-to-upstream deny 10 | |
4834 | match community cm-learnt-cust | |
4835 | match community cm-cust-only | |
4836 | route-map rm-community-filt-to-upstream permit 20 | |
4837 | ! | |
4838 | ! Deny customer routes to other customers with upstream-only set. | |
4839 | route-map rm-community-filt-to-cust deny 10 | |
4840 | match community cm-learnt-cust | |
4841 | match community cm-upstream-only | |
4842 | route-map rm-community-filt-to-cust permit 20 | |
4843 | ! | |
4844 | ! ################################################################### | |
4845 | ! The top-level route-maps applied to sessions. Further entries could | |
4846 | ! be added obviously.. | |
4847 | ! | |
4848 | ! Customers | |
4849 | route-map rm-cust-in permit 10 | |
4850 | call rm-community-in | |
4851 | on-match next | |
4852 | route-map rm-cust-in permit 20 | |
4853 | set community additive 64512:3100 | |
4854 | route-map rm-cust-in permit 30 | |
4855 | ! | |
4856 | route-map rm-cust-out permit 10 | |
4857 | call rm-community-filt-to-cust | |
4858 | on-match next | |
4859 | route-map rm-cust-out permit 20 | |
4860 | ! | |
4861 | ! Upstream transit ASes | |
4862 | route-map rm-upstream-out permit 10 | |
4863 | description filter customer prefixes which are marked cust-only | |
4864 | call rm-community-filt-to-upstream | |
4865 | on-match next | |
4866 | route-map rm-upstream-out permit 20 | |
4867 | description only customer routes are provided to upstreams/peers | |
4868 | match community cm-learnt-cust | |
4869 | ! | |
4870 | ! Peer ASes | |
4871 | ! outbound policy is same as for upstream | |
4872 | route-map rm-peer-out permit 10 | |
4873 | call rm-upstream-out | |
4874 | ! | |
4875 | route-map rm-peer-in permit 10 | |
4876 | set community additive 64512:3200 | |
c3c5a71f | 4877 | |
8fcedbd2 QY |
4878 | |
4879 | Example of how to set up a 6-Bone connection. | |
4880 | ||
4881 | .. code-block:: frr | |
4882 | ||
4883 | ! bgpd configuration | |
4884 | ! ================== | |
4885 | ! | |
4886 | ! MP-BGP configuration | |
4887 | ! | |
4888 | router bgp 7675 | |
4889 | bgp router-id 10.0.0.1 | |
4890 | neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as `as-number` | |
4891 | ! | |
4892 | address-family ipv6 | |
4893 | network 3ffe:506::/32 | |
4894 | neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate | |
4895 | neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out | |
4896 | neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as `as-number` | |
4897 | neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out | |
4898 | exit-address-family | |
4899 | ! | |
4900 | ipv6 access-list all permit any | |
4901 | ! | |
4902 | ! Set output nexthop address. | |
4903 | ! | |
4904 | route-map set-nexthop permit 10 | |
4905 | match ipv6 address all | |
4906 | set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225 | |
4907 | set ipv6 nexthop local fe80::2c0:4fff:fe68:a225 | |
4908 | ! | |
4909 | log file bgpd.log | |
4910 | ! | |
4911 | ||
4ab46701 AR |
4912 | .. _bgp-tcp-mss: |
4913 | ||
4914 | BGP tcp-mss support | |
4915 | =================== | |
4916 | TCP provides a mechanism for the user to specify the max segment size. | |
4917 | setsockopt API is used to set the max segment size for TCP session. We | |
4918 | can configure this as part of BGP neighbor configuration. | |
4919 | ||
4920 | This document explains how to avoid ICMP vulnerability issues by limiting | |
4921 | TCP max segment size when you are using MTU discovery. Using MTU discovery | |
4922 | on TCP paths is one method of avoiding BGP packet fragmentation. | |
4923 | ||
4924 | TCP negotiates a maximum segment size (MSS) value during session connection | |
4925 | establishment between two peers. The MSS value negotiated is primarily based | |
073b7664 DA |
4926 | on the maximum transmission unit (MTU) of the interfaces to which the |
4927 | communicating peers are directly connected. However, due to variations in | |
4928 | link MTU on the path taken by the TCP packets, some packets in the network | |
4ab46701 | 4929 | that are well within the MSS value might be fragmented when the packet size |
073b7664 | 4930 | exceeds the link's MTU. |
4ab46701 AR |
4931 | |
4932 | This feature is supported with TCP over IPv4 and TCP over IPv6. | |
4933 | ||
4934 | CLI Configuration: | |
4935 | ------------------ | |
4936 | Below configuration can be done in router bgp mode and allows the user to | |
4937 | configure the tcp-mss value per neighbor. The configuration gets applied | |
4938 | only after hard reset is performed on that neighbor. If we configure tcp-mss | |
4939 | on both the neighbors then both neighbors need to be reset. | |
4940 | ||
4941 | The configuration takes effect based on below rules, so there is a configured | |
4942 | tcp-mss and a synced tcp-mss value per TCP session. | |
4943 | ||
4944 | By default if the configuration is not done then the TCP max segment size is | |
4945 | set to the Maximum Transmission unit (MTU) – (IP/IP6 header size + TCP header | |
4946 | size + ethernet header). For IPv4 its MTU – (20 bytes IP header + 20 bytes TCP | |
4947 | header + 12 bytes ethernet header) and for IPv6 its MTU – (40 bytes IPv6 header | |
4948 | + 20 bytes TCP header + 12 bytes ethernet header). | |
4949 | ||
073b7664 | 4950 | If the config is done then it reduces 12-14 bytes for the ether header and |
4ab46701 AR |
4951 | uses it after synchronizing in TCP handshake. |
4952 | ||
4953 | .. clicmd:: neighbor <A.B.C.D|X:X::X:X|WORD> tcp-mss (1-65535) | |
4954 | ||
4955 | When tcp-mss is configured kernel reduces 12-14 bytes for ethernet header. | |
4956 | E.g. if tcp-mss is configured as 150 the synced value will be 138. | |
4957 | ||
4958 | Note: configured and synced value is different since TCP module will reduce | |
4959 | 12 bytes for ethernet header. | |
4960 | ||
4961 | Running config: | |
4962 | --------------- | |
4963 | ||
4964 | .. code-block:: frr | |
4965 | ||
073b7664 | 4966 | frr# show running-config |
4ab46701 AR |
4967 | Building configuration... |
4968 | ||
4969 | Current configuration: | |
4970 | ! | |
4971 | router bgp 100 | |
4972 | bgp router-id 192.0.2.1 | |
4973 | neighbor 198.51.100.2 remote-as 100 | |
4974 | neighbor 198.51.100.2 tcp-mss 150 => new entry | |
4975 | neighbor 2001:DB8::2 remote-as 100 | |
4976 | neighbor 2001:DB8::2 tcp-mss 400 => new entry | |
4977 | ||
4978 | Show command: | |
4979 | ------------- | |
4980 | ||
4981 | .. code-block:: frr | |
4982 | ||
073b7664 | 4983 | frr# show bgp neighbors 198.51.100.2 |
4ab46701 AR |
4984 | BGP neighbor is 198.51.100.2, remote AS 100, local AS 100, internal link |
4985 | Hostname: frr | |
4986 | BGP version 4, remote router ID 192.0.2.2, local router ID 192.0.2.1 | |
4987 | BGP state = Established, up for 02:15:28 | |
4988 | Last read 00:00:28, Last write 00:00:28 | |
4989 | Hold time is 180, keepalive interval is 60 seconds | |
4990 | Configured tcp-mss is 150, synced tcp-mss is 138 => new display | |
4991 | ||
4992 | .. code-block:: frr | |
4993 | ||
073b7664 | 4994 | frr# show bgp neighbors 2001:DB8::2 |
4ab46701 AR |
4995 | BGP neighbor is 2001:DB8::2, remote AS 100, local AS 100, internal link |
4996 | Hostname: frr | |
4997 | BGP version 4, remote router ID 192.0.2.2, local router ID 192.0.2.1 | |
4998 | BGP state = Established, up for 02:16:34 | |
4999 | Last read 00:00:34, Last write 00:00:34 | |
5000 | Hold time is 180, keepalive interval is 60 seconds | |
5001 | Configured tcp-mss is 400, synced tcp-mss is 388 => new display | |
5002 | ||
5003 | Show command json output: | |
5004 | ------------------------- | |
5005 | ||
5006 | .. code-block:: frr | |
5007 | ||
073b7664 | 5008 | frr# show bgp neighbors 2001:DB8::2 json |
4ab46701 AR |
5009 | { |
5010 | "2001:DB8::2":{ | |
5011 | "remoteAs":100, | |
5012 | "localAs":100, | |
5013 | "nbrInternalLink":true, | |
5014 | "hostname":"frr", | |
5015 | "bgpVersion":4, | |
5016 | "remoteRouterId":"192.0.2.2", | |
5017 | "localRouterId":"192.0.2.1", | |
5018 | "bgpState":"Established", | |
5019 | "bgpTimerUpMsec":8349000, | |
5020 | "bgpTimerUpString":"02:19:09", | |
5021 | "bgpTimerUpEstablishedEpoch":1613054251, | |
5022 | "bgpTimerLastRead":9000, | |
5023 | "bgpTimerLastWrite":9000, | |
5024 | "bgpInUpdateElapsedTimeMsecs":8347000, | |
5025 | "bgpTimerHoldTimeMsecs":180000, | |
5026 | "bgpTimerKeepAliveIntervalMsecs":60000, | |
5027 | "bgpTcpMssConfigured":400, => new entry | |
5028 | "bgpTcpMssSynced":388, => new entry | |
5029 | ||
5030 | .. code-block:: frr | |
5031 | ||
073b7664 | 5032 | frr# show bgp neighbors 198.51.100.2 json |
4ab46701 AR |
5033 | { |
5034 | "198.51.100.2":{ | |
5035 | "remoteAs":100, | |
5036 | "localAs":100, | |
5037 | "nbrInternalLink":true, | |
5038 | "hostname":"frr", | |
5039 | "bgpVersion":4, | |
5040 | "remoteRouterId":"192.0.2.2", | |
5041 | "localRouterId":"192.0.2.1", | |
5042 | "bgpState":"Established", | |
5043 | "bgpTimerUpMsec":8370000, | |
5044 | "bgpTimerUpString":"02:19:30", | |
5045 | "bgpTimerUpEstablishedEpoch":1613054251, | |
5046 | "bgpTimerLastRead":30000, | |
5047 | "bgpTimerLastWrite":30000, | |
5048 | "bgpInUpdateElapsedTimeMsecs":8368000, | |
5049 | "bgpTimerHoldTimeMsecs":180000, | |
5050 | "bgpTimerKeepAliveIntervalMsecs":60000, | |
5051 | "bgpTcpMssConfigured":150, => new entry | |
5052 | "bgpTcpMssSynced":138, => new entry | |
8fcedbd2 | 5053 | |
9e146a81 | 5054 | .. include:: routeserver.rst |
f3817860 QY |
5055 | |
5056 | .. include:: rpki.rst | |
c1a54c05 | 5057 | |
ed647ed2 | 5058 | .. include:: wecmp_linkbw.rst |
5059 | ||
00458d01 PG |
5060 | .. include:: flowspec.rst |
5061 | ||
d1e7591e | 5062 | .. [#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) |
c1a54c05 QY |
5063 | .. [bgp-route-osci-cond] McPherson, D. and Gill, V. and Walton, D., "Border Gateway Protocol (BGP) Persistent Route Oscillation Condition", IETF RFC3345 |
5064 | .. [stable-flexible-ibgp] Flavel, A. and M. Roughan, "Stable and flexible iBGP", ACM SIGCOMM 2009 | |
5065 | .. [ibgp-correctness] Griffin, T. and G. Wilfong, "On the correctness of IBGP configuration", ACM SIGCOMM 2002 | |
5874235f PG |
5066 | |
5067 | .. _bgp-fast-convergence: | |
5068 | ||
5069 | BGP fast-convergence support | |
5070 | ============================ | |
5071 | Whenever BGP peer address becomes unreachable we must bring down the BGP | |
7cb0494d DA |
5072 | session immediately. Currently only single-hop EBGP sessions are brought |
5073 | down immediately.IBGP and multi-hop EBGP sessions wait for hold-timer | |
5874235f PG |
5074 | expiry to bring down the sessions. |
5075 | ||
5076 | This new configuration option helps user to teardown BGP sessions immediately | |
5077 | whenever peer becomes unreachable. | |
5078 | ||
5079 | .. clicmd:: bgp fast-convergence | |
5080 | ||
5081 | This configuration is available at the bgp level. When enabled, configuration | |
5082 | is applied to all the neighbors configured in that bgp instance. | |
5083 | ||
5084 | .. code-block:: frr | |
5085 | ||
5086 | router bgp 64496 | |
5087 | neighbor 10.0.0.2 remote-as 64496 | |
5088 | neighbor fd00::2 remote-as 64496 | |
5089 | bgp fast-convergence | |
5090 | ! | |
5091 | address-family ipv4 unicast | |
5092 | redistribute static | |
5093 | exit-address-family | |
5094 | ! | |
5095 | address-family ipv6 unicast | |
5096 | neighbor fd00::2 activate | |
5097 | exit-address-family |