1nvme_mi_admin_sanitize_nvm(9) libnvme API manual nvme_mi_admin_sanitize_nvm(9)
2
3
4
6 nvme_mi_admin_sanitize_nvm - Start a subsystem Sanitize operation
7
9 int nvme_mi_admin_sanitize_nvm (nvme_mi_ctrl_t ctrl , struct nvme_sani‐
10 tize_nvm_args *args );
11
13 ctrl Controller to send command to
14
15 args Sanitize command arguments
16
18 A sanitize operation alters all user data in the NVM subsystem such
19 that recovery of any previous user data from any cache, the non-
20 volatile media, or any Controller Memory Buffer is not possible.
21
22 The Sanitize command starts a sanitize operation or to recover from a
23 previously failed sanitize operation. The sanitize operation types that
24 may be supported are Block Erase, Crypto Erase, and Overwrite. All san‐
25 itize operations are processed in the background, i.e., completion of
26 the sanitize command does not indicate completion of the sanitize oper‐
27 ation.
28
30 The nvme command status if a response was received (see enum nvme_sta‐
31 tus_field) or -1 with errno set otherwise.
32
33
34
35November 2022 nvme_mi_admin_sanitize_nnvvmme_mi_admin_sanitize_nvm(9)