Login
- Table of Contents
-
- 15-Network Management and Monitoring Command References
- 00-Preface
- 01-System maintenance and debugging commands
- 02-NQA commands
- 03-iNQA commands
- 04-NTP commands
- 05-PoE commands
- 06-SNMP commands
- 07-RMON commands
- 08-Event MIB commands
- 09-NETCONF commands
- 10-SmartMC commands
- 11-CWMP commands
- 12-EAA commands
- 13-Process monitoring and maintenance commands
- 14-Sampler commands
- 15-Mirroring commands
- 16-NetStream commands
- 17-IPv6 NetStream commands
- 18-sFlow commands
- 19-Performance management commands
- 20-Flow log commands
- 21-Information center commands
- 22-Packet capture commands
- 23-Cloud connection commands
- 24-GOLD commands
- 25-eMDI commands
- 26-SQA commands
- 27-Fast log output commands
- 28-iFIT commands
- Related Documents
-
| Title | Size | Download |
|---|---|---|
| 24-GOLD commands | 91.25 KB |
Contents
GOLD commands
Support for the diagnostic tests depends on the device model. To get the names of diagnostic tests supported by the device, enter ? at the test name position in a GOLD command. The diagnostic test names used in the following command examples are for illustration only.
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
In standalone mode:
diagnostic monitor action [ test test-name ] mode { none | self-reboot | service-restart | switchover | system-reboot }
undo diagnostic monitor action [ test test-name ]
In IRF mode:
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 an IRF member device by its member ID or specifies a range of IRF member devices 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. (In IRF mode.)
Examples
# (In standalone mode.) Set the recovery action to self-reboot for test MonitorTest.
<Sysname> system-view
[Sysname] diagnostic monitor action test MonitorTest mode self-reboot
# (In IRF mode.) Set the recovery action to self-reboot for test MonitorTest on slot 1.
<Sysname> system-view
[Sysname] diagnostic monitor action slot 1 test MonitorTest mode self-reboot
diagnostic monitor enable
Use diagnostic monitor enable to enable monitoring diagnostics.
Use undo diagnostic monitor enable to disable monitoring diagnostics.
Syntax
In standalone mode:
diagnostic monitor enable [ test test-name ]
undo diagnostic monitor enable [ test test-name ]
In IRF mode:
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 an IRF member device by its member ID or specifies a range of IRF member devices 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. (In IRF mode.)
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
# (In standalone mode.) Enable test MonitorTest.
<Sysname> system-view
[Sysname] diagnostic monitor enable test MonitorTest
# (In IRF mode.) Enable test MonitorTest on the specified slot.
<Sysname> system-view
[Sysname] diagnostic monitor enable slot 1 test MonitorTest
Related commands
diagnostic monitor interval
diagnostic monitor interval
Use diagnostic monitor interval to configure an execution interval for monitoring diagnostic tests.
Use undo diagnostic monitor interval to restore the default.
Syntax
In standalone mode:
diagnostic monitor interval [ test test-name ] time interval
undo diagnostic monitor interval [ test test-name ]
In IRF mode:
diagnostic monitor interval slot slot-number-list [ test test-name ] time interval
undo diagnostic monitor interval slot slot-number-list [ test test-name ]
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.
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 an IRF member device by its member ID or specifies a range of IRF member devices 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. (In IRF mode.)
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 monitoring diagnostic tests.
interval: Sets an execution interval in the form of hh:mm:ss. The value range for the hh argument is 0 to 23. The value range for the mm and ss arguments is both 0 to 59. If you specify only the hh argument, you can omit the mm and ss segments. If you specify only the hh and mm arguments, you can omit the ss segment. For example, to specify 01:00:00, you can enter 1.
Usage guidelines
Use this command to configure the interval at which the system automatically executes enabled monitoring diagnostic tests.
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.
Examples
# (In standalone mode.) Set the execution interval to 1 minute for test MonitorTest.
<Sysname> system-view
[Sysname] diagnostic monitor interval test MonitorTest time 00:01:00
# (In IRF mode.) Set the execution interval to 1 minute for test MonitorTest on the specified slot.
<Sysname> system-view.
[Sysname] diagnostic monitor interval slot 1 test MonitorTest time 00:01:00
Related commands
diagnostic monitor enable
display diagnostic content
diagnostic simulation
Use diagnostic simulation to simulate diagnostic tests.
Use undo diagnostic simulation to restore the default.
Syntax
In standalone mode:
diagnostic simulation test test-name { failure | random-failure | success }
undo diagnostic simulation test test-name
In IRF mode:
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 an IRF member device by its member ID or specifies a range of IRF member devices 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. (In IRF mode.)
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
# (In standalone mode.) Simulate test MonitorTest as failed.
<Sysname> diagnostic simulation test MonitorTest failure
# (In IRF mode.) Simulate test MonitorTest as failed on the specified slot.
<Sysname> diagnostic simulation slot 1 test MonitorTest 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 ScriptTest.
<Sysname> diagnostic start test ScriptTest
This command requires null configuration and reboot device afterwards. Continue?
[Y/N]:y
=================================================
===============display clock===================
10:55:19.115 UTC Fri 06/27/2017
===============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
In standalone mode:
display diagnostic content [ verbose ]
In IRF mode:
display diagnostic content [ slot slot-number ] [ verbose ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies an IRF member device by its member ID. If you do not specify this option, the command applies to all member devices. (In IRF mode.)
verbose: Displays detailed information about diagnostic tests. If you do not specify this keyword, the command displays brief information about the diagnostic tests.
Examples
# (In standalone mode.) Display brief information about all diagnostic tests.
<Sysname> display diagnostic content
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
Name Attributes Interval
MonitorTest **M*PA 01:00:00
# (In standalone mode.) Display detailed information about all diagnostic tests.
<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 : MonitorTest
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-
# (In IRF mode.) 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
Slot 1:
Name Attributes Interval
MonitorTest **M*PA 01:00:00
# (In IRF mode.) 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
Slot 1:
Test name : MonitorTest
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-
Table 1 Command output
|
Field |
Description |
|
B/* |
This field is not supported in the current software version. Boot-up/Not boot-up. |
|
O/* |
This field is not supported in the current software version. 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. |
|
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 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.
(In standalone mode.) GOLD logs are cleared when the device restarts.
(In IRF mode.) GOLD logs are cleared when the device restarts or when a master/subordinate device switchover occurs.
Examples
#(In standalone mode.) Display all GOLD log entries.
<Sysname> display diagnostic event-log
Event: E_INFO, Wed Jan 7 11:39:53:314 2017, TestName->IPCMonitor, Event_INFO: Result->Success.
# (In IRF mode.) Display all GOLD log entries.
<Sysname> display diagnostic event-log
Event: E_INFO, Wed Jan 7 11:39:53:314 2017, -Slot=1 TestName->IPCMonitor, Event_INFO: Result->Success.
display diagnostic result
Use display diagnostic result to display test results.
Syntax
In standalone mode:
display diagnostic result [ test test-name ] [ verbose ]
In IRF mode:
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 an IRF member device by its member ID. If you do not specify this option, the command applies to all member devices. (In IRF mode.)
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
# (In standalone mode.) Display brief test results for all diagnostic tests.
<Sysname> display diagnostic result
Name Run count Failure count Last result
MonitorTest 386 0 Success
# (In standalone mode.) Display detailed test results for all diagnostic tests.
<Sysname> display diagnostic result verbose
Test name : MonitorTest
Total run count : 386
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:00:01 2014
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:00:01 2014
Last execution result : Success
Last failure reason : -NA-
Next execution time : Sat Nov 22 00:00:07 2014
Slot check status : Normal
# (In IRF mode.) Display brief test results for all diagnostic tests on the specified slot.
<Sysname> display diagnostic result slot 1
Slot 1:
Name Run count Failure count Last result
MonitorTest 386 0 Success
# (In IRF mode.) Display detailed test results for all diagnostic tests.
<Sysname> display diagnostic result verbose
Slot 1:
Test name : MonitorTest
Total run count : 386
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:00:01 2014
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:00:01 2014
Last execution result : Success
Last failure reason : -NA-
Next execution time : Sat Nov 22 00:00:07 2014
Slot check status : Normal
Table 2 Command output
|
Field |
Description |
|
Name |
Name of the test. |
|
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. For a monitoring diagnostic test, the next execution time is the most recent execution time plus the execution interval. |
display diagnostic simulation
Use display diagnostic simulation to display configurations for simulated diagnostic tests.
Syntax
In standalone mode:
display diagnostic simulation
In IRF mode:
display diagnostic simulation [ slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies an IRF member device by its member ID. If you do not specify this option, the command applies to all member devices. (In IRF mode.)
Examples
# (In standalone mode.) Display configurations for all simulated diagnostic tests.
<Sysname> display diagnostic simulation
Name Mode
MonitorTest failure
# (In IRF mode.) Display configurations for all simulated diagnostic tests on the specified slot.
<Sysname> display diagnostic simulation slot 1
Slot 1:
Name Mode
MonitorTest 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
In standalone mode:
reset diagnostic result [ test test-name ]
In IRF mode:
reset diagnostic result [ slot slot-number [ test test-name ] ]
Views
User view
Predefined user roles
network-admin
Parameters
slot slot-number: Specifies an IRF member device by its member ID. If you do not specify this option, the command applies to all IRF member devices. (In IRF mode.)
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
# (In standalone mode.) Clear test results for test MonitorTest.
<Sysname> reset diagnostic result test MonitorTest
# (In IRF mode.) Clear test results for test MonitorTest on the specified slot.
<Sysname> reset diagnostic result slot 1 test MonitorTest
Related commands
display diagnostic result
