From 1b9d2d609163bd074a633de3796fd92705e42fd3 Mon Sep 17 00:00:00 2001 From: Trey Aspelund Date: Tue, 10 Jan 2023 19:37:28 +0000 Subject: [PATCH] doc: add "detail" advertised/received routes Signed-off-by: Trey Aspelund --- doc/user/bgp.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 0c51ce2d21..1b17d8e005 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -4199,7 +4199,7 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`. The ``terse`` option can be used in combination with the remote-as, neighbor, failed and established filters, and with the ``wide`` option as well. -.. clicmd:: show bgp [afi] [safi] [neighbor [PEER] [routes|advertised-routes|received-routes] [json] +.. clicmd:: show bgp [afi] [safi] [neighbor [PEER] [routes|advertised-routes|received-routes] [detail] [json] This command shows information on a specific BGP peer of the relevant afi and safi selected. @@ -4214,6 +4214,13 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`. The ``received-routes`` keyword displays all routes belonging to this address-family (prior to inbound policy) that were received by this peer. + 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. + .. clicmd:: show bgp [ VIEWVRFNAME] [afi] [safi] neighbors PEER received prefix-filter [json] Display Address Prefix ORFs received from this peer. @@ -4306,7 +4313,7 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`. If the ``json`` option is specified, output is displayed in JSON format. -.. clicmd:: show [ip] bgp [afi] [safi] [all] neighbors A.B.C.D [advertised-routes|received-routes|filtered-routes] [json|wide] +.. clicmd:: show [ip] bgp [afi] [safi] [all] neighbors A.B.C.D [advertised-routes|received-routes|filtered-routes] [detail] [json|wide] Display the routes advertised to a BGP neighbor or received routes from neighbor or filtered routes received from neighbor based on the @@ -4323,6 +4330,11 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`. if afi is specified, with ``all`` option, routes will be displayed for each SAFI in the selcted AFI + 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. .. clicmd:: show [ip] bgp [afi] [safi] [all] detail-routes -- 2.39.5