From: Jana Babovakova <babovakova.jana@gmail.com>
Date: Mon, 24 Feb 2025 13:39:29 +0000 (+0100)
Subject: Updated router id docs to 4-byte integer.
X-Git-Tag: v2.17~45
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=36d7e7e4410fd99cbc0a879f89fcae43d396f3f0;p=thirdparty%2Fbird.git

Updated router id docs to 4-byte integer.
---

diff --git a/doc/bird.sgml b/doc/bird.sgml
index 93dd11dbd..d400b3491 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -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,
diff --git a/nest/route.h b/nest/route.h
index 3ff611824..5a9e7fa16 100644
--- a/nest/route.h
+++ b/nest/route.h
@@ -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) */