diff options
| author | Ondrej Zajicek <santiago@crfreenet.org> | 2023-04-21 04:42:13 +0200 |
|---|---|---|
| committer | Ondrej Zajicek <santiago@crfreenet.org> | 2023-04-21 04:42:13 +0200 |
| commit | f3b599afe5bde0c7f232421743041b305bb8afa7 (patch) | |
| tree | da861d8c13e1cfc0e91686b9ac02c2fc50cd6181 | |
| parent | 976dec048a25fc22efb07fa73be1316c95046420 (diff) | |
BMP: Add some basic documentation
| -rw-r--r-- | doc/bird.sgml | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml index 557140b8..39eae4cd 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"> |