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 May 6, 2016 28.Dt ISCSI.CONF 5 29.Os 30.Sh NAME 31.Nm iscsi.conf 32.Nd iSCSI initiator configuration file 33.Sh DESCRIPTION 34The 35.Nm 36configuration file is used by the 37.Xr iscsictl 8 38and 39.Xr iscontrol 8 40utilities. 41The general syntax is: 42.Bf Li 43.Bd -literal 44 # this is a comment 45 nickname_1 { 46 variable = value; 47 ... 48 } 49 nickname_2 { 50 variable = value; 51 ... 52 } 53 ... 54.Ed 55.Ef 56.Bl -tag -width MaxConnections 57.It Cm AuthMethod 58Sets the authentication type. 59Type can be either 60.Qq Ar None , 61or 62.Qq Ar CHAP . 63Default is 64.Qq Ar None . 65When set to 66.Cm CHAP , 67both 68.Cm chapIName 69and 70.Cm chapSecret 71must be defined. 72.It Cm chapIName 73Login for CHAP authentication. 74.It Cm chapSecret 75Secret for CHAP authentication. 76.It Cm tgtChapName 77Target login for Mutual CHAP authentication. 78.It Cm tgtChapSecret 79Target secret for Mutual CHAP authentication. 80.It Cm HeaderDigest 81Sets the header digest; a checksum calculated over the header of iSCSI 82PDUs, and verified on receive. 83Digest can be either 84.Qq Ar None , 85or 86.Qq Ar CRC32C . 87Default is 88.Qq Ar None . 89.It Cm DataDigest 90Sets the data digest; a checksum calculated over the Data Section of iSCSI 91PDUs, and verified on receive. 92Digest can be either 93.Qq Ar None , 94or 95.Qq Ar CRC32C . 96Default is 97.Qq Ar None . 98.It Cm InitiatorName 99Sets the initiator name. 100By default, the name is concatenation of 101.Qq Ar iqn.1994-09.org.freebsd: 102with the hostname. 103.It Cm TargetName 104Sets the target name. 105Not required for discovery sessions. 106.It Cm TargetAddress 107Sets the target address and port, in 108.Sy address[:port] 109format. 110The 111.Sy address 112can be either an IP address, or hostname. 113The optional port defaults to 3260. 114.It Cm SessionType 115Sets the session type. 116Type can be either 117.Qq Ar Discovery , 118or 119.Qq Ar Normal . 120Default is 121.Qq Ar Normal . 122For normal sessions, the 123.Sy TargetName 124must be defined. 125Discovery sessions result in the initiator connecting to all the targets 126returned by SendTargets iSCSI discovery with the defined 127.Sy TargetAddress . 128.It Cm Enable 129Enable or disable the session. 130State can be either 131.Qq Ar On , 132or 133.Qq Ar Off . 134Default is 135.Qq Ar On . 136.It Cm Offload 137Name of selected iSCSI hardware offload driver. 138Default is 139.Qq Ar None . 140.It Cm Protocol 141Name of selected protocol. 142It can be either 143.Qq Ar iSER , 144for iSCSI over RDMA, or 145.Qq Ar iSCSI . 146Default is 147.Qq Ar iSCSI . 148.It Cm dscp 149The DiffServ Codepoint used for sending data. 150The DSCP can be set to numeric, or hexadecimal values directly, 151as well as the well-defined 152.Qq Ar cs<n> 153and 154.Qq Ar af<xx> 155codepoints. 156Default is no specified dscp codepoint, which means the default 157of the outgoing interface is used. 158.It Cm pcp 159The 802.1Q Priority CodePoint used for sending packets. 160The PCP can be set to a value in the range between 161.Qq Ar 0 162to 163.Qq Ar 7 . 164When omitted, the default for the outgoing interface is used. 165.El 166.Sh FILES 167.Bl -tag -width indent 168.It Pa /etc/iscsi.conf 169.El 170.Sh EXAMPLES 171.Bd -literal 172myiscsi { # nickname 173 targetaddress = iscsi1 174 targetname = iqn.1900.com.com:sn.123456 175} 176 177myiscsi6 { # nickname 178 targetaddress = [2001:db8::de:ef]:3260 179 targetname = iqn.1900.com.com:sn.123456 180} 181 182chaptest { 183 targetaddress = 10.0.0.1; 184 targetname = iqn.1900.com.com:sn.123456; 185 initiatorname = iqn.2005-01.il.ac.huji.cs:nobody; 186 authmethod = CHAP; 187 chapiname = iqn.2005-01.il.ac.huji.cs:nobody; 188 chapsecret = "secretsecret"; 189} 190.Ed 191.Sh SEE ALSO 192.Xr iscontrol 8 , 193.Xr iscsictl 8 194.\"Sh HISTORY 195.\"Sh AUTHORS 196