1 .\" Copyright (c) 2012 The FreeBSD Foundation
2 .\" All rights reserved.
4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
5 .\" from the FreeBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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.
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
35 .Nd iSCSI initiator management utility
39 .Fl p Ar portal Fl t Ar target
40 .Op Fl u Ar user Fl s Ar secret
44 .Fl d Ar discovery-host Op Fl u Ar user Fl s Ar secret
50 .Fl n Ar nickname Op Fl c Ar path
61 .Op Fl n Ar nickname Op Fl c Ar path
71 .Fl n Ar nickname Op Fl c Ar path
79 utility is used to configure the iSCSI initiator.
81 The following options are available:
82 .Bl -tag -width ".Fl A"
86 in a selection of different human and machine readable formats.
89 for details on command line arguments.
99 When adding, add all sessions defined in the configuration file.
100 When removing, remove all currently established sessions.
102 Path to the configuration file.
104 .Pa /etc/iscsi.conf .
106 Target host name or address used for SendTargets discovery.
107 When used, it will add a temporary discovery session.
108 After discovery is done, sessions will be added for each discovered target,
109 and the temporary discovery session will be removed.
111 Session ID, as displayed by
115 The "nickname" of session defined in the configuration file.
117 Target portal - host name or address - for statically defined targets.
127 Instead of returning immediately, wait up to
129 seconds until all configured sessions are successfully established.
132 Certain parameters are necessary when adding a session.
133 One can specify these either via command line (using the
139 options), or configuration file (using the
144 Some functionality - for example mutual CHAP - is available only
145 via configuration file.
147 Since connecting to the target is performed in background, non-zero
148 exit status does not mean that the session was successfully established.
151 to check the connection status, or the
153 flag to wait for session establishment.
155 Note that in order for the iSCSI initiator to be able to connect to a target,
158 daemon must be running.
162 currently supports two different initiators: the old one,
163 .Xr iscsi_initiator 4 ,
164 with its control utility
172 The only thing the two have in common is the configuration file,
175 .Bl -tag -width ".Pa /etc/iscsi.conf" -compact
176 .It Pa /etc/iscsi.conf
177 iSCSI initiator configuration file.
182 utility exits 0 on success, and >0 if an error occurs.
184 Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1:
185 .Dl Nm Fl A Fl t Ar iqn.2012-06.com.example:target0 Fl p Ar 192.168.1.1
187 Disconnect all iSCSI sessions:
191 .Xr xo_parse_args 3 ,
203 utility was developed by
204 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
205 under sponsorship from the FreeBSD Foundation.