- Table of Contents
-
- 17-Network Management and Monitoring Configuration Guide
- 00-Preface
- 01-Information center configuration
- 02-Flow log configuration
- 03-Fast log output configuration
- 04-NetStream configuration
- 05-Sampler configuration
- 06-Cloud connection configuration
- 07-Mirroring configuration
- 08-Packet capture configuration
- 09-NQA configuration
- 10-Track configuration
- 11-BFD configuration
- 12-Monitor Link configuration
- 13-Smart Link configuration
- 14-Interface backup configuration
- 15-Interface collaboration configuration
- 16-System maintenance and debugging configuration
- 17-NTP configuration
- 18-EAA configuration
- 19-Process monitoring and maintenance configuration
- 20-NETCONF configuration
- 21-CWMP configuration
- 22-SNMP configuration
- 23-RMON configuration
- 24-Event MIB configuration
- 25-Process placement configuration
- 26-GOLD configuration
- 27-gRPC configuration
- 28-iNQA configuration
- 29-SmartMC configuration (self-mesh supported)
- Related Documents
-
Title | Size | Download |
---|---|---|
26-GOLD configuration | 92.05 KB |
Configuring boot-up diagnostics
Configuring monitoring diagnostics
Configuring on-demand diagnostics
Configuring script-bound diagnostics
Configuring the log buffer size
Display and maintenance commands for GOLD
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
GOLD diagnostics are divided into the following types:
· Boot-up diagnostics—Test device cards during boot-up or when the cards are inserted or removed.
· Monitoring diagnostics—Run diagnostic tests periodically when the system is in operation and record test results. Monitoring diagnostics execute only non-disruptive tests.
· On-demand diagnostics—Enable you to manually start or stop diagnostic tests during system operation.
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
Choose the following tasks as needed:
¡ Configuring boot-up diagnostics
¡ Configuring monitoring diagnostics
¡ Configuring on-demand diagnostics
¡ Configuring script-bound diagnostics
2. (Optional.) Simulating diagnostic tests
3. (Optional.) Configuring the log buffer size
Configuring boot-up diagnostics
Choose one option as needed:
· Enter user view and enable the system to run a boot-up diagnostic test.
diagnostic bootup enable slot slot-number-list test test-name [ para parameters ]
· Enable the device to run all boot-up diagnostic tests.
a. system-view
b. diagnostic bootup level complete
· Disable boot-up diagnostics.
a. system-view
b. diagnostic bootup level bypass
By default, the system does not run boot-up diagnostic tests during startup.
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 ]
The default settings for this command depend on the device model.
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.
4. Set the recovery action for monitoring diagnostic tests.
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-.
Configuring on-demand diagnostics
About this task
You can stop an on-demand diagnostic test by using any of the following commands:
· Use the diagnostic ondemand stop command to immediately stop the test.
· Use the diagnostic ondemand repeating command to configure the number of executions for the test.
· Use the diagnostic ondemand failure command to configure the maximum number of failed tests before the system stops the test.
Restrictions and guidelines
The diagnostic ondemand commands are effective only during the current system operation. These commands are restored to the default after you restart the device.
Procedure
To configure on-demand diagnostics, perform the following steps in user view:
1. Configure the number of executions.
diagnostic ondemand repeating repeating-number
The default value for the repeating-number argument is 1.
This command applies only to diagnostic tests to be enabled.
2. Configure the number of failed tests.
diagnostic ondemand failure failure-number
By default, the maximum number of failed tests is not specified.
Configure a number no larger than the configured repeating-number argument.
This command applies only to diagnostic tests to be enabled.
3. Enable on-demand diagnostics.
diagnostic ondemand start slot slot-number-list test { test-name | non-disruptive } [ para parameters ]
The system runs the tests according to the default configuration if you do not perform the first two configurations.
4. (Optional.) Stop on-demand diagnostics.
diagnostic ondemand stop slot slot-number-list test { test-name | non-disruptive }
You can manually stop all on-demand diagnostic tests.
Configuring script-bound diagnostics
About this task
The device is configured with tests that are bound with scripts before the device is shipped. The system supports TCL and shell scripts, such as scripts for verifying chip and port basic information after the device is powered on. After you use this command to start a test, the system automatically runs the scripts and displays the results at the CLI.
Procedure
To start script-bound diagnostics, execute the following command in user view:
diagnostic start test test-name [ parameters ]
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 and on-demand diagnostics support test simulation.
Procedure
To simulate a test, execute the following command in user view:
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 boot-up diagnostic test information. |
display diagnostic bootup [ slot slot-number ] [ test test-name ] |
Display the level of boot-up diagnostics that are executed during the most recent boot-up. |
display diagnostic bootup level |
Display test content. |
display diagnostic content [ slot slot-number ] [ verbose ] |
Display GOLD logs. |
display diagnostic event-log [ error | info ] |
Display configurations of on-demand diagnostics. |
display diagnostic ondemand configuration |
Display test results. |
display diagnostic result [ slot slot-number [ test test-name ] ] [ verbose ] |
Display statistics for packet-related tests. |
display diagnostic result [ slot slot-number [ test test-name ] ] statistics |
Display configurations for simulated tests. |
display diagnostic simulation [ slot slot-number ] |
Clear GOLD logs. |
reset diagnostic event-log |
Clear test results. |
reset diagnostic result [ slot slot-number [ test test-name ] ] |