summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/iscsi.4 3.html
blob: a8359e02a3791fa5c2448668ae7edb7c0acdd487 (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
<table class="head">
  <tr>
    <td class="head-ltitle">ISCSI(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">ISCSI(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">iscsi</code> &#x2014; <span class="Nd">iSCSI
    initiator</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 line
    in the kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><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>iscsi_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">iscsi</code> subsystem provides the kernel
    component of an iSCSI initiator, responsible for implementing the Full
    Feature Phase of the iSCSI protocol. The initiator is the iSCSI client,
    which connects to an iSCSI target, providing local access to a remote block
    device. The userland component is provided by <a class="Xr">iscsid(8)</a>
    and both the kernel and userland are configured using
    <a class="Xr">iscsictl(8)</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.iscsi.debug"><var class="Va">kern.iscsi.debug</var></dt>
  <dd>Verbosity level for log messages from the <code class="Nm">iscsi</code>
      driver. 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.iscsi.ping_timeout"><var class="Va">kern.iscsi.ping_timeout</var></dt>
  <dd>The number of seconds to wait for the target to respond to a NOP-Out PDU.
      In the event that there is no response within that time the session gets
      forcibly restarted. Set to 0 to disable sending NOP-Out PDUs. Defaults to
      5.</dd>
  <dt id="kern.iscsi.iscsid_timeout"><var class="Va">kern.iscsi.iscsid_timeout</var></dt>
  <dd>The number of seconds to wait for <a class="Xr">iscsid(8)</a> to establish
      a session. After that time <code class="Nm">iscsi</code> will abort and
      retry. Defaults to 60.</dd>
  <dt id="kern.iscsi.login_timeout"><var class="Va">kern.iscsi.login_timeout</var></dt>
  <dd>The number of seconds to wait for a login attempt to succeed. After that
      time <code class="Nm">iscsi</code> will abort and retry. Defaults to
    60.</dd>
  <dt id="kern.iscsi.maxtags"><var class="Va">kern.iscsi.maxtags</var></dt>
  <dd>The maximum number of outstanding IO requests. Defaults to 255.</dd>
  <dt id="kern.iscsi.fail_on_disconnection"><var class="Va">kern.iscsi.fail_on_disconnection</var></dt>
  <dd>Controls the behavior after an iSCSI connection has been dropped due to
      network problems. When set to 1, a dropped connection causes the iSCSI
      device nodes to be destroyed. After reconnecting, they will be created
      again. By default, the device nodes are left intact. While the connection
      is down all input/output operations are suspended, to be retried after the
      connection is reestablished.</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">iser(4)</a>, <a class="Xr">iscsi.conf(5)</a>,
    <a class="Xr">iscsictl(8)</a>, <a class="Xr">iscsid(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">iscsi</code> subsystem first appeared in
    <span class="Ux">FreeBSD 10.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">iscsi</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.</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>