usr.bin/iscsictl/iscsictl.8

   1 .\" Copyright (c) 2012 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
   5 .\" from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd April 24, 2014
  31 .Dt ISCSICTL 8
  32 .Os
  33 .Sh NAME
  34 .Nm iscsictl
  35 .Nd iSCSI initiator management utility
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Fl A
  39 .Fl p Ar portal Fl t Ar target Op Fl u Ar user Fl s Ar secret
  40 .Nm
  41 .Fl A
  42 .Fl d Ar discovery-host Op Fl u Ar user Fl s Ar secret
  43 .Nm
  44 .Fl A
  45 .Fl a Op Fl c Ar path
  46 .Nm
  47 .Fl A
  48 .Fl n Ar nickname Op Fl c Ar path
  49 .Nm
  50 .Fl R
  51 .Op Fl p Ar portal
  52 .Op Fl t Ar target
  53 .Nm
  54 .Fl R
  55 .Fl a
  56 .Nm
  57 .Fl R
  58 .Fl n Ar nickname Op Fl c Ar path
  59 .Nm
  60 .Fl L
  61 .Op Fl v
  62 .Sh DESCRIPTION
  63 The
  64 .Nm
  65 utility is used to configure the iSCSI initiator.
  66 .Pp
  67 The following options are available:
  68 .Bl -tag -width ".Fl A"
  69 .It Fl A
  70 Add session.
  71 .It Fl R
  72 Remove session.
  73 .It Fl L
  74 List sessions.
  75 .It Fl a
  76 When adding, add all sessions defined in the configuration file.
  77 When removing, remove all currently established sessions.
  78 .It Fl c
  79 Path to the configuration file.
  80 The default is
  81 .Pa /etc/iscsi.conf .
  82 .It Fl d
  83 Target host name or address used for SendTargets discovery.
  84 When used, it will add a temporary discovery session.
  85 After discovery is done, sessions will be added for each discovered target,
  86 and the temporary discovery session will be removed.
  87 .It Fl n
  88 The "nickname" of session defined in the configuration file.
  89 .It Fl p
  90 Target portal - host name or address - for statically defined targets.
  91 .It Fl s
  92 CHAP secret.
  93 .It Fl t
  94 Target name.
  95 .It Fl u
  96 CHAP login.
  97 .It Fl v
  98 Verbose mode.
  99 .El
 100 .Pp
 101 Certain parameters are necessary when adding a session.
 102 One can specify these either via command line (using the
 103 .Fl t ,
 104 .Fl p ,
 105 .Fl u ,
 106 and
 107 .Fl s
 108 options), or configuration file (using the
 109 .Fl a
 110 or
 111 .Fl n
 112 options).
 113 Some functionality - for example mutual CHAP - is available only
 114 via configuration file.
 115 .Pp
 116 Since connecting to the target is performed in background, non-zero
 117 exit status does not mean that the session was successfully established.
 118 Use
 119 .Nm Fl L
 120 to check the connection status.
 121 .Pp
 122 Note that in order for the iSCSI initiator to be able to connect to a target,
 123 the
 124 .Xr iscsid 8
 125 daemon must be running.
 126 .Pp
 127 Also note that
 128 .Fx
 129 currently supports two different initiators: the old one,
 130 .Xr iscsi_initiator 4 ,
 131 with its control utility
 132 .Xr iscontrol 8 ,
 133 and the new one,
 134 .Xr iscsi 4 ,
 135 with
 136 .Nm
 137 and
 138 .Xr iscsid 8 .
 139 The only thing the two have in common is the configuration file,
 140 .Xr iscsi.conf 5 .
 141 .Sh FILES
 142 .Bl -tag -width ".Pa /etc/iscsi.conf" -compact
 143 .It Pa /etc/iscsi.conf
 144 iSCSI initiator configuration file.
 145 .El
 146 .Sh EXIT STATUS
 147 The
 148 .Nm
 149 utility exits 0 on success, and >0 if an error occurs.
 150 .Sh EXAMPLES
 151 Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1:
 152 .Dl Nm Fl A Fl t Ar iqn.2012-06.com.example:target0 Fl p Ar 192.168.1.1
 153 .Pp
 154 Disconnect all iSCSI sessions:
 155 .Dl Nm Fl Ra
 156 .Sh SEE ALSO
 157 .Xr iscsi.conf 5 ,
 158 .Xr iscsid 8
 159 .Sh HISTORY
 160 The
 161 .Nm
 162 command appeared in
 163 .Fx 10.0 .
 164 .Sh AUTHORS
 165 The
 166 .Nm
 167 was developed by
 168 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
 169 under sponsorship from the FreeBSD Foundation.