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