| 1 |
.TH "nvme_mi_admin_sanitize_nvm" 9 "nvme_mi_admin_sanitize_nvm" "November 2025" "libnvme API manual" LINUX |
| 2 |
.SH NAME |
| 3 |
nvme_mi_admin_sanitize_nvm \- Start a subsystem Sanitize operation |
| 4 |
.SH SYNOPSIS |
| 5 |
.B "int" nvme_mi_admin_sanitize_nvm |
| 6 |
.BI "(nvme_mi_ctrl_t ctrl " "," |
| 7 |
.BI "struct nvme_sanitize_nvm_args *args " ");" |
| 8 |
.SH ARGUMENTS |
| 9 |
.IP "ctrl" 12 |
| 10 |
Controller to send command to |
| 11 |
.IP "args" 12 |
| 12 |
Sanitize command arguments |
| 13 |
.SH "DESCRIPTION" |
| 14 |
A sanitize operation alters all user data in the NVM subsystem such that |
| 15 |
recovery of any previous user data from any cache, the non-volatile media, |
| 16 |
or any Controller Memory Buffer is not possible. |
| 17 |
|
| 18 |
The Sanitize command starts a sanitize operation or to recover from a |
| 19 |
previously failed sanitize operation. The sanitize operation types that may |
| 20 |
be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize |
| 21 |
operations are processed in the background, i.e., completion of the sanitize |
| 22 |
command does not indicate completion of the sanitize operation. |
| 23 |
.SH "RETURN" |
| 24 |
The nvme command status if a response was received (see |
| 25 |
\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |