ipmctl-start-diagnostic - Man Page

Starts a diagnostic test

Synopsis

ipmctl start [OPTIONS] -diagnostic [TARGETS]

Description

Starts a diagnostic test.

Options

-h, -help

Displays help for the command.

-ddrt

Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.

-smbus

Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
Note

The -ddrt and -smbus options are mutually exclusive and may not be used together.

-lpmb

Used to specify large transport payload size for the current invocation of ipmctl.

-spmb

Used to specify small transport payload size for the current invocation of ipmctl.
Note

The -lpmb and -spmb options are mutually exclusive and may not be used together.

-o (text|nvmxml), -output (text|nvmxml)

Changes the output format. One of: "text" (default) or "nvmxml".

Targets

-diagnostic [Quick|Config|Security|FW]

Start a specific test by supplying its name. All tests are run by default. One of:

  • "Quick" - This test verifies that the PMem module host mailbox is accessible and that basic health indicators can be read and are currently reporting acceptable values.
  • "Config" - This test verifies that the BIOS platform configuration matches the installed hardware and the platform configuration conform to best known practices.
  • "Security" - This test verifies that all PMem modules have a consistent security state. It is a best practice to enable security on all PMem modules rather than just some.
  • "FW" - This test verifies that all PMem modules of a given model have consistent FW installed and other FW modifiable attributes are set in accordance with best practices.
    Note that the test does not have a means of verifying that the installed FW is the optimal version for a given PMem module model just that it has been consistently applied across the system.
-dimm [DimmIDS]

Starts a diagnostic test on specific PMem modules by optionally supplying one or more comma separated PMem module identifiers. The default is to start the specified tests on all manageable PMem modules. Only valid for the Quick diagnostic test.

Examples

Starts all diagnostics.

ipmctl start -diagnostic

Starts the quick check diagnostic on PMem module 0x0001.

ipmctl start -diagnostic Quick -dimm 0x0001

Limitations

If a PMem module is unmanageable, then Quick test will report the reason, while Config, Security and FW tests will skip unmanageable PMem modules.

Return Data

Each diagnostic generates one or more log messages. A successful test generates a single log message per PMem module indicating that no errors were found. A failed test might generate multiple log messages each highlighting a specific error with all the relevant details. Each log contains the following information.

Test

The test name along with overall execution result. One of:

  • "Quick"
  • "Config"
  • "Security"
  • "FW"
State

The collective result state for each test. One of:

  • "Ok"
  • "Warning"
  • "Failed"
  • "Aborted"
Message

The message indicates the status of the test. One of:

  • "Ok"
  • "Failed"
SubTestName

The subtest name for given Test.

Test NameValid SubTest Names
Quick
  • Manageability
Config
  • PMem module specs
Security
  • Encryption status
FW
  • FW Consistency
State

The severity of the error for each sub-test displayed with SubTestName. One of:

  • "Ok"
  • "Warning"
  • "Failed"
  • "Aborted"

Unresolved directive in ipmctl-start-diagnostic.txt - include::ipmctl-diagnostic-events.txt[leveloffset=+1]

Referenced By

ipmctl(1).

2020-10-15 ipmctl