Section 1: user commands and tools
NAME nvme-resv-release – Release an nvme reservation SYNOPSIS nvme resv-release <device> DESCRIPTION The Reservation Release command is used to release or clear a reservation held on a namespace. OPTIONS -n <nsid>, –namespace-id=<nsid> Override the nsid field. If using the admin character device, this parameter is required. -c <crkey>, –crkey=<crkey> Current Reservation Key: If the Reservation…
NAME nvme-resv-register – Register an nvme reservation SYNOPSIS nvme resv-register <device> DESCRIPTION The Reservation Register command is used to register, unregister, or replace a reservation key. OPTIONS -n <nsid>, –namespace-id=<nsid> Override the nsid field. If using the admin character device, this parameter is required. -c <crkey>, –crkey=<crkey> Current Reservation Key: If the Reservation Register Action…
NAME nvme-resv-acquire – Acquire an nvme reservation SYNOPSIS nvme resv-acquire <device> DESCRIPTION The Reservation Acquire command is used to acquire a reservation on a namespace, preempt a reservation held on a namespace, and abort a reservation held on a namespace. OPTIONS -n <nsid>, –namespace-id=<nsid> Override the nsid field. If using the admin character device, this…
NAME nvme-reset – Reset the nvme controller. SYNOPSIS nvme reset <device> DESCRIPTION Requests NVMe controller reset. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0). OPTIONS None EXAMPLES • Resets the controller. # nvme reset /dev/nvme0 NVME Part of the nvme-user suite Index
NAME nvme-read – Send an NVMe Read command, provide results SYNOPSIS nvme – 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…
NAME nvme-list – List all recognized NVMe devices SYNOPSIS nvme list DESCRIPTION Scan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinent information about them. OPTIONS No options yet. EXAMPLES No examples yet. NVME Part of the nvme-user suite Index
NAME nvme-list-ns – Send NVMe Identify List Namespaces, return result and structure SYNOPSIS nvme list-ns <device> [–namespace-id=<nsid> | -n <nsid>] DESCRIPTION For 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),…
NAME nvme-list-ctrl – Send NVMe Identify List Controllers, return result and structure SYNOPSIS nvme list – ctrl<device>[–cntid = <cntid> | -c<cntid>] [–namespace – id = <nsid> | -n<nsid>] DESCRIPTION For 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…
NAME nvme-io-passthru – Submit an arbitrary io command, return results SYNOPSIS nvme – 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 -…
NAME nvme-id-ns – Send NVMe Identify Namespace, return result and structure SYNOPSIS nvme id – ns<device>[-v | –vendor – specific][-b | –raw – binary] [–namespace – id = <nsid> | -n<nsid>][-f | –force] DESCRIPTION For the NVMe device given, sends an identify namespace command and provides the result and returned structure. The <device> parameter is…
NAME nvme-id-ctrl – Send NVMe Identify Controller, return result and structure SYNOPSIS nvme id – ctrl<device>[-v | –vendor – specific][-b | –raw – binary] DESCRIPTION For 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…
NAME nvme-help – Help information. SYNOPSIS nvme help [<command>] DESCRIPTION Provides help information, with detailed information about the given command if provided. OPTIONS No Options EXAMPLES • Show help for nvme smart log: # nvme help smart-log Not much to it NVME Part of the nvme-user suite Index
NAME nvme-get-ns-id – Retrieves the namespace ID for an NVMe block device SYNOPSIS nvme get-ns-id <device> DESCRIPTION Retrieves the namespace ID for an NVMe block device. The <device> param is mandatory and must be an NVMe block device (ex: /dev/nvme0n1). OPTIONS None EXAMPLES • Shows the namespace id for the given block device: # nvme…
NAME nvme-get-log – Retrieves a log page from an NVMe device SYNOPSIS nvme 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] DESCRIPTION Retrieves an arbitrary NVMe log…
NAME nvme-get-feature – Gets an NVMe feature, returns applicable results SYNOPSIS nvme 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] DESCRIPTION Submits an NVMe…
NAME nvme-fw-log – Send NVMe Firmware log page request, returns result and log SYNOPSIS nvme fw-log <device> [–raw-binary | -b] DESCRIPTION Retrieves 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…
NAME nvme-fw-download – Download all or a portion of an nvme firmware image. SYNOPSIS nvme fw – download<device>[–fw = <firmware – file> | -f<firmware – file>] [–xfer = <transfer – size> | -x<transfer – size>] [–offset = <offset> | -o<offset>] DESCRIPTION The Firmware Image Download command is used to download all or a portion of…
NAME nvme-fw-activate – Used to verify and commit a firmware image. SYNOPSIS nvme fw – activate<device>[–slot = <slot> | -s<slot>] [–action = <action> | -a<action>] DESCRIPTION For 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…
NAME nvme-format – Format an NVMe device SYNOPSIS nvme 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>] DESCRIPTION For the NVMe device given, send an nvme Format Namespace admin command and…
NAME nvme-flush – Flush command. SYNOPSIS nvme flush <device> [–namespace-id=<nsid> | -n <nsid>] DESCRIPTION The 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…