nvme(1)

SYNOPSIS

built-in plugin:

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

extension plugins:

nvme [<global-options>] <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): Submit an arbitrary admin command, return results
nvme-capacity-mgmt(1): Submit Capacity Management Command, return results
nvme-compare(1): Submit a Compare command, return results
nvme-connect(1): Connect to NVMeoF subsystem
nvme-connect-all(1): Discover and Connect to NVMeoF subsystems
nvme-copy(1): Submit a Simple Copy command, return results
nvme-device-self-test(1): Perform the necessary tests to observe the performance
nvme-dim(1): Send Discovery Information Management command to a Discovery Controller
nvme-disconnect(1): Disconnect from NVMeoF subsystem
nvme-disconnect-all(1): Disconnect from all connected NVMeoF subsystems
nvme-discover(1): Discover NVMeoF subsystems
nvme-dsm(1): Submit a Data Set Management command, return results
nvme-flush(1): Submit a Flush command, return results
nvme-format(1): Format namespace with new block format
nvme-gen-hostnqn(1): Generate NVMeoF host NQN
nvme-get-feature(1): Get feature and show the resulting value
nvme-get-lba-status(1): Submit a Get LBA Status command, return results
nvme-get-log(1): Generic NVMe get log, returns log in raw format
nvme-get-property(1): Get a property and show the resulting value
nvme-get-reg(1): Get a register and show the resulting value
nvme-io-passthru(1): Submit an arbitrary IO command, return results
nvme-list(1): List all NVMe devices and namespaces on machine
nvme-list-subsys(1): List nvme subsystems
nvme-lockdown(1): Submit a Lockdown command,return result
nvme-ns-rescan(1): Rescans the NVME namespaces
nvme-read(1): Submit a read command, return results
nvme-reset(1): Resets the controller
nvme-sanitize(1): Submit a sanitize command
nvme sanitize-ns: Submit a sanitize namespace command
nvme-set-feature(1): Set a feature and show the resulting value
nvme-set-property(1): Set a property and show the resulting value
nvme-set-reg(1): Set a register and show the resulting value
nvme-show-hostnqn(1): Show NVMeoF host NQN
nvme-show-regs(1): Shows the controller registers or properties. Requires character device
nvme-show-topology(1): Show the topology
nvme-subsystem-reset(1): Resets the subsystem
nvme-top(1): nvme top
nvme-verify(1): Submit a verify command, return results
nvme-virt-mgmt(1): Manage Flexible Resources between Primary and Secondary Controller
nvme-write(1): Submit a write command, return results
nvme-write-uncor(1): Submit a write uncorrectable command, return results
nvme-write-zeroes(1): Submit a write zeroes command, return results
nvme-config-convert(1): Convert config.json/discovery.conf to INI
nvme-config-create(1): Create an NVMeoF connection entry in the INI configuration
nvme-config-show(1): Show the resolved NVMeoF connection configuration
nvme-config-status(1): Report config status
nvme-config-validate(1): Validate an NVMeoF connection configuration
nvme-dir-receive(1): Submit a Directive Receive command, return results
nvme-dir-send(1): Submit a Directive Send command, return results
nvme-exclusion-add(1): Add an entry to an exclusion list
nvme-exclusion-create(1): Create an exclusion list
nvme-exclusion-delete(1): Delete an exclusion list
nvme-exclusion-edit(1): Edit an exclusion list interactively
nvme-exclusion-list(1): List exclusion lists or entries
nvme-exclusion-remove(1): Remove an entry from an exclusion list
nvme-fdp-configs(1): List configurations
nvme-fdp-events(1): List events affecting reclaim units and media usage
nvme-fdp-feature(1): Show, enable or disable FDP configuration
nvme-fdp-set-events(1): Enable or disable events
nvme-fdp-stats(1): Show statistics
nvme-fdp-status(1): Show reclaim unit handle status
nvme-fdp-update(1): Update a reclaim unit handle
nvme-fdp-usage(1): Show reclaim unit handle usage
nvme-feat-arbitration(1): Get and set arbitration feature
nvme-feat-async-event-conf(1): Get and set async event configuration feature
nvme-feat-err-recovery(1): Get and set error recovery feature
nvme-feat-hctm(1): Get and set host controlled thermal management feature
nvme-feat-host-behavior-support(1): Get and set host behavior support feature
nvme-feat-int-coalesce(1): Get and set interrupt coalescing feature
nvme-feat-int-vector-config(1): Get and set interrupt vector configuration feature
nvme-feat-keep-alive-timer(1): Get and set keep alive timer feature
nvme-feat-lba-range-type(1): Get and set lba range type feature
nvme-feat-num-queues(1): Get and set number of queues feature
nvme-feat-perfc(1): Get and set perf characteristics feature
nvme-feat-power-limit(1): Get and set power limit feature
nvme-feat-power-meas(1): Get and set power measurement feature
nvme-feat-power-mgmt(1): Get and set power management feature
nvme-feat-power-thresh(1): Get and set power threshold feature
nvme-feat-temp-thresh(1): Get and set temperature threshold feature
nvme-feat-timestamp(1): Get and set timestamp feature
nvme-feat-volatile-wc(1): Get and set volatile write cache feature
nvme-feat-write-atom-normal(1): Get and set write atomicity normal feature
nvme-fw-commit(1): Verify and commit firmware to a specific slot (fw-activate in old version < 1.2)
nvme-fw-download(1): Download new firmware
nvme-id-ctrl(1): Send NVMe Identify Controller
nvme-id-ctrl-list(1): Send NVMe Identify Controller List, display structure
nvme-id-domain(1): Send NVMe Identify Domain List, display structure
nvme-id-endgrp-list(1): Send NVMe Identify Endurance Group List, display structure
nvme-id-iocs(1): Send NVMe Identify I/O Command Set, display structure
nvme-id-ns(1): Send NVMe Identify Namespace, display structure
nvme-id-ns-descs(1): Send NVMe Namespace Descriptor List, display structure
nvme-id-ns-granularity(1): Send NVMe Identify Namespace Granularity List, display structure
nvme-id-ns-ind(1): I/O Command Set Independent Identify Namespace
nvme-id-ns-lba-format(1): Send NVMe Identify Namespace for the specified LBA Format index, display structure
nvme-id-ns-list(1): Send NVMe Identify List, display structure
nvme-id-nvm-ctrl(1): Send NVMe Identify Controller NVM Command Set, display structure
nvme-id-nvm-ns(1): Send NVMe Identify Namespace NVM Command Set, display structure
nvme-id-nvm-ns-lba-format(1): Send NVMe Identify Namespace NVM Command Set for the specified LBA Format index, display structure
nvme-id-nvmset(1): Send NVMe Identify NVM Set List, display structure
nvme-id-primary-ctrl-caps(1): Send NVMe Identify Primary Controller Capabilities
nvme-id-secondary-ctrl-list(1): List Secondary Controllers associated with a Primary Controller
nvme-id-uuid(1): Send NVMe Identify UUID List, display structure
nvme-io-mgmt-recv(1): I/O Management Receive
nvme-io-mgmt-send(1): I/O Management Send
nvme-keys-check-kxchap-secret(1): Validate NVMeoF KX-HMAC-CHAP host secret format or check if loaded
nvme-keys-check-tls-psk(1): Validate NVMeoF TLS PSK format or check if loaded
nvme-keys-export(1): Export NVMeoF TLS PSKs from a keyring
nvme-keys-gen-kxchap-secret(1): Generate NVMeoF KX-HMAC-CHAP host secret
nvme-keys-gen-tls-psk(1): Generate NVMeoF TLS PSK
nvme-keys-import(1): Import NVMeoF TLS PSKs and KX-HMAC-CHAP secrets into a keyring
nvme-keys-insert-tls-psk(1): Insert NVMeoF TLS PSK into a keyring
nvme-keys-revoke(1): Revoke an NVMeoF TLS PSK from a keyring
nvme lm create-cdq: Create Controller Data Queue
nvme lm delete-cdq: Delete Controller Data Queue
nvme lm get-cdq: Get Feature - Controller Data Queue (FID 21h)
nvme lm migration-recv: Migration Receive
nvme lm migration-send: Migration Send
nvme lm set-cdq: Set Feature - Controller Data Queue (FID 21h)
nvme lm track-send: Track Send Command
nvme-log-ana(1): Retrieve ANA Log, show it
nvme-log-ave-discovery(1): Retrieve AVE Discovery Log, show it
nvme-log-boot-part(1): Retrieve Boot Partition Log, show it
nvme-log-changed-alloc-ns-list(1): Retrieve Changed Allocated Namespace List, show it
nvme-log-changed-ns-list(1): Retrieve Changed Attached Namespace List, show it
nvme-log-dispersed-ns-participating-nss(1): Retrieve Dispersed Namespace Participating NVM Subsystems Log, show it
nvme-log-effects(1): Retrieve Command Effects Log, show it
nvme-log-endurance(1): Retrieve Endurance Group Log, show it
nvme-log-endurance-event-agg(1): Retrieve Endurance Group Event Aggregate Log, show it
nvme-log-error(1): Retrieve Error Log, show it
nvme-log-fid-support-effects(1): Retrieve FID Support and Effects log and show it
nvme-log-fw(1): Retrieve FW Log, show it
nvme-log-host-discovery(1): Retrieve Host Discovery Log, show it
nvme-log-lba-status(1): Retrieve LBA Status Information Log, show it
nvme-log-media-unit-stat(1): Retrieve the configuration and wear of media units, show it
nvme-log-mgmt-addr-list(1): Retrieve Management Address List Log, show it
nvme-log-mi-cmd-support-effects(1): Retrieve MI Command Support and Effects log and show it
nvme-log-persistent-event(1): Retrieve Persistent Event Log, show it
nvme-log-phy-rx-eom(1): Retrieve Physical Interface Receiver Eye Opening Measurement, show it
nvme log power-measurement: Retrieve Power Measurement Log, show it
nvme-log-pred-lat-event-agg(1): Retrieve Predictable Latency Event Aggregate Log, show it
nvme-log-predictable-lat(1): Retrieve Predictable Latency per Nvmset Log, show it
nvme log pull-model-ddc-req: Retrieve Pull Model DDC Request Log, show it
nvme-log-reachability-associations(1): Retrieve Reachability Associations Log, show it
nvme-log-reachability-groups(1): Retrieve Reachability Groups Log, show it
nvme-log-resv-notif(1): Retrieve Reservation Notification Log, show it
nvme-log-rotational-media-info(1): Retrieve Rotational Media Information Log, show it
nvme-log-sanitize(1): Retrieve sanitize log, show it
nvme-log-self-test(1): Retrieve the SELF-TEST Log, show it
nvme-log-smart(1): Retrieve SMART Log, show it
nvme-log-supported-cap-config(1): Retrieve the list of Supported Capacity Configuration Descriptors
nvme-supported-log-pages(1): Retrieve the Supported Log pages details, show it
nvme-log-telemetry(1): Retrieve FW Telemetry log write to file
nvme nbft show: Show contents of ACPI NBFT tables
nvme-ns-attach(1): Attaches a namespace to requested controller(s)
nvme-ns-create(1): Creates a namespace with the provided parameters
nvme-ns-delete(1): Deletes a namespace from the controller
nvme-ns-detach(1): Detaches a namespace from requested controller(s)
nvme-ns-get-id(1): Retrieve the namespace ID of opened block device
nvme-nvme-mi-recv(1): Submit a NVMe-MI Receive command, return results
nvme-nvme-mi-send(1): Submit a NVMe-MI Send command, return results
nvme-registry-delete(1): Remove a controller’s registry entry
nvme-registry-list(1): List live registry entries
nvme-registry-retrieve(1): Read an attribute from a controller’s entry
nvme-registry-update(1): Write an attribute to a controller’s entry
nvme-resv-acquire(1): Submit a Reservation Acquire, return results
nvme-resv-register(1): Submit a Reservation Register, return results
nvme-resv-release(1): Submit a Reservation Release, return results
nvme-resv-report(1): Submit a Reservation Report, return results
nvme-rpmb-info(1): Print RPMB support information for the controller
nvme-rpmb-program-key(1): Program the RPMB authentication key
nvme-rpmb-read-config(1): Read the RPMB device configuration block
nvme-rpmb-read-counter(1): Read the RPMB write counter
nvme-rpmb-read-data(1): Read authenticated data from an RPMB target
nvme-rpmb-write-config(1): Write the RPMB device configuration block
nvme-rpmb-write-data(1): Write authenticated data to an RPMB target
nvme-security-recv(1): Submit a Security Receive command, return results
nvme-security-send(1): Submit a Security Send command, return results
nvme-sed-discover(1): Discover SED Opal Locking Features
nvme-sed-initialize(1): Initialize a SED Opal Device for locking
nvme-sed-lock(1): Lock a SED Opal Device
nvme-sed-password(1): Change the SED Opal Device password
nvme-sed-revert(1): Revert a SED Opal Device from locking
nvme-sed-unlock(1): Unlock a SED Opal Device
nvme utils dump-command-metadata: Dump all commands and their options as JSON
nvme-zns-changed-zone-list(1): Retrieve the changed zone list log
nvme-zns-close-zone(1): Close one or more zones
nvme-zns-finish-zone(1): Finish one or more zones
nvme-zns-id-ctrl(1): Send NVMe Identify Zoned Namespace Controller, display structure
nvme-zns-id-ns(1): Send NVMe Identify Zoned Namespace Namespace, display structure
nvme zns list: List all NVMe devices with Zoned Namespace Command Set support
nvme-zns-offline-zone(1): Offline one or more zones
nvme-zns-open-zone(1): Open one or more zones
nvme-zns-report-zones(1): Report zones associated to a Zoned Namespace
nvme-zns-reset-zone(1): Reset one or more zones
nvme-zns-set-zone-desc(1): Attach zone descriptor extension data to a zone
nvme-zns-zone-append(1): Append data and metadata (if applicable) to a zone
nvme-zns-zone-mgmt-recv(1): Send the zone management receive command
nvme-zns-zone-mgmt-send(1): Send the zone management send command
nvme-zns-zrwa-flush-zone(1): Flush LBAs associated with a ZRWA to a zone.

Plugins/Vendor extension commands

nvme amzn id-ctrl: Send NVMe Identify Controller
nvme amzn stats: Get EBS volume stats
nvme-dapustor-smart-log-add(1): Retrieve DapuStor SMART Log, show it
nvme dell id-ctrl: Send NVMe Identify Controller
nvme dera smart-log-add: Retrieve Dera SMART Log, show it
nvme-huawei-id-ctrl(1): Huawei identify controller
nvme-huawei-list(1): List all Huawei NVMe devices and namespaces on machine
nvme ibm crit-log: Display IBM Smart Log Information
nvme ibm persist-event-log: IBM specific Persistent Event Log
nvme ibm vpd: Display IBM VPD Information
nvme innogrit get-cdump: get cdump data
nvme innogrit get-eventlog: get event log
nvme-inspur-nvme-vendor-log(1): Retrieve Inspur Vendor Log, show it
nvme-intel-id-ctrl(1): Send NVMe Identify Controller
nvme-intel-internal-log(1): Retrieve Intel internal firmware log, save it
nvme-intel-lat-stats(1): Retrieve Intel IO Latency Statistics log, show it
nvme intel lat-stats-tracking: Enable and disable Latency Statistics logging.
nvme-intel-market-name(1): Retrieve Intel Marketing Name log, show it
nvme intel set-bucket-thresholds: Set Latency Stats Bucket Values, save it
nvme-intel-smart-log-add(1): Retrieve Intel SMART Log, show it
nvme-intel-temp-stats(1): Retrieve Intel Temperature Statistics log, show it
nvme-mangoboost-id-ctrl(1): Send NVMe Identify Controller
nvme memblaze clear-error-log: Clear error log
nvme memblaze get-pm-status: Get Memblaze Power Manager Status
nvme memblaze lat-get-feature-x: Get Enabled/Disabled of Latency Monitor feature
nvme memblaze lat-log: Set Memblaze High Latency Log
nvme memblaze lat-log-print: Output Memblaze High Latency Log
nvme memblaze lat-log-print-x: Get High Latency log and show it.
nvme memblaze lat-set-feature-x: Set Enable/Disable for Latency Monitor feature
nvme memblaze lat-stats: Enable and disable Latency Statistics logging
nvme memblaze lat-stats-print: Retrieve IO Latency Statistics log, show it
nvme memblaze lat-stats-print-x: Get Latency Statistics log and show it.
nvme memblaze perf-stats-print-x: Get Performance Stat log and show it.
nvme memblaze select-download: Selective Firmware Download
nvme memblaze set-pm-status: Set Memblaze Power Manager Status
nvme memblaze smart-log-add: Retrieve Memblaze SMART Log, show it
nvme memblaze smart-log-add-x: Retrieve Memblaze SMART Log, show it
nvme micron clear-fw-activate-history: Clear FW activation history
nvme-micron-clear-pcie-errors(1): Clear correctable PCIe errors
nvme micron cloud-SSD-plugin-version: Display plugin version info
nvme micron cloud-boot-SSD-version: Prints HyperScale Boot Version
nvme-micron-id-ctrl(1): Identify Controller
nvme micron latency-logs: Latency log details tracked by drive
nvme micron latency-stats: Latency information for tracked commands
nvme micron latency-tracking: Latency monitoring feature control
nvme micron log-page-directory: Retrieve log page directory
nvme micron plugin-version: Display plugin version info
nvme-micron-selective-download(1): Selective Firmware Download
nvme-micron-smart-log(1): Retrieve SMART/Health Log
nvme micron vs-cloud-log: Retrieve Extended Health Information of Hyperscale NVMe Boot SSD
nvme micron vs-device-waf: Reports SLC and TLC WAF ratio
nvme micron vs-drive-info: Retrieve Drive information
nvme micron vs-fw-activate-history: Display FW activation history
nvme-micron-internal-log(1): Retrieve Micron logs
nvme-micron-nand-stats(1): Retrieve NAND Stats
nvme-micron-pcie-stats(1): Retrieve Micron PCIe error stats
nvme-micron-smart-add-log(1): Retrieve extended SMART data
nvme micron vs-smart-ext-log: Retrieve extended SMART logs
nvme micron vs-smbus-option: Enable/Disable SMBUS on the drive
nvme micron vs-telemetry-controller-option: Enable/Disable controller telemetry log generation
nvme-micron-temperature-stats(1): Retrieve Micron temperature statistics
nvme micron vs-vendor-telemetry-log: Retrieve Vendor Telemetry logs
nvme micron vs-work-load-log: Retrieve Workload logs
nvme-netapp-ontapdevices(1): NetApp ONTAPdevices
nvme-netapp-smdevices(1): NetApp SMdevices
nvme nvidia id-ctrl: Send NVMe Identify Controller
nvme-ocp-clear-fw-activate-history(1): Clear Firmware Update History
nvme-ocp-clear-pcie-correctable-error-counters(1): Clear PCIe Correctable Error Counters
nvme-ocp-device-capability-log(1): Retrieve Device Capabilities Log Page
nvme-ocp-eol-plp-failure-mode(1): Define EOL or PLP Circuitry Failure Mode
nvme-ocp-error-recovery-log(1): Retrieve Error Recovery Log Page
nvme ocp fw-activate-history: Retrieve Firmware Activation History Log Page
nvme-ocp-get-clear-pcie-correctable-errors(1): Get Clear PCIe Correctable Error Counters Feature
nvme-ocp-get-dssd-async-event-config(1): Get DSSD Asynchronous Event Configuration
nvme-ocp-get-dssd-power-state-feature(1): Get DSSD Power State Feature
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
nvme-samsung-vs-internal-log(1): Retrieve and save internal firmware log
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
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
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
nvme shannon smart-log-add: Retrieve Shannon SMART Log, show it
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
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
nvme ssstc smart-log-add: Retrieve ssstc SMART Log, show it
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
nvme-transcend-badblock(1): Get NVME bad block number
nvme-transcend-healthvalue(1): NVME health percentage
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
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
nvme ymtc smart-log-add: Retrieve YMTC SMART Log, show it

GLOBAL OPTIONS

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run: Print the command that would be executed, but do not actually execute it.
--no-ioctl-probing: Disable probing for 64-bit IOCTL support.
--no-retries: Disable retry logic on transient errors.
-o <fmt>
--output-format=<fmt>: Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.
--output-format-version=<version>: Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names. Other versions are rejected.
--quiet: Suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level.
--set-options=<key=value>[,<key=value>…]: Set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir.
--timeout=<ms>: Set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff).
-v
--verbose: Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

RETURNS

All commands will behave the same, they will return 0 on success and 1 on failure.

ENVIRONMENT

NO_COLOR: When set to a non-empty value, nvme prints no colors or bold text, see https://no-color.org/. Without it, errors, warnings and headings are highlighted when they go to a terminal.

FURTHER DOCUMENTATION

See the freely available references on the Official NVM-Express Site.

Authors

This is written and maintained by Keith Busch.

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

NVME

Part of the nvme suite

nvme(1) Manual Page

NAME