- Table of Contents
-
- 12-Network Management and Monitoring Configuration Guide
- 00-Preface
- 01-System maintenance and debugging configuration
- 02-NQA configuration
- 03-iNQA configuration
- 04-NTP configuration
- 05-PTP configuration
- 06-Network synchronization configuration
- 07-SNMP configuration
- 08-RMON configuration
- 09-NETCONF configuration
- 10-Ansible configuration
- 11-SmartMC configuration
- 12-CWMP configuration
- 13-EAA configuration
- 14-Process monitoring and maintenance configuration
- 15-Sampler configuration
- 16-Mirroring configuration
- 17-NetAnalysis configuration
- 18-sFlow configuration
- 19-Information center configuration
- 20-GOLD configuration
- 21-Packet capture configuration
- 22-VCF fabric configuration
- 23-Cloud connection configuration
- 24-eMDI configuration
- 25-SQA configuration
- 26-Performance management configuration
- Related Documents
-
Title | Size | Download |
---|---|---|
20-GOLD configuration | 78.04 KB |
Restrictions and guidelines: GOLD configuration
Configuring monitoring diagnostics
Configuring script-bound diagnostics
Configuring the log buffer size
Display and maintenance commands for GOLD
Example: Configuring GOLD (in standalone mode)
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 multiple types. The device supports only monitoring diagnostics.
Monitoring diagnostics runs diagnostic tests periodically when the system is in operation and records 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.
Restrictions and guidelines: GOLD configuration
GOLD is supported only on the default MDC. The non-default MDCs do not support GOLD.
Only the BoardStatusMonitor test is supported.
GOLD tasks at a glance
To configure GOLD, perform the following tasks:
1. Configuring diagnostics
Choose the following tasks as needed:
¡ Configuring monitoring diagnostics
¡ Configuring script-bound 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 slot slot-number-list [ test test-name ]
In IRF mode:
diagnostic monitor enable chassis chassis-number 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.
In standalone mode:
diagnostic monitor interval slot slot-number-list [ test test-name ] time interval
In IRF mode:
diagnostic monitor interval chassis chassis-number 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 script-bound diagnostics
About this task
The device is configured with tests that are bound with scripts before shipment, such as scripts for verifying chip and port basic information after the device is powered on. The system supports only TCL scripts. 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
Simulating diagnostic tests
About this task
You can simulate monitoring diagnostic tests or on-demand diagnostic tests to verify 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:
In standalone mode:
diagnostic simulation slot slot-number-list test test-name { failure | random-failure | success }
In IRF mode:
diagnostic simulation chassis chassis-number 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 [ slot slot-number ] [ verbose ] In IRF mode: display diagnostic content [ chassis chassis-number [ slot slot-number ] ] [ verbose ] |
Display GOLD logs. |
display diagnostic event-log [ error | info ] |
Display test results. |
In standalone mode: display diagnostic result [ slot slot-number [ test test-name ] ] [ verbose ] In IRF mode: display diagnostic result [ chassis chassis-number [ slot slot-number [ test test-name ] ] ] [ verbose ] |
Display statistics for packet-related tests. |
In standalone mode: display diagnostic result [ slot slot-number [ test test-name ] ] statistics In IRF mode: display diagnostic result [ chassis chassis-number [ slot slot-number [ test test-name ] ] ] statistics |
Display configurations for simulated tests. |
In standalone mode: display diagnostic simulation [ slot slot-number ] In IRF mode: display diagnostic simulation [ chassis chassis-number [ slot slot-number ] ] |
Clear GOLD logs. |
reset diagnostic event-log |
Clear test results. |
In standalone mode: reset diagnostic result [ slot slot-number [ test test-name ] ] In IRF mode: reset diagnostic result [ chassis chassis-number [ slot slot-number [ test test-name ] ] ] |
GOLD configuration examples
Support for the diagnostic tests depends on the device model. The diagnostic test named MonitorTest used in the following examples is for illustration only.
Example: Configuring GOLD (in standalone mode)
Network configuration
Enable monitoring diagnostic test MonitorTest on slot 1, and set its execution interval to 1 minute. (Support for diagnostic tests varies by device model. MonitorTest is used in this configuration example.)
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 : MonitorTest
Test attributes : **M*PI
Test interval : 00:00:10
Min interval : 00:00:10
Correct-action : -NA-
Description : A Real-time test, disabled by default that checks link status between ports.
Exec : -NA-
# Enable test MonitorTest on slot 1.
<Sysname> system-view
[Sysname] diagnostic monitor enable slot 1 test MonitorTest
# Set the execution interval to 1 minute.
[Sysname] diagnostic monitor interval slot 1 test MonitorTest 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 : MonitorTest
Test attributes : **M*PA
Test interval : 00:01:00
Min interval : 00:00:10
Correct-action : -NA-
Description : A Real-time test, disabled by default that checks link status between ports.
Exec : -NA-
# View the test result about test MonitorTest.
[Sysname] display diagnostic result slot 1 test monitortest verbose
Slot 1:
Test name : MonitorTest
Total run count : 1247
Total failure count : 0
Consecutive failure count: 0
Last execution time : Mon Feb 25 18:09:21 2019
First failure time : -NA-
Last failure time : -NA-
Last pass time : Mon Feb 25 18:09:21 2019
Last execution result : Success
Last failure reason : -NA-
Next execution time : Mon Feb 25 18:10:21 2019
Port link status : Normal