| Sun Fire V20z and Sun Fire V40z Servers User Guide
|
   
|
You can use the diags subcommands shown in TABLE C-1 to manage diagnostics tests:
TABLE C-1 Diagnostic Subcommands
|
Subcommand
|
Description
|
|
diags cancel tests
|
Cancels one or more diagnostic tests, resulting in the deletion of the results data.
|
|
diags get state
|
Returns the state of the platform diagnostics control server.
|
|
diags get tests
|
Returns data describing the diagnostic tests that are available and their requirements and parameters.
|
|
diags run tests
|
Submits one or more diagnostic tests for execution.
|
|
diags start
|
Starts the Service Processor and platform diagnostics framework.
|
|
diags terminate
|
Terminates all diagnostics tests and terminates the diagnostics subsystem.
|
|
Note - Every command returns a return code upon completion.
|
C.1 diags cancel tests C.1.1 Command
Access: Administrators
Description: Cancels one or more diagnostic tests, resulting in the deletion of results data.
Command format: diags cancel tests [[{ -t | --test} test_handle] [{-a|--all}] [{-H | --noheader}]]
|
Arguments
|
Description
|
|
{ -t | --test}
|
Specifies the test to cancel. (Note: The test_handle is the same as the test handle that is output to the screen when you submit the test.)
|
|
{-a | --all}
|
Cancels all tests.
|
|
{-H | --noheader}
|
Suppresses header output.
|
Specifying no arguments cancels all tests for each device in the system.
C.1.2 Return Codes
Following are the return values for this command:
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_RPCTimeout
|
2
|
Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform operation.
|
|
NWSE_MissingArgument
|
7
|
Missing argument(s).
|
C.1.3 diags get state
C.1.3.1 Command
Access: Administrators
Description: Returns the state of the platform diagnostics control server.
Command format: diags get state
If the command returns a success text message, the platform is up and ready for diagnostics and you can submit platform diagnostic tests for execution.
If you get an error text message, the platform diagnostics are not up and you will need to wait to run the platform diagnostics tests.
C.1.3.2 Return Codes
Following are the return values for this command:
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_DeviceError
|
25
|
Unable to read or write to the device.
|
C.2 diags get testsC.2.1 Command
Access: Administrators
Description: Returns data describing the diagnostic tests that are available. This data includes the specific test name and the module to which the test applies.
Command format: diags get tests [{ -a | --all}] [{-H | --noheader}]] [{-D | --delim delimiter}]
|
Arguments
|
Description
|
|
{-a | --all}
|
Specifies to return information for all tests in the system. Specifying no arguments also returns all tests available for each device in the system.
|
|
{-H | --noheader}
|
Suppresses header output.
|
|
{-D | --delim delimiter}
|
Delimits columns with the specified delimiter. Headings are also delimited unless suppressed. The delimiter can be any character or string.
|
C.2.2 Return Codes
Following are the return values for this command:
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_RPCTimeout
|
2
|
Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_MissingArgument
|
7
|
Missing argument(s).
|
C.3 diags run testsC.3.1 Command
Access: Administrators
Description: Submits one or more diagnostic tests for execution.
Command format: diags run tests [ [{ -n | --name} test_name] [{-a| --all}] [-H | --noheader] [-P | --noprogress] [{-m | --module} module] [-v | --verbose]
|
Arguments
|
Description
|
|
{ -n | --name test_name}
|
Specifies the specific test(s) to execute. See TABLE 3-1 for test_name values. Run diags get tests for a list of individual test names.
|
|
{-a | --all}
|
Specifies that all tests are to be executed. Run diags get tests for a list of all available tests. Specifying no arguments also runs all tests for each device in the system.
|
|
{-H |--noheader}
|
Suppresses header output.
|
|
{-P | --noprogress}
|
Suppresses progress dots when waiting for test results.
|
|
{-m | --module module}
|
Specifies that only tests for the specified module are to be executed. See TABLE 3-1 for module values. Run diags get tests for a list of modules.
|
|
[-v | --verbose]
|
If specified, test details display following the test result line.
|
The following data displays after a test is run:
- Submitted Test Name
- Test Handle
- Test Result (for example, Passed, Failed)
- Details (if you specify the -v option, Test Details displays indicating detailed information about the test such as high, low and nominal values, actual values, and so on. Upon failure, Failure Details displays with a text message indicating the cause of failure.)
C.3.2 Return Codes
Following are the return values for this command:
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_RPCTimeout
|
2
|
Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_MissingArgument
|
7
|
Missing argument(s).
|
C.4 diags start C.4.1 Command
Access: Administrators
Description: Starts the service processor and platform diagnostics framework. You must execute this command before running any tests.
The platform state must be either off or OS communicating. Refer to the platform get os state command in the Sun Fire V20z and Sun Fire V40z Servers, Server Management Guide for details about these states.
Command format: diags start {--noplatform}
|
Arguments
|
Description
|
|
{--noplatform}
|
Lets you enable diagnostics when the platform power is on and the OS is running.
Note: If you use this option, you cannot use any platform diagnostics, which include diagnostics for memory, NIC cards and storage.
|
C.4.2 Return Codes
Following are the return values for this command:
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_RPCTimeout
|
2
|
Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_InvalidOpForState
|
22
|
Invalid operation for current state.
|
C.5 diags terminate C.5.1 Command
Access: Administrators
Description: Terminates all diagnostics tests and the diagnostics session.
Command format: diags terminate
C.5.2 Return Codes
Following are the return values for this command:
|
Return Code
|
ID
|
Description
|
|
NWSE_Success
|
0
|
Command successfully completed.
|
|
NWSE_InvalidUsage
|
1
|
Invalid usage: bad parameter usage, conflicting options specified.
|
|
NWSE_RPCTimeout
|
2
|
Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
|
|
NWSE_RPCNotConnected
|
3
|
Unable to connect to the RPC server.
|
|
NWSE_InvalidArgument
|
4
|
One or more arguments were incorrect or invalid.
|
|
NWSE_NoPermission
|
6
|
Not authorized to perform this operation.
|
|
NWSE_MissingArgument
|
7
|
Missing argument(s).
|
| Sun Fire V20z and Sun Fire V40z Servers User Guide
|
817-5248-13
|
|
Copyright © 2004, Sun Microsystems, Inc. All Rights Reserved.