summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-drive-log.txt
blob: 0587df9fddebfdbf03d2e71e4da935e2d72a9e85 (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
nvme-wdc-drive-log(1)
=====================

NAME
----
nvme-wdc-drive-log - Retrieve WDC device's drive log and save to file.

SYNOPSIS
--------
[verse]
'nvme wdc drive-log' <device> [--output-file=<FILE>, -o <FILE>]

DESCRIPTION
-----------
For the NVMe device given, sends the wdc vendor unique drive log
request and saves the result to a file.

The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).

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 "drive_log" suffix

EXAMPLES
--------
* Gets the drive log from the device and saves to default file in current directory (e.g. STM00019F3F9drive_log.bin):
+
------------
# nvme wdc drive-log /dev/nvme0
------------
* Gets the drive log from the device and saves to defined file in current directory (e.g. testSTM00019F3F9drive_log.bin):
+
------------
# nvme wdc drive-log /dev/nvme0 -o test
------------
* Gets the drive log from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9drive_log.bin):
+
------------
# nvme wdc drive-log /dev/nvme0 -o /tmp/test
------------

NVME
----
Part of the nvme-user suite