nvme-capacity-mgmt(1)

nvme-capacity-mgmt1

Send capacity management command to configure/create/delete endurance groups or nvm sets, returns results.

Usage

nvme [<global-options>] capacity-mgmt <device> [{--operation=<operation> | -O <operation>}] [{--element-id=<element-id> | -i <element-id>}] [{--cap-lower=<cap-lower> | -l <cap-lower>}] [{--cap-upper=<cap-upper> | -u <cap-upper>}]

Overview

For the NVMe device given, sends a capacity management command to configure/create/delete the Endurance Groups or NVM Sets with the requested operation and element_id. On success, if the Operation is Create Endurance group or NVM Set, CQE CDW0 contains Created element identifier else CQE CDW0 is reserved.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

Options

-O <operation>, --operation=<operation>

Operation to be performed by the controller

-i <element-id>, --element-id=<element-id>

Value specific to the value of the Operation field.

-l <cap-lower>, --cap-lower=<cap-lower>

Least significant 32 bits of the capacity in bytes of the Endurance Group or NVM Set to be created

-u <cap-upper>, --cap-upper=<cap-upper>

Most significant 32 bits of the capacity in bytes of the Endurance Group or NVM Set to be created

Options

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run

Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing

Disable probing for 64-bit IOCTL support.

--no-retries

Disable retry logic on transient errors.

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

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

--output-format-version=<version>

Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names. Other versions are rejected.

--quiet

Suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level.

--set-options=<key=value>[,<key=value>...]

Set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir.

--timeout=<ms>

Set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff).

-v, --verbose

Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

Examples

No examples provided yet.

Nvme

Part of the nvme-user suite

Releases

3 releases since Debian 12 (Bookworm); the text changed 2 times.

  1. 12
  2. 13
  3. Arch

--dry-run since Arch Linux 2026-11-01; --no-ioctl-probing since Arch Linux 2026-11-01; --no-retries since Arch Linux 2026-11-01; --output-format since Debian 13 (Trixie); --output-format-version since Arch Linux 2026-11-01; --quiet since Arch Linux 2026-11-01; --set-options since Arch Linux 2026-11-01; --timeout since Debian 13 (Trixie); --verbose since Debian 13 (Trixie); -O since Debian 13 (Trixie); -v since Debian 13 (Trixie).

-t until Debian 13 (Trixie).

From nvme-cli 3.2-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.