summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-mi-cmd-support-effects-log.txt
blob: 22218040ff546b50986c07eca36b2c10811aeb7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
nvme-mi-cmd-support-effects-log(1)
==================================

NAME
----
nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log,
returns results and structure

SYNOPSIS
--------
[verse]
'nvme-mi-cmd-support-effects-log' <device> [--human-readable | -H]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
For the NVMe device given, sends an MI Command Support and Effects log (id 13h)
and provides the result and returned log structure.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

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.

OPTIONS
-------
-H::
--human-readable::
	This option will parse and format many of the bit fields
	into human-readable formats.

-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json' or 'binary'. Only one
	output format can be used at a time.

-v::
--verbose::
	Increase the information detail in the output.

EXAMPLES
--------
nvme mi-cmd-support-effects-log /dev/nvme0 -H

NVME
----
Part of the nvme-user suite