summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-get-crash-dump.txt
blob: 109daca41338adcfa1f90211f75622159e500576 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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