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

NAME
----
nvme-endurance-log - Send NVMe Endurance log page request, returns result and log

SYNOPSIS
--------
[verse]
'nvme endurance-log' <device> [--group-id=<group> | -g <group>]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
Retrieves the NVMe Endurance 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 endurance 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, the raw buffer may be
printed to stdout for another program to parse, or reported in json format.

OPTIONS
-------
-g <group>::
--group-id=<group>::
	The endurance group identifier.

-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 Endurance log page in a human readable format:
+
------------
# nvme endurance-log /dev/nvme0
------------
+

* Print the raw Endurance log to a file:
+
------------
# nvme endurance-log /dev/nvme0 --output=binary > endurance_log.raw
------------
+
It is probably a bad idea to not redirect stdout when using this mode.

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