summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-device-self-test.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
commitdc597ce8df5ae6efd2728a2d7ba7d92486028f79 (patch)
tree55b9e9257eba4579667f9522368aa29f5be6754a /Documentation/nvme-device-self-test.txt
parentInitial commit. (diff)
downloadnvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.tar.xz
nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.zip
Adding upstream version 1.12.upstream/1.12
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-device-self-test.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/Documentation/nvme-device-self-test.txt b/Documentation/nvme-device-self-test.txt
new file mode 100644
index 0000000..b7273a0
--- /dev/null
+++ b/Documentation/nvme-device-self-test.txt
@@ -0,0 +1,55 @@
+nvme-device-self-test(1)
+========================
+
+NAME
+----
+nvme-device-self-test - Perform the necessary tests to observe the performance and the parameters
+
+SYNOPSIS
+--------
+[verse]
+'nvme device-self-test' <device> [--namespace-id=<NUM> | -n <NUM>]
+ [--self-test-code=<NUM> | -s <NUM>]
+
+DESCRIPTION
+-----------
+Initiates the required test based on the user input.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the corresponding test is initiated.
+
+OPTIONS
+-------
+-n <NUM>::
+--namespace-id=<NUM>::
+ Indicate the namespace in which the device self-test has to becarried out
+
+-s <NUM>::
+--self-test-code=<NUM>::
+ This field specifies the action taken by the device self-test command :
+ 1h: Start a short device self-test operation
+ 2h: Start a extended device self-test operation
+ eh: Start a vendor specific device self-test operation
+ fh: abort the device self-test operation
+
+
+EXAMPLES
+--------
+* Start a short device self-test in the namespace-id 1:
++
+------------
+# nvme device-self-test /dev/nvme0 -n 1 -s 1
+------------
++
+
+* Abort the device self-test operation in the namespace-id 1:
++
+------------
+# nvme device-self-test /dev/nvme0 -n 1 -s 0xf
+------------
+
+NVME
+----
+Part of the nvme-user suite