2. The BMP plugin contains a default configuration, which is applied after the feature starts up.
One instance of BMP monitoring station is created (named *example-bmp-monitor*), and its presence can be verified via REST:
- **URL:** ``/restconf/operational/bmp-monitor:bmp-monitor/monitor/example-bmp-monitor``
+ **URL:** ``/restconf/config/odl-bmp-monitor-config:odl-bmp-monitors/bmp-monitor-config/example-bmp-monitor``
**Method:** ``GET``
.. code-block:: xml
- <monitor xmlns="urn:opendaylight:params:xml:ns:yang:bmp-monitor">
- <monitor-id>example-bmp-monitor</monitor-id>
- </monitor>
+ <bmp-monitor-config xmlns="urn:opendaylight:params:xml:ns:yang: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>
BMP Monitoring Station
----------------------
^^^^^^^^^^^^^
This section shows the way to configure the BMP monitoring station via REST API.
-.. warning:: The BMP monitoring station configuration is going to be changed in Carbon.
- This user-guide will be updated accordingly.
-
Monitoring station configuration
''''''''''''''''''''''''''''''''
In order to change default's BMP monitoring station configuration, use following request.
-It is required to install ``odl-netconf-connector-ssh`` feature first.
-**URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
+**URL:** ``/restconf/config/odl-bmp-monitor-config:odl-bmp-monitors/bmp-monitor-config/example-bmp-monitor``
**Method:** ``PUT``
:linenos:
:emphasize-lines: 4,5
- <module xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
- <name>example-bmp-monitor</name>
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">x:bmp-monitor-impl</type>
- <binding-port xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">12355</binding-port>
- <binding-address xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">0.0.0.0</binding-address>
- <bmp-dispatcher xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type>bmp-dispatcher</type>
- <name>global-bmp-dispatcher</name>
- </bmp-dispatcher>
- <codec-tree-factory xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-codec-tree-factory</type>
- <name>runtime-mapping-singleton</name>
- </codec-tree-factory>
- <extensions xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:spi">x:extensions</type>
- <name>global-rib-extensions</name>
- </extensions>
- <dom-data-provider xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom">x:dom-async-data-broker</type>
- <name>pingpong-broker</name>
- </dom-data-provider>
- </module>
+ <bmp-monitor-config xmlns="urn:opendaylight:params:xml:ns:yang: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>
@line 4: **binding-port** - The BMP server listening port.
Active mode configuration
'''''''''''''''''''''''''
In order to enable active connection, use following request.
-It is required to install ``odl-netconf-connector-ssh`` feature first.
-**URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
+**URL:** ``/restconf/config/odl-bmp-monitor-config:odl-bmp-monitors/bmp-monitor-config/example-bmp-monitor``
**Method:** ``PUT``
.. code-block:: xml
:linenos:
- :emphasize-lines: 23,24,25
-
- <module xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
- <name>example-bmp-monitor</name>
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">x:bmp-monitor-impl</type>
- <bmp-dispatcher xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type>bmp-dispatcher</type>
- <name>global-bmp-dispatcher</name>
- </bmp-dispatcher>
- <codec-tree-factory xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-codec-tree-factory</type>
- <name>runtime-mapping-singleton</name>
- </codec-tree-factory>
- <extensions xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:spi">x:extensions</type>
- <name>global-rib-extensions</name>
- </extensions>
- <binding-address xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">0.0.0.0</binding-address>
- <dom-data-provider xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom">x:dom-async-data-broker</type>
- <name>pingpong-broker</name>
- </dom-data-provider>
- <binding-port xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">12345</binding-port>
- <monitored-router xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <address xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">10.10.10.10</address>
- <port xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">1234</port>
- <active xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">true</active>
+ :emphasize-lines: 8,9,10
+
+ <bmp-monitor-config xmlns="urn:opendaylight:params:xml:ns:yang: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>
+ <monitored-router>
+ <address>192.0.2.2</address>
+ <port>1234</port>
+ <active>true</active>
</monitored-router>
- </module>
+ </bmp-monitor-config>
-@line 23: **address** - The monitored router's IP address.
+@line 8: **address** - The monitored router's IP address.
-@line 24: **port** - The monitored router's port.
+@line 9: **port** - The monitored router's port.
-@line 25: **active** - Active mode set.
+@line 10: **active** - Active mode set.
.. note:: User may configure active session establishment for multiple monitored routers.
MD5 authentication configuration
''''''''''''''''''''''''''''''''
In order to enable active connection, use following request.
-It is required to install ``odl-netconf-connector-ssh`` feature first.
-**URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
+**URL:** ``/restconf/config/odl-bmp-monitor-config:odl-bmp-monitors/bmp-monitor-config/example-bmp-monitor``
**Method:** ``PUT``
.. code-block:: xml
:linenos:
- :emphasize-lines: 23,24
-
- <module xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
- <name>example-bmp-monitor</name>
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">x:bmp-monitor-impl</type>
- <bmp-dispatcher xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type>bmp-dispatcher</type>
- <name>global-bmp-dispatcher</name>
- </bmp-dispatcher>
- <codec-tree-factory xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-codec-tree-factory</type>
- <name>runtime-mapping-singleton</name>
- </codec-tree-factory>
- <extensions xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:spi">x:extensions</type>
- <name>global-rib-extensions</name>
- </extensions>
- <binding-address xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">0.0.0.0</binding-address>
- <dom-data-provider xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom">x:dom-async-data-broker</type>
- <name>pingpong-broker</name>
- </dom-data-provider>
- <binding-port xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">12345</binding-port>
- <monitored-router xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">
- <address xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">11.11.11.11</address>
- <password xmlns="urn:opendaylight:params:xml:ns:yang:controller:bmp:impl">topsecret</password>
+ :emphasize-lines: 8,9
+
+ <bmp-monitor-config xmlns="urn:opendaylight:params:xml:ns:yang: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>
+ <monitored-router>
+ <address>192.0.2.2</address>
+ <password>changeme</password>
</monitored-router>
- </module>
+ </bmp-monitor-config>
+
+@line 8: **address** - The monitored router's IP address.
+
+@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.
-@line 23: **address** - The monitored router's IP address.
+**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
-@line 24: **password** - The TCP MD5 signature.
+ feature:install odl-bgpcep-bmp-config-example
Collector DB Tree
^^^^^^^^^^^^^^^^^
--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.
Code Review / docs.git / blobdiff