1NVME(1) NVMe Manual NVME(1)
2
6 nvme - the dumb pci-e storage utility
7
9 nvme <command> <device> [<args>]
10
12 NVM-Express is a fast, scalable host controller interface designed to
13 address the needs for PCI Express based solid state drives.
14 This nvme program is a user space utility to provide standards
16 compliant tooling for NVM-Express drives. It was made specifically for
17 Linux as it relies on the IOCTLs defined by the mainline kernel driver.
18
20 The utility has sub-commands for all admin and io commands defined in
21 the specification and for displaying controller registers. There is
22 also an option to submit completely arbitrary commands. For a list of
23 commands available, run "nvme help".
24
26 Main commands
27 nvme-admin-passthru(1)
28 Admin Passthrough Command
29 nvme-compare(1)
31 IO Compare
32 nvme-error-log(1)
34 Retrieve error logs
35 nvme-flush(1)
37 Submit flush
38 nvme-dms(1)
40 Submit Data Set Management
41 nvme-format(1)
43 Format namespace(s)
44 nvme-fw-activate(1)
46 F/W Activate
47 nvme-fw-download(1)
49 F/W Download
50 nvme-fw-log(1)
52 Retrieve f/w log
53 nvme-get-feature(1)
55 Get Features
56 nvme-get-log(1)
58 Generic Get Log
59 nvme-telemetry-log(1)
61 Telemetry Host-Initiated Log
62 nvme-smart-log(1)
64 Retrieve Smart Log
65 nvme-endurance-log(1)
67 Retrieve endurance Log
68 nvme-effects-log(1)
70 Retrieve effects Log
71 nvme-get-ns-id(1)
73 Retrieve namespace identifier
74 nvme-help(1)
76 NVMe CLI Help
77 nvme-id-ctrl(1)
79 Identify Controller
80 nvme-id-ns(1)
82 Identify Namespace
83 nvme-create-ns(1)
85 Create a new namespace
86 nvme-delete-ns(1)
88 Delete existing namespace
89 nvme-attach-ns(1)
91 Attach namespace
92 nvme-detach-ns(1)
94 Detach namespace
95 nvme-io-passthru(1)
97 IO Passthrough Command
98 nvme-list-ns(1)
100 List all nvme namespaces
101 nvme-ns-descs(1)
103 Identify Namespace Identification Descriptor
104 nvme-list(1)
106 List all nvme controllers
107 nvme-list-ctrl(1)
109 List controller in NVMe subsystem
110 nvme-read(1)
112 Issue IO Read Command
113 nvme-write(1)
115 Issue IO Write Command
116 nvme-write-zeroes(1)
118 Issue IO Write Zeroes Command
119 nvme-write-uncor(1)
121 Issue IO Write Uncorrectable Command
122 nvme-resv-acquire(1)
124 Acquire Namespace Reservation
125 nvme-resv-register(1)
127 Register Namespace Reservation
128 nvme-resv-release(1)
130 Release Namespace Reservation
131 nvme-resv-report(1)
133 Report Reservation Capabilities
134 nvme-security-recv(1)
136 Security Receive
137 nvme-security-send(1)
139 Security Send
140 nvme-set-feature(1)
142 Set Feature
143 nvme-show-regs(1)
145 Show NVMe Controller Registers
146 nvme-discover(1)
148 Send Get Log Page request to Discovery Controller
149 nvme-connect(1)
151 Connect to an NVMe-over-Fabrics subsystem
152
154 See the freely available references on the Official NVM-Express
155 Site[1].
156
158 This is written and maintained by Keith Busch[2].
159
161 Patches and issues may be submitted to the official repository at
162 https://github.com/linux-nvme/nvme-cli or the Linux NVMe mailing list
163 linux-nvme[3]
164
166 Part of the nvme suite
167
169 1. Official NVM-Express Site
170 http://nvmexpress.org
171 2. Keith Busch
173 mailto:keith.busch@intel.com
174 3. linux-nvme
176 mailto:linux-nvme@lists.infradead.org
177NVMe 06/05/2018 NVME(1)