summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-self-test-log.txt
blob: 78798d9ffd4f52584fb99065f07fa7a9c39d875a (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
50
51
52
53
54
55
56
57
58
59
60
61
nvme-self-test-log(1)
=====================

NAME
----
nvme-self-test-log - Retrieve the log information initited by device-self-test and display it

SYNOPSIS
--------
[verse]
'nvme self-test'-log <device> [--output-format=<FMT> | -o <FMT>] 

DESCRIPTION
-----------
Retrieves the log pages from an NVMe device corresponding to the 
requested self-test by the user and provides 20-most recent result 
returned 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 returned log structure may be returned in one of
several ways depending on the option flags; the structure may parsed by
the program and printed in a readable format or the raw buffer or the 
json format.

By default the log is printed out in the normal readable format.

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


EXAMPLES
--------
* Get the self-test-log and print it in a human readable format:
+
------------
# nvme self-test-log /dev/nvme0
------------
+

* Print the raw output to a file:
+
------------
# nvme self-test-log /dev/nvme0 -o "binary"
------------
+

* Get the self-test-log and print it in a json format:
+
------------
# nvme self-test-log /dev/nvme0 -o "json"
------------

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