diff options
Diffstat (limited to 'Documentation/nvme-solidigm-smart-log-add.1')
-rw-r--r-- | Documentation/nvme-solidigm-smart-log-add.1 | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/Documentation/nvme-solidigm-smart-log-add.1 b/Documentation/nvme-solidigm-smart-log-add.1 new file mode 100644 index 0000000..a71787b --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.1 @@ -0,0 +1,123 @@ +'\" t +.\" Title: nvme-solidigm-smart-log-add +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-SMAR" "1" "10/31/2024" "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-solidigm-smart-log-add \- Retrieve Solidigm SMART Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm smart\-log\-add\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] + [\-\-output\-format=<fmt> | \-o <fmt>] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the Solidigm vendor\-specific SMART log for the given NVMe device and optionally the specified namespace, then displays the log\&. +.sp +The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n <nsid>, \-\-namespace\-id=<nsid> +.RS 4 +Retrieve the log for the given nsid\&. If not specified, the log will be retrieved for all namespaces\&. +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log for all namespaces: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /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 +.\} +Retrieve the Solidigm SMART log for namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite |