summaryrefslogtreecommitdiff
path: root/doc/bird.sgml
diff options
context:
space:
mode:
authorRadu Carpa <radu.carpa@cern.ch>2023-01-17 18:13:37 +0100
committerOndrej Zajicek <santiago@crfreenet.org>2023-01-17 18:13:37 +0100
commit7144c9ca46f092da33a4e051bbce8f973a3bd8c4 (patch)
tree4b2d6f0b3da49d0236075cae3c05c61bb60a5579 /doc/bird.sgml
parent928a1cb034e6f9e8edcdd1dc07264cd703e00827 (diff)
Filter: Allow setting the 'onlink' route attribute in filters
Add static route attribute to set onlink flag for route next hop. Can be used to build a dynamically routed IP-in-IP overlay network. Usage: ifname = "tunl0"; onlink = true; gw = bgp_next_hop;
Diffstat (limited to 'doc/bird.sgml')
-rw-r--r--doc/bird.sgml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 50657ebf..001fcbd4 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -1816,6 +1816,14 @@ Common route attributes are:
creation/removal. Zero is returned for routes with undefined outgoing
interfaces. Read-only.
+ <tag><label id="rta-onlink"><m/bool/ onlink</tag>
+ Onlink flag means that the specified nexthop is accessible on the
+ interface regardless of IP prefixes configured on the interface.
+ The attribute can be used to configure such next hops by first setting
+ <cf/onlink = true/ and <cf/ifname/, and then setting <cf/gw/. Possible
+ use case for setting this flag is to automatically build overlay IP-IP
+ networks on linux.
+
<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