share/man/man4/iscsi_initiator.4

   1 .\" Copyright (c) 2007 Daniel Braniss <danny@cs.huji.ac.il>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 9, 2010
  28 .Dt ISCSI_INITIATOR 4
  29 .Os
  30 .Sh NAME
  31 .Nm iscsi_initiator
  32 .Nd kernel driver for the iSCSI protocol
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device iscsi_initiator"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 iscsi_initiator_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 implements the kernel side of the Internet SCSI (iSCSI) network
  51 protocol standard.
  52 The userland companion is
  53 .Xr iscontrol 8 ,
  54 and permits access to remote
  55 .Em virtual
  56 SCSI devices via
  57 .Xr cam 4 .
  58 .Sh SYSCTL VARIABLES
  59 .Bl -tag -width "net.iscsi.n.targedaddress"
  60 .It Va debug.iscsi_initiator
  61 set the debug-level, 0 means no debugging, 9 for maximum.
  62 .It Va net.iscsi.isid
  63 the initiator part of the Session Identifier.
  64 .El
  65 .Pp
  66 The following are informative only:
  67 .Bl -tag -width "net.iscsi.n.targedaddress"
  68 .It Va net.iscsi.driver_version
  69 the current version of the driver.
  70 .It Va net.iscsi.sessions
  71 the number of current active sessions.
  72 .It Va net.iscsi.n.targetname
  73 the target name of session
  74 .Em n .
  75 .It Va net.iscsi.n.targedaddress
  76 the IP address of the target of session
  77 .Em n .
  78 .It Va net.iscsi.n.stats
  79 statistics for session
  80 .Em n
  81 .It Va net.iscsi.n.pid
  82 the
  83 .Em "process id"
  84 of the userland side of session
  85 .Em n ,
  86 see
  87 .Xr iscontrol 8 .
  88 .El
  89 .Sh FILES
  90 The
  91 .Nm
  92 driver creates the following:
  93 .Pp
  94 .Bl -tag -width ".Pa /dev/iscsi%dxx" -compact
  95 .It Pa /dev/iscsi
  96 used to create new sessions.
  97 .It Pa /dev/iscsi%d
  98 for each new session.
  99 .El
 100 .Sh SEE ALSO
 101 .Xr cam 4 ,
 102 .Xr camcontrol 8 ,
 103 .Xr iscontrol 8
 104 .Sh STANDARDS
 105 iSCSI RFC 3720
 106 .\" .Sh HISTORY
 107 .\" .Sh AUTHORS
 108 .Sh BUGS
 109 The lun discovery method is old-fashioned.