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