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

# nvme\_format\_nvm(2)

Format nvme namespace(s)

## NAME

nvme\_format\_nvm - Format nvme namespace(s)

## SYNOPSIS

**int nvme\_format\_nvm** **(struct nvme\_format\_nvm\_args \*args** *);*

## ARGUMENTS

- args

  *struct nvme\_format\_nvme\_args* argument structure

## DESCRIPTION

The Format NVM command low level formats the NVM media. This command is used by the host to change the LBA data size and/or metadata size. A low level format may destroy all data and metadata associated with all namespaces or only the specific namespace associated with the command

## RETURN

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