2025-02-16 11:09:01 +01:00
'\" t
2025-02-16 12:15:45 +01:00
. \" Title: nvme-mi-cmd-support-effects-log
2025-02-16 11:09:01 +01:00
. \" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
. \" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
2025-02-16 12:15:45 +01:00
. \" Date: 04/08/2022
2025-02-16 11:09:01 +01:00
. \" Manual: NVMe Manual
. \" Source: NVMe
. \" Language: English
. \"
2025-02-16 12:15:45 +01:00
.TH "NVME\-MI\-CMD\-SUPPO" "1" "04/08/2022" "NVMe" "NVMe Manual"
2025-02-16 11:09:01 +01:00
. \" -----------------------------------------------------------------
. \" * 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"
2025-02-16 12:15:45 +01:00
nvme-mi-cmd-support-effects-log \- Send NVMe MI Command Support and Effects log, returns results and structure
2025-02-16 11:09:01 +01:00
.SH "SYNOPSIS"
.sp
.nf
2025-02-16 12:15:45 +01:00
\fI nvme\- mi\- cmd\- support\- effects\- log\fR <device> [\- o <fmt> | \- \- output\- format=<fmt>]
[\- H | \- \- human\- readable]
2025-02-16 11:09:01 +01:00
.fi
.SH "DESCRIPTION"
.sp
2025-02-16 12:15:45 +01:00
For the NVMe device given, sends an MI Command Support and Effects log (id 13h) and provides the result and returned log structure\& .
.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)\& .
.sp
On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\& .
2025-02-16 11:09:01 +01:00
.SH "OPTIONS"
.PP
2025-02-16 12:15:45 +01:00
\- o <format>, \- \- output\- format=<format>
2025-02-16 11:09:01 +01:00
.RS 4
2025-02-16 12:15:45 +01:00
Set the reporting format to
\fI normal\fR ,
\fI json\fR , or
\fI binary\fR \& . Only one output format can be used at a time\& .
2025-02-16 11:09:01 +01:00
.RE
.PP
2025-02-16 12:15:45 +01:00
\- H, \- \- human\- readable
2025-02-16 11:09:01 +01:00
.RS 4
2025-02-16 12:15:45 +01:00
This option will parse and format many of the bit fields into human\- readable formats\& .
2025-02-16 11:09:01 +01:00
.RE
.SH "EXAMPLES"
.sp
2025-02-16 12:15:45 +01:00
nvme mi\- cmd\- support\- effects\- log /dev/nvme0 \- H
2025-02-16 11:09:01 +01:00
.SH "NVME"
.sp
Part of the nvme\- user suite