xref: /freebsd/usr.sbin/iscsid/iscsid.8 (revision 009ea47eb2d21856af4529aaaca32cd67748daea)
1*009ea47eSEdward Tomasz Napierala.\" Copyright (c) 2012 The FreeBSD Foundation
2*009ea47eSEdward Tomasz Napierala.\" All rights reserved.
3*009ea47eSEdward Tomasz Napierala.\"
4*009ea47eSEdward Tomasz Napierala.\" This software was developed by Edward Tomasz Napierala under sponsorship
5*009ea47eSEdward Tomasz Napierala.\" from the FreeBSD Foundation.
6*009ea47eSEdward Tomasz Napierala.\"
7*009ea47eSEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without
8*009ea47eSEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions
9*009ea47eSEdward Tomasz Napierala.\" are met:
10*009ea47eSEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright
11*009ea47eSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer.
12*009ea47eSEdward Tomasz Napierala.\" 2. Redistributions in binary form must reproduce the above copyright
13*009ea47eSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer in the
14*009ea47eSEdward Tomasz Napierala.\"    documentation and/or other materials provided with the distribution.
15*009ea47eSEdward Tomasz Napierala.\"
16*009ea47eSEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17*009ea47eSEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*009ea47eSEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*009ea47eSEdward Tomasz Napierala.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20*009ea47eSEdward Tomasz Napierala.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*009ea47eSEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*009ea47eSEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*009ea47eSEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*009ea47eSEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*009ea47eSEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*009ea47eSEdward Tomasz Napierala.\" SUCH DAMAGE.
27*009ea47eSEdward Tomasz Napierala.\"
28*009ea47eSEdward Tomasz Napierala.\" $FreeBSD$
29*009ea47eSEdward Tomasz Napierala.\"
30*009ea47eSEdward Tomasz Napierala.Dd September 20, 2012
31*009ea47eSEdward Tomasz Napierala.Dt ISCSID 8
32*009ea47eSEdward Tomasz Napierala.Os
33*009ea47eSEdward Tomasz Napierala.Sh NAME
34*009ea47eSEdward Tomasz Napierala.Nm iscsid
35*009ea47eSEdward Tomasz Napierala.Nd iSCSI initiator daemon
36*009ea47eSEdward Tomasz Napierala.Sh SYNOPSIS
37*009ea47eSEdward Tomasz Napierala.Nm
38*009ea47eSEdward Tomasz Napierala.Op Fl P Ar pidfile
39*009ea47eSEdward Tomasz Napierala.Op Fl d
40*009ea47eSEdward Tomasz Napierala.Op Fl l Ar loglevel
41*009ea47eSEdward Tomasz Napierala.Op Fl m Ar maxproc
42*009ea47eSEdward Tomasz Napierala.Op Fl t Ar seconds
43*009ea47eSEdward Tomasz Napierala.Sh DESCRIPTION
44*009ea47eSEdward Tomasz NapieralaThe
45*009ea47eSEdward Tomasz Napierala.Nm
46*009ea47eSEdward Tomasz Napieraladaemon is responsible for performing the Login Phase of iSCSI connections,
47*009ea47eSEdward Tomasz Napieralaas well as performing SendTargets discovery.
48*009ea47eSEdward Tomasz Napierala.Pp
49*009ea47eSEdward Tomasz Napierala.Pp
50*009ea47eSEdward Tomasz NapieralaUpon startup, the
51*009ea47eSEdward Tomasz Napierala.Nm
52*009ea47eSEdward Tomasz Napieraladaemon opens the iSCSI initiator device file and waits for kernel requests.
53*009ea47eSEdward Tomasz NapieralaIt doesn't use any configuration file; all the information it needs it gets
54*009ea47eSEdward Tomasz Napieralafrom the kernel.
55*009ea47eSEdward Tomasz Napierala.Pp
56*009ea47eSEdward Tomasz NapieralaWhen the
57*009ea47eSEdward Tomasz Napierala.Nm
58*009ea47eSEdward Tomasz Napieraladamon is not running, already established iSCSI connections continue
59*009ea47eSEdward Tomasz Napieralato work.
60*009ea47eSEdward Tomasz NapieralaHowever, establishing new connections, or recovering existing ones in case
61*009ea47eSEdward Tomasz Napieralaof connection error, is not possible.
62*009ea47eSEdward Tomasz Napierala.Pp
63*009ea47eSEdward Tomasz NapieralaThe following options are available:
64*009ea47eSEdward Tomasz Napierala.Bl -tag -width ".Fl P Ar pidfile"
65*009ea47eSEdward Tomasz Napierala.It Fl P Ar pidfile
66*009ea47eSEdward Tomasz NapieralaSpecify alternative location of a file where main process PID will be stored.
67*009ea47eSEdward Tomasz NapieralaThe default location is /var/run/iscsid.pid.
68*009ea47eSEdward Tomasz Napierala.It Fl d
69*009ea47eSEdward Tomasz NapieralaDebug mode.
70*009ea47eSEdward Tomasz NapieralaThe server sends verbose debug output to standard error, and does not
71*009ea47eSEdward Tomasz Napieralaput itself in the background.
72*009ea47eSEdward Tomasz NapieralaThe server will also not fork and will exit after processing one connection.
73*009ea47eSEdward Tomasz NapieralaThis option is only intended for debugging the initiator.
74*009ea47eSEdward Tomasz Napierala.It Fl l Ar loglevel
75*009ea47eSEdward Tomasz NapieralaSpecifies debug level.
76*009ea47eSEdward Tomasz NapieralaThe default is 0.
77*009ea47eSEdward Tomasz Napierala.It Fl m Ar maxproc
78*009ea47eSEdward Tomasz NapieralaSpecifies limit for concurrently running child processes handling
79*009ea47eSEdward Tomasz Napieralaconnections.
80*009ea47eSEdward Tomasz NapieralaThe default is 30.
81*009ea47eSEdward Tomasz NapieralaSetting it to 0 disables the limit.
82*009ea47eSEdward Tomasz Napierala.It Fl t Ar seconds
83*009ea47eSEdward Tomasz NapieralaSpecifies timeout for login session, after which the connection
84*009ea47eSEdward Tomasz Napieralawill be forcibly terminated.
85*009ea47eSEdward Tomasz NapieralaThe default is 60.
86*009ea47eSEdward Tomasz NapieralaSetting it to 0 disables the timeout.
87*009ea47eSEdward Tomasz Napierala.El
88*009ea47eSEdward Tomasz Napierala.Sh FILES
89*009ea47eSEdward Tomasz Napierala.Bl -tag -width ".Pa /var/run/iscsid.pid" -compact
90*009ea47eSEdward Tomasz Napierala.It Pa /dev/iscsi
91*009ea47eSEdward Tomasz NapieralaThe iSCSI initiator device file.
92*009ea47eSEdward Tomasz Napierala.It Pa /var/run/iscsid.pid
93*009ea47eSEdward Tomasz NapieralaThe default location of the
94*009ea47eSEdward Tomasz Napierala.Nm
95*009ea47eSEdward Tomasz NapieralaPID file.
96*009ea47eSEdward Tomasz Napierala.El
97*009ea47eSEdward Tomasz Napierala.Sh EXIT STATUS
98*009ea47eSEdward Tomasz NapieralaThe
99*009ea47eSEdward Tomasz Napierala.Nm
100*009ea47eSEdward Tomasz Napieralautility exits 0 on success, and >0 if an error occurs.
101*009ea47eSEdward Tomasz Napierala.Sh SEE ALSO
102*009ea47eSEdward Tomasz Napierala.Xr iscsictl 8
103*009ea47eSEdward Tomasz Napierala.Sh HISTORY
104*009ea47eSEdward Tomasz NapieralaThe
105*009ea47eSEdward Tomasz Napierala.Nm
106*009ea47eSEdward Tomasz Napieralacommand appeared in
107*009ea47eSEdward Tomasz Napierala.Fx 10.0 .
108*009ea47eSEdward Tomasz Napierala.Sh AUTHORS
109*009ea47eSEdward Tomasz NapieralaThe
110*009ea47eSEdward Tomasz Napierala.Nm
111*009ea47eSEdward Tomasz Napieralawas developed by
112*009ea47eSEdward Tomasz Napierala.An Edward Tomasz Napierala Aq trasz@FreeBSD.org
113*009ea47eSEdward Tomasz Napieralaunder sponsorship from the FreeBSD Foundation.
114