home βΊ Package nvme
Package nvme
nvme(1) β the NVMe storage command line interface utility (nvme\-cli)
nvme-admin-passthru(1) β Submit an arbitrary admin command, return results
nvme-ana-log(1) β Send NVMe ANA log page request, returns result and log
nvme-attach-ns(1) β Send NVMe attach namespace, return result.
nvme-boot-part-log(1) β Retrieves a Boot Partition log page from an NVMe device
nvme-capacity-mgmt(1) β Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results.
nvme-changed-ns-list-log(1) β Send NVMe Changed Namespace List log page request, returns result and log.
nvme-cmdset-ind-id-ns(1) β Send NVMe I/O Command Set Independent Identify Namespace, return result and structure.
nvme-compare(1) β Send an NVMe Compare command, provide results
nvme-connect(1) β Connect to a Fabrics controller.
nvme-connect-all(1) β Discover and Connect to Fabrics controllers.
nvme-copy(1) β Send an NVMe Simple Copy command, provide results
nvme-create-ns(1) β Send NVMe Namespace management command to create namespace, returns results.
nvme-dapustor-smart-log-add(1) β Send NVMe DapuStor Additional SMART log page request, returns result and log
nvme-delete-ns(1) β Send NVMe Namespace Management delete namespace command, return result.
nvme-dera-stat(1) β Send NVMe Dera Device status and Additional SMART log page request, returns result and log
nvme-detach-ns(1) β Send NVMe detach namespace, return result.
nvme-device-self-test(1) β Perform the necessary tests to observe the performance and the parameters
nvme-dim(1) β Send Discovery Information Management command to one or more Discovery Controllers.
nvme-dir-receive(1) β Send a directive receive command, returns applicable results
nvme-dir-send(1) β Issue a directive send command, returns applicable results
nvme-disconnect(1) β Disconnect one or more Fabrics controller(s).
nvme-disconnect-all(1) β Disconnect from all connected Fabrics controllers.
nvme-discover(1) β Send Get Log Page request to Discovery Controller.
nvme-dsm(1) β Send NVMe Data Set Management, return results
nvme-effects-log(1) β Send NVMe Command Effects log page request, returns result and log
nvme-endurance-event-agg-log(1) β Send NVMe Endurance log page request, returns result and log
nvme-endurance-log(1) β Send NVMe Endurance log page request, returns result and log
nvme-error-log(1) β Send NVME Error log page request, return result and log
nvme-fdp-configs(1) β Get Flexible Data Placement Configurations
nvme-fdp-events(1) β Get Flexible Data Placement Events
nvme-fdp-feature(1) β Show or change Flexible Data Placement (FDP) Feature
nvme-fdp-set-events(1) β Enable or disable FDP events
nvme-fdp-stats(1) β Get Flexible Data Placement Statistics
nvme-fdp-status(1) β Get Reclaim Unit Handle Status
nvme-fdp-update(1) β Reclaim Unit Handle Update
nvme-fdp-usage(1) β Get Reclaim Unit Handle Usage
nvme-fid-support-effects-log(1) β Send NVMe FID Support and Effects log, return result and structure
nvme-flush(1) β Flush command.
nvme-format(1) β Format an NVMe device
nvme-fw-commit(1) β Used to verify and commit a firmware image.
nvme-fw-download(1) β Download all or a portion of an nvme firmware image.
nvme-fw-log(1) β Send NVMe Firmware log page request, returns result and log
nvme-gen-hostnqn(1) β Generate a host NVMe Qualified Name
nvme-get-feature(1) β Gets an NVMe feature, returns applicable results
nvme-get-lba-status(1) β Get LBA Status from NVMe device
nvme-get-log(1) β Retrieves a log page from an NVMe device
nvme-get-ns-id(1) β Retrieves the namespace ID for an NVMe block device
nvme-get-property(1) β Reads and shows the defined NVMe controller property for NVMe over Fabric
nvme-help(1) β Help information.
nvme-huawei-id-ctrl(1) β Send NVMe Identify Controller, return result and structure
nvme-huawei-list(1) β List all recognized Huawei NVMe devices
nvme-id-ctrl(1) β Send NVMe Identify Controller, return result and structure
nvme-id-domain(1) β Send NVMe Identify Domain List, return result and structure
nvme-id-iocs(1) β Send NVMe Identify I/O Command Set, return result and structure
nvme-id-ns(1) β Send NVMe Identify Namespace, return result and structure
nvme-id-nvmset(1) β Send NVMe Identify NVM Set List, return result and structure
nvme-inspur-nvme-vendor-log(1) β Send NVMe Inspur Device Vendor log page request, returns result
nvme-intel-id-ctrl(1) β Send NVMe Identify Controller, return result and structure
nvme-intel-internal-log(1) β Retrieve Intel device\*(Aqs internal log and save to file.
nvme-intel-lat-stats(1) β Send NVMe Identify Controller, return result and structure
nvme-intel-market-name(1) β Send NVMe Identify Controller, return result and structure
nvme-intel-smart-log-add(1) β Send NVMe Intel Additional SMART log page request, returns result and log
nvme-intel-temp-stats(1) β Send NVMe SMART log page request, returns result and log
nvme-io-mgmt-recv(1) β I/O Management Receive command
nvme-io-mgmt-send(1) β I/O Management Send command
nvme-io-passthru(1) β Submit an arbitrary io command, return results
nvme-lba-status-log(1) β Send LBA Status Log Page request returns result and log
nvme-list(1) β List all recognized NVMe devices
nvme-list-ctrl(1) β Send NVMe Identify List Controllers, return result and structure
nvme-list-endgrp(1) β Send NVMe Identify Endurance Group List, return result and structure
nvme-list-ns(1) β Send NVMe Identify List Namespaces, return result and structure
nvme-list-subsys(1) β List all NVMe subsystems
nvme-lockdown(1) β Send an NVMe Lockdown command to prohibit or allow the execution of command
nvme-mangoboost-id-ctrl(1) β Send NVMe Identify Controller, return result and structure
nvme-mi-cmd-support-effects-log(1) β Send NVMe MI Command Support and Effects log, returns results and structure
nvme-micron-clear-pcie-errors(1) β Clears correctable PCIe correctable errors of given Micron device
nvme-micron-internal-log(1) β Retrieve Micron device\*(Aqs internal logs and save to given zip file.
nvme-micron-nand-stats(1) β Retrieves NAND statistics of given micron device
nvme-micron-pcie-stats(1) β Retrieves pcie error statistics for given micron device
nvme-micron-selective-download(1) β Performs selective firmware download that allows user select which firmware binary to update for 9200 devices. This requires power cycle the update completes.
nvme-micron-smart-add-log(1) β Retrieves NAND statistics (2200 model drives) or Extended SMART information (OCP complaint models) of given micron device
nvme-micron-temperature-stats(1) β Retrieves temperature information of given micron device
nvme-netapp-ontapdevices(1) β Display information about ONTAP devices
nvme-netapp-smdevices(1) β Display information for each NVMe path to an E\-Series volume
nvme-ns-descs(1) β Send NVMe Identify for a list of Namespace Identification Descriptor structure, return result and structure
nvme-ns-rescan(1) β Rescans the nvme namespaces.
nvme-nvm-id-ctrl(1) β Send NVMe Identify Controller, return NVM command set structure
nvme-nvme-mi-recv(1) β Send a NVMe\-MI Receive command to the specified device
nvme-nvme-mi-send(1) β Send a NVMe\-MI Send command to the specified device
nvme-ocp-clear-fw-activate-history(1) β Clear the OCP Firmware Update History Log
nvme-ocp-clear-pcie-correctable-error-counters(1) β Clear PCIe correctable error counters
nvme-ocp-device-capability-log(1) β Retrieves OCP Device Capability Log Page
nvme-ocp-eol-plp-failure-mode(1) β Define and print EOL or PLP circuitry failure mode
nvme-ocp-error-recovery-log(1) β Retrieves OCP Error Recovery Log Page
nvme-ocp-get-dssd-async-event-config(1) β Get dssd\-async\-event\-config value
nvme-ocp-get-dssd-power-state-feature(1) β Get DSSD Power State
nvme-ocp-get-plp-health-check-interval(1) β Define and print plp\-health\-check\-interval value
nvme-ocp-internal-log(1) β Conditionally retrieves 07h Telemetry Host\-Initiated log, C9h OCP Strings Log from an NVMe device or from user\-specified file path. Takes retrieved logs and decodes into human\-readable output format specified by user.
nvme-ocp-latency-monitor-log(1) β Display latency monitor log page data in human readable format
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
nvme-ocp-set-plp-health-check-interval(1) β Define and set PLP health check interval
nvme-ocp-set-telemetry-profile(1) β Set Telemetry Profile
nvme-ocp-smart-add-log(1) β Retrieves Extended SMART information of given OCP compliant device
nvme-ocp-telemetry-string-log(1) β Retrieve OCP Telemetry String Log page
nvme-ocp-unsupported-reqs-log(1) β Retrieves unsupported requirements log page of given OCP compliant device
nvme-persistent-event-log(1) β Send NVMe persistent event log page request, returns result and log
nvme-pred-lat-event-agg-log(1) β Send Predictable Latency Event Aggregate Log Page request, returns result and log
nvme-predictable-lat-log(1) β Send Predictable latency per NVM set log page request, returns result and log
nvme-primary-ctrl-caps(1) β Send identify Primary Controller Caps, return result and structure
nvme-read(1) β Send an NVMe Read command, provide results
nvme-reset(1) β Reset the nvme controller.
nvme-resv-acquire(1) β Acquire an nvme reservation
nvme-resv-notif-log(1) β Send NVMe Reservation Notification log page request, return result and log
nvme-resv-register(1) β Register an nvme reservation
nvme-resv-release(1) β Release an nvme reservation
nvme-resv-report(1) β Send NVMe Reservation Report, parse the result
nvme-rpmb(1) β Send RPMB commands to an NVMe device
nvme-sanitize(1) β Send NVMe Sanitize Command, return result
nvme-sanitize-log(1) β Send NVMe sanitize\-log Command, return result
nvme-seagate-clear-fw-activate-history(1) β Clear the firmware activation history for a given Seagate device.
nvme-seagate-clear-pcie-correctable-errors(1) β Clear Seagate PCIe error statistics
nvme-seagate-cloud-SSD-plugin-version(1) β Shows OCP Seagate plugin\*(Aqs version information
nvme-seagate-get-ctrl-tele(1) β Retrieve Seagate Controller\-Initiated Telemetry in either hex\-dump (default) or binary format
nvme-seagate-get-host-tele(1) β Retrieve Seagate Host\-Initiated Telemetry in either hex\-dump (default) or binary format
nvme-seagate-help(1) β Shows the Seagate plugin\*(Aqs help information
nvme-seagate-plugin-version(1) β Shows Seagate plugin\*(Aqs version information
nvme-seagate-version(1) β Shows the Seagate version information for nvme\-cli
nvme-seagate-vs-fw-activate-history(1) β Retrieve Seagate vendor specific Controller\-Initiated Telemetry in binary
nvme-seagate-vs-internal-log(1) β Retrieve Seagate vendor specific Controller\-Initiated Telemetry in binary
nvme-seagate-vs-log-page-sup(1) β Retrieve Seagate vendor specific Supported Log\-pages Information
nvme-seagate-vs-pcie-stats(1) β Retrieve Seagate vendor specific PCIe error statistics
nvme-seagate-vs-smart-add-log(1) β Retrieve Seagate vendor specific extended\-SMART Information
nvme-seagate-vs-temperature-stats(1) β Retrieve Seagate vendor specific temperature statistics
nvme-security-recv(1) β Security Recv command
nvme-security-send(1) β Security Send command
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 locking password of a SED device
nvme-sed-revert(1) β Revert a SED Opal Device from locking
nvme-sed-unlock(1) β Unlock a SED Opal Device
nvme-self-test-log(1) β Retrieve the log information initiated by device\-self\-test and display it
nvme-set-feature(1) β Sets an NVMe feature, returns applicable results
nvme-set-property(1) β Writes and shows the defined NVMe controller property for NVMe over Fabric
nvme-show-hostnqn(1) β Show the host NQN configured for the system
nvme-show-regs(1) β Reads and shows the defined NVMe controller registers for NVMe over PCIe or the controller properties for NVMe over Fabrics.
nvme-show-topology(1) β Show topology of all NVMe subsystems
nvme-smart-log(1) β Send NVMe SMART log page request, returns result and log
nvme-sndk-capabilities(1) β Display sndk device command capabilities
nvme-sndk-clear-assert-dump(1) β Clears the assert dump (if present).
nvme-sndk-clear-fw-activate-history(1) β Clears the firmware activate history table.
nvme-sndk-clear-pcie-correctable-errors(1) β Clears the pcie correctable errors field returned in the smart\-log\-add command.
nvme-sndk-cloud-SSD-plugin-version(1) β Display sndk plugin Cloud SSD Plugin Version
nvme-sndk-cloud-boot-SSD-version(1) β Display sndk plugin Cloud Boot SSD Version
nvme-sndk-cu-smart-log(1) β Send NVMe Sandisk cu\-smart\-log Vendor Unique Command, return result
nvme-sndk-drive-resize(1) β Send NVMe sndk Resize Vendor Unique Command, return result.
nvme-sndk-get-dev-capabilities-log(1) β Send NVMe sndk get\-dev\-capabilities\-log plugin command, return parsed log output
nvme-sndk-get-drive-status(1) β Send the NVMe sndk get\-drive\-status command, return result
nvme-sndk-get-error-recovery-log(1) β Send NVMe sndk get\-error\-recovery\-log plugin command, return parsed log output.
nvme-sndk-get-latency-monitor-log(1) β Display latency monitor log page data in human readable format
nvme-sndk-get-unsupported-reqs-log(1) β Send NVMe sndk get\-unsupported\-reqs\-log plugin command, return parsed log output
nvme-sndk-log-page-directory(1) β Retrieves the list of Log IDs supported by the drive
nvme-sndk-namespace-resize(1) β Resizes the device\*(Aqs namespace.
nvme-sndk-set-latency-monitor-feature(1) β Set NVMe sndk latency monitor feature options
nvme-sndk-vs-cloud-log(1) β Send NVMe sndk vs\-cloud\-log Vendor Unique Command, return result
nvme-sndk-vs-device-waf(1) β Calculates the device write amplification factor and prints both TLC and SLC results
nvme-sndk-vs-drive-info(1) β Send the NVMe sndk vs\-drive\-info command, return result
nvme-sndk-vs-error-reason-identifier(1) β Retrieve sndk device\*(Aqs telemetry log error reason identifier field
nvme-sndk-vs-fw-activate-history(1) β Execute NVMe sndk vs\-fw\-activate\-history Vendor Unique Command, return result
nvme-sndk-vs-hw-rev-log(1) β Send NVMe sndk vs\-hw\-rev\-log Vendor Unique Command, return result
nvme-sndk-vs-internal-log(1) β Retrieve sndk device\*(Aqs internal firmware log and save to file.
nvme-sndk-vs-nand-stats(1) β Send NVMe sndk vs\-nand\-stats Vendor Unique Command, return result
nvme-sndk-vs-pcie-stats(1) β Send the NVMe sndk vs\-pcie\-stats command, return result
nvme-sndk-vs-smart-add-log(1) β Send NVMe sndk vs\-smart\-add\-log Vendor Unique Command, return result
nvme-sndk-vs-telemetry-controller-option(1) β Disable/Enable the controller initiated option of the telemetry log page.
nvme-sndk-vs-temperature-stats(1) β Display temperature\-related statistics
nvme-solidigm-clear-fw-activate-history(1) β Clear firmware update history log
nvme-solidigm-clear-pcie-correctable-errors(1) β Clear PCIe Correctable Error Counters
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, return result and structure
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 and display Solidigm Telemetry log
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
nvme-solidigm-vs-internal-log(1) β Retrieve Debug log binaries
nvme-solidigm-vs-smart-add-log(1) β Get SMART / health extended log
nvme-solidigm-workload-tracker(1) β Real\-time capture of Workload Tracker samples
nvme-subsystem-reset(1) β Reset the nvme subsystem.
nvme-supported-log-pages(1) β Send NVMe Supported Log pages request, returns result and log
nvme-telemetry-log(1) β Retrieves a Telemetry Host\-Initiated log page from an NVMe device
nvme-tls-key(1) β Manage NVMe TLS PSKs
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\*(Aqs vendor specific internal log and either save to file or dump the contents.
nvme-toshiba-vs-smart-add-log(1) β Retrieve a Toshiba device\*(Aqs vendor specific extended SMART log page contents and either save to file or dump the contents.
nvme-transcend-badblock(1) β Retrieve Transcend NVMe device\*(Aqs bad blocks.
nvme-transcend-healthvalue(1) β Use NVMe SMART table to analyze the health value of Transcend device.
nvme-verify(1) β Send an NVMe Verify command, return results
nvme-virtium-save-smart-to-vtview-log(1) β Periodically save smart attributes into a log file (csv format).
nvme-virtium-show-identify(1) β Show a complete detail of identify device information in json format.
nvme-wdc-cap-diag(1) β Retrieve WDC device\*(Aqs diagnostic log and save to file.
nvme-wdc-capabilities(1) β Display WDC plugin command capabilities
nvme-wdc-clear-assert-dump(1) β Clears the assert dump (if present).
nvme-wdc-clear-fw-activate-history(1) β Clears the firmware activate history table.
nvme-wdc-clear-pcie-correctable-errors(1) β Clears the pcie correctable errors field returned in the smart\-log\-add command.
nvme-wdc-cloud-SSD-plugin-version(1) β Display WDC plugin Cloud SSD Plugin Version
nvme-wdc-cloud-boot-SSD-version(1) β Display WDC plugin Cloud Boot SSD Version
nvme-wdc-cu-smart-log(1) β Send NVMe WDC cu\-smart\-log Vendor Unique Command, return result
nvme-wdc-drive-essentials(1) β Retrieve WDC device\*(Aqs drive essentials bin files and save to a tar file.
nvme-wdc-drive-log(1) β Retrieve WDC device\*(Aqs drive log and save to file.
nvme-wdc-drive-resize(1) β Send NVMe WDC Resize Vendor Unique Command, return result.
nvme-wdc-enc-get-log(1) β Send NVMe WDC enc\-get\-log Vendor Unique Command, return result.
nvme-wdc-get-crash-dump(1) β Retrieve WDC device\*(Aqs crash dump.
nvme-wdc-get-dev-capabilities-log(1) β Send NVMe WDC get\-dev\-capabilities\-log plugin command, return parsed log output
nvme-wdc-get-drive-status(1) β Send the NVMe WDC get\-drive\-status command, return result
nvme-wdc-get-error-recovery-log(1) β Send NVMe WDC get\-error\-recovery\-log plugin command, return parsed log output
nvme-wdc-get-latency-monitor-log(1) β Display latency monitor log page data in human readable format
nvme-wdc-get-pfail-dump(1) β Retrieve WDC device\*(Aqs pfail crash dump.
nvme-wdc-get-unsupported-reqs-log(1) β Send NVMe WDC get\-unsupported\-reqs\-log plugin command, return parsed log output
nvme-wdc-id-ctrl(1) β Send NVMe Identify Controller, return result and structure
nvme-wdc-log-page-directory(1) β Retrieves the list of Log IDs supported by the drive
nvme-wdc-namespace-resize(1) β Resizes the device\*(Aqs namespace.
nvme-wdc-purge(1) β Send NVMe WDC Purge Vendor Unique Command, return result
nvme-wdc-purge-monitor(1) β Send NVMe WDC Purge\-Monitor Vendor Unique Command, return result
nvme-wdc-vs-cloud-log(1) β Send NVMe WDC vs\-cloud\-log Vendor Unique Command, return result
nvme-wdc-vs-device-waf(1) β Calculates the device write amplification factor and prints both TLC and SLC results
nvme-wdc-vs-drive-info(1) β Send the NVMe WDC vs\-drive\-info command, return result
nvme-wdc-vs-error-reason-identifier(1) β Retrieve WDC device\*(Aqs telemetry log error reason identifier field
nvme-wdc-vs-fw-activate-history(1) β Execute NVMe WDC vs\-fw\-activate\-history Vendor Unique Command, return result
nvme-wdc-vs-hw-rev-log(1) β Send NVMe WDC vs\-hw\-rev\-log Vendor Unique Command, return result
nvme-wdc-vs-internal-log(1) β Retrieve WDC device\*(Aqs internal firmware log and save to file.
nvme-wdc-vs-nand-stats(1) β Send NVMe WDC vs\-nand\-stats Vendor Unique Command, return result
nvme-wdc-vs-smart-add-log(1) β Send NVMe WDC vs\-smart\-add\-log Vendor Unique Command, return result
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
nvme-write(1) β Send an NVMe write command, provide results
nvme-write-uncor(1) β Send an NVMe write uncorrectable command, return results
nvme-write-zeroes(1) β Send an NVMe write zeroes command, return results
nvme-zns-changed-zone-list(1) β Retrieve Changed Zone log for the given device
nvme-zns-close-zone(1) β Closes one or all zones
nvme-zns-finish-zone(1) β Finishes one or all zones
nvme-zns-id-ctrl(1) β Send NVMe Zoned Command Set Identify Controller, return result and structure
nvme-zns-id-ns(1) β Send NVMe Zoned Command Set Identify namespace, return result and structure
nvme-zns-offline-zone(1) β Offlines one or all zones
nvme-zns-open-zone(1) β Opens one or all zones
nvme-zns-report-zones(1) β Retrieve and display the Report Zones data structure
nvme-zns-reset-zone(1) β Resets one or all zones
nvme-zns-set-zone-desc(1) β Set extended descriptor data for a zone
nvme-zns-zone-append(1) β Send an NVMe write command, provide results
nvme-zns-zone-mgmt-recv(1) β Zone Management Receive command
nvme-zns-zone-mgmt-send(1) β Zone Management Send command