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

NAME

6       nvme - the dumb pci-e storage utility
7

SYNOPSIS

9       nvme <command> <device> [<args>]
10

DESCRIPTION

12       NVM-Express is a fast, scalable host controller interface designed to
13       address the needs for PCI Express based solid state drives.
14
15       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

NVME COMMANDS

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

NVME CLI SUB-COMMANDS

26   Main commands
27       nvme-admin-passthru(1)
28           Admin Passthrough Command
29
30       nvme-compare(1)
31           IO Compare
32
33       nvme-error-log(1)
34           Retrieve error logs
35
36       nvme-flush(1)
37           Submit flush
38
39       nvme-dms(1)
40           Submit Data Set Management
41
42       nvme-format(1)
43           Format namespace(s)
44
45       nvme-fw-activate(1)
46           F/W Activate
47
48       nvme-fw-download(1)
49           F/W Download
50
51       nvme-fw-log(1)
52           Retrieve f/w log
53
54       nvme-get-feature(1)
55           Get Features
56
57       nvme-get-log(1)
58           Generic Get Log
59
60       nvme-telemetry-log(1)
61           Telemetry Host-Initiated Log
62
63       nvme-smart-log(1)
64           Retrieve Smart Log
65
66       nvme-endurance-log(1)
67           Retrieve endurance Log
68
69       nvme-effects-log(1)
70           Retrieve effects Log
71
72       nvme-get-ns-id(1)
73           Retrieve namespace identifier
74
75       nvme-help(1)
76           NVMe CLI Help
77
78       nvme-id-ctrl(1)
79           Identify Controller
80
81       nvme-id-ns(1)
82           Identify Namespace
83
84       nvme-create-ns(1)
85           Create a new namespace
86
87       nvme-delete-ns(1)
88           Delete existing namespace
89
90       nvme-attach-ns(1)
91           Attach namespace
92
93       nvme-detach-ns(1)
94           Detach namespace
95
96       nvme-io-passthru(1)
97           IO Passthrough Command
98
99       nvme-list-ns(1)
100           List all nvme namespaces
101
102       nvme-ns-descs(1)
103           Identify Namespace Identification Descriptor
104
105       nvme-list(1)
106           List all nvme controllers
107
108       nvme-list-ctrl(1)
109           List controller in NVMe subsystem
110
111       nvme-read(1)
112           Issue IO Read Command
113
114       nvme-write(1)
115           Issue IO Write Command
116
117       nvme-write-zeroes(1)
118           Issue IO Write Zeroes Command
119
120       nvme-write-uncor(1)
121           Issue IO Write Uncorrectable Command
122
123       nvme-resv-acquire(1)
124           Acquire Namespace Reservation
125
126       nvme-resv-register(1)
127           Register Namespace Reservation
128
129       nvme-resv-release(1)
130           Release Namespace Reservation
131
132       nvme-resv-report(1)
133           Report Reservation Capabilities
134
135       nvme-security-recv(1)
136           Security Receive
137
138       nvme-security-send(1)
139           Security Send
140
141       nvme-set-feature(1)
142           Set Feature
143
144       nvme-show-regs(1)
145           Show NVMe Controller Registers
146
147       nvme-discover(1)
148           Send Get Log Page request to Discovery Controller
149
150       nvme-connect(1)
151           Connect to an NVMe-over-Fabrics subsystem
152
153       nvme-get-property(1)
154           Reads and shows NVMe-over-Fabrics controller property
155

FURTHER DOCUMENTATION

157       See the freely available references on the Official NVM-Express
158       Site[1].
159

AUTHORS

161       This is written and maintained by Keith Busch[2].
162

REPORTING BUGS

164       Patches and issues may be submitted to the official repository at
165       https://github.com/linux-nvme/nvme-cli or the Linux NVMe mailing list
166       linux-nvme[3]
167

NVME

169       Part of the nvme suite
170

NOTES

172        1. Official NVM-Express Site
173           http://nvmexpress.org
174
175        2. Keith Busch
176           mailto:keith.busch@intel.com
177
178        3. linux-nvme
179           mailto:linux-nvme@lists.infradead.org
180
181
182
183NVMe                              01/08/2019                           NVME(1)
Impressum