xref: /freebsd/usr.sbin/iscsid/iscsid.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1009ea47eSEdward Tomasz Napierala.\" Copyright (c) 2012 The FreeBSD Foundation
2009ea47eSEdward Tomasz Napierala.\"
3009ea47eSEdward Tomasz Napierala.\" This software was developed by Edward Tomasz Napierala under sponsorship
4009ea47eSEdward Tomasz Napierala.\" from the FreeBSD Foundation.
5009ea47eSEdward Tomasz Napierala.\"
6009ea47eSEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without
7009ea47eSEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions
8009ea47eSEdward Tomasz Napierala.\" are met:
9009ea47eSEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright
10009ea47eSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer.
11009ea47eSEdward Tomasz Napierala.\" 2. Redistributions in binary form must reproduce the above copyright
12009ea47eSEdward Tomasz Napierala.\"    notice, this list of conditions and the following disclaimer in the
13009ea47eSEdward Tomasz Napierala.\"    documentation and/or other materials provided with the distribution.
14009ea47eSEdward Tomasz Napierala.\"
15009ea47eSEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16009ea47eSEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17009ea47eSEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18009ea47eSEdward Tomasz Napierala.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19009ea47eSEdward Tomasz Napierala.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20009ea47eSEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21009ea47eSEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22009ea47eSEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23009ea47eSEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24009ea47eSEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25009ea47eSEdward Tomasz Napierala.\" SUCH DAMAGE.
26009ea47eSEdward Tomasz Napierala.\"
27*aa212185SEdward Tomasz Napierala.Dd May 28, 2017
28009ea47eSEdward Tomasz Napierala.Dt ISCSID 8
29009ea47eSEdward Tomasz Napierala.Os
30009ea47eSEdward Tomasz Napierala.Sh NAME
31009ea47eSEdward Tomasz Napierala.Nm iscsid
32009ea47eSEdward Tomasz Napierala.Nd iSCSI initiator daemon
33009ea47eSEdward Tomasz Napierala.Sh SYNOPSIS
34009ea47eSEdward Tomasz Napierala.Nm
35009ea47eSEdward Tomasz Napierala.Op Fl P Ar pidfile
36009ea47eSEdward Tomasz Napierala.Op Fl d
37009ea47eSEdward Tomasz Napierala.Op Fl l Ar loglevel
38009ea47eSEdward Tomasz Napierala.Op Fl m Ar maxproc
39009ea47eSEdward Tomasz Napierala.Op Fl t Ar seconds
40009ea47eSEdward Tomasz Napierala.Sh DESCRIPTION
41009ea47eSEdward Tomasz NapieralaThe
42009ea47eSEdward Tomasz Napierala.Nm
43*aa212185SEdward Tomasz Napieraladaemon is the userspace component of the iSCSI initiator,
44*aa212185SEdward Tomasz Napieralaresponsible for performing the Login Phase
45*aa212185SEdward Tomasz Napieralaof iSCSI connections and the SendTargets discovery.
46009ea47eSEdward Tomasz Napierala.Pp
47009ea47eSEdward Tomasz NapieralaUpon startup, the
48009ea47eSEdward Tomasz Napierala.Nm
49*aa212185SEdward Tomasz Napieraladaemon opens the iSCSI initiator device file and waits for requests
50*aa212185SEdward Tomasz Napieralafrom the kernel component,
51*aa212185SEdward Tomasz Napierala.Xr iscsi 4 .
524f9ec027SAllan Jude.Nm
534f9ec027SAllan Judedoes not use any configuration files.
544f9ec027SAllan JudeAll needed information is supplied by the kernel.
55009ea47eSEdward Tomasz Napierala.Pp
56009ea47eSEdward Tomasz NapieralaWhen the
57009ea47eSEdward Tomasz Napierala.Nm
584f9ec027SAllan Judedaemon is not running, already established iSCSI connections continue
59009ea47eSEdward Tomasz Napieralato work.
60009ea47eSEdward Tomasz NapieralaHowever, establishing new connections, or recovering existing ones in case
61009ea47eSEdward Tomasz Napieralaof connection error, is not possible.
62009ea47eSEdward Tomasz Napierala.Pp
63009ea47eSEdward Tomasz NapieralaThe following options are available:
64009ea47eSEdward Tomasz Napierala.Bl -tag -width ".Fl P Ar pidfile"
65009ea47eSEdward Tomasz Napierala.It Fl P Ar pidfile
66009ea47eSEdward Tomasz NapieralaSpecify alternative location of a file where main process PID will be stored.
6733e1779aSJoel DahlThe default location is
6833e1779aSJoel Dahl.Pa /var/run/iscsid.pid .
69009ea47eSEdward Tomasz Napierala.It Fl d
70009ea47eSEdward Tomasz NapieralaDebug mode.
7123bd2dd4SEdward Tomasz NapieralaThe daemon sends verbose debug output to standard error, and does not
72009ea47eSEdward Tomasz Napieralaput itself in the background.
7323bd2dd4SEdward Tomasz NapieralaThe daemon will also not fork and will exit after processing one connection.
74009ea47eSEdward Tomasz NapieralaThis option is only intended for debugging the initiator.
75009ea47eSEdward Tomasz Napierala.It Fl l Ar loglevel
76009ea47eSEdward Tomasz NapieralaSpecifies debug level.
77009ea47eSEdward Tomasz NapieralaThe default is 0.
78009ea47eSEdward Tomasz Napierala.It Fl m Ar maxproc
79009ea47eSEdward Tomasz NapieralaSpecifies limit for concurrently running child processes handling
80009ea47eSEdward Tomasz Napieralaconnections.
81009ea47eSEdward Tomasz NapieralaThe default is 30.
82009ea47eSEdward Tomasz NapieralaSetting it to 0 disables the limit.
83009ea47eSEdward Tomasz Napierala.It Fl t Ar seconds
84009ea47eSEdward Tomasz NapieralaSpecifies timeout for login session, after which the connection
85009ea47eSEdward Tomasz Napieralawill be forcibly terminated.
86009ea47eSEdward Tomasz NapieralaThe default is 60.
87009ea47eSEdward Tomasz NapieralaSetting it to 0 disables the timeout.
88009ea47eSEdward Tomasz Napierala.El
89009ea47eSEdward Tomasz Napierala.Sh FILES
90009ea47eSEdward Tomasz Napierala.Bl -tag -width ".Pa /var/run/iscsid.pid" -compact
91009ea47eSEdward Tomasz Napierala.It Pa /dev/iscsi
92009ea47eSEdward Tomasz NapieralaThe iSCSI initiator device file.
93009ea47eSEdward Tomasz Napierala.It Pa /var/run/iscsid.pid
94009ea47eSEdward Tomasz NapieralaThe default location of the
95009ea47eSEdward Tomasz Napierala.Nm
96009ea47eSEdward Tomasz NapieralaPID file.
97009ea47eSEdward Tomasz Napierala.El
98009ea47eSEdward Tomasz Napierala.Sh EXIT STATUS
99009ea47eSEdward Tomasz NapieralaThe
100009ea47eSEdward Tomasz Napierala.Nm
101009ea47eSEdward Tomasz Napieralautility exits 0 on success, and >0 if an error occurs.
102009ea47eSEdward Tomasz Napierala.Sh SEE ALSO
1034f9ec027SAllan Jude.Xr iscsi 4 ,
104009ea47eSEdward Tomasz Napierala.Xr iscsictl 8
105009ea47eSEdward Tomasz Napierala.Sh HISTORY
106009ea47eSEdward Tomasz NapieralaThe
107009ea47eSEdward Tomasz Napierala.Nm
108009ea47eSEdward Tomasz Napieralacommand appeared in
109009ea47eSEdward Tomasz Napierala.Fx 10.0 .
110009ea47eSEdward Tomasz Napierala.Sh AUTHORS
111009ea47eSEdward Tomasz NapieralaThe
112009ea47eSEdward Tomasz Napierala.Nm
1134f9ec027SAllan Judeutility was developed by
11401c2b8acSBaptiste Daroussin.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
115009ea47eSEdward Tomasz Napieralaunder sponsorship from the FreeBSD Foundation.
116