xref: /linux/Documentation/ABI/stable/sysfs-nvme (revision 9762c7ae1ee709f6dc3823d151391f89457b5492)
1What:		/sys/class/nvme/nvmeX/model
2What:		/sys/class/nvme/nvmeX/serial
3What:		/sys/class/nvme/nvmeX/firmware_rev
4Date:		January 2016
5KernelVersion:	4.5
6Contact:	Keith Busch <kbusch@kernel.org>
7Description:
8		Shows the model, serial number, or firmware revision string
9		of the NVMe controller, as reported in the Identify
10		Controller data structure.
11
12What:		/sys/class/nvme/nvmeX/cntlid
13Date:		February 2016
14KernelVersion:	4.6
15Contact:	Ming Lin <ming.l@ssi.samsung.com>
16Description:
17		Shows the controller identifier assigned by the NVMe
18		subsystem.
19
20What:		/sys/class/nvme/nvmeX/cntrltype
21What:		/sys/class/nvme/nvmeX/dctype
22Date:		February 2022
23KernelVersion:	5.18
24Contact:	Martin Belanger <martin.belanger@dell.com>
25Description:
26		cntrltype: Shows the controller type. Possible values: "io",
27		"discovery", "admin", "reserved".
28
29		dctype: Shows the discovery controller type. Possible values:
30		"none", "ddc", "cdc", "reserved".
31
32What:		/sys/class/nvme/nvmeX/reset_controller
33Date:		November 2015
34KernelVersion:	4.5
35Contact:	Christoph Hellwig <hch@lst.de>
36Description:
37		Write-only. Writing any value triggers a synchronous
38		controller reset.
39
40What:		/sys/class/nvme/nvmeX/rescan_controller
41Date:		April 2016
42KernelVersion:	4.7
43Contact:	Keith Busch <kbusch@kernel.org>
44Description:
45		Write-only. Writing any value triggers a namespace rescan
46		on this controller.
47
48What:		/sys/class/nvme/nvmeX/transport
49What:		/sys/class/nvme/nvmeX/subsysnqn
50What:		/sys/class/nvme/nvmeX/address
51What:		/sys/class/nvme/nvmeX/delete_controller
52What:		/sys/class/nvme/nvmeX/reconnect_delay
53What:		/sys/class/nvme/nvmeX/ctrl_loss_tmo
54Date:		June 2016
55KernelVersion:	4.8
56Contact:	Ming Lin <ming.l@ssi.samsung.com>
57Description:
58		Fabrics controller attributes added with NVMe-oF support.
59
60		transport: Shows the transport type string. Possible values:
61		"pcie", "tcp", "rdma", "fc", "loop".
62
63		subsysnqn: Shows the NVMe Qualified Name (NQN) of the
64		subsystem this controller belongs to.
65
66		address: Shows the transport-specific address string. Only
67		available for fabrics controllers.
68
69		delete_controller: Write-only. Triggers deletion of this
70		fabrics controller.
71
72		reconnect_delay: Shows or sets the reconnect delay in
73		seconds. Reading returns the delay value.
74
75		ctrl_loss_tmo: Shows or sets the controller loss timeout in
76		seconds. Reading returns the timeout value, or "off" if
77		infinite reconnects are allowed. Writing a negative value
78		disables the timeout.
79
80What:		/sys/class/nvme/nvmeX/hostnqn
81What:		/sys/class/nvme/nvmeX/hostid
82Date:		February 2020
83KernelVersion:	5.7
84Contact:	Sagi Grimberg <sagi@grimberg.me>
85Description:
86		hostnqn: Shows the host NQN used by this fabrics controller.
87
88		hostid: Shows the host identifier (UUID format) used by this
89		fabrics controller.
90
91		Only available for fabrics controllers.
92
93What:		/sys/class/nvme/nvmeX/fast_io_fail_tmo
94Date:		November 2020
95KernelVersion:	5.11
96Contact:	Victor Gladkov <Victor.Gladkov@kioxia.com>
97Description:
98		Shows or sets the fast I/O fail timeout in seconds. Reading
99		returns the timeout value, or "off" if disabled. Writing a
100		negative value disables the fast I/O fail. Only available
101		for fabrics controllers.
102
103What:		/sys/class/nvme/nvmeX/kato
104Date:		April 2021
105KernelVersion:	5.13
106Contact:	Hannes Reinecke <hare@suse.de>
107Description:
108		Shows the Keep Alive Timeout value in milliseconds for
109		this controller.
110
111What:		/sys/class/nvme/nvmeX/cmb
112Date:		October 2016
113KernelVersion:	4.9
114Contact:	Stephen Bates <sbates@raithlin.com>
115Description:
116		Shows the Controller Memory Buffer (CMB) register values
117		in format "cmbloc : 0x%08x\ncmbsz  : 0x%08x\n". Only
118		visible when the controller has a CMB (cmbsz != 0).
119		PCI transport only.
120
121What:		/sys/class/nvme/nvmeX/cmbloc
122What:		/sys/class/nvme/nvmeX/cmbsz
123What:		/sys/class/nvme/nvmeX/hmb
124Date:		July 2021
125KernelVersion:	5.15
126Contact:	Keith Busch <kbusch@kernel.org>
127Description:
128		cmbloc: Shows the CMBLOC register value.
129
130		cmbsz: Shows the CMBSZ register value.
131
132		cmbloc and cmbsz are only visible when the controller has
133		a CMB. PCI transport only.
134
135		hmb: Shows or sets whether the Host Memory Buffer (HMB) is
136		enabled. Reading returns 1 (enabled) or 0 (disabled).
137		Writing 1 enables HMB; writing 0 disables it. Only
138		visible when the controller supports HMB (hmpre != 0).
139		PCI transport only.
140
141What:		/sys/class/nvme/nvmeX/state
142Date:		November 2016
143KernelVersion:	4.11
144Contact:	Sagi Grimberg <sagi@grimberg.me>
145Description:
146		Shows the current state of the controller. Possible values:
147		"new", "live", "resetting", "connecting", "deleting",
148		"deleting (no IO)", "dead".
149
150What:		/sys/class/nvme/nvmeX/numa_node
151Date:		November 2018
152KernelVersion:	5.0
153Contact:	Hannes Reinecke <hare@suse.de>
154Description:
155		Shows the NUMA node the controller is attached to.
156
157What:		/sys/class/nvme/nvmeX/queue_count
158What:		/sys/class/nvme/nvmeX/sqsize
159Date:		September 2019
160KernelVersion:	5.4
161Contact:	James Smart <jsmart2021@gmail.com>
162Description:
163		queue_count: Shows the total number of queues (admin + I/O)
164		for this controller.
165
166		sqsize: Shows the submission queue size for this controller.
167
168What:		/sys/class/nvme/nvmeX/dhchap_secret
169What:		/sys/class/nvme/nvmeX/dhchap_ctrl_secret
170Date:		June 2022
171KernelVersion:	6.0
172Contact:	Hannes Reinecke <hare@suse.de>
173Description:
174		dhchap_secret: Shows or sets the host DH-HMAC-CHAP secret
175		for this controller. Reading returns "none" if not set.
176		Writing must use the "DHHC-1:" key format and triggers
177		re-authentication.
178
179		dhchap_ctrl_secret: Shows or sets the controller
180		DH-HMAC-CHAP secret for bidirectional authentication.
181		Same format as dhchap_secret.
182
183		Only available when CONFIG_NVME_HOST_AUTH is enabled and
184		for fabrics controllers.
185
186What:		/sys/class/nvme/nvmeX/tls_key
187Date:		August 2023
188KernelVersion:	6.7
189Contact:	Hannes Reinecke <hare@suse.de>
190Description:
191		Shows the serial of the currently active TLS PSK as hex.
192		Returns empty if no TLS key is active. Only available for
193		TCP controllers with TLS or secure concatenation enabled
194		(CONFIG_NVME_TCP_TLS).
195
196What:		/sys/class/nvme/nvmeX/tls_configured_key
197Date:		July 2024
198KernelVersion:	6.12
199Contact:	Hannes Reinecke <hare@kernel.org>
200Description:
201		Shows the serial of the configured TLS key. Writing 0
202		triggers a PSK reauthentication (REPLACETLSPSK) with
203		the target. After reauthentication the returned serial
204		will be the new key. Only available for TCP controllers
205		with secure concatenation enabled (CONFIG_NVME_TCP_TLS).
206
207What:		/sys/class/nvme/nvmeX/tls_keyring
208Date:		July 2024
209KernelVersion:	6.12
210Contact:	Hannes Reinecke <hare@kernel.org>
211Description:
212		Shows the TLS keyring description. Only available for TCP
213		controllers with a keyring configured (CONFIG_NVME_TCP_TLS).
214
215What:		/sys/class/nvme/nvmeX/tls_mode
216Date:		April 2026
217KernelVersion:	7.1
218Contact:	Daniel Wagner <wagi@kernel.org>
219Description:
220		Shows the TLS mode: "tls" for direct TLS or "concat" for
221		secure concatenation. Only available for TCP controllers
222		with TLS or secure concatenation enabled
223		(CONFIG_NVME_TCP_TLS).
224
225What:		/sys/class/nvme/nvmeX/passthru_err_log_enabled
226Date:		January 2024
227KernelVersion:	6.8
228Contact:	Alan Adamson <alan.adamson@oracle.com>
229Description:
230		Shows or sets whether admin passthrough error logging is
231		enabled for this controller. Reading returns "on" or "off".
232		Writing accepts a boolean value.
233
234What:		/sys/class/nvme/nvmeX/quirks
235Date:		November 2025
236KernelVersion:	7.0
237Contact:	Maurizio Lombardi <mlombard@redhat.com>
238Description:
239		Shows the active quirk names for this controller, one per
240		line. Shows "none" if no quirks are active.
241
242What:		/sys/class/nvme/nvmeX/admin_timeout
243What:		/sys/class/nvme/nvmeX/io_timeout
244Date:		May 2026
245KernelVersion:	7.2
246Contact:	Maurizio Lombardi <mlombard@redhat.com>
247Description:
248		admin_timeout: Shows or sets the admin command timeout in
249		milliseconds.
250
251		io_timeout: Shows or sets the I/O command timeout in
252		milliseconds. Changes are propagated to all namespace
253		request queues.
254
255		The value must be nonzero. Only writable after the
256		controller has been started at least once.
257
258What:		/sys/block/nvmeXnY/uuid
259What:		/sys/block/nvmeXnY/eui
260What:		/sys/block/nvmeXnY/nsid
261Date:		December 2015
262KernelVersion:	4.5
263Contact:	Keith Busch <kbusch@kernel.org>
264Description:
265		Namespace identification attributes.
266
267		uuid: Shows the UUID for this namespace. Falls back to
268		showing the NGUID for backward compatibility. Hidden if
269		both are all zeros.
270
271		eui: Shows the IEEE Extended Unique Identifier (EUI-64).
272		Hidden if all zeros.
273
274		nsid: Shows the namespace identifier (NSID).
275
276What:		/sys/block/nvmeXnY/wwid
277Date:		February 2016
278KernelVersion:	4.6
279Contact:	Keith Busch <kbusch@kernel.org>
280Description:
281		Shows the World Wide Identifier for this namespace. The
282		format depends on available identifiers (in priority
283		order): "uuid.{UUID}", "eui.{NGUID}", "eui.{EUI64}", or
284		"nvme.{VID}-{SERIAL}-{MODEL}-{NSID}".
285
286What:		/sys/block/nvmeXnY/nguid
287Date:		June 2017
288KernelVersion:	4.13
289Contact:	Johannes Thumshirn <jthumshirn@suse.de>
290Description:
291		Shows the Namespace Globally Unique Identifier (NGUID).
292		Hidden if the NGUID is all zeros.
293
294What:		/sys/block/nvmeXcYnZ/ana_grpid
295What:		/sys/block/nvmeXcYnZ/ana_state
296Date:		May 2018
297KernelVersion:	4.19
298Contact:	Christoph Hellwig <hch@lst.de>
299Description:
300		ana_grpid: Shows the ANA Group ID for this namespace
301		path device.
302
303		ana_state: Shows the ANA state. Possible values:
304		"optimized", "non-optimized", "inaccessible",
305		"persistent-loss", "change".
306
307		Only visible when the controller supports ANA.
308		Requires CONFIG_NVME_MULTIPATH.
309
310What:		/sys/block/nvmeXcYnZ/queue_depth
311Date:		June 2024
312KernelVersion:	6.11
313Contact:	Thomas Song <tsong@purestorage.com>
314Description:
315		Shows the current active I/O count on this path's
316		controller. Returns empty if iopolicy is not "queue-depth".
317		Requires CONFIG_NVME_MULTIPATH.
318
319What:		/sys/block/nvmeXcYnZ/numa_nodes
320Date:		January 2025
321KernelVersion:	6.15
322Contact:	Nilay Shroff <nilay@linux.ibm.com>
323Description:
324		Shows the NUMA node mask for which this path is the
325		currently selected path. Returns empty if iopolicy is not
326		"numa". Requires CONFIG_NVME_MULTIPATH.
327
328What:		/sys/block/nvmeXcYnZ/path_state
329Date:		September 2026
330KernelVersion:	7.4
331Contact:	Guixin Liu <kanie@linux.alibaba.com>
332Description:
333		Shows the current multipath path state for this namespace
334		path device. Possible values:
335
336		"enabled": the path is usable for I/O.
337
338		"ctrl-down": the path is disabled because the controller
339		is not live.
340
341		"ana-pending": the path is disabled because an ANA state
342		change is pending.
343
344		"ns-not-ready": the path is disabled because the namespace
345		is not ready.
346
347		Requires CONFIG_NVME_MULTIPATH.
348
349What:		/sys/block/nvmeXnY/delayed_removal_secs
350Date:		May 2025
351KernelVersion:	6.16
352Contact:	Nilay Shroff <nilay@linux.ibm.com>
353Description:
354		Shows or sets the delayed removal timeout in seconds for
355		the multipath head device. When nonzero, I/O is queued
356		instead of failed when all paths are gone, and head removal
357		is deferred. Only visible on multipath head devices.
358		Requires CONFIG_NVME_MULTIPATH.
359
360What:		/sys/block/nvmeXnY/fail_on_ctrl_loss
361Date:		October 2026
362KernelVersion:	7.4
363Contact:	Krishna Iyer <kiyer@crusoe.ai>
364Description:
365		Shows or sets the fail-on-ctrl-loss policy of the multipath
366		head device ("on" or "off", default "off"). When on, I/O
367		queued or arriving while no usable path exists is failed
368		immediately instead of being queued. This is the opposite of
369		the queue-if-no-path behavior enabled by a nonzero
370		delayed_removal_secs: when both are set fail_on_ctrl_loss takes
371		precedence and the parked I/O is failed rather than held for
372		the delayed_removal_secs window. Reconnect attempts are not
373		affected. Only visible on multipath head devices.
374		Requires CONFIG_NVME_MULTIPATH.
375
376What:		/sys/block/nvmeXnY/csi
377What:		/sys/block/nvmeXnY/metadata_bytes
378What:		/sys/block/nvmeXnY/nuse
379Date:		December 2023
380KernelVersion:	6.8
381Contact:	Daniel Wagner <dwagner@suse.de>
382Description:
383		csi: Shows the Command Set Identifier for this namespace.
384
385		metadata_bytes: Shows the metadata size in bytes.
386
387		nuse: Shows the Namespace Utilization (NUSE) value. Reading
388		triggers an Identify Namespace command to refresh the
389		value (rate-limited to avoid excessive commands).
390
391What:		/sys/block/nvmeXnY/passthru_err_log_enabled
392Date:		January 2024
393KernelVersion:	6.8
394Contact:	Alan Adamson <alan.adamson@oracle.com>
395Description:
396		Shows or sets whether I/O passthrough error logging is
397		enabled for this namespace. Reading returns "on" or "off".
398		Writing accepts a boolean value.
399
400What:		/sys/class/nvme/nvmeX/diag/command_error_count
401What:		/sys/class/nvme/nvmeX/diag/reset_count
402What:		/sys/class/nvme/nvmeX/diag/reconnect_count
403Date:		May 2026
404KernelVersion:	7.2
405Contact:	Nilay Shroff <nilay@linux.ibm.com>
406Description:
407		Controller diagnostic counters.
408
409		command_error_count: Admin command error counter.
410
411		reset_count: Controller reset counter.
412
413		reconnect_count: Accumulated reconnect counter. Only
414		available for fabrics controllers.
415
416		All counters can be reset by writing a value.
417
418What:		/sys/block/nvmeXnY/diag/command_retries_count
419What:		/sys/block/nvmeXnY/diag/command_error_count
420Date:		May 2026
421KernelVersion:	7.2
422Contact:	Nilay Shroff <nilay@linux.ibm.com>
423Description:
424		Namespace diagnostic counters for non-multipath
425		configurations (when CONFIG_NVME_MULTIPATH is not
426		configured).
427
428		command_retries_count: I/O command retry counter.
429
430		command_error_count: I/O command error counter.
431
432		All counters can be reset by writing any value.
433
434What:		/sys/block/nvmeXcYnZ/diag/command_retries_count
435What:		/sys/block/nvmeXcYnZ/diag/command_error_count
436What:		/sys/block/nvmeXcYnZ/diag/multipath_failover_count
437What:		/sys/block/nvmeXnY/diag/io_requeue_no_usable_path_count
438What:		/sys/block/nvmeXnY/diag/io_fail_no_available_path_count
439Date:		May 2026
440KernelVersion:	7.2
441Contact:	Nilay Shroff <nilay@linux.ibm.com>
442Description:
443		Namespace diagnostic counters for multipath
444		configurations (when CONFIG_NVME_MULTIPATH is
445		configured).
446
447		command_retries_count: I/O command retry counter.
448
449		command_error_count: I/O command error counter.
450
451		multipath_failover_count: Multipath failover counter.
452
453		io_requeue_no_usable_path_count: Counter of I/Os
454		requeued because no usable path was available.
455
456		io_fail_no_available_path_count: Counter of I/Os
457		failed because no available path existed.
458
459		All counters can be reset by writing any value.
460
461What:		/sys/class/nvme-subsystem/nvme-subsysX/model
462What:		/sys/class/nvme-subsystem/nvme-subsysX/serial
463What:		/sys/class/nvme-subsystem/nvme-subsysX/firmware_rev
464What:		/sys/class/nvme-subsystem/nvme-subsysX/subsysnqn
465Date:		November 2017
466KernelVersion:	4.15
467Contact:	Hannes Reinecke <hare@suse.de>
468Description:
469		Shows the model, serial number, firmware revision, or NQN
470		of the NVMe subsystem.
471
472What:		/sys/class/nvme-subsystem/nvme-subsysX/iopolicy
473Date:		February 2019
474KernelVersion:	5.1
475Contact:	Hannes Reinecke <hare@suse.de>
476Description:
477		Shows or sets the multipath I/O path selection policy for
478		this subsystem. Accepted values: "numa", "round-robin",
479		"queue-depth". Changing the policy clears all current path
480		selections. Only available when CONFIG_NVME_MULTIPATH is
481		enabled.
482
483		A discovery subsystem has no namespaces and hence no I/O
484		paths to select from: reading returns "none" and writing
485		fails with EOPNOTSUPP.
486
487What:		/sys/class/nvme-subsystem/nvme-subsysX/iopolicies
488Date:		September 2026
489KernelVersion:	7.4
490Contact:	Laurence Oberman <loberman@redhat.com>
491Description:
492		Shows the I/O path selection policies that may be written
493		to the iopolicy attribute of this subsystem, separated by
494		spaces: "numa round-robin queue-depth". A discovery
495		subsystem accepts no policy at all and reports "none".
496		Only available when CONFIG_NVME_MULTIPATH is enabled.
497
498What:		/sys/class/nvme-subsystem/nvme-subsysX/subsystype
499Date:		September 2021
500KernelVersion:	5.16
501Contact:	Hannes Reinecke <hare@suse.de>
502Description:
503		Shows the subsystem type. Possible values: "discovery",
504		"nvm", "reserved".
505