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

Check Out this Related Man Page

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

NAME

     iscsi-target -- service remote iSCSI requests

SYNOPSIS

     iscsi-target [-46DV] [-b block length] [-f configuration file] [-p port number] [-s maximum number of sessions] [-t target name]
		  [-v verbose arg]

DESCRIPTION

     iscsi-target is the server for iSCSI requests from iSCSI initiators.  iscsi-target listens for discovery and login requests on the required
     port, and responds to those requests appropriately.

     Options and operands available for iscsi-target:

     -4      iscsi-target will listen for IPv4 connections, and respond back using IPv4.  This is the default address family.

     -6      iscsi-target will listen for IPv6 connections, and respond back using IPv6.

     -b blocksize
	     Specify the underlying block size for iSCSI storage which will be served.	The possible sizes are: 512, 1024, 2048, and 4096 bytes,
	     with the default being 512 bytes.

     -D      When this option is specified, iscsi-target will not detach itself from the controlling tty, and will not become a daemon.  This can
	     be useful for debugging purposes.

     -f configfile
	     Use the named file as the configuration file.  The default file can be found in /etc/iscsi/targets.  See targets(5) for more informa-
	     tion.

     -p port number
	     Use the port number provided as the argument as the port on which to listen for iSCSI service requests from initiators.

     -s maximum number of sessions
	     Allow the maximum number of sessions to be initiated when connecting to the target.

     -t filename
	     The target name (as it appears to the iSCSI initiator) can be specified using this flag.

     -V      iscsi-target will print the utility name and version number, and the address for bug reports, and then exit.

     -v argument
	     The amount of information shown can be varied by using this command.  Possible values of argument are net to show network-related
	     information, iscsi to show iSCSI protocol-related information, scsi to show SCSI protocol information, and all to show information
	     from all of the above arguments.

FILES

     /etc/iscsi/targets 	the list of exported storage
     /var/run/iscsi-target.pid	the PID of the currently running iscsi-target

SEE ALSO

     targets(5)

HISTORY

     The iscsi-target utility first appeared in NetBSD 4.0.

BSD
								   May 27, 2006 							       BSD

Linux and UNIX Man Pages

iscsictl(8) [freebsd man page]

Check Out this Related Man Page