'\" t
.\"     Title: nvme-ocp-hardware-component-log
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/07/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-OCP\-HARDWARE\" "1" "09/07/2026" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-ocp-hardware-component-log \- retrieve hardware component log
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIocp hardware\-component\-log\fR <device>
                        [\-\-comp\-id=<num> | \-i <num>]
                        [\-\-list | \-l]
.fi
.SH "DESCRIPTION"
.sp
Retrieve hardware component log\&.
.sp
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
.sp
This will only work on OCP compliant devices supporting this feature\&. Results for any other device are undefined\&.
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
\-i <num>, \-\-comp\-id=<num>
.RS 4
component identifier
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
Value
T}:T{
Definition
T}
T{
0x0000
T}:T{
Reserved
T}
T{
0x0001 |
\fIasic\fR
T}:T{
Controller ASIC component
T}
T{
0x0002 |
\fInand\fR
T}:T{
NAND Component
T}
T{
0x0003 |
\fIdram\fR
T}:T{
DRAM Component
T}
T{
0x0004 |
\fIpmic\fR
T}:T{
PMIC Component
T}
T{
0x0005 |
\fIpcb\fR
T}:T{
PCB Component
T}
T{
0x0006 |
\fIcap\fR
T}:T{
capacitor component
T}
T{
0x0007 |
\fIreg\fR
T}:T{
registor component
T}
T{
0x0008 |
\fIcase\fR
T}:T{
case component
T}
T{
0x0009 |
\fIsn\fR
T}:T{
Device Serial Number
T}
T{
0x000A |
\fIcountry\fR
T}:T{
Country of Origin
T}
T{
0x000B |
\fIhw\-rev\fR
T}:T{
Global Device Hardware Revision
T}
T{
0x000C\-0x7FFF
T}:T{
Reserved
T}
T{
0x8000 |
\fIvendor\fR
T}:T{
Vendor Unique Component
T}
T{
0x8001\-0xFFFF
T}:T{
Vendor Unique Component
T}
.TE
.sp 1
.RE
.PP
\-l, \-\-list
.RS 4
list component descriptions
.RE
.SH "GLOBAL OPTIONS"
.sp
The following options are defined at the top\-level nvme command and are available to this subcommand:
.PP
\-\-dry\-run
.RS 4
Print the command that would be executed, but do not actually execute it\&.
.RE
.PP
\-\-no\-ioctl\-probing
.RS 4
Disable probing for 64\-bit IOCTL support\&.
.RE
.PP
\-\-no\-retries
.RS 4
Disable retry logic on transient errors\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fItabular, \*(Aqjson\fR, or
\fIbinary\fR\&. Only one output format may be used at a time\&.
.RE
.PP
\-\-output\-format\-version=<version>
.RS 4
Select the output format version\&. Version
\fI1\fR
uses the original field naming, while version
\fI2\fR
(default) provides more consistent and script\-friendly field names\&.
.RE
.PP
\-\-timeout=<ms>
.RS 4
Set the timeout for the command in milliseconds\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
.RE
.sp
These options can also be set as machine\-wide defaults in nvme\-cli\&.conf(5)\&. A command\-line flag always overrides the file\&.
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Has the program issue a ocp hardware\-component\-log
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme ocp hardware\-component\-log /dev/nvme0
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Has the program issue a ocp hardware\-component\-log with asic component list
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme ocp hardware\-component\-log /dev/nvme0 \-i asic \-l
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite\&.