From: Trey Aspelund Date: Fri, 3 Feb 2023 21:13:38 +0000 (+0000) Subject: doc: optional keyword info for bestpath-routes X-Git-Tag: base_9.0~410^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=refs%2Fpull%2F12738%2Fhead;p=mirror%2Ffrr.git 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 --- diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index eaa675edd9..b17442f641 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -1837,11 +1837,21 @@ Configuring Peers Displaying Information about Peers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. clicmd:: show bgp neighbors WORD bestpath-routes [json] [wide] +.. clicmd:: show bgp 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