]> git.ipfire.org Git - thirdparty/bird.git/commitdiff
Updated router id docs to 4-byte integer.
authorJana Babovakova <babovakova.jana@gmail.com>
Mon, 24 Feb 2025 13:39:29 +0000 (14:39 +0100)
committerJana Babovakova <babovakova.jana@gmail.com>
Tue, 25 Feb 2025 14:13:09 +0000 (15:13 +0100)
doc/bird.sgml
nest/route.h

index 93dd11dbdc25067c907942ac60625cbc478c2011..d400b3491c1a9109e6d0a5776610d3421c5e09f9 100644 (file)
@@ -650,10 +650,9 @@ include "tablename.conf";;
        in import filters for export filtering purposes instead of locally
        assigned BGP communities which have to be deleted in export filters.
 
-       <tag><label id="opt-router-id">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: the lowest
-       IPv4 address of a non-loopback interface.
+       <tag><label id="opt-router-id">router id <m/number/ | <m/IPv4 address/</tag>
+       Set BIRD's router ID. It's a 4-byte non-zero integer that should be unique
+       within an AS. Default: the lowest IPv4 address of the router.
 
        <tag><label id="opt-router-id-from">router id from [-] [ "<m/mask/" ] [ <m/prefix/ ] [, <m/.../]</tag>
        Set BIRD's router ID based on an IPv4 address of an interface specified by
@@ -833,7 +832,7 @@ agreement").
        BGP protocol, <cf/states/ logs BGP state changes and <cf/messages/ logs
        received BGP messages. Other protocols does not support MRTdump yet.
 
-       <tag><label id="proto-router-id">router id <m/IPv4 address/</tag>
+       <tag><label id="proto-router-id">router id <m/number/ | <m/IPv4 address/</tag>
        This option can be used to override global router id for a given
        protocol. Default: uses global router id.
 
@@ -3046,7 +3045,7 @@ using the following configuration parameters:
        Be a route reflector and treat the neighbor as a route reflection
        client. Default: disabled.
 
-       <tag><label id="bgp-rr-cluster-id">rr cluster id <m/IPv4 address/</tag>
+       <tag><label id="bgp-rr-cluster-id">rr cluster id <m/number/ | <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,
index 3ff61182489408610f9de74d613532ba4bb10281..5a9e7fa16fdb6be123d7711b3c9b4cc0f86ca3f5 100644 (file)
@@ -551,7 +551,7 @@ const char *ea_custom_name(uint ea);
 #define EAF_TYPE_INT 0x01              /* 32-bit unsigned integer number */
 #define EAF_TYPE_OPAQUE 0x02           /* Opaque byte string (not filterable) */
 #define EAF_TYPE_IP_ADDRESS 0x04       /* IP address */
-#define EAF_TYPE_ROUTER_ID 0x05                /* Router ID (IPv4 address) */
+#define EAF_TYPE_ROUTER_ID 0x05                /* Router ID (4-octet positive integer) */
 #define EAF_TYPE_AS_PATH 0x06          /* BGP AS path (encoding per RFC 1771:4.3) */
 #define EAF_TYPE_BITFIELD 0x09         /* 32-bit embedded bitfield */
 #define EAF_TYPE_INT_SET 0x0a          /* Set of u32's (e.g., a community list) */