summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-telemetry-log.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
commitfc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch)
tree4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-telemetry-log.txt
parentAdding upstream version 2.5. (diff)
downloadnvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz
nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-telemetry-log.txt16
1 files changed, 13 insertions, 3 deletions
diff --git a/Documentation/nvme-telemetry-log.txt b/Documentation/nvme-telemetry-log.txt
index cf126d9..4d2a494 100644
--- a/Documentation/nvme-telemetry-log.txt
+++ b/Documentation/nvme-telemetry-log.txt
@@ -8,8 +8,9 @@ nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from an NVMe
SYNOPSIS
--------
[verse]
-'nvme telemetry-log' <device> [--output-file=<file> | -o <file>]
- [--host-generate=<gen> | -g <gen>]
+'nvme telemetry-log' <device> [--output-file=<file> | -O <file>]
+ [--host-generate=<gen> | -g <gen>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
@@ -24,7 +25,7 @@ On success, the returned log structure will be in raw binary format _only_ with
OPTIONS
-------
--o <file>::
+-O <file>::
--output-file=<file>::
File name to which raw binary data will be saved to.
@@ -41,6 +42,15 @@ OPTIONS
this option is not specified, the default value is 3, since data area
4 may not be supported.
+-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
--------
* Retrieve Telemetry Host-Initiated data to telemetry_log.bin