Merge "Add MD-SAL M1 readout"

[docs.git] / docs / user-guide / bgp-monitoring-protocol-user-guide.rst

diff --git a/docs/user-guide/bgp-monitoring-protocol-user-guide.rst b/docs/user-guide/bgp-monitoring-protocol-user-guide.rst
index 8a0b90081f7e215d927cb37838097e9543b32ee4..c01b43a47bb348ad04810a45a2c4f400d6f210d8 100644 (file)
--- a/docs/user-guide/bgp-monitoring-protocol-user-guide.rst
+++ b/docs/user-guide/bgp-monitoring-protocol-user-guide.rst
@@ -217,6 +217,39 @@ In order to enable active connection, use following request.
 
 @line 9: **password** - The TCP MD5 signature.
 
+BMP Monitors Configuration Loader
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+BMP Monitors Configuration Loader allows user to define static initial configuration for a BMP protocol instance.
+This service will detect the creation of new configuration files following the pattern "odl-bmp-monitors-*.xml" under the path "etc/opendaylight/bgpcep".
+Once the file is processed, the defined configuration will be available from the configuration Data Store.
+
+.. note:: If the BMP Monitor instance is already present, no update or configuration will be applied.
+
+**PATH:** ``etc/opendaylight/bgpcep/odl-bmp-monitors-config.xml``
+
+.. code-block:: xml
+
+    <odl-bmp-monitors xmlns="urn:opendaylight:params:xml:ns:yang:bmp-monitor-config">
+        <bmp-monitor-config>
+            <monitor-id>example-bmp-monitor</monitor-id>
+            <server>
+                <binding-port>12345</binding-port>
+                <binding-address>0.0.0.0</binding-address>
+            </server>
+        </bmp-monitor-config>
+    </odl-bmp-monitors>
+
+BMP Monitor Configuration Example
+'''''''''''''''''''''''''''''''''
+
+BGP provides a feature providing a BMP Monitor configuration file example.
+Once feature is installed defined configuration will be loaded and setup.
+
+.. code-block:: console
+
+   feature:install odl-bgpcep-bmp-config-example
+
 Collector DB Tree
 ^^^^^^^^^^^^^^^^^
 
@@ -503,8 +536,8 @@ with optional input parameters:
    --local_address <address> (optional, default 127.0.0.1)
       The IPv4 address where BMP mock is bind to.
 
-   --remote_address <address:port> (optional, default 127.0.0.1:12345)
-      The remote IPv4 Address and port number of BMP monitoring station.
+   -ra <IP_ADDRESS:PORT,...>, --remote_address <IP_ADDRESS:PORT,...>
+      A list of IP addresses of BMP monitoring station, by default 127.0.0.1:12345.
 
    --passive (optional, not present by default)
       This flags enables passive mode for simulated routers.