1 .\" Copyright (c) 2007-2010 Daniel Braniss <danny@cs.huji.ac.il>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd login/negotiator/control for an iSCSI initiator session
42 .Op Ar variable Ns = Ns Ar value
44 Internet SCSI (iSCSI) is a network protocol standard, that allows the
45 use of the SCSI protocol over TCP/IP networks,
48 program is the userland side of an iSCSI session, see
49 .Xr iscsi_initiator 4 .
50 It has 2 modes of operation, if -d (discovery session) is specified,
53 returned by the target and exit.
54 In the second mode, it will, after a successful login/negotiation, run
55 in daemon mode, monitoring the connection, and will try to reconnect
56 in case of a network/target failure.
57 It will terminate/logout the session
58 when a SIGHUP signal is received.
59 The flags are as follows:
60 .Bl -tag -width variable=value
62 a file containing configuration
73 is specified, then search for the block named
78 will write the process ID of the session to the specified
81 the target's IP address or name.
84 .It Ar variable Ns = Ns Ar value
87 for the complete list of variables/options and their
91 .Dl iscontrol -dt myiscsitarget
96 print to stdout the list of available targetnames/targetadresses.
97 Note: this listing does not necessarily mean availability, since
98 depending on the target configuration, a discovery session might
99 not need login/access permission, but a
103 .Dl iscontrol -c /etc/iscsi.conf -n myiscsi
105 will read options from
106 .Pa /etc/iscsi.conf ,
107 use the targetaddress
108 found in the block nicknamed myiscsi, login and negotiate
109 whatever options are specified, and start an iscsi-session.
112 .Xr iscsi_initiator 4 ,
121 should probably load the iscsi_initiator module if needed.
123 Not all functions/specifications have been implemented yet, noticeably
124 missing are the Task Management Functions.
125 The error recovery, though not
127 does a brave effort to recover from network disconnects.