From: Ondrej Zajicek <santiago@crfreenet.org>
Date: Fri, 21 Apr 2023 02:42:13 +0000 (+0200)
Subject: BMP: Add some basic documentation
X-Git-Tag: v2.13~2^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f3b599afe5bde0c7f232421743041b305bb8afa7;p=thirdparty%2Fbird.git

BMP: Add some basic documentation
---

diff --git a/doc/bird.sgml b/doc/bird.sgml
index 557140b8c..39eae4cd2 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -3268,6 +3268,35 @@ protocol bgp {
 </code>
 
 
+<sect>BMP
+<label id="bmp">
+
+<p>The BGP Monitoring Protocol is used for monitoring BGP sessions and obtaining
+routing table data. The current implementation in BIRD is a preliminary release
+with a limited feature set, it will be subject to significant changes in the
+future. It is not ready for production usage and therefore it is not compiled
+by default and have to be enabled during installation by the configure option
+<tt/--with-protocols=/.
+
+<p>The implementation is limited to monitor protocol state changes and routes
+in <ref id="bgp-import-table" name="BGP import tables"> (not regular routing
+tables), therefore import table must be enabled in BGP protocols. All BGP
+protocols are monitored automatically.
+
+<sect1>Example
+<label id="bmp-exam">
+
+<p><code>
+protocol bmp {
+	# The monitoring station to connect to
+	station address ip 198.51.100.10 port 1790;
+
+	# required option
+	monitoring rib in pre_policy;
+}
+</code>
+
+
 <sect>Device
 <label id="device">