All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD$
.Dd October 10, 2013 .Dt ISCSI.CONF 5 .Os .Sh NAME .Nm iscsi.conf .Nd iSCSI initiator configuration file .Sh DESCRIPTION The file .Nm , is used by the .Xr iscsictl 8 and .Xr iscontrol 8 utilities. It contains declarations and parameter/key-options. The syntax is very simple, .D1 Li variable = value; and they can be grouped via a .Em block declaration: f Li d -literal # this is a comment target_1 { # nickname variable = value; ... } # this must be on a line by itself. .Ed .Ef
p
The following are specified in the iSCSI RFC 3720,
for a full description see sections 11/12 of the RFC.
l -tag -width MaxConnections t Cm AuthMethod currently only supported authentication method is CHAP, with
digest either MD5 or SHA.
Default is none.
t Cm HeaderDigest a
.Em digest
is calculated on the header of all iSCSI PDUs, and
checked.
Only CRC32C is implemented.
Default is none.
t Cm DataDigest same as for HeaderDigest, but on the data part of the iSCSI PDU.
(not yet tested)
t Cm TargetName is the name by which the target is known, not to be confused with
target address, either obtained via the target administrator, or
from a
.Em discovery session .
t Cm InitiatorName if not specified, defaults to
.Sy iqn.2005-01.il.ac.huji.cs:
.Aq hostname .
t Cm TargetAddress is of the form
.Sy domainname[:port][,portal-group-tag]
to quote the RFC:
d -ragged -compact The domainname can be specified as either a DNS host name, a
dotted-decimal IPv4 address, or a bracketed IPv6 address as specified
in [RFC2732].
.Ed
Note: portal-group-tag is unused at the moment.
.Em not implemented yet.
t Cm MaxRecvDataSegmentLength the maximum data segment length in
bytes it can receive in an iSCSI PDU, default is 8192.
t Cm MaxOutstandingR2T is used to calculate/negotiate the
.Em tag opening ,
can be overridden by the
.Sy tag
option.
t Cm SessionType either Discovery or Normal, default is Normal, see the
.Fl d
flag of
.Cm iscontrol .
.El
The following are not specified in the
.Sy RFC 3720
l -tag -width sockbufsize t Cm port The iSCSI port used by the iSCSI protocol, defaults to 3260.
t Cm tags Sets the
.Em tag opening
to the value specified.
t Cm maxluns overrides the compiled value of
.Sy luns ,
see
.Xr iscsi_initiator 4 .
This value can only be reduced.
t Cm sockbufsize sets the receiver and transmitter socket buffer size to
.Em size ,
in kilobytes.
The default is 128.
.El
If
.Em AuthMethod
is set to
.Cm CHAP ,
then the following must also be set:
l -tag -width chapSecret t Cm chapSecret this
.Em shared-secret .
Can be either an ASCII string (e.g. hello world), a hex string (e.g
0xababcd0987654321...), or base64 string (eg 0b...)
t Cm chapIName the chap-name, defaults to
.Em hostname .
t Cm chapDigest can be MD5 or SHA1.
t Cm tgtChapSecret/tgtChapName same as the none
.Em tgt
counterpart, but to authenticate the target.
.El
.Sh FILES
l -tag -width indent t Pa /etc/iscsi.conf .El
.Sh EXAMPLES
d -literal #
# Globals
#
port = 3260
#
myiscsi { # nickname
targetaddress = iscsi1
targetname = iqn.1900.com.com:sn.123456
}
chaptest {
targetaddress= 10.0.0.1;
targetname = iqn.1900.com.com:sn.123456
initiatorname= iqn.2005-01.il.ac.huji.cs:nobody
authmethod = CHAP; chapDigest = SHA1;
chapsecret = 0x3713c3336d9a224c2791c873d3d2b174
tags = 256
}
.Ed
.Sh SEE ALSO
.Xr iscsi_initiator 4 ,
.Xr iscsictl 8 ,
.Xr iscontrol 8
.Sh STANDARDS
ISCSI RFC 3720
Sh HISTORY
Sh AUTHORS
.Sh BUGS
Some options have not been implemented, either they were found
to be unnecessary, or not understood, this can change in the future.
The tags opening value is difficult to calculate, use wisely.