1NVME(1)                           NVMe Manual                          NVME(1)
2
3
4

NAME

6       nvme - the NVMe storage command line interface utility (nvme-cli)
7

SYNOPSIS

9       built-in plugin:
10
11       nvme <command> <device> [<args>]
12
13       extension plugins:
14
15       nvme <plugin> <command> <device> [<args>]
16

DESCRIPTION

18       NVM-Express is a fast, scalable host controller interface designed to
19       address the needs for not only PCI Express based solid state drives,
20       but also NVMe-oF(over fabrics).
21
22       This nvme program is a user space utility to provide standards
23       compliant tooling for NVM-Express drives. It was made specifically for
24       Linux as it relies on the IOCTLs defined by the mainline kernel driver.
25

NVME COMMANDS

27       The utility has sub-commands for all admin and io commands defined in
28       the specification and for displaying controller registers. There is
29       also an option to submit completely arbitrary commands. For a list of
30       commands available, run "nvme help".
31

NVME CLI SUB-COMMANDS

33   Main commands
34       nvme-admin-passthru(1)
35           Admin Passthrough Command
36
37       nvme-compare(1)
38           IO Compare
39
40       nvme-error-log(1)
41           Retrieve error logs
42
43       nvme-flush(1)
44           Submit flush
45
46       nvme-dsm(1)
47           Submit Data Set Management
48
49       nvme-format(1)
50           Format namespace(s)
51
52       nvme-fw-activate(1)
53           F/W Activate (in old version < 1.2)
54
55       nvme-fw-commit(1)
56           F/W Commit (in > 1.2)
57
58       nvme-fw-download(1)
59           F/W Download
60
61       nvme-fw-log(1)
62           Retrieve f/w log
63
64       nvme-get-feature(1)
65           Get Features
66
67       nvme-get-log(1)
68           Generic Get Log
69
70       nvme-telemetry-log(1)
71           Telemetry Host-Initiated Log
72
73       nvme-changed-ns-list-log(1)
74           Retrieve Changed Namespace List Log
75
76       nvme-smart-log(1)
77           Retrieve Smart Log
78
79       nvme-ana-log(1)
80           Retrieve ANA(Asymmetric Namespace Access) Log
81
82       nvme-endurance-log(1)
83           Retrieve endurance Log
84
85       nvme-effects-log(1)
86           Retrieve effects Log
87
88       nvme-self-test-log(1)
89           Retrieve Device Self-test Log
90
91       nvme-get-ns-id(1)
92           Retrieve namespace identifier
93
94       nvme-help(1)
95           NVMe CLI Help
96
97       nvme-id-ctrl(1)
98           Identify Controller
99
100       nvme-id-ns(1)
101           Identify Namespace
102
103       nvme-id-nvmset(1)
104           Identify NVM Set List
105
106       nvme-id-iocs(1)
107           Identify I/O Command Set
108
109       nvme-create-ns(1)
110           Create a new namespace
111
112       nvme-delete-ns(1)
113           Delete existing namespace
114
115       nvme-attach-ns(1)
116           Attach namespace
117
118       nvme-detach-ns(1)
119           Detach namespace
120
121       nvme-io-passthru(1)
122           IO Passthrough Command
123
124       nvme-list-ns(1)
125           List all nvme namespaces
126
127       nvme-ns-descs(1)
128           Identify Namespace Identification Descriptor
129
130       nvme-list(1)
131           List all nvme controllers
132
133       nvme-list-ctrl(1)
134           List controller in NVMe subsystem
135
136       nvme-list-subsys(1)
137           List NVMe subsystems
138
139       nvme-reset(1)
140           Reset a NVMe controller
141
142       nvme-device-self-test(1)
143           Issue Device Self-test Command
144
145       nvme-read(1)
146           Issue IO Read Command
147
148       nvme-write(1)
149           Issue IO Write Command
150
151       nvme-write-zeroes(1)
152           Issue IO Write Zeroes Command
153
154       nvme-write-uncor(1)
155           Issue IO Write Uncorrectable Command
156
157       nvme-resv-acquire(1)
158           Acquire Namespace Reservation
159
160       nvme-resv-register(1)
161           Register Namespace Reservation
162
163       nvme-resv-release(1)
164           Release Namespace Reservation
165
166       nvme-resv-report(1)
167           Report Reservation Capabilities
168
169       nvme-security-recv(1)
170           Security Receive
171
172       nvme-security-send(1)
173           Security Send
174
175       nvme-dsm(1)
176           Issue Data Set Management Command
177
178       nvme-copy(1)
179           Issue Simple Copy Command
180
181       nvme-set-feature(1)
182           Set Feature
183
184       nvme-show-regs(1)
185           Show NVMe Controller Registers
186
187       nvme-discover(1)
188           Send Get Log Page request to Discovery Controller
189
190       nvme-connect-all(1)
191           Discover and connect to all NVMe-over-Fabrics subsystems
192
193       nvme-connect(1)
194           Connect to an NVMe-over-Fabrics subsystem
195
196       nvme-dim(1)
197           Send Discovery Information Management command to a Discovery
198           Controller
199
200       nvme-disconnect(1)
201           Disconnect from an NVMe-over-Fabrics subsystem
202
203       nvme-disconnect-all(1)
204           Disconnect from all NVMe-over-Fabrics subsystems
205
206       nvme-get-property(1)
207           Reads and shows NVMe-over-Fabrics controller property
208
209       nvme-media-unit-stat-log(1)
210           Retrieve and show the configuration and wear of media units
211
212       nvme-supported-cap-config-log(1)
213           Retrieve and show the list of Supported Capacity Configuration
214           Descriptors
215
216       nvme-boot-part-log(1)
217           Retrieve Boot Partition Log
218
219       nvme-capacity-mgmt(1)
220           Capacity Management Command
221
222       nvme-check-dhchap-key(1)
223           Generate NVMeoF DH-HMAC-CHAP host key
224
225       nvme-check-tls-key(1)
226           Validate NVMeoF TLS PSK
227
228       nvme-cmdset-ind-id-ns(1)
229           I/O Command Set Independent Identify Namespace
230
231       nvme-endurance-event-agg-log(1)
232           Retrieve Endurance Group Event Aggregate Log
233
234       nvme-fid-support-effects-log(1)
235           Retrieve FID Support and Effects log
236
237       nvme-gen-dhchap-key(1)
238           Generate NVMeoF DH-HMAC-CHAP host key
239
240       nvme-gen-hostnqn(1)
241           Generate NVMeoF host NQN
242
243       nvme-gen-tls-key(1)
244           Generate NVMeoF TLS PSK
245
246       nvme-get-lba-status(1)
247           Get LBA Status command
248
249       nvme-id-domain(1)
250           NVMe Identify Domain List
251
252       nvme-id-ns-lba-format(1)
253           NVMe Identify Namespace for the specified LBA Format index
254
255       nvme-lba-status-log(1)
256           Retrieve LBA Status Information Log
257
258       nvme-list-endgrp(1)
259           NVMe Identify Endurance Group List
260
261       nvme-ns-rescan(1)
262           Rescans the NVME namespaces
263
264       nvme-nvm-id-ctrl(1)
265           NVMe Identify Controller NVM Command Set
266
267       nvme-nvm-id-ns(1)
268           NVMe Identify Namespace NVM Command Set
269
270       nvme-nvm-id-ns-lba-format(1)
271           NVMe Identify Namespace NVM Command Set for the specified LBA
272           Format index
273
274       nvme-persistent-event-log(1)
275           Retrieve Persistent Event Log
276
277       nvme-predictable-lat-log(1)
278           Retrieve Predictable Latency per Nvmset Log
279
280       nvme-pred-lat-event-agg-log(1)
281           Retrieve Predictable Latency Event Aggregate Log
282
283       nvme-primary-ctrl-caps(1)
284           NVMe Identify Primary Controller Capabilities
285
286       nvme-reset(1)
287           Resets the controller
288
289       nvme-rpmb(1)
290           Replay Protection Memory Block commands
291
292       nvme-sanitize-log(1)
293           Retrieve sanitize log
294
295       nvme-set-property(1)
296           Set a property and show the resulting value
297
298       nvme-show-hostnqn(1)
299           Show NVMeoF host NQN
300
301       nvme-subsystem-reset(1)
302           Resets the subsystem
303
304       nvme-supported-log-pages(1)
305           Retrieve the Supported Log pages details
306
307       nvme-verify(1)
308           verify command
309
310       nvme-show-topology(1)
311           Show NVMe topology
312
313   Plugins/Vendor extension commands
314       nvme-intel-id-ctrl(1)
315           Intel - NVMe Identify Controller
316
317       nvme-intel-internal-log(1)
318           Retrieve Intel device’s internal log and save to file
319
320       nvme-intel-lat-stats(1)
321           Retrieve NVMe Identify Controller, return result and structure
322
323       nvme-intel-market-name(1)
324           Intel vendor specific marketing name log page
325
326       nvme-intel-smart-log-add(1)
327           NVMe Intel Additional SMART log page
328
329       nvme-intel-temp-stats(1)
330           NVMe Intel Additional SMART log page for temp stats
331
332       nvme-huawei-id-ctrl(1)
333           NVMe huawei Identify Controller
334
335       nvme-huawei-list(1)
336           List all recognized Huawei NVMe devices
337
338       nvme-dera-stat(1)
339           NVMe Dera Device status and Additional SMART log page request
340
341       nvme-micron-clear-pcie-errors(1)
342           Clears correctable PCIe correctable errors of given Micron device
343
344       nvme-micron-internal-log(1)
345           Retrieve Micron device’s internal logs and save to given zip file
346
347       nvme-micron-nand-stats(1)
348           Retrieves NAND statistics of given micron device
349
350       nvme-micron-pcie-stats(1)
351           Retrieves pcie error statistics for given micron device
352
353       nvme-micron-selective-download(1)
354           Performs selective firmware download
355
356       nvme-micron-smart-add-log(1)
357           Retrieves NAND statistics
358
359       nvme-micron-temperature-stats(1)
360           Retrieves temperature information of given micron device
361
362       nvme-netapp-ontapdevices(1)
363           Display information about ONTAP devices
364
365       nvme-netapp-smdevices(1)
366           Display information for each NVMe path to an E-Series volume
367
368       nvme-toshiba-clear-pcie-correctable-errors(1)
369           Reset the PCIe correctable errors count to zero
370
371       nvme-toshiba-vs-internal-log(1)
372           Retrieve a Toshiba device’s vendor specific internal log
373
374       nvme-toshiba-vs-smart-add-log(1)
375           Retrieve a Toshiba device’s vendor specific extended SMART log page
376
377       nvme-transcend-badblock(1)
378           Retrieve Transcend NVMe device’s bad blocks
379
380       nvme-transcend-healthvalue(1)
381           Use NVMe SMART table to analyze the health value of Transcend
382           device
383
384       nvme-virtium-show-identify(1)
385           Show a complete detail of identify device information in json
386           format
387
388       nvme-virtium-save-smart-to-vtview-log(1)
389           Periodically save smart attributes into a log file
390
391       nvme-wdc-cap-diag(1)
392           Retrieve WDC device’s diagnostic log and save to file
393
394       nvme-wdc-capabilities(1)
395           Display WDC plugin command capabilities
396
397       nvme-wdc-clear-assert-dump(1)
398           Clears the assert dump (if present)
399
400       nvme-wdc-clear-fw-activate-history(1)
401           Clears the firmware activate history table
402
403       nvme-wdc-clear-pcie-corr(1)
404           Clears the pcie correctable errors field
405
406       nvme-wdc-clear-pcie-correctable-errors(1)
407           Clears the pcie correctable errors returned in the smart-log-add
408           command
409
410       nvme-wdc-cloud-SSD-plugin-version(1)
411           Display WDC plugin Cloud SSD Plugin Version
412
413       nvme-wdc-drive-essentials(1)
414           Retrieve WDC device’s drive essentials bin files
415
416       nvme-wdc-drive-log(1)
417           Retrieve WDC device’s drive log and save to file
418
419       nvme-wdc-drive-resize(1)
420           Send NVMe WDC Resize Vendor Unique Command
421
422       nvme-wdc-enc-get-log(1)
423           Send NVMe WDC enc-get-log Vendor Unique Command
424
425       nvme-wdc-get-crash-dump(1)
426           Retrieve WDC device’s crash dump
427
428       nvme-wdc-get-drive-status(1)
429           Send the NVMe WDC get-drive-status command
430
431       nvme-wdc-get-latency-monitor-log(1)
432           Display latency monitor log page data in human readable format
433
434       nvme-wdc-get-pfail-dump(1)
435           Retrieve WDC device’s pfail crash dump
436
437       nvme-wdc-id-ctrl(1)
438           Send NVMe Identify Controller, return result and structure
439
440       nvme-wdc-log-page-directory(1)
441           Retrieves the list of Log IDs supported by the drive
442
443       nvme-wdc-namespace-resize(1)
444           Resizes the device’s namespace
445
446       nvme-wdc-purge-monitor(1)
447           Send NVMe WDC Purge-Monitor Vendor Unique Command
448
449       nvme-wdc-purge(1)
450           Send NVMe WDC Purge Vendor Unique Command
451
452       nvme-wdc-smart-add-log(1)
453           Send NVMe WDC smart add log Vendor Unique Command
454
455       nvme-wdc-vs-drive-info(1)
456           Send the NVMe WDC vs-drive-info command
457
458       nvme-wdc-vs-error-reason-identifier(1)
459           Retrieve WDC device’s telemetry log error reason identifier field
460
461       nvme-wdc-vs-fw-activate-history(1)
462           Execute NVMe WDC vs-fw-activate-history Vendor Unique Command
463
464       nvme-wdc-vs-internal-log(1)
465           Retrieve WDC device’s internal firmware log and save to file
466
467       nvme-wdc-vs-nand-stats(1)
468           Send NVMe WDC vs-nand-stats Vendor Unique Command
469
470       nvme-wdc-vs-telemetry-controller-option(1)
471           Disable/Enable the controller initiated option of the telemetry log
472           page
473
474       nvme-wdc-vs-temperature-stats(1)
475           Display temperature-related statistics
476
477       nvme-zns-changed-zone-list(1)
478           Retrieve Changed Zone log for the given device
479
480       nvme-zns-close-zone(1)
481           Closes one or all zones
482
483       nvme-zns-finish-zone(1)
484           Finishes one or all zones
485
486       nvme-zns-id-ctrl(1)
487           Send NVMe Zoned Command Set Identify Controller
488
489       nvme-zns-id-ns(1)
490           Send NVMe Zoned Command Set Identify Namespace
491
492       nvme-zns-offline-zone(1)
493           Offlines one or all zones
494
495       nvme-zns-open-zone(1)
496           Opens one or all zones
497
498       nvme-zns-report-zones(1)
499           Retrieve and display the Report Zones data structure
500
501       nvme-zns-reset-zone(1)
502           Resets one or all zones
503
504       nvme-zns-set-zone-desc(1)
505           Set extended descriptor data for a zone
506
507       nvme-zns-zone-append(1)
508           Send an NVMe write command, provide results
509
510       nvme-zns-zone-mgmt-recv(1)
511           Zone Management Receive command
512
513       nvme-zns-zone-mgmt-send(1)
514           Zone Management Send command
515
516       nvme-zns-zrwa-flush-zone(1)
517           Flush LBAs associated with a ZRWA to a zone
518
519       nvme-inspur-nvme-vendor-log(1)
520           NVMe Inspur Device Vendor log page request
521

RETURNS

523       All commands will behave the same, they will return 0 on success and 1
524       on failure.
525

FURTHER DOCUMENTATION

527       See the freely available references on the Official NVM-Express
528       Site[1].
529

AUTHORS

531       This is written and maintained by Keith Busch[2].
532

REPORTING BUGS

534       Patches and issues may be submitted to the official repository at
535       https://github.com/linux-nvme/nvme-cli or the Linux NVMe mailing list
536       linux-nvme[3]
537

NVME

539       Part of the nvme suite
540

NOTES

542        1. Official NVM-Express Site
543           http://nvmexpress.org
544
545        2. Keith Busch
546           mailto:kbusch@kernel.org
547
548        3. linux-nvme
549           mailto:linux-nvme@lists.infradead.org
550
551
552
553NVMe                              09/29/2023                           NVME(1)
Impressum