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 October 17, 2015 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 p Ar portal Fl t Ar target 40.Op Fl u Ar user Fl s Ar secret 41.Op Fl w Ar timeout 42.Nm 43.Fl A 44.Fl d Ar discovery-host Op Fl u Ar user Fl s Ar secret 45.Nm 46.Fl A 47.Fl a Op Fl c Ar path 48.Nm 49.Fl A 50.Fl n Ar nickname Op Fl c Ar path 51.Nm 52.Fl M 53.Fl i Ar session-id 54.Op Fl p Ar portal 55.Op Fl t Ar target 56.Op Fl u Ar user 57.Op Fl s Ar secret 58.Nm 59.Fl M 60.Fl i Ar session-id 61.Op Fl n Ar nickname Op Fl c Ar path 62.Nm 63.Fl R 64.Op Fl p Ar portal 65.Op Fl t Ar target 66.Nm 67.Fl R 68.Fl a 69.Nm 70.Fl R 71.Fl n Ar nickname Op Fl c Ar path 72.Nm 73.Fl L 74.Op Fl v 75.Op Fl w Ar timeout 76.Sh DESCRIPTION 77The 78.Nm 79utility is used to configure the iSCSI initiator. 80.Pp 81The following options are available: 82.Bl -tag -width ".Fl A" 83.It Fl A 84Add session. 85.It Fl M 86Modify session. 87.It Fl R 88Remove session. 89.It Fl L 90List sessions. 91.It Fl a 92When adding, add all sessions defined in the configuration file. 93When removing, remove all currently established sessions. 94.It Fl c 95Path to the configuration file. 96The default is 97.Pa /etc/iscsi.conf . 98.It Fl d 99Target host name or address used for SendTargets discovery. 100When used, it will add a temporary discovery session. 101After discovery is done, sessions will be added for each discovered target, 102and the temporary discovery session will be removed. 103.It Fl i 104Session ID, as displayed by 105.Nm 106.Fl v . 107.It Fl n 108The "nickname" of session defined in the configuration file. 109.It Fl p 110Target portal - host name or address - for statically defined targets. 111.It Fl s 112CHAP secret. 113.It Fl t 114Target name. 115.It Fl u 116CHAP login. 117.It Fl v 118Verbose mode. 119.It Fl w 120Instead of returning immediately, wait up to 121.Ar timeout 122seconds until all configured sessions are successfully established. 123.El 124.Pp 125Certain parameters are necessary when adding a session. 126One can specify these either via command line (using the 127.Fl t , 128.Fl p , 129.Fl u , 130and 131.Fl s 132options), or configuration file (using the 133.Fl a 134or 135.Fl n 136options). 137Some functionality - for example mutual CHAP - is available only 138via configuration file. 139.Pp 140Since connecting to the target is performed in background, non-zero 141exit status does not mean that the session was successfully established. 142Use either 143.Nm Fl L 144to check the connection status, or the 145.Fl w 146flag to wait for session establishment. 147.Pp 148Note that in order for the iSCSI initiator to be able to connect to a target, 149the 150.Xr iscsid 8 151daemon must be running. 152.Pp 153Also note that 154.Fx 155currently supports two different initiators: the old one, 156.Xr iscsi_initiator 4 , 157with its control utility 158.Xr iscontrol 8 , 159and the new one, 160.Xr iscsi 4 , 161with 162.Nm 163and 164.Xr iscsid 8 . 165The only thing the two have in common is the configuration file, 166.Xr iscsi.conf 5 . 167.Sh FILES 168.Bl -tag -width ".Pa /etc/iscsi.conf" -compact 169.It Pa /etc/iscsi.conf 170iSCSI initiator configuration file. 171.El 172.Sh EXIT STATUS 173The 174.Nm 175utility exits 0 on success, and >0 if an error occurs. 176.Sh EXAMPLES 177Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1: 178.Dl Nm Fl A Fl t Ar iqn.2012-06.com.example:target0 Fl p Ar 192.168.1.1 179.Pp 180Disconnect all iSCSI sessions: 181.Dl Nm Fl Ra 182.Sh SEE ALSO 183.Xr iscsi 4 , 184.Xr iscsi.conf 5 , 185.Xr iscsid 8 186.Sh HISTORY 187The 188.Nm 189command appeared in 190.Fx 10.0 . 191.Sh AUTHORS 192The 193.Nm 194utility was developed by 195.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 196under sponsorship from the FreeBSD Foundation. 197