diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:41:32 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:41:32 +0000 |
| commit | f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad (patch) | |
| tree | c953c007cbe4f60a147ab62f97937d58abb2e9ca /Documentation/nvme-wdc-get-crash-dump.txt | |
| parent | Initial commit. (diff) | |
| download | nvme-cli-upstream/2.8.tar.xz nvme-cli-upstream/2.8.zip | |
Adding upstream version 2.8.upstream/2.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
| -rw-r--r-- | Documentation/nvme-wdc-get-crash-dump.txt | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-get-crash-dump.txt b/Documentation/nvme-wdc-get-crash-dump.txt new file mode 100644 index 0000000..109daca --- /dev/null +++ b/Documentation/nvme-wdc-get-crash-dump.txt @@ -0,0 +1,52 @@ +nvme-wdc-get-crash-dump(1) +========================== + +NAME +---- +nvme-wdc-get-crash-dump - Retrieve WDC device's crash dump. + +SYNOPSIS +-------- +[verse] +'nvme wdc get-crash-dump' <device> [--output-file=<FILE>, -o <FILE>] + +DESCRIPTION +----------- +For the NVMe device given, sends the WDC vendor unique crash dump +request and saves the result to file. In current implementation crash dump is +captured if it is present. On success it will save the dump in file with +appropriate suffix. Note that this command will clear the available +dump from the device on success. + +The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +OPTIONS +------- +-o <FILE>:: +--output-file=<FILE>:: + Output file; defaults to device serial number followed by "crash_dump" suffix + +EXAMPLES +-------- +* Gets the crash dump from the device and saves to default file in current directory (e.g. STM00019F3F9crash_dump.bin): ++ +------------ +# nvme wdc get-crash-dump /dev/nvme0 +------------ +* Gets the crash dump from the device and saves to defined file in current directory (e.g. testSTM00019F3F9crash_dump.bin): ++ +------------ +# nvme wdc get-crash-dump /dev/nvme0 -o test +------------ +* Gets the crash dump from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9crash_dump.bin): ++ +------------ +# nvme wdc get-crash-dump /dev/nvme0 -o /tmp/test +------------ + +NVME +---- +Part of the nvme-user suite |