Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

iscsi.conf(5) [freebsd man page]

ISCSI.CONF(5)						      BSD File Formats Manual						     ISCSI.CONF(5)

NAME

     iscsi.conf -- iSCSI initiator configuration file

DESCRIPTION

     The file iscsi.conf, is used by the iscsictl(8) and iscontrol(8) utilities.  It contains declarations and parameter/key-options.  The syntax
     is very simple,
	   variable = value;
     and they can be grouped via a block declaration:

	     # this is a comment
	     target_1 { # nickname
		variable = value;
		...
	     } # this must be on a line by itself.

     The following are specified in the iSCSI RFC 3720, for a full description see sections 11/12 of the RFC.

     AuthMethod      currently only supported authentication method is CHAP, with digest either MD5 or SHA.  Default is none.

     HeaderDigest    a digest is calculated on the header of all iSCSI PDUs, and checked.  Only CRC32C is implemented.	Default is none.

     DataDigest      same as for HeaderDigest, but on the data part of the iSCSI PDU.  (not yet tested)

     TargetName      is the name by which the target is known, not to be confused with target address, either obtained via the target administra-
		     tor, or from a discovery session.

     InitiatorName   if not specified, defaults to iqn.2005-01.il.ac.huji.cs: <hostname>.

     TargetAddress   is of the form domainname[:port][,portal-group-tag] to quote the RFC:
		     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].
		     Note: portal-group-tag is unused at the moment.  not implemented yet.

     MaxRecvDataSegmentLength
		     the maximum data segment length in bytes it can receive in an iSCSI PDU, default is 8192.

     MaxOutstandingR2T
		     is used to calculate/negotiate the tag opening, can be overridden by the tag option.

     SessionType     either Discovery or Normal, default is Normal, see the -d flag of iscontrol.

     The following are not specified in the RFC 3720

     offload	  Name of selected iSCSI hardware offload driver.

     port	  The iSCSI port used by the iSCSI protocol, defaults to 3260.

     tags	  Sets the tag opening to the value specified.

     maxluns	  overrides the compiled value of luns, see iscsi_initiator(4).  This value can only be reduced.

     sockbufsize  sets the receiver and transmitter socket buffer size to size, in kilobytes.  The default is 128.

     If AuthMethod is set to CHAP, then the following must also be set:

     chapSecret  this shared-secret.  Can be either an ASCII string (e.g. hello world), a hex string (e.g 0xababcd0987654321...), or base64 string
		 (eg 0b...)

     chapIName	 the chap-name, defaults to hostname.

     chapDigest  can be MD5 or SHA1.

     tgtChapName/tgtChapSecret
		 name and secret used for mutual CHAP; by default, mutual CHAP is not used.

FILES

     /etc/iscsi.conf

EXAMPLES

     #
     # 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
     }

SEE ALSO

     iscsi_initiator(4), iscontrol(8), iscsictl(8)

STANDARDS

     ISCSI RFC 3720

BUGS

     Some options have not been implemented, either they were found to be unnecessary, or not understood, this can change in the future.
     The tags opening value is difficult to calculate, use wisely.

BSD
								 February 4, 2015							       BSD

Check Out this Related Man Page

ISCSICTL(8)						    BSD System Manager's Manual 					       ISCSICTL(8)

NAME

     iscsictl -- iSCSI initiator management utility

SYNOPSIS

     iscsictl -A -p portal -t target [-u user -s secret]
     iscsictl -A -d discovery-host [-u user -s secret]
     iscsictl -A -a [-c path]
     iscsictl -A -n nickname [-c path]
     iscsictl -M -i session-id [-p portal] [-t target] [-u user] [-s secret]
     iscsictl -M -i session-id [-n nickname [-c path]]
     iscsictl -R [-p portal] [-t target]
     iscsictl -R -a
     iscsictl -R -n nickname [-c path]
     iscsictl -L [-v]

DESCRIPTION

     The iscsictl utility is used to configure the iSCSI initiator.

     The following options are available:

     -A  Add session.

     -M  Modify session.

     -R  Remove session.

     -L  List sessions.

     -a  When adding, add all sessions defined in the configuration file.  When removing, remove all currently established sessions.

     -c  Path to the configuration file.  The default is /etc/iscsi.conf.

     -d  Target host name or address used for SendTargets discovery.  When used, it will add a temporary discovery session.  After discovery is
	 done, sessions will be added for each discovered target, and the temporary discovery session will be removed.

     -i  Session ID, as displayed by iscsictl -v.

     -n  The "nickname" of session defined in the configuration file.

     -p  Target portal - host name or address - for statically defined targets.

     -s  CHAP secret.

     -t  Target name.

     -u  CHAP login.

     -v  Verbose mode.

     Certain parameters are necessary when adding a session.  One can specify these either via command line (using the -t, -p, -u, and -s
     options), or configuration file (using the -a or -n options).  Some functionality - for example mutual CHAP - is available only via configu-
     ration file.

     Since connecting to the target is performed in background, non-zero exit status does not mean that the session was successfully established.
     Use iscsictl -L to check the connection status.

     Note that in order for the iSCSI initiator to be able to connect to a target, the iscsid(8) daemon must be running.

     Also note that FreeBSD currently supports two different initiators: the old one, iscsi_initiator(4), with its control utility iscontrol(8),
     and the new one, iscsi(4), with iscsictl and iscsid(8).  The only thing the two have in common is the configuration file, iscsi.conf(5).

FILES

     /etc/iscsi.conf  iSCSI initiator configuration file.

EXIT STATUS

     The iscsictl utility exits 0 on success, and >0 if an error occurs.

EXAMPLES

     Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1:
	   iscsictl -A -t iqn.2012-06.com.example:target0 -p 192.168.1.1

     Disconnect all iSCSI sessions:
	   iscsictl -Ra

SEE ALSO

     iscsi(4), iscsi.conf(5), iscsid(8)

HISTORY

     The iscsictl command appeared in FreeBSD 10.0.

AUTHORS

     The iscsictl utility was developed by Edward Tomasz Napierala <trasz@FreeBSD.org> under sponsorship from the FreeBSD Foundation.

BSD
								September 12, 2014							       BSD
Man Page