1
0
Fork 0
nvme-cli/Documentation/nvme-fw-log.txt
Daniel Baumann d6e1a5d456
Adding upstream version 2.7.1.
Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-02-16 12:25:41 +01:00

61 lines
1.4 KiB
Text

nvme-fw-log(1)
==============
NAME
----
nvme-fw-log - Send NVMe Firmware log page request, returns result and log
SYNOPSIS
--------
[verse]
'nvme fw-log' <device> [--raw-binary | -b]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Retrieves the NVMe Firmware 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 f/w 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 may be
printed to stdout for another program to parse.
OPTIONS
-------
-b::
--raw-binary::
Print the raw fw log buffer to stdout.
-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 firmware log page in a human readable format:
+
------------
# nvme fw-log /dev/nvme0
------------
+
* Print the log firmware to a file:
+
------------
# nvme fw-log /dev/nvme0 --raw-binary > fw_log.raw
------------
+
It is probably a bad idea to not redirect stdout when using this mode.
NVME
----
Part of the nvme-user suite