xref: /NextBSD/share/man/man4/iscsi_initiator.4 (revision 65145fa4c81da358fcbc3b650156dab705dfa34e)
1.\" Copyright (c) 2007-2010 Daniel Braniss <danny@cs.huji.ac.il>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 9, 2014
28.Dt ISCSI_INITIATOR 4
29.Os
30.Sh NAME
31.Nm iscsi_initiator
32.Nd kernel driver for the iSCSI protocol
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device iscsi_initiator"
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
45iscsi_initiator_load="YES"
46.Ed
47.Sh DESCRIPTION
48.Bf -symbolic
49This driver, along with its userspace counterpart
50.Xr iscontrol 8 ,
51is obsolete.
52Users are advised to use
53.Xr iscsi 4
54instead.
55.Ef
56.Pp
57The
58.Nm
59implements the kernel side of the Internet SCSI (iSCSI) network
60protocol standard, the user land companion is
61.Xr iscontrol 8 ,
62and permits access to remote
63.Em virtual
64SCSI devices via
65.Xr cam 4 .
66.Sh SYSCTL VARIABLES
67.Bl -tag -width ".Va net.iscsi.n.targeaddress"
68.It Va debug.iscsi_initiator
69set the debug-level, 0 means no debugging, 9 for maximum.
70.It Va net.iscsi.isid
71the initiator part of the Session Identifier.
72.It Va "kern.cam.cam_srch_hi=1"
73allow search above LUN 7 for SCSI3 and greater devices.
74.It "the following are informative only:"
75.It Va net.iscsi.driver_version
76the current version of the driver.
77.It Va net.iscsi.sessions
78the number of current active sessions.
79.It Va net.iscsi.n.targetname
80is the targe name of session
81.Em n .
82.It Va net.iscsi.n.targeaddress
83is the IP address of the target of session
84.Em n .
85.It Va net.iscsi.n.stats
86are some statistics for session
87.Em n
88.It Va net.iscsi.n.pid
89is the
90.Em "process id"
91of the userland side of session
92.Em n ,
93see
94.Xr iscontrol 8 .
95.El
96.Sh FILES
97The
98.Nm
99driver creates the following:
100.Pp
101.Bl -tag -width ".Pa /dev/iscsi%dxx" -compact
102.It Pa /dev/iscsi
103used to create new sessions.
104.It Pa /dev/iscsi%d
105for each new session.
106.El
107.Sh SEE ALSO
108.Xr cam 4 ,
109.Xr camcontrol 8 ,
110.Xr iscontrol 8
111.Sh STANDARDS
112iSCSI RFC 3720
113.\" .Sh HISTORY
114.Sh AUTHORS
115This software was written by
116.An Daniel Braniss Aq Mt danny@cs.huji.ac.il
117.Sh BUGS
118The lun discovery method is old-fashioned.
119