[show] Add show ssd CLI #502

mudsut4ke · 2019-04-08T02:26:46Z

- What I did
Add commands to display SSD information

  ssd_all               Execute all test iterms of SSD
  ssd_badblock          Check the later bad block status which may...
  ssd_capcity           Show ssd capcity
  ssd_firmwareinfo      Show ssd fwinfo
  ssd_health            Check the health status
  ssd_help              Show all SSD cmd
  ssd_pecycle           Show ssd P/E cycle
  ssd_remaintime        Show ssd Remaining Time
  ssd_sn                Show ssd serial number
  ssd_temperature       Read SSD temperature C

- How I did it
Add function to display ssd information to 'show/main.py'

- How to verify it

Install smartmontool ([docker-platform-monitor]: Add smartmontools 6.6-1 sonic-buildimage#2703)
Run show ssd command as above

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

admin@sonic:~$ show
Usage: show [OPTIONS] COMMAND [ARGS]...

  SONiC command line - 'show' command

Options:
  -?, -h, --help  Show this message and exit.

Commands:
  aaa                   Show AAA configuration
  acl                   Show ACL related information
  arp                   Show IP ARP table
  clock                 Show date and time
  ecn                   Show ECN configuration
  environment           Show environmentals (voltages, fans, temps)
  interfaces            Show details of the network interfaces
  ip                    Show IP (IPv4) commands
  ipv6                  Show IPv6 commands
  line                  Show all /dev/ttyUSB lines and their info
  lldp                  LLDP (Link Layer Discovery Protocol)...
  logging               Show system log
  mac                   Show MAC (FDB) entries
  mirror_session        Show existing everflow sessions
  mmu                   Show mmu configuration
  ndp                   Show IPv6 Neighbour table
  ntp                   Show NTP information
  pfc                   Show details of the priority-flow-control...
  platform              Show platform-specific hardware info
  priority-group        Show details of the PGs
  processes             Display process information
  queue                 Show details of the queues
  reboot-cause          Show cause of most recent reboot
  route-map             show route-map
  runningconfiguration  Show current running configuration...
  services              Show all daemon services
  startupconfiguration  Show startup configuration information
  system-memory         Show memory information
  tacacs                Show TACACS+ configuration
  techsupport           Gather information for troubleshooting
  uptime                Show system uptime
  users                 Show users
  version               Show version information
  vlan                  Show VLAN information
  warm_restart          Show warm restart configuration and state
  watermark             Show details of watermark

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

admin@sonic:~$ show
Usage: show [OPTIONS] COMMAND [ARGS]...

  SONiC command line - 'show' command

Options:
  -?, -h, --help  Show this message and exit.

Commands:
  aaa                   Show AAA configuration
  acl                   Show ACL related information
  arp                   Show IP ARP table
  clock                 Show date and time
  ecn                   Show ECN configuration
  environment           Show environmentals (voltages, fans, temps)
  interfaces            Show details of the network interfaces
  ip                    Show IP (IPv4) commands
  ipv6                  Show IPv6 commands
  line                  Show all /dev/ttyUSB lines and their info
  lldp                  LLDP (Link Layer Discovery Protocol)...
  logging               Show system log
  mac                   Show MAC (FDB) entries
  mirror_session        Show existing everflow sessions
  mmu                   Show mmu configuration
  ndp                   Show IPv6 Neighbour table
  ntp                   Show NTP information
  pcie_checkid          Chedk Vender ID and Devie ID Check
  pcie_help             Show all SSD cmd
  pcie_lnkspeed         Chedk the link speed
  pfc                   Show details of the priority-flow-control...
  platform              Show platform-specific hardware info
  priority-group        Show details of the PGs
  processes             Display process information
  queue                 Show details of the queues
  reboot-cause          Show cause of most recent reboot
  route-map             show route-map
  runningconfiguration  Show current running configuration...
  services              Show all daemon services
  ssd_all               Execute all test iterms of SSD
  ssd_badblock          Check the later bad block status which may...
  ssd_capcity           Show ssd capcity
  ssd_firmwareinfo      Show ssd fwinfo
  ssd_health            Check the health status
  ssd_help              Show all SSD cmd
  ssd_pecycle           Show ssd P/E cycle
  ssd_remaintime        Show ssd Remaining Time
  ssd_sn                Show ssd serial number
  ssd_temperature       Read SSD temperature C
  startupconfiguration  Show startup configuration information
  system-memory         Show memory information
  tacacs                Show TACACS+ configuration
  techsupport           Gather information for troubleshooting
  uptime                Show system uptime
  users                 Show users
  version               Show version information
  vlan                  Show VLAN information
  warm_restart          Show warm restart configuration and state
  watermark             Show details of watermark

mudsut4ke · 2019-04-08T03:37:34Z

@sandycelestica Please follow this PR

jleveque

Please make 'ssd' a group and all ssd-related commands should be nested under that group. This will help consolidate the commands. For example,

show ssd all
show ssd badblock
show ssd capcity
...

Many examples of groups like this already exist in this file.

* [show] update ssd cli format * [show] fix invalid capacity text

andriymoroz-mlnx · 2019-04-09T14:26:06Z

show/main.py

+            click.echo(line.strip())
+        return
+    else:
+        for line in output:


this code block repeats 4 times. Function?

andriymoroz-mlnx · 2019-04-09T14:31:01Z

show/main.py

+
+
+#
+# function name : print_test_title


why printing firmware version or capacity is a "test"?

I'll update this part later.If you have the detail request of the content.Please let me know.I plan to display like this:"Show SSD Firmware info"

andriymoroz-mlnx · 2019-04-09T14:42:30Z

show/main.py

+
+    checkin = 1
+    testname = "Vender ID and Devie ID Check Test"
+    command = "sudo lspci -n | grep b960 "


what is b960? vid? pid?

b960 is the switch chip(BCM56960) of Seastone. Here we just check switch chip info.

andriymoroz-mlnx · 2019-04-09T14:47:13Z

show/main.py

+                else:
+                    checkin = 0
+                    click.echo(line.strip())
+                    click.echo("Device Model Not Match 3ME3 3ME4 or 3IE3")


how to extend the code if disk vendor is not one from the list?
upd:
to make it extendable consider using plugins model
see: https://github.com/Azure/SONiC/wiki/SSD-Health-design-(Draft)

Thanks for your suggest. Currently this SSD diag is just for Seastone. So not support other types of SSD right now. And we are planning to extend it.

andriymoroz-mlnx

show utility is mostly a wrapper
I suggest to have a separate utility (like sfputil, psuutil, intfutil, etc) and call it from show

mudsut4ke · 2019-04-09T14:51:49Z

@sandycelestica, Please check the above comment

andriymoroz-mlnx · 2019-04-09T15:11:49Z

show/main.py

+                checkin = 1
+
+    if(checkin == 1):
+        remainingtime = poweron * 100 / 7.62 - poweron


remainingtime = poweron * 100 / 7.62 - poweron
remainingtime = poweron * (100 / 7.62 - 1)
remainingtime = poweron * 12.12
what is remaining time for SSD?

There is a formula to calculate this value:
ID Hex Attribute

09 (09) Power on Hours
To estimate remaining hours of use: ID# 9 (100/7.26) – 1 (x ID# 9)

In our code,
if "Power_On_Hours" in line:
rawval = line.split()[-1]
poweron = int(rawval)
checkin = 1

we get the poweron first and then calculate the remaining time follow the formula.

I just don't understand why remaining time is calculated as poweron*12
why remaining is always greater?

jleveque · 2019-04-10T01:06:14Z

@mudsut4ke, @sandycelestica: Are you aware of this in-progress design for SSD health: https://github.com/Azure/SONiC/wiki/SSD-Health-design-(Draft)?

sandycelestica · 2019-04-10T02:05:35Z

show utility is mostly a wrapper
I suggest to have a separate utility (like sfputil, psuutil, intfutil, etc) and call it from show

From the beginning we discussed with Guo Han. He suggested to modify the main.py in show. So we merged it into show.

mudsut4ke · 2019-04-10T02:49:12Z

Add @grantshao Please help Sandy review this change

mudsut4ke · 2019-04-10T03:14:55Z

show utility is mostly a wrapper
I suggest to have a separate utility (like sfputil, psuutil, intfutil, etc) and call it from show

From the beginning we discussed with Guo Han. He suggested to modify the main.py in show. So we merged it into show.

@lguohan, Do you have a comment ?

andriymoroz-mlnx · 2019-04-10T07:24:46Z

show/main.py

+                checkin = 1
+
+    if(checkin == 1):
+        remainingtime = poweron * 100 / 7.62 - poweron


I just don't understand why remaining time is calculated as poweron*12
why remaining is always greater?

andriymoroz-mlnx · 2019-04-10T07:45:47Z

show/main.py

+
+@ssd.command()
+@click.argument("device")
+def all(device):


all() can call other functions and not duplicate the code...

OK,I'll update it as your suggestion.Thanks

andriymoroz-mlnx · 2019-04-10T07:46:58Z

show/main.py

+
+
+#
+# check_pcie_speed


It would be better to have pcie in a separate PR
or at least fix the subject...

liat-grozovik

As a general comment i think it is bad practice to add a CLI which can work on specific platforms.
The idea is that the code/utility provided can be extended to other vendors at any time and for that it should be designed to be like that.

Also, as this is only a utility I believe it is only show the current value which is good but it is partially. I think it should be added as a new API to the Platform API as a component and can be monitored as well. for example if some threshold expires we raise an error so the user/admin can handle.

In addition as it is relevant to multiple vendors we usually discuss the design before the PR in the community meeting or at least share a design doc. Can you please share?

liat-grozovik · 2019-05-01T14:02:12Z

We had an SSD HLD in the last community meeting. I think merging this CLI now will contradict the design held. The design is also referred earlier on this PR discussion.
My suggestion is to close the PR and to wait for the SSD implementation by Andiry Moroz.

@andriymoroz-mlnx could you please share the design document in https://github.com/Azure/SONiC/tree/master/doc as PRfollowing the review comments?

andriymoroz-mlnx · 2019-05-03T11:40:06Z

@andriymoroz-mlnx could you please share the design document in https://github.com/Azure/SONiC/tree/master/doc as PRfollowing the review comments?

Created https://github.com/Azure/SONiC/pull/378/files

[show] add interface to show ssd information

1c864f2

jleveque suggested changes Apr 8, 2019

View reviewed changes

[show] Update SSD CLI format

da469f9

* [show] update ssd cli format * [show] fix invalid capacity text

andriymoroz-mlnx reviewed Apr 9, 2019

View reviewed changes

show/main.py

click.echo(line.strip())

return

else:

for line in output:

Copy link

Collaborator

andriymoroz-mlnx Apr 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this code block repeats 4 times. Function?

andriymoroz-mlnx reviewed Apr 9, 2019

View reviewed changes

andriymoroz-mlnx suggested changes Apr 9, 2019

View reviewed changes

andriymoroz-mlnx reviewed Apr 9, 2019

View reviewed changes

andriymoroz-mlnx reviewed Apr 10, 2019

View reviewed changes

liat-grozovik reviewed Apr 10, 2019

View reviewed changes

mudsut4ke closed this May 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[show] Add show ssd CLI #502

[show] Add show ssd CLI #502

mudsut4ke commented Apr 8, 2019

mudsut4ke commented Apr 8, 2019 •

edited

Loading

jleveque left a comment

andriymoroz-mlnx Apr 9, 2019

andriymoroz-mlnx Apr 9, 2019

sandycelestica Apr 10, 2019

andriymoroz-mlnx Apr 9, 2019

sandycelestica Apr 10, 2019

andriymoroz-mlnx Apr 9, 2019 •

edited

Loading

sandycelestica Apr 10, 2019

andriymoroz-mlnx left a comment

mudsut4ke commented Apr 9, 2019

andriymoroz-mlnx Apr 9, 2019

sandycelestica Apr 10, 2019

andriymoroz-mlnx Apr 10, 2019

jleveque commented Apr 10, 2019

sandycelestica commented Apr 10, 2019

mudsut4ke commented Apr 10, 2019 •

edited

Loading

mudsut4ke commented Apr 10, 2019

andriymoroz-mlnx Apr 10, 2019

andriymoroz-mlnx Apr 10, 2019

sandycelestica Apr 10, 2019

andriymoroz-mlnx Apr 10, 2019

liat-grozovik left a comment •

edited

Loading

liat-grozovik commented May 1, 2019

andriymoroz-mlnx commented May 3, 2019

[show] Add show ssd CLI #502

[show] Add show ssd CLI #502

Conversation

mudsut4ke commented Apr 8, 2019

mudsut4ke commented Apr 8, 2019 • edited Loading

jleveque 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andriymoroz-mlnx Apr 9, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andriymoroz-mlnx left a comment

Choose a reason for hiding this comment

mudsut4ke commented Apr 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

There is a formula to calculate this value: ID Hex Attribute

Choose a reason for hiding this comment

jleveque commented Apr 10, 2019

sandycelestica commented Apr 10, 2019

mudsut4ke commented Apr 10, 2019 • edited Loading

mudsut4ke commented Apr 10, 2019

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

liat-grozovik left a comment • edited Loading

Choose a reason for hiding this comment

liat-grozovik commented May 1, 2019

andriymoroz-mlnx commented May 3, 2019

mudsut4ke commented Apr 8, 2019 •

edited

Loading

andriymoroz-mlnx Apr 9, 2019 •

edited

Loading

There is a formula to calculate this value:
ID Hex Attribute

mudsut4ke commented Apr 10, 2019 •

edited

Loading

liat-grozovik left a comment •

edited

Loading