NVME-LOG-SANITIZE(1)              NVMe Manual             NVME-LOG-SANITIZE(1)

NAME
       nvme-log-sanitize - Send NVMe sanitize-log Command, return result

SYNOPSIS
       nvme [<global-options>] log sanitize <device> [--rae | -r]
                               [--raw-binary | -b]

DESCRIPTION
       Retrieves the NVMe Sanitize log page from an NVMe device and provides
       the status of sanitize command.

       The <device> parameter is mandatory NVMe character device (ex:
       /dev/nvme0).

       Expected status and description :-

       +------------+----------------------------+
       |Status Code | Description                |
       +------------+----------------------------+
       |0x0000      | NVM subsystem has never    |
       |            | been sanitized.            |
       +------------+----------------------------+
       |0x0001      | The most recent sanitize   |
       |            | operation completed        |
       |            | successfully.              |
       +------------+----------------------------+
       |0x0002      | A sanitize operation is    |
       |            | currently in progress.     |
       +------------+----------------------------+
       |0x0003      | The most recent sanitize   |
       |            | operation failed.          |
       +------------+----------------------------+
       |0x0100      | Global Data Erased bit If  |
       |            | set to 1 then non-volatile |
       |            | storage in the NVM         |
       |            | subsystem has not been     |
       |            | written to: a) since being |
       |            | manufactured and the NVM   |
       |            | subsystem has never been   |
       |            | sanitized; or b) since the |
       |            | most recent successful     |
       |            | sanitize operation. If     |
       |            | cleared to 0, then         |
       |            | non-volatile storage in    |
       |            | the NVM subsystem has been |
       |            | written to: a) since being |
       |            | manufactured and the NVM   |
       |            | subsystem has never been   |
       |            | sanitized; or b) since the |
       |            | most recent successful     |
       |            | sanitize operation of the  |
       |            | NVM subsystem.             |
       +------------+----------------------------+
       |0x0800      | Purged (PRGD) bit If set   |
       |            | to 1, then the most recent |
       |            | sanitize operation purged  |
       |            | user data, as defined by   |
       |            | IEEE Std 2883, because the |
       |            | Purge Required (PREQ) bit  |
       |            | was set to 1 in the        |
       |            | command that started that  |
       |            | sanitize operation. If     |
       |            | cleared to 0, either PREQ  |
       |            | was not set, or the        |
       |            | sanitize operation cleared |
       |            | (rather than purged) user  |
       |            | data.                      |
       +------------+----------------------------+

       Sanitize Progress - percentage complete

       On success it returns 0, error code otherwise.

OPTIONS
       -r, --rae
           Retain an Asynchronous Event.

       -b, --raw-binary
           Print the raw buffer to stdout. Structure is not parsed by program.
           This overrides the vendor specific and human readable options.

GLOBAL OPTIONS
       The following options are defined at the top-level nvme command and are
       available to this subcommand:

       --dry-run
           Print the command that would be executed, but do not actually
           execute it.

       --no-ioctl-probing
           Disable probing for 64-bit IOCTL support.

       --no-retries
           Disable retry logic on transient errors.

       -o <fmt>, --output-format=<fmt>
           Set the reporting format to normal, tabular, 'json, or binary. Only
           one output format may be used at a time.

       --output-format-version=<version>
           Select the output format version. Version 1 uses the original field
           naming, while version 2 (default) provides more consistent and
           script-friendly field names.

       --timeout=<ms>
           Set the timeout for the command in milliseconds.

       -v, --verbose
           Increase the level of detail in the output. May be specified
           multiple times to further increase verbosity.

       These options can also be set as machine-wide defaults in
       nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES
       o   Has the program issue Sanitize-log Command :

               # nvme log sanitize /dev/nvme0

NVME
       Part of the nvme-user suite.

NVMe                              09/07/2026              NVME-LOG-SANITIZE(1)