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 iSCSI initiator configuration file
41 It contains declarations and parameter/key-options.
42 The syntax is very simple,
43 .D1 Li variable = value;
44 and they can be grouped via a
53 } # this must be on a line by itself.
57 The following are specified in the iSCSI RFC 3720,
58 for a full description see sections 11/12 of the RFC.
59 .Bl -tag -width MaxConnections
61 currently only supported authentication method is CHAP, with
62 digest either MD5 or SHA.
67 is calculated on the header of all iSCSI PDUs, and
69 Only CRC32C is implemented.
72 same as for HeaderDigest, but on the data part of the iSCSI PDU.
75 is the name by which the target is known, not to be confused with
76 target address, either obtained via the target administrator, or
78 .Em discovery session .
80 if not specified, defaults to
81 .Sy iqn.2005-01.il.ac.huji.cs:
85 .Sy domainname[:port][,portal-group-tag]
88 The domainname can be specified as either a DNS host name, a
89 dotted-decimal IPv4 address, or a bracketed IPv6 address as specified
92 Note: portal-group-tag is unused at the moment.
93 .Em not implemented yet.
94 .It Cm MaxRecvDataSegmentLength
95 the maximum data segment length in
96 bytes it can receive in an iSCSI PDU, default is 8192.
97 .It Cm MaxOutstandingR2T
98 is used to calculate/negotiate the
100 can be overridden by the
104 either Discovery or Normal, default is Normal, see the
110 The following are not specified in the
112 .Bl -tag -width sockbufsize
114 The iSCSI port used by the iSCSI protocol, defaults to 3260.
118 to the value specified.
120 overrides the compiled value of
123 .Xr iscsi_initiator 4 .
124 This value can only be reduced.
126 sets the receiver and transmitter socket buffer size to
136 then the following must also be set:
137 .Bl -tag -width chapSecret
141 Can be either an ASCII string (e.g. hello world), a hex string (e.g
142 0xababcd0987654321...), or base64 string (eg 0b...)
144 the chap-name, defaults to
148 .It Cm tgtChapName/tgtChapSecret
149 name and secret used for mutual CHAP; by default, mutual CHAP
153 .Bl -tag -width indent
154 .It Pa /etc/iscsi.conf
164 targetaddress = iscsi1
165 targetname = iqn.1900.com.com:sn.123456
168 targetaddress= 10.0.0.1;
169 targetname = iqn.1900.com.com:sn.123456
170 initiatorname= iqn.2005-01.il.ac.huji.cs:nobody
171 authmethod = CHAP; chapDigest = SHA1;
172 chapsecret = 0x3713c3336d9a224c2791c873d3d2b174
177 .Xr iscsi_initiator 4 ,
185 Some options have not been implemented, either they were found
186 to be unnecessary, or not understood, this can change in the future.
188 The tags opening value is difficult to calculate, use wisely.