.\" Copyright (c) 2012 The FreeBSD Foundation .\" All rights reserved. .\" .\" This software was developed by Edward Tomasz Napierala under sponsorship .\" from the FreeBSD Foundation. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd September 20, 2012 .Dt ISCSICTL 8 .Os .Sh NAME .Nm iscsictl .Nd iSCSI initiator management utility .Sh SYNOPSIS .Nm .Fl A .Fl h Ar host Fl t Ar target Op Fl u Ar user Fl s Ar secret .Nm .Fl A .Fl d Ar discovery-host Op Fl u Ar user Fl s Ar secret .Nm .Fl A .Fl a Op Fl c Ar path .Nm .Fl A .Fl n Ar nickname Op Fl c Ar path .Nm .Fl R .Op Fl h Ar host .Op Fl t Ar target .Nm .Fl R .Fl a .Nm .Fl R .Fl n Ar nickname Op Fl c Ar path .Nm .Fl L .Op Fl v .Sh DESCRIPTION The .Nm utility is used to configure the iSCSI initiator. .Pp The following options are available: .Bl -tag -width ".Fl A" .It Fl A Add session. .It Fl R Remove session. .It Fl L List sessions. .It Fl a When adding, add all sessions defined in the configuration file. When removing, remove all currently established sessions. .It Fl c Path to the configuration file. The default is .Pa /etc/iscsi.conf . .It Fl 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 sesion will be removed. .It Fl h Target host name or address for statically defined targets. .It Fl n The "nickname" of session defined in the configuration file. .It Fl t Target name. .It Fl v Verbose mode. .El .Pp Since connecting to the target is performed in background, non-zero exit status does not mean that the session was successfully established. Use .Nm Fl L to check the connection status. The initiator notifies .Xr devd 8 when session gets connected or disconnected. .Pp Note that in order to the iSCSI initiator to be able to connect to a target, the .Xr iscsid 8 daemon must be running. .Pp Also note that .Fx currently supports two different initiators: the old one, .Xr iscsi_initiator 4 , with its control utility .Xr iscontrol 8 , and the new one, .Xr iscsi 4 , with .Nm and .Xr iscsid 8 . The only thing the two have in common is the configuration file, .Xr iscsi.conf 5 . .Sh FILES .Bl -tag -width ".Pa /etc/iscsi.conf" -compact .It Pa /etc/iscsi.conf iSCSI initiator configuration file. .El .Sh EXIT STATUS The .Nm utility exits 0 on success, and >0 if an error occurs. .Sh EXAMPLES Attach to target qn.2012-06.com.example:target0, served by 192.168.1.1: .Dl Nm Fl A Fl t Ar qn.2012-06.com.example:target0 Fl h Ar 192.168.1.1 .Pp Disconnect all iSCSI sessions: .Dl Nm Fl Ra .Sh SEE ALSO .Xr iscsi.conf 5 , .Xr iscsid 8 .Sh HISTORY The .Nm command appeared in .Fx 10.0 . .Sh AUTHORS The .Nm was developed by .An Edward Tomasz Napierala Aq trasz@FreeBSD.org under sponsorship from the FreeBSD Foundation.