---
name: "nvme_mi_admin_sanitize_nvm"
section: "2"
platform: "linux"
package: "libnvme-dev"
version: "1.13-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/nvme_mi_admin_sanitize_nvm"
---

# nvme\_mi\_admin\_sanitize\_nvm(2)

Start a subsystem Sanitize operation

## NAME

nvme\_mi\_admin\_sanitize\_nvm - 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.