summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Stapp <mjs@voltanet.io>2019-05-08 14:12:55 -0400
committerMark Stapp <mjs@voltanet.io>2019-05-10 15:42:28 -0400
commit3fdcb303291475cca77e7a286a5025536e33102a (patch)
treeedb19d07e38ddec21ade4d415dc7dee7efa8c84f
parentb0a973b94a6858f6c8826f7a561e771866fa1da5 (diff)
doc: add doc for zebra dplane cli
Add some notes about the cli associated with the zebra dataplane. Signed-off-by: Mark Stapp <mjs@voltanet.io>
-rw-r--r--doc/user/zebra.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index bb3d6e491c..bee86fef17 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -685,6 +685,40 @@ replaces the information sent in the first message.
If the connection to the FPM goes down for some reason, zebra sends
the FPM a complete copy of the forwarding table(s) when it reconnects.
+.. _zebra-dplane:
+
+Dataplane Commands
+==================
+
+The zebra dataplane subsystem provides a framework for FIB
+programming. Zebra uses the dataplane to program the local kernel as
+it makes changes to objects such as IP routes, MPLS LSPs, and
+interface IP addresses. The dataplane runs in its own pthread, in
+order to off-load work from the main zebra pthread.
+
+
+.. index:: show zebra dplane [detailed]
+.. clicmd:: show zebra dplane [detailed]
+
+ Display statistics about the updates and events passing through the
+ dataplane subsystem.
+
+
+.. index:: show zebra dplane providers
+.. clicmd:: show zebra dplane providers
+
+ Display information about the running dataplane plugins that are
+ providing updates to a FIB. By default, the local kernel plugin is
+ present.
+
+
+.. index:: zebra dplane limit [NUMBER]
+.. clicmd:: zebra dplane limit [NUMBER]
+
+ Configure the limit on the number of pending updates that are
+ waiting to be processed by the dataplane pthread.
+
+
zebra Terminal Mode Commands
============================