ospf-to-leds: introduce script to visualize ospf state via ledschange-34

1 files changed, 34 insertions, 0 deletions

diff --git a/doc/ospf-to-leds.md b/doc/ospf-to-leds.md
new file mode 100644
index 0000000..72fab6b
--- /dev/null
+++ b/doc/ospf-to-leds.md
@@ -0,0 +1,34 @@
+Visualize OSPF state via LEDs
+=============================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+Physical interfaces have their state LEDs, software-defined connectivity
+does not. This script helps to visualize whether or not an OSPF instance
+is running.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+    $ScriptInstallUpdate ospf-to-leds;
+
+... and add a scheduler to run the script periodically:
+
+    / system scheduler add interval=20s name=ospf-to-leds on-event="/ system script run ospf-to-leds;" start-time=startup;
+
+Configuration
+-------------
+
+The configuration goes to OSPF instance's comment. To visualize state for
+instance `default` via LED `user-led` set this:
+
+    / routing ospf instance set default comment="ospf-to-leds, leds=user-led";
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)