NVME(1)

💖 NAME 💖

Welcome to the NVMe Manual, bestie — this is nvme(1), aka the NVMe storage command line interface utility (nvme-cli). She’s the utility that runs the NVMe show, periodt. 👑🦋

✨ SYNOPSIS ✨

Here’s the built-in plugin shape first, then the extension-plugin shape, both exactly as the manual lays them out:

built-in plugin:

nvme [<global-options>] <command> <device> [<args>]

extension plugins:

nvme [<global-options>] <plugin> <command> <device> [<args>]

No cap, this is the whole invocation vibe. 🫶

🌈 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). It’s giving speed, scale, and range, literally. ✨

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. Linux-only main character energy, and that’s on purpose. 🐧💅

👑 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. Honestly? A little nvme help moment fixes a lot. 💖

🦋 NVME CLI SUB-COMMANDS 🦋

🎀 Main commands 🎀

Okay bestie, here’s the full main-command menu, in order, no skips, no “I forgot one” energy:

• nvme-admin-passthru(1) — submits an arbitrary admin command and returns the results. 🫶
• nvme-capacity-mgmt(1) — submits a Capacity Management Command and returns the results.
• nvme-compare(1) — submits a Compare command and returns the results.
• nvme-connect(1) — connects to an NVMeoF subsystem.
• nvme-connect-all(1) — discovers and connects to NVMeoF subsystems.
• nvme-copy(1) — submits a Simple Copy command and returns the results.
• nvme-device-self-test(1) — performs the necessary tests to observe the performance.
• nvme-dim(1) — sends a Discovery Information Management command to a Discovery Controller.
• nvme-disconnect(1) — disconnects from an NVMeoF subsystem.
• nvme-disconnect-all(1) — disconnects from all connected NVMeoF subsystems.
• nvme-discover(1) — discovers NVMeoF subsystems.
• nvme-dsm(1) — submits a Data Set Management command and returns the results.
• nvme-flush(1) — submits a Flush command and returns the results.
• nvme-format(1) — formats a namespace with a new block format.
• nvme-gen-hostnqn(1) — generates an NVMeoF host NQN.
• nvme-get-feature(1) — gets a feature and shows the resulting value.
• nvme-get-lba-status(1) — submits a Get LBA Status command and returns the results.
• nvme-get-log(1) — the generic NVMe get log; returns the log in raw format.
• nvme-get-property(1) — gets a property and shows the resulting value.
• nvme-get-reg(1) — gets a register and shows the resulting value.
• nvme-io-passthru(1) — submits an arbitrary IO command and returns the results.
• nvme-list(1) — lists all NVMe devices and namespaces on the machine.
• nvme-list-subsys(1) — lists nvme subsystems.
• nvme-lockdown(1) — submits a Lockdown command and returns the result.
• nvme-ns-rescan(1) — rescans the NVME namespaces.
• nvme-read(1) — submits a read command and returns the results.
• nvme-reset(1) — resets the controller.
• nvme-sanitize(1) — submits a sanitize command.
• nvme sanitize-ns — submits a sanitize namespace command.
• nvme-set-feature(1) — sets a feature and shows the resulting value.
• nvme-set-property(1) — sets a property and shows the resulting value.
• nvme-set-reg(1) — sets a register and shows the resulting value.
• nvme-show-hostnqn(1) — shows the NVMeoF host NQN.
• nvme-show-regs(1) — shows the controller registers or properties. Requires character device. 👀
• nvme-show-topology(1) — shows the topology.
• nvme-subsystem-reset(1) — resets the subsystem.
• nvme-top(1) — the nvme top view.
• nvme-verify(1) — submits a verify command and returns the results.
• nvme-virt-mgmt(1) — manages Flexible Resources between Primary and Secondary Controller.
• nvme-write(1) — submits a write command and returns the results.
• nvme-write-uncor(1) — submits a write uncorrectable command and returns the results.
• nvme-write-zeroes(1) — submits a write zeroes command and returns the results.
• nvme-config-convert(1) — converts config.json/discovery.conf to INI.
• nvme-config-create(1) — creates an NVMeoF connection entry in the INI configuration.
• nvme-config-show(1) — shows the resolved NVMeoF connection configuration.
• nvme-config-status(1) — reports config status.
• nvme-config-validate(1) — validates an NVMeoF connection configuration.
• nvme-dir-receive(1) — submits a Directive Receive command and returns the results.
• nvme-dir-send(1) — submits a Directive Send command and returns the results.
• nvme-exclusion-add(1) — adds an entry to an exclusion list.
• nvme-exclusion-create(1) — creates an exclusion list.
• nvme-exclusion-delete(1) — deletes an exclusion list.
• nvme-exclusion-edit(1) — edits an exclusion list interactively.
• nvme-exclusion-list(1) — lists exclusion lists or entries.
• nvme-exclusion-remove(1) — removes an entry from an exclusion list.
• nvme-fdp-configs(1) — lists configurations.
• nvme-fdp-events(1) — lists events affecting reclaim units and media usage.
• nvme-fdp-feature(1) — shows, enables, or disables FDP configuration.
• nvme-fdp-set-events(1) — enables or disables events.
• nvme-fdp-stats(1) — shows statistics.
• nvme-fdp-status(1) — shows reclaim unit handle status.
• nvme-fdp-update(1) — updates a reclaim unit handle.
• nvme-fdp-usage(1) — shows reclaim unit handle usage.
• nvme-feat-arbitration(1) — gets and sets the arbitration feature.
• nvme-feat-async-event-conf(1) — gets and sets the async event configuration feature.
• nvme-feat-err-recovery(1) — gets and sets the error recovery feature.
• nvme-feat-hctm(1) — gets and sets the host controlled thermal management feature.
• nvme-feat-host-behavior-support(1) — gets and sets the host behavior support feature.
• nvme-feat-int-coalesce(1) — gets and sets the interrupt coalescing feature.
• nvme-feat-int-vector-config(1) — gets and sets the interrupt vector configuration feature.
• nvme-feat-keep-alive-timer(1) — gets and sets the keep alive timer feature.
• nvme-feat-lba-range-type(1) — gets and sets the lba range type feature.
• nvme-feat-num-queues(1) — gets and sets the number of queues feature.
• nvme-feat-perfc(1) — gets and sets the perf characteristics feature.
• nvme-feat-power-limit(1) — gets and sets the power limit feature.
• nvme-feat-power-meas(1) — gets and sets the power measurement feature.
• nvme-feat-power-mgmt(1) — gets and sets the power management feature.
• nvme-feat-power-thresh(1) — gets and sets the power threshold feature.
• nvme-feat-temp-thresh(1) — gets and sets the temperature threshold feature.
• nvme-feat-timestamp(1) — gets and sets the timestamp feature.
• nvme-feat-volatile-wc(1) — gets and sets the volatile write cache feature.
• nvme-feat-write-atom-normal(1) — gets and sets the write atomicity normal feature.
• nvme-fw-commit(1) — verifies and commits firmware to a specific slot (fw-activate in old version < 1.2).
• nvme-fw-download(1) — downloads new firmware.
• nvme-id-ctrl(1) — sends NVMe Identify Controller.
• nvme-id-ctrl-list(1) — sends NVMe Identify Controller List and displays the structure.
• nvme-id-domain(1) — sends NVMe Identify Domain List and displays the structure.
• nvme-id-endgrp-list(1) — sends NVMe Identify Endurance Group List and displays the structure.
• nvme-id-iocs(1) — sends NVMe Identify I/O Command Set and displays the structure.
• nvme-id-ns(1) — sends NVMe Identify Namespace and displays the structure.
• nvme-id-ns-descs(1) — sends NVMe Namespace Descriptor List and displays the structure.
• nvme-id-ns-granularity(1) — sends NVMe Identify Namespace Granularity List and displays the structure.
• nvme-id-ns-ind(1) — does I/O Command Set Independent Identify Namespace.
• nvme-id-ns-lba-format(1) — sends NVMe Identify Namespace for the specified LBA Format index and displays the structure.
• nvme-id-ns-list(1) — sends NVMe Identify List and displays the structure.
• nvme-id-nvm-ctrl(1) — sends NVMe Identify Controller NVM Command Set and displays the structure.
• nvme-id-nvm-ns(1) — sends NVMe Identify Namespace NVM Command Set and displays the structure.
• nvme-id-nvm-ns-lba-format(1) — sends NVMe Identify Namespace NVM Command Set for the specified LBA Format index and displays the structure.
• nvme-id-nvmset(1) — sends NVMe Identify NVM Set List and displays the structure.
• nvme-id-primary-ctrl-caps(1) — sends NVMe Identify Primary Controller Capabilities.
• nvme-id-secondary-ctrl-list(1) — lists Secondary Controllers associated with a Primary Controller.
• nvme-id-uuid(1) — sends NVMe Identify UUID List and displays the structure.
• nvme-io-mgmt-recv(1) — does I/O Management Receive.
• nvme-io-mgmt-send(1) — does I/O Management Send.
• nvme-keys-check-kxchap-secret(1) — validates NVMeoF KX-HMAC-CHAP host secret format or checks if loaded.
• nvme-keys-check-tls-psk(1) — validates NVMeoF TLS PSK format or checks if loaded.
• nvme-keys-export(1) — exports NVMeoF TLS PSKs from a keyring.
• nvme-keys-gen-kxchap-secret(1) — generates NVMeoF KX-HMAC-CHAP host secret.
• nvme-keys-gen-tls-psk(1) — generates NVMeoF TLS PSK.
• nvme-keys-import(1) — imports NVMeoF TLS PSKs and KX-HMAC-CHAP secrets into a keyring.
• nvme-keys-insert-tls-psk(1) — inserts NVMeoF TLS PSK into a keyring.
• nvme-keys-revoke(1) — revokes an NVMeoF TLS PSK from a keyring.
• nvme lm create-cdq — creates a Controller Data Queue.
• nvme lm delete-cdq — deletes a Controller Data Queue.
• nvme lm get-cdq — gets Feature - Controller Data Queue (FID 21h).
• nvme lm migration-recv — does Migration Receive.
• nvme lm migration-send — does Migration Send.
• nvme lm set-cdq — sets Feature - Controller Data Queue (FID 21h).
• nvme lm track-send — does Track Send Command.
• nvme-log-ana(1) — retrieves the ANA Log and shows it.
• nvme-log-ave-discovery(1) — retrieves the AVE Discovery Log and shows it.
• nvme-log-boot-part(1) — retrieves the Boot Partition Log and shows it.
• nvme-log-changed-alloc-ns-list(1) — retrieves the Changed Allocated Namespace List and shows it.
• nvme-log-changed-ns-list(1) — retrieves the Changed Attached Namespace List and shows it.
• nvme-log-dispersed-ns-participating-nss(1) — retrieves the Dispersed Namespace Participating NVM Subsystems Log and shows it.
• nvme-log-effects(1) — retrieves the Command Effects Log and shows it.
• nvme-log-endurance(1) — retrieves the Endurance Group Log and shows it.
• nvme-log-endurance-event-agg(1) — retrieves the Endurance Group Event Aggregate Log and shows it.
• nvme-log-error(1) — retrieves the Error Log and shows it.
• nvme-log-fid-support-effects(1) — retrieves the FID Support and Effects log and shows it.
• nvme-log-fw(1) — retrieves the FW Log and shows it.
• nvme-log-host-discovery(1) — retrieves the Host Discovery Log and shows it.
• nvme-log-lba-status(1) — pulls the LBA Status Information Log and shows it off 💅 yep, the whole log, displayed
• nvme-log-media-unit-stat(1) — grabs the configuration and the wear of your media units, then shows it, because knowing how tired your media is matters 🫶
• nvme-log-mgmt-addr-list(1) — Retrieves the Management Address List Log, shows it, no notes ✨
• nvme-log-mi-cmd-support-effects(1) — pulls the MI Command Support and Effects log and shows it, iconic behavior
• nvme-log-persistent-event(1) — Retrieves the Persistent Event Log and shows it. the lore. preserved. 💀
• nvme-log-phy-rx-eom(1) — Retrieves the Physical Interface Receiver Eye Opening Measurement, and yes it shows it. eye opening measurement bestie, we're literally checking the vibes of your signal 🌸
• nvme log power-measurement — Retrieves the Power Measurement Log and shows it, so you can see exactly what your watts are doing ⚡
• nvme-log-pred-lat-event-agg(1) — Retrieves the Predictable Latency Event Aggregate Log, shows it, main character of aggregate logs
• nvme-log-predictable-lat(1) — Retrieves the Predictable Latency per Nvmset Log, shows it. per. nvmset. 🎀
• nvme log pull-model-ddc-req — Retrieves the Pull Model DDC Request Log, shows it, slay
• nvme-log-reachability-associations(1) — Retrieves the Reachability Associations Log, shows it 🔥
• nvme-log-reachability-groups(1) — Retrieves the Reachability Groups Log, shows it, and yes it's the groups one not the associations one, read carefully bestie
• nvme-log-resv-notif(1) — Retrieves the Reservation Notification Log, shows it 💖
• nvme-log-rotational-media-info(1) — Retrieves the Rotational Media Information Log, shows it. spinning rust lore, but make it informational 🌀
• nvme-log-sanitize(1) — Retrieves the sanitize log, shows it. the sanitize log!! keep an eye on it 👑
• nvme-log-self-test(1) — Retrieves the SELF-TEST Log, shows it. self care but it's diagnostics 🧚
• nvme-log-smart(1) — Retrieves the SMART Log, shows it. the classic. the moment. the health check ⭐
• nvme-log-supported-cap-config(1) — Retrieves the list of Supported Capacity Configuration Descriptors, and that's the whole list ok, that's the deliverable 💜
• nvme-supported-log-pages(1) — Retrieves the Supported Log pages details, shows it. meta af — it's a log of logs 🌈
• nvme-log-telemetry(1) — Retrieves the FW Telemetry log and writes it to a file 🦋
• nvme nbft show — Shows the contents of ACPI NBFT tables. showing. contents. yes 🌟
• nvme-ns-attach(1) — Attaches a namespace to the controller(s) you asked for, no cap
• nvme-ns-create(1) — Creates a namespace using the parameters you handed it ✨
• nvme-ns-delete(1) — Deletes a namespace from the controller. bye bestie 💀
• nvme-ns-detach(1) — Detaches a namespace from the requested controller(s) 🫶
• nvme-ns-get-id(1) — Retrieves the namespace ID of the opened block device. cute little lookup
• nvme-nvme-mi-recv(1) — Submits a NVMe-MI Receive command and returns the results 📨
• nvme-nvme-mi-send(1) — Submits a NVMe-MI Send command and returns the results 📬
• nvme-registry-delete(1) — Removes a controller's registry entry, gone, deleted, periodt
• nvme-registry-list(1) — Lists the live registry entries 👑
• nvme-registry-retrieve(1) — Reads an attribute from a controller's entry 🔍
• nvme-registry-update(1) — Writes an attribute to a controller's entry. writing, not reading, keep up 💅
• nvme-resv-acquire(1) — Submits a Reservation Acquire and returns the results
• nvme-resv-register(1) — Submits a Reservation Register and returns the results
• nvme-resv-release(1) — Submits a Reservation Release and returns the results 🕊️
• nvme-resv-report(1) — Submits a Reservation Report and returns the results 📋
• nvme-rpmb-info(1) — Prints the RPMB support information for the controller 🎀
• nvme-rpmb-program-key(1) — Programs the RPMB authentication key 🔑
• nvme-rpmb-read-config(1) — Reads the RPMB device configuration block
• nvme-rpmb-read-counter(1) — Reads the RPMB write counter. counting the writes fr fr
• nvme-rpmb-read-data(1) — Reads authenticated data from an RPMB target ✅
• nvme-rpmb-write-config(1) — Writes the RPMB device configuration block ✍️
• nvme-rpmb-write-data(1) — Writes authenticated data to an RPMB target 💾
• nvme-security-recv(1) — Submits a Security Receive command and returns the results 🛡️
• nvme-security-send(1) — Submits a Security Send command and returns the results 🛡️
• nvme-sed-discover(1) — Discovers SED Opal Locking Features, like a little detective 🔎
• nvme-sed-initialize(1) — Initializes a SED Opal Device for locking. setting it up to be secure 💅
• nvme-sed-lock(1) — Locks a SED Opal Device 🔒
• nvme-sed-password(1) — Changes the SED Opal Device password 🤫
• nvme-sed-revert(1) — Reverts a SED Opal Device from locking, undoing the lock era
• nvme-sed-unlock(1) — Unlocks a SED Opal Device 🔓
• nvme utils dump-command-metadata — Dumps all commands and their options as JSON. every command. every option. JSON. iconic 📦
• nvme-zns-changed-zone-list(1) — Retrieves the changed zone list log 🦋
• nvme-zns-close-zone(1) — Closes one or more zones 🚪
• nvme-zns-finish-zone(1) — Finishes one or more zones. not closes — finishes — different thing bestie ✅
• nvme-zns-id-ctrl(1) — Sends NVMe Identify Zoned Namespace Controller and displays the structure 🌟
• nvme-zns-id-ns(1) — Sends NVMe Identify Zoned Namespace Namespace and displays the structure 🌟
• nvme zns list — Lists all NVMe devices with Zoned Namespace Command Set support. the roster 👑
• nvme-zns-offline-zone(1) — Offlines one or more zones 💀
• nvme-zns-open-zone(1) — Opens one or more zones 🔓
• nvme-zns-report-zones(1) — Reports the zones associated to a Zoned Namespace 📊
• nvme-zns-reset-zone(1) — Resets one or more zones 🔄
• nvme-zns-set-zone-desc(1) — Attaches zone descriptor extension data to a zone 🎀
• nvme-zns-zone-append(1) — Appends data and metadata (if applicable) to a zone ✍️
• nvme-zns-zone-mgmt-recv(1) — Sends the zone management receive command 📥
• nvme-zns-zone-mgmt-send(1) — Sends the zone management send command 📤
• nvme-zns-zrwa-flush-zone(1) — Flushes the LBAs associated with a ZRWA to a zone 🌊

---

🔌 Plugins/Vendor extension commands 🔌

okay bestie, this is the vendor corner of the group chat — every drive brand showed up with their own little plugin and honestly? obsessed. each one is listed with exactly what it does 💖

• nvme amzn id-ctrl — Sends NVMe Identify Controller, Amazon style
• nvme amzn stats — Gets EBS volume stats 📈
• nvme-dapustor-smart-log-add(1) — Retrieves the DapuStor SMART Log, shows it
• nvme dell id-ctrl — Sends NVMe Identify Controller, Dell edition
• nvme dera smart-log-add — Retrieves the Dera SMART Log, shows it
• nvme-huawei-id-ctrl(1) — Huawei identify controller 🀄
• nvme-huawei-list(1) — Lists all Huawei NVMe devices and namespaces on the machine, the whole lineup 💅
• nvme ibm crit-log — Displays IBM Smart Log Information
• nvme ibm persist-event-log — IBM specific Persistent Event Log, the lore but IBM flavored
• nvme ibm vpd — Displays IBM VPD Information
• nvme innogrit get-cdump — gets cdump data 📦
• nvme innogrit get-eventlog — gets the event log 📋
• nvme-inspur-nvme-vendor-log(1) — Retrieves the Inspur Vendor Log, shows it
• nvme-intel-id-ctrl(1) — Sends NVMe Identify Controller, Intel style
• nvme-intel-internal-log(1) — Retrieves the Intel internal firmware log and saves it 💾
• nvme-intel-lat-stats(1) — Retrieves the Intel IO Latency Statistics log, shows it 📊
• nvme intel lat-stats-tracking — Enables and disables Latency Statistics logging. on or off, your call 🔘
• nvme-intel-market-name(1) — Retrieves the Intel Marketing Name log, shows it 🏷️
• nvme intel set-bucket-thresholds — Sets Latency Stats Bucket Values, and saves it 🪣
• nvme-intel-smart-log-add(1) — Retrieves the Intel SMART Log, shows it
• nvme-intel-temp-stats(1) — Retrieves the Intel Temperature Statistics log, shows it 🌡️
• nvme-mangoboost-id-ctrl(1) — Sends NVMe Identify Controller, mango mode 🥭
• nvme memblaze clear-error-log — Clears the error log 🧹
• nvme memblaze get-pm-status — Gets Memblaze Power Manager Status ⚡
• nvme memblaze lat-get-feature-x — Gets the Enabled/Disabled state of the Latency Monitor feature
• nvme memblaze lat-log — Sets Memblaze High Latency Log
• nvme memblaze lat-log-print — Outputs the Memblaze High Latency Log 🖨️
• nvme memblaze lat-log-print-x — Gets the High Latency log and shows it
• nvme memblaze lat-set-feature-x — Sets Enable/Disable for the Latency Monitor feature 🔘
• nvme memblaze lat-stats — Enables and disables Latency Statistics logging
• nvme memblaze lat-stats-print — Retrieves the IO Latency Statistics log, shows it 📊
• nvme memblaze lat-stats-print-x — Gets the Latency Statistics log and shows it
• nvme memblaze perf-stats-print-x — Gets the Performance Stat log and shows it 🏎️
• nvme memblaze select-download — Selective Firmware Download
• nvme memblaze set-pm-status — Sets Memblaze Power Manager Status ⚡
• nvme memblaze smart-log-add — Retrieves the Memblaze SMART Log, shows it
• nvme memblaze smart-log-add-x — Retrieves the Memblaze SMART Log, shows it. yes it's basically the same one-liner as above, that's literally what the page says bestie, don't come for me 😭
• nvme micron clear-fw-activate-history — Clears FW activation history 🧹
• nvme-micron-clear-pcie-errors(1) — Clears correctable PCIe errors
• nvme micron cloud-SSD-plugin-version — Displays plugin version info 🏷️
• nvme micron cloud-boot-SSD-version — Prints HyperScale Boot Version
• nvme-micron-id-ctrl(1) — Identify Controller, Micron flavored
• nvme micron latency-logs — Latency log details tracked by the drive 📊
• nvme micron latency-stats — Latency information for tracked commands ⏱️
• nvme micron latency-tracking — Latency monitoring feature control 🎛️
• nvme micron log-page-directory — Retrieves the log page directory 📖
• nvme micron plugin-version — Displays plugin version info
• nvme-micron-selective-download(1) — Selective Firmware Download
• nvme-micron-smart-log(1) — Retrieves SMART/Health Log 💖
• nvme micron vs-cloud-log — Retrieves Extended Health Information of the Hyperscale NVMe Boot SSD ☁️
• nvme micron vs-device-waf — Reports SLC and TLC WAF ratio 📐
• nvme micron vs-drive-info — Retrieves Drive information 🏷️
• nvme micron vs-fw-activate-history — Displays FW activation history 📜
• nvme-micron-internal-log(1) — Retrieves Micron logs
• nvme-micron-nand-stats(1) — Retrieves NAND Stats 🧠
• nvme-micron-pcie-stats(1) — Retrieves Micron PCIe error stats
• nvme-micron-smart-add-log(1) — Retrieves extended SMART data
• nvme micron vs-smart-ext-log — Retrieves extended SMART logs
• nvme micron vs-smbus-option — Enables/Disables SMBUS on the drive 🔘
• nvme micron vs-telemetry-controller-option — Enables/Disables controller telemetry log generation 📡
• nvme-micron-temperature-stats(1) — Retrieves Micron temperature statistics 🌡️
• nvme micron vs-vendor-telemetry-log — Retrieves Vendor Telemetry logs
• nvme micron vs-work-load-log — Retrieves Workload logs 💼
• nvme-netapp-ontapdevices(1) — NetApp ONTAPdevices
• nvme-netapp-smdevices(1) — NetApp SMdevices
• nvme nvidia id-ctrl — Sends NVMe Identify Controller, NVIDIA edition 🎮
• nvme-ocp-clear-fw-activate-history(1) — Clears Firmware Update History 🧹
• nvme-ocp-clear-pcie-correctable-error-counters(1) — Clears PCIe Correctable Error Counters
• nvme-ocp-device-capability-log(1) — Retrieves the Device Capabilities Log Page 📄
• nvme-ocp-eol-plp-failure-mode(1) — Defines the EOL or PLP Circuitry Failure Mode ⚠️
• nvme-ocp-error-recovery-log(1) — Retrieves the Error Recovery Log Page 🛟
• nvme ocp fw-activate-history — Retrieves the Firmware Activation History Log Page 📜
• nvme-ocp-get-clear-pcie-correctable-errors(1) — Gets the Clear PCIe Correctable Error Counters Feature
• nvme-ocp-get-dssd-async-event-config(1) — Gets the DSSD Asynchronous Event Configuration 🎛️
• nvme-ocp-get-dssd-power-state-feature(1) — Gets the DSSD Power State Feature ⚡

okay bestie, next chunk is the plug-in zone — every vendor out here decided their SSD needed its own ✨flavor✨ of log pages, and honestly? iconic of them. here's the whole roster, nobody gets left out:

---

🎀 OCP plug-in 🎀

• nvme ocp get-enable-ieee1667-silo — Get Enable IEEE1667 Silo Feature
• nvme-ocp-get-error-injection(1) — Get Error Injection Feature
• nvme-ocp-get-idle-wakeup-time(1) — Get Idle Wake Up Time Configuration
• nvme-ocp-get-latency-monitor(1) — Get Latency Monitor Feature
• nvme-ocp-get-plp-health-check-interval(1) — Get PLP Health Check Interval
• nvme-ocp-get-telemetry-profile(1) — Get Telemetry Profile Feature
• nvme-ocp-hardware-component-log(1) — Retrieve Hardware Component Log Page
• nvme-ocp-internal-log(1) — Retrieve and Save Internal Device Telemetry Log
• nvme-ocp-latency-monitor-log(1) — Retrieve Latency Monitor Log Page
• nvme-ocp-persistent-event-log(1) — Retrieve Persistent Event Log with OCP Events
• nvme-ocp-set-dssd-async-event-config(1) — Set DSSD Asynchronous Event Configuration
• nvme-ocp-set-dssd-power-state-feature(1) — Set DSSD Power State Feature
• nvme ocp set-enable-ieee1667-silo — Set Enable IEEE1667 Silo Feature
• nvme-ocp-set-error-injection(1) — Set Error Injection Feature
• nvme ocp set-latency-monitor-feature — Set Latency Monitor Feature
• nvme-ocp-set-plp-health-check-interval(1) — Set PLP Health Check Interval
• nvme-ocp-set-telemetry-profile(1) — Set Telemetry Profile Feature
• nvme-ocp-smart-add-log(1) — Retrieve Extended SMART Information
• nvme-ocp-tcg-configuration-log(1) — Retrieve TCG Configuration Log Page
• nvme-ocp-telemetry-string-log(1) — Retrieve Telemetry String Log Page
• nvme-ocp-unsupported-reqs-log(1) — Retrieve Unsupported Requirements Log Page

---

🧚 Samsung 🧚

• nvme-samsung-vs-internal-log(1) — Retrieve and save internal firmware log

---

🦋 Seagate 🦋

• nvme-seagate-clear-fw-activate-history(1) — Clear Firmware Activation History
• nvme-seagate-clear-pcie-correctable-errors(1) — Clear Seagate PCIe error statistics
• nvme-seagate-cloud-SSD-plugin-version(1) — Shows OCP Seagate plugin’s version information
• nvme-seagate-get-ctrl-tele(1) — Retrieve Seagate Controller-Initiated Telemetry
• nvme-seagate-get-host-tele(1) — Retrieve Seagate Host-Initiated Telemetry
• nvme-seagate-plugin-version(1) — Shows Seagate plugin’s version information
• nvme-seagate-vs-fw-activate-history(1) — Retrieve the Firmware Activation History
• nvme-seagate-vs-internal-log(1) — Retrieve Seagate Controller-Initiated Telemetry in binary format
• nvme-seagate-vs-log-page-sup(1) — Retrieve Seagate Supported Log-pages Information
• nvme-seagate-vs-pcie-stats(1) — Retrieve Seagate PCIe error statistics
• nvme-seagate-vs-smart-add-log(1) — Retrieve Seagate extended-SMART Information
• nvme-seagate-vs-temperature-stats(1) — Retrieve Seagate temperature statistics

---

🍓 ScaleFlux (sfx) 🍓

• nvme sfx change-cap — Dynamic change capacity
• nvme sfx dump-evtlog — dump evtlog into file and parse warning & error log
• nvme sfx expand-cap — expand the last namespace capacity lossless
• nvme sfx get-bad-block — Retrieve bad block table of block device, show it
• nvme sfx get-feature — Get a feature
• nvme sfx lat-stats — Retrieve ScaleFlux IO Latency Statistics log, show it
• nvme sfx query-cap — Query current capacity info
• nvme sfx set-feature — Set a feature
• nvme sfx smart-log-add — Retrieve ScaleFlux SMART Log, show it
• nvme sfx status — Retrieve the ScaleFlux status output, show it

---

🌸 Shannon 🌸

• nvme shannon get-additional-feature — Get additional Shannon feature
• nvme shannon id-ctrl — Retrieve Shannon ctrl id, show it
• nvme shannon set-additioal-feature — Set additional Shannon feature (yes bestie, that spelling is literally in the source, we do not fix it, we respect it 💅)
• nvme shannon smart-log-add — Retrieve Shannon SMART Log, show it

---

💜 Sandisk (sndk) 💜

• nvme-sndk-capabilities(1) — Sandisk Device Capabilities
• nvme-sndk-clear-assert-dump(1) — Sandisk Clear Assert Dump
• nvme-sndk-clear-fw-activate-history(1) — Sandisk Clear FW Activate History
• nvme-sndk-clear-pcie-correctable-errors(1) — Sandisk Clear PCIe Correctable Error Count
• nvme-sndk-cloud-SSD-plugin-version(1) — Sandisk Cloud SSD Plugin Version
• nvme-sndk-cloud-boot-SSD-version(1) — Sandisk Get the Cloud Boot SSD Version
• nvme-sndk-cu-smart-log(1) — Sandisk Get Customer Unique Smart Log
• nvme-sndk-drive-resize(1) — Sandisk Drive Resize
• nvme-sndk-get-dev-capabilities-log(1) — Sandisk Get Device Capabilities Log Page
• nvme-sndk-get-drive-status(1) — Sandisk Get Drive Status
• nvme-sndk-get-error-recovery-log(1) — Sandisk Get Error Recovery Log Page
• nvme-sndk-get-latency-monitor-log(1) — Sandisk Get Latency Monitor Log Page
• nvme-sndk-get-unsupported-reqs-log(1) — Sandisk Get Unsupported Requirements Log Page
• nvme-sndk-log-page-directory(1) — Sandisk Get Log Page Directory
• nvme-sndk-namespace-resize(1) — Sandisk NamespaceDrive Resize
• nvme-sndk-set-latency-monitor-feature(1) — Sandisk set Latency Monitor feature
• nvme-sndk-vs-cloud-log(1) — Sandisk Get the Cloud Log Page
• nvme-sndk-vs-device-waf(1) — Sandisk Calculate Device Write Amplication Factor
• nvme-sndk-vs-drive-info(1) — Sandisk Get Drive Info
• nvme-sndk-vs-error-reason-identifier(1) — Sandisk Telemetry Reason Identifier
• nvme-sndk-vs-fw-activate-history(1) — Sandisk Get FW Activate History
• nvme-sndk-vs-hw-rev-log(1) — Sandisk Get the Hardware Revision Log Page
• nvme-sndk-vs-internal-log(1) — Sandisk Internal Firmware Log
• nvme-sndk-vs-nand-stats(1) — Sandisk NAND Statistics
• nvme-sndk-vs-pcie-stats(1) — Sandisk VS PCIE Statistics
• nvme-sndk-vs-smart-add-log(1) — Sandisk Additional Smart Log
• nvme-sndk-vs-telemetry-controller-option(1) — Sandisk Enable/Disable Controller Initiated Telemetry Log
• nvme-sndk-vs-temperature-stats(1) — Sandisk Get Temperature Stats

---

🫶 Solidigm 🫶

• nvme-solidigm-clear-fw-activate-history(1) — Clear firmware update history log (redirects to ocp plug-in)
• nvme-solidigm-clear-pcie-correctable-errors(1) — Clear PCIe Correctable Error Counters (redirects to ocp plug-in)
• nvme-solidigm-cloud-SSDplugin-version(1) — Prints plug-in OCP version
• nvme-solidigm-garbage-collect-log(1) — Retrieve Garbage Collection Log
• nvme-solidigm-id-ctrl(1) — Send NVMe Identify Controller
• nvme-solidigm-latency-tracking-log(1) — Enable/Retrieve Latency tracking Log
• nvme-solidigm-log-page-directory(1) — Retrieve log page directory
• nvme-solidigm-market-log(1) — Retrieve Market Log
• nvme-solidigm-parse-telemetry-log(1) — Parse Telemetry Log binary
• nvme-solidigm-smart-log-add(1) — Retrieve Solidigm SMART Log
• nvme-solidigm-temp-stats(1) — Retrieve Temperature Statistics log
• nvme-solidigm-vs-drive-info(1) — Retrieve drive information
• nvme-solidigm-vs-fw-activate-history(1) — Get firmware activation history log (redirects to ocp plug-in)
• nvme-solidigm-vs-internal-log(1) — Retrieve Debug log binaries
• nvme-solidigm-vs-smart-add-log(1) — Get SMART / health extended log (redirects to ocp plug-in)
• nvme-solidigm-workload-tracker(1) — Real Time capture Workload Tracker samples

---

🌈 ssstc 🌈

• nvme ssstc smart-log-add — Retrieve ssstc SMART Log, show it

---

⭐ Toshiba ⭐

• nvme-toshiba-clear-pcie-correctable-errors(1) — Clear PCIe correctable error count
• nvme-toshiba-vs-internal-log(1) — Get Internal Log
• nvme-toshiba-vs-smart-add-log(1) — Extended SMART information

---

🎀 Transcend 🎀

• nvme-transcend-badblock(1) — Get NVME bad block number
• nvme-transcend-healthvalue(1) — NVME health percentage

---

🧚 Virtium 🧚

• nvme-virtium-save-smart-to-vtview-log(1) — Periodically save smart attributes into a log file. The data in this log file can be analyzed using excel or using Virtium’s vtView. Visit vtView.virtium.com to see full potential uses of the data
• nvme-virtium-show-identify(1) — Shows detail features and current settings

---

👑 WDC 👑

• nvme-wdc-cap-diag(1) — WDC Capture-Diagnostics
• nvme-wdc-capabilities(1) — WDC Device Capabilities
• nvme-wdc-clear-assert-dump(1) — WDC Clear Assert Dump
• nvme-wdc-clear-fw-activate-history(1) — WDC Clear FW Activate History
• nvme-wdc-clear-pcie-correctable-errors(1) — WDC Clear PCIe Correctable Error Count
• nvme-wdc-cloud-SSD-plugin-version(1) — WDC Cloud SSD Plugin Version
• nvme-wdc-cloud-boot-SSD-version(1) — WDC Get the Cloud Boot SSD Version
• nvme-wdc-cu-smart-log(1) — WDC Get Customer Unique Smart Log
• nvme-wdc-drive-essentials(1) — WDC Drive Essentials
• nvme-wdc-drive-log(1) — WDC Drive Log
• nvme-wdc-drive-resize(1) — WDC Drive Resize
• nvme-wdc-enc-get-log(1) — WDC Get Enclosure Log
• nvme-wdc-get-crash-dump(1) — WDC Crash Dump
• nvme-wdc-get-dev-capabilities-log(1) — WDC Get Device Capabilities Log Page
• nvme-wdc-get-drive-status(1) — WDC Get Drive Status
• nvme-wdc-get-error-recovery-log(1) — WDC Get Error Recovery Log Page
• nvme-wdc-get-latency-monitor-log(1) — WDC Get Latency Monitor Log Page
• nvme-wdc-get-pfail-dump(1) — WDC Pfail Dump
• nvme-wdc-get-unsupported-reqs-log(1) — WDC Get Unsupported Requirements Log Page
• nvme-wdc-id-ctrl(1) — WDC identify controller
• nvme-wdc-log-page-directory(1) — WDC Get Log Page Directory
• nvme-wdc-namespace-resize(1) — WDC NamespaceDrive Resize
• nvme-wdc-purge(1) — WDC Purge
• nvme-wdc-purge-monitor(1) — WDC Purge Monitor
• nvme-wdc-set-latency-monitor-feature(1) — WDC set Latency Monitor feature
• nvme-wdc-vs-cloud-log(1) — WDC Get the Cloud Log Page
• nvme-wdc-vs-device-waf(1) — WDC Calculate Device Write Amplication Factor
• nvme-wdc-vs-drive-info(1) — WDC Get Drive Info
• nvme-wdc-vs-error-reason-identifier(1) — WDC Telemetry Reason Identifier
• nvme-wdc-vs-fw-activate-history(1) — WDC Get FW Activate History
• nvme-wdc-vs-hw-rev-log(1) — WDC Get the Hardware Revision Log Page
• nvme-wdc-vs-internal-log(1) — WDC Internal Firmware Log
• nvme-wdc-vs-nand-stats(1) — WDC NAND Statistics
• nvme wdc vs-pcie-stats — WDC VS PCIE Statistics
• nvme-wdc-vs-smart-add-log(1) — WDC Additional Smart Log
• nvme-wdc-vs-telemetry-controller-option(1) — WDC Enable/Disable Controller Initiated Telemetry Log
• nvme-wdc-vs-temperature-stats(1) — WDC Get Temperature Stats

---

🦋 YMTC 🦋

• nvme ymtc smart-log-add — Retrieve YMTC SMART Log, show it

💅 GLOBAL OPTIONS 💅

okay so these are the big-picture flags — they live at the top-level nvme command, and every subcommand gets to use them. bestie, they're always there for you 🫶

• --dry-run — shows you the command it would run, then just... doesn't run it. ghosting the actual execution, iconic ✨
• --no-ioctl-probing — turns off probing for 64-bit IOCTL support. no cap, that's all it does.
• --no-retries — kills the retry logic on transient errors. one shot, no do-overs 💀
• -o <fmt>, --output-format=<fmt> — picks the reporting format: normal, tabular, json, or binary. only one output format at a time, pick your fighter 🎀
• --output-format-version=<version> — chooses the output format version. version 1 uses the original field naming, while version 2 (the default) gives you more consistent and script-friendly field names. any other version gets rejected — no vibes allowed 😭
• --quiet — suppresses informational messages. errors still get reported (we're not hiding the tea), and --quiet cancels any --verbose for the library log level. they literally can't coexist 💅
• --set-options=<key=value>[,<key=value>...] — sets libnvme library options just for this invocation. supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir. that's the whole list, no extras, periodt.
• --timeout=<ms> — sets the command timeout in milliseconds. infinite or -1 waits with no time limit (0xffffffff). the way that's just forever 🕰️
• -v, --verbose — more detail in the output. you can stack it multiple times to get even louder 🔥

and here's the cute part: these can also be set as machine-wide defaults in nvme-cli.conf(5). but a command-line flag always overrides the file. file says one thing, your flag says another, the flag wins, slay 👑

---

🌈 RETURNS 🌈

every single command keeps it consistent, fr fr — returns 0 on success and 1 on failure. that's it. that's the whole vibe check.

---

🌸 ENVIRONMENT 🌸

• NO_COLOR — when it's set to a non-empty value, nvme prints no colors or bold text. see https://no-color.org/ for the lore. without it, errors, warnings and headings get highlighted when they go to a terminal — so pretty ✨

---

🦋 FURTHER DOCUMENTATION 🦋

go look at the freely available references on the Official NVM-Express Site^[1]. iykyk 📚

---

👑 AUTHORS 👑

this is written and maintained by Keith Busch^[2]. king behavior, honestly.

---

💜 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]. found something cursed? tell them, don't suffer in silence 🙈

---

⭐ NVME ⭐

part of the nvme suite. one of many, all together, cute little family 🎀

---

🍓 NOTES 🍓

1. Official NVM-Express Site http://nvmexpress.org
2. Keith Busch mailto:kbusch@kernel.org
3. linux-nvme mailto:linux-nvme@lists.infradead.org

---

and that's a wrap on the whole page, bestie!! 🧚✨ this edition is dated 10/30/2026, from the NVMe source — version NVME(1), obviously 💅 go forth and query your drives responsibly 💖