NVME(1) | NVMe Manual | NVME(1) |
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-supported-cap-config-log(1)
nvme-endurance-event-agg-log(1)
nvme-fid-support-effects-log(1)
nvme-pred-lat-event-agg-log(1)
Plugins/Vendor extension commands
nvme-micron-clear-pcie-errors(1)
nvme-micron-selective-download(1)
nvme-micron-temperature-stats(1)
nvme-toshiba-clear-pcie-correctable-errors(1)
nvme-toshiba-vs-internal-log(1)
nvme-toshiba-vs-smart-add-log(1)
nvme-virtium-save-smart-to-vtview-log(1)
nvme-wdc-clear-fw-activate-history(1)
nvme-wdc-clear-pcie-correctable-errors(1)
nvme-wdc-cloud-SSD-plugin-version(1)
nvme-wdc-get-latency-monitor-log(1)
nvme-wdc-log-page-directory(1)
nvme-wdc-vs-error-reason-identifier(1)
nvme-wdc-vs-fw-activate-history(1)
nvme-wdc-vs-telemetry-controller-option(1)
nvme-wdc-vs-temperature-stats(1)
nvme-inspur-nvme-vendor-log(1)
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
- 3.
- linux-nvme
08/07/2024 | NVMe |