| 1 |
.TH "nvme_format_nvm" 9 "nvme_format_nvm" "November 2025" "libnvme API manual" LINUX |
| 2 |
.SH NAME |
| 3 |
nvme_format_nvm \- Format nvme namespace(s) |
| 4 |
.SH SYNOPSIS |
| 5 |
.B "int" nvme_format_nvm |
| 6 |
.BI "(struct nvme_format_nvm_args *args " ");" |
| 7 |
.SH ARGUMENTS |
| 8 |
.IP "args" 12 |
| 9 |
\fIstruct nvme_format_nvme_args\fP argument structure |
| 10 |
.SH "DESCRIPTION" |
| 11 |
The Format NVM command low level formats the NVM media. This command is used |
| 12 |
by the host to change the LBA data size and/or metadata size. A low level |
| 13 |
format may destroy all data and metadata associated with all namespaces or |
| 14 |
only the specific namespace associated with the command |
| 15 |
.SH "RETURN" |
| 16 |
The nvme command status if a response was received (see |
| 17 |
\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |