[show] enhance 'show ip[v6] bgp summary' command #754

rvisnu · 2019-11-26T09:43:06Z

- What I did
Enhanced show ip bgp summary and show ipv6 bgp summary commands to display neighbor host name
- How I did it
By getting the neighbor info from the CONFIG DB BGP_NEIGHBOR table
- How to verify it
Run show ip bgp summary or show ipv6 bgp summary in the hardware box
- Previous command output (if the output of a command-line utility has changed)
show ip bgp summary

  IPv4 Unicast Summary:
  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 6465
  RIB entries 12807, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd
  10.0.0.57       4      64600    3995    4001        0    0    0 00:39:32         6400
  10.0.0.59       4      64600    3995    3998        0    0    0 00:39:32         6400
  10.0.0.61       4      64600    3995    4001        0    0    0 00:39:32         6400
  10.0.0.63       4      64600    3995    3998        0    0    0 00:39:32         6400

  Total number of neighbors 4

show ipv6 bgp summary

  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 12803
  RIB entries 12805, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd
  fc00::72        4      64600    3995    5208        0    0    0 00:39:30         6400
  fc00::76        4      64600    3994    5208        0    0    0 00:39:30         6400
  fc00::7a        4      64600    3993    5208        0    0    0 00:39:30         6400
  fc00::7e        4      64600    3993    5208        0    0    0 00:39:30         6400

  Total number of neighbors 4

- New command output (if the output of a command-line utility has changed)

show ip bgp summary

  IPv4 Unicast Summary:
  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 6465
  RIB entries 12807, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd NeighborName
  10.0.0.57       4      64600    3995    4001        0    0    0 00:39:32         6400 Lab-T1-01
  10.0.0.59       4      64600    3995    3998        0    0    0 00:39:32         6400 Lab-T1-02
  10.0.0.61       4      64600    3995    4001        0    0    0 00:39:32         6400 Lab-T1-03
  10.0.0.63       4      64600    3995    3998        0    0    0 00:39:32         6400 NotAvailable

  Total number of neighbors 4

show ipv6 bgp summary

  BGP router identifier 10.1.0.32, local AS number 65100 vrf-id 0
  BGP table version 12803
  RIB entries 12805, using 2001 KiB of memory
  Peers 4, using 83 KiB of memory
  Peer groups 2, using 128 bytes of memory

  Neighbor        V         AS MsgRcvd MsgSent   TblVer  InQ OutQ  Up/Down State/PfxRcd NeighborName
  fc00::72        4      64600    3995    4001        0    0    0 00:39:32         6400 Lab-T1-01
  fc00::76        4      64600    3995    3998        0    0    0 00:39:32         6400 Lab-T1-02
  fc00::7a        4      64600    3995    4001        0    0    0 00:39:32         6400 Lab-T1-03
  fc00::7e       4      64600    3995    3998        0    0    0 00:39:32         6400 NotAvailable

Sandeepsr · 2019-11-26T10:18:50Z

show/bgp_frr_v6.py

@@ -19,7 +19,7 @@ def bgp():
 @bgp.command()
 def summary():
 """Show summarized information of IPv6 BGP state"""
- run_command('sudo vtysh -c "show bgp ipv6 summary"')
+ get_bgp_summary_extended('sudo vtysh -c "show ip bgp summary"')


ipv6 changed to ip ?

Thanks, changed to show bgp ipv6 summary in next iteration

Sandeepsr · 2019-11-26T10:19:16Z

show/bgp_quagga_v6.py

@@ -19,7 +19,7 @@ def bgp():
 @bgp.command()
 def summary():
 """Show summarized information of IPv6 BGP state"""
- run_command('sudo vtysh -c "show ipv6 bgp summary"')
+ get_bgp_summary_extended('sudo vtysh -c "show ip bgp summary"')


ipv6 changed to ip ?

Thanks, changed to show ipv6 bgp summary in next iteration

Sandeepsr · 2019-11-26T10:24:00Z

show/main.py

+ :param command: command to get bgp summary
+ """
+ try:
+ p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)


If you can consider : can we modifiy run_command to take a bool arg and return the output but not echo if True, then you can reuse the it at many places.:

def run_command(command, display_cmd=False, return_cmd=False):

if output and return_cmd:
return output
elif output:
click.echo(output.rstrip('\n'))

good one. modified in next iteration

doc/Command-Reference.md

Sandeepsr · 2019-11-26T10:52:07Z

show/main.py

+ device_output = p.stdout.read()
+ modified_output = []
+ my_list = iter(device_output.splitlines())
+ for element in my_list:


You can simplify logic. and avoid nested for loops.

import re
data_list = data.splitlines()

new_data = []

for i in data_list:
if i.startswith("Neighbor "):
new_i = "{}\tNeighborName".format(i)
new_data.append(new_i)
elif re.match(r"([0-9A-Fa-f]{1,4}:?|\d+.\d+.\d+.\d+)", i.split(" ")[0]):
new_data.append(i + "\tNameOfNeighbor")
elif i.startswith("Total number "):
new_data.append(i)
else:
new_data.append(i)

for i in new_data:
print(i)

The command output lines that we modify are not always sequential.
for eg.
sometimes the ipv6 summary output have ipv6 in one line and rest parameters comes in another line.

Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd afc0::20:1a2:1:1a 4 64802 506 504 0 0 0 08:17:29 7

So used iterator and nested for loops.
will check if I can simplify this.

removed nested for loops in next iteration

pavel-shirshov

as comments

pavel-shirshov · 2019-11-27T20:09:12Z

show/main.py

@@ -201,6 +201,8 @@ def run_command(command, display_cmd=False):
 proc = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)

 while True:
+ if return_cmd:
+ return proc.stdout.read()


This will not work if output has a lot of data.
You need to use communicate() for that. https://docs.python.org/2/library/subprocess.html#subprocess.Popen.communicate
Also

Warning Use communicate() rather than .stdin.write, .stdout.read or .stderr.read to avoid deadlocks due to any of the other OS pipe buffers filling up and blocking the child process.

from https://docs.python.org/2/library/subprocess.html

Thanks Pavel. Using communicate() from next iteration

show/bgp_quagga_v6.py

pavel-shirshov · 2019-11-27T20:11:56Z

show/main.py

+ modified_output.append(element)
+ elif not element or element.startswith("Total number "):
+ modified_output.append(element)
+ elif re.match(r"([0-9A-Fa-f]{1,4}:|\d+.\d+.\d+.\d+)", element.split()[0]):


your regexp doesn't have '*' prefix, which we have for dynamic neighbors.

fixed in next iteration

pavel-shirshov · 2019-11-27T20:12:36Z

show/main.py

+ name = bgp_neighbor_ip_to_name(ip)
+ if len(element.split()) == 1:
+ modified_output.append(element)
+ element = next(my_list)


I don't feel safe with next() here. I'm not sure it's a good practice.

element = next(my_list)
The show ipv6 bgp summary command output have ipv6 address in one line and the other datas in second line.

acb0::10:182:1:10e 4 64802 548 546 0 0 0 08:59:22 7

as the motive of this PR is to add the Neighbor Name at the end of default data, we have to move to the line and append at the end. That is the reason I chose the next method.

pavel-shirshov · 2019-11-27T20:13:39Z

show/main.py

+ :return: string
+ """
+ config_db = ConfigDBConnector()
+ config_db.connect()


Can you open that connection only once?
Otherwise you'll open a connection for every neighbor

changed in next iteration

rvisnu · 2019-12-10T11:45:45Z

please retest again

rvisnu · 2019-12-10T11:46:29Z

retest this please

rvisnu · 2019-12-10T23:51:14Z

retest this please

Merge remote-tracking branch 'origin/master' into bgpSummaryWithHostname

rvisnu · 2019-12-23T03:38:37Z

retest this please

pavel-shirshov · 2020-01-03T00:15:42Z

retest this please

rvisnu · 2020-01-06T07:07:19Z

retest this please

* [show] enhance 'show ip[v6] bgp summary' command * changing ipaddr to ipaddress

6cfb3ecb0248768da0a91e5f7fb4477c5da7eb4e (HEAD -> 201911, origin/201911) [build]: allow to use extra inc/lib location to build the package (sonic-net#595) 40d34872d3b7f354adac67f084eebf6ee467f779 Merge pull request sonic-net#846 from xumia/azp-201911 76ac50f147a7d820b19d8d7628a67f2fe4f5159b Disable the build test 6c9cf655b8b5b152cab1d578e05eddf8238b81b0 Fix branch reference error ca8d81d37a9b0294098f161b036d330d9ff461e0 [ci]: download artifacts from master branch (sonic-net#768) 0cbf4d55c67a9f8f52715f95536f3588acf06c4a [ci]: use sonicbld pool (sonic-net#766) b6f1265ee9bd86f8a5e909a6f1e9b2384497c906 [ci]: add build for arm64 and armhf (sonic-net#757) 9ec0a7da64d479b124815edc5b505fb88b2532a0 CI: add azure pipeline CI/CD (sonic-net#754) 1436dbe02cd3c56f796c6b3398d4075cd05d97e0 Fix RIF issue (sonic-net#835) Signed-off-by: Abhishek Dosi <abdosi@microsoft.com>

[show] enhance 'show ip[v6] bgp summary' command

32f180b

Sandeepsr reviewed Nov 26, 2019

View reviewed changes

doc/Command-Reference.md Show resolved Hide resolved

Sandeepsr reviewed Nov 26, 2019

View reviewed changes

addressing comments

3a2f83c

pavel-shirshov suggested changes Nov 27, 2019

View reviewed changes

pavel-shirshov self-assigned this Nov 27, 2019

pavel-shirshov added the Enhancement label Nov 27, 2019

Visnu Rajendran (virajend) added 2 commits November 28, 2019 09:26

addressing comments

37eb563

addressing comments

dda88b2

pavel-shirshov previously approved these changes Dec 10, 2019

View reviewed changes

Visnu Rajendran (virajend) added 2 commits December 20, 2019 11:06

Merging with local master.

6972997

Merge remote-tracking branch 'origin/master' into bgpSummaryWithHostname

changing ipaddr to ipaddress

5a45499

rvisnu dismissed pavel-shirshov’s stale review via 5a45499 December 20, 2019 11:09

pavel-shirshov approved these changes Jan 6, 2020

View reviewed changes

pavel-shirshov added the Request for 201911 Branch label Jan 6, 2020

pavel-shirshov merged commit c217c0c into sonic-net:master Jan 15, 2020

rvisnu mentioned this pull request Jan 20, 2020

ipaddr module to ipaddress #786

Merged

abdosi pushed a commit that referenced this pull request Jan 21, 2020

[show] enhance 'show ip[v6] bgp summary' command (#754)

b969958

* [show] enhance 'show ip[v6] bgp summary' command * changing ipaddr to ipaddress

abdosi added the Included in 201911 Branch label Jan 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[show] enhance 'show ip[v6] bgp summary' command #754

[show] enhance 'show ip[v6] bgp summary' command #754

rvisnu commented Nov 26, 2019

Sandeepsr Nov 26, 2019

rvisnu Nov 26, 2019 •

edited

Loading

Sandeepsr Nov 26, 2019

rvisnu Nov 26, 2019 •

edited

Loading

Sandeepsr Nov 26, 2019 •

edited

Loading

rvisnu Nov 26, 2019 •

edited

Loading

Sandeepsr Nov 26, 2019

rvisnu Nov 26, 2019

rvisnu Nov 27, 2019

pavel-shirshov left a comment

pavel-shirshov Nov 27, 2019

rvisnu Nov 28, 2019

pavel-shirshov Nov 27, 2019

rvisnu Nov 28, 2019 •

edited

Loading

pavel-shirshov Nov 27, 2019

rvisnu Nov 28, 2019 •

edited

Loading

pavel-shirshov Nov 27, 2019

rvisnu Nov 28, 2019

rvisnu commented Dec 10, 2019

rvisnu commented Dec 10, 2019

rvisnu commented Dec 10, 2019

rvisnu commented Dec 23, 2019

pavel-shirshov commented Jan 3, 2020

rvisnu commented Jan 6, 2020

[show] enhance 'show ip[v6] bgp summary' command #754

[show] enhance 'show ip[v6] bgp summary' command #754

Conversation

rvisnu commented Nov 26, 2019

Choose a reason for hiding this comment

rvisnu Nov 26, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvisnu Nov 26, 2019 • edited Loading

Choose a reason for hiding this comment

Sandeepsr Nov 26, 2019 • edited Loading

Choose a reason for hiding this comment

rvisnu Nov 26, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pavel-shirshov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvisnu Nov 28, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvisnu Nov 28, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rvisnu commented Dec 10, 2019

rvisnu commented Dec 10, 2019

rvisnu commented Dec 10, 2019

rvisnu commented Dec 23, 2019

pavel-shirshov commented Jan 3, 2020

rvisnu commented Jan 6, 2020

rvisnu Nov 26, 2019 •

edited

Loading

rvisnu Nov 26, 2019 •

edited

Loading

Sandeepsr Nov 26, 2019 •

edited

Loading

rvisnu Nov 26, 2019 •

edited

Loading

rvisnu Nov 28, 2019 •

edited

Loading

rvisnu Nov 28, 2019 •

edited

Loading