---
name: "nvme_mi_admin_format_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_format_nvm"
---

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

Format NVMe namespace

## NAME

nvme\_mi\_admin\_format\_nvm - Format NVMe namespace

## SYNOPSIS

**int nvme\_mi\_admin\_format\_nvm** **(nvme\_mi\_ctrl\_t ctrl** *,* **struct nvme\_format\_nvm\_args \*args** *);*

## ARGUMENTS

- ctrl

  Controller to send command to

- args

  Format NVM command arguments

## DESCRIPTION

Perform a low-level format to set the LBA data & metadata size. May destroy data & metadata on the specified namespaces

## RETURN

The nvme command status if a response was received (see *enum nvme\_status\_field*) or -1 with errno set otherwise.
