Login
- Table of Contents
-
- 12 Network Management and Monitoring Command Reference
- 00-Preface
- 01-System maintenance and debugging commands
- 02-NQA commands
- 03-NTP commands
- 04-SNMP commands
- 05-RMON commands
- 06-NETCONF commands
- 07-EAA commands
- 08-Process monitoring and maintenance commands
- 09-Mirroring commands
- 10-sFlow commands
- 11-Information center commands
- 12-GOLD commands
- 13-Packet capture commands
- 14-VCF fabric commands
- 15-CWMP commands
- 16-SmartMC commands
- Related Documents
-
| Title | Size | Download |
|---|---|---|
| 12-GOLD commands | 58.82 KB |
GOLD commands
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 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
The monitoring diagnostic tests vary in enabling status. To view the enabling status of monitoring diagnostic tests, 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.
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
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
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.
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
# Set the execution interval to 1 minute for test BoardStatusMonitor on the specified slot.
<Sysname> system-view.
[Sysname] diagnostic monitor interval slot 1 test BoardStatusMonitor 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
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.
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
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 an IRF member device by its member ID. If you do not specify this option, the command applies to all member devices.
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
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
Slot 1:
Test name : IPCMonitor
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 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 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 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/* |
(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. |
|
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. |
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 a master/subordinate device switchover occurs.
Examples
# Display all GOLD log entries.
<Sysname> display diagnostic event-log
Event: E_INFO, Wed Jan 7 11:39:53:314 2014, -Slot=1 TestName->IPCMonitor, Event_INFO: Result->Success.
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 an IRF member device by its member ID. If you do not specify this option, the command applies to all member devices.
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:
Name Run count Failure count Last result
IPCMonitor 51 0 Success
BoardStatusMonitor 386 0 Success
TaskMonitor 310 0 Success
PortMonitor 310 0 Success
ComponentMonitor 103 0 Success
# Display detailed test results for all diagnostic tests.
<Sysname> display diagnostic result verbose
Slot 1:
Test name : IPCMonitor
Total run count : 52
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:25 2014
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:25 2014
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:14:25 2014
ipc link status : Normal
Test name : BoardStatusMonitor
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
Test name : TaskMonitor
Total run count : 313
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:35 2014
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:35 2014
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:13:45 2014
Task check status : Normal
Test name : PortMonitor
Total run count : 313
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:35 2014
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:35 2014
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:13:45 2014
test result: pass
Test name : ComponentMonitor
Total run count : 104
Total failure count : 0
Consecutive failure count: 0
Last execution time : Fri Nov 21 23:13:25 2014
First failure time : -NA-
Last failure time : -NA-
Last pass time : Fri Nov 21 23:13:25 2014
Last execution result : Success
Last failure reason : -NA-
Next execution time : Fri Nov 21 23:13:55 2014
test result: pass
Table 2 Command output
|
Field |
Description |
|
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. 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
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.
Examples
# Display configurations for 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 an IRF member device by its member ID. If you do not specify this option, the command applies to all IRF member devices.
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
