Blame Documentation/nvme-endurance-log.txt

Packit Service b7b338
nvme-endurance-log(1)
Packit Service b7b338
=====================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-endurance-log - Send NVMe Endurance log page request, returns result and log
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme endurance-log' <device> [--group-id=<group> | -g <group>]
Packit Service b7b338
			[--output-format=<fmt> | -o <fmt>]
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
Retrieves the NVMe Endurance log page from an NVMe device and provides the returned structure.
Packit Service b7b338
Packit Service b7b338
The <device> parameter is mandatory and may be either the NVMe character
Packit Service b7b338
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
Packit Service b7b338
Packit Service b7b338
On success, the returned endurance log structure may be returned in one of
Packit Service b7b338
several ways depending on the option flags; the structure may parsed by
Packit Service b7b338
the program and printed in a readable format, the raw buffer may be
Packit Service b7b338
printed to stdout for another program to parse, or reported in json format.
Packit Service b7b338
Packit Service b7b338
OPTIONS
Packit Service b7b338
-------
Packit Service b7b338
-g <group>::
Packit Service b7b338
--group-id=<group>::
Packit Service b7b338
	The endurance group identifier.
Packit Service b7b338
Packit Service b7b338
-o <format>::
Packit Service b7b338
--output-format=<format>::
Packit Service b7b338
              Set the reporting format to 'normal', 'json', or
Packit Service b7b338
              'binary'. Only one output format can be used at a time.
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
* Print the Endurance log page in a human readable format:
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme endurance-log /dev/nvme0
Packit Service b7b338
------------
Packit Service b7b338
+
Packit Service b7b338
Packit Service b7b338
* Print the raw Endurance log to a file:
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme endurance-log /dev/nvme0 --output=binary > endurance_log.raw
Packit Service b7b338
------------
Packit Service b7b338
+
Packit Service b7b338
It is probably a bad idea to not redirect stdout when using this mode.
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite