external/bsd/iscsi/dist/src/target/iscsi-target.8

   1 .\" $NetBSD: iscsi-target.8,v 1.7 2009/05/04 21:09:12 wiz Exp $
   2 .\"
   3 .\" Copyright © 2006 Alistair Crooks.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote
  14 .\"    products derived from this software without specific prior written
  15 .\"    permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  18 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd May 27, 2006
  30 .Dt ISCSI-TARGET 8
  31 .Os
  32 .Sh NAME
  33 .Nm iscsi-target
  34 .Nd service remote iSCSI requests
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl 46DV
  38 .Op Fl b Ar block length
  39 .Op Fl f Ar configuration file
  40 .Op Fl p Ar port number
  41 .Op Fl s Ar maximum number of sessions
  42 .Op Fl t Ar target name
  43 .Op Fl v Ar verbose arg
  44 .Sh DESCRIPTION
  45 .Nm
  46 is the server for
  47 iSCSI
  48 requests from iSCSI initiators.
  49 .Nm
  50 listens for discovery and login requests on the required port,
  51 and responds to those requests appropriately.
  52 .Pp
  53 Options and operands available for
  54 .Nm iscsi-target :
  55 .Bl -tag -width Ds
  56 .It Fl 4
  57 .Nm
  58 will listen for IPv4 connections,
  59 and respond back using IPv4.
  60 This is the default address family.
  61 .It Fl 6
  62 .Nm
  63 will listen for IPv6 connections,
  64 and respond back using IPv6.
  65 .It Fl b Ar blocksize
  66 Specify the underlying block size for iSCSI storage which will be served.
  67 The possible sizes are: 512, 1024, 2048, and 4096 bytes, with the default
  68 being 512 bytes.
  69 .It Fl D
  70 When this option is specified,
  71 .Nm
  72 will not detach itself from the controlling tty, and will
  73 not become a daemon.
  74 This can be useful for debugging purposes.
  75 .It Fl f Ar configfile
  76 Use the named file as the configuration file.
  77 The default file can be found in
  78 .Ar /etc/iscsi/targets .
  79 See
  80 .Xr targets 5
  81 for more information.
  82 .It Fl p Ar port number
  83 Use the port number provided as the argument as the port
  84 on which to listen for iSCSI service requests from
  85 initiators.
  86 .It Fl s Ar maximum number of sessions
  87 Allow the maximum number of sessions to be initiated when
  88 connecting to the target.
  89 .It Fl t Ar filename
  90 The target name (as it appears to the iSCSI initiator) can be specified
  91 using this flag.
  92 .It Fl V
  93 .Nm
  94 will print the utility name and version number,
  95 and the address for bug reports, and then exit.
  96 .It Fl v Ar argument
  97 The amount of information shown can be varied by using this command.
  98 Possible values of
  99 .Ar argument
 100 are
 101 .Ar net
 102 to show network-related information,
 103 .Ar iscsi
 104 to show iSCSI protocol-related information,
 105 .Ar scsi
 106 to show SCSI protocol information, and
 107 .Ar all
 108 to show information from all of the above arguments.
 109 .El
 110 .Sh FILES
 111 .Bl -tag -width /var/run/iscsi-target.pid -compact
 112 .It Pa /etc/iscsi/targets
 113 the list of exported storage
 114 .It Pa /var/run/iscsi-target.pid
 115 the PID of the currently running
 116 .Nm
 117 .El
 118 .Sh SEE ALSO
 119 .Xr targets 5
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 utility first appeared in
 124 .Nx 4.0 .