| iscsi.conf.5 (255570) | iscsi.conf.5 (256261) |
|---|---|
| 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/sbin/iscontrol/iscsi.conf.5 255570 2013-09-14 15:29:06Z trasz $ | 25.\" $FreeBSD: head/sbin/iscontrol/iscsi.conf.5 256261 2013-10-10 11:28:20Z trasz $ |
| 26.\" | 26.\" |
| 27.Dd June 5, 2007 | 27.Dd October 10, 2013 |
| 28.Dt ISCSI.CONF 5 29.Os 30.Sh NAME 31.Nm iscsi.conf | 28.Dt ISCSI.CONF 5 29.Os 30.Sh NAME 31.Nm iscsi.conf |
| 32.Nd key options to be negotiated in an iSCSI session | 32.Nd iSCSI initiator configuration file |
| 33.Sh DESCRIPTION 34The file 35.Nm , | 33.Sh DESCRIPTION 34The file 35.Nm , |
| 36is read by the | 36is used by the 37.Xr iscsictl 8 38and |
| 37.Xr iscontrol 8 | 39.Xr iscontrol 8 |
| 38program. | 40utilities. |
| 39It contains declarations and parameter/key-options. 40The syntax is very simple, 41.D1 Li variable = value; 42and they can be grouped via a 43.Em block 44declaration: 45.Bf Li 46.Bd -literal --- 17 unchanged lines hidden (view full) --- 64.Em digest 65is calculated on the header of all iSCSI PDUs, and 66checked. 67Only CRC32C is implemented. 68Default is none. 69.It Cm DataDigest 70same as for HeaderDigest, but on the data part of the iSCSI PDU. 71(not yet tested) | 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: 47.Bf Li 48.Bd -literal --- 17 unchanged lines hidden (view full) --- 66.Em digest 67is calculated on the header of all iSCSI PDUs, and 68checked. 69Only CRC32C is implemented. 70Default is none. 71.It Cm DataDigest 72same as for HeaderDigest, but on the data part of the iSCSI PDU. 73(not yet tested) |
| 72.It Cm MaxConnections 73is the number of simultaneous connections per session, 74currently only 1. | |
| 75.It Cm TargetName 76is the name by which the target is known, not to be confused with 77target address, either obtained via the target administrator, or 78from a 79.Em discovery session . 80.It Cm InitiatorName 81if not specified, defaults to 82.Sy iqn.2005-01.il.ac.huji.cs: 83.Aq hostname . | 74.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 . 79.It Cm InitiatorName 80if not specified, defaults to 81.Sy iqn.2005-01.il.ac.huji.cs: 82.Aq hostname . |
| 84.It Cm TargetAlias / InitiatorAlias 85not implemented. | |
| 86.It Cm TargetAddress 87is of the form 88.Sy domainname[:port][,portal-group-tag] 89to quote the RFC: 90.Bd -ragged -compact 91The domainname can be specified as either a DNS host name, a 92dotted-decimal IPv4 address, or a bracketed IPv6 address as specified 93in [RFC2732]. 94.Ed 95Note: portal-group-tag is unused at the moment. | 83.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. |
| 96.It Cm TargetPortalGroupTag | |
| 97.Em not implemented yet. | 93.Em not implemented yet. |
| 98.It Cm InitialR2T 99.Em not implemented yet. 100.It Cm ImmediateData 101.Em not implemented yet. | |
| 102.It Cm MaxRecvDataSegmentLength 103the maximum data segment length in 104bytes it can receive in an iSCSI PDU, default is 8192. | 94.It Cm MaxRecvDataSegmentLength 95the maximum data segment length in 96bytes it can receive in an iSCSI PDU, default is 8192. |
| 105.It Cm MaxBurstLength 106.Em not implemented yet. 107.It Cm FirstBurstLength 108.Em not implemented yet. 109.It Cm DefaultTime2Wait 110.Em not implemented yet. 111.It Cm DefaultTime2Retain 112.Em not implemented yet. | |
| 113.It Cm MaxOutstandingR2T 114is used to calculate/negotiate the 115.Em tag opening , 116can be overridden by the 117.Sy tag 118option. | 97.It Cm MaxOutstandingR2T 98is used to calculate/negotiate the 99.Em tag opening , 100can be overridden by the 101.Sy tag 102option. |
| 119.It Cm DataPDUInOrder 120.Em not implemented yet. 121.It Cm DataSequenceInOrder 122.Em not implemented yet. 123.It Cm ErrorRecoveryLevel 124Only level 0 is supported. | |
| 125.It Cm SessionType 126either Discovery or Normal, default is Normal, see the 127.Fl d 128flag of 129.Cm iscontrol . 130.El 131.sp 132The following are not specified in the --- 58 unchanged lines hidden (view full) --- 191 targetaddress= 10.0.0.1; 192 targetname = iqn.1900.com.com:sn.123456 193 initiatorname= iqn.2005-01.il.ac.huji.cs:nobody 194 authmethod = CHAP; chapDigest = SHA1; 195 chapsecret = 0x3713c3336d9a224c2791c873d3d2b174 196 tags = 256 197} 198.Ed | 103.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 --- 58 unchanged lines hidden (view full) --- 169 targetaddress= 10.0.0.1; 170 targetname = iqn.1900.com.com:sn.123456 171 initiatorname= iqn.2005-01.il.ac.huji.cs:nobody 172 authmethod = CHAP; chapDigest = SHA1; 173 chapsecret = 0x3713c3336d9a224c2791c873d3d2b174 174 tags = 256 175} 176.Ed |
| 199.Sh ERRORS 200The parsing is very primitive, so do not expect - at the moment - any 201error messages. | |
| 202.Sh SEE ALSO 203.Xr iscsi_initiator 4 , 204.Xr iscsictl 8 , 205.Xr iscontrol 8 206.Sh STANDARDS 207ISCSI RFC 3720 208.\"Sh HISTORY 209.\"Sh AUTHORS 210.Sh BUGS 211Some options have not been implemented, either they were found 212to be unnecessary, or not understood, this can change in the future. 213.br 214The tags opening value is difficult to calculate, use wisely. | 177.Sh SEE ALSO 178.Xr iscsi_initiator 4 , 179.Xr iscsictl 8 , 180.Xr iscontrol 8 181.Sh STANDARDS 182ISCSI RFC 3720 183.\"Sh HISTORY 184.\"Sh AUTHORS 185.Sh BUGS 186Some options have not been implemented, either they were found 187to be unnecessary, or not understood, this can change in the future. 188.br 189The tags opening value is difficult to calculate, use wisely. |