nvme-reset – Reset the nvme controller. Synopsisnvme reset <device>DescriptionRequests NVMe controller reset. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0). OptionsNone Examples• Resets the controller. # nvme reset /dev/nvme0NvmePart of the nvme-user suite
nvme-read – Send an NVMe Read command, provide results Synopsisnvme-read <device> [–start-block=<slba> | -s <slba>] [–block-count=<nlb> | -c <nlb>] [–data-size=<size> | -z <size>] [–metadata-size=<size> | -y <size>] [–ref-tag=<reftag> | -r <reftag>] [–data=<data-file> | -d <data-file>] [–metadata=<metadata-file> | -M <metadata-file>] [–prinfo=<prinfo> | -p <prinfo>] [–app-tag-mask=<appmask> | -m <appmask>] [–app-tag=<apptag> | -a <apptag>] [–limited-retry | -l] [–latency…
nvme-list – List all recognized NVMe devices Synopsisnvme listDescriptionScan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinent information about them. OptionsNo options yet. ExamplesNo examples yet. NvmePart of the nvme-user suite
nvme-list-ns – Send NVMe Identify List Namespaces, return result and structure Synopsisnvme list-ns <device> [–namespace-id=<nsid> | -n <nsid>]DescriptionFor the NVMe device given, sends an identify command for namespace list and provides the result and returned structure. The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block…
nvme-list-ctrl – Send NVMe Identify List Controllers, return result and structure Synopsisnvme list-ctrl <device> [–cntid=<cntid> | -c <cntid>] [–namespace-id=<nsid> | -n <nsid>] DESCRIPTIONFor the NVMe device given, sends an identify command for controller list and provides the result and returned structure. This uses either mode 12h or 13h depending on the requested namespace identifier. The…
nvme-io-passthru – Submit an arbitrary io command, return results Synopsisnvme-io-passthru <device> [–opcode=<opcode> | -o <opcode>] [–flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>] [–namespace-id=<nsid> | -nsid <nsid>] [–cdw2=<cdw2>] [–cdw3=<cdw3>] [–cdw10=<cdw10>] [–cdw11=<cdw11>] [–cdw12=<cdw12>] [–cdw13=<cdw13>] [–cdw14=<cdw14>] [–cdw15=<cdw15>] [–data-len=<data-len> | -l <data-len>] [–metadata-len=<len> | -m <len>] [–read | -r ] [–write | -w] [–input-file=<file> | -f <file>] [–timeout=<to>…
nvme-id-ns – Send NVMe Identify Namespace, return result and structure Synopsisnvme id-ns <device> [-v | –vendor-specific] [-b | –raw-binary] [–namespace-id=<nsid> | -n <nsid>] [-f | –force]DescriptionFor the NVMe device given, sends an identify namespace command and provides the result and returned structure. The <device> parameter is mandatory and may be either the NVMe character device…
nvme-id-ctrl – Send NVMe Identify Controller, return result and structure Synopsisnvme id-ctrl <device> [-v | –vendor-specific] [-b | –raw-binary]DescriptionFor the NVMe device given, sends an identify controller command and provides the result and returned structure. The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device…
nvme-help – Help information. Synopsisnvme help [<command>]DescriptionProvides help information, with detailed information about the given command if provided. OptionsNo Options Examples• Show help for nvme smart log: # nvme help smart-log Not much to itNvmePart of the nvme-user suite
nvme-get-ns-id – Retrieves the namespace ID for an NVMe block device Synopsisnvme get-ns-id <device>DescriptionRetrieves the namespace ID for an NVMe block device. The <device> param is mandatory and must be an NVMe block device (ex: /dev/nvme0n1). OptionsNone Examples• Shows the namespace id for the given block device: # nvme get-ns-id /dev/nvme0n1NvmePart of the nvme-user suite
nvme-get-log – Retrieves a log page from an NVMe device Synopsisnvme get-log <device> [–log-id=<log-id> | -i <log-id>] [–log-len=<log-len> | -l <log-len>] [–namespace-id=<nsid> | -n <nsid>] [–raw-binary | -b]DescriptionRetrieves an arbitrary NVMe log page from an NVMe device and provides the retuned structure. The <device> parameter is mandatory and may be either the NVMe character device…
nvme-get-feature – Gets an NVMe feature, returns applicable results Synopsisnvme get-feature <device> [–namespace-id=<nsid> | -n <nsid>] [–feature-id=<fid> | -f <fid>] [–cdw11=<cdw11>] [–data-len=<data-len> | -l <data-len>] [–sel=<select> | -s <select>] [–raw-binary | -b]DescriptionSubmits an NVMe Get Feature admin command and returns the applicable results. This may be the feature’s value, or may also include a feature…
nvme-fw-log – Send NVMe Firmware log page request, returns result and log Synopsisnvme fw-log <device> [–raw-binary | -b]DescriptionRetrieves the NVMe Firmware log page from an NVMe device and provides the retuned structure. The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). On…
nvme-fw-download – Download all or a portion of an nvme firmware image. Synopsisnvme fw-download <device> [–fw=<firmware-file> | -f <firmware-file>] [–xfer=<transfer-size> | -x <transfer-size>] [–offset=<offset> | -o <offset>]DescriptionThe Firmware Image Download command is used to download all or a portion of the firmware image for a future update to the controller. The Firmware Image Download command…
nvme-fw-activate – Used to verify and commit a firmware image. Synopsisnvme fw-activate <device> [–slot=<slot> | -s <slot>] [–action=<action> | -a <action>]DescriptionFor the NVMe device given, send an nvme Firmware Activate admin command and provides the results. The Firmware Activate command is used to verify that a valid firmware image has been downloaded and to commit…
nvme-format – Format an NVMe device Synopsisnvme format <device> [–namespace-id=<nsid> | -n <nsid>] [–lbaf=<lbaf> | -l <lbaf>] [–ses=<ses> | -s <ses>] [–pil=<pil> | -p <pil>] [–pi=<pi> | -i <pi>] [–ms=<ms> | -m <ms>]DescriptionFor the NVMe device given, send an nvme Format Namespace admin command and provides the results. The <device> parameter is mandatory and may…
nvme-flush – Flush command. Synopsisnvme flush <device> [–namespace-id=<nsid> | -n <nsid>]DescriptionThe Flush command shall commit data and metadata associated with the specified namespace(s) to nonvolatile media. The flush applies to all commands completed prior to the submission of the Flush command. The controller may also flush additional data and/or metadata from any namespace. Options-n <nsid>,…
nvme-error-log – Send NVME Error log page request, return result and log Synopsisnvme error-log <device> [–namespace-id=<nsid> | -n <nsid>] [–log-entries=<entries> | -e <entries>] [–raw-binary | -b]DescriptionRetrieves NVMe Error log page from an NVMe device and provides the retuned structure. The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or…
nvme-dsm – Send NVMe Data Set Management, return results Synopsisnvme dsm <device> [ –namespace-id=<nsid> | -n <nsid> ] [ –ctx-attrs=<attribute-list,> | -a <attribute-list,> ] [ –blocks=<nlb-list,> | -b <nlb-list,> ] [ –slbs=<slba-list,> | -s <slba-list,> ] [ –ad | -d ] [ –idw | -w ] [ –idr | -r ] [ –cdw11=<cdw11> | -c…
nvme-detach-ns – Send NVMe detach namespace, return result. Synopsisnvme detach-ns <device> [–namespace-id=<nsid> | -n <nsid>] [–controllers=<ctrl-list,> | -c <ctrl-list,>DescriptionFor the NVMe device given, sends the nvme namespace detach command for the provided namespace identifier, attaching to the provided list of controller identifiers. Options-n <nsid>, –namespace-id=<nsid> The namespace identifier to detach. -c <ctrl-list,>, -controllers=<ctrl-list,> The comma…