diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
| commit | 1cc8413aaf5f8fa6595aece1933462c096e88639 (patch) | |
| tree | e97b4f25c511372d73bdd96c389c5f468d99138a /Documentation/nvme-self-test-log.txt | |
| parent | Initial commit. (diff) | |
| download | nvme-cli-1cc8413aaf5f8fa6595aece1933462c096e88639.tar.xz nvme-cli-1cc8413aaf5f8fa6595aece1933462c096e88639.zip | |
Adding upstream version 2.4+really2.3.upstream/2.4+really2.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-self-test-log.txt')
| -rw-r--r-- | Documentation/nvme-self-test-log.txt | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/Documentation/nvme-self-test-log.txt b/Documentation/nvme-self-test-log.txt new file mode 100644 index 0000000..56a3c4a --- /dev/null +++ b/Documentation/nvme-self-test-log.txt @@ -0,0 +1,68 @@ +nvme-self-test-log(1) +===================== + +NAME +---- +nvme-self-test-log - Retrieve the log information initiated by device-self-test and display it + +SYNOPSIS +-------- +[verse] +'nvme self-test'-log <device> [--log-entries=<entries> | -e <entries>] + [--output-format=<FMT> | -o <FMT>] + +DESCRIPTION +----------- +Retrieves the log pages from an NVMe device corresponding to the +requested self-test by the user and provides 20-most recent result +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 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 or the +json format. + +By default the log is printed out in the normal readable format. + +OPTION +------- +-e <entries>:: +--log-entries=<entries>:: + Specifies how many DST log entries the program should request from + the device. This must be at least one, and shouldn't exceed the + 20 entries. Defaults to 20 DST log entries. + +-o <format>:: +--output-format=<format>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + + +EXAMPLES +-------- +* Get the self-test-log and print it in a human readable format: ++ +------------ +# nvme self-test-log /dev/nvme0 +------------ ++ + +* Print the raw output to a file: ++ +------------ +# nvme self-test-log /dev/nvme0 -o "binary" +------------ ++ + +* Get the self-test-log and print it in a json format: ++ +------------ +# nvme self-test-log /dev/nvme0 -o "json" +------------ + +NVME +---- +Part of the nvme-user suite |