| 1 |
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "November 2025" "libnvme API manual" LINUX |
| 2 |
.SH NAME |
| 3 |
nvme_dev_self_test \- Start or abort a self test |
| 4 |
.SH SYNOPSIS |
| 5 |
.B "int" nvme_dev_self_test |
| 6 |
.BI "(struct nvme_dev_self_test_args *args " ");" |
| 7 |
.SH ARGUMENTS |
| 8 |
.IP "args" 12 |
| 9 |
\fIstruct nvme_dev_self_test\fP argument structure |
| 10 |
.SH "DESCRIPTION" |
| 11 |
The Device Self-test command starts a device self-test operation or abort a |
| 12 |
device self-test operation. A device self-test operation is a diagnostic |
| 13 |
testing sequence that tests the integrity and functionality of the |
| 14 |
controller and may include testing of the media associated with namespaces. |
| 15 |
The controller may return a response to this command immediately while |
| 16 |
running the self-test in the background. |
| 17 |
|
| 18 |
Set the 'nsid' field to 0 to not include namespaces in the test. Set to |
| 19 |
0xffffffff to test all namespaces. All other values tests a specific |
| 20 |
namespace, if present. |
| 21 |
.SH "RETURN" |
| 22 |
The nvme command status if a response was received (see |
| 23 |
\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |