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 December 30, 2013
  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 sesion 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 t
  92 Target name.
  93 .It Fl v
  94 Verbose mode.
  95 .El
  96 .Pp
  97 Since connecting to the target is performed in background, non-zero
  98 exit status does not mean that the session was successfully established.
  99 Use
 100 .Nm Fl L
 101 to check the connection status.
 102 .Pp
 103 Note that in order to the iSCSI initiator to be able to connect to a target,
 104 the
 105 .Xr iscsid 8
 106 daemon must be running.
 107 .Pp
 108 Also note that
 109 .Fx
 110 currently supports two different initiators: the old one,
 111 .Xr iscsi_initiator 4 ,
 112 with its control utility
 113 .Xr iscontrol 8 ,
 114 and the new one,
 115 .Xr iscsi 4 ,
 116 with
 117 .Nm
 118 and
 119 .Xr iscsid 8 .
 120 The only thing the two have in common is the configuration file,
 121 .Xr iscsi.conf 5 .
 122 .Sh FILES
 123 .Bl -tag -width ".Pa /etc/iscsi.conf" -compact
 124 .It Pa /etc/iscsi.conf
 125 iSCSI initiator configuration file.
 126 .El
 127 .Sh EXIT STATUS
 128 The
 129 .Nm
 130 utility exits 0 on success, and >0 if an error occurs.
 131 .Sh EXAMPLES
 132 Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1:
 133 .Dl Nm Fl A Fl t Ar iqn.2012-06.com.example:target0 Fl p Ar 192.168.1.1
 134 .Pp
 135 Disconnect all iSCSI sessions:
 136 .Dl Nm Fl Ra
 137 .Sh SEE ALSO
 138 .Xr iscsi.conf 5 ,
 139 .Xr iscsid 8
 140 .Sh HISTORY
 141 The
 142 .Nm
 143 command appeared in
 144 .Fx 10.0 .
 145 .Sh AUTHORS
 146 The
 147 .Nm
 148 was developed by
 149 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
 150 under sponsorship from the FreeBSD Foundation.