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
IO Compare
Retrieve error logs
Submit flush
Submit Data Set Management
Format namespace(s)
F/W Activate (in old version < 1.2)
F/W Commit (in > 1.2)
F/W Download
Retrieve f/w log
Get Features
Generic Get Log
Telemetry Host-Initiated Log
Retrieve Changed Namespace List Log
Retrieve Smart Log
Retrieve ANA(Asymmetric Namespace Access) Log
Retrieve endurance Log
Retrieve effects Log
Retrieve Device Self-test Log
Retrieve namespace identifier
NVMe CLI Help
Identify Controller
Identify Namespace
Identify NVM Set List
Identify I/O Command Set
Create a new namespace
Delete existing namespace
Attach namespace
Detach namespace
IO Passthrough Command
List all nvme namespaces
Identify Namespace Identification Descriptor
List all nvme controllers
List controller in NVMe subsystem
List NVMe subsystems
Reset a NVMe controller
Issue Device Self-test Command
Issue IO Read Command
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
Issue Data Set Management Command
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
Connect to an NVMe-over-Fabrics subsystem
Send Discovery Information Management command to a Discovery Controller
Disconnect from an NVMe-over-Fabrics subsystem
Disconnect from all NVMe-over-Fabrics subsystems
Reads and shows NVMe-over-Fabrics controller property
Retrieve and show the configuration and wear of media units
nvme-supported-cap-config-log(1)
Retrieve and show the list of Supported Capacity Configuration Descriptors
Retrieve Boot Partition Log
Capacity Management Command
Generate NVMeoF DH-HMAC-CHAP host key
Validate NVMeoF TLS PSK
I/O Command Set Independent Identify Namespace
nvme-endurance-event-agg-log(1)
Retrieve Endurance Group Event Aggregate Log
nvme-fid-support-effects-log(1)
Retrieve FID Support and Effects log
Generate NVMeoF DH-HMAC-CHAP host key
Generate NVMeoF host NQN
Generate NVMeoF TLS PSK
Get LBA Status command
NVMe Identify Domain List
NVMe Identify Namespace for the specified LBA Format index
Retrieve LBA Status Information Log
NVMe Identify Endurance Group List
Rescans the NVME namespaces
NVMe Identify Controller NVM Command Set
NVMe Identify Namespace NVM Command Set
NVMe Identify Namespace NVM Command Set for the specified LBA Format index
Retrieve Persistent Event Log
Retrieve Predictable Latency per Nvmset Log
nvme-pred-lat-event-agg-log(1)
Retrieve Predictable Latency Event Aggregate Log
NVMe Identify Primary Controller Capabilities
Resets the controller
Replay Protection Memory Block commands
Retrieve sanitize log
Set a property and show the resulting value
Show NVMeoF host NQN
Resets the subsystem
Retrieve the Supported Log pages details
verify command
Show NVMe topology
Plugins/Vendor
extension commands
nvme-intel-id-ctrl(1)
Intel - NVMe Identify Controller
Retrieve Intel device’s internal log and save to file
Retrieve NVMe Identify Controller, return result and structure
Intel vendor specific marketing name log page
NVMe Intel Additional SMART log page
NVMe Intel Additional SMART log page for temp stats
NVMe huawei Identify Controller
List all recognized Huawei NVMe devices
NVMe Dera Device status and Additional SMART log page request
nvme-micron-clear-pcie-errors(1)
Clears correctable PCIe correctable errors of given Micron device
Retrieve Micron device’s internal logs and save to given zip file
Retrieves NAND statistics of given micron device
Retrieves pcie error statistics for given micron device
nvme-micron-selective-download(1)
Performs selective firmware download
Retrieves NAND statistics
nvme-micron-temperature-stats(1)
Retrieves temperature information of given micron device
Display information about ONTAP devices
Display information for each NVMe path to an E-Series volume
nvme-toshiba-clear-pcie-correctable-errors(1)
Reset the PCIe correctable errors count to zero
nvme-toshiba-vs-internal-log(1)
Retrieve a Toshiba device’s vendor specific internal log
nvme-toshiba-vs-smart-add-log(1)
Retrieve a Toshiba device’s vendor specific extended SMART log page
Retrieve Transcend NVMe device’s bad blocks
Use NVMe SMART table to analyze the health value of Transcend device
Show a complete detail of identify device information in json format
nvme-virtium-save-smart-to-vtview-log(1)
Periodically save smart attributes into a log file
Retrieve WDC device’s diagnostic log and save to file
Display WDC plugin command capabilities
Clears the assert dump (if present)
nvme-wdc-clear-fw-activate-history(1)
Clears the firmware activate history table
Clears the pcie correctable errors field
nvme-wdc-clear-pcie-correctable-errors(1)
Clears the pcie correctable errors returned in the smart-log-add command
nvme-wdc-cloud-SSD-plugin-version(1)
Display WDC plugin Cloud SSD Plugin Version
Retrieve WDC device’s drive essentials bin files
Retrieve WDC device’s drive log and save to file
Send NVMe WDC Resize Vendor Unique Command
Send NVMe WDC enc-get-log Vendor Unique Command
Retrieve WDC device’s crash dump
Send the NVMe WDC get-drive-status command
nvme-wdc-get-latency-monitor-log(1)
Display latency monitor log page data in human readable format
Retrieve WDC device’s pfail crash dump
Send NVMe Identify Controller, return result and structure
nvme-wdc-log-page-directory(1)
Retrieves the list of Log IDs supported by the drive
Resizes the device’s namespace
Send NVMe WDC Purge-Monitor Vendor Unique Command
Send NVMe WDC Purge Vendor Unique Command
Send NVMe WDC smart add log Vendor Unique Command
Send the NVMe WDC vs-drive-info command
nvme-wdc-vs-error-reason-identifier(1)
Retrieve WDC device’s telemetry log error reason identifier field
nvme-wdc-vs-fw-activate-history(1)
Execute NVMe WDC vs-fw-activate-history Vendor Unique Command
Retrieve WDC device’s internal firmware log and save to file
Send NVMe WDC vs-nand-stats Vendor Unique Command
nvme-wdc-vs-telemetry-controller-option(1)
Disable/Enable the controller initiated option of the telemetry log page
nvme-wdc-vs-temperature-stats(1)
Display temperature-related statistics
Retrieve Changed Zone log for the given device
Closes one or all zones
Finishes one or all zones
Send NVMe Zoned Command Set Identify Controller
Send NVMe Zoned Command Set Identify Namespace
Offlines one or all zones
Opens one or all zones
Retrieve and display the Report Zones data structure
Resets one or all zones
Set extended descriptor data for a zone
Send an NVMe write command, provide results
Zone Management Receive command
Zone Management Send command
Flush LBAs associated with a ZRWA to a zone
nvme-inspur-nvme-vendor-log(1)
NVMe Inspur Device Vendor log page request
RETURNS
All commands will behave the same, they will return 0 on success and 1 on failure.
FURTHER DOCUMENTATION
See the freely available references on the Official NVM-Express Site [1] .
AUTHORS
This is written and maintained by Keith Busch [2] .
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 [3]
NVME
Part of the nvme suite
NOTES
|
1. |
Official NVM-Express Site |
|
2. |
Keith Busch |
mailto:kbusch [AT] kernel.org
|
3. |
linux-nvme |
mailto:linux-nvme [AT] lists.org