summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-micron-internal-log.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:41:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:41:32 +0000
commitf26f66d866ba1a9f3204e6fdfe2b07e67b5492ad (patch)
treec953c007cbe4f60a147ab62f97937d58abb2e9ca /Documentation/nvme-micron-internal-log.txt
parentInitial commit. (diff)
downloadnvme-cli-f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad.tar.xz
nvme-cli-f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad.zip
Adding upstream version 2.8.upstream/2.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-micron-internal-log.txt')
-rw-r--r--Documentation/nvme-micron-internal-log.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/nvme-micron-internal-log.txt b/Documentation/nvme-micron-internal-log.txt
new file mode 100644
index 0000000..b8e9228
--- /dev/null
+++ b/Documentation/nvme-micron-internal-log.txt
@@ -0,0 +1,45 @@
+nvme-micron-internal-log(1)
+==========================
+
+NAME
+----
+nvme-micron-internal-log - Retrieve Micron device's internal logs and save to
+given zip file.
+
+SYNOPSIS
+--------
+[verse]
+'nvme micron vs-internal-log' <device> [--package=<FILE>, -p <FILE>]
+
+DESCRIPTION
+-----------
+For the given NVMe device, sends the Micron vendor specific device commands to
+retrieve various logs (in binary format) and compresses them and saves into
+specified zip file. These vendor unique logs can be analyzed with Micron
+Technical support team for any device specific issues.
+
+The <device> parameter is mandatory and may be either the NVMe
+character device (ex: /dev/nvme0), or a namespace block device (ex:
+/dev/nvme0n1).
+
+This will only work on Micron devices devices of model numbers 9200 and 54XX.
+Support for new devices may be added subsequently. Results for any other device
+are undefined.
+
+OPTIONS
+-------
+-l <FILE>::
+--package=<FILE>::
+ name of the file (with .zip extension) to save the device logs
+
+EXAMPLES
+--------
+* Gets the logs from the device and saves to micron_logs.zip file
++
+------------
+# nvme micron vs-internal-log /dev/nvme0 --package=micron_logs.zip
+
+------------
+NVME
+----
+Part of the nvme-user suite