]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: optional keyword info for bestpath-routes 12738/head
authorTrey Aspelund <taspelund@nvidia.com>
Fri, 3 Feb 2023 21:13:38 +0000 (21:13 +0000)
committerTrey Aspelund <taspelund@nvidia.com>
Wed, 8 Feb 2023 21:07:02 +0000 (21:07 +0000)
Adds information about the optional keywords for the bestpath-routes
bgp show command.

Signed-off-by: Trey Aspelund <taspelund@nvidia.com>
doc/user/bgp.rst

index eaa675edd9ef64cd26cc64ce478c6f050dc1df3a..b17442f64160c65747a68f1ac0499314d36003a0 100644 (file)
@@ -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