Page MenuHomeFreeBSD
Differential D18608 Diff 52338 head/usr.bin/iscsictl/iscsictl.8

Changeset View

Standalone View

View Options

head/usr.bin/iscsictl/iscsictl.8

Show All 21 Lines
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd May 6, 2016 .Dd December 27, 2018
.Dt ISCSICTL 8 .Dt ISCSICTL 8
.Os .Os
.Sh NAME .Sh NAME
.Nm iscsictl .Nm iscsictl
.Nd iSCSI initiator management utility .Nd iSCSI initiator management utility
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Fl A .Fl A
.Fl p Ar portal Fl t Ar target .Fl p Ar portal Fl t Ar target
.Op Fl u Ar user Fl s Ar secret .Op Fl u Ar user Fl s Ar secret
.Op Fl w Ar timeout .Op Fl w Ar timeout
.Op Fl r .Op Fl r
.Op Fl e Cm on | off .Op Fl e Cm on Ns | Ns Cm off
.Nm .Nm
.Fl A .Fl A
.Fl d Ar discovery-host .Fl d Ar discovery-host
.Op Fl u Ar user Fl s Ar secret .Op Fl u Ar user Fl s Ar secret
.Op Fl r .Op Fl r
.Op Fl e Cm on | off .Op Fl e Cm on Ns | Ns Cm off
.Nm .Nm
.Fl A .Fl A
.Fl a Op Fl c Ar path .Fl a Op Fl c Ar path
.Nm .Nm
.Fl A .Fl A
.Fl n Ar nickname Op Fl c Ar path .Fl n Ar nickname Op Fl c Ar path
.Nm .Nm
.Fl M .Fl M
.Fl i Ar session-id .Fl i Ar session-id
.Op Fl p Ar portal .Op Fl p Ar portal
.Op Fl t Ar target .Op Fl t Ar target
.Op Fl u Ar user .Op Fl u Ar user
.Op Fl s Ar secret .Op Fl s Ar secret
.Op Fl e Cm on | off .Op Fl e Cm on Ns | Ns Cm off
.Nm .Nm
.Fl M .Fl M
.Fl i Ar session-id .Fl i Ar session-id
.Op Fl n Ar nickname Op Fl c Ar path .Op Fl n Ar nickname Op Fl c Ar path
.Nm .Nm
.Fl R .Fl R
.Op Fl p Ar portal .Op Fl p Ar portal
.Op Fl t Ar target .Op Fl t Ar target
.Nm .Nm
.Fl R .Fl R
.Fl a .Fl a
.Nm .Nm
.Fl R .Fl R
.Fl n Ar nickname Op Fl c Ar path .Fl n Ar nickname Op Fl c Ar path
.Nm .Nm
.Fl L .Fl L
.Op Fl v .Op Fl v
.Op Fl w Ar timeout .Op Fl w Ar timeout
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility is used to configure the iSCSI initiator. utility is used to configure the iSCSI initiator.
.Pp .Pp
The following options are available: The following options are available:
.Bl -tag -width ".Fl A" .Bl -tag -width "-d discovery-host"
.It Fl -libxo .It Fl -libxo
Generate output via Generate output via
.Xr libxo 3 .Xr libxo 3
in a selection of different human and machine readable formats. in a selection of different human and machine readable formats.
See See
.Xr xo_parse_args 3 .Xr xo_parse_args 3
for details on command line arguments. for details on command line arguments.
.It Fl A .It Fl A
Add session. Add session.
.It Fl M .It Fl M
Modify session. Modify session.
.It Fl R .It Fl R
Remove session. Remove session.
.It Fl L .It Fl L
List sessions. List sessions.
.It Fl a .It Fl a
When adding, add all sessions defined in the configuration file. When adding, add all sessions defined in the configuration file.
When removing, remove all currently established sessions. When removing, remove all currently established sessions.
.It Fl c .It Fl c Ar path
Path to the configuration file. Path to the configuration file.
The default is The default is
.Pa /etc/iscsi.conf . .Pa /etc/iscsi.conf .
.It Fl d .It Fl d Ar discovery-host
Target host name or address used for SendTargets discovery. Target host name or address used for SendTargets discovery.
When used, it will add a temporary discovery session. When used, it will add a temporary discovery session.
After discovery is done, sessions will be added for each discovered target, After discovery is done, sessions will be added for each discovered target,
and the temporary discovery session will be removed. and the temporary discovery session will be removed.
.It Fl e .It Fl e Cm on Ns | Ns Cm off
Enable or disable the session. Enable or disable the session.
This is ignored for discovery sessions, but gets passed down to normal This is ignored for discovery sessions, but gets passed down to normal
sessions they add. sessions they add.
.It Fl i .It Fl i Ar session-id
Session ID, as displayed by Session ID, as displayed by
.Nm .Nm
.Fl v . .Fl v .
.It Fl n .It Fl n Ar nickname
The "nickname" of session defined in the configuration file. The
.It Fl p .Ar nickname
Target portal - host name or address - for statically defined targets. of a session defined in the configuration file.
.It Fl p Ar portal
Target portal \(em host name or address \(em for statically defined targets.
.It Fl r .It Fl r
Use iSER (iSCSI over RDMA) instead of plain iSCSI over TCP/IP. Use iSER (iSCSI over RDMA) instead of plain iSCSI over TCP/IP.
.It Fl s .It Fl s Ar secret
CHAP secret. CHAP secret.
.It Fl t .It Fl t Ar target
Target name. Target name.
.It Fl u .It Fl u Ar user
CHAP login. CHAP login.
.It Fl v .It Fl v
Verbose mode. Verbose mode.
.It Fl w .It Fl w Ar timeout
Instead of returning immediately, wait up to Instead of returning immediately, wait up to
.Ar timeout .Ar timeout
seconds until all configured sessions are successfully established. seconds until all configured sessions are successfully established.
.El .El
.Pp .Pp
Certain parameters are necessary when adding a session. Certain parameters are necessary when adding a session.
One can specify these either via command line (using the One can specify these either via command line (using the
.Fl t , .Fl t ,
▲ Show 20 Lines • Show All 77 Lines • Show Last 20 Lines