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 9, 2014
  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.
  48 Users are advised to use
  49 .Xr iscsictl 8
  50 instead.
  51 .Ef
  52 .Pp
  53 Internet SCSI (iSCSI) is a network protocol standard, that allows the
  54 use of the SCSI protocol over TCP/IP networks,
  55 the
  56 .Nm
  57 program is the userland side of an iSCSI session, see
  58 .Xr iscsi_initiator 4 .
  59 It has 2 modes of operation, if -d (discovery session) is specified,
  60 it will print out the
  61 .Em target names
  62 returned by the target and exit.
  63 In the second mode, it will, after a successful login/negotiation, run
  64 in daemon mode, monitoring the connection, and will try to reconnect
  65 in case of a network/target failure.
  66 It will terminate/logout the session
  67 when a SIGHUP signal is received.
  68 The flags are as follows:
  69 .Bl -tag -width variable=value
  70 .It Fl c Ar file
  71 a file containing configuration
  72 .Em key-options ,
  73 see
  74 .Xr iscsi.conf 5 .
  75 .It Fl d
  76 do a
  77 .Em discovery session
  78 and exit.
  79 .It Fl n Ar nickname
  80 if
  81 .Sy -c file
  82 is specified, then search for the block named
  83 .Em nickname
  84 in that file, see
  85 .Xr iscsi.conf 5 .
  86 .It Fl p Ar pidfile
  87 will write the process ID of the session to the specified
  88 .Em pidfile
  89 .It Fl t Ar target
  90 the target's IP address or name.
  91 .It Fl v
  92 verbose mode.
  93 .It Ar variable Ns = Ns Ar value
  94 see
  95 .Xr iscsi.conf 5
  96 for the complete list of variables/options and their
  97 possible values.
  98 .El
  99 .Sh EXAMPLES
 100 .Dl iscontrol -dt myiscsitarget
 101 .Pp
 102 will start a
 103 .Em discovery session
 104 with the target and
 105 print to stdout the list of available targetnames/targetadresses.
 106 Note: this listing does not necessarily mean availability, since
 107 depending on the target configuration, a discovery session might
 108 not need login/access permission, but a
 109 .Em full session
 110 certainly does.
 111 .sp
 112 .Dl iscontrol -c /etc/iscsi.conf -n myiscsi
 113 .Pp
 114 will read options from
 115 .Pa /etc/iscsi.conf ,
 116 use the targetaddress
 117 found in the block nicknamed myiscsi, login and negotiate
 118 whatever options are specified, and start an iscsi-session.
 119 .Sh SEE ALSO
 120 .Xr da 4 ,
 121 .Xr iscsi_initiator 4 ,
 122 .Xr sa 4 ,
 123 .Xr iscsi.conf 5 ,
 124 .Xr iscsictl 8 ,
 125 .Xr camcontrol 8
 126 .Sh STANDARDS
 127 RFC 3720
 128 .\"Sh HISTORY
 129 .Sh BUGS
 130 .Nm
 131 should probably load the iscsi_initiator module if needed.
 132 .br
 133 Not all functions/specifications have been implemented yet, noticeably
 134 missing are the Task Management Functions.
 135 The error recovery, though not
 136 .Em fully compliant
 137 does a brave effort to recover from network disconnects.