'\" t
.\"     Title: ipmctl-run-diagnostic
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 1.5.8
.\"      Date: 2019-10-28
.\"    Manual: ipmctl
.\"    Source: ipmctl
.\"  Language: English
.\"
.TH "IPMCTL\-RUN\-DIAGNOSTIC" "1" "2019-10-28" "ipmctl" "ipmctl"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
ipmctl\-run\-diagnostic \- Runs a diagnostic test
.SH "SYNOPSIS"
.sp
.nf
ipmctl start [OPTIONS] \-diagnostic (Quick|Config|Security|FW) \-dimm(DIMMIDs)
.fi
.br
.SH "DESCRIPTION"
.sp
Runs a diagnostic test.
.SH "OPTIONS"
.sp
\-h, \-help
.RS 4
Displays help for the command.
.RE
.sp
\-o (text|nvmxml), \-output (text|nvmxml)
.RS 4
Changes the output format. One of: "text" (default) or "nvmxml".
.RE
.SH "TARGETS"
.sp
\-diagnostic (Quick|Config|Security|FW)
.RS 4
Run a specific test by supplying its name. By default all tests are run.
One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Quick" \- This test verifies that the DCPMM host mailbox is accessible and
that basic health indicators can be read and are currently reporting
acceptable values.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Config" \- This test verifies that the BIOS platform configuration matches
the installed hardware and the platform configuration conforms to best known
practices.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Security" \- This test verifies that all DCPMMs have a consistent security
state. It\(cqs a best practice to enable security on all DCPMMs rather than
just some.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"FW" \- This test verifies that all DCPMMs of a given model have consistent
FW installed and other FW modifiable attributes are set in accordance with
best practices.
.br
Note that the test does not have a means of verifying that
the installed FW is the optimal version for a given DCPMM model just that
it\(cqs been consistently applied across the system.
.RE
.RE
.sp
\-dimm [(DimmIDS)]
.RS 4
Runs a diagnostic test on specific DCPMMs by optionally supplying one or more
comma\-separated DCPMM identifiers. The default is to run the specified tests
on all manageable DCPMMs. Only valid for the Quick diagnostic test.
.RE
.SH "EXAMPLES"
.sp
Runs all diagnostics.
.sp
.nf
ipmctl start \-diagnostic
.fi
.br
.sp
Runs the quick check diagnostic on DCPMM 0x0001
.sp
.nf
ipmctl start \-diagnostic Quick \-dimm 0x0001
.fi
.br
.SH "LIMITATIONS"
.sp
If a DCPMM is unmanageable, then Quick test will report the reason, while
Config, Security and FW tests will skip unmanageable DCPMMs.
.SH "RETURN DATA"
.sp
Each diagnostic generates one or more log messages. A successful test generates a
single log message per DCPMM 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.
.sp
TestName
.RS 4
The test name. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Quick"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Config"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Security"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"FW"
.RE
.RE
.sp
State
.RS 4
The severity of the error. One of:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Ok"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Warning"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Failed"
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
"Aborted"
.sp
.if n .RS 4
.nf
NOTE: State is promoted to the highest severity result from the test group.
.fi
.if n .RE
.RE
.RE
.sp
Message
.RS 4
A free form textual description of the error.
.RE