summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrey Aspelund <taspelund@nvidia.com>2023-02-03 22:13:38 +0100
committerTrey Aspelund <taspelund@nvidia.com>2023-02-08 22:07:02 +0100
commit200631aa65c151ba1c1563e2a6aa8757cd4024f0 (patch)
tree24ac38a920513e4449271be08edd61f34b967015
parentdoc: prefix match for advertised/received-routes (diff)
downloadfrr-200631aa65c151ba1c1563e2a6aa8757cd4024f0.tar.xz
frr-200631aa65c151ba1c1563e2a6aa8757cd4024f0.zip
doc: optional keyword info for bestpath-routes
Adds information about the optional keywords for the bestpath-routes bgp show command. Signed-off-by: Trey Aspelund <taspelund@nvidia.com>
-rw-r--r--doc/user/bgp.rst12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index eaa675edd..b17442f64 100644
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -1837,11 +1837,21 @@ Configuring Peers
Displaying Information about Peers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. clicmd:: show bgp <afi> <safi> neighbors WORD bestpath-routes [json] [wide]
+.. clicmd:: show bgp <afi> <safi> neighbors WORD bestpath-routes [detail] [json] [wide]
For the given neighbor, WORD, that is specified list the routes selected
by BGP as having the best path.
+ If ``detail`` option is specified, the detailed version of all routes
+ will be displayed. The same format as ``show [ip] bgp [afi] [safi] PREFIX``
+ will be used, but for the whole table of received, advertised or filtered
+ prefixes.
+
+ If ``json`` option is specified, output is displayed in JSON format.
+
+ If ``wide`` option is specified, then the prefix table's width is increased
+ to fully display the prefix and the nexthop.
+
.. _bgp-peer-filtering:
Peer Filtering