Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
ISCSICTL(8)             FreeBSD System Manager's Manual            ISCSICTL(8)

NAME
     iscsictl - iSCSI initiator management utility

SYNOPSIS
     iscsictl -A -p portal -t target [-u user -s secret] [-w timeout]
     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] [-w timeout]

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.

     -w     Instead of returning immediately, wait up to timeout seconds until
            all configured sessions are successfully established.

     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 configuration file.

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

     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.

FreeBSD 11.0-PRERELEASE        October 17, 2015        FreeBSD 11.0-PRERELEASE

NAME | SYNOPSIS | DESCRIPTION | FILES | EXIT STATUS | EXAMPLES | SEE ALSO | HISTORY | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=iscsictl&sektion=8&manpath=FreeBSD+10.3-RELEASE+and+Ports>

home | help