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