1NVME-DEVICE-SELF-(1)              NVMe Manual             NVME-DEVICE-SELF-(1)
2
3
4

NAME

6       nvme-device-self-test - Perform the necessary tests to observe the
7       performance and the parameters
8

SYNOPSIS

10       nvme device-self-test <device> [--namespace-id=<NUM> | -n <NUM>]
11                               [--self-test-code=<NUM> | -s <NUM>]  [--wait | -w]
12

DESCRIPTION

14       Initiates the required test based on the user input.
15
16       The <device> parameter is mandatory and may be either the NVMe
17       character device (ex: /dev/nvme0), or a namespace block device (ex:
18       /dev/nvme0n1).
19
20       On success, the corresponding test is initiated.
21

OPTIONS

23       -n <NUM>, --namespace-id=<NUM>
24           Indicate the namespace in which the device self-test has to be
25           carried out
26
27       -s <NUM>, --self-test-code=<NUM>
28           This field specifies the action taken by the device self-test
29           command : 0h: Show current state of device self-test operation 1h:
30           Start a short device self-test operation 2h: Start a extended
31           device self-test operation eh: Start a vendor specific device
32           self-test operation fh: Abort the device self-test operation
33           Default is 0h.
34
35       -w, --wait
36           Wait for the device self test to complete before exiting The device
37           self-test is aborted by SIGINT signal interrupt for the wait The
38           option is ignored if the abort self-test code option specified.
39

EXAMPLES

41       •   Start a short device self-test in the namespace-id 1:
42
43               # nvme device-self-test /dev/nvme0 -n 1 -s 1
44
45       •   Abort the device self-test operation in the namespace-id 1:
46
47               # nvme device-self-test /dev/nvme0 -n 1 -s 0xf
48

NVME

50       Part of the nvme-user suite
51
52
53
54NVMe                              09/29/2023              NVME-DEVICE-SELF-(1)
Impressum