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-dms(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
54
55       nvme-fw-download(1)
56           F/W Download
57
58       nvme-fw-log(1)
59           Retrieve f/w log
60
61       nvme-get-feature(1)
62           Get Features
63
64       nvme-get-log(1)
65           Generic Get Log
66
67       nvme-telemetry-log(1)
68           Telemetry Host-Initiated Log
69
70       nvme-smart-log(1)
71           Retrieve Smart Log
72
73       nvme-endurance-log(1)
74           Retrieve endurance Log
75
76       nvme-effects-log(1)
77           Retrieve effects Log
78
79       nvme-get-ns-id(1)
80           Retrieve namespace identifier
81
82       nvme-help(1)
83           NVMe CLI Help
84
85       nvme-id-ctrl(1)
86           Identify Controller
87
88       nvme-id-ns(1)
89           Identify Namespace
90
91       nvme-create-ns(1)
92           Create a new namespace
93
94       nvme-delete-ns(1)
95           Delete existing namespace
96
97       nvme-attach-ns(1)
98           Attach namespace
99
100       nvme-detach-ns(1)
101           Detach namespace
102
103       nvme-io-passthru(1)
104           IO Passthrough Command
105
106       nvme-list-ns(1)
107           List all nvme namespaces
108
109       nvme-ns-descs(1)
110           Identify Namespace Identification Descriptor
111
112       nvme-list(1)
113           List all nvme controllers
114
115       nvme-list-ctrl(1)
116           List controller in NVMe subsystem
117
118       nvme-read(1)
119           Issue IO Read Command
120
121       nvme-write(1)
122           Issue IO Write Command
123
124       nvme-write-zeroes(1)
125           Issue IO Write Zeroes Command
126
127       nvme-write-uncor(1)
128           Issue IO Write Uncorrectable Command
129
130       nvme-resv-acquire(1)
131           Acquire Namespace Reservation
132
133       nvme-resv-register(1)
134           Register Namespace Reservation
135
136       nvme-resv-release(1)
137           Release Namespace Reservation
138
139       nvme-resv-report(1)
140           Report Reservation Capabilities
141
142       nvme-security-recv(1)
143           Security Receive
144
145       nvme-security-send(1)
146           Security Send
147
148       nvme-set-feature(1)
149           Set Feature
150
151       nvme-show-regs(1)
152           Show NVMe Controller Registers
153
154       nvme-discover(1)
155           Send Get Log Page request to Discovery Controller
156
157       nvme-connect-all(1)
158           Discover and connect to all NVMe-over-Fabrics subsystems
159
160       nvme-connect(1)
161           Connect to an NVMe-over-Fabrics subsystem
162
163       nvme-disconnect(1)
164           Disconnect from an NVMe-over-Fabrics subsystem
165
166       nvme-disconnect-all(1)
167           Disconnect from all NVMe-over-Fabrics subsystems
168
169       nvme-get-property(1)
170           Reads and shows NVMe-over-Fabrics controller property
171

FURTHER DOCUMENTATION

173       See the freely available references on the Official NVM-Express
174       Site[1].
175

AUTHORS

177       This is written and maintained by Keith Busch[2].
178

REPORTING BUGS

180       Patches and issues may be submitted to the official repository at
181       https://github.com/linux-nvme/nvme-cli or the Linux NVMe mailing list
182       linux-nvme[3]
183

NVME

185       Part of the nvme suite
186

NOTES

188        1. Official NVM-Express Site
189           http://nvmexpress.org
190
191        2. Keith Busch
192           mailto:kbusch@kernel.org
193
194        3. linux-nvme
195           mailto:linux-nvme@lists.infradead.org
196
197
198
199NVMe                              04/24/2020                           NVME(1)
Impressum