xref: /freebsd/usr.sbin/iscsid/iscsid.8 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2012 The FreeBSD Foundation
2.\"
3.\" This software was developed by Edward Tomasz Napierala under sponsorship
4.\" from the FreeBSD Foundation.
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 AUTHORS 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 AUTHORS 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.\"
29.Dd May 28, 2017
30.Dt ISCSID 8
31.Os
32.Sh NAME
33.Nm iscsid
34.Nd iSCSI initiator daemon
35.Sh SYNOPSIS
36.Nm
37.Op Fl P Ar pidfile
38.Op Fl d
39.Op Fl l Ar loglevel
40.Op Fl m Ar maxproc
41.Op Fl t Ar seconds
42.Sh DESCRIPTION
43The
44.Nm
45daemon is the userspace component of the iSCSI initiator,
46responsible for performing the Login Phase
47of iSCSI connections and the SendTargets discovery.
48.Pp
49Upon startup, the
50.Nm
51daemon opens the iSCSI initiator device file and waits for requests
52from the kernel component,
53.Xr iscsi 4 .
54.Nm
55does not use any configuration files.
56All needed information is supplied by the kernel.
57.Pp
58When the
59.Nm
60daemon is not running, already established iSCSI connections continue
61to work.
62However, establishing new connections, or recovering existing ones in case
63of connection error, is not possible.
64.Pp
65The following options are available:
66.Bl -tag -width ".Fl P Ar pidfile"
67.It Fl P Ar pidfile
68Specify alternative location of a file where main process PID will be stored.
69The default location is
70.Pa /var/run/iscsid.pid .
71.It Fl d
72Debug mode.
73The daemon sends verbose debug output to standard error, and does not
74put itself in the background.
75The daemon will also not fork and will exit after processing one connection.
76This option is only intended for debugging the initiator.
77.It Fl l Ar loglevel
78Specifies debug level.
79The default is 0.
80.It Fl m Ar maxproc
81Specifies limit for concurrently running child processes handling
82connections.
83The default is 30.
84Setting it to 0 disables the limit.
85.It Fl t Ar seconds
86Specifies timeout for login session, after which the connection
87will be forcibly terminated.
88The default is 60.
89Setting it to 0 disables the timeout.
90.El
91.Sh FILES
92.Bl -tag -width ".Pa /var/run/iscsid.pid" -compact
93.It Pa /dev/iscsi
94The iSCSI initiator device file.
95.It Pa /var/run/iscsid.pid
96The default location of the
97.Nm
98PID file.
99.El
100.Sh EXIT STATUS
101The
102.Nm
103utility exits 0 on success, and >0 if an error occurs.
104.Sh SEE ALSO
105.Xr iscsi 4 ,
106.Xr iscsictl 8
107.Sh HISTORY
108The
109.Nm
110command appeared in
111.Fx 10.0 .
112.Sh AUTHORS
113The
114.Nm
115utility was developed by
116.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
117under sponsorship from the FreeBSD Foundation.
118