summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/cfiscsi.4 3.html
blob: 28230c19ba05e7f0bcc93b22082354b73b46a697 (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
<table class="head">
  <tr>
    <td class="head-ltitle">CFISCSI(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">CFISCSI(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">cfiscsi</code> &#x2014; <span class="Nd">CAM
    Target Layer iSCSI target frontend</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device cfiscsi</code>
<br/>
<code class="Cd">device ctl</code>
<br/>
<code class="Cd">device iscsi</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>cfiscsi_load=&quot;YES&quot;</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">cfiscsi</code> subsystem provides the kernel
    component of an iSCSI target. The target is the iSCSI server, providing LUNs
    backed by local files and volumes to remote initiators. The userspace
    component is provided by <a class="Xr">ctld(8)</a>.
    <code class="Nm">cfiscsi</code> is implemented as a <a class="Xr">ctl(4)</a>
    frontend and uses infrastructure provided by <a class="Xr">iscsi(4)</a>.</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.cam.ctl.iscsi.debug"><var class="Va">kern.cam.ctl.iscsi.debug</var></dt>
  <dd>Verbosity level for log messages from the kernel part of iSCSI target. Set
      to 0 to disable logging or 1 to warn about potential problems. Larger
      values enable debugging output. Defaults to 1.</dd>
  <dt id="kern.cam.ctl.iscsi.maxtags"><var class="Va">kern.cam.ctl.iscsi.maxtags</var></dt>
  <dd>The number of outstanding commands to advertise to each iSCSI initiator.
      Current implementation is not very accurate, so do not set this below 2.
      Defaults to 256.</dd>
  <dt id="kern.cam.ctl.iscsi.ping_timeout"><var class="Va">kern.cam.ctl.iscsi.ping_timeout</var></dt>
  <dd>The number of seconds to wait for the iSCSI initiator to respond to a
      NOP-In PDU. In the event that there is no response within that time the
      session gets forcibly terminated. Set to 0 to disable sending NOP-In PDUs.
      Defaults to 5.</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">ctl(4)</a>, <a class="Xr">iscsi(4)</a>,
    <a class="Xr">ctl.conf(5)</a>, <a class="Xr">ctld(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">cfiscsi</code> subsystem first appeared in
    <span class="Ux">FreeBSD 10.0</span> as part of the <a class="Xr">ctl(4)</a>
    driver. It was split off of <a class="Xr">ctl(4)</a> in
    <span class="Ux">FreeBSD 12.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">cfiscsi</code> subsystem was developed by
    <span class="An">Edward Tomasz Napierala</span>
    &lt;<a class="Mt" href="mailto:trasz@FreeBSD.org">trasz@FreeBSD.org</a>&gt;
    under sponsorship from the FreeBSD Foundation. This manual page was written
    by <span class="An">Enji Cooper</span>
    &lt;<a class="Mt" href="mailto:ngie@FreeBSD.org">ngie@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">May 28, 2017</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>