NetBSD-5.0.2/dist/iscsi/src/iscsi-harness.8

Compare this file to the similar file:
Show the results in this format:
.\" $NetBSD: iscsi-harness.8,v 1.5 2007/10/26 18:36:47 agc Exp $
.\"
.\" Copyright © 2006 Alistair Crooks.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote
.\"    products derived from this software without specific prior written
.\"    permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\" WHETHER IN CONTRACT, STRICT 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 SUCH DAMAGE.
.\"
.Dd September 8, 2007
.Dt ISCSI-HARNESS 8
.Os
.Sh NAME
.Nm iscsi-harness
.Nd test harness for iscsi-target
.Sh SYNOPSIS
.Nm
.Op Fl V
.Op Fl a Ar authentication type
.Op Fl d Ar digest type
.Op Fl h Ar target hostname
.Op Fl n Ar number of test iterations
.Op Fl p Ar port number of iSCSI target
.Op Fl t Ar target name
.Op Fl u Ar user name
.Sh DESCRIPTION
.Nm
is the test harness for
.Xr iscsi-target 8 ,
the iSCSI service.
.Nm
acts as an initiator, performing a set of tests for a number of iterations.
to show network-related information,
It connects to the
.Xr iscsi-target 8
service, and performs a discovery session,
then sends data of various sizes to the target, and reads
data of various sizes from the target.
.Pp
Options and operands available for
.Nm iscsi-harness :
.Bl -tag -width Ds
.It Fl a Ar authentication type
The authentication type can be one of
.Ar chap ,
.Ar Kerberos ,
.Ar SRP ,
or
.Ar none .
The default value is
.Ar none .
.It Fl d Ar digest type
The digest type can be one of
.Ar header ,
.Ar data ,
.Ar both ,
or
.Ar all ,
or
.Ar none .
The default value is
.Ar none .
.It Fl p Ar iSCSI target port number
This option allows the
.Nm
utility to connect to a specific port number
upon which the
.Xr iscsi-target 8
process is listening.
The default port number is 3260.
.It Fl V
.Nm
will print the utility name and version number,
and the address for bug reports, and then exit.
.El
.Sh FILES
.Bl -tag -width /var/run/iscsi-target.pid -compact
.It Pa /etc/iscsi/targets
the list of exported storage
.It Pa /var/run/iscsi-target.pid
the PID of the currently running
.Nm
.El
.Sh SEE ALSO
.Xr targets 5 ,
.Xr iscsi-target 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Nx 4.0 .