| iscsi.conf.5 (278232) | iscsi.conf.5 (280982) |
|---|---|
| 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. --- 8 unchanged lines hidden (view full) --- 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.\" | 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. --- 8 unchanged lines hidden (view full) --- 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: head/usr.bin/iscsictl/iscsi.conf.5 278232 2015-02-05 06:37:59Z trasz $ | 25.\" $FreeBSD: head/usr.bin/iscsictl/iscsi.conf.5 280982 2015-04-02 11:18:43Z trasz $ |
| 26.\" | 26.\" |
| 27.Dd February 4, 2015 | 27.Dd April 2, 2015 |
| 28.Dt ISCSI.CONF 5 29.Os 30.Sh NAME 31.Nm iscsi.conf 32.Nd iSCSI initiator configuration file 33.Sh DESCRIPTION | 28.Dt ISCSI.CONF 5 29.Os 30.Sh NAME 31.Nm iscsi.conf 32.Nd iSCSI initiator configuration file 33.Sh DESCRIPTION |
| 34The file 35.Nm , 36is used by the | 34The 35.Nm 36configuration file is used by the |
| 37.Xr iscsictl 8 38and 39.Xr iscontrol 8 40utilities. | 37.Xr iscsictl 8 38and 39.Xr iscontrol 8 40utilities. |
| 41It contains declarations and parameter/key-options. 42The syntax is very simple, 43.D1 Li variable = value; 44and they can be grouped via a 45.Em block 46declaration: | 41The general syntax is: |
| 47.Bf Li 48.Bd -literal 49 # this is a comment | 42.Bf Li 43.Bd -literal 44 # this is a comment |
| 50 target_1 { # nickname | 45 nickname_1 { |
| 51 variable = value; 52 ... | 46 variable = value; 47 ... |
| 53 } # this must be on a line by itself. | 48 } 49 nickname_2 { 50 variable = value; 51 ... 52 } 53 ... |
| 54.Ed 55.Ef | 54.Ed 55.Ef |
| 56.Pp 57The following are specified in the iSCSI RFC 3720, 58for a full description see sections 11/12 of the RFC. | |
| 59.Bl -tag -width MaxConnections 60.It Cm AuthMethod | 56.Bl -tag -width MaxConnections 57.It Cm AuthMethod |
| 61currently only supported authentication method is CHAP, with 62digest either MD5 or SHA. 63Default is none. | 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. |
| 64.It Cm HeaderDigest | 80.It Cm HeaderDigest |
| 65a 66.Em digest 67is calculated on the header of all iSCSI PDUs, and 68checked. 69Only CRC32C is implemented. 70Default is none. | 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 . |
| 71.It Cm DataDigest | 89.It Cm DataDigest |
| 72same as for HeaderDigest, but on the data part of the iSCSI PDU. 73(not yet tested) | 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 . |
| 74.It Cm TargetName | 98.It Cm TargetName |
| 75is the name by which the target is known, not to be confused with 76target address, either obtained via the target administrator, or 77from a 78.Em discovery session . | 99Sets the target name. 100Not required for discovery sessions. |
| 79.It Cm InitiatorName | 101.It Cm InitiatorName |
| 80if not specified, defaults to 81.Sy iqn.2005-01.il.ac.huji.cs: 82.Aq hostname . | 102Sets the initiator name. 103By default, the name is concatenation of 104.Qq Ar iqn.1994-09.org.freebsd: 105with the hostname. |
| 83.It Cm TargetAddress | 106.It Cm TargetAddress |
| 84is of the form 85.Sy domainname[:port][,portal-group-tag] 86to quote the RFC: 87.Bd -ragged -compact 88The domainname can be specified as either a DNS host name, a 89dotted-decimal IPv4 address, or a bracketed IPv6 address as specified 90in [RFC2732]. 91.Ed 92Note: portal-group-tag is unused at the moment. 93.Em not implemented yet. 94.It Cm MaxRecvDataSegmentLength 95the maximum data segment length in 96bytes it can receive in an iSCSI PDU, default is 8192. 97.It Cm MaxOutstandingR2T 98is used to calculate/negotiate the 99.Em tag opening , 100can be overridden by the 101.Sy tag 102option. | 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. |
| 103.It Cm SessionType | 114.It Cm SessionType |
| 104either Discovery or Normal, default is Normal, see the 105.Fl d 106flag of 107.Cm iscontrol . 108.El 109.sp 110The following are not specified in the 111.Sy RFC 3720 112.Bl -tag -width sockbufsize 113.It Cm offload | 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 Offload |
| 114Name of selected iSCSI hardware offload driver. | 129Name of selected iSCSI hardware offload driver. |
| 115.It Cm port 116The iSCSI port used by the iSCSI protocol, defaults to 3260. 117.It Cm tags 118Sets the 119.Em tag opening 120to the value specified. 121.It Cm maxluns 122overrides the compiled value of 123.Sy luns , 124see 125.Xr iscsi_initiator 4 . 126This value can only be reduced. 127.It Cm sockbufsize 128sets the receiver and transmitter socket buffer size to 129.Em size , 130in kilobytes. 131The default is 128. | 130Default is 131.Qq Ar None . |
| 132.El | 132.El |
| 133.sp 134If 135.Em AuthMethod 136is set to 137.Cm CHAP , 138then the following must also be set: 139.Bl -tag -width chapSecret 140.It Cm chapSecret 141this 142.Em shared-secret . 143Can be either an ASCII string (e.g. hello world), a hex string (e.g 1440xababcd0987654321...), or base64 string (eg 0b...) 145.It Cm chapIName 146the chap-name, defaults to 147.Em hostname . 148.It Cm chapDigest 149can be MD5 or SHA1. 150.It Cm tgtChapName/tgtChapSecret 151name and secret used for mutual CHAP; by default, mutual CHAP 152is not used. 153.El | |
| 154.Sh FILES 155.Bl -tag -width indent 156.It Pa /etc/iscsi.conf 157.El 158.Sh EXAMPLES 159.Bd -literal | 133.Sh FILES 134.Bl -tag -width indent 135.It Pa /etc/iscsi.conf 136.El 137.Sh EXAMPLES 138.Bd -literal |
| 160# 161# Globals 162# 163port = 3260 164# | |
| 165myiscsi { # nickname | 139myiscsi { # nickname |
| 166 targetaddress = iscsi1 167 targetname = iqn.1900.com.com:sn.123456 | 140 targetaddress = iscsi1 141 targetname = iqn.1900.com.com:sn.123456 |
| 168} 169chaptest { | 142} 143chaptest { |
| 170 targetaddress= 10.0.0.1; 171 targetname = iqn.1900.com.com:sn.123456 172 initiatorname= iqn.2005-01.il.ac.huji.cs:nobody 173 authmethod = CHAP; chapDigest = SHA1; 174 chapsecret = 0x3713c3336d9a224c2791c873d3d2b174 175 tags = 256 | 144 targetaddress = 10.0.0.1; 145 targetname = iqn.1900.com.com:sn.123456; 146 initiatorname = iqn.2005-01.il.ac.huji.cs:nobody; 147 authmethod = CHAP; 148 chapiname = iqn.2005-01.il.ac.huji.cs:nobody; 149 chapsecret = "secretsecret"; |
| 176} 177.Ed 178.Sh SEE ALSO | 150} 151.Ed 152.Sh SEE ALSO |
| 179.Xr iscsi_initiator 4 , | |
| 180.Xr iscontrol 8 , 181.Xr iscsictl 8 | 153.Xr iscontrol 8 , 154.Xr iscsictl 8 |
| 182.Sh STANDARDS 183ISCSI RFC 3720 | |
| 184.\"Sh HISTORY 185.\"Sh AUTHORS | 155.\"Sh HISTORY 156.\"Sh AUTHORS |
| 186.Sh BUGS 187Some options have not been implemented, either they were found 188to be unnecessary, or not understood, this can change in the future. 189.br 190The tags opening value is difficult to calculate, use wisely. | |