Add BGPCEP submodule and BGP Cli documentation

Change-Id: Iee7d89a8b1ff1cc707afe9683eb794a8bff2dc53
Signed-off-by: Claudio D. Gasparini <claudio.gasparini@pantheon.tech>

diff --git a/.gitmodules b/.gitmodules
index a1948bca2905f095974efcbe409817d8d344d024..c9f26c4075ca6f6d2f422a8890ef3570aa43eaa7 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,8 @@
+[submodule "docs/submodules/bgpcep"]
+       path = docs/submodules/bgpcep
+       url = ../bgpcep
+       branch = .
+       ignore = dirty
 [submodule "source/submodules/releng/builder"]
        path = docs/submodules/releng/builder
        url = ../releng/builder

diff --git a/docs/submodules/bgpcep b/docs/submodules/bgpcep
new file mode 160000 (submodule)
index 0000000..a41ee31
--- /dev/null
+++ b/docs/submodules/bgpcep
@@ -0,0 +1 @@
+Subproject commit a41ee3138b4eaf27b2f806807ff50ed4258ed2e5

diff --git a/docs/user-guide/bgp-user-guide.rst b/docs/user-guide/bgp-user-guide.rst
index e34fe297a1861aebd4e43d74b4a770ea16aeac9e..75884da704f7de7b4934ce3da2b6ce16a1f880db 100644 (file)
--- a/docs/user-guide/bgp-user-guide.rst
+++ b/docs/user-guide/bgp-user-guide.rst
@@ -4616,6 +4616,26 @@ BGP Peer Groups Operational State
 @line 6: Total Prefixes installed under by peers pertaining to this peer group (effective-rib-in).
 This count doesn't differentiate repeated prefixes.
 
+CLI
+---
+
+BGP Karaf Console (odl-bgpcep-bgp-cli) provides a CLI feature to read operational state per RIB, Neighbor and Peer Group.
+
+.. code-block:: bash
+   :linenos:
+
+   opendaylight-user@root> bgp:operational-state -rib example-bgp-rib
+
+.. code-block:: bash
+   :linenos:
+
+   opendaylight-user@root> bgp:operational-state -rib example-bgp-rib -neighbor 192.0.2.1
+
+.. code-block:: bash
+   :linenos:
+
+   opendaylight-user@root> bgp:operational-state -rib -peer-group application-peers
+
 High Availability
 -----------------
 Running OpenDaylight BGP in clustered environment brings an advantage of the plugin's high availability (HA).
@@ -5273,4 +5293,4 @@ Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following inf
 
 #. Steps to reproduce
 
-#. Attach Karaf log files, optionally packet captures, REST input/output
\ No newline at end of file
+#. Attach Karaf log files, optionally packet captures, REST input/output