diff options
Diffstat (limited to 'Documentation/nvme-telemetry-log.txt')
| -rw-r--r-- | Documentation/nvme-telemetry-log.txt | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/Documentation/nvme-telemetry-log.txt b/Documentation/nvme-telemetry-log.txt new file mode 100644 index 0000000..4d2a494 --- /dev/null +++ b/Documentation/nvme-telemetry-log.txt @@ -0,0 +1,64 @@ +nvme-telemetry-log(1) +===================== + +NAME +---- +nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from an NVMe device + +SYNOPSIS +-------- +[verse] +'nvme telemetry-log' <device> [--output-file=<file> | -O <file>] + [--host-generate=<gen> | -g <gen>] + [--output-format=<fmt> | -o <fmt>] [--verbose | -v] + +DESCRIPTION +----------- +Retrieves an Telemetry Host-Initiated 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 log structure will be in raw binary format _only_ with +--output-file option which is mandatory. + +OPTIONS +------- +-O <file>:: +--output-file=<file>:: + File name to which raw binary data will be saved to. + +-g <gen>:: +--host-generate=<gen>:: + If set to 1, controller shall capture the Telemetry Host-Initiated data + representing the internal state of the controller at the time the + associated Get Log Page command is processed. + If cleated to 0, controller shall _not_ update this data. + +-d <da>:: +--data-area=<da>:: + Retrieves the specific data area requested. Valid inputs are 1,2,3,4. If + 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 ++ +------------ +# nvme telemetry-log /dev/nvme0 --output-file=telemetry_log.bin +------------ + +NVME +---- +Part of the nvme-user suite |