# nvme(1)

# nvme(1) Manual Page

## NAME

nvme - the NVMe storage command line interface utility (nvme-cli)

## SYNOPSIS

built-in plugin:

    nvme <command> <device> [<args>]

extension plugins:

    nvme <plugin> <command> <device> [<args>]

## DESCRIPTION

NVM-Express is a fast, scalable host controller interface designed to address the needs for not only PCI Express based solid state drives, but also NVMe-oF(over fabrics).

This nvme program is a user space utility to provide standards compliant tooling for NVM-Express drives. It was made specifically for Linux as it relies on the IOCTLs defined by the mainline kernel driver.

## NVME COMMANDS

The utility has sub-commands for all admin and io commands defined in the specification and for displaying controller registers. There is also an option to submit completely arbitrary commands. For a list of commands available, run "nvme help".

## nvme cli sub-commands

### Main commands

nvme-admin-passthru(1)

  Admin Passthrough Command

nvme-compare(1)

  IO Compare

nvme-error-log(1)

  Retrieve error logs

nvme-flush(1)

  Submit flush

nvme-dms(1)

  Submit Data Set Management

nvme-format(1)

  Format namespace(s)

nvme-fw-activate(1)

  F/W Activate (in old version < 1.2)

nvme-fw-commit(1)

  F/W Commit (in > 1.2)

nvme-fw-download(1)

  F/W Download

nvme-fw-log(1)

  Retrieve f/w log

nvme-get-feature(1)

  Get Features

nvme-get-log(1)

  Generic Get Log

nvme-telemetry-log(1)

  Telemetry Host-Initiated Log

nvme-changed-ns-list-log(1)

  Retrieve Changed Namespace List Log

nvme-smart-log(1)

  Retrieve Smart Log

nvme-ana-log(1)

  Retreive ANA(Asymmetric Namespace Access) Log

nvme-endurance-log(1)

  Retrieve endurance Log

nvme-effects-log(1)

  Retrieve effects Log

nvme-self-test-log(1)

  Retrieve Device Self-test Log

nvme-get-ns-id(1)

  Retrieve namespace identifier

nvme-help(1)

  NVMe CLI Help

nvme-id-ctrl(1)

  Identify Controller

nvme-id-ns(1)

  Identify Namespace

nvme-id-nvmset(1)

  Identify NVM Set List

nvme-id-iocs(1)

  Identify I/O Command Set

nvme-create-ns(1)

  Create a new namespace

nvme-delete-ns(1)

  Delete existing namespace

nvme-attach-ns(1)

  Attach namespace

nvme-detach-ns(1)

  Detach namespace

nvme-io-passthru(1)

  IO Passthrough Command

nvme-list-ns(1)

  List all nvme namespaces

nvme-ns-descs(1)

  Identify Namespace Identification Descriptor

nvme-list(1)

  List all nvme controllers

nvme-list-ctrl(1)

  List controller in NVMe subsystem

nvme-list-subsys(1)

  List NVMe subsystems

nvme-reset(1)

  Reset a NVMe controller

nvme-device-self-test(1)

  Issue Device Self-test Command

nvme-read(1)

  Issue IO Read Command

nvme-write(1)

  Issue IO Write Command

nvme-write-zeroes(1)

  Issue IO Write Zeroes Command

nvme-write-uncor(1)

  Issue IO Write Uncorrectable Command

nvme-resv-acquire(1)

  Acquire Namespace Reservation

nvme-resv-register(1)

  Register Namespace Reservation

nvme-resv-release(1)

  Release Namespace Reservation

nvme-resv-report(1)

  Report Reservation Capabilities

nvme-security-recv(1)

  Security Receive

nvme-security-send(1)

  Security Send

nvme-dsm(1)

  Issue Data Set Management Command

nvme-copy(1)

  Issue Simple Copy Command

nvme-set-feature(1)

  Set Feature

nvme-show-regs(1)

  Show NVMe Controller Registers

nvme-discover(1)

  Send Get Log Page request to Discovery Controller

nvme-connect-all(1)

  Discover and connect to all NVMe-over-Fabrics subsystems

nvme-connect(1)

  Connect to an NVMe-over-Fabrics subsystem

nvme-disconnect(1)

  Disconnect from an NVMe-over-Fabrics subsystem

nvme-disconnect-all(1)

  Disconnect from all NVMe-over-Fabrics subsystems

nvme-get-property(1)

  Reads and shows NVMe-over-Fabrics controller property

## FURTHER DOCUMENTATION

See the freely available references on the Official NVM-Express Site.

## Authors

This is written and maintained by Keith Busch.

## Reporting Bugs

Patches and issues may be submitted to the official repository at https://github.com/linux-nvme/nvme-cli or the Linux NVMe mailing list linux-nvme

## NVME

Part of the nvme suite