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.Dd May 28, 2017 26.Dt CFISCSI 4 27.Os 28.Sh NAME 29.Nm cfiscsi 30.Nd CAM Target Layer iSCSI target frontend 31.Sh SYNOPSIS 32To compile this driver into the kernel, 33place the following lines in your 34kernel configuration file: 35.Bd -ragged -offset indent 36.Cd "device cfiscsi" 37.Cd "device ctl" 38.Cd "device iscsi" 39.Ed 40.Pp 41Alternatively, to load the driver as a 42module at boot time, place the following line in 43.Xr loader.conf 5 : 44.Bd -literal -offset indent 45cfiscsi_load="YES" 46.Ed 47.Sh DESCRIPTION 48The 49.Nm 50subsystem provides the kernel component of an iSCSI target. 51The target is the iSCSI server, providing LUNs backed by local files 52and volumes to remote initiators. 53The userspace component is provided by 54.Xr ctld 8 . 55.Nm 56is implemented as a 57.Xr ctl 4 58frontend and uses infrastructure provided by 59.Xr iscsi 4 . 60.Sh SYSCTL VARIABLES 61The following variables are available as both 62.Xr sysctl 8 63variables and 64.Xr loader 8 65tunables: 66.Bl -tag -width indent 67.It Va kern.cam.ctl.iscsi.debug 68Verbosity level for log messages from the kernel part of iSCSI target. 69Set to 0 to disable logging or 1 to warn about potential problems. 70Larger values enable debugging output. 71Defaults to 1. 72.It Va kern.cam.ctl.iscsi.maxtags 73The number of outstanding commands to advertise to each iSCSI initiator. 74Current implementation is not very accurate, so do not set this below 2. 75Defaults to 256. 76.It Va kern.cam.ctl.iscsi.ping_timeout 77The number of seconds to wait for the iSCSI initiator to respond to a NOP-In 78PDU. 79In the event that there is no response within that time the session gets 80forcibly terminated. 81Set to 0 to disable sending NOP-In PDUs. 82Defaults to 5. 83.El 84.Sh SEE ALSO 85.Xr ctl 4 , 86.Xr iscsi 4 , 87.Xr ctl.conf 5 , 88.Xr ctld 8 89.Sh HISTORY 90The 91.Nm 92subsystem first appeared in 93.Fx 10.0 94as part of the 95.Xr ctl 4 96driver. 97It was split off of 98.Xr ctl 4 99in 100.Fx 12.0 . 101.Sh AUTHORS 102.An -nosplit 103The 104.Nm 105subsystem was developed by 106.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 107under sponsorship from the FreeBSD Foundation. 108This manual page was written by 109.An Enji Cooper Aq Mt ngie@FreeBSD.org . 110