Contents

Configuring GOLD·· 1

About GOLD·· 1

Types of GOLD diagnostics· 1

GOLD diagnostic tests· 1

GOLD tasks at a glance· 1

Configuring monitoring diagnostics· 1

Configuring the log buffer size· 2

Display and maintenance commands for GOLD·· 2

GOLD configuration examples· 3

Example: Configuring GOLD·· 3

 

Configuring GOLD

About GOLD

Generic Online Diagnostics (GOLD) performs the following operations:

·     Runs diagnostic tests on a device to inspect device ports, RAM, chip, connectivity, forwarding paths, and control paths for hardware faults.

·     Reports the problems to the system.

Types of GOLD diagnostics

Among the GOLD diagnostics, the device supports only monitoring diagnostics.

·     Monitoring diagnostics—Run diagnostic tests periodically when the system is in operation and record test results. Monitoring diagnostics execute only non-disruptive tests.

GOLD diagnostic tests

Each kind of diagnostics runs its diagnostic tests. The parameters of a diagnostic test include test name, type, description, attribute (disruptive or non-disruptive), default status, and execution interval.

Support for the diagnostic tests and default values for a test's parameters depend on the device model. You can modify part of the parameters by using the commands provided by this document.

The diagnostic tests are released with the system software image of the device. All enabled diagnostic tests run in the background. You can use the display commands to view test results and logs to verify hardware faults.

GOLD tasks at a glance

To configure GOLD, perform the following tasks:

1.     Configuring diagnostics

¡     Configuring monitoring diagnostics

2.     (Optional.) Configuring the log buffer size

Configuring monitoring diagnostics

About this task

The system automatically executes monitoring diagnostic tests that are enabled by default after the device starts. Use the diagnostic monitor enable command to enable monitoring diagnostic tests that are disabled by default.

Procedure

1.     Enter system view.

system-view

2.     Enable monitoring diagnostics.

diagnostic monitor enable slot slot-number-list [ test test-name ]

By default, the monitoring diagnostic tests vary in enabling status. To view the enabling status of a monitoring diagnostic test, execute the display diagnostic content command.

3.     Set an execution interval for monitoring diagnostic tests.

diagnostic monitor interval slot slot-number-list [ test test-name ] time interval

By default, the execution interval varies by monitoring diagnostic test. To display the execution interval of a monitoring diagnostic test, execute the display diagnostic content command.

The configured interval cannot be smaller than the minimum execution interval of the tests. Use the display diagnostic content verbose command to view the minimum execution interval of the tests.

Configuring the log buffer size

About this task

GOLD saves test results in the form of logs. You can use the display diagnostic event-log command to view the logs.

Procedure

1.     Enter system view.

system-view

2.     Configure the maximum number of GOLD logs that can be saved.

diagnostic event-log size number

By default, GOLD saves 512 log entries at most.

When the number of logs exceeds the configured log buffer size, the system deletes the oldest entries.

Display and maintenance commands for GOLD

Execute display commands in any view and reset commands in user view.

 

Task	Command
Display test content.	display diagnostic content [ slot slot-number ] [ verbose ]
Display GOLD logs.	display diagnostic event-log [ error | info ]
Display test results.	display diagnostic result [ slot slot-number [ test test-name ] ] [ verbose ]
Clear GOLD logs.	reset diagnostic event-log
Clear test results.	reset diagnostic result [ slot slot-number [ test test-name ] ]

‌

GOLD configuration examples

Support for the diagnostic tests depends on the device model. Monitoring diagnostic test MonitorTest in the following configuration examples is for illustration only.

Example: Configuring GOLD

Network configuration

Enable monitoring diagnostic test Enable monitoring diagnostic test CpuVoqMonitor on slot 0, and set its execution interval to 1 minute.

Procedure

# View the default status and execution interval of the test on slot 0.

<Sysname> display diagnostic content slot 0 verbose

Diagnostic test suite attributes:

#B/*: Bootup test/NA

#O/*: Ondemand test/NA

#M/*: Monitoring test/NA

#D/*: Disruptive test/Non-disruptive test

#P/*: Per port test/NA

#A/I/*: Monitoring test is active/Monitoring test is inactive/NA

 

Slot 0 :

Test name        : CpuVoqMonitor                                               

Test attributes  : **M*PA                                                      

Test interval    : 01:00:00                                                    

Min interval     : 00:00:01                                                    

Correct-action   : -NA-                                                        

Description      : A Real-time test, enabled by default that checks cpu voq stat

us.                                                                            

Exec             : -NA-

# Enable test CpuVoqMonitor on slot 0.

<Sysname> system-view

[Sysname] diagnostic monitor enable slot 0 test CpuVoqMonitor

# Set the execution interval to 1 minute on slot 0.

[Sysname] diagnostic monitor interval slot 0 test CpuVoqMonitor time 0:1:0

Verifying the configuration

# View the test configuration.

[Sysname] display diagnostic content slot 0  verbose

Diagnostic test suite attributes:

#B/*: Bootup test/NA

#O/*: Ondemand test/NA

#M/*: Monitoring test/NA

#D/*: Disruptive test/Non-disruptive test

#P/*: Per port test/NA

#A/I/*: Monitoring test is active/Monitoring test is inactive/NA

 

Slot 0:

Test name        : CpuVoqMonitor                                               

Test attributes  : **M*PA                                                      

Test interval    : 00:01:00                                                    

Min interval     : 00:00:01                                                    

Correct-action   : -NA-                                                        

Description      : A Real-time test, enabled by default that checks cpu voq stat

us.                                                                             

Exec             : -NA-

# View the test result on slot 0.

[Sysname] display diagnostic result slot 0 verbose

Slot 0:

  Test name                : CpuVoqMonitor                                     

  Total run count          : 5                                                 

  Total failure count      : 0                                                 

  Consecutive failure count: 0                                                 

  Last execution time      : Thu Feb 16 17:00:50 2023                          

  First failure time       : -NA-                                              

  Last failure time        : -NA-                                              

  Last pass time           : Thu Feb 16 17:00:50 2023                          

  Last execution result    : Success                                           

  Last failure reason      : -NA-                                               

  Next execution time      : Thu Feb 16 17:01:50 2023