]>
Commit | Line | Data |
---|---|---|
04a22949 | 1 | <!doctype birddoc system> |
d37f899b PM |
2 | |
3 | <!-- | |
d150c637 | 4 | BIRD documentation |
d37f899b | 5 | |
02357f96 PM |
6 | This documentation can have 4 forms: sgml (this is master copy), html, |
7 | ASCII text and dvi/postscript (generated from sgml using | |
8 | sgmltools). You should always edit master copy. | |
9 | ||
4e8ec666 | 10 | This is a slightly modified linuxdoc dtd. Anything in <descrip> tags is considered definition of |
326e33f5 | 11 | configuration primitives, <cf> is fragment of configuration within normal text, <m> is |
cd4fecb6 | 12 | "meta" information within fragment of configuration - something in config which is not keyword. |
d37f899b PM |
13 | |
14 | (set-fill-column 100) | |
15 | ||
16 | Copyright 1999,2000 Pavel Machek <pavel@ucw.cz>, distribute under GPL version 2 or later. | |
17 | ||
18 | --> | |
19 | ||
371adba6 | 20 | <book> |
d37f899b | 21 | |
aa185265 | 22 | <title>BIRD User's Guide |
d37f899b | 23 | <author> |
aa185265 MM |
24 | Ondrej Filip <it/<feela@network.cz>/, |
25 | Pavel Machek <it/<pavel@ucw.cz>/, | |
26 | Martin Mares <it/<mj@ucw.cz>/ | |
27 | </author> | |
d37f899b | 28 | |
d37f899b | 29 | <abstract> |
aa185265 | 30 | This document contains user documentation for the BIRD Internet Routing Daemon project. |
d37f899b PM |
31 | </abstract> |
32 | ||
33 | <!-- Table of contents --> | |
34 | <toc> | |
35 | ||
36 | <!-- Begin the document --> | |
37 | ||
371adba6 | 38 | <chapt>Introduction |
d37f899b | 39 | |
371adba6 | 40 | <sect>What is BIRD |
d37f899b | 41 | |
897cd7aa MM |
42 | <p><label id="intro"> |
43 | The name `BIRD' is actually an acronym standing for `BIRD Internet Routing Daemon'. | |
44 | Let's take a closer look at the meaning of the name: | |
45 | ||
46 | <p><em/BIRD/: Well, we think we have already explained that. It's an acronym standing | |
47 | for `BIRD Internet Routing Daemon', you remember, don't you? :-) | |
48 | ||
49 | <p><em/Internet Routing/: It's a program (well, a daemon, as you are going to discover in a moment) | |
50 | which works as a dynamic router in an Internet type network (that is, in a network running either | |
51 | the IPv4 or the IPv6 protocol). Routers are devices which forward packets between interconnected | |
52 | networks in order to allow hosts not connected directly to the same local area network to | |
02357f96 | 53 | communicate with each other. They also communicate with the other routers in the Internet to discover |
897cd7aa | 54 | the topology of the network which allows them to find optimal (in terms of some metric) rules for |
02357f96 | 55 | forwarding of packets (which will be called routes in the rest of this document) and to adapt themselves to the |
897cd7aa MM |
56 | changing conditions such as outages of network links, building of new connections and so on. Most of |
57 | these routers are costly dedicated devices running obscure firmware which is hard to configure and | |
02357f96 | 58 | not open to any changes (on the other hand, their special hardware design allows them to keep up with lots of high-speed network interfaces, better than general-purpose computer does). Fortunately, most operating systems of the UNIX family allow an ordinary |
897cd7aa MM |
59 | computer to act as a router and forward packets belonging to the other hosts, but only according to |
60 | a statically configured table. | |
61 | ||
62 | <p>A <em/Routing Daemon/ is in UNIX terminology a non-interactive program running on | |
63 | background which does the dynamic part of Internet routing, that is it communicates | |
64 | with the other routers, calculates routing tables and sends them to the OS kernel | |
02357f96 | 65 | which does the actual packet forwarding. There already exist other such routing daemons: routed (rip only), GateD<HTMLURL URL="http://www.gated.org/"> |
4e8ec666 | 66 | (non free), Zebra<HTMLURL URL="http://www.zebra.org"> and MRTD<HTMLURL URL="http://www.zcu.cz/ftp/mirrors/mmrz/mrtd">, but their capabilities are limited and |
068b4127 | 67 | they are relatively hard to configure and maintain. |
897cd7aa MM |
68 | |
69 | <p>BIRD is an Internet Routing Daemon designed to avoid all of these shortcomings, | |
5459fac6 | 70 | to support all the routing technology used in the today's Internet or planned to be |
897cd7aa MM |
71 | used in near future and to have a clean extensible architecture allowing new routing |
72 | protocols to be incorporated easily. Among other features, BIRD supports: | |
73 | ||
74 | <itemize> | |
75 | <item>both IPv4 and IPv6 protocols | |
76 | <item>multiple routing tables | |
77 | <item>the Border Gateway Protocol (BGPv4) | |
78 | <item>the Routing Interchange Protocol (RIPv2) | |
79 | <item>the Open Shortest Path First protocol (OSPFv2) | |
02357f96 | 80 | <item>a virtual protocol for exchange of routes between different routing tables on a single host |
897cd7aa MM |
81 | <item>a command-line interface allowing on-line control and inspection |
82 | of status of the daemon | |
83 | <item>soft reconfiguration (no need to use complex online commands | |
84 | to change the configuration, just edit the configuration file | |
02357f96 | 85 | and notify BIRD to re-read it and it will smoothly switch itself |
897cd7aa MM |
86 | to the new configuration, not disturbing routing protocols |
87 | unless they are affected by the configuration changes) | |
02357f96 | 88 | <item>a powerful language for route filtering |
897cd7aa MM |
89 | </itemize> |
90 | ||
91 | <p>BIRD has been developed at the Faculty of Math and Physics, Charles University, Prague, | |
e9df1bb6 | 92 | Czech Republic as a student project. It can be freely distributed under the terms of the GNU General |
897cd7aa MM |
93 | Public License. |
94 | ||
95 | <p>BIRD has been designed to work on all UNIX-like systems. It has been developed and | |
02357f96 | 96 | tested under Linux 2.0 to 2.4, but porting to other systems (even non-UNIX ones) should |
068b4127 | 97 | be relatively easy due to its highly modular architecture. |
d37f899b | 98 | |
371adba6 | 99 | <sect>Installing BIRD |
440439e3 | 100 | |
02357f96 | 101 | <p>On a recent UNIX system with GNU development tools (GCC, binutils, m4, make) and Perl, installing BIRD should be as easy as: |
440439e3 PM |
102 | |
103 | <code> | |
104 | ./configure | |
105 | make | |
106 | make install | |
107 | vi /usr/local/etc/bird.conf | |
c184d9d0 | 108 | bird |
440439e3 PM |
109 | </code> |
110 | ||
02357f96 PM |
111 | <p>You can use <tt>./configure --help</tt> to get a list of configure |
112 | options. The most important ones are: | |
113 | <tt/--enable-ipv6/ which enables building of an IPv6 version of BIRD, | |
114 | <tt/--with-protocols=/ to produce a slightly smaller BIRD executable by configuring out routing protocols you don't use, and | |
115 | <tt/--prefix=/ to install BIRD to a place different from. | |
b093c328 PM |
116 | <file>/usr/local</file>. |
117 | ||
02357f96 | 118 | <sect>Running BIRD |
36032ded | 119 | |
c184d9d0 | 120 | <p>You can pass several command-line options to bird: |
d26524fa | 121 | |
c184d9d0 PM |
122 | <descrip> |
123 | <tag>-c <m/config name/</tag> | |
02357f96 | 124 | use given configuration file instead of <file>$prefix/etc/bird.conf</file>. |
c184d9d0 PM |
125 | |
126 | <tag>-d</tag> | |
02357f96 | 127 | enable debug messages and run bird in foreground. |
c184d9d0 | 128 | |
02357f96 PM |
129 | <tag>-D <m/filename of debug log/</tag> |
130 | log debugging information to given file instead of stderr | |
c184d9d0 PM |
131 | |
132 | <tag>-s <m/name of communication socket/</tag> | |
02357f96 | 133 | use given filename for a socket for communications with the client, default is <file>$prefix/var/run/bird.ctl</file>. |
c184d9d0 | 134 | </descrip> |
d26524fa | 135 | |
02357f96 PM |
136 | <p>BIRD writes messages about its work to log files or syslog (according to config). |
137 | ||
a852c139 PM |
138 | <chapt>About routing tables |
139 | ||
02357f96 | 140 | <p>BIRD has one or more routing tables, which may or may not be |
a852c139 PM |
141 | synchronized with kernel and which may or may not be synchronized with |
142 | each other (see the Pipe protocol). Each routing table contains list of | |
143 | known routes. Each route consists of: | |
144 | ||
145 | <itemize> | |
4e8ec666 | 146 | <item>network prefix this route is for (consists of network address and number of bits forming the network part of the address) |
a852c139 PM |
147 | <item>preference of this route (taken from preference of |
148 | protocol and possibly altered by filters) | |
02357f96 PM |
149 | <item>IP address of router who told us about this route |
150 | <item>IP address of router we should forward the packets to | |
a852c139 PM |
151 | using this route |
152 | <item>other attributes common to all routes | |
02357f96 PM |
153 | <item>dynamic attributes defined by protocols which may or |
154 | may not be present (typically protocol metrics) | |
a852c139 PM |
155 | </itemize> |
156 | ||
157 | Routing table maintains more than | |
02357f96 | 158 | one entry for a network, but at most one entry for one network and one |
a852c139 | 159 | protocol. The entry with biggest preference is used for routing. If |
02357f96 | 160 | there are more entries with the same preference and they are from the same |
a852c139 PM |
161 | protocol, protocol decides (typically according to metrics). If not, |
162 | internal ordering is used to decide. You can | |
163 | get list of route attributes in "Route attributes" section in | |
164 | filters. | |
165 | ||
02357f96 PM |
166 | <p>Protocols are connected to routing tables through filters. Routes |
167 | that come from other routers go to the protocol, it then passes them to | |
a852c139 PM |
168 | filters, if import filter accepts route, it gets to main routing |
169 | table. It is then broadcasted to all other protocols (filtered through | |
02357f96 | 170 | their export filters), which typically send it to other routers. |
a852c139 PM |
171 | |
172 | Filters can alter routes passed between routing tables and | |
173 | protocols. | |
174 | ||
371adba6 | 175 | <chapt>Configuration |
af0b25d2 | 176 | |
371adba6 | 177 | <sect>Introduction |
d37f899b | 178 | |
02357f96 PM |
179 | <p>BIRD is configured using a text configuration file. Upon startup, BIRD reads <file>$prefix/bird.conf</file> (unless the |
180 | <tt/-c/ command line option is given). Configuration may be changed on user's request: if you modify | |
181 | config file and then signal BIRD with SIGHUP, it will adjust to the new | |
182 | config. Then there's the client, | |
183 | which allows you to talk with BIRD in an extensive way. (Of course you can tell BIRD to reconfigure from BIRDC, you can also tell it to shut down, dump various info etc.). | |
184 | ||
185 | <p>In the config, everything on a line after <cf/#/ or inside <cf>/* | |
186 | */</cf> is a comment, whitespace characters are treated as a single space. If there's a variable number of options, they are grouped using | |
187 | the <cf/{ }/ brackets. Each option is terminated by a <cf/;/. Configuration | |
326e33f5 PM |
188 | is case sensitive. |
189 | ||
02357f96 PM |
190 | <p>Here is an example of a simple config file. It enables |
191 | synchronization of routing tables with OS kernel, scans for | |
192 | new network interfaces every 10 seconds and runs RIP on all network interfaces found. | |
4a5bb2bf | 193 | |
d37f899b | 194 | |
a0dd1c74 | 195 | <code> |
d37f899b | 196 | protocol kernel { |
d150c637 | 197 | persist; # Don't remove routes on BIRD shutdown |
d37f899b PM |
198 | scan time 20; # Scan kernel routing table every 20 seconds |
199 | export all; # Default is export none | |
200 | } | |
201 | ||
202 | protocol device { | |
203 | scan time 10; # Scan interfaces every 10 seconds | |
204 | } | |
205 | ||
206 | protocol rip { | |
207 | export all; | |
208 | import all; | |
209 | } | |
a0dd1c74 | 210 | </code> |
d37f899b | 211 | |
326e33f5 | 212 | |
371adba6 | 213 | <sect>Global options |
af0b25d2 | 214 | |
a0dd1c74 | 215 | <p><descrip> |
2f647f3f | 216 | <tag>log "<m/filename/"|syslog|stderr all|{ <m/list of classes/ }</tag> |
02357f96 | 217 | Set logging of messages having the given (either <cf/all/ or <cf/{ |
242352b7 | 218 | error, trace }/ etc.) into selected destination. Classes are: |
02357f96 | 219 | <cf/info/, <cf/warning/, <cf/error/ and <cf/fatal/ for messages about local problems |
98627595 | 220 | <cf/debug/ for debugging messages, |
02357f96 PM |
221 | <cf/trace/ when you want to know what happens in the network, |
222 | <cf/remote/ for messages about misbehavior of remote machines, | |
223 | <cf/auth/ about authentication failures, | |
4e8ec666 | 224 | <cf/bug/ for internal BIRD bugs. You may specify more than one <cf/log/ line to establish logging to multiple |
5a203dac | 225 | destinations. Default: log everything to the system log. |
02357f96 | 226 | |
7581b81b | 227 | <tag>debug protocols all|off|{ states, routes, filters, interfaces, events, packets }</tag> |
5a203dac PM |
228 | Set global defaults of protocol debugging options. See <cf/debug/ in the following section. Default: off. |
229 | ||
230 | <tag>debug commands <m/number/</tag> | |
231 | Control logging of client connections (0 for no logging, 1 for | |
232 | logging of connects and disconnects, 2 and higher for logging of | |
233 | all client commands). Default: 0. | |
249d238c | 234 | |
02357f96 | 235 | <tag>filter <m/name local variables/{ <m/commands/ }</tag> Define a filter. You can learn more about filters |
5a203dac | 236 | in the following chapter. |
326e33f5 | 237 | |
02357f96 PM |
238 | <tag>function <m/name (parameters) local variables/ { <m/commands/ }</tag> Define a function. You can learn more |
239 | about functions in the following chapter. | |
bfd71178 | 240 | |
02357f96 PM |
241 | <tag>protocol rip|ospf|bgp|... <m/[name]/ { <m>protocol options</m> }</tag> Define a protocol |
242 | instance called <cf><m/name/</cf> (or with a name like "rip5" generated automatically, if you don't specify <cf><m/name/</cf>). You can learn more | |
d150c637 | 243 | about configuring protocols in their own chapters. You can run more than one instance of |
5a203dac | 244 | most protocols (like RIP or BGP). By default, no instances are configured. |
249d238c | 245 | |
02357f96 PM |
246 | <tag>define <m/constant/ = (<m/expression/)|<m/number/|<m/IP address/</tag> Define a constant. You can use it later in every place |
247 | you could use a simple integer or IP address. | |
249d238c | 248 | |
5a203dac | 249 | <tag>router id <m/IPv4 address/</tag> Set BIRD's router ID. It's a world-wide unique identification of your router, usually one of router's IPv4 addresses. Default: in IPv4 version, the lowest IP address of a non-loopback interface. In IPv6 version, this option is mandatory. |
249d238c | 250 | |
02357f96 | 251 | <tag>table <m/name/</tag> Create a new routing table. The default |
326e33f5 PM |
252 | routing table is created implicitly, other routing tables have |
253 | to be added by this command. | |
af0b25d2 | 254 | |
02357f96 PM |
255 | <tag>eval <m/expr/</tag> Evaluates given filter expression. It |
256 | is used by us for testing filters. | |
249d238c PM |
257 | </descrip> |
258 | ||
371adba6 | 259 | <sect>Protocol options |
bfd71178 | 260 | |
5a203dac PM |
261 | <p>For each protocol instance, you can configure a bunch of options. |
262 | Some of them (those described in this section) are generic, some are | |
263 | specific to the protocol (see sections talking about the protocols). | |
7581b81b | 264 | |
5a203dac PM |
265 | <p>Several options use a <cf><m/switch/</cf> argument. It can be either |
266 | <cf/on/, <cf/yes/ or a numeric expression with a non-zero value for the | |
267 | option to be enabled or <cf/off/, <cf/no/ or a numeric expression evaluating | |
268 | to zero to disable it. An empty <cf><m/switch/</cf> is equivalent to <cf/on/ | |
269 | ("silence means agreement"). | |
7581b81b | 270 | |
5a203dac PM |
271 | <descrip> |
272 | <tag>preference <m/expr/</tag> Sets the preference of routes generated by this protocol. Default: protocol dependent. | |
273 | ||
274 | <tag>disabled <m/switch/</tag> Disables the protocol. You can change the disable/enable status from the command | |
275 | line interface without needing to touch the configuration. Disabled protocols are not activated. Default: protocol is enabled. | |
276 | ||
277 | <tag>debug all|off|{ states, routes, filters, interfaces, events, packets }</tag> | |
278 | Set protocol debugging options. If asked, each protocol is capable of | |
279 | writing trace messages about its work to the log (with category | |
280 | <cf/trace/). You can either request printing of <cf/all/ trace messages | |
281 | or only of the types selected: <cf/states/ for protocol state changes | |
282 | (protocol going up, down, starting, stopping etc.), | |
283 | <cf/routes/ for routes exchanged with the routing table, | |
284 | <cf/filters/ for details on route filtering, | |
285 | <cf/interfaces/ for interface change events sent to the protocol, | |
286 | <cf/events/ for events internal to the protocol and | |
287 | <cf/packets/ for packets sent and received by the protocol. Default: off. | |
288 | ||
289 | <tag>import all | none | filter <m/name/ | filter { <m/filter commands/ } | where <m/filter expression/</tag> | |
290 | Specify a filter to be used for filtering routes coming from protocol to the routing table. <cf/all/ is shorthand for <cf/where true/ and <cf/none/ is shorthand for <cf/where false/. Default: <cf/all/. | |
bfd71178 | 291 | |
a7c9f7c0 | 292 | <tag>export <m/filter/</tag> This is similar to <cf>import</cf> keyword, except that it |
5a203dac | 293 | works in direction from the routing table to the protocol. Default: <cf/none/. |
af0b25d2 | 294 | |
a7c9f7c0 | 295 | <tag>table <m/name/</tag> Connect this protocol to a non-default routing table. |
7581b81b PM |
296 | </descrip> |
297 | ||
a7c9f7c0 | 298 | <p>There are several options that give sense only with certain protocols: |
7581b81b PM |
299 | |
300 | <descrip> | |
301 | <tag>passwords { password "<m/password/" from <m/time/ to <m/time/ passive <m/time/ id | |
a7c9f7c0 | 302 | <m/num/ [...] }</tag> Specifies passwords to be used with this protocol. <cf>Passive <m/time/</cf> is |
074a166d | 303 | time from which the password is not used for sending, but it is recognized on reception. <cf/id/ is password ID, as needed by |
5a203dac | 304 | certain protocols. Format of <cf><m/time/</cf> is <tt>dd-mm-yyyy HH:MM:SS</tt>. |
7581b81b | 305 | |
a7c9f7c0 PM |
306 | <tag>interface "<m/mask/"|<m/prefix/ [ { <m/option/ ; [ ... ] } ]</tag> Specifies which |
307 | interfaces this protocol is active on, and allows you to set options on | |
308 | per-interface basis. Mask is specified in shell-like patterns, thus <cf>interface | |
309 | "*" { mode broadcast; };</cf> will start the protocol on all interfaces with <cf>mode | |
326e33f5 | 310 | broadcast;</cf> option. If first character of mask is <cf/-/, such interfaces are |
a7c9f7c0 | 311 | excluded. Masks are parsed left-to-right, thus <cf/interface "-eth*", "*";/ means all but |
5a203dac PM |
312 | the ethernets. Default: none. |
313 | ||
7581b81b | 314 | </descrip> |
d37f899b | 315 | |
5a203dac | 316 | <chapt>Remote control |
36032ded | 317 | |
a7c9f7c0 | 318 | <p>You can use the command-line client <file>birdc</file> to talk with |
5a203dac | 319 | a running BIRD. Communication is done using <file/bird.ctl/ UNIX domain |
a7c9f7c0 PM |
320 | socket (unless changed with the <tt/-s/ option given to both the server and |
321 | the client). The client can do simple actions such as enabling/disabling | |
36032ded PM |
322 | protocols, telling BIRD to show various information, telling it to |
323 | show routing table filtered by any filter, or telling bird to | |
324 | reconfigure. Press <tt/?/ at any time to get online help. Option | |
a7c9f7c0 | 325 | <tt/-v/ can be passed to the client, telling it to dump numeric return |
75317ab8 | 326 | codes. You do not necessarily need to use BIRDC to talk to BIRD, your |
c184d9d0 | 327 | own application could do that, too -- format of communication between |
75317ab8 | 328 | BIRD and BIRDC is stable (see programmer's documentation). |
c184d9d0 | 329 | |
5a203dac | 330 | <p>Here is a brief list of supported functions: |
64722c98 PM |
331 | |
332 | <descrip> | |
5a203dac PM |
333 | <tag>dump resources|sockets|interfaces|neighbors|attributes|routes|protocols</tag> |
334 | Dump contents of internal data structures to the debugging output. | |
335 | ||
336 | <tag>show status</tag> | |
337 | Show router status, that is bird version, uptime and time from last reconfiguration. | |
338 | ||
339 | <tag>show protocols [all]</tag> | |
340 | Show list of protocols along with tables they are connected to and status, possibly giving verbose information. | |
64722c98 | 341 | |
5a203dac PM |
342 | <tag>show ospf [interface|neighbors] [<m/name/] ["<m/interface/"]</tag> |
343 | Show detailed information about OSPF protocol, possibly giving a verbose list of interfaces and neighbors. The <m/name/ of the protocol instance can be omitted if there exists only a single instance. | |
64722c98 | 344 | |
5a203dac PM |
345 | <tag>show static [<m/name/]</tag> |
346 | Show detailed information about static routes. The <m/name/ of the protocol instance can be omitted if there exists only a single instance. | |
64722c98 | 347 | |
5a203dac PM |
348 | <tag>show interfaces [summary]</tag> |
349 | Show list of interfaces. For each interface, print its type, state, MTU and addresses assigned. | |
350 | ||
351 | <tag>show symbols</tag> | |
352 | Show list of symbols defined in the configuration (names of protocols, routing tables etc.). | |
353 | ||
354 | <tag>show route [<m/prefix/|for <m/prefix or IP/] [primary] [table <m/sym/] [all] [stats|count] [filter <m/name/|where <m/condition/] [(import|proto) <m/sym/]</tag> | |
355 | Show contents of a routing table (by default of the main one), | |
356 | i.e. routes, their metrics and (in case the <cf/all/ switch is given) | |
357 | all their attributes. | |
358 | ||
359 | <p>You can specify a <m/prefix/ if you want to print routes for a | |
360 | specific network. If you use <cf>for <m/prefix or IP/</cf>, you'll get | |
361 | the entry which will be used for forwarding of packets to the given | |
362 | destination. By default, all routes for each network are printed with | |
363 | the selected one at the top, unless <cf/primary/ is given in which case | |
364 | only the selected route is shown. | |
365 | ||
366 | <p>You can also ask for printing only routes processed and accepted by | |
367 | a given filter (<cf>filter <m/name/</cf> or <cf>filter { <m/filter/ } | |
368 | </cf> or matching a given condition (<cf>where <m/condition/</cf>). | |
369 | The <cf/import/ and <cf/proto/ switches ask for printing of entries as | |
370 | they would be seen by the specified protocol. With <cf/import/, the | |
371 | export filter of the protocol is skipped. | |
372 | ||
373 | <p>The <cf/stats/ switch requests showing of route statistics (the | |
374 | number of networks, number of routes before and after filtering). If | |
375 | you use <cf/count/ instead, only the statistics will be printed. | |
376 | ||
377 | <tag>enable|disable|restart <m/name/|"<m/pattern/"|all</tag> | |
378 | Enable, disable or restart given protocol instance, instances matching the <cf><m/pattern/</cf> or <cf/all/ instances. | |
379 | ||
380 | <tag>configure ["<m/config file/"]</tag> | |
381 | Reload configuration from a given file. | |
382 | ||
383 | <tag/down/ | |
384 | Shut BIRD down. | |
64722c98 PM |
385 | |
386 | <tag>debug <m/protocol/|<m/pattern/|all all|off|{ states | routes | filters | events | packets } | |
387 | Control protocol debugging. | |
388 | </descrip> | |
36032ded | 389 | |
371adba6 | 390 | <chapt>Filters |
d37f899b | 391 | |
371adba6 | 392 | <sect>Introduction |
d37f899b | 393 | |
a7c9f7c0 PM |
394 | <p>BIRD contains a rather simple programming language. (No, it can't yet read mail :-). There are |
395 | two objects in this language: filters and functions. Filters are called by BIRD core when a route is | |
4e8ec666 | 396 | being passed between protocols and routing tables. Filter language contains control structures such |
d37f899b | 397 | as if's and switches, but it allows no loops. Filters are |
a7c9f7c0 | 398 | interpreted. An example of a filter using many features can be found in <file>filter/test.conf</file>. |
d37f899b | 399 | |
a7c9f7c0 PM |
400 | <p>Filter gets the route, looks at its attributes and |
401 | modifies some of them if it wishes. At the end, it decides whether to | |
402 | pass the changed route through (using <cf/accept/) or whether to <cf/reject/ given route. A simple filter looks | |
0e5373fd | 403 | like this: |
d37f899b | 404 | |
a0dd1c74 | 405 | <code> |
d37f899b PM |
406 | filter not_too_far |
407 | int var; | |
408 | { | |
409 | if defined( rip_metric ) then | |
410 | var = rip_metric; | |
411 | else { | |
412 | var = 1; | |
413 | rip_metric = 1; | |
414 | } | |
415 | if rip_metric > 10 then | |
416 | reject "RIP metric is too big"; | |
417 | else | |
418 | accept "ok"; | |
419 | } | |
a0dd1c74 | 420 | </code> |
d37f899b | 421 | |
a7c9f7c0 PM |
422 | <p>As you can see, a filter has a header, a list of local variables, and a body. The header consists of |
423 | the <cf/filter/ keyword, followed by a (unique) name of filter. List of local variables consists of | |
0e7a720a | 424 | pairs <cf><M>type name</M>;</cf>, where each pair defines one local variable. Body consists of |
a7c9f7c0 PM |
425 | <cf> { <M>statements</M> }</cf>. Each <m/statement/ is terminated by <cf/;/. You can group |
426 | several statements into one by using braces (<cf>{ <M>statements</M> }</cf>), that is useful if | |
d37f899b PM |
427 | you want to make bigger block of code conditional. |
428 | ||
02357f96 | 429 | <p>BIRD supports functions, so that you don't have to repeat same blocks of code over and |
a7c9f7c0 | 430 | over. Functions can have zero or more parameters and they can have local variables. Recursion is not allowed. They |
326e33f5 | 431 | look like this: |
0e5373fd PM |
432 | |
433 | <code> | |
434 | function name () | |
435 | int local_variable; | |
436 | { | |
437 | local_variable = 5; | |
438 | } | |
439 | ||
440 | function with_parameters (int parameter) | |
441 | { | |
442 | print parameter; | |
443 | } | |
444 | </code> | |
445 | ||
a7c9f7c0 | 446 | <p>Unlike in C, variables are declared after function line but before the first {. You can't declare |
0e5373fd | 447 | variables in nested blocks. Functions are called like in C: <cf>name(); |
a7c9f7c0 PM |
448 | with_parameters(5);</cf>. Function may return value using the <cf>return <m/[expr]/</cf> |
449 | command. Returning a value exits from current function (this is similar to C). | |
0e5373fd | 450 | |
a7c9f7c0 PM |
451 | <p>Filters are declared in a way similar to functions except they can't have explicit |
452 | parameters. They get route table entry as an implicit parameter, it is also passed automatically | |
453 | to any functions called. The filter must terminate with either | |
454 | <cf/accept/ or <cf/reject/ statement. If there's runtime error in filter, the route | |
2f647f3f | 455 | is rejected. |
0e5373fd | 456 | |
a7c9f7c0 PM |
457 | <p>A nice trick to debug filters is to use <cf>show route filter |
458 | <m/name/</cf> from the command line client. An example session might look | |
c184d9d0 PM |
459 | like: |
460 | ||
461 | <code> | |
462 | pavel@bug:~/bird$ ./birdc -s bird.ctl | |
463 | BIRD 0.0.0 ready. | |
c184d9d0 PM |
464 | bird> show route |
465 | 10.0.0.0/8 dev eth0 [direct1 23:21] (240) | |
466 | 195.113.30.2/32 dev tunl1 [direct1 23:21] (240) | |
467 | 127.0.0.0/8 dev lo [direct1 23:21] (240) | |
468 | bird> show route ? | |
8798c811 | 469 | show route [<prefix>] [table <t>] [filter <f>] [all] [primary] [(import|protocol) <p>]... |
c184d9d0 PM |
470 | bird> show route filter { if 127.0.0.5 ~ net then accept; } |
471 | 127.0.0.0/8 dev lo [direct1 23:21] (240) | |
472 | bird> | |
473 | </code> | |
474 | ||
371adba6 | 475 | <sect>Data types |
d37f899b | 476 | |
a7c9f7c0 | 477 | <p>Each variable and each value has certain type. Booleans, integers and enums are |
326e33f5 | 478 | incompatible with each other (that is to prevent you from shooting in the foot). |
d37f899b PM |
479 | |
480 | <descrip> | |
a7c9f7c0 | 481 | <tag/bool/ This is a boolean type, it can have only two values, <cf/true/ and |
326e33f5 | 482 | <cf/false/. Boolean is not compatible with integer and is the only type you can use in if |
7581b81b | 483 | statements. |
d37f899b | 484 | |
a7c9f7c0 PM |
485 | <tag/int/ This is a general integer type, you can expect it to store signed values from -2000000000 |
486 | to +2000000000. Overflows are not checked. You can use <cf/0x1234/ syntax to write hexadecimal values. | |
d37f899b | 487 | |
a7c9f7c0 PM |
488 | <tag/pair/ This is a pair of two short integers. Each component can have values from 0 to |
489 | 65535. Literals of this type is written as <cf/(1234,5678)/. | |
d37f899b | 490 | |
a7c9f7c0 PM |
491 | <tag/string/ This is a string of characters. There are no ways to modify strings in |
492 | filters. You can pass them between functions, assign them to variables of type <cf/string/, print | |
493 | such variables, but you can't concatenate two strings. String literals | |
0e5373fd | 494 | are written as <cf/"This is a string constant"/. |
d37f899b | 495 | |
a7c9f7c0 | 496 | <tag/ip/ This type can hold a single IP address. Depending on the compile-time configuration of BIRD you are using, it |
5a203dac | 497 | is either an IPv4 or IPv6 address. IP addresses are written in the standard notation (<cf/10.20.30.40/ or <cf/fec0:3:4::1/). You can apply special operator <cf>.mask(<M>num</M>)</cf> |
0e7a720a | 498 | on values of type ip. It masks out all but first <cf><M>num</M></cf> bits from ip |
5a203dac | 499 | address. So <cf/1.2.3.4.mask(8) = 1.0.0.0/ is true. |
d37f899b | 500 | |
a7c9f7c0 | 501 | <tag/prefix/ This type can hold a network prefix consisting of IP address and prefix length. Prefix literals are written as |
0e5373fd PM |
502 | <cf><M>ipaddress</M>/<M>pxlen</M></cf>, or |
503 | <cf><m>ipaddress</m>/<m>netmask</m></cf> There are two special | |
504 | operators on prefix: | |
7581b81b | 505 | <cf/.ip/, which separates ip address from the pair, and <cf/.len/, which separates prefix |
326e33f5 | 506 | len from the pair. So <cf>1.2.0.0/16.pxlen = 16</cf> is true. |
d37f899b | 507 | |
326e33f5 | 508 | <tag/int|ip|prefix|pair|enum set/ |
a7c9f7c0 PM |
509 | Filters recognize four types of sets. Sets are similar to strings: you can pass them around |
510 | but you can't modify them. Literals of type <cf>set int</cf> look like <cf> | |
d37f899b | 511 | [ 1, 2, 5..7 ]</cf>. As you can see, both simple values and ranges are permitted in |
c184d9d0 | 512 | sets. Sets of prefixes are special: you can specify which prefix lengths should match them by |
a7c9f7c0 | 513 | using <cf>[ 1.0.0.0/8+, 2.0.0.0/8-, 3.0.0.0/8{5,6} ]</cf>. <cf>3.0.0.0/8{5,6}</cf> matches |
25696edb PM |
514 | prefixes <cf/3.X.X.X/, whose prefix length is 5 to 6. <cf><m>address</m>/<m>num</m>+</cf> is shorthand for <cf><m>address</m>/{0,<m/num/}</cf>, |
515 | <cf><m>address</m>/<m/num/-</cf> is shorthand for <cf><m>address</m>/{0,<m/num-1/}</cf>. For example, | |
a7c9f7c0 | 516 | <cf>1.2.0.0/16 ~ [ 1.0.0.0/8{ 15 , 17 } ]</cf> is true, but |
25696edb | 517 | <cf>1.0.0.0/8 ~ [ 1.0.0.0/8- ]</cf> is false. |
d37f899b PM |
518 | |
519 | <tag/enum/ | |
4e8ec666 | 520 | Enumeration types are fixed in BIRD -- you can't define your own |
a7c9f7c0 PM |
521 | variables of enumeration type, but some route attributes are of enumeration |
522 | type. Enumeration types are incompatible with each other. | |
0e5373fd PM |
523 | |
524 | <tag/bgppath/ | |
a7c9f7c0 | 525 | BGP path is a list of autonomous system numbers. You can't write literals of this type. |
4a5bb2bf | 526 | |
5a203dac PM |
527 | <tag/bgpmask/ |
528 | BGP masks are patterns used for BGP path matching | |
529 | (using <cf>path ˜ /2 3 5 ?/</cf> syntax). The masks | |
530 | resemble wildcard patterns as used by UNIX shells. Autonomous | |
531 | system numbers match themselves, <cf/?/ matches any (even empty) | |
532 | sequence of arbitrary AS numbers (<cf/*/ hasn't been chosen, because | |
533 | <cf>/*</cf> starts a comment). For example: | |
a7c9f7c0 | 534 | <tt>/4 3 2 1/ ~ /? 4 3 ?/</tt> is true, but |
5a203dac | 535 | <tt>/4 3 2 1/ ~ /? 4 5 ?/</tt> is false. |
4a5bb2bf | 536 | <tag/clist/ |
a7c9f7c0 | 537 | Community list is similar to set of pairs, |
4a5bb2bf | 538 | except that unlike other sets, it can be modified. |
a7c9f7c0 | 539 | There exist no literals of this type. |
0e5373fd | 540 | |
d37f899b PM |
541 | </descrip> |
542 | ||
a7c9f7c0 | 543 | <sect>Operators |
d37f899b | 544 | |
25696edb | 545 | <!-- Sorry, birddoc does not support tables. --> |
a7c9f7c0 PM |
546 | |
547 | <p>The filter language supports common integer operators <cf>(+,-,*,/)</cf>, parentheses <cf/(a*(b+c))/, comparison | |
25696edb PM |
548 | <cf/(a=b, a!=b, a<b, a>=b)/. Logical operations include unary not (<cf/!/), and (<cf/&&/) and or (<cf/||/). |
549 | Special operators include <cf/˜/ for "in" operation. In operation can be | |
550 | used on element and set of that elements (returning true if element is within given set), or on IP and prefix (returning true if IP is within range defined by that prefix), or on | |
4e8ec666 | 551 | prefix and prefix (returning true if first prefix is more specific than second) or on bgppath and bgpmask (returning true if path matches given path mask) or on pair and clist (returning true if given community is element of community list). |
25696edb | 552 | |
d37f899b | 553 | |
371adba6 | 554 | <sect>Control structures |
d37f899b | 555 | |
a7c9f7c0 PM |
556 | <p>Filters support two control structures: conditions and case switches. |
557 | ||
a7c9f7c0 | 558 | <p>Syntax of condition is <cf>if |
074a166d | 559 | <M>boolean expression</M> then <M>command1</M>; else <M>command2</M>;</cf> and you can use <cf>{ |
7581b81b | 560 | <M>command_1</M>; <M>command_2</M>; <M>...</M> }</cf> instead of one or both commands. <cf>else</cf> |
074a166d | 561 | clause may be omitted. If <cf><m>boolean expression</m></cf> is true, <cf><m>command1</m></cf> is executed, otherwise <cf><m>command2</m></cf> is executed. |
d37f899b | 562 | |
7581b81b | 563 | <p><cf>case</cf> is similar to case from Pascal. Syntax is <cf>case <m/expr/ { else | |
a7c9f7c0 PM |
564 | <m/num_or_prefix [ .. num_or_prefix]/: <m/statement/ ; [ ... ] }</cf>. Expression after |
565 | <cf>case</cf> can be of any type that can be on the left side of the ˜ operator, and anything that could | |
566 | be a member of a set is allowed before <cf/:/. Multiple commands are allowed without <cf/{}/ grouping | |
074a166d | 567 | and break is implicit before each case. If <cf><m/expr/</cf> matches one of <cf/:/ clauses, statements between it and next <cf/:/ statement are executed. If <cf><m/expr/</cf> matches neither of <cf/:/ clauses, <cf/else:/ statements after <cf/else:/ are executed. |
d37f899b | 568 | |
a7c9f7c0 | 569 | <p>Here is example that uses <cf/if/ and <cf/case/ structures: |
af0b25d2 PM |
570 | |
571 | <code> | |
572 | case arg1 { | |
573 | 2: print "two"; print "I can do more commands without {}"; | |
574 | 3 .. 5: print "three to five"; | |
575 | else: print "something else"; | |
a7c9f7c0 | 576 | } |
af0b25d2 | 577 | |
8798c811 PM |
578 | if 1234 = i then printn "."; else { |
579 | print "not 1234"; | |
580 | print "You need {} around multiple commands"; | |
581 | } | |
af0b25d2 PM |
582 | </code> |
583 | ||
371adba6 | 584 | <sect>Route attributes |
0e5373fd | 585 | |
a7c9f7c0 PM |
586 | <p>An filter is implicitly passed route, and it can access its |
587 | attributes just like it accesses variables. Attempt to access undefined | |
588 | attribute result in a runtime error; you can check if an attribute is | |
589 | defined using the <cf>defined( <m>attribute</m> )</cf> operator. | |
590 | ||
36032ded | 591 | <descrip> |
cd4fecb6 | 592 | <tag><m/prefix/ net</tag> |
25696edb | 593 | Network the route is talking about. Read-only. (See the section about routing tables.) |
a7c9f7c0 PM |
594 | |
595 | <tag><m/enum/ scope</tag> | |
5a203dac | 596 | Address scope of the network (<cf/SCOPE_HOST/ for addresses local to this host, <cf/SCOPE_LINK/ for those specific for a physical link, <cf/SCOPE_SITE/ and <cf/SCOPE_ORGANIZATION/ for private addresses, <cf/SCOPE_UNIVERSE/ for globally visible addresses). |
0e5373fd | 597 | |
cd4fecb6 | 598 | <tag><m/int/ preference</tag> |
a7c9f7c0 | 599 | Preference of the route. (See section about routing tables.) |
c184d9d0 | 600 | |
cd4fecb6 | 601 | <tag><m/ip/ from</tag> |
25696edb | 602 | The router which the route has originated from. Read-only. |
0e5373fd | 603 | |
cd4fecb6 | 604 | <tag><m/ip/ gw</tag> |
a7c9f7c0 | 605 | Next hop packets routed using this route should be forwarded to. |
0e5373fd | 606 | |
cd4fecb6 | 607 | <tag><m/enum/ source</tag> |
25696edb | 608 | what protocol has told me about this route. Possible values: <cf/RTS_DUMMY, RTS_STATIC, RTS_INHERIT, RTS_DEVICE, RTS_STATIC_DEVICE, RTS_REDIRECT, RTS_RIP, RTS_OSPF, RTS_OSPF_EXT, RTS_OSPF_IA, RTS_OSPF_BOUNDARY, RTS_BGP, RTS_PIPE/. |
c184d9d0 | 609 | |
cd4fecb6 | 610 | <tag><m/enum/ cast</tag> |
5a203dac | 611 | Route type (<cf/RTC_UNICAST/ for normal routes, <cf/RTC_BROADCAST, RTC_MULTICAST, RTC_ANYCAST/ for broadcast, multicast and anycast routes). Read-only. |
c184d9d0 | 612 | |
cd4fecb6 | 613 | <tag><m/enum/ dest</tag> |
5a203dac | 614 | Type of destination the packets should be sent to (<cf/RTD_ROUTER/ for forwarding to a neighboring router, <cf/RTD_NETWORK/ for routing to a directly-connected network, <cf/RTD_BLACKHOLE/ for packets to be silently discarded, <cf/RTD_UNREACHABLE/, <cf/RTD_PROHIBIT/ for packets that should be returned with ICMP host unreachable / ICMP administratively prohibited messages). Read-only. |
ba1dda49 | 615 | </descrip> |
0e5373fd | 616 | |
a7c9f7c0 | 617 | <p>There also exist some protocol-specific attributes, which are described in protocol sections. |
0e5373fd | 618 | |
b093c328 | 619 | <sect>Statements |
69477cad | 620 | |
a7c9f7c0 | 621 | <p>The following statements are available: |
69477cad PM |
622 | |
623 | <descrip> | |
a7c9f7c0 | 624 | <tag><m/variable/ = <m/expr/</tag> Set variable to a given value. |
326e33f5 | 625 | |
a7c9f7c0 | 626 | <tag>accept|reject [ <m/expr/ ]</tag> Accept or reject the route, possibly printing <cf><m>expr</m></cf>. |
326e33f5 | 627 | |
a7c9f7c0 | 628 | <tag>return <m/expr/</tag> Return <cf><m>expr</m></cf> from function, the function ends at this point. |
326e33f5 | 629 | |
a7c9f7c0 PM |
630 | <tag>print|printn <m/expr/ [<m/, expr.../]</tag> |
631 | Prints given expressions; useful mainly while debugging | |
632 | filters. The <cf/printn/ variant does not terminate the line. | |
69477cad PM |
633 | |
634 | <tag>quitbird</tag> | |
a7c9f7c0 | 635 | Terminates BIRD. Useful when debugging filter interpreter. |
69477cad PM |
636 | </descrip> |
637 | ||
371adba6 | 638 | <chapt>Protocols |
d37f899b | 639 | |
371adba6 | 640 | <sect>BGP |
1b55b1a3 | 641 | |
56ab03c7 | 642 | <p>The Border Gateway Protocol is the routing protocol used for backbone |
5a203dac | 643 | level routing in the today's Internet. Contrary to the other protocols, its convergence |
56ab03c7 MM |
644 | doesn't rely on all routers following the same rules for route selection, |
645 | making it possible to implement any routing policy at any router in the | |
646 | network, the only restriction being that if a router advertises a route, | |
647 | it must accept and forward packets according to it. | |
648 | ||
649 | <p>BGP works in terms of autonomous systems (often abbreviated as AS). Each | |
5a203dac PM |
650 | AS is a part of the network with common management and common routing policy. It is identified by a unique 16-bit number. |
651 | Routers within each AS usually communicate with each other using either a interior routing | |
56ab03c7 MM |
652 | protocol (such as OSPF or RIP) or an interior variant of BGP (called iBGP). |
653 | Boundary routers at the border of the AS communicate with their peers | |
654 | in the neighboring AS'es via exterior BGP (eBGP). | |
655 | ||
656 | <p>Each BGP router sends to its neighbors updates of the parts of its | |
5a203dac PM |
657 | routing table it wishes to export along with complete path information |
658 | (a list of AS'es the packet will travel through if it uses the particular | |
56ab03c7 MM |
659 | route) in order to avoid routing loops. |
660 | ||
5459fac6 MM |
661 | <p>BIRD supports all requirements of the BGP4 standard as defined in |
662 | RFC 1771<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1771.txt"> | |
663 | including several enhancements from the | |
664 | latest draft<htmlurl url="ftp://ftp.rfc-editor.org/internet-drafts/draft-ietf-idr-bgp4-09.txt">. | |
665 | It also supports the community attributes as per | |
666 | RFC 1997<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1997.txt">, | |
56ca7acd | 667 | capability negotiation defined in |
5a203dac | 668 | RFC 2842<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2842.txt">. |
5459fac6 MM |
669 | For IPv6, it uses the standard multiprotocol extensions defined in |
670 | RFC 2283<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2283.txt"> | |
671 | including changes described in the | |
5a203dac | 672 | latest draft<htmlurl url="ftp://ftp.rfc-editor.org/internet-drafts/draft-ietf-idr-bgp4-multiprotocol-v2-05.txt"> |
5459fac6 MM |
673 | and applied to IPv6 according to |
674 | RFC 2545<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2545.txt">. | |
675 | ||
371adba6 | 676 | <sect1>Route selection rules |
5459fac6 MM |
677 | |
678 | <p>BGP doesn't have any simple metric, so the rules for selection of an optimal | |
679 | route among multiple BGP routes with the same preference are a bit more complex | |
5a203dac | 680 | and they are implemented according to the following algorithm. It starts the first |
5459fac6 MM |
681 | rule, if there are more "best" routes, then it uses the second rule to choose |
682 | among them and so on. | |
683 | ||
684 | <itemize> | |
5a203dac | 685 | <item>Prefer route with the highest Local Preference attribute. |
5459fac6 MM |
686 | <item>Prefer route with the shortest AS path. |
687 | <item>Prefer IGP origin over EGP and EGP over incomplete. | |
688 | <item>Prefer the lowest value of the Multiple Exit Discriminator. | |
5a203dac PM |
689 | <item>Prefer internal routes over external ones. |
690 | <item>Prefer the route with the lowest value of router ID of the | |
5459fac6 MM |
691 | advertising router. |
692 | </itemize> | |
56ab03c7 | 693 | |
371adba6 | 694 | <sect1>Configuration |
56ab03c7 | 695 | |
5459fac6 | 696 | <p>Each instance of the BGP corresponds to one neighboring router. |
5a203dac PM |
697 | This allows to set routing policy and all the other parameters differently |
698 | for each neighbor using the following configuration parameters: | |
5459fac6 MM |
699 | |
700 | <descrip> | |
701 | <tag>local as <m/number/</tag> Define which AS we are part of. (Note that | |
702 | contrary to other IP routers, BIRD is able to act as a router located | |
703 | in multiple AS'es simultaneously, but in such cases you need to tweak | |
704 | the BGP paths manually in the filters to get consistent behavior.) | |
705 | This parameter is mandatory. | |
5a203dac | 706 | |
5459fac6 MM |
707 | <tag>neighbor <m/ip/ as <m/number/</tag> Define neighboring router |
708 | this instance will be talking to and what AS it's located in. Unless | |
709 | you use the <cf/multihop/ clause, it must be directly connected to one | |
f8e2d916 MM |
710 | of your router's interfaces. In case the neighbor is in the same AS |
711 | as we are, we automatically switch to iBGP. This parameter is mandatory. | |
5a203dac | 712 | |
5459fac6 MM |
713 | <tag>multihop <m/number/ via <m/ip/</tag> Configure multihop BGP to a |
714 | neighbor which is connected at most <m/number/ hops far and to which | |
715 | we should route via our direct neighbor with address <m/ip/. | |
716 | Default: switched off. | |
5a203dac | 717 | |
5459fac6 MM |
718 | <tag>next hop self</tag> Avoid calculation of the Next Hop attribute |
719 | and always advertise our own source address (see below) as a next hop. | |
720 | This needs to be used only | |
721 | occasionally to circumvent misconfigurations of other routers. | |
722 | Default: disabled. | |
5a203dac | 723 | |
5459fac6 MM |
724 | <tag>source address <m/ip/</tag> Define local address we should use |
725 | for next hop calculation. Default: the address of the local end | |
726 | of the interface our neighbor is connected to. | |
5a203dac | 727 | |
5459fac6 MM |
728 | <tag>disable after error <m/switch/</tag> When an error is encountered (either |
729 | locally or by the other side), disable the instance automatically | |
5a203dac PM |
730 | and wait for an administrator to fix the problem manually. Default: off. |
731 | ||
732 | <tag>hold time <m/number/</tag> Time in seconds to wait for a Keepalive | |
5459fac6 MM |
733 | message from the other side before considering the connection stale. |
734 | Default: depends on agreement with the neighboring router, we prefer | |
735 | 240 seconds if the other side is willing to accept it. | |
5a203dac | 736 | |
5459fac6 | 737 | <tag>startup hold time <m/number/</tag> Value of the hold timer used |
5a203dac | 738 | before the routers have a chance to exchange open messages and agree |
5459fac6 | 739 | on the real value. Default: 240 seconds. |
5a203dac | 740 | |
5459fac6 | 741 | <tag>keepalive time <m/number/</tag> Delay in seconds between sending |
5a203dac PM |
742 | of two consecutive Keepalive messages. Default: One third of the hold time. |
743 | ||
5459fac6 | 744 | <tag>connect retry time <m/number/</tag> Time in seconds to wait before |
5a203dac PM |
745 | retrying a failed attempt to connect. Default: 120 seconds. |
746 | ||
5459fac6 | 747 | <tag>start delay time <m/number/</tag> Delay in seconds between protocol |
5a203dac PM |
748 | startup and the first attempt to connect. Default: 5 seconds. |
749 | ||
750 | <tag>error wait time <m/number/,<m/number/</tag> Minimum and maximum delay in seconds between a protocol | |
751 | failure (either local or reported by the peer) and automatic restart. | |
5459fac6 MM |
752 | Doesn't apply when <cf/disable after error/ is configured. If consecutive |
753 | errors happen, the delay is increased exponentially until it reaches the maximum. Default: 60, 300. | |
5a203dac | 754 | |
5459fac6 MM |
755 | <tag>error forget time <m/number/</tag> Maximum time in seconds between two protocol |
756 | failures to treat them as a error sequence which makes the <cf/error wait time/ | |
757 | increase exponentially. Default: 300 seconds. | |
5a203dac | 758 | |
5459fac6 MM |
759 | <tag>path metric <m/switch/</tag> Enable comparison of path lengths |
760 | when deciding which BGP route is the best one. Default: on. | |
5a203dac | 761 | |
5459fac6 MM |
762 | <tag>default bgp_med <m/number/</tag> Value of the Multiple Exit |
763 | Discriminator to be used during route selection when the MED attribute | |
764 | is missing. Default: infinite. | |
5a203dac | 765 | |
5459fac6 MM |
766 | <tag>default bgp_local_pref <m/number/</tag> Value of the Local Preference |
767 | to be used during route selection when the Local Preference attribute | |
768 | is missing. Default: 0. | |
769 | </descrip> | |
770 | ||
371adba6 | 771 | <sect1>Attributes |
56ab03c7 | 772 | |
5a203dac | 773 | <p>BGP defines several route attributes. Some of them (those marked with `<tt/I/' in the |
5459fac6 | 774 | table below) are available on internal BGP connections only, some of them (marked |
5a203dac | 775 | with `<tt/O/') are optional. |
5459fac6 MM |
776 | |
777 | <descrip> | |
326e33f5 | 778 | <tag>bgppath <cf/bgp_path/</tag> Sequence of AS numbers describing the AS path |
5a203dac PM |
779 | the packet will travel through when forwarded according to the particular route. In case of |
780 | internal BGP it doesn't contain the number of the local AS. | |
781 | ||
5459fac6 MM |
782 | <tag>int <cf/bgp_local_pref/ [I]</tag> Local preference value used for |
783 | selection among multiple BGP routes (see the selection rules above). It's | |
784 | used as an additional metric which is propagated through the whole local AS. | |
5a203dac | 785 | |
5459fac6 | 786 | <tag>int <cf/bgp_med/ [IO]</tag> The Multiple Exit Discriminator of the route |
f8e2d916 | 787 | is an optional attribute which is often used within the local AS to |
5459fac6 MM |
788 | reflect interior distances to various boundary routers. See the route selection |
789 | rules above for exact semantics. | |
5a203dac PM |
790 | |
791 | <tag>enum <cf/bgp_origin/</tag> Origin of the route: either <cf/ORIGIN_IGP/ | |
792 | if the route has originated in an interior routing protocol or | |
793 | <cf/ORIGIN_EGP/ if it's been imported from the <tt>EGP</tt> protocol | |
794 | (nowadays it seems to be obsolete) or <cf/ORIGIN_INCOMPLETE/ if the origin | |
5459fac6 | 795 | is unknown. |
5a203dac | 796 | |
5459fac6 MM |
797 | <tag>ip <cf/bgp_next_hop/</tag> Next hop to be used for forwarding of packets |
798 | to this destination. On internal BGP connections, it's an address of the | |
799 | originating router if it's inside the local AS or a boundary router the | |
800 | packet will leave the AS through if it's an exterior route, so each BGP | |
801 | speaker within the AS has a chance to use the shortest interior path | |
802 | possible to this point. | |
5a203dac | 803 | |
5459fac6 | 804 | <tag>void <cf/bgp_atomic_aggr/ [O]</tag> This is an optional attribute |
5a203dac PM |
805 | which carries no value, but the sole presence of which indicates that the route |
806 | has been aggregated from multiple routes by some router on the path from | |
5459fac6 | 807 | the originator. |
5a203dac | 808 | |
5459fac6 MM |
809 | <!-- we don't handle aggregators right since they are of a very obscure type |
810 | <tag>bgp_aggregator</tag> | |
811 | --> | |
812 | <tag>clist <cf/bgp_community/ [O]</tag> List of community values associated | |
813 | with the route. Each such value is a pair (represented as a <cf/pair/ data | |
5a203dac PM |
814 | type inside the filters) of 16-bit integers, the first of them containing the number of the AS which defines |
815 | the community and the second one being a per-AS identifier. There are lots | |
5459fac6 MM |
816 | of uses of the community mechanism, but generally they are used to carry |
817 | policy information like "don't export to USA peers". As each AS can define | |
326e33f5 | 818 | its own routing policy, it also has a complete freedom about which community |
5a203dac | 819 | attributes it defines and what will their semantics be. |
5459fac6 MM |
820 | </descrip> |
821 | ||
371adba6 | 822 | <sect1>Example |
56ab03c7 | 823 | |
5459fac6 MM |
824 | <p><code> |
825 | protocol bgp { | |
826 | local as 65000; # Use a private AS number | |
5a203dac PM |
827 | neighbor 62.168.0.130 as 5588; # Our neighbor... |
828 | multihop 20 via 62.168.0.13; # ... which is connected indirectly | |
5459fac6 MM |
829 | export filter { # We use non-trivial export rules |
830 | if source = RTS_STATIC then { # Export only static routes | |
a852c139 PM |
831 | # Assign our community |
832 | bgp_community.add((65000,5678)); | |
833 | # Artificially increase path length | |
5a203dac | 834 | # by advertising local AS number twice |
a852c139 PM |
835 | if bgp_path ~ / 65000 / then |
836 | bgp_path.prepend(65000); | |
5459fac6 MM |
837 | accept; |
838 | } | |
839 | reject; | |
840 | }; | |
841 | import all; | |
5a203dac | 842 | source address 62.168.0.1; # Use a non-standard source address |
5459fac6 MM |
843 | } |
844 | </code> | |
845 | ||
371adba6 | 846 | <sect>Device |
1b55b1a3 | 847 | |
5a203dac PM |
848 | <p>The Device protocol is not a real routing protocol. It doesn't generate |
849 | any routes and it only serves as a module for getting information about network | |
79a2b697 MM |
850 | interfaces from the kernel. |
851 | ||
0e694e04 | 852 | <p>Except for very unusual circumstances, you probably should include |
5a203dac PM |
853 | this protocol in the configuration since almost all other protocols |
854 | require network interfaces to be defined for them to work with. | |
79a2b697 | 855 | |
5459fac6 | 856 | <p>The only configurable thing is interface scan time: |
79a2b697 MM |
857 | |
858 | <p><descrip> | |
859 | <tag>scan time <m/number/</tag> Time in seconds between two scans | |
860 | of the network interface list. On systems where we are notified about | |
861 | interface status changes asynchronously (such as newer versions of | |
5a203dac PM |
862 | Linux), we need to scan the list only in order to avoid confusion by lost |
863 | notification messages, so the default time is set to a large value. | |
79a2b697 MM |
864 | </descrip> |
865 | ||
79a2b697 | 866 | <p>As the Device protocol doesn't generate any routes, it cannot have |
4f88ac47 | 867 | any attributes. Example configuration looks really simple: |
79a2b697 MM |
868 | |
869 | <p><code> | |
870 | protocol device { | |
871 | scan time 10; # Scan the interfaces often | |
872 | } | |
873 | </code> | |
874 | ||
371adba6 | 875 | <sect>Direct |
1b55b1a3 | 876 | |
79a2b697 MM |
877 | <p>The Direct protocol is a simple generator of device routes for all the |
878 | directly connected networks according to the list of interfaces provided | |
879 | by the kernel via the Device protocol. | |
880 | ||
881 | <p>It's highly recommended to include this protocol in your configuration | |
882 | unless you want to use BIRD as a route server or a route reflector, that is | |
5a203dac | 883 | on a machine which doesn't forward packets itself and only participates in |
79a2b697 MM |
884 | distribution of routing information. |
885 | ||
5a203dac | 886 | <p>The only configurable thing about direct is what interfaces it watches: |
79a2b697 MM |
887 | |
888 | <p><descrip> | |
0e694e04 | 889 | <tag>interface <m/pattern [, ...]/</tag> By default, the Direct |
79a2b697 MM |
890 | protocol will generate device routes for all the interfaces |
891 | available. If you want to restrict it to some subset of interfaces | |
892 | (for example if you're using multiple routing tables for policy | |
893 | routing and some of the policy domains don't contain all interfaces), | |
894 | just use this clause. | |
895 | </descrip> | |
896 | ||
79a2b697 MM |
897 | <p>Direct device routes don't contain any specific attributes. |
898 | ||
4f88ac47 | 899 | <p>Example config might look like this: |
79a2b697 MM |
900 | |
901 | <p><code> | |
902 | protocol direct { | |
903 | interface "-arc*", "*"; # Exclude the ARCnets | |
904 | } | |
905 | </code> | |
906 | ||
371adba6 | 907 | <sect>Kernel |
1b55b1a3 | 908 | |
0e4789c2 | 909 | <p>The Kernel protocol is not a real routing protocol. Instead of communicating |
5a203dac PM |
910 | the with other routers in the network, it performs synchronization of BIRD's routing |
911 | tables with the OS kernel. Basically, it sends all routing table updates to the kernel | |
0e4789c2 MM |
912 | and from time to time it scans the kernel tables to see whether some routes have |
913 | disappeared (for example due to unnoticed up/down transition of an interface) | |
f8e2d916 | 914 | or whether an `alien' route has been added by someone else (depending on the |
5a203dac | 915 | <cf/learn/ switch, such routes are either deleted or accepted to our |
f8e2d916 | 916 | table). |
0e4789c2 MM |
917 | |
918 | <p>If your OS supports only a single routing table, you can configure only one | |
919 | instance of the Kernel protocol. If it supports multiple tables (in order to | |
5a203dac | 920 | allow policy routing; such an OS is for example Linux 2.2), you can run as many instances as you want, but each of |
0e4789c2 MM |
921 | them must be connected to a different BIRD routing table and to a different |
922 | kernel table. | |
923 | ||
371adba6 | 924 | <sect1>Configuration |
0e4789c2 MM |
925 | |
926 | <p><descrip> | |
927 | <tag>persist <m/switch/</tag> Tell BIRD to leave all its routes in the | |
326e33f5 | 928 | routing tables when it exits (instead of cleaning them up). |
5a203dac | 929 | <tag>scan time <m/number/</tag> Time in seconds between two consecutive scans of the |
0e4789c2 MM |
930 | kernel routing table. |
931 | <tag>learn <m/switch/</tag> Enable learning of routes added to the kernel | |
932 | routing tables by other routing daemons or by the system administrator. | |
933 | This is possible only on systems which support identification of route | |
934 | authorship. | |
935 | <tag>kernel table <m/number/</tag> Select which kernel table should | |
936 | this particular instance of the Kernel protocol work with. Available | |
937 | only on systems supporting multiple routing tables. | |
938 | </descrip> | |
939 | ||
5a203dac | 940 | <p>The Kernel protocol doesn't define any route attributes. |
326e33f5 | 941 | <p>A simple configuration can look this way: |
0e4789c2 MM |
942 | |
943 | <p><code> | |
944 | protocol kernel { | |
945 | import all; | |
946 | export all; | |
947 | } | |
948 | </code> | |
949 | ||
950 | <p>Or for a system with two routing tables: | |
951 | ||
952 | <p><code> | |
953 | protocol kernel { # Primary routing table | |
954 | learn; # Learn alien routes from the kernel | |
955 | persist; # Don't remove routes on bird shutdown | |
956 | scan time 10; # Scan kernel routing table every 10 seconds | |
957 | import all; | |
958 | export all; | |
959 | } | |
960 | ||
961 | protocol kernel { # Secondary routing table | |
962 | table auxtable; | |
963 | kernel table 100; | |
964 | export all; | |
a2a3ced8 | 965 | } |
0e4789c2 MM |
966 | </code> |
967 | ||
371adba6 | 968 | <sect>OSPF |
1b55b1a3 | 969 | |
8fd12e6b OF |
970 | <sect1>Introduction |
971 | ||
3ca3e999 | 972 | <p>Open Shortest Path First (OSPF) is a quite complex interior gateway |
64722c98 | 973 | protocol. The current IPv4 version (OSPFv2) is defined in RFC 2328<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2328.txt">. It's a link |
3ca3e999 MM |
974 | state (a.k.a. shortest path first) protocol -- Each router maintains a database |
975 | describing the autonomous system's topology. Each participating router | |
976 | has an identical copy of the database and all routers run the same algorithm | |
977 | calculating a shortest path tree with themselves as a root. | |
4e8ec666 | 978 | OSPF chooses the least cost path as the best path. |
3ca3e999 MM |
979 | |
980 | <p>In OSPF, the autonomous system can be split to several areas in order | |
981 | to reduce the amount of resources consumed for exchanging the routing | |
982 | information and to protect the other areas from incorrect routing data. | |
983 | Topology of the area is hidden to the rest of the autonomous system. | |
4e8ec666 | 984 | Unfortunately multiple OSPF areas are not yet fully supported |
3ca3e999 MM |
985 | by this version of BIRD and neither is the IPv6 version (OSPFv3). |
986 | ||
987 | <p>Another very important feature of OSPF is that | |
988 | it can keep routing information from other protocols (like Static or BGP) | |
989 | in its link state database as external routes. Each external route can | |
990 | be tagged by the advertising router, making possible to pass additional | |
991 | information between routers on the boundary of the autonomous system. | |
992 | ||
993 | <p>OSPF quickly detects topological changes in the autonomous system (such | |
8fd12e6b | 994 | as router interface failures) and calculates new loop-free routes after a |
3ca3e999 MM |
995 | period of convergence. This period is short and involves only minimal |
996 | routing traffic. | |
8fd12e6b | 997 | |
3ca3e999 MM |
998 | <p>Each router participating in OSPF routing periodically sends Hello messages |
999 | to all its interfaces. This allows neighbors to be discovered dynamically. | |
1000 | Then the neighbors exchange theirs parts of the link state database and keep it | |
1001 | identical by flooding updates. The flooding process is reliable and ensures | |
1002 | that each router detects all changes. | |
8fd12e6b OF |
1003 | |
1004 | <sect1>Configuration | |
1005 | ||
1006 | <p> | |
1007 | ||
1008 | <code> | |
088bc8ad | 1009 | protocol ospf <name> { |
3ca3e999 | 1010 | rfc1583compat <bool>; |
088bc8ad OF |
1011 | area <id> { |
1012 | stub <bool>; | |
1013 | tick <num>; | |
3ca3e999 | 1014 | interface <interface pattern> |
8fd12e6b | 1015 | { |
088bc8ad OF |
1016 | cost <num>; |
1017 | hello <num>; | |
1018 | retransmit <num>; | |
1019 | priority <num>; | |
1020 | wait <num>; | |
1021 | dead count <num>; | |
8fd12e6b OF |
1022 | type [broadcast|nonbroadcast|pointopoint]; |
1023 | authetication [none|simple]; | |
088bc8ad | 1024 | password "<text>"; |
8fd12e6b | 1025 | neighbors { |
088bc8ad | 1026 | <ip>; |
8fd12e6b OF |
1027 | }; |
1028 | }; | |
1029 | }; | |
1030 | } | |
1031 | </code> | |
1032 | ||
1033 | <descrip> | |
1034 | <tag>rfc1583compat <M>bool</M></tag> | |
3ca3e999 | 1035 | This option controls compatibility of routing table |
8fd12e6b OF |
1036 | calculation with RFC 1583<htmlurl |
1037 | url="ftp://ftp.rfc-editor.org/in-notes/rfc1583.txt">. Default | |
1038 | value is no. | |
1039 | ||
1040 | <tag>area <M>id</M></tag> | |
3ca3e999 MM |
1041 | This defines an OSPF area with given area ID (an integer or an IPv4 |
1042 | address, similarly to a router ID). | |
1043 | The most important area is | |
1044 | the backbone (ID 0) to which every other area must be connected. | |
8fd12e6b OF |
1045 | |
1046 | <tag>stub <M>bool</M></tag> | |
3ca3e999 | 1047 | No external routes are flooded into stub areas. Default value is no. |
8fd12e6b OF |
1048 | |
1049 | <tag>tick <M>num</M></tag> | |
3ca3e999 MM |
1050 | The routing table calculation is not performed when a single link state |
1051 | change arrives. To lower the CPU utilization, it's processed later | |
1052 | at periodical intervals of <m/num/ seconds. The default value is 7. | |
8fd12e6b | 1053 | |
3ca3e999 MM |
1054 | <tag>interface <M>pattern</M></tag> |
1055 | Defines that the specified interfaces belong to the area being defined. | |
8fd12e6b OF |
1056 | |
1057 | <tag>cost <M>num</M></tag> | |
3ca3e999 | 1058 | Specifies output cost (metric) of an interface. Default value is 10. |
8fd12e6b OF |
1059 | |
1060 | <tag>hello <M>num</M></tag> | |
3ca3e999 MM |
1061 | Specifies interval in seconds between sending of Hello messages. Beware, all |
1062 | routers on the same network need to have the same hello interval. | |
8fd12e6b OF |
1063 | Default value is 10. |
1064 | ||
1065 | <tag>retransmit <M>num</M></tag> | |
4e8ec666 | 1066 | Specifies interval in seconds between retransmissions of unacknowledged updates. |
8fd12e6b OF |
1067 | Default value is 5. |
1068 | ||
1069 | <tag>priority <M>num</M></tag> | |
3ca3e999 MM |
1070 | On every multiple access network (e.g., the Ethernet) Designed Router |
1071 | and Backup Designed router are elected. These routers have some | |
1072 | special functions in the flooding process. Higher priority increases | |
1073 | preferences in this election. Routers with priority 0 are not | |
8fd12e6b OF |
1074 | eligible. Default value is 1. |
1075 | ||
1076 | <tag>wait <M>num</M></tag> | |
3ca3e999 | 1077 | After start, router waits for the specified number of seconds between starting |
8fd12e6b OF |
1078 | election and building adjacency. Default value is 40. |
1079 | ||
1080 | <tag>dead count <M>num</M></tag> | |
3ca3e999 MM |
1081 | When the router does not receive any messages from a neighbor in |
1082 | <m/dead count/*<m/hello/ seconds, it will consider the neighbor down. | |
8fd12e6b | 1083 | |
3ca3e999 MM |
1084 | <tag>type broadcast</tag> |
1085 | BIRD detects a type of a connected network automatically, but sometimes it's | |
1086 | convenient to force use of a different type manually. | |
1087 | On broadcast networks, flooding and Hello messages are sent using multicasts (a single packet for all the neighbors). | |
8fd12e6b | 1088 | |
3ca3e999 MM |
1089 | <tag>type nonbroadcast</tag> |
1090 | On nonbroadcast networks, the packets are sent to each neighbor | |
1091 | separately because of lack of multicast capabilities. | |
8fd12e6b | 1092 | |
3ca3e999 MM |
1093 | <tag>type pointopoint</tag> |
1094 | Point-to-point networks connect just 2 routers together. No election | |
1095 | is performed there which reduces the number of messages sent. | |
8fd12e6b | 1096 | |
4e8ec666 | 1097 | <tag>authentication none</tag> |
3ca3e999 | 1098 | No passwords are sent in OSPF packets. This is the default value. |
8fd12e6b | 1099 | |
4e8ec666 | 1100 | <tag>authentication simple</tag> |
3ca3e999 | 1101 | Every packet carries 8 bytes of password. Received packets |
4e8ec666 | 1102 | lacking this password are ignored. This authentication mechanism is |
8fd12e6b OF |
1103 | very weak. |
1104 | ||
5a203dac | 1105 | <tag>password "<M>text</M>"</tag> |
3ca3e999 | 1106 | An 8-byte password used for authentication. |
8fd12e6b | 1107 | |
5a203dac | 1108 | <tag>neighbors { <m/set/ } </tag> |
3ca3e999 MM |
1109 | A set of neighbors to which Hello messages on nonbroadcast networks |
1110 | are to be sent. | |
8fd12e6b OF |
1111 | </descrip> |
1112 | ||
1113 | <sect1>Attributes | |
1114 | ||
f06a219a OF |
1115 | <p>OSPF defines three route attributes. Each internal route has a <cf/metric/ |
1116 | Metric is ranging from 1 to infinity (65535). | |
1117 | External routes use <cf/metric type 1/ or <cf/metric type 2/. | |
1118 | A <cf/metric of type 1/ is comparable with internal <cf/metric/, a | |
1119 | <cf/metric of type 2/ is always longer | |
1120 | than any <cf/metric of type 1/ or any <cf/internal metric/. | |
1121 | Each external route can also carry a <cf/tag/ which is a 32-bit | |
1122 | integer which is used when exporting routes to other protocols; | |
1123 | otherwise, it doesn't affect routing inside the OSPF domain at all. | |
8fd12e6b OF |
1124 | |
1125 | <sect1>Example | |
1126 | ||
1127 | <p> | |
1128 | ||
1129 | <code> | |
1130 | protocol ospf MyOSPF { | |
76c7efec OF |
1131 | export filter { |
1132 | if source = RTS_BGP then { | |
1133 | ospf_metric1 = 100; | |
1134 | accept; | |
1135 | } | |
1136 | reject; | |
1137 | }; | |
8fd12e6b OF |
1138 | area 0.0.0.0 { |
1139 | tick 8; | |
1140 | interface "eth*" { | |
1141 | cost 11; | |
1142 | hello 15; | |
1143 | priority 100; | |
1144 | retransmit 7; | |
1145 | authentication simple; | |
1146 | password "aaa"; | |
1147 | }; | |
1148 | interface "ppp*" { | |
1149 | cost 100; | |
1150 | }; | |
1151 | }; | |
1152 | area 120 { | |
1153 | stub yes; | |
1154 | interface "-arc0" , "arc*" { | |
1155 | type nonbroadcast; | |
1156 | authentication none; | |
1157 | wait 50; | |
1158 | dead count 6; | |
1159 | neighbors { | |
1160 | 192.168.120.1; | |
1161 | 192.168.120.2; | |
1162 | 192.168.120.10; | |
1163 | }; | |
1164 | }; | |
1165 | }; | |
1166 | } | |
1167 | </code> | |
1168 | ||
371adba6 | 1169 | <sect>Pipe |
1b55b1a3 | 1170 | |
371adba6 | 1171 | <sect1>Introduction |
a2a3ced8 MM |
1172 | |
1173 | <p>The Pipe protocol serves as a link between two routing tables, allowing routes to be | |
5a203dac | 1174 | passed from a table declared as primary (i.e., the one the pipe is connected to using the |
a2a3ced8 MM |
1175 | <cf/table/ configuration keyword) to the secondary one (declared using <cf/peer table/) |
1176 | and vice versa, depending on what's allowed by the filters. Export filters control export | |
1177 | of routes from the primary table to the secondary one, import filters control the opposite | |
1178 | direction. | |
1179 | ||
5a203dac | 1180 | <p>The primary use of multiple routing tables and the Pipe protocol is for policy routing, |
a2a3ced8 MM |
1181 | where handling of a single packet doesn't depend only on its destination address, but also |
1182 | on its source address, source interface, protocol type and other similar parameters. | |
5a203dac | 1183 | In many systems (Linux 2.2 being a good example), the kernel allows to enforce routing policies |
a2a3ced8 MM |
1184 | by defining routing rules which choose one of several routing tables to be used for a packet |
1185 | according to its parameters. Setting of these rules is outside the scope of BIRD's work | |
5a203dac | 1186 | (on Linux, you can use the <tt/ip/ command), but you can create several routing tables in BIRD, |
a2a3ced8 | 1187 | connect them to the kernel ones, use filters to control which routes appear in which tables |
5a203dac | 1188 | and also you can employ the Pipe protocol for exporting a selected subset of one table to |
a2a3ced8 MM |
1189 | another one. |
1190 | ||
371adba6 | 1191 | <sect1>Configuration |
a2a3ced8 MM |
1192 | |
1193 | <p><descrip> | |
1194 | <tag>peer table <m/table/</tag> Define secondary routing table to connect to. The | |
1195 | primary one is selected by the <cf/table/ keyword. | |
1196 | </descrip> | |
1197 | ||
371adba6 | 1198 | <sect1>Attributes |
a2a3ced8 MM |
1199 | |
1200 | <p>The Pipe protocol doesn't define any route attributes. | |
1201 | ||
371adba6 | 1202 | <sect1>Example |
a2a3ced8 MM |
1203 | |
1204 | <p>Let's consider a router which serves as a boundary router of two different autonomous | |
1205 | systems, each of them connected to a subset of interfaces of the router, having its own | |
1206 | exterior connectivity and wishing to use the other AS as a backup connectivity in case | |
1207 | of outage of its own exterior line. | |
1208 | ||
1209 | <p>Probably the simplest solution to this situation is to use two routing tables (we'll | |
1210 | call them <cf/as1/ and <cf/as2/) and set up kernel routing rules, so that packets having | |
1211 | arrived from interfaces belonging to the first AS will be routed according to <cf/as1/ | |
1212 | and similarly for the second AS. Thus we have split our router to two logical routers, | |
1213 | each one acting on its own routing table, having its own routing protocols on its own | |
1214 | interfaces. In order to use the other AS's routes for backup purposes, we can pass | |
1215 | the routes between the tables through a Pipe protocol while decreasing their preferences | |
5a203dac | 1216 | and correcting their BGP paths to reflect the AS boundary crossing. |
a2a3ced8 MM |
1217 | |
1218 | <code> | |
1219 | table as1; # Define the tables | |
1220 | table as2; | |
1221 | ||
1222 | protocol kernel kern1 { # Synchronize them with the kernel | |
1223 | table as1; | |
1224 | kernel table 1; | |
1225 | } | |
1226 | ||
1227 | protocol kernel kern2 { | |
1228 | table as2; | |
1229 | kernel table 2; | |
1230 | } | |
1231 | ||
1232 | protocol bgp bgp1 { # The outside connections | |
1233 | table as1; | |
1234 | local as 1; | |
1235 | neighbor 192.168.0.1 as 1001; | |
1236 | export all; | |
1237 | import all; | |
1238 | } | |
1239 | ||
1240 | protocol bgp bgp2 { | |
1241 | table as2; | |
1242 | local as 2; | |
1243 | neighbor 10.0.0.1 as 1002; | |
1244 | export all; | |
1245 | import all; | |
1246 | } | |
1247 | ||
1248 | protocol pipe { # The Pipe | |
1249 | table as1; | |
1250 | peer table as2; | |
1251 | export filter { | |
1252 | if net ~ [ 1.0.0.0/8+] then { # Only AS1 networks | |
1253 | if preference>10 then preference = preference-10; | |
1254 | if source=RTS_BGP then bgp_path.prepend(1); | |
1255 | accept; | |
1256 | } | |
1257 | reject; | |
1258 | }; | |
1259 | import filter { | |
1260 | if net ~ [ 2.0.0.0/8+] then { # Only AS2 networks | |
1261 | if preference>10 then preference = preference-10; | |
1262 | if source=RTS_BGP then bgp_path.prepend(2); | |
1263 | accept; | |
1264 | } | |
1265 | reject; | |
1266 | }; | |
1267 | } | |
1268 | </code> | |
1269 | ||
1532a244 | 1270 | <sect>RIP |
d37f899b | 1271 | |
371adba6 | 1272 | <sect1>Introduction |
d37f899b | 1273 | |
1532a244 PM |
1274 | <p>The RIP protocol (also sometimes called Rest In Pieces) is a simple protocol, where each router broadcasts (to all its neighbors) |
1275 | distances to all networks it can reach. When a router hears distance to another network, it increments | |
d37f899b | 1276 | it and broadcasts it back. Broadcasts are done in regular intervals. Therefore, if some network goes |
1532a244 PM |
1277 | unreachable, routers keep telling each other that its distance is the original distance plus 1 (actually, plus |
1278 | interface metric, which is usually one). After some time, the distance reaches infinity (that's 15 in | |
1279 | RIP) and all routers know that network is unreachable. RIP tries to minimize situations where | |
a7c9f7c0 | 1280 | counting to infinity is necessary, because it is slow. Due to infinity being 16, you can't use |
1532a244 | 1281 | RIP on networks where maximal distance is higher than 15 hosts. You can read more about rip at <HTMLURL |
074a166d | 1282 | URL="http://www.ietf.org/html.charters/rip-charter.html" name="http://www.ietf.org/html.charters/rip-charter.html">. Both IPv4 |
64722c98 | 1283 | (RFC 1723<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1723.txt">) |
074a166d PM |
1284 | and IPv6 (RFC 2080<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2080.txt">) versions of RIP are supported by BIRD, historical RIPv1 (RFC 1058<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1058.txt">)is |
1285 | not currently supported. RIPv4 md5 authentication (RFC 2082<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2082.txt">) is supported. | |
440439e3 | 1286 | |
1532a244 PM |
1287 | <p>RIP is a very simple protocol, and it has a lot of shortcomings. Slow |
1288 | convergence, big network load and inability to handle larger networks | |
440439e3 | 1289 | makes it pretty much obsolete in IPv4 world. (It is still usable on |
1532a244 PM |
1290 | very small networks.) It is widely used in IPv6 networks, |
1291 | because there are no good implementations of OSPFv3. | |
d37f899b | 1292 | |
371adba6 | 1293 | <sect1>Configuration |
d37f899b | 1294 | |
1532a244 | 1295 | <p>In addition to options common for all to other protocols, RIP supports the following ones: |
d37f899b PM |
1296 | |
1297 | <descrip> | |
1532a244 PM |
1298 | <tag/authentication none|password|md5/ selects authentication method to be used. <cf/none/ means that |
1299 | packets are not authenticated at all, <cf/password/ means that a plaintext password is embedded | |
1300 | into each packet, and <cf/md5/ means that packets are authenticated using a md5 cryptographic | |
1301 | hash. If you set authentication to not-none, it is a good idea to add <cf>passwords { }</cf> | |
5a203dac | 1302 | section. Default: none. |
7581b81b | 1303 | |
1532a244 PM |
1304 | <tag>honor always|neighbor|never </tag>specifies when should requests for dumping routing table |
1305 | be honored. (Always, when sent from a host on a directly connected | |
1306 | network or never.) Routing table updates are honored only from | |
5a203dac | 1307 | neighbors, that is not configurable. Default: never. |
d37f899b PM |
1308 | </descrip> |
1309 | ||
1310 | <p>There are two options that can be specified per-interface. First is <cf>metric</cf>, with | |
7581b81b | 1311 | default one. Second is <cf>mode multicast|broadcast|quiet|nolisten|version1</cf>, it selects mode for |
1b55b1a3 | 1312 | rip to work in. If nothing is specified, rip runs in multicast mode. <cf>version1</cf> is |
1532a244 PM |
1313 | currently equivalent to <cf>broadcast</cf>, and it makes RIP talk to a broadcast address even |
1314 | through multicast mode is possible. <cf>quiet</cf> option means that RIP will not transmit | |
1315 | any periodic messages to this interface and <cf>nolisten</cf> means that RIP will send to this | |
1316 | interface but not listen to it. | |
d37f899b | 1317 | |
1532a244 PM |
1318 | <p>The following options generally override behavior specified in RFC. If you use any of these |
1319 | options, BIRD will no longer be RFC-compliant, which means it will not be able to talk to anything | |
1320 | other than equally configured BIRD. I have warned you. | |
d37f899b PM |
1321 | |
1322 | <descrip> | |
0e7a720a | 1323 | <tag>port <M>number</M></tag> |
d150c637 | 1324 | selects IP port to operate on, default 520. (This is useful when testing BIRD, if you |
1532a244 | 1325 | set this to an address >1024, you will not need to run bird with UID==0). |
d37f899b | 1326 | |
0e7a720a | 1327 | <tag>infinity <M>number</M></tag> |
1532a244 | 1328 | selects the value of infinity, default is 16. Bigger values will make protocol convergence |
d37f899b PM |
1329 | even slower. |
1330 | ||
0e7a720a | 1331 | <tag>period <M>number</M> |
1532a244 | 1332 | </tag>specifies the number of seconds between periodic updates. Default is 30 seconds. A lower |
326e33f5 PM |
1333 | number will mean faster convergence but bigger network |
1334 | load. Do not use values lower than 10. | |
d37f899b | 1335 | |
f3b33928 | 1336 | <tag>timeout time <M>number</M> |
1532a244 | 1337 | </tag>specifies how old route has to be to be considered unreachable. Default is 4*<cf/period/. |
d37f899b | 1338 | |
f3b33928 | 1339 | <tag>garbage time <M>number</M> |
1532a244 | 1340 | </tag>specifies how old route has to be to be discarded. Default is 10*<cf/period/. |
d37f899b PM |
1341 | </descrip> |
1342 | ||
371adba6 | 1343 | <sect1>Attributes |
d37f899b | 1344 | |
1b55b1a3 MM |
1345 | <p>RIP defines two route attributes: |
1346 | ||
1347 | <descrip> | |
1348 | <tag>int <cf/rip_metric/</tag> RIP metric of the route (ranging from 0 to <cf/infinity/). | |
1349 | When routes from different RIP instances are available and all of them have the same | |
1350 | preference, BIRD prefers the route with lowest <cf/rip_metric/. | |
5a203dac | 1351 | When importing a non-RIP route, the metric defaults to 5. |
1b55b1a3 MM |
1352 | |
1353 | <tag>int <cf/rip_tag/</tag> RIP route tag: a 16-bit number which can be used | |
1354 | to carry additional information with the route (for example, an originating AS number | |
5a203dac | 1355 | in case of external routes). When importing a non-RIP route, the tag defaults to 0. |
1b55b1a3 MM |
1356 | </descrip> |
1357 | ||
371adba6 | 1358 | <sect1>Example |
1b55b1a3 MM |
1359 | |
1360 | <p><code> | |
d37f899b PM |
1361 | protocol rip MyRIP_test { |
1362 | debug all; | |
1363 | port 1520; | |
326e33f5 PM |
1364 | period 10; |
1365 | garbage time 60; | |
22080a86 PM |
1366 | interface "eth0" { metric 3; mode multicast; } |
1367 | "eth1" { metric 2; mode broadcast; }; | |
326e33f5 | 1368 | honor neighbor; |
d37f899b PM |
1369 | authentication none; |
1370 | import filter { print "importing"; accept; }; | |
1371 | export filter { print "exporting"; accept; }; | |
1372 | } | |
a0dd1c74 | 1373 | </code> |
d37f899b | 1374 | |
371adba6 | 1375 | <sect>Static |
1b55b1a3 | 1376 | |
0e4789c2 | 1377 | <p>The Static protocol doesn't communicate with other routers in the network, |
f8e2d916 | 1378 | but instead it allows you to define routes manually. This is often used for |
79a2b697 MM |
1379 | specifying how to forward packets to parts of the network which don't use |
1380 | dynamic routing at all and also for defining sink routes (i.e., those | |
1381 | telling to return packets as undeliverable if they are in your IP block, | |
1382 | you don't have any specific destination for them and you don't want to send | |
1383 | them out through the default route to prevent routing loops). | |
1384 | ||
1385 | <p>There are three types of static routes: `classical' routes telling to | |
1386 | forward packets to a neighboring router, device routes specifying forwarding | |
1387 | to hosts on a directly connected network and special routes (sink, blackhole | |
1388 | etc.) which specify a special action to be done instead of forwarding the | |
1389 | packet. | |
1390 | ||
1391 | <p>When the particular destination is not available (the interface is down or | |
1392 | the next hop of the route is not a neighbor at the moment), Static just | |
326e33f5 | 1393 | uninstalls the route from the table it is connected to and adds it again as soon |
a00c7a18 | 1394 | as the destination becomes adjacent again. |
79a2b697 | 1395 | |
79a2b697 | 1396 | <p>The Static protocol has no configuration options. Instead, the |
326e33f5 | 1397 | definition of the protocol contains a list of static routes: |
79a2b697 MM |
1398 | |
1399 | <descrip> | |
1400 | <tag>route <m/prefix/ via <m/ip/</tag> Static route through | |
1401 | a neighboring router. | |
1402 | <tag>route <m/prefix/ via <m/"interface"/</tag> Static device | |
1403 | route through an interface to hosts on a directly connected network. | |
1404 | <tag>route <m/prefix/ drop|reject|prohibit</tag> Special routes | |
1405 | specifying to drop the packet, return it as unreachable or return | |
1406 | it as administratively prohibited. | |
1407 | </descrip> | |
1408 | ||
79a2b697 MM |
1409 | <p>Static routes have no specific attributes. |
1410 | ||
4f88ac47 | 1411 | <p>Example static config might look like this: |
79a2b697 MM |
1412 | |
1413 | <p><code> | |
1414 | protocol static { | |
a00c7a18 | 1415 | table testable; # Connect to a non-default routing table |
79a2b697 MM |
1416 | route 0.0.0.0/0 via 62.168.0.13; # Default route |
1417 | route 62.168.0.0/25 reject; # Sink route | |
1418 | route 10.2.0.0/24 via "arc0"; # Secondary network | |
1419 | } | |
1420 | </code> | |
1421 | ||
371adba6 | 1422 | <chapt>Problems |
69477cad | 1423 | |
c184d9d0 | 1424 | <p>BIRD is relatively young system, and probably contains some |
25696edb | 1425 | bugs. You can report bugs at bird-users mailing list (<HTMLURL URL="mailto:bird-users@bird.network.cz" name="bird-users@bird.network.cz">), but before you do, |
75317ab8 | 1426 | please make sure you have read available documentation, make sure are running latest version (available at <HTMLURL |
25696edb | 1427 | URL="ftp://bird.network.cz/pub/bird" name="bird.network.cz:/pub/bird">). (Of course, patch |
326e33f5 | 1428 | which fixes the bug along with bug report is always welcome). If you |
a7c9f7c0 | 1429 | want to use BIRD, join mailing list by sending |
25696edb | 1430 | <tt/subscribe bird-users/ to <HTMLURL URL="mailto:majordomo@bird.network.cz" name="majordomo@bird.network.cz">. Main home page of bird is <HTMLURL URL="http://bird.network.cz/" name="http://bird.network.cz/">. When |
c184d9d0 | 1431 | trying to understand, what is going on, Internet standards are |
25696edb | 1432 | relevant reading; you can get them from <HTMLURL URL="ftp://ftp.rfc-editor.org/" name="ftp.rfc-editor.org"> (or nicely sorted version from <HTMLURL URL="ftp://atrey.karlin.mff.cuni.cz/pub/rfc" name="atrey.karlin.mff.cuni.cz:/pub/rfc">). |
69477cad | 1433 | |
c184d9d0 | 1434 | <p><it/Good luck!/ |
69477cad | 1435 | |
371adba6 | 1436 | </book> |
7581b81b | 1437 | |
a0dd1c74 | 1438 | <!-- |
75317ab8 MM |
1439 | LocalWords: GPL IPv GateD BGPv RIPv OSPFv Linux sgml html dvi sgmltools Pavel |
1440 | LocalWords: linuxdoc dtd descrip config conf syslog stderr auth ospf bgp Mbps | |
5a203dac | 1441 | LocalWords: router's eval expr num birdc ctl UNIX if's enums bool int ip GCC |
75317ab8 MM |
1442 | LocalWords: len ipaddress pxlen netmask enum bgppath bgpmask clist gw md eth |
1443 | LocalWords: RTS printn quitbird iBGP AS'es eBGP RFC multiprotocol IGP Machek | |
4e8ec666 | 1444 | LocalWords: EGP misconfigurations keepalive pref aggr aggregator BIRD's RTC |
5a203dac | 1445 | LocalWords: OS'es AS's multicast nolisten misconfigured UID blackhole MRTD MTU |
4e8ec666 | 1446 | LocalWords: uninstalls ethernets IP binutils ANYCAST anycast dest RTD ICMP rfc |
5a203dac | 1447 | LocalWords: compat multicasts nonbroadcast pointopoint loopback sym stats |
64722c98 | 1448 | LocalWords: Perl SIGHUP dd mm yy HH MM SS EXT IA UNICAST multihop Discriminator txt |
5a203dac PM |
1449 | LocalWords: proto wildcard |
1450 | --> |