sbin/iscontrol/iscsi.conf.5

   1 .\" Copyright (c) 2007-2010 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 June 5, 2007
  28 .Dt ISCSI.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm iscsi.conf
  32 .Nd key options to be negotiated in an iSCSI session
  33 .Sh DESCRIPTION
  34 The file
  35 .Nm ,
  36 is read by the
  37 .Xr iscontrol 8
  38 program.
  39 It contains declarations and parameter/key-options.
  40 The syntax is very simple,
  41 .D1 Li variable = value;
  42 and they can be grouped via a
  43 .Em block
  44 declaration:
  45 .Bf Li
  46 .Bd -literal
  47         # this is a comment
  48         target_1 { # nickname
  49            variable = value;
  50            ...
  51         } # this must be on a line by itself.
  52 .Ed
  53 .Ef
  54 .Pp
  55 The following are specified in the iSCSI RFC 3720,
  56 for a full description see sections 11/12 of the RFC.
  57 .Bl -tag -width MaxConnections
  58 .It Cm AuthMethod
  59 currently only supported authentication method is CHAP, with
  60 digest either MD5 or SHA.
  61 Default is none.
  62 .It Cm HeaderDigest
  63 a
  64 .Em digest
  65 is calculated on the header of all iSCSI PDUs, and
  66 checked.
  67 Only CRC32C is implemented.
  68 Default is none.
  69 .It Cm DataDigest
  70 same as for HeaderDigest, but on the data part of the iSCSI PDU.
  71 (not yet tested)
  72 .It Cm MaxConnections
  73 is the number of simultaneous connections per session,
  74 currently only 1.
  75 .It Cm TargetName
  76 is the name by which the target is known, not to be confused with
  77 target address, either obtained via the target administrator, or
  78 from a
  79 .Em discovery session .
  80 .It Cm InitiatorName
  81 if not specified, defaults to
  82 .Sy iqn.2005-01.il.ac.huji.cs:
  83 .Aq hostname .
  84 .It Cm TargetAlias / InitiatorAlias
  85 not implemented.
  86 .It Cm TargetAddress
  87 is of the form
  88 .Sy domainname[:port][,portal-group-tag]
  89 to quote the RFC:
  90 .Bd -ragged -compact
  91 The domainname can be specified as either a DNS host name, a
  92 dotted-decimal IPv4 address, or a bracketed IPv6 address as specified
  93 in [RFC2732].
  94 .Ed
  95 Note: portal-group-tag is unused at the moment.
  96 .It Cm TargetPortalGroupTag
  97 .Em not implemented yet.
  98 .It Cm InitialR2T
  99 .Em not implemented yet.
 100 .It Cm ImmediateData
 101 .Em not implemented yet.
 102 .It Cm MaxRecvDataSegmentLength
 103 the maximum data segment length in
 104 bytes it can receive in an iSCSI PDU, default is 8192.
 105 .It Cm MaxBurstLength
 106 .Em not implemented yet.
 107 .It Cm FirstBurstLength
 108 .Em not implemented yet.
 109 .It Cm DefaultTime2Wait
 110 .Em not implemented yet.
 111 .It Cm DefaultTime2Retain
 112 .Em not implemented yet.
 113 .It Cm MaxOutstandingR2T
 114 is used to calculate/negotiate the
 115 .Em tag opening ,
 116 can be overridden by the
 117 .Sy tag
 118 option.
 119 .It Cm DataPDUInOrder
 120 .Em not implemented yet.
 121 .It Cm DataSequenceInOrder
 122 .Em not implemented yet.
 123 .It Cm ErrorRecoveryLevel
 124 Only level 0 is supported.
 125 .It Cm SessionType
 126 either Discovery or Normal, default is Normal, see the
 127 .Fl d
 128 flag of
 129 .Cm iscontrol .
 130 .El
 131 .sp
 132 The following are not specified in the
 133 .Sy RFC 3720
 134 .Bl -tag -width sockbufsize
 135 .It Cm port
 136 The iSCSI port used by the iSCSI protocol, defaults to 3260.
 137 .It Cm tags
 138 Sets the
 139 .Em tag opening
 140 to the value specified.
 141 .It Cm maxluns
 142 overrides the compiled value of
 143 .Sy luns ,
 144 see
 145 .Xr iscsi_initiator 4 .
 146 This value can only be reduced.
 147 .It Cm sockbufsize
 148 sets the receiver and transmitter socket buffer size to
 149 .Em size ,
 150 in kilobytes.
 151 The default is 128.
 152 .El
 153 .sp
 154 If
 155 .Em AuthMethod
 156 is set to
 157 .Cm CHAP ,
 158 then the following must also be set:
 159 .Bl -tag -width chapSecret
 160 .It Cm chapSecret
 161 this
 162 .Em shared-secret .
 163 Can be either an ASCII string (e.g. hello world), a hex string (e.g
 164 0xababcd0987654321...), or base64 string (eg 0b...)
 165 .It Cm chapIName
 166 the chap-name, defaults to
 167 .Em hostname .
 168 .It Cm chapDigest
 169 can be MD5 or SHA1.
 170 .It Cm tgtChapSecret/tgtChapName
 171 same as the none
 172 .Em tgt
 173 counterpart, but to authenticate the target.
 174 .El
 175 .Sh FILES
 176 .Pa /etc/iscsi.conf
 177 .Sh EXAMPLES
 178 .Bd -literal
 179 #
 180 # Globals
 181 #
 182 port = 3260
 183 #
 184 myiscsi { # nickname
 185    targetaddress        = iscsi1
 186    targetname           = iqn.1900.com.com:sn.123456
 187 }
 188 chaptest {
 189    targetaddress= 10.0.0.1;
 190    targetname   = iqn.1900.com.com:sn.123456
 191    initiatorname= iqn.2005-01.il.ac.huji.cs:nobody
 192    authmethod = CHAP; chapDigest = SHA1;
 193    chapsecret = 0x3713c3336d9a224c2791c873d3d2b174
 194    tags         = 256
 195 }
 196 .Ed
 197 .Sh ERRORS
 198 The parsing is very primitive, so do not expect - at the moment - any
 199 error messages.
 200 .Sh SEE ALSO
 201 .Xr iscsi_initiator 4 ,
 202 .Xr iscontrol 8
 203 .Sh STANDARDS
 204 ISCSI RFC 3720
 205 .\"Sh HISTORY
 206 .\"Sh AUTHORS
 207 .Sh BUGS
 208 Some options have not been implemented, either they were found
 209 to be unnecessary, or not understood, this can change in the future.
 210 .br
 211 The tags opening value is difficult to calculate, use wisely.