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: src/sbin/iscontrol/iscontrol.8,v 1.3 2008/11/25 07:17:11 scottl Exp $
  26 .\"
  27 .Dd September 23, 2009
  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 .Op Fl c Ar file
  37 .Op Fl n Ar nickname
  38 .Op Fl t Ar target
  39 .Op Ar variable Ns = Ns Ar value ...
  40 .Sh DESCRIPTION
  41 Internet SCSI (iSCSI) is a network protocol standard, that allows the
  42 use of the SCSI protocol over TCP/IP networks, the
  43 .Nm
  44 program is the userland side of an iSCSI session, see
  45 .Xr iscsi_initiator 4 .
  46 It has two modes of operation, if
  47 .Fl d
  48 (discovery session) is specified,
  49 it will print out the
  50 .Em target names
  51 returned by the target and exit.
  52 In the second mode, it will, after a successful login/negotiation, run
  53 in daemon mode, monitoring the connection, and will try to reconnect
  54 in case of a network/target failure.
  55 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 c Ar file
  60 a file containing configuration
  61 .Em key-options ,
  62 see
  63 .Xr iscsi.conf 5 .
  64 Default is
  65 .Pa /etc/iscsi.conf
  66 .It Fl d
  67 do a
  68 .Em discovery session
  69 and exit.
  70 .It Fl n Ar nickname
  71 search for the block named
  72 .Ar nickname
  73 in the configuration file
  74 .Fl ( c ) ,
  75 see
  76 .Xr iscsi.conf 5 .
  77 .It Fl t Ar target
  78 is the target's IP address or name.
  79 .It Fl v
  80 verbose mode.
  81 .It Ar variable Ns = Ns Ar value
  82 see
  83 .Xr iscsi.conf 5
  84 for the complete list of variables/options and their
  85 possible values.
  86 .El
  87 .Sh FILES
  88 .Bl -tag -width /etc/iscsi.conf -compact
  89 .It Pa /etc/iscsi.conf
  90 default configuration file
  91 .El
  92 .Sh EXAMPLES
  93 .Dl iscontrol -dt myiscsitarget
  94 .Pp
  95 will start a
  96 .Em discovery session
  97 with the target and
  98 print to stdout the list of available targetnames/targetadresses.
  99 Note: this listing does not necessarily mean availability, since
 100 depending on the target configuration, a discovery session might
 101 not need login/access permission, but a
 102 .Em full session
 103 certainly does.
 104 .Pp
 105 .Dl iscontrol -c myiscsi.conf -n myiscsi
 106 .Pp
 107 will read options from
 108 .Pa myiscsi.conf ,
 109 use the targetaddress
 110 found in the block nicknamed myiscsi, login and negotiate
 111 whatever options are specified, and start an iscsi-session.
 112 .Sh SEE ALSO
 113 .Xr da 4 ,
 114 .Xr iscsi_initiator 4 ,
 115 .Xr sa 4 ,
 116 .Xr iscsi.conf 5 ,
 117 .Xr camcontrol 8
 118 .Sh STANDARDS
 119 RFC 3720
 120 .\"Sh HISTORY
 121 .Sh BUGS
 122 Not all functions/specifications have been implemented yet, noticeably
 123 missing are the Task Management Functions.
 124 The error recovery, though not
 125 .Em fully compliant
 126 does a brave effort to recover from network disconnects.