# System Self-Diagnostics

## 1. Function Overview

This product includes system self-diagnostic function.

The system self-diagnostic function detects the following types of errors.

- Startup process errors

- Hardware component errors

  - Interface (Ethernet port)

  - RTC

  - CPLD

  - SFP

  - PSU

  - Fan

- Memory error

- Temperature anomaly

## 2. Definition of Terms Used

RTC（Real-Time Clock）

Device used to manage time

CPLD (Complex Programmable Logic Device)

A type of programmable logic circuit device.

PSU (Power Supply Unit)

Power supply unit.

Packet Processor

Device used to process packets.

## 3. Function Details

### 3.1. Diagnostics

Three types of system self-diagnostic functionality, either boot-up diagnostics, on-demand diagnostics, or health monitoring diagnostics, are available depending on when diagnostics are performed.
The features of each type are indicated below.

- Boot-up diagnostics

  - Automatically executes whenever the system starts up.

  - Detects startup process errors and hardware component errors (RTC, etc.).

- On-demand diagnostics

  - Can be executed at user-specified times set using the system-diagnostics on-demand execute command.

  - Detects hardware component errors (interface, etc.) and memory errors.

  - All ports are shut down during diagnostics and the system is restarted when finished.

- Health monitoring diagnostics

  - Running continuously in the background during system operation

  - Detects hardware component errors (fan errors, etc.) and temperature abnormalities.

  - Health monitoring diagnostics results are displayed via the GUI and LED indicators (only some test results are indicated via the LED indicators).

Each diagnosis runs multiple tests. The tests performed for each diagnosis are indicated below.
For a detailed list of tests performed, refer to 4. Test Details.

Test Type | Boot-up diagnostics | On-demand diagnostics | Health monitoring diagnostics
--- | --- | --- | ---
Loading Test | Yes |  |
RTC Test | Yes |  |
Packet Processor Test | Yes |  |
PHY Test |  | Yes |
CPLD Test |  | Yes |
Memory Test |  | Yes |
Thermal Test |  |  | Yes
Fan Test |  |  | Yes
SFP Test |  |  | Yes
PSU Test |  |  | Yes

### 3.2. Diagnostic results displayed

Diagnostic results can be checked using the show system-diagnostics command.
Though the system is automatically restarted after on-demand diagnostics, diagnostic results can be confirmed after restarting.

### 3.3. Deleting on-demand diagnostics results

On-demand diagnostics results can be deleted using the clear system-diagnostics on-demand command.

## 4. Test Details

Details about each test item are indicated below.

### 4.1. Loading Test

This verifies the loading status of software modules.
A “Pass” result is output if all modules are successfully loaded, whereas a “Fail” result is output if even one module fails to load.

The show system-diagnostics command does not indicate information about modules that failed to load.
To identify which module failed to load, use the show logging command to search the following log.
Note: XXXX part shows the module name.

    [   HAMON]:err: An unexpected error has occurred. (XXXX deamon)

### 4.2. RTC Test

This verifies access to the RTC register.
A time value is obtained from the RTC two times, resulting in “Pass” if the time value changed or “Fail” if the time values are identical.
A “Fail” result also occurs if the test fails to obtain a time value from the RTC (or load the register).

### 4.3. Packet Processor Test

This verifies accessing the packet processor register.
A “Pass” result occurs if the value written in the packet processor register matches the loaded value, whereas a “Fail” result occurs if the values do not match.
A “Fail” result also occurs if the test fails to access the register.

### 4.4. PHY Test

This verifies access to the PHY register.
A “Pass” result occurs if the value written in the PHY register matches the loaded value, whereas a “Fail” result occurs if the values do not match.
A “Fail” result also occurs if the test fails to access the register.

### 4.5. CPLD Test

This verifies accessing the CPLD register.
A “Pass” result occurs if the value written in the CPLD register matches the loaded value, whereas a “Fail” result occurs if the values do not match.
A “Fail” result also occurs if the test fails to access the register.

### 4.6. Memory Test

This verifies accessing the packet processor memory.
Values are written to and read from the various packet processor memory areas, then "Passed" is displayed if the values match or "Failed" is displayed if the values do not match.
A “Fail” result also occurs if the test fails to access the memory.

### 4.7. Thermal Test

Displays the temperature diagnostic results for CPU, MAC, PHY, SFP module, and DDR.
If the temperature exceeds the threshold, a warning will be displayed.

### 4.8. Fan Test

This displays the diagnostic results for the fan speed.
If the fan rotation has stopped or if the rotation speed has increased, a warning is displayed.

### 4.9. SFP Test

This displays the diagnostic results of the SFP module optical input level.
If the optical input level goes out of a certain range, a warning is displayed.

### 4.10. PSU Test

Displays the status diagnosis result for the power supply unit.
A warning will be displayed if a warning or abnormality is detected for the current, voltage, temperature, or fan.

## 5. Related Commands

Related commands are indicated below.
For details on the commands, refer to the Command Reference.

Operations | Operating commands
--- | ---
Display system self-diagnostic results | show system-diagnostics
Execute on-demand diagnostics | system-diagnostics on-demand execute
Discard on-demand diagnostics results | clear system-diagnostics on-demand

## 6. Examples of Command Execution

### 6.1. Display system self-diagnostic results

1. Check the system self-diagnostics results as follows.

       Yamaha#show system-diagnostics
       Test results:
         P = Pass, F = Fail, U = Untested
         N = Normal, W = Warning

       - Bootup
         Loading Test: Pass

         RTC Test: Pass

         Packet Processor Test: Pass

       - On-demand
         Last on-demand diagnostics information:
           Date     : 2025/01/01 09:00:00 +09:00
           BootROM  : Ver.1.00
           Firmware : Rev.4.03.00
           CPLD     : Ver.05/12/12
           PHY      : Ver.10.15.5.0

         PHY Test:
           Port   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16
           --------------------------------------------------------------------
                  P   P   P   P   P   P   P   P   P   P   P   P   P   P   P   P

           Port  17  18  19  20  21  22  23  24
           ------------------------------------
                  P   P   P   P   P   P   P   P

         CPLD Test: Pass

         Memory Test: Pass

       - Health monitoring
         Thermal Test:
           CPU    : Normal
           MAC    : Normal
           PHY1   : Normal
           PHY2   : Normal
           PHY3   : Normal
           SFP28  : Normal
           QSFP28 : Normal
           DDR    : Normal

         Fan Test: Normal

         SFP Test:
           Port  25  26  27  28  29  30
           ----------------------------
                  N   N   N   N   N   N

         PSU Test:
           Slot   1   2
           ------------
                  N   N

### 6.2. Performing on-demand diagnostics

1. Perform on-demand diagnostics as follows.

       Yamaha#system-diagnostics on-demand execute
       The system will be rebooted after diagnostics. Continue ? (y/n) y
       on-demand diagnostics completed (pass). reboot immediately...

### 6.3. Discard on-demand diagnostics results

1. Delete the on-demand diagnostic results as follows.

       Yamaha#clear system-diagnostics on-demand

## 7. Points of Caution

- All ports are automatically shut down and restarted whenever on-demand diagnostics are performed. Therefore, use particular caution before executing on-demand diagnostics while the system is being operated.

- On-demand diagnostics are only executed if the stack status is standalone or disabled. To perform on-demand diagnostics when a stack is configured, first disconnect the connections between member switches.

- If online diagnostics are performed remotely, such as via Telnet or the web console, simplified results cannot be displayed before restarting because all ports are shut down during diagnostics. Use the show system-diagnostics command to check diagnostic results after restarting.

## 8. Related Documentation

None

Search result
No more search results.
There are no topics that match your search query.