summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-solidigm-vs-drive-info.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-11-09 08:09:56 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-11-09 08:09:56 +0000
commit2822061d0e17d5acdbc46740b535021115f11071 (patch)
tree8c14f8690f3689562c5fd1d550e1883629ced2a8 /Documentation/nvme-solidigm-vs-drive-info.txt
parentAdding upstream version 2.10.2. (diff)
downloadnvme-cli-2822061d0e17d5acdbc46740b535021115f11071.tar.xz
nvme-cli-2822061d0e17d5acdbc46740b535021115f11071.zip
Adding upstream version 2.11.upstream/2.11upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-solidigm-vs-drive-info.txt')
-rw-r--r--Documentation/nvme-solidigm-vs-drive-info.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/nvme-solidigm-vs-drive-info.txt b/Documentation/nvme-solidigm-vs-drive-info.txt
new file mode 100644
index 0000000..8096b13
--- /dev/null
+++ b/Documentation/nvme-solidigm-vs-drive-info.txt
@@ -0,0 +1,45 @@
+nvme-solidigm-vs-drive-info(1)
+==============================
+
+NAME
+----
+nvme-solidigm-vs-drive-info - Retrieve drive information
+
+SYNOPSIS
+--------
+[verse]
+'nvme solidigm vs-drive-info' <device> [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+Retrieves and displays vendor-specific drive information for the given Solidigm
+NVMe device. This command provides additional details about the drive that may
+not be available through standard NVMe commands.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal' or 'json'. Only one output format
+ can be used at a time.
+
+EXAMPLES
+--------
+* Retrieve and display the drive information:
++
+------------
+# nvme solidigm vs-drive-info /dev/nvme0
+------------
+
+* Retrieve the drive information in JSON format:
++
+------------
+# nvme solidigm vs-drive-info /dev/nvme0 -o json
+------------
+
+NVME
+----
+Part of the nvme-user suite \ No newline at end of file