From e90dd656cc9126e1fbcc45fb77a10bf1baa2a1b5 Mon Sep 17 00:00:00 2001
From: "Ondrej Zajicek (work)" <santiago@crfreenet.org>
Date: Fri, 8 Apr 2016 15:10:57 +0200
Subject: Direct: Implement check link for direct protocol

When enabled, direct protocol generates routes only if the underlying
link state is up.
---
 doc/bird.sgml | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'doc/bird.sgml')

diff --git a/doc/bird.sgml b/doc/bird.sgml
index 5e943d7c..829b148a 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -2155,7 +2155,7 @@ conditions, because a lower priority IGP route for the same network is not
 exported to the kernel routing table. This is an issue on BSD systems only, as
 on Linux systems BIRD cannot change non-BIRD route in the kernel routing table.
 
-<p>The only configurable thing about direct is what interfaces it watches:
+<p>There are just few configuration options for the Direct protocol:
 
 <p><descrip>
 	<tag>interface <m/pattern [, ...]/</tag>
@@ -2166,6 +2166,12 @@ on Linux systems BIRD cannot change non-BIRD route in the kernel routing table.
 	interfaces), just use this clause. See <ref id="dsc-iface" name="interface">
 	common option for detailed description. The Direct protocol uses
 	extended interface clauses.
+
+	<tag>check link <m/switch/</tag>
+	If enabled, a hardware link state (reported by OS) is taken into
+	consideration. Routes for directly connected networks are generated only
+	if link up is reported and they are withdrawn when link disappears
+	(e.g., an ethernet cable is unplugged). Default value is no.
 </descrip>
 
 <p>Direct device routes don't contain any specific attributes.
-- 
cgit v1.2.3