1.\" Copyright (c) 2012 The FreeBSD Foundation 2.\" All rights reserved. 3.\" 4.\" This software was developed by Edward Tomasz Napierala under sponsorship 5.\" from the FreeBSD Foundation. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" $FreeBSD$ 29.\" 30.Dd September 20, 2012 31.Dt ISCSICTL 8 32.Os 33.Sh NAME 34.Nm iscsictl 35.Nd iSCSI initiator management utility 36.Sh SYNOPSIS 37.Nm 38.Fl A 39.Fl h Ar host Fl t Ar target Op Fl u Ar user Fl s Ar secret 40.Nm 41.Fl A 42.Fl d Ar discovery-host Op Fl u Ar user Fl s Ar secret 43.Nm 44.Fl A 45.Fl a Op Fl c Ar path 46.Nm 47.Fl A 48.Fl n Ar nickname Op Fl c Ar path 49.Nm 50.Fl R 51.Op Fl h Ar host 52.Op Fl t Ar target 53.Nm 54.Fl R 55.Fl a 56.Nm 57.Fl R 58.Fl n Ar nickname Op Fl c Ar path 59.Nm 60.Fl L 61.Op Fl v 62.Sh DESCRIPTION 63The 64.Nm 65utility is used to configure the iSCSI initiator. 66.Pp 67The following options are available: 68.Bl -tag -width ".Fl A" 69.It Fl A 70Add session. 71.It Fl R 72Remove session. 73.It Fl L 74List sessions. 75.It Fl a 76When adding, add all sessions defined in the configuration file. 77When removing, remove all currently established sessions. 78.It Fl c 79Path to the configuration file. 80The default is 81.Pa /etc/iscsi.conf . 82.It Fl d 83Target host name or address used for SendTargets discovery. 84When used, it will add a temporary discovery session. 85After discovery is done, sessions will be added for each discovered target, 86and the temporary discovery sesion will be removed. 87.It Fl h 88Target host name or address for statically defined targets. 89.It Fl n 90The "nickname" of session defined in the configuration file. 91.It Fl t 92Target name. 93.It Fl v 94Verbose mode. 95.El 96.Pp 97Since connecting to the target is performed in background, non-zero 98exit status does not mean that the session was successfully established. 99Use 100.Nm Fl L 101to check the connection status. 102The initiator notifies 103.Xr devd 8 104when session gets connected or disconnected. 105.Pp 106Note that in order to the iSCSI initiator to be able to connect to a target, 107the 108.Xr iscsid 8 109daemon must be running. 110.Pp 111Also note that 112.Fx 113currently supports two different initiators: the old one, 114.Xr iscsi_initiator 4 , 115with its control utility 116.Xr iscontrol 8 , 117and the new one, 118.Xr iscsi 4 , 119with 120.Nm 121and 122.Xr iscsid 8 . 123The only thing the two have in common is the configuration file, 124.Xr iscsi.conf 5 . 125.Sh FILES 126.Bl -tag -width ".Pa /etc/iscsi.conf" -compact 127.It Pa /etc/iscsi.conf 128iSCSI initiator configuration file. 129.El 130.Sh EXIT STATUS 131The 132.Nm 133utility exits 0 on success, and >0 if an error occurs. 134.Sh EXAMPLES 135Attach to target qn.2012-06.com.example:target0, served by 192.168.1.1: 136.Dl Nm Fl A Fl t Ar qn.2012-06.com.example:target0 Fl h Ar 192.168.1.1 137.Pp 138Disconnect all iSCSI sessions: 139.Dl Nm Fl Ra 140.Sh SEE ALSO 141.Xr iscsi.conf 5 , 142.Xr iscsid 8 143.Sh HISTORY 144The 145.Nm 146command appeared in 147.Fx 10.0 . 148.Sh AUTHORS 149The 150.Nm 151was developed by 152.An Edward Tomasz Napierala Aq trasz@FreeBSD.org 153under sponsorship from the FreeBSD Foundation. 154