summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-get-drive-status.txt
blob: f8a37d686cf405e453183e30c56345e4fa3e85fc (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
53
54
55
56
57
58
59
60
nvme-wdc-get-drive-status(1)
============================

NAME
----
nvme-wdc-get-drive-status - Send the NVMe WDC get-drive-status command, return result

SYNOPSIS
--------
[verse]
'nvme wdc get-drive-status' <device>

DESCRIPTION
-----------
For the NVMe device given, send the unique WDC get-drive-status command and
provide the additional drive status information.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0).

This will only work on WDC devices supporting this feature.
Results for any other device are undefined.

On success it returns 0, error code otherwise.

Output Explanation
------------------
[cols="2*", frame="topbot", align="center", options="header"]
|===
|Field |Description

|*Percent Life Used.*
|The percentage of drive function used.

|*EOL (End of Life) Status*
|The 3 possible states are :  Normal, Read Only, or End of Life.

|*Assert Dump Status*
|The 2 possible states are :  Present or Not Present.

|*Thermal Throttling Status*
|The 3 possible states are :  Off, On, or Unavaiable.

|*Format Corrupt Reason*
|The 3 possible states are :  Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.

|===


EXAMPLES
--------
* Has the program issue WDC get-drive-status command :
+
------------
# nvme wdc get-drive-status /dev/nvme0
------------

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