summaryrefslogtreecommitdiffstats
path: root/Documentation/cmds-main.txt
blob: 14a6ff69984a771085d23874e5e3c97ec5ee4f95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
linknvme:nvme-admin-passthru[1]::
	Admin Passthrough Command

linknvme:nvme-compare[1]::
	IO Compare

linknvme:nvme-error-log[1]::
	Retrieve error logs

linknvme:nvme-flush[1]::
	Submit flush

linknvme:nvme-dsm[1]::
	Submit Data Set Management

linknvme:nvme-format[1]::
	Format namespace(s)

linknvme:nvme-fw-activate[1]::
	F/W Activate (in old version < 1.2)

linknvme:nvme-fw-commit[1]::
	F/W Commit (in > 1.2)

linknvme:nvme-fw-download[1]::
	F/W Download

linknvme:nvme-fw-log[1]::
	Retrieve f/w log

linknvme:nvme-get-feature[1]::
	Get Features

linknvme:nvme-get-log[1]::
	Generic Get Log

linknvme:nvme-telemetry-log[1]::
	Telemetry Host-Initiated Log

linknvme:nvme-changed-ns-list-log[1]::
	Retrieve Changed Namespace List Log

linknvme:nvme-smart-log[1]::
	Retrieve Smart Log

linknvme:nvme-ana-log[1]::
	Retrieve ANA(Asymmetric Namespace Access) Log

linknvme:nvme-endurance-log[1]::
	Retrieve endurance Log

linknvme:nvme-effects-log[1]::
	Retrieve effects Log

linknvme:nvme-self-test-log[1]::
	Retrieve Device Self-test Log

linknvme:nvme-get-ns-id[1]::
	Retrieve namespace identifier

linknvme:nvme-help[1]::
	NVMe CLI Help

linknvme:nvme-id-ctrl[1]::
	Identify Controller

linknvme:nvme-id-ns[1]::
	Identify Namespace

linknvme:nvme-id-nvmset[1]::
	Identify NVM Set List

linknvme:nvme-id-iocs[1]::
	Identify I/O Command Set

linknvme:nvme-create-ns[1]::
	Create a new namespace

linknvme:nvme-delete-ns[1]::
	Delete existing namespace

linknvme:nvme-attach-ns[1]::
	Attach namespace

linknvme:nvme-detach-ns[1]::
	Detach namespace

linknvme:nvme-io-passthru[1]::
	IO Passthrough Command

linknvme:nvme-list-ns[1]::
	List all nvme namespaces

linknvme:nvme-ns-descs[1]::
	Identify Namespace Identification Descriptor

linknvme:nvme-list[1]::
	List all nvme controllers

linknvme:nvme-list-ctrl[1]::
	List controller in NVMe subsystem

linknvme:nvme-list-subsys[1]::
	List NVMe subsystems

linknvme:nvme-reset[1]::
	Reset a NVMe controller

linknvme:nvme-device-self-test[1]::
	Issue Device Self-test Command

linknvme:nvme-read[1]::
	Issue IO Read Command

linknvme:nvme-write[1]::
	Issue IO Write Command

linknvme:nvme-write-zeroes[1]::
	Issue IO Write Zeroes Command

linknvme:nvme-write-uncor[1]::
	Issue IO Write Uncorrectable Command

linknvme:nvme-resv-acquire[1]::
	Acquire Namespace Reservation

linknvme:nvme-resv-register[1]::
	Register Namespace Reservation

linknvme:nvme-resv-release[1]::
	Release Namespace Reservation

linknvme:nvme-resv-report[1]::
	Report Reservation Capabilities

linknvme:nvme-security-recv[1]::
	Security Receive

linknvme:nvme-security-send[1]::
	Security Send

linknvme:nvme-dsm[1]::
	Issue Data Set Management Command

linknvme:nvme-copy[1]::
	Issue Simple Copy Command

linknvme:nvme-set-feature[1]::
	Set Feature

linknvme:nvme-show-regs[1]::
	Show NVMe Controller Registers

linknvme:nvme-discover[1]::
	Send Get Log Page request to Discovery Controller

linknvme:nvme-connect-all[1]::
	Discover and connect to all NVMe-over-Fabrics subsystems

linknvme:nvme-connect[1]::
	Connect to an NVMe-over-Fabrics subsystem

linknvme:nvme-dim[1]::
	Send Discovery Information Management command to a Discovery Controller

linknvme:nvme-disconnect[1]::
	Disconnect from an NVMe-over-Fabrics subsystem

linknvme:nvme-disconnect-all[1]::
	Disconnect from all NVMe-over-Fabrics subsystems

linknvme:nvme-get-property[1]::
	Reads and shows NVMe-over-Fabrics controller property

linknvme:nvme-media-unit-stat-log[1]::
	Retrieve and show the configuration and wear of media units

linknvme:nvme-supported-cap-config-log[1]::
	Retrieve and show the list of Supported Capacity Configuration Descriptors

linknvme:nvme-boot-part-log[1]::
	Retrieve Boot Partition Log

linknvme:nvme-capacity-mgmt[1]::
	Capacity Management Command

linknvme:nvme-check-dhchap-key[1]::
	Generate NVMeoF DH-HMAC-CHAP host key

linknvme:nvme-check-tls-key[1]::
	Validate NVMeoF TLS PSK

linknvme:nvme-cmdset-ind-id-ns[1]::
	I/O Command Set Independent Identify Namespace

linknvme:nvme-endurance-event-agg-log[1]::
	Retrieve Endurance Group Event Aggregate Log

linknvme:nvme-fid-support-effects-log[1]::
	Retrieve FID Support and Effects log

linknvme:nvme-gen-dhchap-key[1]::
	Generate NVMeoF DH-HMAC-CHAP host key

linknvme:nvme-gen-hostnqn[1]::
	Generate NVMeoF host NQN

linknvme:nvme-gen-tls-key[1]::
	Generate NVMeoF TLS PSK

linknvme:nvme-get-lba-status[1]::
	Get LBA Status command

linknvme:nvme-id-domain[1]::
	NVMe Identify Domain List

linknvme:nvme-id-ns-lba-format[1]::
	NVMe Identify Namespace for the specified LBA Format index

linknvme:nvme-lba-status-log[1]::
	Retrieve LBA Status Information Log

linknvme:nvme-list-endgrp[1]::
	NVMe Identify Endurance Group List

linknvme:nvme-ns-rescan[1]::
	Rescans the NVME namespaces

linknvme:nvme-nvm-id-ctrl[1]::
	NVMe Identify Controller NVM Command Set

linknvme:nvme-nvm-id-ns[1]::
	NVMe Identify Namespace NVM Command Set

linknvme:nvme-nvm-id-ns-lba-format[1]::
	NVMe Identify Namespace NVM Command Set for the specified LBA Format index

linknvme:nvme-persistent-event-log[1]::
	Retrieve Persistent Event Log

linknvme:nvme-predictable-lat-log[1]::
	Retrieve Predictable Latency per Nvmset Log

linknvme:nvme-pred-lat-event-agg-log[1]::
	Retrieve Predictable Latency Event Aggregate Log

linknvme:nvme-primary-ctrl-caps[1]::
	NVMe Identify Primary Controller Capabilities

linknvme:nvme-reset[1]::
	Resets the controller

linknvme:nvme-rpmb[1]::
	Replay Protection Memory Block commands

linknvme:nvme-sanitize-log[1]::
	Retrieve sanitize log

linknvme:nvme-set-property[1]::
	Set a property and show the resulting value

linknvme:nvme-show-hostnqn[1]::
	Show NVMeoF host NQN

linknvme:nvme-subsystem-reset[1]::
	Resets the subsystem

linknvme:nvme-supported-log-pages[1]::
	Retrieve the Supported Log pages details

linknvme:nvme-verify[1]::
	verify command

linknvme:nvme-show-topology[1]::
	Show NVMe topology