summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-vs-internal-log.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:49:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:49:35 +0000
commitf2c543b4ccad3b9f8871d952cddf66b3b438595b (patch)
treec3c363d1cc72514221685c42a79a19b320114acc /Documentation/nvme-wdc-vs-internal-log.txt
parentAdding debian version 1.12-8. (diff)
downloadnvme-cli-f2c543b4ccad3b9f8871d952cddf66b3b438595b.tar.xz
nvme-cli-f2c543b4ccad3b9f8871d952cddf66b3b438595b.zip
Merging upstream version 1.14.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-wdc-vs-internal-log.txt')
-rw-r--r--Documentation/nvme-wdc-vs-internal-log.txt30
1 files changed, 15 insertions, 15 deletions
diff --git a/Documentation/nvme-wdc-vs-internal-log.txt b/Documentation/nvme-wdc-vs-internal-log.txt
index eaeb21e..4fbde38 100644
--- a/Documentation/nvme-wdc-vs-internal-log.txt
+++ b/Documentation/nvme-wdc-vs-internal-log.txt
@@ -8,7 +8,7 @@ nvme-wdc-vs-internal-log - Retrieve WDC device's internal firmware log and save
SYNOPSIS
--------
[verse]
-'nvme wdc vs-internal-log' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+'nvme wdc vs-internal-log' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
[--data-area=<DATA AREA>, -d <DATA_AREA>] [--file-size=<FILE SIZE>, -f <FILE SIZE>] [--offset=<OFFSET>, -e <OFFSET>]
[--type=<TYPE>, -t <type>] [--verbose, -v]
@@ -35,31 +35,31 @@ OPTIONS
-d <DATA AREA>::
--data-area=<DATA AREA>::
- DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will be retrieved. This parameter
- is currently only supported on the SN340, SN640, and SN840 devices.
-
+ DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will be retrieved. This parameter
+ is currently only supported on the SN340, SN640, SN730, and SN840 devices.
+
-f <FILE SIZE>::
--file-size=<FILE SIZE>::
- Specifies the desired size of the data file starting at the passed in offset. This allows the user to
- retrieve the data in several smaller files of the passed in size. This parameter is currently only
- supported on the SN340 device.
+ Specifies the desired size of the data file starting at the passed in offset. This allows the user to
+ retrieve the data in several smaller files of the passed in size. This parameter is currently only
+ supported on the SN340 device.
-e <OFFSET>::
---offset=<OFFSET>::
+--offset=<OFFSET>::
Specifies the data offset at which to start retrieving the data. This parameter is used in combination
- with the file size parameter to retrieve the data in several smaller files. This parameter is currently
- only supported on the SN340 device.
+ with the file size parameter to retrieve the data in several smaller files. This parameter is currently
+ only supported on the SN340 device.
-t <TYPE>::
---type=<TYPE>::
+--type=<TYPE>::
Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter is used to get either the host
generated or controller initiated telemetry log page. If not specified or none is specified, the command
will return the default E6 log data. This parameter is currently only supported on the SN640 and SN840
- devices.
+ devices.
-v <VERBOSE>::
---verbose=<VERBOSE>::
- Provides additional debug messages for certain drives.
+--verbose=<VERBOSE>::
+ Provides additional debug messages for certain drives.
EXAMPLES
--------
@@ -100,7 +100,7 @@ EXAMPLES
------------
# nvme wdc vs-internal-log /dev/nvme1 -t host -o host-telem-log-da3.bin -d 3
------------
-* Gets the controller telemetry log page to data area 3 from the device and stores it in file ctlr-telem-log-da3.bin:
+* Gets the controller telemetry log page to data area 3 from the device and stores it in file ctlr-telem-log-da3.bin:
+
------------
# nvme wdc vs-internal-log /dev/nvme1 -t controller -o ctlr-telem-log-da3.bin -d 3