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