diff options
Diffstat (limited to 'doc/bird.sgml')
| -rw-r--r-- | doc/bird.sgml | 41 |
1 files changed, 38 insertions, 3 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml index 267c768..0c2b8fb 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -23,7 +23,8 @@ configuration primitives, <cf> is fragment of configuration within normal text, <author> Ondrej Filip <it/<feela@network.cz>/, Pavel Machek <it/<pavel@ucw.cz>/, -Martin Mares <it/<mj@ucw.cz>/ +Martin Mares <it/<mj@ucw.cz>/, +Ondrej Zajicek <it/<santiago@crfreenet.org>/ </author> <abstract> @@ -296,6 +297,10 @@ to zero to disable it. An empty <cf><m/switch/</cf> is equivalent to <cf/on/ <cf/events/ for events internal to the protocol and <cf/packets/ for packets sent and received by the protocol. Default: off. + <tag>router id <m/IPv4 address/</tag> This option can be used to override global + router id for a given protocol. This option is not yet implemented for OSPF + protocol. Default: uses global router id. + <tag>import all | none | filter <m/name/ | filter { <m/filter commands/ } | where <m/filter expression/</tag> Specify a filter to be used for filtering routes coming from the 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/. @@ -478,7 +483,7 @@ This argument can be omitted if there exists only a single instance. switch itself to the new configuration, protocols are reconfigured if possible, restarted otherwise. Changes in filters usualy lead to restart of affected protocols. If - <cf/soft> option is used, changes in filters does not cause + <cf/soft/ option is used, changes in filters does not cause BIRD to restart affected protocols, therefore already accepted routes (according to old filters) would be still propagated, but new routes would be processed according to the new @@ -648,6 +653,21 @@ incompatible with each other (that is to prevent you from shooting in the foot). <tag/bgppath/ BGP path is a list of autonomous system numbers. You can't write literals of this type. + There are several special operators on bgppaths: + + <cf><m/P/.first</cf> returns the first ASN (the neighbor ASN) in path <m/P/. + + <cf><m/P/.last</cf> returns the last ASN (the source ASN) in path <m/P/. + + Both <cf/first/ and <cf/last/ return zero if there is no appropriate ASN, + for example if the path contains an AS set element as the first (or the last) part. + + <cf><m/P/.len</cf> returns the length of path <m/P/. + + <cf>prepend(<m/P/,<m/A/)</cf> prepends ASN <m/A/ to path <m/P/ and returns the result. + Statement <cf><m/P/ = prepend(<m/P/, <m/A/);</cf> can be shortened to + <cf><m/P/.prepend(<m/A/);</cf> if <m/P/ is appropriate route attribute + (for example <cf/bgp_path/). <tag/bgpmask/ BGP masks are patterns used for BGP path matching @@ -661,10 +681,20 @@ incompatible with each other (that is to prevent you from shooting in the foot). BGP mask expressions can also contain integer expressions enclosed in parenthesis and integer variables, for example <tt>[= * 4 (1+2) a =]</tt>. There is also old syntax that uses / .. / instead of [= .. =] and ? instead of *. + <tag/clist/ Community list is similar to set of pairs, except that unlike other sets, it can be modified. There exist no literals of this type. + There are two special operators on clists: + + <cf>add(<m/C/,<m/P/)</cf> adds pair <m/P/ to clist <m/C/ and returns the result. + + <cf>delete(<m/C/,<m/P/)</cf> deletes pair <m/P/ from clist <m/C/ and returns the result. + + Statement <cf><m/C/ = add(<m/C/, <m/P/);</cf> can be shortened to + <cf><m/C/.add(<m/P/);</cf> if <m/C/ is appropriate route attribute + (for example <cf/bgp_community/). Similarly for <cf/delete/. </descrip> @@ -723,7 +753,7 @@ defined by using the <cf>defined( <m>attribute</m> )</cf> operator. 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). <tag><m/int/ preference</tag> - Preference of the route. (See the chapter about routing tables.) + Preference of the route. Valid values are 0-65535. (See the chapter about routing tables.) <tag><m/ip/ from</tag> The router which the route has originated from. Read-only. @@ -867,6 +897,11 @@ for each neighbor using the following configuration parameters: of BGP sessions. Default: no authentication. Password has to be set by external utility (e.g. setkey(8)) on BSD systems. + <tag>passive <m/switch/</tag> Standard BGP behavior is both + initiating outgoing connections and accepting incoming + connections. In passive mode, outgoing connections are not + initiated. Default: off. + <tag>rr client</tag> Be a route reflector and treat the neighbor as a route reflection client. Default: disabled. |