sbin/iscontrol/iscontrol.8

   1 .\" Copyright (c) 2007 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 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 succesful login/negotiation, run
  54 in daemon mode, monitoring the connection, and will try to reconnect
  55 in case of a network/target failure. It will terminate/logout the session
  56 when a SIGHUP signal is received.
  57 The flags are as follows:
  58 .Bl -tag -width variable=value
  59 .It Fl v
  60 verbose mode.
  61 .It Fl d
  62 do a
  63 .Em discovery session
  64 and exit.
  65 .It Fl c Ar file
  66 a file containing configuration
  67 .Em key-options ,
  68 see iscsi.conf(5)
  69 .It Fl n Ar nickname
  70 if
  71 .Sy -c file
  72 is specified, then search for the block named
  73 .Em nickname
  74 in that file, see iscsi.conf(5)
  75 .It Fl t Ar target
  76 is the target's IP address or name
  77 .It Ar variable Ns = Ns Ar value
  78 see iscsi.conf(5) for the complete list of variables/options and their
  79 possible values.
  80 .El
  81 .Sh EXAMPLES
  82 .Dl iscontrol -dt myiscsitarget
  83 .Pp
  84 will start a
  85 .Em discovery session
  86 with the target and
  87 print to stdout the list of available targetnames/targetadresses.
  88 Note: this listing does not necessarily mean availability, since
  89 depending on the target configuration, a discovery session might
  90 not need login/access permition, but a
  91 .Em full session
  92 certainly does.
  93 .sp
  94 .Dl iscontrol -c /etc/iscsi.conf -n myiscsi
  95 .Pp
  96 will read options from file /etc/iscsi.conf, use the targetaddress
  97 found in the block nicknamed myiscsi, login and negotiate
  98 whatever options are specified, and start an iscsi-session.
  99 .Sh SEE ALSO
 100 .Xr iscsi_initiator 4 ,
 101 .Xr iscsi.conf 5 ,
 102 .Xr camcontrol 8 ,
 103 .Xr da 4 ,
 104 .Xr sa 4
 105 .Sh STANDARDS
 106 RFC 3720
 107 .\"Sh HISTORY
 108 .Sh BUGS
 109 .Nm
 110 should probably load the iscsi_initiator module if needed.
 111 .br
 112 Not all functions/specifications have been implemented yet, noticeably
 113 missing are the Task Management Funtions.
 114 The error recovery, though not
 115 .Em fully compliant
 116 does a brave effort to recover from network disconnects.