sbin/iscontrol/iscontrol.8

   1 .\" Copyright (c) 2007-2010 Daniel Braniss <danny@cs.huji.ac.il>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd October 26, 2021
  28 .Dt ISCONTROL 8
  29 .Os
  30 .Sh NAME
  31 .Nm iscontrol
  32 .Nd login/negotiator/control for an iSCSI initiator session
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl dv
  36 .Oo
  37 .Fl c Ar file
  38 .Op Fl n Ar nickname
  39 .Oc
  40 .Op Fl p Ar pidfile
  41 .Op Fl t Ar target
  42 .Op Ar variable Ns = Ns Ar value
  43 .Sh DESCRIPTION
  44 .Bf -symbolic
  45 This command, along with its kernel counterpart
  46 .Xr iscsi_initiator 4 ,
  47 is obsolete and is not present in
  48 .Fx 14
  49 and above.
  50 Users are advised to use
  51 .Xr iscsictl 8
  52 instead.
  53 .Ef
  54 .Pp
  55 Internet SCSI (iSCSI) is a network protocol standard, that allows the
  56 use of the SCSI protocol over TCP/IP networks,
  57 the
  58 .Nm
  59 program is the userland side of an iSCSI session, see
  60 .Xr iscsi_initiator 4 .
  61 It has 2 modes of operation, if -d (discovery session) is specified,
  62 it will print out the
  63 .Em target names
  64 returned by the target and exit.
  65 In the second mode, it will, after a successful login/negotiation, run
  66 in daemon mode, monitoring the connection, and will try to reconnect
  67 in case of a network/target failure.
  68 It will terminate/logout the session
  69 when a SIGHUP signal is received.
  70 The flags are as follows:
  71 .Bl -tag -width variable=value
  72 .It Fl c Ar file
  73 a file containing configuration
  74 .Em key-options ,
  75 see
  76 .Xr iscsi.conf 5 .
  77 .It Fl d
  78 do a
  79 .Em discovery session
  80 and exit.
  81 .It Fl n Ar nickname
  82 if
  83 .Sy -c file
  84 is specified, then search for the block named
  85 .Em nickname
  86 in that file, see
  87 .Xr iscsi.conf 5 .
  88 .It Fl p Ar pidfile
  89 will write the process ID of the session to the specified
  90 .Em pidfile
  91 .It Fl t Ar target
  92 the target's IP address or name.
  93 .It Fl v
  94 verbose mode.
  95 .It Ar variable Ns = Ns Ar value
  96 see
  97 .Xr iscsi.conf 5
  98 for the complete list of variables/options and their
  99 possible values.
 100 .El
 101 .Sh EXAMPLES
 102 .Dl iscontrol -dt myiscsitarget
 103 .Pp
 104 will start a
 105 .Em discovery session
 106 with the target and
 107 print to stdout the list of available targetnames/targetadresses.
 108 Note: this listing does not necessarily mean availability, since
 109 depending on the target configuration, a discovery session might
 110 not need login/access permission, but a
 111 .Em full session
 112 certainly does.
 113 .sp
 114 .Dl iscontrol -c /etc/iscsi.conf -n myiscsi
 115 .Pp
 116 will read options from
 117 .Pa /etc/iscsi.conf ,
 118 use the targetaddress
 119 found in the block nicknamed myiscsi, login and negotiate
 120 whatever options are specified, and start an iscsi-session.
 121 .Sh SEE ALSO
 122 .Xr da 4 ,
 123 .Xr iscsi_initiator 4 ,
 124 .Xr sa 4 ,
 125 .Xr iscsi.conf 5 ,
 126 .Xr camcontrol 8 ,
 127 .Xr iscsictl 8
 128 .Sh STANDARDS
 129 RFC 3720
 130 .Sh HISTORY
 131 The
 132 .Nm
 133 utility appeared in
 134 .Fx 7.0 .
 135 .Sh BUGS
 136 .Nm
 137 should probably load the iscsi_initiator module if needed.
 138 .br
 139 Not all functions/specifications have been implemented yet, noticeably
 140 missing are the Task Management Functions.
 141 The error recovery, though not
 142 .Em fully compliant
 143 does a brave effort to recover from network disconnects.