Section 1 · User commands

nvme-sanitize-log.1

Package: nvme-cli

On this page

NVME−SANITIZE−LOG

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

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.

Sanitize Progress − percentage complete

On success it returns 0, error code otherwise.

−r, −−rae

Retain an Asynchronous Event.

−H, −−human−readable

This option will parse and format many of the bit fields into human−readable formats.

−b, −−raw−binary

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

−o <fmt>, −−output−format=<fmt>

Set the reporting format to normal, json or binary. Only one output format can be used at a time.

−v, −−verbose

Increase the information detail in the output.

• Has the program issue Sanitize−log Command :

Part of the nvme−user suite.