svn commit: r277173 - in stable/10: sbin/iscontrol usr.bin/iscsictl

Wed Jan 14 11:29:17 UTC 2015

Author: trasz
Date: Wed Jan 14 11:29:16 2015
New Revision: 277173
URL: https://svnweb.freebsd.org/changeset/base/277173

Log:
  MFC r275510:
  
  Move iscsi.conf.5 from sbin/iscontrol/ to usr.bin/iscsictl/, as the
  former is obsolete.
  
  Sponsored by:	The FreeBSD Foundation

Added:
  stable/10/usr.bin/iscsictl/iscsi.conf.5
     - copied unchanged from r275510, head/usr.bin/iscsictl/iscsi.conf.5
Deleted:
  stable/10/sbin/iscontrol/iscsi.conf.5
Modified:
  stable/10/sbin/iscontrol/Makefile
  stable/10/usr.bin/iscsictl/Makefile
Directory Properties:
  stable/10/   (props changed)

Modified: stable/10/sbin/iscontrol/Makefile
==============================================================================

--- stable/10/sbin/iscontrol/Makefile	Wed Jan 14 11:26:03 2015	(r277172)
+++ stable/10/sbin/iscontrol/Makefile	Wed Jan 14 11:29:16 2015	(r277173)
@@ -9,6 +9,6 @@ S= ${.CURDIR}/../../sys
 WARNS?=	3
 CFLAGS+=	-I$S
 
-MAN= iscsi.conf.5 iscontrol.8
+MAN= iscontrol.8
 
 .include <bsd.prog.mk>

Modified: stable/10/usr.bin/iscsictl/Makefile
==============================================================================
--- stable/10/usr.bin/iscsictl/Makefile	Wed Jan 14 11:26:03 2015	(r277172)
+++ stable/10/usr.bin/iscsictl/Makefile	Wed Jan 14 11:29:16 2015	(r277173)
@@ -4,7 +4,7 @@ PROG=		iscsictl
 SRCS=		iscsictl.c periphs.c parse.y token.l y.tab.h
 CFLAGS+=	-I${.CURDIR}
 CFLAGS+=	-I${.CURDIR}/../../sys/dev/iscsi
-MAN=		iscsictl.8
+MAN=		iscsi.conf.5 iscsictl.8
 
 DPADD=		${LIBCAM} ${LIBUTIL}
 LDADD=		-lcam -lutil

Copied: stable/10/usr.bin/iscsictl/iscsi.conf.5 (from r275510, head/usr.bin/iscsictl/iscsi.conf.5)
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ stable/10/usr.bin/iscsictl/iscsi.conf.5	Wed Jan 14 11:29:16 2015	(r277173, copy of r275510, head/usr.bin/iscsictl/iscsi.conf.5)
@@ -0,0 +1,188 @@
+.\" Copyright (c) 2007-2010 Daniel Braniss <danny at cs.huji.ac.il>
+.\" 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 December 17, 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:
+.Bf Li
+.Bd -literal
+	# this is a comment
+	target_1 { # nickname
+	   variable = value;
+	   ...
+	} # this must be on a line by itself.
+.Ed
+.Ef
+.Pp
+The following are specified in the iSCSI RFC 3720,
+for a full description see sections 11/12 of the RFC.
+.Bl -tag -width MaxConnections
+.It Cm AuthMethod
+currently only supported authentication method is CHAP, with
+digest either MD5 or SHA.
+Default is none.
+.It Cm HeaderDigest
+a
+.Em digest
+is calculated on the header of all iSCSI PDUs, and
+checked.
+Only CRC32C is implemented.
+Default is none.
+.It Cm DataDigest
+same as for HeaderDigest, but on the data part of the iSCSI PDU.
+(not yet tested)
+.It 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 .
+.It Cm InitiatorName
+if not specified, defaults to
+.Sy iqn.2005-01.il.ac.huji.cs:
+.Aq hostname .
+.It Cm TargetAddress
+is of the form
+.Sy domainname[:port][,portal-group-tag]
+to quote the RFC:
+.Bd -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.
+.It Cm MaxRecvDataSegmentLength
+the maximum data segment length in
+bytes it can receive in an iSCSI PDU, default is 8192.
+.It Cm MaxOutstandingR2T
+is used to calculate/negotiate the
+.Em tag opening ,
+can be overridden by the
+.Sy tag
+option.
+.It Cm SessionType
+either Discovery or Normal, default is Normal, see the
+.Fl d
+flag of
+.Cm iscontrol .
+.El
+.sp
+The following are not specified in the
+.Sy RFC 3720
+.Bl -tag -width sockbufsize
+.It Cm port
+The iSCSI port used by the iSCSI protocol, defaults to 3260.
+.It Cm tags
+Sets the
+.Em tag opening
+to the value specified.
+.It Cm maxluns
+overrides the compiled value of
+.Sy luns ,
+see
+.Xr iscsi_initiator 4 .
+This value can only be reduced.
+.It Cm sockbufsize
+sets the receiver and transmitter socket buffer size to
+.Em size ,
+in kilobytes.
+The default is 128.
+.El
+.sp
+If
+.Em AuthMethod
+is set to
+.Cm CHAP ,
+then the following must also be set:
+.Bl -tag -width chapSecret
+.It 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...)
+.It Cm chapIName
+the chap-name, defaults to
+.Em hostname .
+.It Cm chapDigest
+can be MD5 or SHA1.
+.It Cm tgtChapName/tgtChapSecret
+name and secret used for mutual CHAP; by default, mutual CHAP
+is not used.
+.El
+.Sh FILES
+.Bl -tag -width indent
+.It Pa /etc/iscsi.conf
+.El
+.Sh EXAMPLES
+.Bd -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.
+.br
+The tags opening value is difficult to calculate, use wisely.
