iscsictl(8) [freebsd 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

ISCSI-INITIATOR(8)					    BSD System Manager's Manual 					ISCSI-INITIATOR(8)

NAME

     iscsi-initiator -- refuse-based iSCSI initiator

SYNOPSIS

     iscsi-initiator [-46bcDfVv] [-a authentication-type] [-d digest-type] [-h target-hostname] [-p target-port-number] [-t target-number]
		     [-u username] mount_point

DESCRIPTION

     The iscsi-initiator utility can be used to access an iSCSI target, such as iscsi-target(8), to access block storage which has been exported.
     Information pertaining to the target is displayed underneath the mount point, along with the device corresponding to the storage which the
     target exports.

     The various arguments are as follows:

     -4      Use an IPv4 connection to the target.

     -6      Use an IPv6 connection to the target.

     -a authentication-type
	     Use the specified authentication type when communicating with the target.	The possible values are chap, kerberos, srp or none.  The
	     default value is none.

     -b      Show the storage as a block device.

     -c      Show the storage as a character device.

     -d digest-type
	     Use the specified digest type when communicating with the target.	The possible values are header, data, both, all or none.  The
	     default value is none.

     -D      List the LUNs on the specified target and exit (i.e. do discovery only)

     -f      Show the storage as a regular file.

     -h hostname
	     Connect to the iSCSI target running on the host specified as the argument.

     -p port-number
	     Connect to the iSCSI target running on the port specified as the argument.  The default value is 3260.

     -t target
	     Connect to the number of the iSCSI target running as the argument.

     -u username
	     Use the specified user's credentials when logging in to the iSCSI target.	There is no default.

     -V      Print out the version number and then exit.

     -v      Be verbose in operation.

     The refuse(3) library is used to provide the file system features.

     The mandatory parameter is the local mount point.

     This iSCSI initiator presents a view of the targets underneath the mount point.  Firstly, it creates a directory tree with the hostname of
     the target, and, in that directory, a virtual directory is created for each target name exported by the iSCSI target program.  Within that
     virtual target directory, symbolic links exist for the hostname (for convenience), a textual representation of the IP address, the iSCSI tar-
     get product name, the iSCSI target IQN, the iSCSI target vendor and version number.  One other directory entry is presented in the virtual
     target directory, relating to the storage presented by the iSCSI target.  This can be in the form of a regular file, which is also the
     default, a block device or a character device.

     Please note that the iscsi-initiator utility needs the ``puffs'' kernel module loaded via modload(8) to operate.

EXAMPLES

     # ./iscsi-initiator -u agc -h iscsi-target0.alistaircrooks.co.uk /mnt
     # ls -al /mnt/target0
     total 576
     drwxr-xr-x  2 agc	agc	   512 May 11 22:24 .
     drwxr-xr-x  2 agc	agc	   512 May 11 22:24 ..
     lrw-r--r--  1 agc	agc	    39 May 11 22:24 hostname -> iscsi-target0.alistaircrooks.co.uk
     lrw-r--r--  1 agc	agc	    14 May 11 22:24 ip -> 172.16.135.130
     lrw-r--r--  1 agc	agc	    16 May 11 22:24 product -> NetBSD iSCSI
     -rw-r--r--  1 agc	agc  104857600 May 11 22:24 storage
     lrw-r--r--  1 agc	agc	    43 May 11 22:24 targetname -> iqn.1994-04.org.netbsd.iscsi-target:target0
     lrw-r--r--  1 agc	agc	     8 May 11 22:24 vendor -> NetBSD
     lrw-r--r--  1 agc	agc	     4 May 11 22:24 version -> 0
     #

SEE ALSO

     puffs(3), refuse(3), iscsi-target(8)

HISTORY

     The iscsi-initiator utility first appeared in NetBSD 6.0.	An earlier version called iscsifs was available in NetBSD 5.0 in source format
     only.

AUTHORS

     The iscsi-initiator utility was written by Alistair Crooks <agc@NetBSD.org>.

BUGS

     iscsi-initiator currently only supports a CHAP challenge length of 16 octets.  Other initiators support up to 1024 and thus it is expected
     that most targets will also support such lengths.	This means that CHAP compatibility with other targets apart from iscsi-target(8) is likely
     to be poor.  To workaround this, please use authentication type none by not specifying a username with the -u option.

BSD
								 February 22, 2011							       BSD