summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOndrej Zajicek (work) <santiago@crfreenet.org>2020-12-02 05:02:26 +0100
committerOndrej Zajicek (work) <santiago@crfreenet.org>2020-12-02 05:02:26 +0100
commit8cc5bb09e344038a1f8dff96946e05ec80607c93 (patch)
tree5c7d1f192d4d7654d40282822c639c887aaaffda /doc
parent246586771296d1c42a012c06bdc75b36a7ce0b4f (diff)
Filter: Add 'weight' route attribute
Add 'weight' route attribute that allows to get and set ECMP weight of nexthops. Similar to 'gw' attribute, it is limited to the first nexthop, but it is useful for handling BGP multipath, where an ECMP route is merged from multiple regular routes.
Diffstat (limited to 'doc')
-rw-r--r--doc/bird.sgml9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 05216c4a..5408cb2a 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -1674,6 +1674,15 @@ Common route attributes are:
creation/removal. Zero is returned for routes with undefined outgoing
interfaces. Read-only.
+ <tag><label id="rta-weight"><m/int/ weight</tag>
+ Multipath weight of route next hops. Valid values are 1-256. Reading
+ returns the weight of the first next hop, setting it sets weights of all
+ next hops to the specified value. Therefore, this attribute is not much
+ useful for manipulating individual next hops of an ECMP route, but can
+ be used in BGP multipath setup to set weights of individual routes that
+ are merged to one ECMP route during export to the Kernel protocol
+ (with active <ref id="krt-merge-paths" name="marge paths"> option).
+
<tag><label id="rta-igp-metric"><m/int/ igp_metric</tag>
The optional attribute that can be used to specify a distance to the
network for routes that do not have a native protocol metric attribute