diff options
Diffstat (limited to 'static/freebsd/man4/nvmf.4 3.html')
| -rw-r--r-- | static/freebsd/man4/nvmf.4 3.html | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/static/freebsd/man4/nvmf.4 3.html b/static/freebsd/man4/nvmf.4 3.html new file mode 100644 index 00000000..2a89420d --- /dev/null +++ b/static/freebsd/man4/nvmf.4 3.html @@ -0,0 +1,93 @@ +<table class="head"> + <tr> + <td class="head-ltitle">NVMF(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">NVMF(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">nvmf</code> — <span class="Nd">NVM Express + over Fabrics host driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile the driver into the kernel, place the following line in + the kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device nvmf</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + the following line in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>nvmf_load="YES"</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">nvmf</code> driver provides the kernel + component of an NVM Express over Fabrics host. The NVMeoF host is the client + which provides local access to namespaces exported by a remote + controller.</p> +<p class="Pp">Associations between the local host and remote controllers are + managed using <a class="Xr">nvmecontrol(8)</a>. New associations are created + via the <code class="Cm">connect</code> command and destroyed via the + <code class="Cm">disconnect</code> command. If an association's connection + is interrupted, the <code class="Cm">reconnect</code> command creates a new + association to replace the interrupted association.</p> +<p class="Pp">Similar to <a class="Xr">nvme(4)</a>, <code class="Nm">nvmf</code> + creates controller device nodes using the format + <span class="Pa">/dev/nvmeX</span> and namespace device nodes using the + format <span class="Pa">/dev/nvmeXnsY</span>. <code class="Nm">nvmf</code> + also exports remote namespaces via the CAM <a class="Xr">nda(4)</a> + peripheral driver. Unlike <a class="Xr">nvme(4)</a>, + <code class="Nm">nvmf</code> does not support the <a class="Xr">nvd(4)</a> + disk driver.</p> +<p class="Pp">Associations require a supported transport such as + <a class="Xr">nvmf_tcp(4)</a> for associations using TCP/IP.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL + VARIABLES</a></h1> +<p class="Pp">The following variables are available as both + <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a> + tunables:</p> +<dl class="Bl-tag"> + <dt id="kern.nvmf.fail_on_disconnection"><var class="Va">kern.nvmf.fail_on_disconnection</var></dt> + <dd>Determines the behavior when an association's connection is interrupted. + By default, input/output operations are suspended while a host is + disconnected. This includes operations pending at the time the + association's connection was interrupted as well as new requests submitted + while the host is disconnected. Once a new association is established, + suspended I/O requests are retried. When set to 1, input/output operations + fail with <code class="Er">EIO</code> while a host is disconnected and + <a class="Xr">nda(4)</a> peripherals are destroyed after the first failed + I/O request. Note that any destroyed <a class="Xr">nda(4)</a> peripherals + will be recreated after a new association is established.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">nda(4)</a>, <a class="Xr">nvme(4)</a>, + <a class="Xr">nvmf_tcp(4)</a>, <a class="Xr">nvmft(4)</a>, + <a class="Xr">nvmecontrol(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">nvmf</code> module first appeared in + <span class="Ux">FreeBSD 15.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">nvmf</code> driver was developed by + <span class="An">John Baldwin</span> + <<a class="Mt" href="mailto:jhb@FreeBSD.org">jhb@FreeBSD.org</a>> + under sponsorship from Chelsio Communications, Inc.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">May 7, 2025</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |