share/man/man4/cfiscsi.4

   1 .\" Copyright (c) 2013 Edward Tomasz Napierala
   2 .\" Copyright (c) 2015-2017 Alexander Motin <mav@FreeBSD.org>
   3 .\" Copyright (c) 2017 Enji Cooper <ngie@FreeBSD.org>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .Dd May 28, 2017
  28 .Dt CFISCSI 4
  29 .Os
  30 .Sh NAME
  31 .Nm cfiscsi
  32 .Nd CAM Target Layer iSCSI target frontend
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device cfiscsi"
  39 .Cd "device ctl"
  40 .Cd "device iscsi"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 cfiscsi_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 subsystem provides the kernel component of an iSCSI target.
  53 The target is the iSCSI server, providing LUNs backed by local files
  54 and volumes to remote initiators.
  55 The userspace component is provided by
  56 .Xr ctld 8 .
  57 .Nm
  58 is implemented as a
  59 .Xr ctl 4
  60 frontend and uses infrastructure provided by
  61 .Xr iscsi 4 .
  62 .Sh SYSCTL VARIABLES
  63 The following variables are available as both
  64 .Xr sysctl 8
  65 variables and
  66 .Xr loader 8
  67 tunables:
  68 .Bl -tag -width indent
  69 .It Va kern.cam.ctl.iscsi.debug
  70 Verbosity level for log messages from the kernel part of iSCSI target.
  71 Set to 0 to disable logging or 1 to warn about potential problems.
  72 Larger values enable debugging output.
  73 Defaults to 1.
  74 .It Va kern.cam.ctl.iscsi.maxtags
  75 The number of outstanding commands to advertise to each iSCSI initiator.
  76 Current implementation is not very accurate, so do not set this below 2.
  77 Defaults to 256.
  78 .It Va kern.cam.ctl.iscsi.ping_timeout
  79 The number of seconds to wait for the iSCSI initiator to respond to a NOP-In
  80 PDU.
  81 In the event that there is no response within that time the session gets
  82 forcibly terminated.
  83 Set to 0 to disable sending NOP-In PDUs.
  84 Defaults to 5.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr ctl 4 ,
  88 .Xr iscsi 4 ,
  89 .Xr ctl.conf 5 ,
  90 .Xr ctld 8
  91 .Sh HISTORY
  92 The
  93 .Nm
  94 subsystem first appeared in
  95 .Fx 10.0
  96 as part of the
  97 .Xr ctl 4
  98 driver.
  99 It was split off of
 100 .Xr ctl 4
 101 in
 102 .Fx 12.0 .
 103 .Sh AUTHORS
 104 .An -nosplit
 105 The
 106 .Nm
 107 subsystem was developed by
 108 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 109 under sponsorship from the FreeBSD Foundation.
 110 This manual page was written by
 111 .An Enji Cooper Aq Mt ngie@FreeBSD.org .