diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/bird.conf.example | 1 | ||||
| -rw-r--r-- | doc/bird.sgml | 77 | ||||
| -rw-r--r-- | doc/reply_codes | 3 |
3 files changed, 71 insertions, 10 deletions
diff --git a/doc/bird.conf.example b/doc/bird.conf.example index 0a2aac7e..6ab03a23 100644 --- a/doc/bird.conf.example +++ b/doc/bird.conf.example @@ -162,6 +162,7 @@ protocol static { #protocol bgp { # disabled; +# description "My BGP uplink" # local as 65000; # neighbor 62.168.0.130 as 5588; # multihop 20 via 62.168.0.13; diff --git a/doc/bird.sgml b/doc/bird.sgml index b4dece16..806b0e6d 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -129,7 +129,11 @@ options. The most important ones are: enable debug messages and run bird in foreground. <tag>-D <m/filename of debug log/</tag> - log debugging information to given file instead of stderr + log debugging information to given file instead of stderr. + + <tag>-p</tag> + just parse the config file and exit. Return value is zero if the config file is valid, + nonzero if there are some errors. <tag>-s <m/name of communication socket/</tag> use given filename for a socket for communications with the client, default is <it/prefix/<file>/var/run/bird.ctl</file>. @@ -306,6 +310,10 @@ to zero to disable it. An empty <cf><m/switch/</cf> is equivalent to <cf/on/ <tag>export <m/filter/</tag> This is similar to the <cf>import</cf> keyword, except that it works in the direction from the routing table to the protocol. Default: <cf/none/. + <tag>description "<m/text/"</tag> This is an optional + description of the protocol. It is displayed as a part of the + output of 'show route all' command. + <tag>table <m/name/</tag> Connect this protocol to a non-default routing table. </descrip> @@ -474,9 +482,6 @@ This argument can be omitted if there exists only a single instance. number of networks, number of routes before and after filtering). If you use <cf/count/ instead, only the statistics will be printed. - <tag>enable|disable|restart <m/name/|"<m/pattern/"|all</tag> - Enable, disable or restart a given protocol instance, instances matching the <cf><m/pattern/</cf> or <cf/all/ instances. - <tag>configure [soft] ["<m/config file/"]</tag> Reload configuration from a given file. BIRD will smoothly switch itself to the new configuration, protocols are @@ -488,6 +493,27 @@ This argument can be omitted if there exists only a single instance. but new routes would be processed according to the new filters. + <tag>enable|disable|restart <m/name/|"<m/pattern/"|all</tag> + Enable, disable or restart a given protocol instance, instances matching the <cf><m/pattern/</cf> or <cf/all/ instances. + + <tag>reload [in|out] <m/name/|"<m/pattern/"|all</tag> + + Reload a given protocol instance, that means re-import routes + from the protocol instance and re-export preferred routes to + the instance. If <cf/in/ or <cf/out/ options are used, the + command is restricted to one direction (re-import or + re-export). + + This command is useful if appropriate filters have changed but + the protocol instance was not restarted (or reloaded), + therefore it still propagates the old set of routes. For example + when <cf/configure soft/ command was used to change filters. + + Re-export always succeeds, but re-import is protocol-dependent + and might fail (for example, if BGP neighbor does not support + route-refresh extension). In that case, re-export is also + skipped. + <tag/down/ Shut BIRD down. @@ -641,7 +667,7 @@ incompatible with each other (that is to prevent you from shooting in the foot). but <cf>1.0.0.0/16 ˜ [ 1.0.0.0/8- ]</cf> is false. Cisco-style patterns like <cf>10.0.0.0/8 ge 16 le 24</cf> can be expressed - in Bird as <cf>10.0.0.0/8{16,24}</cf>, <cf>192.168.0.0/16 le 24</cf> as + in BIRD as <cf>10.0.0.0/8{16,24}</cf>, <cf>192.168.0.0/16 le 24</cf> as <cf>192.168.0.0/16{16,24}</cf> and <cf>192.168.0.0/16 ge 24</cf> as <cf>192.168.0.0/16{24,32}</cf>. @@ -882,12 +908,28 @@ for each neighbor using the following configuration parameters: we should route via our direct neighbor with address <m/ip/. Default: switched off. - <tag>next hop self</tag> Avoid calculation of the Next Hop attribute - and always advertise our own source address (see below) as a next hop. - This needs to be used only - occasionally to circumvent misconfigurations of other routers. + <tag>next hop self</tag> Avoid calculation of the Next Hop + attribute and always advertise our own source address (see + below) as a next hop. This needs to be used only occasionally + to circumvent misconfigurations of other routers. Default: disabled. + <tag>missing lladdr self|drop|ignore</tag>Next Hop attribute + in BGP-IPv6 sometimes contains just the global IPv6 address, + but sometimes it has to contain both global and link-local + IPv6 addresses. This option specifies what to do if BIRD have + to send both addresses but does not know link-local address. + This situation might happen when routes from other protocols + are exported to BGP, or when improper updates are received + from BGP peers. <cf/self/ means that BIRD advertises its own + local address instead. <cf/drop/ means that BIRD skips that + prefixes and logs error. <cf/ignore/ means that BIRD ignores + the problem and sends just the global address (and therefore + forms improper BGP update). Default: <cf/self/, unless BIRD + is configured as a route server (option <cf/rs client/), in + that case default is <cf/drop/, because route servers usually + does not forward packets ifselves. + <tag>source address <m/ip/</tag> Define local address we should use for next hop calculation. Default: the address of the local end of the interface our neighbor is connected to. @@ -915,11 +957,21 @@ for each neighbor using the following configuration parameters: as a route server client. A route server is used as a replacement for full mesh EBGP routing in Internet exchange points in a similar way to route reflectors used in IBGP routing. - Bird does not implement obsoleted RFC 1863, but uses ad-hoc implementation, + BIRD does not implement obsoleted RFC 1863, but uses ad-hoc implementation, which behaves like plain EBGP but reduces modifications to advertised route attributes to be transparent (for example does not prepend its AS number to AS PATH attribute and keep MED attribute). Default: disabled. + <tag>enable route refresh <m/switch/</tag> When BGP speaker + changes its import filter, it has to re-examine all routes + received from its neighbor against the new filter. As these + routes might not be available, there is a BGP protocol + extension Route Refresh (specified in RFC 2918) that allows + BGP speaker to request re-advertisment of all routes from its + neighbor. This option specifies whether BIRD advertises this + capability and accepts such requests. Even when disabled, BIRD + can send route refresh requests. Default: on. + <tag>enable as4 <m/switch/</tag> BGP protocol was designed to use 2B AS numbers and was extended later to allow 4B AS number. BIRD supports 4B AS extension, but by disabling this option it can be persuaded not to advertise it and @@ -980,6 +1032,11 @@ for each neighbor using the following configuration parameters: <tag>path metric <m/switch/</tag> Enable comparison of path lengths when deciding which BGP route is the best one. Default: on. + <tag>prefer older <m/switch/</tag> Standard route selection algorithm + breaks ties by comparing router IDs. This changes the behavior + to prefer older routes (when both are external and from different + peer). For details, see RFC 5004. Default: off. + <tag>default bgp_med <m/number/</tag> Value of the Multiple Exit Discriminator to be used during route selection when the MED attribute is missing. Default: 0. diff --git a/doc/reply_codes b/doc/reply_codes index e4330a2e..4588182b 100644 --- a/doc/reply_codes +++ b/doc/reply_codes @@ -23,6 +23,7 @@ Reply codes of BIRD command-line interface 0012 Restarted 0013 Status report 0014 Route count +0015 Reloading 1000 BIRD version 1001 Interface list @@ -40,6 +41,7 @@ Reply codes of BIRD command-line interface 1013 Show ospf neighbors 1014 Show ospf 1015 Show ospf interface +1016 Show ospf state/topology 8000 Reply too long 8001 Route not found @@ -47,6 +49,7 @@ Reply codes of BIRD command-line interface 8003 No protocols match 8004 Stopped due to reconfiguration 8005 Protocol is down => cannot dump +8006 Reload failed 9000 Command too long 9001 Parse error |