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

Simulating diagnostic tests· 2

Configuring the log buffer size· 3

Display and maintenance commands for GOLD·· 3

GOLD configuration examples· 4

Example: Configuring GOLD (in standalone mode) 4

Example: Configuring GOLD (in IRF mode) 6

 

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

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 monitoring diagnostics

2.     (Optional.) Simulating diagnostic tests

3.     (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.

In standalone mode:

diagnostic monitor enable [ test test-name ]

In IRF mode:

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

By default, monitoring diagnostics are enabled.

3.     Set an execution interval for monitoring diagnostic tests.

In standalone mode:

diagnostic monitor interval [ test test-name ] time interval

In IRF mode:

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.

4.     Set the recovery action for monitoring diagnostic tests.

In standalone mode:

diagnostic monitor action [ test test-name ] mode { none | self-reboot | service-restart | switchover | system-reboot }

In IRF mode:

diagnostic monitor action slot slot-number-list [ test test-name ] mode { none | self-reboot | service-restart | switchover | system-reboot }

By default, the settings for this command vary by test. Use the display diagnostic content verbose command to view the recovery action for a test. If a test does not support any recovery action, its recovery action is displayed as -NA-.

Simulating diagnostic tests

About this task

Test simulation verifies GOLD frame functionality. When you use the diagnostic simulation commands to simulate a diagnostic test, only part of the test code is executed to generate a test result. Test simulation does not trigger hardware correcting actions such as device restart and active/standby switchover.

Restrictions and guidelines

Only monitoring diagnostics support test simulation.

Procedure

To simulate a test, execute the following command in user view:

In standalone mode:

diagnostic simulation test test-name { failure | random-failure | success }

In IRF mode:

diagnostic simulation slot slot-number-list test test-name { failure | random-failure | success }

By default, the system runs a test instead of simulating it.

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.	In standalone mode: display diagnostic content [ verbose ] In IRF mode: display diagnostic content [ slot slot-number ] [ verbose ]
Display GOLD logs.	display diagnostic event-log [ error | info ]
Display test results.	In standalone mode: display diagnostic result [ test test-name ] [ verbose ] In IRF mode: display diagnostic result [ slot slot-number [ test test-name ] ] [ verbose ]
Display configurations for simulated tests.	In standalone mode: display diagnostic simulation In IRF mode: display diagnostic simulation [ slot slot-number ]
Clear GOLD logs.	reset diagnostic event-log
Clear test results.	In standalone mode: reset diagnostic result [ test test-name ] In IRF mode: reset diagnostic result [ slot slot-number [ test test-name ] ]

‌

GOLD configuration examples

Example: Configuring GOLD (in standalone mode)

Network configuration

Enable monitoring diagnostic test LIPCMonitor, and set its execution interval to 1 minute.

Procedure

# View the default status and execution interval of the test.

<Sysname> display diagnostic content 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

 

Test name        : DBMMonitor

Test attributes  : **M**A

Test interval    : -NA-

Min interval     : -NA-

Correct-action   : self-reboot

Description      : This is a global monitor test.

Exec             : -NA-

 

Test name        : LIPCMonitor

Test attributes  : **M**A

Test interval    : 00:02:10

Min interval     : 00:01:00

Correct-action   : -NA-

Description      : This is a real-time test.

Exec             : -NA-

# (Optional.) Enable test LIPCMonitor.

<Sysname> system-view

[Sysname] diagnostic monitor enable test LIPCMonitor

# Set the execution interval to 1 minute.

[Sysname] diagnostic monitor interval test LIPCMonitor time 0:1:0

Verifying the configuration

# View the test configuration.

[Sysname] display diagnostic content 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

 

Test name        : DBMMonitor

Test attributes  : **M**A

Test interval    : -NA-

Min interval     : -NA-

Correct-action   : self-reboot

Description      : This is a global monitor test.

Exec             : -NA-

 

Test name        : LIPCMonitor

Test attributes  : **M**A

Test interval    : 00:01:00

Min interval     : 00:01:00

Correct-action   : -NA-

Description      : This is a real-time test.

Exec             : -NA-

# View the test result.

[Sysname] display diagnostic result verbose

Test name                : DBMMonitor

  Total run count          : 0

  Total failure count      : 0

  Consecutive failure count: 0

  Last execution time      : -NA-

  First failure time       : -NA-

  Last failure time        : -NA-

  Last pass time           : -NA-

  Last execution result    : -NA-

  Last failure reason      : -NA-

  Next execution time      : -NA-

 

  Test name                : LIPCMonitor

  Total run count          : 6

  Total failure count      : 0

  Consecutive failure count: 0

  Last execution time      : Mon Sep 13 19:05:12 2021

  First failure time       : -NA-

  Last failure time        : -NA-

  Last pass time           : Mon Sep 13 19:05:12 2021

  Last execution result    : Success

  Last failure reason      : -NA-

  Next execution time      : Mon Sep 13 19:07:48 2021

Example: Configuring GOLD (in IRF mode)

Network configuration

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

Procedure

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

<Sysname> display diagnostic content slot 1 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 1:

Test name        : DBMMonitor

Test attributes  : **M**A

Test interval    : -NA-

Min interval     : -NA-

Correct-action   : self-reboot

Description      : This is a global monitor test.

Exec             : -NA-

 

Test name        : LIPCMonitor

Test attributes  : **M**A

Test interval    : 00:02:10

Min interval     : 00:01:00

Correct-action   : -NA-

Description      : This is a real-time test.

Exec             : -NA-

# (Optional.) Enable test LIPCMonitor on slot 1.

<Sysname> system-view

[Sysname] diagnostic monitor enable slot 1 test LIPCMonitor

# Set the execution interval to 1 minute.

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

Verifying the configuration

# View the test configuration.

[Sysname] display diagnostic content slot 1 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 1:

Test name        : DBMMonitor

Test attributes  : **M**A

Test interval    : -NA-

Min interval     : -NA-

Correct-action   : self-reboot

Description      : This is a global monitor test.

Exec             : -NA-

 

Test name        : LIPCMonitor

Test attributes  : **M**A

Test interval    : 00:01:00

Min interval     : 00:01:00

Correct-action   : -NA-

Description      : This is a real-time test.

Exec             : -NA-

# View the test result.

[Sysname] display diagnostic result slot 1 verbose

slot 1:

Test name                : DBMMonitor

  Total run count          : 0

  Total failure count      : 0

  Consecutive failure count: 0

  Last execution time      : -NA-

  First failure time       : -NA-

  Last failure time        : -NA-

  Last pass time           : -NA-

  Last execution result    : -NA-

  Last failure reason      : -NA-

  Next execution time      : -NA-

 

  Test name                : LIPCMonitor

  Total run count          : 6

  Total failure count      : 0

  Consecutive failure count: 0

  Last execution time      : Mon Sep 13 19:05:12 2021

  First failure time       : -NA-

  Last failure time        : -NA-

  Last pass time           : Mon Sep 13 19:05:12 2021

  Last execution result    : Success

  Last failure reason      : -NA-

  Next execution time      : Mon Sep 13 19:07:48 2021