doc: add documentation for show [ip] bgp [vrf] [afi] [safi] detail [json]

Signed-off-by: Rajasekar Raja <rajasekarr@nvidia.com>
This commit is contained in:
Rajasekar Raja 2023-05-05 09:28:40 -07:00
parent 795bef98db
commit 57e65a80b0

View File

@ -4109,6 +4109,122 @@ 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 selected AFI.
.. clicmd:: show [ip] bgp [<view|vrf> VIEWVRFNAME] [afi] [safi] detail [json]
Display the detailed version of all routes from the specified bgp vrf table
for a given afi + safi.
If no vrf is specified, then it is assumed as a default vrf and routes
are displayed from default vrf table.
If ``all`` option is specified as vrf name, then all bgp vrf tables routes
from a given afi+safi are displayed in the detailed output of routes.
If ``json`` option is specified, detailed output is displayed in JSON format.
Following are sample output for few examples of how to use this command.
.. code-block:: frr
torm-23# sh bgp ipv4 unicast detail (OR) sh bgp vrf default ipv4 unicast detail
!--- Output suppressed.
BGP routing table entry for 172.16.16.1/32
Paths: (1 available, best #1, table default)
Not advertised to any peer
Local, (Received from a RR-client)
172.16.16.1 (metric 20) from torm-22(172.16.16.1) (192.168.0.10)
Origin IGP, metric 0, localpref 100, valid, internal
Last update: Fri May 8 12:54:05 2023
BGP routing table entry for 172.16.16.2/32
Paths: (1 available, best #1, table default)
Not advertised to any peer
Local
0.0.0.0 from 0.0.0.0 (172.16.16.2)
Origin incomplete, metric 0, weight 32768, valid, sourced, bestpath-from-AS Local, best (First path received)
Last update: Wed May 8 12:54:41 2023
Displayed 2 routes and 2 total paths
.. code-block:: frr
torm-23# sh bgp vrf all detail
Instance default:
!--- Output suppressed.
BGP routing table entry for 172.16.16.1/32
Paths: (1 available, best #1, table default)
Not advertised to any peer
Local, (Received from a RR-client)
172.16.16.1 (metric 20) from torm-22(172.16.16.1) (192.168.0.10)
Origin IGP, metric 0, localpref 100, valid, internal
Last update: Fri May 8 12:44:05 2023
BGP routing table entry for 172.16.16.2/32
Paths: (1 available, best #1, table default)
Not advertised to any peer
Local
0.0.0.0 from 0.0.0.0 (172.16.16.2)
Origin incomplete, metric 0, weight 32768, valid, sourced, bestpath-from-AS Local, best (First path received)
Last update: Wed May 8 12:45:01 2023
Displayed 2 routes and 2 total paths
Instance vrf3:
!--- Output suppressed.
BGP routing table entry for 192.168.0.2/32
Paths: (1 available, best #1, vrf vrf3)
Not advertised to any peer
Imported from 172.16.16.1:12:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.0.2], VNI 1008/4003
Local
172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self
Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received)
Extended Community: RT:65000:1008 ET:8 Rmac:00:02:00:00:00:58
Last update: Fri May 8 02:41:55 2023
BGP routing table entry for 192.168.1.2/32
Paths: (1 available, best #1, vrf vrf3)
Not advertised to any peer
Imported from 172.16.16.1:13:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.1.2], VNI 1009/4003
Local
172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self
Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received)
Extended Community: RT:65000:1009 ET:8 Rmac:00:02:00:00:00:58
Last update: Fri May 8 02:41:55 2023
Displayed 2 routes and 2 total paths
.. code-block:: frr
torm-23# sh bgp vrf vrf3 ipv4 unicast detail
!--- Output suppressed.
BGP routing table entry for 192.168.0.2/32
Paths: (1 available, best #1, vrf vrf3)
Not advertised to any peer
Imported from 172.16.16.1:12:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.0.2], VNI 1008/4003
Local
172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self
Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received)
Extended Community: RT:65000:1008 ET:8 Rmac:00:02:00:00:00:58
Last update: Fri May 8 02:23:35 2023
BGP routing table entry for 192.168.1.2/32
Paths: (1 available, best #1, vrf vrf3)
Not advertised to any peer
Imported from 172.16.16.1:13:[2]:[0]:[48]:[00:02:00:00:00:58]:[32]:[192.168.1.2], VNI 1009/4003
Local
172.16.16.1 from torm-22(172.16.16.1) (172.16.16.1) announce-nh-self
Origin IGP, localpref 100, valid, internal, bestpath-from-AS Local, best (First path received)
Extended Community: RT:65000:1009 ET:8 Rmac:00:02:00:00:00:58
Last update: Fri May 8 02:23:55 2023
Displayed 2 routes and 2 total paths
.. _bgp-display-routes-by-community:
Displaying Routes by Community Attribute