Skip to main content
Element Software
A newer release of this product is available.

TestHardwareConfig

Contributors
PDFs

You can use the TestHardwareConfig method to perform hardware tests on a node. Test options include verifying hardware configurations, firmware versions, and that all drives are present.

Parameters

Note These test are not intended to detect hardware failures.

This method has the following input parameters:

Name Description Type Default value Required

clean

Starts the hardware configuration test with a clean cache. Possible values:

  • true: Deletes the cached test results file and reruns the tests.

  • false: Retrieves a cached test results.

boolean

false

No

force

The force parameter must be included in this method to successfully reset the node.

boolean

None

Yes

Return value

This method has the following return value:

Name Description Type

details

Hardware configuration details.

JSON object

Request example

Requests for this method are similar to the following example:

{
   "method": "TestHardwareConfig",
   "params": {
      "force": true
     },
   "id" : 1
}

Response example

Due to the length of this response example, it is documented in a supplementary topic.

New since version

9.6

Find more information

TestHardwareConfig