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