share/man/man4/iscsi.4

   1 .\" Copyright (c) 2014 Edward Tomasz Napierala
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd May 28, 2017
  27 .Dt ISCSI 4
  28 .Os
  29 .Sh NAME
  30 .Nm iscsi
  31 .Nd iSCSI initiator
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following line in the
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device iscsi"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 iscsi_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 subsystem provides the kernel component of an iSCSI initiator,
  50 responsible for implementing the Full Feature Phase of the iSCSI protocol.
  51 The initiator is the iSCSI client, which connects to an iSCSI target,
  52 providing local access to a remote block device.
  53 The userland component is provided by
  54 .Xr iscsid 8
  55 and both the kernel and userland are configured using
  56 .Xr iscsictl 8 .
  57 .Sh SYSCTL VARIABLES
  58 The following variables are available as both
  59 .Xr sysctl 8
  60 variables and
  61 .Xr loader 8
  62 tunables:
  63 .Bl -tag -width indent
  64 .It Va kern.iscsi.debug
  65 Verbosity level for log messages from the
  66 .Nm
  67 driver.
  68 Set to 0 to disable logging or 1 to warn about potential problems.
  69 Larger values enable debugging output.
  70 Defaults to 1.
  71 .It Va kern.iscsi.ping_timeout
  72 The number of seconds to wait for the target to respond to a NOP-Out
  73 PDU.
  74 In the event that there is no response within that time the session gets
  75 forcibly restarted.
  76 Set to 0 to disable sending NOP-Out PDUs.
  77 Defaults to 5.
  78 .It Va kern.iscsi.iscsid_timeout
  79 The number of seconds to wait for
  80 .Xr iscsid 8
  81 to establish a session.
  82 After that time
  83 .Nm
  84 will abort and retry.
  85 Defaults to 60.
  86 .It Va kern.iscsi.login_timeout
  87 The number of seconds to wait for a login attempt to succeed.
  88 After that time
  89 .Nm
  90 will abort and retry.
  91 Defaults to 60.
  92 .It Va kern.iscsi.maxtags
  93 The maximum number of outstanding IO requests.
  94 Defaults to 255.
  95 .It Va kern.iscsi.fail_on_disconnection
  96 Controls the behavior after an iSCSI connection has been dropped due to
  97 network problems.
  98 When set to 1, a dropped connection causes the iSCSI device nodes
  99 to be destroyed.
 100 After reconnecting, they will be created again.
 101 By default, the device nodes are left intact.
 102 While the connection is down all input/output operations are suspended, to be
 103 retried after the connection is reestablished.
 104 .El
 105 .Sh SEE ALSO
 106 .Xr iser 4 ,
 107 .Xr iscsi.conf 5 ,
 108 .Xr iscsictl 8 ,
 109 .Xr iscsid 8
 110 .Sh HISTORY
 111 The
 112 .Nm
 113 subsystem first appeared in
 114 .Fx 10.0 .
 115 .Sh AUTHORS
 116 The
 117 .Nm
 118 subsystem was developed by
 119 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 120 under sponsorship from the FreeBSD Foundation.