Blame Documentation/nvme-device-self-test.txt

Packit Service b7b338
nvme-device-self-test(1)
Packit Service b7b338
========================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-device-self-test - Perform the necessary tests to observe the performance and the parameters
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme device-self-test' <device> [--namespace-id=<NUM> | -n <NUM>]
Packit Service b7b338
			[--self-test-code=<NUM> | -s <NUM>] 
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
Initiates the required test based on the user input.
Packit Service b7b338
Packit Service b7b338
The <device> parameter is mandatory and may be either the NVMe character
Packit Service b7b338
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
Packit Service b7b338
Packit Service b7b338
On success, the corresponding test is initiated.
Packit Service b7b338
Packit Service b7b338
OPTIONS
Packit Service b7b338
-------
Packit Service b7b338
-n <NUM>::
Packit Service b7b338
--namespace-id=<NUM>::
Packit Service b7b338
	Indicate the namespace in which the device self-test has to becarried out
Packit Service b7b338
Packit Service b7b338
-s <NUM>::
Packit Service b7b338
--self-test-code=<NUM>::
Packit Service b7b338
        This field specifies the action taken by the device self-test command : 
Packit Service b7b338
         1h: Start a short device self-test operation
Packit Service b7b338
         2h: Start a extended device self-test operation
Packit Service b7b338
         eh: Start a vendor specific device self-test operation
Packit Service b7b338
         fh: abort the device self-test operation
Packit Service b7b338
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
* Start a short device self-test in the namespace-id 1:
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme device-self-test /dev/nvme0 -n 1 -s 1
Packit Service b7b338
------------
Packit Service b7b338
+
Packit Service b7b338
Packit Service b7b338
* Abort the device self-test operation in the namespace-id 1:
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme device-self-test /dev/nvme0 -n 1 -s 0xf
Packit Service b7b338
------------
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite