📦 nvme-cli-doc

258 pages · page 1 of 2

N

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 (deprecated)✨
nvme-attach-ns(1)Send NVMe attach namespace, return result. (deprecated)✨
nvme-boot-part-log(1)Retrieves a Boot Partition log page from an NVMe device (deprecated)✨
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. (deprecated)✨
nvme-cmdset-ind-id-ns(1)Send NVMe I/O Command Set Independent Identify Namespace, return result and structure. (deprecated)✨
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. (deprecated)✨
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. (deprecated)✨
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. (deprecated)✨
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 (deprecated)✨
nvme-endurance-event-agg-log(1)Send NVMe Endurance log page request, returns result and log (deprecated)✨
nvme-endurance-log(1)Send NVMe Endurance log page request, returns result and log (deprecated)✨
nvme-error-log(1)Send NVME Error log page request, return result and log (deprecated)✨
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 (deprecated)✨
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 (deprecated)✨
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 (deprecated)✨
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's 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 (deprecated)✨
nvme-list(1)List all recognized NVMe devices✨
nvme-list-ctrl(1)Send NVMe Identify List Controllers, return result and structure (deprecated)✨
nvme-list-endgrp(1)Send NVMe Identify Endurance Group List, return result and structure (deprecated)✨
nvme-list-ns(1)Send NVMe Identify List Namespaces, return result and structure (deprecated)✨
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 (deprecated)✨
nvme-micron-clear-pcie-errors(1)Clears correctable PCIe correctable errors of given Micron device✨
nvme-micron-internal-log(1)Retrieve Micron device's 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 (deprecated)✨
nvme-ns-rescan(1)Rescans the nvme namespaces.✨
nvme-nvm-id-ctrl(1)Send NVMe Identify Controller, return NVM command set structure (deprecated)✨
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…✨
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-telemetry-string-log-page(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 (deprecated)✨
nvme-pred-lat-event-agg-log(1)Send Predictable Latency Event Aggregate Log Page request, returns result and log (deprecated)✨
nvme-predictable-lat-log(1)Send Predictable latency per NVM set log page request, returns result and log (deprecated)✨
nvme-primary-ctrl-caps(1)Send identify Primary Controller Caps, return result and structure (deprecated)✨
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 (deprecated)✨
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 (deprecated)✨
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's 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's help information✨
nvme-seagate-plugin-version(1)Shows Seagate plugin's 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 (deprecated)✨
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 (deprecated)✨
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-boot-SSD-version(1)Display sndk plugin Cloud Boot SSD Version✨
nvme-sndk-cloud-SSD-plugin-version(1)Display sndk plugin Cloud SSD Plugin 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's 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's 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's 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 (deprecated)✨
nvme-tls-key(1)Manage NVMe TLS PSKs (deprecated)✨
nvme-toshiba-clear-pcie-correctable-errors(1)Reset the PCIe correctable errors count to zero.✨