nvme-cli/Documentation/nvme-ocp-smart-add-log.1

'\" t
.\"     Title: nvme-ocp-smart-add-log
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/17/2025
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-OCP\-SMART\-AD" "1" "03/17/2025" "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-smart-add-log \- Retrieves Extended SMART information of given OCP compliant device
.SH "SYNOPSIS"
.sp
.nf
\fInvme ocp smart\-add\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-output\-format\-version=<version>]
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, send a smart\-add\-log command and provide the additional smart log\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&.
.sp
This will only work on OCP compliant devices supporting this feature\&. Results for any other device are undefined\&.
.sp
EXPERIMENTAL\&. The \-\-output\-format\-version can be set to 2 to generate field names for the outputs that are easier to process via scripts\&. Note this is experimental and the field names are subject to change\&.
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR
or
\fIjson\fR\&. Only one output format can be used at a time\&. The default is normal\&.
.RE
.PP
\-\-output\-format\-version=<version>
.RS 4
Set the field labels in the reporting format to either
\fI1\fR
(the original) or
\fI2\fR\&. The default is 1\&. Note this is experimental\&.
.RE
.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 smart\-add\-log command to retrieve the 0xC0 log page\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme ocp smart\-add\-log /dev/nvme0
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite\&.