From 4ece284ce1b4e5e26fdccc30e351cce4242c68b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20K=C3=BCthe?= Date: Sun, 8 Jan 2023 00:29:02 +0100 Subject: [PATCH 1/5] add docs for meaning of dump output MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Küthe --- docs/routing/babeld/babeld.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/routing/babeld/babeld.md b/docs/routing/babeld/babeld.md index 01095d5..0ef456e 100644 --- a/docs/routing/babeld/babeld.md +++ b/docs/routing/babeld/babeld.md @@ -156,6 +156,27 @@ With the command `dump` you can display the current status: ``` dump ``` +This should produce an output according to the following scheme: +``` +add interface up true ipv6 +``` +The configured interfaces are displayed here. Here `` is the interface name and `` is the own IPv6 link-local address. + +``` +add neighbour address if reach ffff ureach 0000 rxcost txcost cost +``` +The babel neighbors are displayed here. Here `` is the router ID of the neighbor. `` is the link-local address of the peer and `` is the interface over which the peer is connected. `` describes the amount of cost it takes to send data from the peer to us. These costs are set by us manually or automatically by babeld. +`` describes the amount of cost it takes to send data to the peer. This value is set by the peer. + +``` +add xroute -::/0 prefix from ::/0 metric 0 +``` +The networks that originate from us are displayed here. This should only be our own network. Here `` is the network we originate. + +``` +add route prefix from ::/0 installed id metric refmetric via if +``` +The routes learned from the babel neighbors are displayed here. Here `` is the router ID of the neighbor and `` is the prefix learned about the neighbor. `` is either `yes` or `no`. If `yes` the route was exported to the kernel, if `no` it was not. `` shows the cost of consuming to reach the prefix via this route. `` shows the cost our neighbor needs to reach the prefix. `` shows the nexthop, which is normally the IPv6 link-local address of our neighbor. `` shows the interface this route goes through. ## Further links From a37ad82030ea5288fb82c2581ef32eb17708b1cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20K=C3=BCthe?= Date: Sun, 8 Jan 2023 00:33:56 +0100 Subject: [PATCH 2/5] rename placeholders MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Küthe --- docs/routing/babeld/babeld.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/routing/babeld/babeld.md b/docs/routing/babeld/babeld.md index 0ef456e..02112ef 100644 --- a/docs/routing/babeld/babeld.md +++ b/docs/routing/babeld/babeld.md @@ -158,14 +158,14 @@ dump ``` This should produce an output according to the following scheme: ``` -add interface up true ipv6 +add interface up true ipv6 ``` -The configured interfaces are displayed here. Here `` is the interface name and `` is the own IPv6 link-local address. +The configured interfaces are displayed here. Here `` is the interface name and `` is the own IPv6 link-local address. ``` -add neighbour address if reach ffff ureach 0000 rxcost txcost cost +add neighbour address if reach ffff ureach 0000 rxcost txcost cost ``` -The babel neighbors are displayed here. Here `` is the router ID of the neighbor. `` is the link-local address of the peer and `` is the interface over which the peer is connected. `` describes the amount of cost it takes to send data from the peer to us. These costs are set by us manually or automatically by babeld. +The babel neighbors are displayed here. Here `` is the router ID of the neighbor. `` is the link-local address of the peer and `` is the interface over which the peer is connected. `` describes the amount of cost it takes to send data from the peer to us. These costs are set by us manually or automatically by babeld. `` describes the amount of cost it takes to send data to the peer. This value is set by the peer. ``` @@ -174,9 +174,9 @@ add xroute -::/0 prefix from ::/0 metric 0 The networks that originate from us are displayed here. This should only be our own network. Here `` is the network we originate. ``` -add route prefix from ::/0 installed id metric refmetric via if +add route prefix from ::/0 installed id metric refmetric via if ``` -The routes learned from the babel neighbors are displayed here. Here `` is the router ID of the neighbor and `` is the prefix learned about the neighbor. `` is either `yes` or `no`. If `yes` the route was exported to the kernel, if `no` it was not. `` shows the cost of consuming to reach the prefix via this route. `` shows the cost our neighbor needs to reach the prefix. `` shows the nexthop, which is normally the IPv6 link-local address of our neighbor. `` shows the interface this route goes through. +The routes learned from the babel neighbors are displayed here. Here `` is the router ID of the neighbor and `` is the prefix learned about the neighbor. `` is either `yes` or `no`. If `yes` the route was exported to the kernel, if `no` it was not. `` shows the cost of consuming to reach the prefix via this route. `` shows the cost our neighbor needs to reach the prefix. `` shows the nexthop, which is normally the IPv6 link-local address of our neighbor. `` shows the interface this route goes through. ## Further links From 5a6ef25644b2af820cdcd9205ca4742c9dc9da97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20K=C3=BCthe?= Date: Sun, 8 Jan 2023 14:30:43 +0100 Subject: [PATCH 3/5] add explatation to MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Küthe --- docs/routing/babeld/babeld.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/routing/babeld/babeld.md b/docs/routing/babeld/babeld.md index 02112ef..963776d 100644 --- a/docs/routing/babeld/babeld.md +++ b/docs/routing/babeld/babeld.md @@ -176,7 +176,7 @@ The networks that originate from us are displayed here. This should only be our ``` add route prefix from ::/0 installed id metric refmetric via if ``` -The routes learned from the babel neighbors are displayed here. Here `` is the router ID of the neighbor and `` is the prefix learned about the neighbor. `` is either `yes` or `no`. If `yes` the route was exported to the kernel, if `no` it was not. `` shows the cost of consuming to reach the prefix via this route. `` shows the cost our neighbor needs to reach the prefix. `` shows the nexthop, which is normally the IPv6 link-local address of our neighbor. `` shows the interface this route goes through. +The routes learned from the babel neighbors are displayed here. Here `` is the router ID of the neighbor and `` is the prefix learned about the neighbor. `` is either `yes` or `no`. If `yes` the route was exported to the kernel, if `no` it was not. `` shows the cost of consuming to reach the prefix via this route. `` shows the cost our neighbor needs to reach the prefix. `` shows the nexthop, which is normally the IPv6 link-local address of our neighbor. `` shows the interface this route goes through. `` is a unique ID to a route. The route keeps its ID until it is flushed. ## Further links From 0fc33c60b9e4f146f92d5edc23ed5591ac991b44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20K=C3=BCthe?= Date: Mon, 9 Jan 2023 08:20:51 +0100 Subject: [PATCH 4/5] add reference to rfc8966 --- docs/routing/babeld/babeld.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/routing/babeld/babeld.md b/docs/routing/babeld/babeld.md index a485c21..5a5dd9f 100644 --- a/docs/routing/babeld/babeld.md +++ b/docs/routing/babeld/babeld.md @@ -172,6 +172,7 @@ add neighbour address if reach ffff ureach 0000 r ``` The babel neighbors are displayed here. Here `` is the router ID of the neighbor. `` is the link-local address of the peer and `` is the interface over which the peer is connected. `` describes the amount of cost it takes to send data from the peer to us. These costs are set by us manually or automatically by babeld. `` describes the amount of cost it takes to send data to the peer. This value is set by the peer. +Information on how costs are calculated can be found in [RFC8966 3.4.3](https://www.rfc-editor.org/rfc/rfc8966#cost-computation) and [RFC8966 Appendix A](https://www.rfc-editor.org/rfc/rfc8966#name-cost-and-metric-computation). ``` add xroute -::/0 prefix from ::/0 metric 0 From 25b9db016d9f448b3b6b76efa21a3ea90b08e483 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20K=C3=BCthe?= Date: Mon, 9 Jan 2023 08:21:18 +0100 Subject: [PATCH 5/5] add reference to rfc8966 in further links --- docs/routing/babeld/babeld.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/routing/babeld/babeld.md b/docs/routing/babeld/babeld.md index 5a5dd9f..8d614c8 100644 --- a/docs/routing/babeld/babeld.md +++ b/docs/routing/babeld/babeld.md @@ -193,3 +193,4 @@ The routes learned from the babel neighbors are displayed here. Here `` is - [babeld mailling list](https://alioth-lists.debian.net/pipermail/babel-users/) - [babeld source code](https://github.com/jech/babeld) - [Babel configuration by Réseau Libre](https://wiki.reseaulibre.ca/documentation/babel/) +- [RFC8966](https://www.rfc-editor.org/rfc/rfc8966)