xref: /freebsd/share/man/man4/cfiscsi.4 (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
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 March 29, 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 iSCSI target device emulation via
54.Xr ctl 4
55and
56.Xr iscsi 4 .
57.Sh SYSCTL VARIABLES
58The following variables are available as both
59.Xr sysctl 8
60variables and
61.Xr loader 8
62tunables:
63.Bl -tag -width indent
64.It Va kern.cam.ctl.iscsi.debug
65Verbosity level for log messages from the kernel part of iSCSI target.
66Set to 0 to disable logging or 1 to warn about potential problems.
67Larger values enable debugging output.
68Defaults to 1.
69.It Va kern.cam.ctl.iscsi.maxtags
70The number of outstanding commands to advertise to each iSCSI initiator.
71Current implementation is not very accurate, so do not set this below 2.
72Defaults to 256.
73.It Va kern.cam.ctl.iscsi.ping_timeout
74The number of seconds to wait for the iSCSI initiator to respond to a NOP-In
75PDU.
76In the event that there is no response within that time the session gets
77forcibly terminated.
78Set to 0 to disable sending NOP-In PDUs.
79Defaults to 5.
80.El
81.Sh SEE ALSO
82.Xr ctl 4 ,
83.Xr iscsi 4
84.Sh HISTORY
85The
86.Nm
87subsystem first appeared in
88.Fx 10.0
89as part of the
90.Xr ctl 4
91driver.
92It was split off of
93.Xr ctl 4
94in
95.Fx 12.0 .
96.Sh AUTHORS
97.An -nosplit
98The
99.Nm
100subsystem was developed by
101.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
102under sponsorship from the FreeBSD Foundation.
103This manual page was written by
104.An Ngie Cooper Aq Mt ngie@FreeBSD.org .
105