1IPMCTL-RUN-DIAGNOSTIC(1)            ipmctl            IPMCTL-RUN-DIAGNOSTIC(1)
2
3
4

NAME

6       ipmctl-run-diagnostic - Runs a diagnostic test
7

SYNOPSIS

9       ipmctl start [OPTIONS] -diagnostic (Quick|Config|Security|FW) -dimm(DIMMIDs)
10

DESCRIPTION

12       Runs a diagnostic test.
13

OPTIONS

15       -h, -help
16           Displays help for the command.
17
18       -o (text|nvmxml), -output (text|nvmxml)
19           Changes the output format. One of: "text" (default) or "nvmxml".
20

TARGETS

22       -diagnostic (Quick|Config|Security|FW)
23           Run a specific test by supplying its name. By default all tests are
24           run. One of:
25
26           ·   "Quick" - This test verifies that the DCPMM host mailbox is
27               accessible and that basic health indicators can be read and are
28               currently reporting acceptable values.
29
30           ·   "Config" - This test verifies that the BIOS platform
31               configuration matches the installed hardware and the platform
32               configuration conforms to best known practices.
33
34           ·   "Security" - This test verifies that all DCPMMs have a
35               consistent security state. It’s a best practice to enable
36               security on all DCPMMs rather than just some.
37
38           ·   "FW" - This test verifies that all DCPMMs of a given model have
39               consistent FW installed and other FW modifiable attributes are
40               set in accordance with best practices.
41               Note that the test does not have a means of verifying that the
42               installed FW is the optimal version for a given DCPMM model
43               just that it’s been consistently applied across the system.
44
45       -dimm [(DimmIDS)]
46           Runs a diagnostic test on specific DCPMMs by optionally supplying
47           one or more comma-separated DCPMM identifiers. The default is to
48           run the specified tests on all manageable DCPMMs. Only valid for
49           the Quick diagnostic test.
50

EXAMPLES

52       Runs all diagnostics.
53
54       ipmctl start -diagnostic
55
56       Runs the quick check diagnostic on DCPMM 0x0001
57
58       ipmctl start -diagnostic Quick -dimm 0x0001
59

LIMITATIONS

61       If a DCPMM is unmanageable, then Quick test will report the reason,
62       while Config, Security and FW tests will skip unmanageable DCPMMs.
63

RETURN DATA

65       Each diagnostic generates one or more log messages. A successful test
66       generates a single log message per DCPMM indicating that no errors were
67       found. A failed test might generate multiple log messages each
68       highlighting a specific error with all the relevant details. Each log
69       contains the following information.
70
71       TestName
72           The test name. One of:
73
74           ·   "Quick"
75
76           ·   "Config"
77
78           ·   "Security"
79
80           ·   "FW"
81
82       State
83           The severity of the error. One of:
84
85           ·   "Ok"
86
87           ·   "Warning"
88
89           ·   "Failed"
90
91           ·   "Aborted"
92
93                   NOTE: State is promoted to the highest severity result from the test group.
94
95       Message
96           A free form textual description of the error.
97
98
99
100ipmctl                            2019-10-23          IPMCTL-RUN-DIAGNOSTIC(1)