iscsi(4) [freebsd man page]

ISCSI(4)						   BSD Kernel Interfaces Manual 						  ISCSI(4)

NAME

     iscsi -- iSCSI initiator

SYNOPSIS

     To compile this driver into the kernel, place the following line in the kernel configuration file:

	   device iscsi

     Alternatively, to load the driver as a module at boot time, place the following line in loader.conf(5):

	   iscsi_load="YES"

DESCRIPTION

     The iscsi subsystem provides the kernel component of an iSCSI initiator.  The initiator is the iSCSI client, which connects to an iSCSI tar-
     get, providing local access to a remote block device.  The userland component is provided by iscsid(8) and both the kernel and userland are
     configured using iscsictl(8).  The iscsi subsystem is responsible for implementing the "Full Feature Phase" of the iSCSI protocol.

SYSCTL VARIABLES

     The following variables are available as both sysctl(8) variables and loader(8) tunables:

     kern.iscsi.ping_timeout
	     The number of seconds to wait for the target to respond to a NOP-Out PDU.	In the event that there is no response within that time
	     the session gets forcibly restarted.

     kern.iscsi.iscsid_timeout
	     The number of seconds to wait for ctld(8) to establish a session.	After that time iscsi will abort and retry.

     kern.iscsi.login_timeout
	     The number of seconds to wait for a login attempt to succeed.  After that time iscsi will abort and retry.

     kern.iscsi.maxtags
	     The maximum number of outstanding IO requests.

     kern.iscsi.fail_on_disconnection
	     Controls the behavior after an iSCSI connection has been dropped due to network problems.	When set to 1, a dropped connection causes
	     the iSCSI device nodes to be destroyed.  After reconnecting, they will be created again.  By default, the device nodes are left
	     intact.  While the connection is down all input/output operations are suspended, to be retried after the connection is reestablished.

SEE ALSO

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

HISTORY

     The iscsi subsystem first appeared in FreeBSD 10.0.

AUTHORS

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

BSD
								September 11, 2014							       BSD

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