1. Executable programs or shell commands
NVME
Section: NVMe Manual (1)Updated: 11/11/2021
Index | Return to Main Contents
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
- Admin Passthrough Command
nvme-compare(1)
- IO Compare
- Retrieve error logs
nvme-flush(1)
- Submit flush
nvme-dms(1)
- Submit Data Set Management
nvme-format(1)
- Format namespace(s)
- F/W Activate (in old version < 1.2)
- F/W Commit (in > 1.2)
- F/W Download
nvme-fw-log(1)
- Retrieve f/w log
- Get Features
nvme-get-log(1)
- Generic Get Log
- Telemetry Host-Initiated Log
- Retrieve Changed Namespace List Log
- Retrieve Smart Log
nvme-ana-log(1)
- Retreive ANA(Asymmetric Namespace Access) Log
- Retrieve endurance Log
- Retrieve effects Log
- Retrieve Device Self-test Log
- Retrieve namespace identifier
nvme-help(1)
- NVMe CLI Help
nvme-id-ctrl(1)
- Identify Controller
nvme-id-ns(1)
- Identify Namespace
- Identify NVM Set List
nvme-id-iocs(1)
- Identify I/O Command Set
- Create a new namespace
- Delete existing namespace
- Attach namespace
- Detach namespace
- IO Passthrough Command
nvme-list-ns(1)
- List all nvme namespaces
- Identify Namespace Identification Descriptor
nvme-list(1)
- List all nvme controllers
- List controller in NVMe subsystem
- List NVMe subsystems
nvme-reset(1)
- Reset a NVMe controller
- Issue Device Self-test Command
nvme-read(1)
- Issue IO Read Command
nvme-write(1)
- Issue IO Write Command
- Issue IO Write Zeroes Command
- Issue IO Write Uncorrectable Command
- Acquire Namespace Reservation
- Register Namespace Reservation
- Release Namespace Reservation
- Report Reservation Capabilities
- Security Receive
- Security Send
nvme-dsm(1)
- Issue Data Set Management Command
nvme-copy(1)
- Issue Simple Copy Command
- Set Feature
- Show NVMe Controller Registers
- Send Get Log Page request to Discovery Controller
- Discover and connect to all NVMe-over-Fabrics subsystems
nvme-connect(1)
- Connect to an NVMe-over-Fabrics subsystem
- Disconnect from an NVMe-over-Fabrics subsystem
- Disconnect from all NVMe-over-Fabrics subsystems
- Reads and shows NVMe-over-Fabrics controller property
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[] or the Linux NVMe mailing list m[blue]linux-nvmem[][3]
NVME
NOTES
- 1.
- Official NVM-Express Site
- 2.
-
Keith Busch
- mailto:kbusch@kernel.org
- 3.
-
linux-nvme
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- NVME COMMANDS
- NVME CLI SUB-COMMANDS
- FURTHER DOCUMENTATION
- AUTHORS
- REPORTING BUGS
- NVME
- NOTES
Return to Main Contents