nvme (1) - Linux Manuals

nvme: the dumb pci-e storage utility

Command to display nvme manual in Linux: $ man 1 nvme

NAME

nvme - the dumb pci-e storage utility

SYNOPSIS

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

DESCRIPTION

NVM-Express is a fast, scalable host controller interface designed to address the needs for PCI Express based solid state drives.

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

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-smart-log(1)

: Retrieve Smart 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-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-list(1)

: List all nvme controllers

nvme-list-ctrl(1)

: List controller in NVMe subsystem

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-set-feature(1)

: Set Feature

nvme-show-regs(1)

: Show NVMe Controller Registers

FURTHER DOCUMENTATION

See the freely available references on the m[blue]Official NVM-Express Sitem[][1].

AUTHORS

This is written and maintained by m[blue]Keith Buschm[][2].

REPORTING BUGS

Patches and issues may be submitted to the official repository at m[blue]https://github.com/linux-nvme/nvme-clim[].

NVME

Part of the nvme suite

NOTES

1.

Official NVM-Express Site

: http://nvmexpress.org

2.

Keith Busch

: mailto:keith.busch [at] intel.com