Debian Codegraph @

doc/man/nvme_mi_admin_format_nvm.2

raw
1 .TH "nvme_mi_admin_format_nvm" 9 "nvme_mi_admin_format_nvm" "November 2025" "libnvme API manual" LINUX
2 .SH NAME
3 nvme_mi_admin_format_nvm \- Format NVMe namespace
4 .SH SYNOPSIS
5 .B "int" nvme_mi_admin_format_nvm
6 .BI "(nvme_mi_ctrl_t ctrl " ","
7 .BI "struct nvme_format_nvm_args *args " ");"
8 .SH ARGUMENTS
9 .IP "ctrl" 12
10 Controller to send command to
11 .IP "args" 12
12 Format NVM command arguments
13 .SH "DESCRIPTION"
14 Perform a low-level format to set the LBA data & metadata size. May destroy
15 data & metadata on the specified namespaces
16 .SH "RETURN"
17 The nvme command status if a response was received (see
18 \fIenum nvme_status_field\fP) or -1 with errno set otherwise.