diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:41:05 +0000 |
commit | 1cc8413aaf5f8fa6595aece1933462c096e88639 (patch) | |
tree | e97b4f25c511372d73bdd96c389c5f468d99138a /Documentation/nvme-wdc-get-drive-status.1 | |
parent | Initial commit. (diff) | |
download | nvme-cli-1cc8413aaf5f8fa6595aece1933462c096e88639.tar.xz nvme-cli-1cc8413aaf5f8fa6595aece1933462c096e88639.zip |
Adding upstream version 2.4+really2.3.upstream/2.4+really2.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-wdc-get-drive-status.1')
-rw-r--r-- | Documentation/nvme-wdc-get-drive-status.1 | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-get-drive-status.1 b/Documentation/nvme-wdc-get-drive-status.1 new file mode 100644 index 0000000..03f04e9 --- /dev/null +++ b/Documentation/nvme-wdc-get-drive-status.1 @@ -0,0 +1,122 @@ +'\" t +.\" Title: nvme-wdc-get-drive-status +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/30/2023 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-GET\-DRIV" "1" "01/30/2023" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-get-drive-status \- Send the NVMe WDC get\-drive\-status command, return result +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc get\-drive\-status\fR <device> +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send the unique WDC get\-drive\-status command and provide the additional drive status information\&. +.sp +The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OUTPUT EXPLANATION" +.TS +allbox tab(:); +ltB ltB. +T{ +Field +T}:T{ +Description +T} +.T& +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +\fBPercent Life Used\&.\fR +T}:T{ +.sp +The percentage of drive function used\&. +T} +T{ +.sp +\fBEOL (End of Life) Status\fR +T}:T{ +.sp +The 3 possible states are : Normal, Read Only, or End of Life\&. +T} +T{ +.sp +\fBAssert Dump Status\fR +T}:T{ +.sp +The 2 possible states are : Present or Not Present\&. +T} +T{ +.sp +\fBThermal Throttling Status\fR +T}:T{ +.sp +The 3 possible states are : Off, On, or Unavailable\&. +T} +T{ +.sp +\fBFormat Corrupt Reason\fR +T}:T{ +.sp +The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason\&. +T} +.TE +.sp 1 +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue WDC get\-drive\-status command : +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc get\-drive\-status /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. |