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
43 .Op Fl e Cm on Ns | Ns Cm off
46 .Fl d Ar discovery-host
47 .Op Fl u Ar user Fl s Ar secret
49 .Op Fl e Cm on Ns | Ns Cm off
55 .Fl n Ar nickname Op Fl c Ar path
63 .Op Fl e Cm on Ns | Ns Cm off
67 .Op Fl n Ar nickname Op Fl c Ar path
77 .Fl n Ar nickname Op Fl c Ar path
85 utility is used to configure the iSCSI initiator.
87 The following options are available:
88 .Bl -tag -width "-d discovery-host"
92 in a selection of different human and machine readable formats.
95 for details on command line arguments.
105 When adding, add all sessions defined in the configuration file.
106 When removing, remove all currently established sessions.
108 Path to the configuration file.
110 .Pa /etc/iscsi.conf .
111 .It Fl d Ar discovery-host
112 Target host name or address used for SendTargets discovery.
113 When used, it will add a temporary discovery session.
114 After discovery is done, sessions will be added for each discovered target,
115 and the temporary discovery session will be removed.
116 .It Fl e Cm on Ns | Ns Cm off
117 Enable or disable the session.
118 This is ignored for discovery sessions, but gets passed down to normal
120 .It Fl i Ar session-id
121 Session ID, as displayed by
127 of a session defined in the configuration file.
129 Target portal \(em host name or address \(em for statically defined targets.
131 Use iSER (iSCSI over RDMA) instead of plain iSCSI over TCP/IP.
141 Instead of returning immediately, wait up to
143 seconds until all configured sessions are successfully established.
146 Certain parameters are necessary when adding a session.
147 One can specify these either via command line (using the
153 options), or configuration file (using the
158 Some functionality - for example mutual CHAP - is available only
159 via configuration file.
161 Since connecting to the target is performed in background, non-zero
162 exit status does not mean that the session was successfully established.
165 to check the connection status, or the
167 flag to wait for session establishment.
169 Note that in order for the iSCSI initiator to be able to connect to a target,
172 daemon must be running.
176 currently supports two different initiators: the old one,
177 .Xr iscsi_initiator 4 ,
178 with its control utility
186 The only thing the two have in common is the configuration file,
189 .Bl -tag -width ".Pa /etc/iscsi.conf" -compact
190 .It Pa /etc/iscsi.conf
191 iSCSI initiator configuration file.
196 utility exits 0 on success, and >0 if an error occurs.
198 Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1:
199 .Dl Nm Fl A Fl t Ar iqn.2012-06.com.example:target0 Fl p Ar 192.168.1.1
201 Perform discovery on 192.168.1.1, and add disabled sessions for each
202 discovered target; use
205 .Dl Nm Fl A Fl d Ar 192.168.1.1 Fl e Ar off
207 Disconnect all iSCSI sessions:
211 .Xr xo_parse_args 3 ,
223 utility was developed by
224 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
225 under sponsorship from the FreeBSD Foundation.