xref: /netbsd-src/sbin/iscsid/iscsid.8 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\" $NetBSD: iscsid.8,v 1.10 2014/03/18 18:20:38 riastradh Exp $
2.\"
3.\" Copyright (c) 2011 Alistair Crooks <agc@NetBSD.org>
4.\" All rights reserved.
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 AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd May 27, 2012
27.Dt ISCSID 8
28.Os
29.Sh NAME
30.Nm iscsid
31.Nd interface to kernel iSCSI driver
32.Sh SYNOPSIS
33.Nm
34.Op Fl n
35.Op Fl d Ar lvl
36.Sh DESCRIPTION
37The iSCSI initiator runs as a kernel driver, and provides access
38to iSCSI targets running across a network using the iSCSI protocol,
39RFC 3270.
40The
41.Nm
42utility itself interfaces to the kernel iSCSI driver, and also
43communicates, using
44.Xr isns 3 ,
45with the iSCSI name service running on other hosts
46to locate services and iSCSI instances.
47In normal operation,
48.Nm
49is a standard daemon, and will detach from the controlling
50terminal using
51.Xr daemon 3
52and then loops, reading requests, processing them,
53and sending responses.
54Communication takes place over a
55Unix domain socket.
56.Nm
57exits on receiving a terminate message,
58(no response to one that is sent to the kernel),
59or when an error occurs reading from or writing to the socket.
60.Pp
61The
62.Fl d
63flag increases the debug level to
64.Ar lvl .
65Any level above 0 causes
66.Nm
67to remain in the foreground, and increases the amount of debug output.
68The
69.Fl n
70flag makes the daemon single-threaded.
71.Pp
72It is envisaged that user-level communication take place with
73.Nm
74using the
75.Xr iscsictl 8
76utility, rather than directly over its communication socket.
77An example of setting up the in-kernel iSCSI initiator
78is shown in
79.Xr iscsictl 8 .
80.Sh SEE ALSO
81.Xr daemon 3 ,
82.Xr isns 3 ,
83.Xr iscsictl 8
84.Sh HISTORY
85The
86.Nm
87utility appeared in
88.Nx 6.0 .
89.Sh AUTHORS
90.An Alistair Crooks Aq Mt agc@NetBSD.org
91wrote this manual page.
92The
93.Nm
94utility was contributed by Wasabi Systems, Inc.
95