1 .\" Copyright (c) 2014 Edward Tomasz Napierala
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 To compile this driver into the kernel,
34 place the following line in the
35 kernel configuration file:
36 .Bd -ragged -offset indent
40 Alternatively, to load the driver as a
41 module at boot time, place the following line in
43 .Bd -literal -offset indent
49 subsystem provides the kernel component of an iSCSI initiator.
50 The initiator is the iSCSI client, which connects to an iSCSI target,
51 providing local access to a remote block device.
52 The userland component is provided by
54 and both the kernel and userland are configured using
58 subsystem is responsible for implementing the
59 .Qq Full Feature Phase
60 of the iSCSI protocol.
62 The following variables are available as both
67 .Bl -tag -width indent
68 .It Va kern.iscsi.debug
69 Verbosity level for log messages from the
72 Set to 0 to disable logging or 1 to warn about potential problems.
73 Larger values enable debugging output.
75 .It Va kern.iscsi.ping_timeout
76 The number of seconds to wait for the target to respond to a NOP-Out
78 In the event that there is no response within that time the session gets
80 Set to 0 to disable sending NOP-Out PDUs.
82 .It Va kern.iscsi.iscsid_timeout
83 The number of seconds to wait for
85 to establish a session.
90 .It Va kern.iscsi.login_timeout
91 The number of seconds to wait for a login attempt to succeed.
96 .It Va kern.iscsi.maxtags
97 The maximum number of outstanding IO requests.
99 .It Va kern.iscsi.fail_on_disconnection
100 Controls the behavior after an iSCSI connection has been dropped due to
102 When set to 1, a dropped connection causes the iSCSI device nodes
104 After reconnecting, they will be created again.
105 By default, the device nodes are left intact.
106 While the connection is down all input/output operations are suspended, to be
107 retried after the connection is reestablished.
116 subsystem first appeared in
121 subsystem was developed by
122 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
123 under sponsorship from the FreeBSD Foundation.