1 .\" Copyright (c) 2007-2008 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
25 .\" $FreeBSD: src/sbin/iscontrol/iscontrol.8,v 1.3 2008/11/25 07:17:11 scottl Exp $
27 .Dd September 04, 2009
32 .Nd login/negotiator/control for an iSCSI initiator session
41 .Op Ar variable Ns = Ns Ar value
43 Internet SCSI (iSCSI) is a network protocol standard, that allows the
44 use of the SCSI protocol over TCP/IP networks,
47 program is the userland side of an iSCSI session, see
48 .Xr iscsi_initiator 4 .
49 It has 2 modes of operation, if -d (discovery session) is specified,
52 returned by the target and exit.
53 In the second mode, it will, after a successful login/negotiation, run
54 in daemon mode, monitoring the connection, and will try to reconnect
55 in case of a network/target failure.
56 It will terminate/logout the session
57 when a SIGHUP signal is received.
58 The flags are as follows:
59 .Bl -tag -width variable=value
67 a file containing configuration
74 is specified, then search for the block named
79 is the target's IP address or name
80 .It Ar variable Ns = Ns Ar value
83 for the complete list of variables/options and their
87 .Dl iscontrol -dt myiscsitarget
92 print to stdout the list of available targetnames/targetadresses.
93 Note: this listing does not necessarily mean availability, since
94 depending on the target configuration, a discovery session might
95 not need login/access permission, but a
99 .Dl iscontrol -c /etc/iscsi.conf -n myiscsi
101 will read options from
102 .Pa /etc/iscsi.conf ,
103 use the targetaddress
104 found in the block nicknamed myiscsi, login and negotiate
105 whatever options are specified, and start an iscsi-session.
108 .Xr iscsi_initiator 4 ,
116 Not all functions/specifications have been implemented yet, noticeably
117 missing are the Task Management Functions.
118 The error recovery, though not
120 does a brave effort to recover from network disconnects.