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