summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-enc-get-log.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-wdc-enc-get-log.txt')
-rw-r--r--Documentation/nvme-wdc-enc-get-log.txt18
1 files changed, 12 insertions, 6 deletions
diff --git a/Documentation/nvme-wdc-enc-get-log.txt b/Documentation/nvme-wdc-enc-get-log.txt
index ae93a7a..bcff83f 100644
--- a/Documentation/nvme-wdc-enc-get-log.txt
+++ b/Documentation/nvme-wdc-enc-get-log.txt
@@ -3,12 +3,15 @@ nvme-wdc-enc-get-log(1)
NAME
----
-nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return result.
+nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return
+result.
SYNOPSIS
--------
[verse]
-'nvme wdc enc-get-log' <device> [--log-id=<NUM>, -l <NUM>] [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+'nvme wdc enc-get-log' <device> [--log-id=<NUM>, -l <NUM>]
+ [--output-file=<FILE>, -o <FILE>]
+ [--transfer-size=<SIZE>, -s <SIZE>]
DESCRIPTION
-----------
@@ -19,7 +22,8 @@ output the Enclosure logs.
The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0).
-The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.
+The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2,
+0xd3, 0xd4, 0xe2 and 0xe4.
This will only work on WDC devices supporting this feature.
Results for any other device are undefined.
@@ -30,15 +34,17 @@ OPTIONS
-------
-o <FILE>::
--output-file=<FILE>::
- Output file pathname
+ Output file pathname
-s <SIZE>::
--transfer-size=<NUM>::
- Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192)
+ Data retrieval transfer size, maximum transfer size should be 0x2000
+ (decimal 8192)
EXAMPLES
--------
-* Gets the enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory:
+* Gets the enclosure log from the device based on the log id(0xd1) with transfer
+ size(0x2000) and saves to defined file in current directory:
+
------------
# nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -o d1_log.bin -s 0x2000