The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
NAME nvme-write-zeroes – Send an NVMe write zeroes command, return results SYNOPSIS nvme – write – zeroes<device>[–start – block = <slba> | -s<slba>][–block – count = <nlb> | -c<nlb>][–ref – tag = <reftag> | -r<reftag>][–prinfo = <prinfo> | -p<prinfo>][–app – tag – mask = <appmask> | -m<appmask>][–app – tag = <apptag> | -a<apptag>][–limited – retry…
NAME nvme-write-uncor – Send an NVMe write uncorrectable command, return results SYNOPSIS nvme – write – zeroes<device>[–start – block = <slba> | -s<slba>][–block – count = <nlb> | -c<nlb>][–namespace – id = <nsid> | -n<nsid>] DESCRIPTION The Write Zeroes command is used to set a range of logical blocks to 0. OPTIONS –start-block=<slba>, -s <slba>…
NAME nvme-subsystem-reset – Reset the nvme subsystem. SYNOPSIS nvme subsystem-reset <device> DESCRIPTION Requests NVMe subsystem reset. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0). OPTIONS None EXAMPLES • Resets the subsystem. # nvme subsystem-reset /dev/nvme0 NVME Part of the nvme-user suite Index
NAME nvme-smart-log – Send NVMe SMART log page request, returns result and log SYNOPSIS nvme smart – log<device>[–namespace – id = <nsid> | -n<nsid>] [–raw – binary | -b] DESCRIPTION Retrieves the NVMe SMART log page from an NVMe device and provides the retuned structure. The <device> parameter is mandatory and may be either the…
NAME nvme-show-regs – Reads and shows the defined NVMe controller registers. SYNOPSIS nvme show-regs <device> DESCRIPTION For the NVMe device given, sends an identify namespace command and provides the result and returned structure. The <device> parameter is mandatory and must be the nvme admin character device (ex: /dev/nvme0). The program uses knowledge of the sysfs…
NAME nvme-set-feature – Sets an NVMe feature, returns applicable results SYNOPSIS nvme set – feature<device>[–namespace – id = <nsid> | -n<nsid>] [–feature – id = <fid> | -f<fid>][–value = <value>] [–data – len = <data – len> | -l<data – len>] [–data = <data – file> | -d<data – file>] [–raw – binary | -b]…
NAME nvme-security-send – Security Send command SYNOPSIS nvme security – send[<device>][–file = <file> | -f<file>] [–secp = <security – protocol> | -p<security – protocol>] [–spsp = <protocol – specific> | -s<protocol – specific>] [–tl = <transfer – length> | -t<transfer – length>] [–nssf = <nvme – specific> | -N<nvme – specific>] [–namespace – id =…
NAME nvme-security-recv – Security Recv command SYNOPSIS nvme security – recv[<device>][–size = <size> | -x<size>] [–secp = <security – protocol> | -p<security – protocol>] [–spsp = <protocol – specific> | -s<protocol – specific>] [–nssf = <nvme – specific> | -N<nvme – specific>] [–tl = <transfer – length> | -t<transfer – length>] [–namespace – id =…
NAME nvme-resv-report – Send NVMe Reservation Report, parse the result SYNOPSIS nvme resv – report<device>[–namespace – id = <nsid> | -n<nsid>] [–numd = <num – dwords> | -d<num – dwords>] [-b | –raw – binary] DESCRIPTION The Reservation Report command returns a Reservation Status data structure to host memory that describes the registration and reservation…
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…