Blame Documentation/nvme-wdc-get-drive-status.txt

Packit Service b7b338
nvme-wdc-get-drive-status(1)
Packit Service b7b338
============================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-wdc-get-drive-status - Send the NVMe WDC get-drive-status command, return result
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme wdc get-drive-status' <device>
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
For the NVMe device given, send the unique WDC get-drive-status command and
Packit Service b7b338
provide the additional drive status information.
Packit Service b7b338
Packit Service b7b338
The <device> parameter is mandatory and may be either the NVMe character
Packit Service b7b338
device (ex: /dev/nvme0).
Packit Service b7b338
Packit Service b7b338
This will only work on WDC devices supporting this feature.
Packit Service b7b338
Results for any other device are undefined.
Packit Service b7b338
Packit Service b7b338
On success it returns 0, error code otherwise.
Packit Service b7b338
Packit Service b7b338
Output Explanation
Packit Service b7b338
------------------
Packit Service b7b338
[cols="2*", frame="topbot", align="center", options="header"]
Packit Service b7b338
|===
Packit Service b7b338
|Field |Description
Packit Service b7b338
Packit Service b7b338
|*Percent Life Used.*
Packit Service b7b338
|The percentage of drive function used.
Packit Service b7b338
Packit Service b7b338
|*EOL (End of Life) Status*
Packit Service b7b338
|The 3 possible states are :  Normal, Read Only, or End of Life.
Packit Service b7b338
Packit Service b7b338
|*Assert Dump Status*
Packit Service b7b338
|The 2 possible states are :  Present or Not Present.
Packit Service b7b338
Packit Service b7b338
|*Thermal Throttling Status*
Packit Service b7b338
|The 3 possible states are :  Off, On, or Unavaiable.
Packit Service b7b338
Packit Service b7b338
|*Format Corrupt Reason*
Packit Service b7b338
|The 3 possible states are :  Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.
Packit Service b7b338
Packit Service b7b338
|===
Packit Service b7b338
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
* Has the program issue WDC get-drive-status command :
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme wdc get-drive-status /dev/nvme0
Packit Service b7b338
------------
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite.