Update of a documentation - new options for AS4, MD5 auth and route reflection.

diff --git a/doc/bird.conf.example b/doc/bird.conf.example
index 05259d5b373cc1c8232788821e8b0556ff817976..22221d43b6121a53b3277ea4e947121108e39957 100644 (file)
--- a/doc/bird.conf.example
+++ b/doc/bird.conf.example
@@ -179,6 +179,9 @@ protocol static {
 #      default bgp_med 0;      # MED value we use for comparison when none is defined
 #      default bgp_local_pref 0;       # The same for local preference
 #      source address 62.168.0.14;     # What local address we use for the TCP connection
+#      password "secret"       # Password used for MD5 authentication
+#      rr client;              # I am a route reflector and the neighor is my client
+#      rr cluster id 1.0.0.1   # Use this value for cluster id instead of my router id 
 #      export where source=RTS_STATIC;
 #      export filter {
 #              if source = RTS_STATIC then {

diff --git a/doc/bird.sgml b/doc/bird.sgml
index 87113fa933dfff7edd365a3401f6c97b9d12d35b..5ee9562f4382840ed72c9c604f47ecd80c5f5400 100644 (file)
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -655,13 +655,19 @@ routing table it wishes to export along with complete path information
 route) in order to avoid routing loops.
 
 <p>BIRD supports all requirements of the BGP4 standard as defined in
-RFC 1771<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1771.txt">
-including several enhancements from the
-latest draft<htmlurl url="ftp://ftp.rfc-editor.org/internet-drafts/draft-ietf-idr-bgp4-09.txt">.
-It also supports the community attributes as per
-RFC 1997<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1997.txt">,
-capability negotiation defined in
-RFC 2842<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2842.txt">.
+RFC 4271<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc4271.txt">
+It also supports the community attributes
+(RFC 1997<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1997.txt">),
+capability negotiation
+(RFC 3392<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc3392.txt">),
+MD5 password authentication
+(RFC 2385<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2385.txt">),
+route reflectors 
+(RFC 4456<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc4456.txt">),
+and 4B AS numbers 
+(RFC 4893<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc4893.txt">).
+
+
 For IPv6, it uses the standard multiprotocol extensions defined in
 RFC 2283<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc2283.txt">
 including changes described in the
@@ -721,6 +727,27 @@ for each neighbor using the following configuration parameters:
        for next hop calculation. Default: the address of the local end
        of the interface our neighbor is connected to.
 
+       <tag>password <m/string/</tag> Use this password for MD5 authentication
+       of BGP sessions. Default: no authentication.
+
+       <tag>rr client</tag> Be a route reflector and treat neighbor as
+       route reflection client. Default: disabled.
+
+       <tag>rr cluster id <m/IPv4 address/</tag> Route reflectors use cluster id
+       to avoid route reflection loops. When there is one route reflector in a cluster
+       it usually uses its router id as a cluster id, but when there are more route
+       reflectors in a cluster, these need to be configured (using this option) to
+       use a common cluster id. Clients in a cluster need not known their cluster
+       id and this option is not allowed to them  Default: a same as router id.
+
+       <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
+       to maintain old-style sessions with its neighbors. This might be useful for
+       circumventing bugs in neighbor's implementation of 4B AS extension.
+       Even when disabled (off), BIRD behaves internally as AS4-aware BGP router.
+       Default: on.
+
        <tag>disable after error <m/switch/</tag> When an error is encountered (either
        locally or by the other side), disable the instance automatically
        and wait for an administrator to fix the problem manually. Default: off.