summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lba-status-log.txt
blob: 7d6efbd781021f248bc307b7621c733fd4d91b7b (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
nvme-lba-status-log(1)
======================

NAME
----
nvme-lba-status-log - Send LBA Status Log Page request returns result and log

SYNOPSIS
--------
[verse]
'nvme lba-status-log' <device> [--rae | -r]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
Retrieves the NVMe LBA Status Log Page from an NVMe device and provides
the 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 LBA Status Log Page 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
may be printed to stdout for another program to parse.

OPTIONS
-------
-r::
--rae::
	Retain an Asynchronous Event.

-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
--------
* Print the LBA Status Log page in a normal readable format:
+
------------
# nvme lba-status-log /dev/nvme0
------------
+

* Show the output in json format
+
------------
# nvme lba-status-log /dev/nvme0 -o json
+

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