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 Op Fl u Ar user Fl s Ar secret
42 .Fl d Ar discovery-host Op Fl u Ar user Fl s Ar secret
48 .Fl n Ar nickname Op Fl c Ar path
58 .Fl n Ar nickname Op Fl c Ar path
65 utility is used to configure the iSCSI initiator.
67 The following options are available:
68 .Bl -tag -width ".Fl A"
76 When adding, add all sessions defined in the configuration file.
77 When removing, remove all currently established sessions.
79 Path to the configuration file.
83 Target host name or address used for SendTargets discovery.
84 When used, it will add a temporary discovery session.
85 After discovery is done, sessions will be added for each discovered target,
86 and the temporary discovery sesion will be removed.
88 The "nickname" of session defined in the configuration file.
90 Target portal - host name or address - for statically defined targets.
101 Since connecting to the target is performed in background, non-zero
102 exit status does not mean that the session was successfully established.
105 to check the connection status.
107 Note that in order to the iSCSI initiator to be able to connect to a target,
110 daemon must be running.
114 currently supports two different initiators: the old one,
115 .Xr iscsi_initiator 4 ,
116 with its control utility
124 The only thing the two have in common is the configuration file,
127 .Bl -tag -width ".Pa /etc/iscsi.conf" -compact
128 .It Pa /etc/iscsi.conf
129 iSCSI initiator configuration file.
134 utility exits 0 on success, and >0 if an error occurs.
136 Attach to target iqn.2012-06.com.example:target0, served by 192.168.1.1:
137 .Dl Nm Fl A Fl t Ar iqn.2012-06.com.example:target0 Fl p Ar 192.168.1.1
139 Disconnect all iSCSI sessions:
153 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
154 under sponsorship from the FreeBSD Foundation.