sbin/iscontrol/iscontrol.8

   1 .\" Copyright (c) 2007-2008 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 February 22, 2007
  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 vd
  36 .Oo
  37 .Op Fl Ar file
  38 .Op Fl n Ar nickname
  39 .Oc
  40 .Op Fl t Ar target
  41 .Op Ar variable Ns = Ns Ar value
  42 .Sh DESCRIPTION
  43 Internet SCSI (iSCSI) is a network protocol standard, that allows the
  44 use of the SCSI protocol over TCP/IP networks,
  45 the
  46 .Nm
  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,
  50 it will print out the
  51 .Em target names
  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
  60 .It Fl v
  61 verbose mode.
  62 .It Fl d
  63 do a
  64 .Em discovery session
  65 and exit.
  66 .It Fl c Ar file
  67 a file containing configuration
  68 .Em key-options ,
  69 see
  70 .Xr iscsi.conf 5
  71 .It Fl n Ar nickname
  72 if
  73 .Sy -c file
  74 is specified, then search for the block named
  75 .Em nickname
  76 in that file, see
  77 .Xr iscsi.conf 5
  78 .It Fl t Ar target
  79 is the target's IP address or name
  80 .It Ar variable Ns = Ns Ar value
  81 see
  82 .Xr iscsi.conf 5
  83 for the complete list of variables/options and their
  84 possible values.
  85 .El
  86 .Sh EXAMPLES
  87 .Dl iscontrol -dt myiscsitarget
  88 .Pp
  89 will start a
  90 .Em discovery session
  91 with the target and
  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
  96 .Em full session
  97 certainly does.
  98 .sp
  99 .Dl iscontrol -c /etc/iscsi.conf -n myiscsi
 100 .Pp
 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.
 106 .Sh SEE ALSO
 107 .Xr da 4 ,
 108 .Xr iscsi_initiator 4 ,
 109 .Xr sa 4 ,
 110 .Xr iscsi.conf 5 ,
 111 .Xr camcontrol 8
 112 .Sh STANDARDS
 113 RFC 3720
 114 .\"Sh HISTORY
 115 .Sh BUGS
 116 .Nm
 117 should probably load the iscsi_initiator module if needed.
 118 .br
 119 Not all functions/specifications have been implemented yet, noticeably
 120 missing are the Task Management Functions.
 121 The error recovery, though not
 122 .Em fully compliant
 123 does a brave effort to recover from network disconnects.