Skip to content

Commit d33454c

Browse files
shlomibittonShlomi Bitton
authored andcommitted
Update Command-Reference.md
Add a CLI reference for system-health feature.
1 parent c04dfed commit d33454c

1 file changed

Lines changed: 189 additions & 0 deletions

File tree

doc/Command-Reference.md

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@
108108
* [System State](#system-state)
109109
* [Processes](#processes)
110110
* [Services & Memory](#services--memory)
111+
* [System-Health](#System-Health)
111112
* [VLAN & FDB](#vlan--fdb)
112113
* [VLAN](#vlan)
113114
* [VLAN show commands](#vlan-show-commands)
@@ -5907,6 +5908,194 @@ NOTE: This command is not working. It crashes as follows. A bug ticket is opened
59075908
59085909
Go Back To [Beginning of the document](#) or [Beginning of this section](#System-State)
59095910
5911+
Go Back To [Beginning of the document](#) or [Beginning of this section](#System-Health)
5912+
5913+
### System-Health
5914+
5915+
These commands are used to monitor the system current running services and hardware state.
5916+
5917+
**show system-health summary**
5918+
5919+
This command displays the current status of 'Services' and 'Hardware' under monitoring.
5920+
If any of the elements under each of these two sections is 'Not OK' a proper message will appear under the relevant section.
5921+
5922+
- Usage:
5923+
```
5924+
show system-health summary
5925+
```
5926+
5927+
- Example:
5928+
```
5929+
admin@sonic:~$ show system-health summary
5930+
System status summary
5931+
---------------------
5932+
System status LED red
5933+
5934+
Services Not OK
5935+
telemetry is not Running
5936+
Hardware OK
5937+
5938+
```
5939+
```
5940+
admin@sonic:~$ show system-health summary
5941+
System status summary
5942+
---------------------
5943+
System status LED green
5944+
5945+
Services OK
5946+
Hardware OK
5947+
5948+
```
5949+
5950+
**show system-health monitor-list**
5951+
5952+
This command displays a list of all current 'Services' and 'Hardware' being monitored, their status and type.
5953+
5954+
- Usage:
5955+
```
5956+
show system-health monitor-list
5957+
```
5958+
5959+
- Example:
5960+
```
5961+
admin@sonic:~$ show system-health monitor-list
5962+
System services and devices monitor list
5963+
----------------------------------------
5964+
5965+
Name Status Type
5966+
-------------- -------- ----------
5967+
telemetry Not OK Process
5968+
neighsyncd OK Process
5969+
vrfmgrd OK Process
5970+
dialout_client OK Process
5971+
zebra OK Process
5972+
rsyslog OK Process
5973+
snmpd OK Process
5974+
redis_server OK Process
5975+
intfmgrd OK Process
5976+
orchagent OK Process
5977+
vxlanmgrd OK Process
5978+
lldpd_monitor OK Process
5979+
portsyncd OK Process
5980+
var-log OK Filesystem
5981+
lldpmgrd OK Process
5982+
syncd OK Process
5983+
sonic OK System
5984+
buffermgrd OK Process
5985+
portmgrd OK Process
5986+
staticd OK Process
5987+
bgpd OK Process
5988+
lldp_syncd OK Process
5989+
bgpcfgd OK Process
5990+
snmp_subagent OK Process
5991+
root-overlay OK Filesystem
5992+
fpmsyncd OK Process
5993+
sflowmgrd OK Process
5994+
vlanmgrd OK Process
5995+
nbrmgrd OK Process
5996+
PSU 2 OK PSU
5997+
psu_1_fan_1 OK Fan
5998+
psu_2_fan_1 OK Fan
5999+
fan11 OK Fan
6000+
fan10 OK Fan
6001+
fan12 OK Fan
6002+
ASIC OK ASIC
6003+
fan1 OK Fan
6004+
PSU 1 OK PSU
6005+
fan3 OK Fan
6006+
fan2 OK Fan
6007+
fan5 OK Fan
6008+
fan4 OK Fan
6009+
fan7 OK Fan
6010+
fan6 OK Fan
6011+
fan9 OK Fan
6012+
fan8 OK Fan
6013+
6014+
```
6015+
6016+
**show system-health detail**
6017+
6018+
This command displays the current status of 'Services' and 'Hardware' under monitoring.
6019+
If any of the elements under each of these two sections is 'Not OK' a proper message will appear under the relevant section.
6020+
In addition, displays a list of all current 'Services' and 'Hardware' being monitored and a list of ignored elements.
6021+
6022+
- Usage:
6023+
```
6024+
show system-health detail
6025+
```
6026+
6027+
- Example:
6028+
```
6029+
admin@sonic:~$ show system-health detail
6030+
System status summary
6031+
---------------------
6032+
System status LED red
6033+
6034+
Services Not OK
6035+
telemetry is not Running
6036+
Hardware OK
6037+
6038+
System services and devices monitor list
6039+
----------------------------------------
6040+
6041+
Name Status Type
6042+
-------------- -------- ----------
6043+
telemetry Not OK Process
6044+
neighsyncd OK Process
6045+
vrfmgrd OK Process
6046+
dialout_client OK Process
6047+
zebra OK Process
6048+
rsyslog OK Process
6049+
snmpd OK Process
6050+
redis_server OK Process
6051+
intfmgrd OK Process
6052+
orchagent OK Process
6053+
vxlanmgrd OK Process
6054+
lldpd_monitor OK Process
6055+
portsyncd OK Process
6056+
var-log OK Filesystem
6057+
lldpmgrd OK Process
6058+
syncd OK Process
6059+
sonic OK System
6060+
buffermgrd OK Process
6061+
portmgrd OK Process
6062+
staticd OK Process
6063+
bgpd OK Process
6064+
lldp_syncd OK Process
6065+
bgpcfgd OK Process
6066+
snmp_subagent OK Process
6067+
root-overlay OK Filesystem
6068+
fpmsyncd OK Process
6069+
sflowmgrd OK Process
6070+
vlanmgrd OK Process
6071+
nbrmgrd OK Process
6072+
PSU 2 OK PSU
6073+
psu_1_fan_1 OK Fan
6074+
psu_2_fan_1 OK Fan
6075+
fan11 OK Fan
6076+
fan10 OK Fan
6077+
fan12 OK Fan
6078+
ASIC OK ASIC
6079+
fan1 OK Fan
6080+
PSU 1 OK PSU
6081+
fan3 OK Fan
6082+
fan2 OK Fan
6083+
fan5 OK Fan
6084+
fan4 OK Fan
6085+
fan7 OK Fan
6086+
fan6 OK Fan
6087+
fan9 OK Fan
6088+
fan8 OK Fan
6089+
6090+
System services and devices ignore list
6091+
---------------------------------------
6092+
6093+
Name Status Type
6094+
----------- -------- ------
6095+
psu.voltage Ignore Device
6096+
6097+
```
6098+
Go Back To [Beginning of the document](#) or [Beginning of this section](#System-Health)
59106099
59116100
## VLAN & FDB
59126101

0 commit comments

Comments
 (0)