Login
- Table of Contents
- Related Documents
-
| Title | Size | Download |
|---|---|---|
| 01-GOLD commands | 143.54 KB |
GOLD commands
Support for diagnostic tests dependes on the device model. The diagnostic test names used in the following command examples are for illustration only. To get the names of diagnostic tests supported by the device, enter ? at the test name position in a GOLD command.
diagnostic event-log size
Use diagnostic event-log size to configure the maximum number of GOLD log entries.
Use undo diagnostic event-log size to restore the default.
Syntax
diagnostic event-log size number
undo diagnostic event-log size
Default
GOLD can save up to 512 log entries.
Views
System view
Predefined user roles
network-admin
Parameters
number: Specifies the maximum number of log entries, in the range of 0 to 1024.
Usage guidelines
If you specify a number smaller than the number of existing log entries, the system automatically deletes the oldest excess entries.
When the number of GOLD log entries exceeds the configured log buffer size, the system automatically deletes the oldest excess entries.
Examples
# Set the maximum number of log entries to 600.
<Sysname> system-view
[Sysname] diagnostic event-log size 600
diagnostic monitor action
Use diagnostic monitor action to configure the recovery action to take upon detection of an error for monitoring diagnostic tests.
Use undo diagnostic monitor action to restore the default.
Syntax
diagnostic monitor action slot slot-number-list [ test test-name ] mode { none | self-reboot | service-restart | switchover | system-reboot }
undo diagnostic monitor action slot slot-number-list [ test test-name ]
Default
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-.
Views
System view
Predefined user roles
network-admin
Parameters
test test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name. If you do not specify this option, the command specifies all monitoring diagnostic tests.
none: Does not take any action.
self-reboot: Reboots faulty devices or cards.
service-restart: Restarts faulty services.
switchover: Performs an IRF master/subordinate switchover or an active/standby MPU switchover.
system-reboot: Reboots the device where an error is detected.
slot slot-number-list: Specifies a space-separated list of up to seven slot number items. An item specifies a card by its slot number or specifies a range of cards in the form of start-slot-number to end-slot-number. The end slot number must be equal to or greater than the start slot number.
Examples
# Set the recovery action to self-reboot for test DBMMonitor on slot 1.
<Sysname> system-view
[Sysname] diagnostic monitor action slot 1 test DBMMonitor mode self-reboot
diagnostic monitor enable
Use diagnostic monitor enable to enable monitoring diagnostics.
Use undo diagnostic monitor enable to disable monitoring diagnostics.
Syntax
diagnostic monitor enable slot slot-number-list [ test test-name ]
undo diagnostic monitor enable slot slot-number-list [ test test-name ]
Default
Monitoring diagnostics is enabled.
Views
System view
Predefined user roles
network-admin
Parameters
slot slot-number-list: Specifies a space-separated list of up to seven slot number items. An item specifies a card by its slot number or specifies a range of cards in the form of start-slot-number to end-slot-number. The end slot number must be equal to or greater than the start slot number.
test test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name. If you do not specify this option, the command enables all monitoring diagnostic tests.
Usage guidelines
Monitoring diagnostics enable the system to periodically run diagnostic tests to detect hardware faults and record test results. Monitoring diagnostics execute only non-disruptive tests.
Disruptive diagnostic tests that are being executed affect device operation or even disable certain functions, but non-disruptive diagnostic tests do not.
The system automatically executes enabled monitoring diagnostic tests after the device starts. Use the diagnostic monitor enable command to enable diagnostic tests that are disabled by default.
Examples
# Enable test BoardStatusMonitor on the specified slot.
<Sysname> system-view
[Sysname] diagnostic monitor enable slot 1 test BoardStatusMonitor
diagnostic ondemand failure
Use diagnostic ondemand failure to set the maximum number of failed on-demand diagnostic tests.
Use undo diagnostic ondemand failure to restore the default.
Syntax
diagnostic ondemand failure failure-number
undo diagnostic ondemand failure
Default
The maximum number of failed on-demand diagnostic tests is not specified.
Views
User view
Predefined user roles
network-admin
Parameters
failure-number: Specifies the maximum number of failed tests, in the range of 1 to 999.
Usage guidelines
After you use the diagnostic ondemand start command to enable on-demand diagnostics, you can stop the diagnostic tests by using any of the following commands:
· Use the diagnostic ondemand stop command to immediately stop the tests.
· Use the diagnostic ondemand repeating command to configure the number of executions for the tests. The system stops executing the tests when the threshold is reached.
· Use the diagnostic ondemand failure command to configure the maximum number of failed tests. The system stops a test when the number of failures reaches the configured threshold and the test is not executed as many times as specified.
Use this command to configure the maximum number of failed tests for diagnostic tests to be enabled. This command does not survive a device reboot.
Examples
# Set the maximum number of failed tests to 5 for all on-demand diagnostic tests.
<Sysname> diagnostic ondemand failure 5
Related commands
diagnostic ondemand repeating
diagnostic ondemand start
display diagnostic ondemand configuration
diagnostic ondemand repeating
Use diagnostic ondemand repeating to configure the number of executions for on-demand diagnostic tests.
Use undo diagnostic ondemand repeating to restore the default.
Syntax
diagnostic ondemand repeating repeating-number
undo diagnostic ondemand repeating
Default
The default number of executions is 1.
Views
User view
Predefined user roles
network-admin
Parameters
repeating-number: Specifies the number of executions for on-demand diagnostic tests, in the range of 1 to 999.
Usage guidelines
Use this command to configure the number of executions for diagnostic tests to be enabled. This command does not survive a device reboot.
Do not specify a number smaller than the number of failed tests configured by using the diagnostic ondemand failure command.
Examples
# Set the number of executions to 2 for all on-demand diagnostic tests.
<Sysname> diagnostic ondemand repeating 2
Related commands
diagnostic ondemand failure
diagnostic ondemand start
display diagnostic configuration
diagnostic ondemand start
Use diagnostic ondemand start to enable on-demand diagnostics.
Syntax
diagnostic ondemand start slot slot-number-list test { test-name | non-disruptive } [ para parameters ]
Default
All on-demand diagnostic tests need to be manually enabled.
Views
User view
Predefined user roles
network-admin
Parameters
slot slot-number-list: Specifies a space-separated list of up to seven slot number items. An item specifies a card by its slot number or specifies a range of cards in the form of start-slot-number to end-slot-number. The end slot number must be equal to or greater than the start slot number.
non-disruptive: Executes all non-disruptive diagnostic tests.
test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name.
para parameters: Specifies an extended parameter. The current software version does not support this option.
Usage guidelines
On-demand diagnostics allow you to manually execute certain diagnostic tests. These tests are known as on-demand diagnostic tests.
You can configure the number of executions and the maximum number of failed tests for on-demand diagnostic tests at the CLI. When either threshold is reached, the system immediately stops executing the tests.
Examples
# Start disruptive diagnostic test PRBS on the specified slot.
<Sysname> diagnostic ondemand start slot 1 test PRBS
Running test PRBS on slot 1 may disrupt system operation. Continue? [Y/N]:y
# Start all non-disruptive diagnostic tests on the specified slot.
<Sysname> diagnostic ondemand start slot 1 test non-disruptive
Related commands
diagnostic ondemand failure
diagnostic ondemand repeating
diagnostic ondemand stop
Use diagnostic ondemand stop to stop on-demand diagnostic tests.
Syntax
diagnostic ondemand stop slot slot-number-list test { test-name | non-disruptive }
Views
User view
Predefined user roles
network-admin
Parameters
slot slot-number-list: Specifies a space-separated list of up to seven slot number items. An item specifies a card by its slot number or specifies a range of cards in the form of start-slot-number to end-slot-number. The end slot number must be equal to or greater than the start slot number.
non-disruptive: Stops all non-disruptive diagnostic tests.
test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name.
Usage guidelines
You can configure the number of executions and the maximum number of failed tests for on-demand diagnostic tests at the CLI. When either threshold is reached, the system immediately stops executing the tests. You can also use this command to manually stop on-demand diagnostic tests.
Examples
# Stop all non-disruptive diagnostic tests on the specified slot.
<Sysname> diagnostic ondemand stop slot 1 test non-disruptive
Related commands
diagnostic ondemand failure
diagnostic ondemand repeating
diagnostic simulation
Use diagnostic simulation to simulate diagnostic tests.
Use undo diagnostic simulation to restore the default.
Syntax
diagnostic simulation slot slot-number-list test test-name { failure | random-failure | success }
undo diagnostic simulation slot slot-number-list test test-name
Default
All diagnostic tests are executed instead of simulated.
Views
User view
Predefined user roles
network-admin
Parameters
slot slot-number-list: Specifies a space-separated list of up to seven slot number items. An item specifies a card by its slot number or specifies a range of cards in the form of start-slot-number to end-slot-number. The end slot number must be equal to or greater than the start slot number.
test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name.
failure: Configures the system to generate failure results.
random-failure: Configures the system to randomly generate results.
success: Configures the system to generate success results.
Usage guidelines
Test simulation is used to verify GOLD frame functionality. After you execute this command, the system simulates the specified test if the execution requirements for the test are met. The test is not actually executed and does not trigger hardware correcting actions.
Examples
# Simulate test BoardStatusMonitor as failed on the specified slot.
<Sysname> diagnostic simulation slot 1 test BoardStatusMonitor failure
Related commands
display diagnostic simulation
diagnostic start test
Use diagnostic start test to start script-bound diagnostics.
Syntax
diagnostic start test test-name
Views
User view
Predefined user roles
network-admin
Parameters
test-name: Specifies a script-bound test by its name, a case-insensitive string of 1 to 31 characters. You can use the diagnostic start test ? command to verify available test names.
Usage guidelines
The device is configured with tests that are bound with scripts before the device is shipped. The system supports TCL 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.
Examples
# Start script-bound test EquipSelfCheck.
<Sysname> diagnostic start test EquipSelfCheck
This command requires null configuration and reboot device afterwards. Continue?
[Y/N]:y
=================================================
===============display clock===================
10:55:19 UTC Fri 06/27/2019
===============system-view=====================
System View: return to User View with Ctrl+Z.
===============undo stp enable=====================
===============probe-view=====================
===========undo monitor inner-channel=================
display diagnostic content
Use display diagnostic content to display information about diagnostic tests.
Syntax
display diagnostic content [ slot slot-number ] [ verbose ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command applies to all cards.
verbose: Displays detailed information about diagnostic tests. If you do not specify this keyword, the command displays brief information about the diagnostic tests.
Examples
# Display brief information about all diagnostic tests on the specified slot.
<Sysname> display diagnostic content slot 1
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
#T/*: Troubleshooting test/NA
Slot 1:
Name Attributes Interval
IPCMonitor **M*PA* 00:01:00
BoardStatusMonitor **M*PA* 01:00:00
TaskMonitor **M*PA* 00:00:10
PortMonitor **M*PA* 00:00:10
ComponentMonitor **M*PA* 00:00:30
# Display detailed information about all diagnostic tests on the specified slot.
<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
#T/*: Troubleshooting test/NA
Slot 1:
Test name : IPCMonitor
Test item : -NA-
Test attributes : **M*PA*
Test interval : 00:01:00
Min interval : 00:01:00
Correct-action : -NA-
Description : A Real-time test, enabled by default that checks ipc between
switch units.
Exec : -NA-
Test name : BoardStatusMonitor
Test item : -NA-
Test attributes : **M*PA*
Test interval : 01:00:00
Min interval : 00:00:06
Correct-action : -NA-
Description : A Real-time test, enabled by default that checks board status
between local master and other local boards.
Exec : -NA-
Test name : TaskMonitor
Test item : -NA-
Test attributes : **M*PA*
Test interval : 00:00:10
Min interval : 00:00:10
Correct-action : -NA-
Description : A Real-time test, enabled by default that checks the important
tasks.
Exec : -NA-
Test name : PortMonitor
Test attributes : **M*PA*
Test interval : 00:00:10
Min interval : 00:00:10
Correct-action : -NA-
Description : A Real-time test, enabled by default that checks port status
for each inner port.
Exec : -NA-
Test name : ComponentMonitor
Test item : -NA-
Test attributes : **M*PA*
Test interval : 00:00:30
Min interval : 00:00:10
Correct-action : -NA-
Description : A Real-time test, enabled by default that checks component status.
Exec : -NA-
Table 1 Command output
|
Field |
Description |
|
B/* |
This field is not supported in the current software version. Boot-up/Not boot-up. |
|
O/* |
On-demand/Not on-demand. |
|
M/* |
Monitoring/Not monitoring. |
|
D/* |
This field is not supported in the current software version. Disruptive/Non-disruptive. |
|
P/* |
Port-related/Not port-related. |
|
A/I/* |
Active and monitoring/Inactive and monitoring/Not monitoring. |
|
T/* |
Diagnostic troubleshooting/Not diagnostic troubleshooting. For more information about diagnostic troubleshooting, see Intelligent Operations Configuration Guide. |
|
Name |
Name of the diagnostic test. |
|
Attributes |
Attributes of the diagnostic test. The characters from left to right indicate whether or not the test is boot-up, on-demand, monitoring, disruptive, port-related, or active. The asterisks (*) indicate that the test does not have the corresponding attributes. |
|
Interval |
Execution interval for the test. If the execution interval for the test is not set, –NA–is displayed. |
|
Test name |
Name of the diagnostic test. |
|
Test item |
Name of the test item. Only diagnostic troubleshooting tests support this field. This field displays for other types of diagnostic tests. For more information about diagnostic troubleshooting, see Intelligent Operations Configuration Guide. |
|
Test attributes |
Attributes of the diagnostic test. The characters from left to right indicate whether or not the test is boot-up, on-demand, monitoring, disruptive, port-related, or active. The asterisks (*) indicate that the test does not have the corresponding attributes. |
|
Test interval |
Execution interval for the test. If the execution interval for the test is not set, –NA–is displayed. |
|
Min interval |
Minimum execution interval for the test. If the test does not have a minimum execution interval, –NA–is displayed. |
|
Correct-action |
Correcting action triggered by failure of the test. |
|
Description |
Description for the test. |
|
Exec |
Path of the executed scripts. If the test does not run scripts, –NA–is displayed. |
display diagnostic event-log
Use display diagnostic event-log to display GOLD log entries.
Syntax
display diagnostic event-log [ error | info ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
error: Displays all error log entries.
info: Displays all log entries except error log entries.
Usage guidelines
If you do not specify the error and info keywords, the command displays all GOLD log entries.
The system records information about test execution in the form of logs. A log entry contains test name, execution time, test result, and failure cause. Log entries are generated for every execution. To reduce the burden of the information center, GOLD logs are not sent to the information center.
GOLD logs are cleared when the device restarts or when an active/standby MPU switchover occurs.
Examples
# Display all GOLD log entries.
<Sysname> display diagnostic event-log
Event: E_INFO, Wed Jan 7 11:39:53:314 2019, -Slot=1 TestName->IPCMonitor, Event_INFO: Result->Success.
display diagnostic ondemand configuration
Use display diagnostic ondemand configuration to display configurations of on-demand diagnostic tests.
Syntax
display diagnostic ondemand configuration
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display the number of executions and the number of failed tests configured for on-demand diagnostic tests.
<Sysname> display diagnostic ondemand configuration
Maximum test-repeating times: 4
Maximum test-failure times: 1
Related commands
diagnostic ondemand failure
diagnostic ondemand repeating
display diagnostic result
Use display diagnostic result to display test results.
Syntax
display diagnostic result [ slot slot-number [ test test-name ] ] [ verbose ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command applies to all cards.
test test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name. If you do not specify this option, the command applies to all diagnostic tests.
verbose: Displays detailed test results for diagnostic tests that are enabled or executed. (Statistics are not included.) If you do not specify this parameter, the command displays brief test results for the diagnostic tests.
Examples
# Display brief test results for all diagnostic tests on the specified slot.
<Sysname> display diagnostic result slot 1
Slot 1:
Test name Test item Run count Failure count Last result
IPCMonitor -NA- 51 0 Success
# Display detailed test results for all diagnostic tests.
<Sysname> display diagnostic result verbose
Slot 1:
Test name : IPCMonitor
Test item : -NA-
Total run count : 52
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:25 2019
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:25 2019
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:14:25 2019
ipc link status : Normal
Test name : BoardStatusMonitor
Test item : -NA-
Total run count : 386
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:00:01 2019
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:00:01 2019
Last execution result : Success
Last failure reason : -NA-
Next execution time : Sat Nov 22 00:00:07 2019
Slot check status : Normal
Test name : TaskMonitor
Test item : -NA-
Total run count : 313
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:35 2019
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:35 2019
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:13:45 2019
Task check status : Normal
Test name : PortMonitor
Test item : -NA-
Total run count : 313
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:35 2019
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:35 2019
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:13:45 2019
test result: pass
Test name : ComponentMonitor
Test item : -NA-
Total run count : 104
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:25 2019
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:25 2019
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:13:55 2019
test result: pass
Table 2 Command output
|
Field |
Description |
|
Test Name |
Name of the test. |
|
Test item |
Name of the test item. Only diagnostic troubleshooting tests support this field. This field displays for other types of diagnostic tests. For more information about diagnostic troubleshooting, see Intelligent Operations Configuration Guide. |
|
Run count |
Total number of executions. |
|
Failure count |
Total number of failed tests. |
|
Last result |
Most recent test result. |
|
Test name |
Name of the test. |
|
Total run count |
Total number of executions. |
|
Total failure count |
Total number of failed tests. |
|
Consecutive failure count |
Number of consecutive failed tests. |
|
Last execution time |
Most recent execution time. |
|
First failure time |
First failed test time. If no failure occurs, –NA– is displayed. |
|
Last failure time |
Most recent failed test time. If no failure occurs, –NA– is displayed. |
|
Last pass time |
Most recent success test time. If no success occurs, –NA– is displayed. |
|
Last execution result |
Most recent test result. |
|
Last failure reason |
Cause for the most recent failed test. If the failed test is simulated, Simulated Test is displayed. If no failure occurs, –NA– is displayed. |
|
Next execution time |
Time for the next execution. If the test is a monitoring diagnostic test, its next execution time is the most recent execution time plus the execution interval. If the test is an on-demand or boot-up diagnostic test, –NA– is displayed. |
display diagnostic result statistics
Use display diagnostic result statistics to display statistics for packet-related diagnostic tests.
Syntax
display diagnostic result [ slot slot-number [ test test-name ] ] statistics
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command applies to all cards.
test test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name. If you do not specify this option, the command applies to all packet-related diagnostic tests.
Examples
# Display statistics for test PortMonitor on the specified slot.
<Sysname> display diagnostic result slot 1 test PortMonitor statistics
Slot 1:
Test name: PortMonitor
Port Packets sent Packets received Packets lost
1 0 0 0
2 0 0 0
3 0 0 0
4 4 4 0
5 4 4 0
6 4 4 0
7 4 4 0
8 0 0 0
Table 3 Command output
|
Field |
Description |
|
Test name |
Name of the test. |
|
Port |
Port number. |
|
Packets sent |
Number of packets that the device sends. |
|
Packets received |
Number of packets that the device receives. |
|
Packets lost |
Number of lost packets. |
display diagnostic simulation
Use display diagnostic simulation to display the results of simulated diagnostic tests.
Syntax
display diagnostic simulation [ slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command applies to all cards.
Examples
# Display the results of all simulated diagnostic tests on the specified slot.
<Sysname> display diagnostic simulation slot 1
Slot 1:
Name Mode
BoardStatusMonitor failure
Related commands
diagnostic simulation
reset diagnostic event-log
Use reset diagnostic event-log to clear GOLD logs.
Syntax
reset diagnostic event-log
Views
User view
Predefined user roles
network-admin
Examples
# Clear GOLD logs.
<Sysname> reset diagnostic event-log
Related commands
display diagnostic event-log
reset diagnostic result
Use reset diagnostic result to clear test results.
Syntax
reset diagnostic result [ slot slot-number [ test test-name ] ]
Views
User view
Predefined user roles
network-admin
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify this option, the command applies to all cards.
test test-name: Specifies a test by its name, a case-sensitive character string. You can use the test ? command to verify the value range of the test name. If you do not specify this option, the command applies to all diagnostic tests.
Usage guidelines
This command does not clear the next execution time.
Examples
# Clear test results for test BoardStatusMonitor on the specified slot.
<Sysname> reset diagnostic result slot 1 test BoardStatusMonitor
Related commands
display diagnostic result
