Add CLI show commands to view bgp network, neighbors and summary on per-vrf basis

doc/Command-Reference.md

@@ -2376,15 +2376,17 @@ Detailed show commands examples for Quagga are provided at the end of this docum
 
 This command displays the summary of all IPv4 & IPv6 bgp neighbors that are configured and the corresponding states.
 
+Optionally, you can specify a vrf-name in order to display summary only for that particular vrf. 
+
 - Usage:
 
   *Versions >= 201904 using default FRR routing stack*
   ```
-  show bgp summary
+  show bgp [vrf <vrf-name>] summary
   ```
   *Versions <= 201811 using Quagga routing stack*
   ```
-  show ip bgp summary
+  show ip bgp [vrf <vrf-name>] summary
   ```
 
 - Example:
@@ -2462,11 +2464,11 @@ In order to get details for an IPv6 neigbor, use "show bgp ipv6 neighbor <ipv6_a
 
   *Versions >= 201904 using default FRR routing stack*
   ```
-  show bgp neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
+  show bgp [vrf <vrf-name>] neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
   ```
   *Versions <= 201811 using Quagga routing stack*
   ```
-  show ip bgp neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
+  show ip bgp [vrf <vrf-name>] neighbors [<ipv4-address> [advertised-routes | received-routes | routes]]
   ```
 
 - Example:
@@ -2540,16 +2542,22 @@ Optionally, you can specify an IP address in order to display only that particul
 
   Click [here](#Quagga-BGP-Show-Commands) to see the example for "show ip bgp neighbors" for Quagga.
 
+Optionally, you can specify a vrf-name in order to display only neighbors for that particular vrf. 
+
+- Example:
+```
+ admin@sonic:~$ show bgp vrf Vnet_90 neighbors
+```
 
-**show ip bgp network [[<ipv4-address>|<ipv4-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
+**show ip bgp [vrf <vrf-name>] network [[<ipv4-address>|<ipv4-prefix>] [(bestpath | multipath | longer-prefixes | json)]]**
 
 This command displays all the details of IPv4 Border Gateway Protocol (BGP) prefixes.
 
 - Usage:
 
 
   ```
-  show ip bgp network [[<ipv4-address>|<ipv4-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
+  show ip bgp [vrf <vrf-name>] network [[<ipv4-address>|<ipv4-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
   ```
 
 - Example:
@@ -2572,23 +2580,25 @@ This command displays all the details of IPv4 Border Gateway Protocol (BGP) pref
   admin@sonic:~$ show ip bgp network 10.1.0.32/32 json
 
   admin@sonic:~$ show ip bgp network 10.1.0.32/32 longer-prefixes
+
+  admin@sonic:~$ show ip bgp vrf Vnet_90 network
   ```
 
-**show bgp ipv6 summary (Versions >= 201904 using default FRR routing stack)**
+**show bgp [vrf <vrf-name>] ipv6 summary (Versions >= 201904 using default FRR routing stack)**
 
-**show ipv6 bgp summary (Versions <= 201811 using Quagga routing stack)**
+**show ipv6 bgp [vrf <vrf-name>] summary (Versions <= 201811 using Quagga routing stack)**
 
 This command displays the summary of all IPv6 bgp neighbors that are configured and the corresponding states.
 
 - Usage:
 
   *Versions >= 201904 using default FRR routing stack*
   ```
-  show bgp ipv6 summary
+  show bgp [vrf <vrf-name>] ipv6 summary
   ```
   *Versions <= 201811 using Quagga routing stack*
   ```
-  show ipv6 bgp summary
+  show ipv6 bgp [vrf <vrf-name>] summary
   ```
 
 - Example:
@@ -2623,11 +2633,11 @@ This command displays all the details of one particular IPv6 Border Gateway Prot
 
   *Versions >= 201904 using default FRR routing stack*
   ```
-  show bgp ipv6 neighbors [<ipv6-address> [(advertised-routes | received-routes | routes)]]
+  show bgp [vrf <vrf-name>] ipv6 neighbors [<ipv6-address> [(advertised-routes | received-routes | routes)]]
   ```
   *Versions <= 201811 using Quagga routing stack*
   ```
-  show ipv6 bgp neighbors [<ipv6-address> [(advertised-routes | received-routes | routes)]]
+  show ipv6 bgp [vrf <vrf-name>] neighbors [<ipv6-address> [(advertised-routes | received-routes | routes)]]
   ```
 
 - Example:
@@ -2637,19 +2647,21 @@ This command displays all the details of one particular IPv6 Border Gateway Prot
   admin@sonic:~$ show bgp ipv6 neighbors fc00::72 received-routes
 
   admin@sonic:~$ show bgp ipv6 neighbors fc00::72 routes
+
+  admin@sonic:~$ show bgp vrf Vnet_90 ipv6 neighbors
   ```
   Click [here](#Quagga-BGP-Show-Commands) to see the example for "show ip bgp summary" for Quagga.
 
 
-**show ipv6 bgp network [[<ipv6-address>|<ipv6-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
+**show ipv6 bgp [vrf <vrf-name>] network [[<ipv6-address>|<ipv6-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
 
 This command displays all the details of IPv6 Border Gateway Protocol (BGP) prefixes.
 
 - Usage:
 
 
   ```
-  show ipv6 bgp network [[<ipv6-address>|<ipv6-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
+  show ipv6 bgp [vrf <vrf-name>] network [[<ipv6-address>|<ipv6-prefix>] [(bestpath | multipath | longer-prefixes | json)]]
   ```
 
 - Example:
@@ -2672,7 +2684,8 @@ This command displays all the details of IPv6 Border Gateway Protocol (BGP) pref
   admin@sonic:~$ show ipv6 bgp network fc00::72/64 json
 
   admin@sonic:~$ show ipv6 bgp network fc00::72/64 longer-prefixes
-  ```
+
+  admin@sonic:~$ show ipv6 bgp vrf Vnet_90 network
 
 
 

show/bgp_frr_v4.py

@@ -20,7 +20,10 @@
 def bgp():
     """Show IPv4 BGP (Border Gateway Protocol) information"""
     if device_info.is_supervisor():
-        subcommand = sys.argv[3]
+        if sys.argv[3] in "vrf":
+            subcommand = sys.argv[5]
+        else:
+            subcommand = sys.argv[3]
         if subcommand not in "network":
             # the command will be executed directly by rexec if it is not "show ip bgp network"
             click.echo("Since the current device is a chassis supervisor, " +
@@ -33,10 +36,7 @@ def bgp():
 @bgp.command()
 @multi_asic_util.multi_asic_click_options
 def summary(namespace, display):
-    bgp_summary = bgp_util.get_bgp_summary_from_all_bgp_instances(
-        constants.IPV4, namespace, display)
-    bgp_util.display_bgp_summary(bgp_summary=bgp_summary, af=constants.IPV4)
-
+    summary_helper(namespace, display)
 
 # 'neighbors' subcommand ("show ip bgp neighbors")
 @bgp.command()
@@ -55,8 +55,104 @@ def summary(namespace, display):
                 callback=multi_asic_util.multi_asic_namespace_validation_callback)
 def neighbors(ipaddress, info_type, namespace):
     """Show IP (IPv4) BGP neighbors"""
+    neighbors_helper(ipaddress, info_type, namespace)
+
+# 'network' subcommand ("show ip bgp network")
+@bgp.command()
+@click.argument('ipaddress',
+                metavar='[<ipv4-address>|<ipv4-prefix>]',
+                required=True if device_info.is_supervisor() else False)
+@click.argument('info_type',
+                metavar='[bestpath|json|longer-prefixes|multipath]',
+                type=click.Choice(
+                    ['bestpath', 'json', 'longer-prefixes', 'multipath']),
+                required=False)
+@click.option('--namespace',
+                '-n',
+                'namespace',
+                type=str,
+                show_default=True,
+                required=False,
+                help='Namespace name or all',
+                default="all",
+                callback=multi_asic_util.multi_asic_namespace_validation_callback)
+def network(ipaddress, info_type, namespace):
+    """Show IP (IPv4) BGP network"""
+    network_helper(ipaddress, info_type, namespace)
+
+@bgp.group(cls=clicommon.AliasedGroup)
+@click.argument('vrf', required=True)
+@click.pass_context
+def vrf(ctx, vrf):
+    """Show IPv4 BGP information for a given VRF"""
+    pass
+
+# 'summary' subcommand ("show ip bgp vrf <vrf/vnet name> summary")
+@vrf.command('summary')
+@multi_asic_util.multi_asic_click_options
+@click.pass_context
+def vrf_summary(ctx, namespace, display):
+    vrf = ctx.parent.params['vrf']
+    summary_helper(namespace, display, vrf)
+
+# 'neighbors' subcommand ("show ip bgp vrf neighbors")
+@vrf.command('neighbors')
+@click.argument('ipaddress', required=False)
+@click.argument('info_type',
+                type=click.Choice(
+                    ['routes', 'advertised-routes', 'received-routes']),
+                required=False)
+@click.option('--namespace',
+                '-n',
+                'namespace',
+                default=None,
+                type=str,
+                show_default=True,
+                help='Namespace name or all',
+                callback=multi_asic_util.multi_asic_namespace_validation_callback)
+@click.pass_context
+def vrf_neighbors(ctx, ipaddress, info_type, namespace):
+    """Show IP (IPv4) BGP neighbors"""
+    vrf = ctx.parent.params['vrf']
+    neighbors_helper(ipaddress, info_type, namespace, vrf)
+
+# 'network' subcommand ("show ip bgp vrf network")
+@vrf.command('network')
+@click.argument('ipaddress',
+                metavar='[<ipv4-address>|<ipv4-prefix>]',
+                required=True if device_info.is_supervisor() else False)
+@click.argument('info_type',
+                metavar='[bestpath|json|longer-prefixes|multipath]',
+                type=click.Choice(
+                    ['bestpath', 'json', 'longer-prefixes', 'multipath']),
+                required=False)
+@click.option('--namespace',
+                '-n',
+                'namespace',
+                type=str,
+                show_default=True,
+                required=False,
+                help='Namespace name or all',
+                default="all",
+                callback=multi_asic_util.multi_asic_namespace_validation_callback)
+@click.pass_context
+def vrf_network(ctx, ipaddress, info_type, namespace):
+    """Show IP (IPv4) BGP network"""
+    vrf = ctx.parent.params['vrf']
+    network_helper(ipaddress, info_type, namespace, vrf)
+
+def summary_helper(namespace, display, vrf=None):
+    bgp_summary = bgp_util.get_bgp_summary_from_all_bgp_instances(
+        constants.IPV4, namespace, display, vrf)
+    bgp_util.display_bgp_summary(bgp_summary=bgp_summary, af=constants.IPV4)
+
+
+def neighbors_helper(ipaddress, info_type, namespace, vrf=None):
+    command = 'show ip bgp'
+    if vrf is not None:
+        command += ' vrf {}'.format(vrf) 
+    command += ' neighbor'
 
-    command = 'show ip bgp neighbor'
     if ipaddress is not None:
         if not bgp_util.is_ipv4_address(ipaddress):
             ctx = click.get_current_context()
@@ -87,29 +183,11 @@ def neighbors(ipaddress, info_type, namespace):
         output += bgp_util.run_bgp_show_command(command, ns)
 
     click.echo(output.rstrip('\n'))
-
-
-# 'network' subcommand ("show ip bgp network")
-@bgp.command()
-@click.argument('ipaddress',
-                metavar='[<ipv4-address>|<ipv4-prefix>]',
-                required=True if device_info.is_supervisor() else False)
-@click.argument('info_type',
-                metavar='[bestpath|json|longer-prefixes|multipath]',
-                type=click.Choice(
-                    ['bestpath', 'json', 'longer-prefixes', 'multipath']),
-                required=False)
-@click.option('--namespace',
-                '-n',
-                'namespace',
-                type=str,
-                show_default=True,
-                required=False,
-                help='Namespace name or all',
-                default="all",
-                callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def network(ipaddress, info_type, namespace):
-    """Show IP (IPv4) BGP network"""
+
+def network_helper(ipaddress, info_type, namespace, vrf=None):
+    command = 'show ip bgp'
+    if vrf is not None:
+        command += ' vrf {}'.format(vrf) 
 
     if device_info.is_supervisor():
         # the command will be executed by rexec
@@ -125,7 +203,6 @@ def network(ipaddress, info_type, namespace):
             ctx.fail('invalid namespace {}. provide namespace from list {}'
                      .format(namespace, multi_asic.get_namespace_list()))
 
-    command = 'show ip bgp'
     if ipaddress is not None:
         if '/' in ipaddress:
             # For network prefixes then this all info_type(s) are available
@@ -154,4 +231,4 @@ def network(ipaddress, info_type, namespace):
             click.echo(output.rstrip('\n'))
     else:
         output = bgp_util.run_bgp_show_command(command, namespace)
-        click.echo(output.rstrip('\n'))
+        click.echo(output.rstrip('\n'))