nvme_mi_admin_sanitize_nvm - Man Page

Start a subsystem Sanitize operation

Synopsis

int nvme_mi_admin_sanitize_nvm (nvme_mi_ctrl_t ctrl , struct nvme_sanitize_nvm_args *args );

Arguments

ctrl

Controller to send command to

args

Sanitize command arguments

Description

A sanitize operation alters all user data in the NVM subsystem such that recovery of any previous user data from any cache, the non-volatile media, or any Controller Memory Buffer is not possible.

The Sanitize command starts a sanitize operation or to recover from a previously failed sanitize operation. The sanitize operation types that may be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize operations are processed in the background, i.e., completion of the sanitize command does not indicate completion of the sanitize operation.

Return

The nvme command status if a response was received (see enum nvme_status_field) or -1 with errno set otherwise.

Info

November 2022 libnvme API manual