xref: /freebsd/share/man/man4/nvmft.4 (revision 9bc300465e48e19d794d88d0c158a2adb92c7197)
1.\"
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2024 Chelsio Communications, Inc.
5.\"
6.Dd May 2, 2024
7.Dt NVMFT 4
8.Os
9.Sh NAME
10.Nm nvmft
11.Nd "NVM Express over Fabrics CAM Target Layer frontend"
12.Sh SYNOPSIS
13To compile the subsystem into the kernel,
14place the following lines in the
15kernel configuration file:
16.Bd -ragged -offset indent
17.Cd "device nvmft"
18.Cd "device ctl"
19.Ed
20.Pp
21Alternatively, to load the subsystem as a
22module at boot time, place the following line in
23.Xr loader.conf 5 :
24.Bd -literal -offset indent
25nvmft_load="YES"
26.Ed
27.Sh DESCRIPTION
28The
29.Nm
30driver provides the kernel component of an NVM Express over Fabrics
31controller.
32The NVMeoF controller is the server exporting namespaces backed by
33local files and volumes to remote hosts.
34.Nm
35follows the dynamic controller model and creates a new dynamic controller
36for each association.
37.Pp
38.Nm
39is implemented as a
40.Xr ctl 4
41frontend and exports CAM Target Layer LUNs as namespaces to remote hosts.
42LUNs can be configured via
43.Xr ctladm 8 .
44.Pp
45Associations between the local controller and remote hosts are managed
46using both the
47.Xr nvmfd 8
48daemon and the
49.Xr ctladm 8
50utility.
51The
52.Xr nvmfd 8
53daemon listens for new associations and handles transport-specific
54negotiation before handing off connected queue pairs to
55.Nm
56which associates queue pairs with a suitable controller instance.
57The
58.Cm nvlist
59.Xr ctladm 8
60command lists active controllers.
61The
62.Cm nvterminate
63command terminates one or more associations between a local controller
64and a remote host.
65.Pp
66Associations require a supported transport such as
67.Xr nvmf_tcp 4
68for associations using TCP/IP.
69.Sh SEE ALSO
70.Xr ctl 4 ,
71.Xr nvmf 4 ,
72.Xr nvmf_tcp 4 ,
73.Xr ctladm 8 ,
74.Xr nvmfd 8
75.Sh HISTORY
76The
77.Nm
78module first appeared in
79.Fx 15.0 .
80.Sh AUTHORS
81The
82.Nm
83subsystem was developed by
84.An John Baldwin Aq Mt jhb@FreeBSD.org
85under sponsorship from Chelsio Communications, Inc.
86