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

NAME

6       ipmctl-start-diagnostic - Starts a diagnostic test
7

SYNOPSIS

9           ipmctl start [OPTIONS] -diagnostic [TARGETS]
10

DESCRIPTION

12       Starts a diagnostic test.
13

OPTIONS

15       -h, -help
16           Displays help for the command.
17
18       -ddrt
19           Used to specify DDRT as the desired transport protocol for the
20           current invocation of ipmctl.
21
22       -smbus
23           Used to specify SMBUS as the desired transport protocol for the
24           current invocation of ipmctl.
25
26           Note
27           The -ddrt and -smbus options are mutually exclusive and may not be
28           used together.
29
30       -lpmb
31           Used to specify large transport payload size for the current
32           invocation of ipmctl.
33
34       -spmb
35           Used to specify small transport payload size for the current
36           invocation of ipmctl.
37
38           Note
39           The -lpmb and -spmb options are mutually exclusive and may not be
40           used together.
41
42       -o (text|nvmxml), -output (text|nvmxml)
43           Changes the output format. One of: "text" (default) or "nvmxml".
44

TARGETS

46       -diagnostic [Quick|Config|Security|FW]
47           Start a specific test by supplying its name. All tests are run by
48           default. One of:
49
50           •   "Quick" - This test verifies that the PMem module host mailbox
51               is accessible and that basic health indicators can be read and
52               are currently reporting acceptable values.
53
54           •   "Config" - This test verifies that the BIOS platform
55               configuration matches the installed hardware and the platform
56               configuration conform to best known practices.
57
58           •   "Security" - This test verifies that all PMem modules have a
59               consistent security state. It is a best practice to enable
60               security on all PMem modules rather than just some.
61
62           •   "FW" - This test verifies that all PMem modules of a given
63               model have consistent FW installed and other FW modifiable
64               attributes are set in accordance with best practices.
65               Note that the test does not have a means of verifying that the
66               installed FW is the optimal version for a given PMem module
67               model just that it has been consistently applied across the
68               system.
69
70       -dimm [DimmIDS]
71           Starts a diagnostic test on specific PMem modules by optionally
72           supplying one or more comma separated PMem module identifiers. The
73           default is to start the specified tests on all manageable PMem
74           modules. Only valid for the Quick diagnostic test.
75

EXAMPLES

77       Starts all diagnostics.
78
79           ipmctl start -diagnostic
80
81       Starts the quick check diagnostic on PMem module 0x0001.
82
83           ipmctl start -diagnostic Quick -dimm 0x0001
84

LIMITATIONS

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

RETURN DATA

91       Each diagnostic generates one or more log messages. A successful test
92       generates a single log message per PMem module indicating that no
93       errors were found. A failed test might generate multiple log messages
94       each highlighting a specific error with all the relevant details. Each
95       log contains the following information.
96
97       Test
98           The test name along with overall execution result. One of:
99
100           •   "Quick"
101
102           •   "Config"
103
104           •   "Security"
105
106           •   "FW"
107
108       State
109           The collective result state for each test. One of:
110
111           •   "Ok"
112
113           •   "Warning"
114
115           •   "Failed"
116
117           •   "Aborted"
118
119       Message
120           The message indicates the status of the test. One of:
121
122           •   "Ok"
123
124           •   "Failed"
125
126       SubTestName
127           The subtest name for given Test.
128
129       ┌──────────┬────────────────────────────┐
130       │          │                            │
131       │Test Name │ Valid SubTest Names        │
132       ├──────────┼────────────────────────────┤
133       │          │                            │
134       │Quick     │                            │
135       │          │        •   Manageability   │
136       │          │                            │
137       │          │        •   Boot status     │
138       │          │                            │
139       │          │        •   Health          │
140       ├──────────┼────────────────────────────┤
141       │          │                            │
142       │Config    │                            │
143       │          │        •   PMem module     │
144       │          │            specs           │
145       │          │                            │
146       │          │        •   Duplicate PMem  │
147       │          │            module          │
148       │          │                            │
149       │          │        •   System          │
150       │          │            Capability      │
151       │          │                            │
152       │          │        •   Namespace LSA   │
153       │          │                            │
154       │          │        •   PCD             │
155       ├──────────┼────────────────────────────┤
156       │          │                            │
157       │Security  │                            │
158       │          │        •   Encryption      │
159       │          │            status          │
160       │          │                            │
161       │          │        •   Inconsistency   │
162       ├──────────┼────────────────────────────┤
163       │          │                            │
164       │FW        │                            │
165       │          │        •   FW Consistency  │
166       │          │                            │
167       │          │        •   Viral Policy    │
168       │          │                            │
169       │          │        •   Threshold check │
170       │          │                            │
171       │          │        •   System Time     │
172       └──────────┴────────────────────────────┘
173
174       State
175           The severity of the error for each sub-test displayed with
176           SubTestName. One of:
177
178           •   "Ok"
179
180           •   "Warning"
181
182           •   "Failed"
183
184           •   "Aborted"
185
186       Unresolved directive in ipmctl-start-diagnostic.txt -
187       include::ipmctl-diagnostic-events.txt[leveloffset=+1]
188
189
190
191ipmctl                            2021-05-13        IPMCTL-START-DIAGNOSTIC(1)
Impressum