blob: 5004cbfc3823d51364cde31dd33b61375ae5c361 [file] [log] [blame]
paul718e3742002-12-13 20:15:29 +00001@c -*-texinfo-*-
paul7190f4e2003-08-12 12:40:20 +00002@c This is part of the Quagga Manual.
paul76b89b42004-11-06 17:13:09 +00003@c @value{COPYRIGHT_STR}
4@c See file quagga.texi for copying conditions.
paul718e3742002-12-13 20:15:29 +00005@node BGP
paul718e3742002-12-13 20:15:29 +00006@chapter BGP
7
paulaa5943f2005-11-04 21:53:59 +00008@acronym{BGP} stands for a Border Gateway Protocol. The lastest BGP version
paul718e3742002-12-13 20:15:29 +00009is 4. It is referred as BGP-4. BGP-4 is one of the Exterior Gateway
10Protocols and de-fact standard of Inter Domain routing protocol.
paulaa5943f2005-11-04 21:53:59 +000011BGP-4 is described in @cite{RFC1771, A Border Gateway Protocol
paul718e3742002-12-13 20:15:29 +0000124 (BGP-4)}.
13
paulaa5943f2005-11-04 21:53:59 +000014Many extensions have been added to @cite{RFC1771}. @cite{RFC2858,
15Multiprotocol Extensions for BGP-4} provides multiprotocol support to
16BGP-4.
paul718e3742002-12-13 20:15:29 +000017
18@menu
19* Starting BGP::
20* BGP router::
21* BGP network::
22* BGP Peer::
23* BGP Peer Group::
24* BGP Address Family::
25* Autonomous System::
26* BGP Communities Attribute::
27* BGP Extended Communities Attribute::
28* Displaying BGP routes::
29* Capability Negotiation::
30* Route Reflector::
31* Route Server::
32* How to set up a 6-Bone connection::
33* Dump BGP packets and table::
paulaa5943f2005-11-04 21:53:59 +000034* BGP Configuration Examples::
paul718e3742002-12-13 20:15:29 +000035@end menu
36
paul76b89b42004-11-06 17:13:09 +000037@node Starting BGP
paul718e3742002-12-13 20:15:29 +000038@section Starting BGP
39
40Default configuration file of @command{bgpd} is @file{bgpd.conf}.
41@command{bgpd} searches the current directory first then
42@value{INSTALL_PREFIX_ETC}/bgpd.conf. All of bgpd's command must be
43configured in @file{bgpd.conf}.
44
45@command{bgpd} specific invocation options are described below. Common
46options may also be specified (@pxref{Common Invocation Options}).
47
48@table @samp
49@item -p @var{PORT}
50@itemx --bgp_port=@var{PORT}
51Set the bgp protocol's port number.
52
53@item -r
54@itemx --retain
55When program terminates, retain BGP routes added by zebra.
56@end table
57
paul76b89b42004-11-06 17:13:09 +000058@node BGP router
paul718e3742002-12-13 20:15:29 +000059@section BGP router
60
61 First of all you must configure BGP router with @command{router bgp}
62command. To configure BGP router, you need AS number. AS number is an
63identification of autonomous system. BGP protocol uses the AS number
64for detecting whether the BGP connection is internal one or external one.
65
66@deffn Command {router bgp @var{asn}} {}
67Enable a BGP protocol process with the specified @var{asn}. After
68this statement you can input any @code{BGP Commands}. You can not
69create different BGP process under different @var{asn} without
70specifying @code{multiple-instance} (@pxref{Multiple instance}).
71@end deffn
72
73@deffn Command {no router bgp @var{asn}} {}
74Destroy a BGP protocol process with the specified @var{asn}.
75@end deffn
76
77@deffn {BGP} {bgp router-id @var{A.B.C.D}} {}
78This command specifies the router-ID. If @command{bgpd} connects to @command{zebra} it gets
79interface and address information. In that case default router ID value
80is selected as the largest IP Address of the interfaces. When
81@code{router zebra} is not enabled @command{bgpd} can't get interface information
82so @code{router-id} is set to 0.0.0.0. So please set router-id by hand.
83@end deffn
84
85@menu
86* BGP distance::
87* BGP decision process::
Alexandre Chappuisc31e5722011-09-11 16:54:11 +040088* BGP route flap dampening::
paul718e3742002-12-13 20:15:29 +000089@end menu
90
paul76b89b42004-11-06 17:13:09 +000091@node BGP distance
paul718e3742002-12-13 20:15:29 +000092@subsection BGP distance
93
94@deffn {BGP} {distance bgp <1-255> <1-255> <1-255>} {}
95This command change distance value of BGP. Each argument is distance
96value for external routes, internal routes and local routes.
97@end deffn
98
99@deffn {BGP} {distance <1-255> @var{A.B.C.D/M}} {}
100@deffnx {BGP} {distance <1-255> @var{A.B.C.D/M} @var{word}} {}
101This command set distance value to
102@end deffn
103
paul76b89b42004-11-06 17:13:09 +0000104@node BGP decision process
paul718e3742002-12-13 20:15:29 +0000105@subsection BGP decision process
106
107@table @asis
108@item 1. Weight check
109
110@item 2. Local preference check.
111
112@item 3. Local route check.
113
114@item 4. AS path length check.
115
116@item 5. Origin check.
117
118@item 6. MED check.
119@end table
120
hasso68118452005-04-08 15:40:36 +0000121@deffn {BGP} {bgp bestpath as-path confed} {}
122This command specifies that the length of confederation path sets and
123sequences should should be taken into account during the BGP best path
124decision process.
125@end deffn
126
Pradosh Mohapatra2fdd4552013-09-07 07:02:36 +0000127@deffn {BGP} {bgp bestpath as-path multipath-relax} {}
128This command specifies that BGP decision process should consider paths
129of equal AS_PATH length candidates for multipath computation. Without
130the knob, the entire AS_PATH must match for multipath computation.
131@end deffn
132
Alexandre Chappuisc31e5722011-09-11 16:54:11 +0400133@node BGP route flap dampening
134@subsection BGP route flap dampening
135
136@deffn {BGP} {bgp dampening @var{<1-45>} @var{<1-20000>} @var{<1-20000>} @var{<1-255>}} {}
137This command enables BGP route-flap dampening and specifies dampening parameters.
138
139@table @asis
140@item @asis{half-life}
141Half-life time for the penalty
142@item @asis{reuse-threshold}
143Value to start reusing a route
144@item @asis{suppress-threshold}
145Value to start suppressing a route
146@item @asis{max-suppress}
147Maximum duration to suppress a stable route
148@end table
149
150The route-flap damping algorithm is compatible with @cite{RFC2439}. The use of this command
151is not recommended nowadays, see @uref{http://www.ripe.net/ripe/docs/ripe-378,,RIPE-378}.
152@end deffn
153
paul76b89b42004-11-06 17:13:09 +0000154@node BGP network
paul718e3742002-12-13 20:15:29 +0000155@section BGP network
156
157@menu
158* BGP route::
159* Route Aggregation::
160* Redistribute to BGP::
161@end menu
162
paul76b89b42004-11-06 17:13:09 +0000163@node BGP route
paul718e3742002-12-13 20:15:29 +0000164@subsection BGP route
165
166@deffn {BGP} {network @var{A.B.C.D/M}} {}
167This command adds the announcement network.
168@example
169@group
170router bgp 1
171 network 10.0.0.0/8
172@end group
173@end example
174This configuration example says that network 10.0.0.0/8 will be
175announced to all neighbors. Some vendors' routers don't advertise
Paul Jakma41367172007-08-06 15:24:51 +0000176routes if they aren't present in their IGP routing tables; @code{bgpd}
paul718e3742002-12-13 20:15:29 +0000177doesn't care about IGP routes when announcing its routes.
178@end deffn
179
180@deffn {BGP} {no network @var{A.B.C.D/M}} {}
181@end deffn
182
paul76b89b42004-11-06 17:13:09 +0000183@node Route Aggregation
paul718e3742002-12-13 20:15:29 +0000184@subsection Route Aggregation
185
186@deffn {BGP} {aggregate-address @var{A.B.C.D/M}} {}
187This command specifies an aggregate address.
188@end deffn
189
190@deffn {BGP} {aggregate-address @var{A.B.C.D/M} as-set} {}
191This command specifies an aggregate address. Resulting routes inlucde
192AS set.
193@end deffn
194
195@deffn {BGP} {aggregate-address @var{A.B.C.D/M} summary-only} {}
196This command specifies an aggregate address. Aggreated routes will
197not be announce.
198@end deffn
199
200@deffn {BGP} {no aggregate-address @var{A.B.C.D/M}} {}
201@end deffn
202
paul76b89b42004-11-06 17:13:09 +0000203@node Redistribute to BGP
paul718e3742002-12-13 20:15:29 +0000204@subsection Redistribute to BGP
205
206@deffn {BGP} {redistribute kernel} {}
207Redistribute kernel route to BGP process.
208@end deffn
209
210@deffn {BGP} {redistribute static} {}
211Redistribute static route to BGP process.
212@end deffn
213
214@deffn {BGP} {redistribute connected} {}
215Redistribute connected route to BGP process.
216@end deffn
217
218@deffn {BGP} {redistribute rip} {}
219Redistribute RIP route to BGP process.
220@end deffn
221
222@deffn {BGP} {redistribute ospf} {}
223Redistribute OSPF route to BGP process.
224@end deffn
225
paul76b89b42004-11-06 17:13:09 +0000226@node BGP Peer
paul718e3742002-12-13 20:15:29 +0000227@section BGP Peer
228
229@menu
230* Defining Peer::
231* BGP Peer commands::
232* Peer filtering::
233@end menu
234
paul76b89b42004-11-06 17:13:09 +0000235@node Defining Peer
paul718e3742002-12-13 20:15:29 +0000236@subsection Defining Peer
237
238@deffn {BGP} {neighbor @var{peer} remote-as @var{asn}} {}
239Creates a new neighbor whose remote-as is @var{asn}. @var{peer}
240can be an IPv4 address or an IPv6 address.
241@example
242@group
243router bgp 1
244 neighbor 10.0.0.1 remote-as 2
245@end group
246@end example
247In this case my router, in AS-1, is trying to peer with AS-2 at
24810.0.0.1.
249
250This command must be the first command used when configuring a neighbor.
251If the remote-as is not specified, @command{bgpd} will complain like this:
252@example
253can't find neighbor 10.0.0.1
254@end example
255@end deffn
256
paul76b89b42004-11-06 17:13:09 +0000257@node BGP Peer commands
paul718e3742002-12-13 20:15:29 +0000258@subsection BGP Peer commands
259
260In a @code{router bgp} clause there are neighbor specific configurations
261required.
262
263@deffn {BGP} {neighbor @var{peer} shutdown} {}
264@deffnx {BGP} {no neighbor @var{peer} shutdown} {}
265Shutdown the peer. We can delete the neighbor's configuration by
266@code{no neighbor @var{peer} remote-as @var{as-number}} but all
267configuration of the neighbor will be deleted. When you want to
268preserve the configuration, but want to drop the BGP peer, use this
269syntax.
270@end deffn
271
272@deffn {BGP} {neighbor @var{peer} ebgp-multihop} {}
273@deffnx {BGP} {no neighbor @var{peer} ebgp-multihop} {}
274@end deffn
275
276@deffn {BGP} {neighbor @var{peer} description ...} {}
277@deffnx {BGP} {no neighbor @var{peer} description ...} {}
278Set description of the peer.
279@end deffn
280
281@deffn {BGP} {neighbor @var{peer} version @var{version}} {}
282Set up the neighbor's BGP version. @var{version} can be @var{4},
283@var{4+} or @var{4-}. BGP version @var{4} is the default value used for
284BGP peering. BGP version @var{4+} means that the neighbor supports
285Multiprotocol Extensions for BGP-4. BGP version @var{4-} is similar but
286the neighbor speaks the old Internet-Draft revision 00's Multiprotocol
287Extensions for BGP-4. Some routing software is still using this
288version.
289@end deffn
290
291@deffn {BGP} {neighbor @var{peer} interface @var{ifname}} {}
292@deffnx {BGP} {no neighbor @var{peer} interface @var{ifname}} {}
Paul Jakma825cd492006-05-23 22:20:34 +0000293When you connect to a BGP peer over an IPv6 link-local address, you
294have to specify the @var{ifname} of the interface used for the
295connection. To specify IPv4 session addresses, see the
296@code{neighbor @var{peer} update-source} command below.
297
298This command is deprecated and may be removed in a future release. Its
299use should be avoided.
paul718e3742002-12-13 20:15:29 +0000300@end deffn
301
Timo Teräs9e7a53c2014-04-24 10:22:37 +0300302@deffn {BGP} {neighbor @var{peer} next-hop-self [all]} {}
303@deffnx {BGP} {no neighbor @var{peer} next-hop-self [all]} {}
paul718e3742002-12-13 20:15:29 +0000304This command specifies an announced route's nexthop as being equivalent
Timo Teräs9e7a53c2014-04-24 10:22:37 +0300305to the address of the bgp router if it is learned via eBGP.
306If the optional keyword @code{all} is specified the modifiation is done
307also for routes learned via iBGP.
paul718e3742002-12-13 20:15:29 +0000308@end deffn
309
Paul Jakma466c9652006-06-26 12:55:58 +0000310@deffn {BGP} {neighbor @var{peer} update-source @var{<ifname|address>}} {}
paul718e3742002-12-13 20:15:29 +0000311@deffnx {BGP} {no neighbor @var{peer} update-source} {}
Paul Jakma825cd492006-05-23 22:20:34 +0000312Specify the IPv4 source address to use for the @acronym{BGP} session to this
313neighbour, may be specified as either an IPv4 address directly or
314as an interface name (in which case the @command{zebra} daemon MUST be running
315in order for @command{bgpd} to be able to retrieve interface state).
316@example
317@group
318router bgp 64555
319 neighbor foo update-source 192.168.0.1
320 neighbor bar update-source lo0
321@end group
322@end example
paul718e3742002-12-13 20:15:29 +0000323@end deffn
324
325@deffn {BGP} {neighbor @var{peer} default-originate} {}
326@deffnx {BGP} {no neighbor @var{peer} default-originate} {}
327@command{bgpd}'s default is to not announce the default route (0.0.0.0/0) even it
328is in routing table. When you want to announce default routes to the
329peer, use this command.
330@end deffn
331
332@deffn {BGP} {neighbor @var{peer} port @var{port}} {}
333@deffnx {BGP} {neighbor @var{peer} port @var{port}} {}
334@end deffn
335
336@deffn {BGP} {neighbor @var{peer} send-community} {}
337@deffnx {BGP} {neighbor @var{peer} send-community} {}
338@end deffn
339
340@deffn {BGP} {neighbor @var{peer} weight @var{weight}} {}
341@deffnx {BGP} {no neighbor @var{peer} weight @var{weight}} {}
342This command specifies a default @var{weight} value for the neighbor's
343routes.
344@end deffn
345
346@deffn {BGP} {neighbor @var{peer} maximum-prefix @var{number}} {}
347@deffnx {BGP} {no neighbor @var{peer} maximum-prefix @var{number}} {}
348@end deffn
349
Andrew Certain5aebb9c2012-11-07 23:50:09 +0000350@deffn {BGP} {neighbor @var{peer} local-as @var{as-number}} {}
351@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend} {}
352@deffnx {BGP} {neighbor @var{peer} local-as @var{as-number} no-prepend replace-as} {}
353@deffnx {BGP} {no neighbor @var{peer} local-as} {}
354Specify an alternate AS for this BGP process when interacting with the
355specified peer. With no modifiers, the specified local-as is prepended to
356the received AS_PATH when receiving routing updates from the peer, and
357prepended to the outgoing AS_PATH (after the process local AS) when
358transmitting local routes to the peer.
359
360If the no-prepend attribute is specified, then the supplied local-as is not
361prepended to the received AS_PATH.
362
363If the replace-as attribute is specified, then only the supplied local-as is
364prepended to the AS_PATH when transmitting local-route updates to this peer.
365
366Note that replace-as can only be specified if no-prepend is.
367
368This command is only allowed for eBGP peers.
369@end deffn
370
Pradosh Mohapatra5d804b42013-09-12 03:37:07 +0000371@deffn {BGP} {neighbor @var{peer} ttl-security hops @var{number}} {}
372@deffnx {BGP} {no neighbor @var{peer} ttl-security hops @var{number}} {}
373This command enforces Generalized TTL Security Mechanism (GTSM), as
374specified in RFC 5082. With this command, only neighbors that are the
375specified number of hops away will be allowed to become neighbors. This
376command is mututally exclusive with @command{ebgp-multihop}.
377@end deffn
378
paul76b89b42004-11-06 17:13:09 +0000379@node Peer filtering
paul718e3742002-12-13 20:15:29 +0000380@subsection Peer filtering
381
382@deffn {BGP} {neighbor @var{peer} distribute-list @var{name} [in|out]} {}
383This command specifies a distribute-list for the peer. @var{direct} is
384@samp{in} or @samp{out}.
385@end deffn
386
387@deffn {BGP command} {neighbor @var{peer} prefix-list @var{name} [in|out]} {}
388@end deffn
389
390@deffn {BGP command} {neighbor @var{peer} filter-list @var{name} [in|out]} {}
391@end deffn
392
393@deffn {BGP} {neighbor @var{peer} route-map @var{name} [in|out]} {}
394Apply a route-map on the neighbor. @var{direct} must be @code{in} or
395@code{out}.
396@end deffn
397
398@c -----------------------------------------------------------------------
paul76b89b42004-11-06 17:13:09 +0000399@node BGP Peer Group
paul718e3742002-12-13 20:15:29 +0000400@section BGP Peer Group
401
402@deffn {BGP} {neighbor @var{word} peer-group} {}
403This command defines a new peer group.
404@end deffn
405
406@deffn {BGP} {neighbor @var{peer} peer-group @var{word}} {}
407This command bind specific peer to peer group @var{word}.
408@end deffn
409
paul76b89b42004-11-06 17:13:09 +0000410@node BGP Address Family
paul718e3742002-12-13 20:15:29 +0000411@section BGP Address Family
412
paul718e3742002-12-13 20:15:29 +0000413@c -----------------------------------------------------------------------
paul76b89b42004-11-06 17:13:09 +0000414@node Autonomous System
paul718e3742002-12-13 20:15:29 +0000415@section Autonomous System
416
paulaa5943f2005-11-04 21:53:59 +0000417The @acronym{AS,Autonomous System} number is one of the essential
418element of BGP. BGP is a distance vector routing protocol, and the
419AS-Path framework provides distance vector metric and loop detection to
420BGP. @cite{RFC1930, Guidelines for creation, selection, and
421registration of an Autonomous System (AS)} provides some background on
422the concepts of an AS.
paul718e3742002-12-13 20:15:29 +0000423
paulaa5943f2005-11-04 21:53:59 +0000424The AS number is a two octet value, ranging in value from 1 to 65535.
425The AS numbers 64512 through 65535 are defined as private AS numbers.
426Private AS numbers must not to be advertised in the global Internet.
paul718e3742002-12-13 20:15:29 +0000427
428@menu
429* AS Path Regular Expression::
430* Display BGP Routes by AS Path::
431* AS Path Access List::
432* Using AS Path in Route Map::
433* Private AS Numbers::
434@end menu
435
paul76b89b42004-11-06 17:13:09 +0000436@node AS Path Regular Expression
paul718e3742002-12-13 20:15:29 +0000437@subsection AS Path Regular Expression
438
paulaa5943f2005-11-04 21:53:59 +0000439AS path regular expression can be used for displaying BGP routes and
paul718e3742002-12-13 20:15:29 +0000440AS path access list. AS path regular expression is based on
441@code{POSIX 1003.2} regular expressions. Following description is
442just a subset of @code{POSIX} regular expression. User can use full
443@code{POSIX} regular expression. Adding to that special character '_'
444is added for AS path regular expression.
445
446@table @code
447@item .
448Matches any single character.
449@item *
450Matches 0 or more occurrences of pattern.
451@item +
452Matches 1 or more occurrences of pattern.
453@item ?
454Match 0 or 1 occurrences of pattern.
455@item ^
456Matches the beginning of the line.
457@item $
458Matches the end of the line.
459@item _
460Character @code{_} has special meanings in AS path regular expression.
461It matches to space and comma , and AS set delimiter @{ and @} and AS
462confederation delimiter @code{(} and @code{)}. And it also matches to
463the beginning of the line and the end of the line. So @code{_} can be
464used for AS value boundaries match. @code{show ip bgp regexp _7675_}
465matches to all of BGP routes which as AS number include @var{7675}.
466@end table
467
paul76b89b42004-11-06 17:13:09 +0000468@node Display BGP Routes by AS Path
paul718e3742002-12-13 20:15:29 +0000469@subsection Display BGP Routes by AS Path
470
paulaa5943f2005-11-04 21:53:59 +0000471To show BGP routes which has specific AS path information @code{show
paul718e3742002-12-13 20:15:29 +0000472ip bgp} command can be used.
473
474@deffn Command {show ip bgp regexp @var{line}} {}
475This commands display BGP routes that matches AS path regular
476expression @var{line}.
477@end deffn
478
paul76b89b42004-11-06 17:13:09 +0000479@node AS Path Access List
paul718e3742002-12-13 20:15:29 +0000480@subsection AS Path Access List
481
paulaa5943f2005-11-04 21:53:59 +0000482AS path access list is user defined AS path.
paul718e3742002-12-13 20:15:29 +0000483
484@deffn {Command} {ip as-path access-list @var{word} @{permit|deny@} @var{line}} {}
485This command defines a new AS path access list.
486@end deffn
487
488@deffn {Command} {no ip as-path access-list @var{word}} {}
489@deffnx {Command} {no ip as-path access-list @var{word} @{permit|deny@} @var{line}} {}
490@end deffn
491
paul76b89b42004-11-06 17:13:09 +0000492@node Using AS Path in Route Map
paul718e3742002-12-13 20:15:29 +0000493@subsection Using AS Path in Route Map
494
495@deffn {Route Map} {match as-path @var{word}} {}
496@end deffn
497
498@deffn {Route Map} {set as-path prepend @var{as-path}} {}
Timo Teräs85c854a2014-09-30 11:31:53 +0300499@deffnx {Route Map} {set as-path prepend last-as @var{num}} {}
paul718e3742002-12-13 20:15:29 +0000500@end deffn
501
paul76b89b42004-11-06 17:13:09 +0000502@node Private AS Numbers
paul718e3742002-12-13 20:15:29 +0000503@subsection Private AS Numbers
504
paul718e3742002-12-13 20:15:29 +0000505@c -----------------------------------------------------------------------
paul76b89b42004-11-06 17:13:09 +0000506@node BGP Communities Attribute
paul718e3742002-12-13 20:15:29 +0000507@section BGP Communities Attribute
508
paulaa5943f2005-11-04 21:53:59 +0000509BGP communities attribute is widely used for implementing policy
paul718e3742002-12-13 20:15:29 +0000510routing. Network operators can manipulate BGP communities attribute
511based on their network policy. BGP communities attribute is defined
paulaa5943f2005-11-04 21:53:59 +0000512in @cite{RFC1997, BGP Communities Attribute} and
513@cite{RFC1998, An Application of the BGP Community Attribute
paul718e3742002-12-13 20:15:29 +0000514in Multi-home Routing}. It is an optional transitive attribute,
515therefore local policy can travel through different autonomous system.
516
paulaa5943f2005-11-04 21:53:59 +0000517Communities attribute is a set of communities values. Each
paul718e3742002-12-13 20:15:29 +0000518communities value is 4 octet long. The following format is used to
519define communities value.
520
521@table @code
522@item AS:VAL
523This format represents 4 octet communities value. @code{AS} is high
524order 2 octet in digit format. @code{VAL} is low order 2 octet in
525digit format. This format is useful to define AS oriented policy
526value. For example, @code{7675:80} can be used when AS 7675 wants to
527pass local policy value 80 to neighboring peer.
528@item internet
529@code{internet} represents well-known communities value 0.
530@item no-export
531@code{no-export} represents well-known communities value @code{NO_EXPORT}@*
532@r{(0xFFFFFF01)}. All routes carry this value must not be advertised
533to outside a BGP confederation boundary. If neighboring BGP peer is
534part of BGP confederation, the peer is considered as inside a BGP
535confederation boundary, so the route will be announced to the peer.
536@item no-advertise
537@code{no-advertise} represents well-known communities value
538@code{NO_ADVERTISE}@*@r{(0xFFFFFF02)}. All routes carry this value
539must not be advertise to other BGP peers.
540@item local-AS
541@code{local-AS} represents well-known communities value
542@code{NO_EXPORT_SUBCONFED} @r{(0xFFFFFF03)}. All routes carry this
543value must not be advertised to external BGP peers. Even if the
544neighboring router is part of confederation, it is considered as
545external BGP peer, so the route will not be announced to the peer.
546@end table
547
548 When BGP communities attribute is received, duplicated communities
549value in the communities attribute is ignored and each communities
550values are sorted in numerical order.
551
552@menu
553* BGP Community Lists::
554* Numbered BGP Community Lists::
555* BGP Community in Route Map::
556* Display BGP Routes by Community::
557* Using BGP Communities Attribute::
558@end menu
559
paul76b89b42004-11-06 17:13:09 +0000560@node BGP Community Lists
paul718e3742002-12-13 20:15:29 +0000561@subsection BGP Community Lists
562
563 BGP community list is a user defined BGP communites attribute list.
564BGP community list can be used for matching or manipulating BGP
565communities attribute in updates.
566
paulaa5943f2005-11-04 21:53:59 +0000567There are two types of community list. One is standard community
paul718e3742002-12-13 20:15:29 +0000568list and another is expanded community list. Standard community list
569defines communities attribute. Expanded community list defines
570communities attribute string with regular expression. Standard
571community list is compiled into binary format when user define it.
572Standard community list will be directly compared to BGP communities
573attribute in BGP updates. Therefore the comparison is faster than
574expanded community list.
575
576@deffn Command {ip community-list standard @var{name} @{permit|deny@} @var{community}} {}
577This command defines a new standard community list. @var{community}
578is communities value. The @var{community} is compiled into community
579structure. We can define multiple community list under same name. In
580that case match will happen user defined order. Once the
581community list matches to communities attribute in BGP updates it
582return permit or deny by the community list definition. When there is
583no matched entry, deny will be returned. When @var{community} is
584empty it matches to any routes.
585@end deffn
586
587@deffn Command {ip community-list expanded @var{name} @{permit|deny@} @var{line}} {}
588This command defines a new expanded community list. @var{line} is a
589string expression of communities attribute. @var{line} can include
590regular expression to match communities attribute in BGP updates.
591@end deffn
592
593@deffn Command {no ip community-list @var{name}} {}
594@deffnx Command {no ip community-list standard @var{name}} {}
595@deffnx Command {no ip community-list expanded @var{name}} {}
596These commands delete community lists specified by @var{name}. All of
597community lists shares a single name space. So community lists can be
598removed simpley specifying community lists name.
599@end deffn
600
601@deffn {Command} {show ip community-list} {}
602@deffnx {Command} {show ip community-list @var{name}} {}
603This command display current community list information. When
604@var{name} is specified the specified community list's information is
605shown.
606
607@example
608# show ip community-list
609Named Community standard list CLIST
610 permit 7675:80 7675:100 no-export
611 deny internet
612Named Community expanded list EXPAND
613 permit :
614
615# show ip community-list CLIST
616Named Community standard list CLIST
617 permit 7675:80 7675:100 no-export
618 deny internet
619@end example
620@end deffn
621
paul76b89b42004-11-06 17:13:09 +0000622@node Numbered BGP Community Lists
paul718e3742002-12-13 20:15:29 +0000623@subsection Numbered BGP Community Lists
624
paulaa5943f2005-11-04 21:53:59 +0000625When number is used for BGP community list name, the number has
paul718e3742002-12-13 20:15:29 +0000626special meanings. Community list number in the range from 1 and 99 is
627standard community list. Community list number in the range from 100
628to 199 is expanded community list. These community lists are called
629as numbered community lists. On the other hand normal community lists
630is called as named community lists.
631
632@deffn Command {ip community-list <1-99> @{permit|deny@} @var{community}} {}
633This command defines a new community list. <1-99> is standard
634community list number. Community list name within this range defines
635standard community list. When @var{community} is empty it matches to
636any routes.
637@end deffn
638
639@deffn Command {ip community-list <100-199> @{permit|deny@} @var{community}} {}
640This command defines a new community list. <100-199> is expanded
641community list number. Community list name within this range defines
642expanded community list.
643@end deffn
644
645@deffn Command {ip community-list @var{name} @{permit|deny@} @var{community}} {}
646When community list type is not specifed, the community list type is
647automatically detected. If @var{community} can be compiled into
648communities attribute, the community list is defined as a standard
649community list. Otherwise it is defined as an expanded community
650list. This feature is left for backward compability. Use of this
651feature is not recommended.
652@end deffn
653
paul76b89b42004-11-06 17:13:09 +0000654@node BGP Community in Route Map
paul718e3742002-12-13 20:15:29 +0000655@subsection BGP Community in Route Map
656
paulaa5943f2005-11-04 21:53:59 +0000657In Route Map (@pxref{Route Map}), we can match or set BGP
paul718e3742002-12-13 20:15:29 +0000658communities attribute. Using this feature network operator can
659implement their network policy based on BGP communities attribute.
660
paulaa5943f2005-11-04 21:53:59 +0000661Following commands can be used in Route Map.
paul718e3742002-12-13 20:15:29 +0000662
663@deffn {Route Map} {match community @var{word}} {}
664@deffnx {Route Map} {match community @var{word} exact-match} {}
665This command perform match to BGP updates using community list
666@var{word}. When the one of BGP communities value match to the one of
667communities value in community list, it is match. When
668@code{exact-match} keyword is spcified, match happen only when BGP
669updates have completely same communities value specified in the
670community list.
671@end deffn
672
673@deffn {Route Map} {set community none} {}
674@deffnx {Route Map} {set community @var{community}} {}
675@deffnx {Route Map} {set community @var{community} additive} {}
676This command manipulate communities value in BGP updates. When
677@code{none} is specified as communities value, it removes entire
678communities attribute from BGP updates. When @var{community} is not
679@code{none}, specified communities value is set to BGP updates. If
680BGP updates already has BGP communities value, the existing BGP
681communities value is replaced with specified @var{community} value.
682When @code{additive} keyword is specified, @var{community} is appended
683to the existing communities value.
684@end deffn
685
686@deffn {Route Map} {set comm-list @var{word} delete} {}
687This command remove communities value from BGP communities attribute.
688The @var{word} is community list name. When BGP route's communities
689value matches to the community list @var{word}, the communities value
690is removed. When all of communities value is removed eventually, the
691BGP update's communities attribute is completely removed.
692@end deffn
693
paul76b89b42004-11-06 17:13:09 +0000694@node Display BGP Routes by Community
paul718e3742002-12-13 20:15:29 +0000695@subsection Display BGP Routes by Community
696
paulaa5943f2005-11-04 21:53:59 +0000697To show BGP routes which has specific BGP communities attribute,
paul718e3742002-12-13 20:15:29 +0000698@code{show ip bgp} command can be used. The @var{community} value and
699community list can be used for @code{show ip bgp} command.
700
701@deffn Command {show ip bgp community} {}
702@deffnx Command {show ip bgp community @var{community}} {}
703@deffnx Command {show ip bgp community @var{community} exact-match} {}
704@code{show ip bgp community} displays BGP routes which has communities
705attribute. When @var{community} is specified, BGP routes that matches
706@var{community} value is displayed. For this command, @code{internet}
707keyword can't be used for @var{community} value. When
708@code{exact-match} is specified, it display only routes that have an
709exact match.
710@end deffn
711
712@deffn Command {show ip bgp community-list @var{word}} {}
713@deffnx Command {show ip bgp community-list @var{word} exact-match} {}
714This commands display BGP routes that matches community list
715@var{word}. When @code{exact-match} is specified, display only routes
716that have an exact match.
717@end deffn
718
paul76b89b42004-11-06 17:13:09 +0000719@node Using BGP Communities Attribute
paul718e3742002-12-13 20:15:29 +0000720@subsection Using BGP Communities Attribute
721
paulaa5943f2005-11-04 21:53:59 +0000722Following configuration is the most typical usage of BGP communities
paul718e3742002-12-13 20:15:29 +0000723attribute. AS 7675 provides upstream Internet connection to AS 100.
724When following configuration exists in AS 7675, AS 100 networks
725operator can set local preference in AS 7675 network by setting BGP
726communities attribute to the updates.
727
728@example
729router bgp 7675
730 neighbor 192.168.0.1 remote-as 100
731 neighbor 192.168.0.1 route-map RMAP in
732!
733ip community-list 70 permit 7675:70
734ip community-list 70 deny
735ip community-list 80 permit 7675:80
736ip community-list 80 deny
737ip community-list 90 permit 7675:90
738ip community-list 90 deny
739!
740route-map RMAP permit 10
741 match community 70
742 set local-preference 70
743!
744route-map RMAP permit 20
745 match community 80
746 set local-preference 80
747!
748route-map RMAP permit 30
749 match community 90
750 set local-preference 90
751@end example
752
paulaa5943f2005-11-04 21:53:59 +0000753Following configuration announce 10.0.0.0/8 from AS 100 to AS 7675.
paul718e3742002-12-13 20:15:29 +0000754The route has communities value 7675:80 so when above configuration
755exists in AS 7675, announced route's local preference will be set to
756value 80.
757
758@example
759router bgp 100
760 network 10.0.0.0/8
761 neighbor 192.168.0.2 remote-as 7675
762 neighbor 192.168.0.2 route-map RMAP out
763!
764ip prefix-list PLIST permit 10.0.0.0/8
765!
766route-map RMAP permit 10
767 match ip address prefix-list PLIST
768 set community 7675:80
769@end example
770
paulaa5943f2005-11-04 21:53:59 +0000771Following configuration is an example of BGP route filtering using
paul718e3742002-12-13 20:15:29 +0000772communities attribute. This configuration only permit BGP routes
773which has BGP communities value 0:80 or 0:90. Network operator can
774put special internal communities value at BGP border router, then
775limit the BGP routes announcement into the internal network.
776
777@example
778router bgp 7675
779 neighbor 192.168.0.1 remote-as 100
780 neighbor 192.168.0.1 route-map RMAP in
781!
782ip community-list 1 permit 0:80 0:90
783!
784route-map RMAP permit in
785 match community 1
786@end example
787
paulaa5943f2005-11-04 21:53:59 +0000788Following exmaple filter BGP routes which has communities value 1:1.
paul718e3742002-12-13 20:15:29 +0000789When there is no match community-list returns deny. To avoid
790filtering all of routes, we need to define permit any at last.
791
792@example
793router bgp 7675
794 neighbor 192.168.0.1 remote-as 100
795 neighbor 192.168.0.1 route-map RMAP in
796!
797ip community-list standard FILTER deny 1:1
798ip community-list standard FILTER permit
799!
800route-map RMAP permit 10
801 match community FILTER
802@end example
803
paulaa5943f2005-11-04 21:53:59 +0000804Communities value keyword @code{internet} has special meanings in
paul718e3742002-12-13 20:15:29 +0000805standard community lists. In below example @code{internet} act as
806match any. It matches all of BGP routes even if the route does not
807have communities attribute at all. So community list @code{INTERNET}
808is same as above example's @code{FILTER}.
809
810@example
811ip community-list standard INTERNET deny 1:1
812ip community-list standard INTERNET permit internet
813@end example
814
paulaa5943f2005-11-04 21:53:59 +0000815Following configuration is an example of communities value deletion.
paul718e3742002-12-13 20:15:29 +0000816With this configuration communities value 100:1 and 100:2 is removed
817from BGP updates. For communities value deletion, only @code{permit}
818community-list is used. @code{deny} community-list is ignored.
819
820@example
821router bgp 7675
822 neighbor 192.168.0.1 remote-as 100
823 neighbor 192.168.0.1 route-map RMAP in
824!
825ip community-list standard DEL permit 100:1 100:2
826!
827route-map RMAP permit 10
828 set comm-list DEL delete
829@end example
830
831@c -----------------------------------------------------------------------
paul76b89b42004-11-06 17:13:09 +0000832@node BGP Extended Communities Attribute
paul718e3742002-12-13 20:15:29 +0000833@section BGP Extended Communities Attribute
834
paulaa5943f2005-11-04 21:53:59 +0000835BGP extended communities attribute is introduced with MPLS VPN/BGP
paul718e3742002-12-13 20:15:29 +0000836technology. MPLS VPN/BGP expands capability of network infrastructure
837to provide VPN functionality. At the same time it requires a new
838framework for policy routing. With BGP Extended Communities Attribute
839we can use Route Target or Site of Origin for implementing network
840policy for MPLS VPN/BGP.
841
paulaa5943f2005-11-04 21:53:59 +0000842BGP Extended Communities Attribute is similar to BGP Communities
paul718e3742002-12-13 20:15:29 +0000843Attribute. It is an optional transitive attribute. BGP Extended
844Communities Attribute can carry multiple Extended Community value.
845Each Extended Community value is eight octet length.
846
paulaa5943f2005-11-04 21:53:59 +0000847BGP Extended Communities Attribute provides an extended range
paul718e3742002-12-13 20:15:29 +0000848compared with BGP Communities Attribute. Adding to that there is a
849type field in each value to provides community space structure.
850
paulaa5943f2005-11-04 21:53:59 +0000851There are two format to define Extended Community value. One is AS
paul718e3742002-12-13 20:15:29 +0000852based format the other is IP address based format.
853
854@table @code
855@item AS:VAL
856This is a format to define AS based Extended Community value.
857@code{AS} part is 2 octets Global Administrator subfield in Extended
858Community value. @code{VAL} part is 4 octets Local Administrator
859subfield. @code{7675:100} represents AS 7675 policy value 100.
860@item IP-Address:VAL
861This is a format to define IP address based Extended Community value.
862@code{IP-Address} part is 4 octets Global Administrator subfield.
863@code{VAL} part is 2 octets Local Administrator subfield.
864@code{10.0.0.1:100} represents
865@end table
866
867@menu
868* BGP Extended Community Lists::
869* BGP Extended Communities in Route Map::
870@end menu
871
paul76b89b42004-11-06 17:13:09 +0000872@node BGP Extended Community Lists
paul718e3742002-12-13 20:15:29 +0000873@subsection BGP Extended Community Lists
874
paulaa5943f2005-11-04 21:53:59 +0000875Expanded Community Lists is a user defined BGP Expanded Community
paul718e3742002-12-13 20:15:29 +0000876Lists.
877
878@deffn Command {ip extcommunity-list standard @var{name} @{permit|deny@} @var{extcommunity}} {}
879This command defines a new standard extcommunity-list.
880@var{extcommunity} is extended communities value. The
881@var{extcommunity} is compiled into extended community structure. We
882can define multiple extcommunity-list under same name. In that case
883match will happen user defined order. Once the extcommunity-list
884matches to extended communities attribute in BGP updates it return
885permit or deny based upon the extcommunity-list definition. When
886there is no matched entry, deny will be returned. When
887@var{extcommunity} is empty it matches to any routes.
888@end deffn
889
890@deffn Command {ip extcommunity-list expanded @var{name} @{permit|deny@} @var{line}} {}
891This command defines a new expanded extcommunity-list. @var{line} is
892a string expression of extended communities attribute. @var{line} can
893include regular expression to match extended communities attribute in
894BGP updates.
895@end deffn
896
897@deffn Command {no ip extcommunity-list @var{name}} {}
898@deffnx Command {no ip extcommunity-list standard @var{name}} {}
899@deffnx Command {no ip extcommunity-list expanded @var{name}} {}
900These commands delete extended community lists specified by
901@var{name}. All of extended community lists shares a single name
902space. So extended community lists can be removed simpley specifying
903the name.
904@end deffn
905
906@deffn {Command} {show ip extcommunity-list} {}
907@deffnx {Command} {show ip extcommunity-list @var{name}} {}
908This command display current extcommunity-list information. When
909@var{name} is specified the community list's information is shown.
910
911@example
912# show ip extcommunity-list
913@end example
914@end deffn
915
paul76b89b42004-11-06 17:13:09 +0000916@node BGP Extended Communities in Route Map
paul718e3742002-12-13 20:15:29 +0000917@subsection BGP Extended Communities in Route Map
918
919@deffn {Route Map} {match extcommunity @var{word}} {}
920@end deffn
921
922@deffn {Route Map} {set extcommunity rt @var{extcommunity}} {}
923This command set Route Target value.
924@end deffn
925
926@deffn {Route Map} {set extcommunity soo @var{extcommunity}} {}
927This command set Site of Origin value.
928@end deffn
929
930@c -----------------------------------------------------------------------
paul76b89b42004-11-06 17:13:09 +0000931@node Displaying BGP routes
paul718e3742002-12-13 20:15:29 +0000932@section Displaying BGP Routes
933
934@menu
935* Show IP BGP::
936* More Show IP BGP::
937@end menu
938
paul76b89b42004-11-06 17:13:09 +0000939@node Show IP BGP
paul718e3742002-12-13 20:15:29 +0000940@subsection Show IP BGP
941
942@deffn {Command} {show ip bgp} {}
943@deffnx {Command} {show ip bgp @var{A.B.C.D}} {}
944@deffnx {Command} {show ip bgp @var{X:X::X:X}} {}
945This command displays BGP routes. When no route is specified it
946display all of IPv4 BGP routes.
947@end deffn
948
949@example
950BGP table version is 0, local router ID is 10.1.1.1
951Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
952Origin codes: i - IGP, e - EGP, ? - incomplete
953
954 Network Next Hop Metric LocPrf Weight Path
955*> 1.1.1.1/32 0.0.0.0 0 32768 i
956
957Total number of prefixes 1
958@end example
959
paul76b89b42004-11-06 17:13:09 +0000960@node More Show IP BGP
paul718e3742002-12-13 20:15:29 +0000961@subsection More Show IP BGP
962
963@deffn {Command} {show ip bgp regexp @var{line}} {}
964This command display BGP routes using AS path regular expression (@pxref{Display BGP Routes by AS Path}).
965@end deffn
966
967@deffn Command {show ip bgp community @var{community}} {}
968@deffnx Command {show ip bgp community @var{community} exact-match} {}
969This command display BGP routes using @var{community} (@pxref{Display
970BGP Routes by Community}).
971@end deffn
972
973@deffn Command {show ip bgp community-list @var{word}} {}
974@deffnx Command {show ip bgp community-list @var{word} exact-match} {}
975This command display BGP routes using community list (@pxref{Display
976BGP Routes by Community}).
977@end deffn
978
979@deffn {Command} {show ip bgp summary} {}
980@end deffn
981
982@deffn {Command} {show ip bgp neighbor [@var{peer}]} {}
983@end deffn
984
985@deffn {Command} {clear ip bgp @var{peer}} {}
986Clear peers which have addresses of X.X.X.X
987@end deffn
988
989@deffn {Command} {clear ip bgp @var{peer} soft in} {}
990Clear peer using soft reconfiguration.
991@end deffn
992
Alexandre Chappuisc31e5722011-09-11 16:54:11 +0400993@deffn {Command} {show ip bgp dampened-paths} {}
994Display paths suppressed due to dampening
995@end deffn
996
997@deffn {Command} {show ip bgp flap-statistics} {}
998Display flap statistics of routes
999@end deffn
1000
paul718e3742002-12-13 20:15:29 +00001001@deffn {Command} {show debug} {}
1002@end deffn
1003
1004@deffn {Command} {debug event} {}
1005@end deffn
1006
1007@deffn {Command} {debug update} {}
1008@end deffn
1009
1010@deffn {Command} {debug keepalive} {}
1011@end deffn
1012
1013@deffn {Command} {no debug event} {}
1014@end deffn
1015
1016@deffn {Command} {no debug update} {}
1017@end deffn
1018
1019@deffn {Command} {no debug keepalive} {}
1020@end deffn
1021
paul76b89b42004-11-06 17:13:09 +00001022@node Capability Negotiation
paul718e3742002-12-13 20:15:29 +00001023@section Capability Negotiation
1024
paulaa5943f2005-11-04 21:53:59 +00001025When adding IPv6 routing information exchange feature to BGP. There
1026were some proposals. @acronym{IETF,Internet Engineering Task Force}
1027@acronym{IDR, Inter Domain Routing} @acronym{WG, Working group} adopted
1028a proposal called Multiprotocol Extension for BGP. The specification
1029is described in @cite{RFC2283}. The protocol does not define new protocols.
1030It defines new attributes to existing BGP. When it is used exchanging
1031IPv6 routing information it is called BGP-4+. When it is used for
1032exchanging multicast routing information it is called MBGP.
paul718e3742002-12-13 20:15:29 +00001033
paulaa5943f2005-11-04 21:53:59 +00001034@command{bgpd} supports Multiprotocol Extension for BGP. So if remote
1035peer supports the protocol, @command{bgpd} can exchange IPv6 and/or
1036multicast routing information.
paul718e3742002-12-13 20:15:29 +00001037
paulaa5943f2005-11-04 21:53:59 +00001038Traditional BGP did not have the feature to detect remote peer's
1039capabilities, e.g. whether it can handle prefix types other than IPv4
1040unicast routes. This was a big problem using Multiprotocol Extension
1041for BGP to operational network. @cite{RFC2842, Capabilities
1042Advertisement with BGP-4} adopted a feature called Capability
1043Negotiation. @command{bgpd} use this Capability Negotiation to detect
1044the remote peer's capabilities. If the peer is only configured as IPv4
1045unicast neighbor, @command{bgpd} does not send these Capability
1046Negotiation packets (at least not unless other optional BGP features
1047require capability negotation).
paul718e3742002-12-13 20:15:29 +00001048
paulaa5943f2005-11-04 21:53:59 +00001049By default, Quagga will bring up peering with minimal common capability
1050for the both sides. For example, local router has unicast and
1051multicast capabilitie and remote router has unicast capability. In
1052this case, the local router will establish the connection with unicast
1053only capability. When there are no common capabilities, Quagga sends
1054Unsupported Capability error and then resets the connection.
paul718e3742002-12-13 20:15:29 +00001055
paulaa5943f2005-11-04 21:53:59 +00001056If you want to completely match capabilities with remote peer. Please
paul718e3742002-12-13 20:15:29 +00001057use @command{strict-capability-match} command.
1058
1059@deffn {BGP} {neighbor @var{peer} strict-capability-match} {}
1060@deffnx {BGP} {no neighbor @var{peer} strict-capability-match} {}
1061Strictly compares remote capabilities and local capabilities. If capabilities
1062are different, send Unsupported Capability error then reset connection.
1063@end deffn
1064
paulaa5943f2005-11-04 21:53:59 +00001065You may want to disable sending Capability Negotiation OPEN message
paul718e3742002-12-13 20:15:29 +00001066optional parameter to the peer when remote peer does not implement
1067Capability Negotiation. Please use @command{dont-capability-negotiate}
1068command to disable the feature.
1069
1070@deffn {BGP} {neighbor @var{peer} dont-capability-negotiate} {}
1071@deffnx {BGP} {no neighbor @var{peer} dont-capability-negotiate} {}
1072Suppress sending Capability Negotiation as OPEN message optional
1073parameter to the peer. This command only affects the peer is configured
1074other than IPv4 unicast configuration.
1075@end deffn
1076
paulaa5943f2005-11-04 21:53:59 +00001077When remote peer does not have capability negotiation feature, remote
1078peer will not send any capabilities at all. In that case, bgp
1079configures the peer with configured capabilities.
paul718e3742002-12-13 20:15:29 +00001080
paulaa5943f2005-11-04 21:53:59 +00001081You may prefer locally configured capabilities more than the negotiated
1082capabilities even though remote peer sends capabilities. If the peer
1083is configured by @command{override-capability}, @command{bgpd} ignores
1084received capabilities then override negotiated capabilities with
1085configured values.
paul718e3742002-12-13 20:15:29 +00001086
1087@deffn {BGP} {neighbor @var{peer} override-capability} {}
1088@deffnx {BGP} {no neighbor @var{peer} override-capability} {}
1089Override the result of Capability Negotiation with local configuration.
1090Ignore remote peer's capability value.
1091@end deffn
1092
paul76b89b42004-11-06 17:13:09 +00001093@node Route Reflector
paul718e3742002-12-13 20:15:29 +00001094@section Route Reflector
1095
1096@deffn {BGP} {bgp cluster-id @var{a.b.c.d}} {}
1097@end deffn
1098
1099@deffn {BGP} {neighbor @var{peer} route-reflector-client} {}
1100@deffnx {BGP} {no neighbor @var{peer} route-reflector-client} {}
1101@end deffn
1102
paul76b89b42004-11-06 17:13:09 +00001103@node Route Server
paul718e3742002-12-13 20:15:29 +00001104@section Route Server
1105
1106At an Internet Exchange point, many ISPs are connected to each other by
1107external BGP peering. Normally these external BGP connection are done by
paulaa5943f2005-11-04 21:53:59 +00001108@samp{full mesh} method. As with internal BGP full mesh formation,
paul718e3742002-12-13 20:15:29 +00001109this method has a scaling problem.
1110
1111This scaling problem is well known. Route Server is a method to resolve
1112the problem. Each ISP's BGP router only peers to Route Server. Route
1113Server serves as BGP information exchange to other BGP routers. By
1114applying this method, numbers of BGP connections is reduced from
1115O(n*(n-1)/2) to O(n).
1116
1117Unlike normal BGP router, Route Server must have several routing tables
1118for managing different routing policies for each BGP speaker. We call the
1119routing tables as different @code{view}s. @command{bgpd} can work as
1120normal BGP router or Route Server or both at the same time.
1121
1122@menu
1123* Multiple instance::
1124* BGP instance and view::
1125* Routing policy::
1126* Viewing the view::
1127@end menu
1128
paul76b89b42004-11-06 17:13:09 +00001129@node Multiple instance
paul718e3742002-12-13 20:15:29 +00001130@subsection Multiple instance
1131
1132To enable multiple view function of @code{bgpd}, you must turn on
1133multiple instance feature beforehand.
1134
1135@deffn {Command} {bgp multiple-instance} {}
1136Enable BGP multiple instance feature. After this feature is enabled,
1137you can make multiple BGP instances or multiple BGP views.
1138@end deffn
1139
1140@deffn {Command} {no bgp multiple-instance} {}
1141Disable BGP multiple instance feature. You can not disable this feature
1142when BGP multiple instances or views exist.
1143@end deffn
1144
1145When you want to make configuration more Cisco like one,
1146
1147@deffn {Command} {bgp config-type cisco} {}
1148Cisco compatible BGP configuration output.
1149@end deffn
1150
1151When bgp config-type cisco is specified,
1152
1153``no synchronization'' is displayed.
Ivan Moskalyov2b09e212010-03-11 17:14:35 +03001154``no auto-summary'' is displayed.
paul718e3742002-12-13 20:15:29 +00001155
1156``network'' and ``aggregate-address'' argument is displayed as
1157``A.B.C.D M.M.M.M''
1158
paul7190f4e2003-08-12 12:40:20 +00001159Quagga: network 10.0.0.0/8
paul718e3742002-12-13 20:15:29 +00001160Cisco: network 10.0.0.0
1161
paul7190f4e2003-08-12 12:40:20 +00001162Quagga: aggregate-address 192.168.0.0/24
paul718e3742002-12-13 20:15:29 +00001163Cisco: aggregate-address 192.168.0.0 255.255.255.0
1164
1165Community attribute handling is also different. If there is no
1166configuration is specified community attribute and extended community
1167attribute are sent to neighbor. When user manually disable the
1168feature community attribute is not sent to the neighbor. In case of
paulaa5943f2005-11-04 21:53:59 +00001169@command{bgp config-type cisco} is specified, community attribute is not
paul718e3742002-12-13 20:15:29 +00001170sent to the neighbor by default. To send community attribute user has
paulaa5943f2005-11-04 21:53:59 +00001171to specify @command{neighbor A.B.C.D send-community} command.
paul718e3742002-12-13 20:15:29 +00001172
paulaa5943f2005-11-04 21:53:59 +00001173@example
paul718e3742002-12-13 20:15:29 +00001174!
1175router bgp 1
1176 neighbor 10.0.0.1 remote-as 1
1177 no neighbor 10.0.0.1 send-community
1178!
paul718e3742002-12-13 20:15:29 +00001179router bgp 1
1180 neighbor 10.0.0.1 remote-as 1
1181 neighbor 10.0.0.1 send-community
1182!
paulaa5943f2005-11-04 21:53:59 +00001183@end example
paul718e3742002-12-13 20:15:29 +00001184
1185@deffn {Command} {bgp config-type zebra} {}
paul7190f4e2003-08-12 12:40:20 +00001186Quagga style BGP configuration. This is default.
paul718e3742002-12-13 20:15:29 +00001187@end deffn
1188
paul76b89b42004-11-06 17:13:09 +00001189@node BGP instance and view
paul718e3742002-12-13 20:15:29 +00001190@subsection BGP instance and view
1191
1192BGP instance is a normal BGP process. The result of route selection
1193goes to the kernel routing table. You can setup different AS at the
1194same time when BGP multiple instance feature is enabled.
1195
1196@deffn {Command} {router bgp @var{as-number}} {}
1197Make a new BGP instance. You can use arbitrary word for the @var{name}.
1198@end deffn
1199
1200@example
1201@group
1202bgp multiple-instance
1203!
1204router bgp 1
1205 neighbor 10.0.0.1 remote-as 2
1206 neighbor 10.0.0.2 remote-as 3
1207!
1208router bgp 2
1209 neighbor 10.0.0.3 remote-as 4
1210 neighbor 10.0.0.4 remote-as 5
1211@end group
1212@end example
1213
1214BGP view is almost same as normal BGP process. The result of
1215route selection does not go to the kernel routing table. BGP view is
1216only for exchanging BGP routing information.
1217
1218@deffn {Command} {router bgp @var{as-number} view @var{name}} {}
1219Make a new BGP view. You can use arbitrary word for the @var{name}. This
1220view's route selection result does not go to the kernel routing table.
1221@end deffn
1222
1223With this command, you can setup Route Server like below.
1224
1225@example
1226@group
1227bgp multiple-instance
1228!
1229router bgp 1 view 1
1230 neighbor 10.0.0.1 remote-as 2
1231 neighbor 10.0.0.2 remote-as 3
1232!
1233router bgp 2 view 2
1234 neighbor 10.0.0.3 remote-as 4
1235 neighbor 10.0.0.4 remote-as 5
1236@end group
1237@end example
1238
paul76b89b42004-11-06 17:13:09 +00001239@node Routing policy
paul718e3742002-12-13 20:15:29 +00001240@subsection Routing policy
1241
1242You can set different routing policy for a peer. For example, you can
1243set different filter for a peer.
1244
1245@example
1246@group
1247bgp multiple-instance
1248!
1249router bgp 1 view 1
1250 neighbor 10.0.0.1 remote-as 2
1251 neighbor 10.0.0.1 distribute-list 1 in
1252!
1253router bgp 1 view 2
1254 neighbor 10.0.0.1 remote-as 2
1255 neighbor 10.0.0.1 distribute-list 2 in
1256@end group
1257@end example
1258
1259This means BGP update from a peer 10.0.0.1 goes to both BGP view 1 and view
12602. When the update is inserted into view 1, distribute-list 1 is
1261applied. On the other hand, when the update is inserted into view 2,
1262distribute-list 2 is applied.
1263
paul76b89b42004-11-06 17:13:09 +00001264@node Viewing the view
paul718e3742002-12-13 20:15:29 +00001265@subsection Viewing the view
1266
1267To display routing table of BGP view, you must specify view name.
1268
1269@deffn {Command} {show ip bgp view @var{name}} {}
1270Display routing table of BGP view @var{name}.
1271@end deffn
1272
paul76b89b42004-11-06 17:13:09 +00001273@node How to set up a 6-Bone connection
paul718e3742002-12-13 20:15:29 +00001274@section How to set up a 6-Bone connection
1275
paul6a22b1f2004-11-07 19:39:13 +00001276
paul718e3742002-12-13 20:15:29 +00001277@example
1278@group
1279zebra configuration
1280===================
1281!
1282! Actually there is no need to configure zebra
1283!
1284
1285bgpd configuration
1286==================
1287!
1288! This means that routes go through zebra and into the kernel.
1289!
1290router zebra
1291!
1292! MP-BGP configuration
1293!
1294router bgp 7675
1295 bgp router-id 10.0.0.1
1296 neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 remote-as @var{as-number}
1297!
1298 address-family ipv6
1299 network 3ffe:506::/32
1300 neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 activate
1301 neighbor 3ffe:1cfa:0:2:2a0:c9ff:fe9e:f56 route-map set-nexthop out
1302 neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 remote-as @var{as-number}
1303 neighbor 3ffe:1cfa:0:2:2c0:4fff:fe68:a231 route-map set-nexthop out
1304 exit-address-family
1305!
1306ipv6 access-list all permit any
1307!
1308! Set output nexthop address.
1309!
1310route-map set-nexthop permit 10
1311 match ipv6 address all
1312 set ipv6 nexthop global 3ffe:1cfa:0:2:2c0:4fff:fe68:a225
1313 set ipv6 nexthop local fe80::2c0:4fff:fe68:a225
1314!
1315! logfile FILENAME is obsolete. Please use log file FILENAME
paul7190f4e2003-08-12 12:40:20 +00001316
paul718e3742002-12-13 20:15:29 +00001317log file bgpd.log
1318!
1319@end group
1320@end example
1321
paul76b89b42004-11-06 17:13:09 +00001322@node Dump BGP packets and table
paul718e3742002-12-13 20:15:29 +00001323@section Dump BGP packets and table
1324
1325@deffn Command {dump bgp all @var{path}} {}
1326@deffnx Command {dump bgp all @var{path} @var{interval}} {}
1327Dump all BGP packet and events to @var{path} file.
1328@end deffn
1329
1330@deffn Command {dump bgp updates @var{path}} {}
1331@deffnx Command {dump bgp updates @var{path} @var{interval}} {}
1332Dump BGP updates to @var{path} file.
1333@end deffn
1334
1335@deffn Command {dump bgp routes @var{path}} {}
1336@deffnx Command {dump bgp routes @var{path}} {}
1337Dump whole BGP routing table to @var{path}. This is heavy process.
1338@end deffn
paulaa5943f2005-11-04 21:53:59 +00001339
1340@node BGP Configuration Examples
1341@section BGP Configuration Examples
1342
1343Example of a session to an upstream, advertising only one prefix to it.
1344
1345@example
1346router bgp 64512
1347 bgp router-id 10.236.87.1
1348 network 10.236.87.0/24
1349 neighbor upstream peer-group
1350 neighbor upstream remote-as 64515
1351 neighbor upstream capability dynamic
1352 neighbor upstream prefix-list pl-allowed-adv out
1353 neighbor 10.1.1.1 peer-group upstream
1354 neighbor 10.1.1.1 description ACME ISP
1355!
1356ip prefix-list pl-allowed-adv seq 5 permit 82.195.133.0/25
1357ip prefix-list pl-allowed-adv seq 10 deny any
1358
1359@end example
1360
1361A more complex example. With upstream, peer and customer sessions.
1362Advertising global prefixes and NO_EXPORT prefixes and providing
1363actions for customer routes based on community values. Extensive use of
1364route-maps and the 'call' feature to support selective advertising of
1365prefixes. This example is intended as guidance only, it has NOT been
1366tested and almost certainly containts silly mistakes, if not serious
1367flaws.
1368
1369@example
1370router bgp 64512
1371 bgp router-id 10.236.87.1
1372 network 10.123.456.0/24
1373 network 10.123.456.128/25 route-map rm-no-export
1374 neighbor upstream capability dynamic
1375 neighbor upstream route-map rm-upstream-out out
1376 neighbor cust capability dynamic
1377 neighbor cust route-map rm-cust-in in
1378 neighbor cust route-map rm-cust-out out
1379 neighbor cust send-community both
1380 neighbor peer capability dynamic
1381 neighbor peer route-map rm-peer-in in
1382 neighbor peer route-map rm-peer-out out
1383 neighbor peer send-community both
1384 neighbor 10.1.1.1 remote-as 64515
1385 neighbor 10.1.1.1 peer-group upstream
1386 neighbor 10.2.1.1 remote-as 64516
1387 neighbor 10.2.1.1 peer-group upstream
1388 neighbor 10.3.1.1 remote-as 64517
1389 neighbor 10.3.1.1 peer-group cust-default
1390 neighbor 10.3.1.1 description customer1
1391 neighbor 10.3.1.1 prefix-list pl-cust1-network in
1392 neighbor 10.4.1.1 remote-as 64518
1393 neighbor 10.4.1.1 peer-group cust
1394 neighbor 10.4.1.1 prefix-list pl-cust2-network in
1395 neighbor 10.4.1.1 description customer2
1396 neighbor 10.5.1.1 remote-as 64519
1397 neighbor 10.5.1.1 peer-group peer
1398 neighbor 10.5.1.1 prefix-list pl-peer1-network in
1399 neighbor 10.5.1.1 description peer AS 1
1400 neighbor 10.6.1.1 remote-as 64520
1401 neighbor 10.6.1.1 peer-group peer
1402 neighbor 10.6.1.1 prefix-list pl-peer2-network in
1403 neighbor 10.6.1.1 description peer AS 2
1404!
1405ip prefix-list pl-default permit 0.0.0.0/0
1406!
1407ip prefix-list pl-upstream-peers permit 10.1.1.1/32
1408ip prefix-list pl-upstream-peers permit 10.2.1.1/32
1409!
1410ip prefix-list pl-cust1-network permit 10.3.1.0/24
1411ip prefix-list pl-cust1-network permit 10.3.2.0/24
1412!
1413ip prefix-list pl-cust2-network permit 10.4.1.0/24
1414!
1415ip prefix-list pl-peer1-network permit 10.5.1.0/24
1416ip prefix-list pl-peer1-network permit 10.5.2.0/24
1417ip prefix-list pl-peer1-network permit 192.168.0.0/24
1418!
1419ip prefix-list pl-peer2-network permit 10.6.1.0/24
1420ip prefix-list pl-peer2-network permit 10.6.2.0/24
1421ip prefix-list pl-peer2-network permit 192.168.1.0/24
1422ip prefix-list pl-peer2-network permit 192.168.2.0/24
1423ip prefix-list pl-peer2-network permit 172.16.1/24
1424!
1425ip as-path access-list asp-own-as permit ^$
1426ip as-path access-list asp-own-as permit _64512_
1427!
1428! #################################################################
1429! Match communities we provide actions for, on routes receives from
1430! customers. Communities values of <our-ASN>:X, with X, have actions:
1431!
1432! 100 - blackhole the prefix
1433! 200 - set no_export
1434! 300 - advertise only to other customers
1435! 400 - advertise only to upstreams
1436! 500 - set no_export when advertising to upstreams
1437! 2X00 - set local_preference to X00
1438!
1439! blackhole the prefix of the route
1440ip community-list standard cm-blackhole permit 64512:100
1441!
1442! set no-export community before advertising
1443ip community-list standard cm-set-no-export permit 64512:200
1444!
1445! advertise only to other customers
1446ip community-list standard cm-cust-only permit 64512:300
1447!
1448! advertise only to upstreams
1449ip community-list standard cm-upstream-only permit 64512:400
1450!
1451! advertise to upstreams with no-export
1452ip community-list standard cm-upstream-noexport permit 64512:500
1453!
1454! set local-pref to least significant 3 digits of the community
1455ip community-list standard cm-prefmod-100 permit 64512:2100
1456ip community-list standard cm-prefmod-200 permit 64512:2200
1457ip community-list standard cm-prefmod-300 permit 64512:2300
1458ip community-list standard cm-prefmod-400 permit 64512:2400
1459ip community-list expanded cme-prefmod-range permit 64512:2...
1460!
1461! Informational communities
1462!
1463! 3000 - learned from upstream
1464! 3100 - learned from customer
1465! 3200 - learned from peer
1466!
1467ip community-list standard cm-learnt-upstream permit 64512:3000
1468ip community-list standard cm-learnt-cust permit 64512:3100
1469ip community-list standard cm-learnt-peer permit 64512:3200
1470!
1471! ###################################################################
1472! Utility route-maps
1473!
1474! These utility route-maps generally should not used to permit/deny
1475! routes, i.e. they do not have meaning as filters, and hence probably
1476! should be used with 'on-match next'. These all finish with an empty
1477! permit entry so as not interfere with processing in the caller.
1478!
1479route-map rm-no-export permit 10
1480 set community additive no-export
1481route-map rm-no-export permit 20
1482!
1483route-map rm-blackhole permit 10
1484 description blackhole, up-pref and ensure it cant escape this AS
1485 set ip next-hop 127.0.0.1
1486 set local-preference 10
1487 set community additive no-export
1488route-map rm-blackhole permit 20
1489!
1490! Set local-pref as requested
1491route-map rm-prefmod permit 10
1492 match community cm-prefmod-100
1493 set local-preference 100
1494route-map rm-prefmod permit 20
1495 match community cm-prefmod-200
1496 set local-preference 200
1497route-map rm-prefmod permit 30
1498 match community cm-prefmod-300
1499 set local-preference 300
1500route-map rm-prefmod permit 40
1501 match community cm-prefmod-400
1502 set local-preference 400
1503route-map rm-prefmod permit 50
1504!
1505! Community actions to take on receipt of route.
1506route-map rm-community-in permit 10
1507 description check for blackholing, no point continuing if it matches.
1508 match community cm-blackhole
1509 call rm-blackhole
1510route-map rm-community-in permit 20
1511 match community cm-set-no-export
1512 call rm-no-export
1513 on-match next
1514route-map rm-community-in permit 30
1515 match community cme-prefmod-range
1516 call rm-prefmod
1517route-map rm-community-in permit 40
1518!
1519! #####################################################################
1520! Community actions to take when advertising a route.
1521! These are filtering route-maps,
1522!
1523! Deny customer routes to upstream with cust-only set.
1524route-map rm-community-filt-to-upstream deny 10
1525 match community cm-learnt-cust
1526 match community cm-cust-only
1527route-map rm-community-filt-to-upstream permit 20
1528!
1529! Deny customer routes to other customers with upstream-only set.
1530route-map rm-community-filt-to-cust deny 10
1531 match community cm-learnt-cust
1532 match community cm-upstream-only
1533route-map rm-community-filt-to-cust permit 20
1534!
1535! ###################################################################
1536! The top-level route-maps applied to sessions. Further entries could
1537! be added obviously..
1538!
1539! Customers
1540route-map rm-cust-in permit 10
1541 call rm-community-in
1542 on-match next
1543route-map rm-cust-in permit 20
1544 set community additive 64512:3100
1545route-map rm-cust-in permit 30
1546!
1547route-map rm-cust-out permit 10
1548 call rm-community-filt-to-cust
1549 on-match next
1550route-map rm-cust-out permit 20
1551!
1552! Upstream transit ASes
1553route-map rm-upstream-out permit 10
1554 description filter customer prefixes which are marked cust-only
1555 call rm-community-filt-to-upstream
1556 on-match next
1557route-map rm-upstream-out permit 20
1558 description only customer routes are provided to upstreams/peers
1559 match community cm-learnt-cust
1560!
1561! Peer ASes
1562! outbound policy is same as for upstream
1563route-map rm-peer-out permit 10
1564 call rm-upstream-out
1565!
1566route-map rm-peer-in permit 10
1567 set community additive 64512:3200
1568@end example