xref: /netbsd-src/sbin/iscsid/iscsid.8 (revision 9724d495e5d1fd2420d3af47d12713523445fadc)
1*9724d495Spgoyette.\" $NetBSD: iscsid.8,v 1.14 2022/04/14 18:52:27 pgoyette Exp $
275a17f3cSagc.\"
375a17f3cSagc.\" Copyright (c) 2011 Alistair Crooks <agc@NetBSD.org>
475a17f3cSagc.\" All rights reserved.
575a17f3cSagc.\"
675a17f3cSagc.\" Redistribution and use in source and binary forms, with or without
775a17f3cSagc.\" modification, are permitted provided that the following conditions
875a17f3cSagc.\" are met:
975a17f3cSagc.\" 1. Redistributions of source code must retain the above copyright
1075a17f3cSagc.\"    notice, this list of conditions and the following disclaimer.
1175a17f3cSagc.\" 2. Redistributions in binary form must reproduce the above copyright
1275a17f3cSagc.\"    notice, this list of conditions and the following disclaimer in the
1375a17f3cSagc.\"    documentation and/or other materials provided with the distribution.
1475a17f3cSagc.\"
1575a17f3cSagc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1675a17f3cSagc.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1775a17f3cSagc.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1875a17f3cSagc.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1975a17f3cSagc.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2075a17f3cSagc.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2175a17f3cSagc.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2275a17f3cSagc.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2375a17f3cSagc.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2475a17f3cSagc.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2575a17f3cSagc.\"
26*9724d495Spgoyette.Dd April 14, 2022
2735d95431Snjoly.Dt ISCSID 8
2875a17f3cSagc.Os
2975a17f3cSagc.Sh NAME
3075a17f3cSagc.Nm iscsid
3175a17f3cSagc.Nd interface to kernel iSCSI driver
3275a17f3cSagc.Sh SYNOPSIS
3375a17f3cSagc.Nm
346fea88c2Smlelstv.Op Fl D
35c1043d58Swiz.Op Fl d Ar lvl
3675a17f3cSagc.Sh DESCRIPTION
3775a17f3cSagcThe iSCSI initiator runs as a kernel driver, and provides access
3875a17f3cSagcto iSCSI targets running across a network using the iSCSI protocol,
39c9f8274cStnnRFC 3720.
4075a17f3cSagcThe
4175a17f3cSagc.Nm
4275a17f3cSagcutility itself interfaces to the kernel iSCSI driver, and also
4375a17f3cSagccommunicates, using
4435d95431Snjoly.Xr isns 3 ,
4575a17f3cSagcwith the iSCSI name service running on other hosts
4675a17f3cSagcto locate services and iSCSI instances.
4775a17f3cSagcIn normal operation,
4875a17f3cSagc.Nm
4975a17f3cSagcis a standard daemon, and will detach from the controlling
5075a17f3cSagcterminal using
5175a17f3cSagc.Xr daemon 3
5275a17f3cSagcand then loops, reading requests, processing them,
5375a17f3cSagcand sending responses.
5475a17f3cSagcCommunication takes place over a
5575a17f3cSagcUnix domain socket.
5675a17f3cSagc.Nm
5775a17f3cSagcexits on receiving a terminate message,
5875a17f3cSagc(no response to one that is sent to the kernel),
5975a17f3cSagcor when an error occurs reading from or writing to the socket.
6075a17f3cSagc.Pp
6104f0598fSrizThe
6204f0598fSriz.Fl d
636fea88c2Smlelstvflag increases the log level to
6404f0598fSriz.Ar lvl .
656fea88c2SmlelstvAt level 0 only start and stop messages are logged.
6604f0598fSrizThe
676fea88c2Smlelstv.Fl D
686fea88c2Smlelstvflag causes
696fea88c2Smlelstv.Nm
706fea88c2Smlelstvto remain in the foreground and to write log output to stdout.
7175a17f3cSagc.Pp
7275a17f3cSagcIt is envisaged that user-level communication take place with
7375a17f3cSagc.Nm
7475a17f3cSagcusing the
7575a17f3cSagc.Xr iscsictl 8
7675a17f3cSagcutility, rather than directly over its communication socket.
7775a17f3cSagcAn example of setting up the in-kernel iSCSI initiator
7875a17f3cSagcis shown in
7975a17f3cSagc.Xr iscsictl 8 .
8075a17f3cSagc.Sh SEE ALSO
8175a17f3cSagc.Xr daemon 3 ,
8235d95431Snjoly.Xr isns 3 ,
8375a17f3cSagc.Xr iscsictl 8
8475a17f3cSagc.Sh HISTORY
8575a17f3cSagcThe
8675a17f3cSagc.Nm
8775a17f3cSagcutility appeared in
8875a17f3cSagc.Nx 6.0 .
8975a17f3cSagc.Sh AUTHORS
90a5684d07Swiz.An Alistair Crooks Aq Mt agc@NetBSD.org
9175a17f3cSagcwrote this manual page.
9275a17f3cSagcThe
9375a17f3cSagc.Nm
9475a17f3cSagcutility was contributed by Wasabi Systems, Inc.
95