1 .\" Copyright (c) 2007-2010 Daniel Braniss <danny@cs.huji.ac.il>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd key options to be negotiated in an iSCSI session
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
51 } # this must be on a line by itself.
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
59 currently only supported authentication method is CHAP, with
60 digest either MD5 or SHA.
65 is calculated on the header of all iSCSI PDUs, and
67 Only CRC32C is implemented.
70 same as for HeaderDigest, but on the data part of the iSCSI PDU.
73 is the number of simultaneous connections per session,
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
79 .Em discovery session.
81 if not specified, defaults to
82 .Sy iqn.2005-01.il.ac.huji.cs:
84 .It Cm TargetAlias / InitiatorAlias
88 .Sy domainname[:port][,portal-group-tag]
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
95 Note: portal-group-tag is unused at the moment.
96 .It Cm TargetPortalGroupTag
97 .Em not implemented yet.
99 .Em not implemented yet.
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
116 can be overridden by the
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.
126 either Discovery or Normal, default is Normal, see the
132 The following are not specified in the
134 .Bl -tag -width sockbufsize
136 The iSCSI port used by the iSCSI protocol, defaults to 3260.
140 to the value specified.
142 overrides the compiled value of
145 .Xr iscsi_initiator 4 .
146 This value can only be reduced.
148 sets the receiver and transmitter socket buffer size to
158 then the following must also be set:
159 .Bl -tag -width chapSecret
163 Can be either an ASCII string (e.g. hello world), a hex string (e.g
164 0xababcd0987654321...), or base64 string (eg 0b...)
166 the chap-name, defaults to
170 .It Cm tgtChapSecret/tgtChapName
173 counterpart, but to authenticate the target.
185 targetaddress = iscsi1
186 targetname = iqn.1900.com.com:sn.123456
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
198 The parsing is very primitive, so do not expect - at the moment - any
201 .Xr iscsi_initiator 4 ,
208 Some options have not been implemented, either they were found
209 to be unnecessary, or not understood, this can change in the future.
211 The tags opening value is difficult to calculate, use wisely.