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
36 configuration file is used by the
41 The general syntax is:
56 .Bl -tag -width MaxConnections
58 Sets the authentication type.
73 Login for CHAP authentication.
75 Secret for CHAP authentication.
77 Target login for Mutual CHAP authentication.
79 Target secret for Mutual CHAP authentication.
81 Sets the header digest; a checksum calculated over the header of iSCSI
82 PDUs, and verified on receive.
90 Sets the data digest; a checksum calculated over the Data Section of iSCSI
91 PDUs, and verified on receive.
99 Sets the initiator name.
100 By default, the name is concatenation of
101 .Qq Ar iqn.1994-09.org.freebsd:
104 Sets the target name.
105 Not required for discovery sessions.
107 Sets the target address and port, in
112 can be either an IP address, or hostname.
113 The optional port defaults to 3260.
115 Sets the session type.
122 For normal sessions, the
125 Discovery sessions result in the initiator connecting to all the targets
126 returned by SendTargets iSCSI discovery with the defined
129 Enable or disable the session.
137 Name of selected iSCSI hardware offload driver.
141 Name of selected protocol.
144 for iSCSI over RDMA, or
149 The DiffServ Codepoint used for sending data.
150 The DSCP can be set to numeric, or hexadecimal values directly,
151 as well as the well-defined
156 Default is no specified dscp codepoint, which means the default
157 of the outgoing interface is used.
159 The 802.1Q Priority CodePoint used for sending packets.
160 The PCP can be set to a value in the range between
164 When omitted, the default for the outgoing interface is used.
167 .Bl -tag -width indent
168 .It Pa /etc/iscsi.conf
173 targetaddress = iscsi1
174 targetname = iqn.1900.com.com:sn.123456
177 myiscsi6 { # nickname
178 targetaddress = [2001:db8::de:ef]:3260
179 targetname = iqn.1900.com.com:sn.123456
183 targetaddress = 10.0.0.1;
184 targetname = iqn.1900.com.com:sn.123456;
185 initiatorname = iqn.2005-01.il.ac.huji.cs:nobody;
187 chapiname = iqn.2005-01.il.ac.huji.cs:nobody;
188 chapsecret = "secretsecret";