share/man/man4/iscsi_initiator.4

   1 .\" Copyright (c) 2007-2010 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 August 3, 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, the user land companion is
  52 .Xr iscontrol 8 ,
  53 and permits access to remote
  54 .Em virtual
  55 SCSI devices via
  56 .Xr cam 4 .
  57 .Sh SYSCTL VARIABLES
  58 .Bl -tag -width ".Va net.iscsi.n.targeaddress"
  59 .It Va debug.iscsi_initiator
  60 set the debug-level, 0 means no debugging, 9 for maximum.
  61 .It Va net.iscsi.isid
  62 the initiator part of the Session Identifier.
  63 .It Va "kern.cam.cam_srch_hi=1"
  64 allow search above LUN 7 for SCSI3 and greater devices.
  65 .It "the following are informative only:"
  66 .It Va net.iscsi.driver_version
  67 the current version of the driver.
  68 .It Va net.iscsi.sessions
  69 the number of current active sessions.
  70 .It Va net.iscsi.n.targetname
  71 is the targe name of session
  72 .Em n .
  73 .It Va net.iscsi.n.targeaddress
  74 is the IP address of the target of session
  75 .Em n .
  76 .It Va net.iscsi.n.stats
  77 are some statistics for session
  78 .Em n
  79 .It Va net.iscsi.n.pid
  80 is the
  81 .Em "process id"
  82 of the userland side of session
  83 .Em n ,
  84 see
  85 .Xr iscontrol 8 .
  86 .El
  87 .Sh FILES
  88 The
  89 .Nm
  90 driver creates the following:
  91 .Pp
  92 .Bl -tag -width ".Pa /dev/iscsi%dxx" -compact
  93 .It Pa /dev/iscsi
  94 used to create new sessions.
  95 .It Pa /dev/iscsi%d
  96 for each new session.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr cam 4 ,
 100 .Xr camcontrol 8 ,
 101 .Xr iscontrol 8
 102 .Sh STANDARDS
 103 iSCSI RFC 3720
 104 .\" .Sh HISTORY
 105 .Sh AUTHORS
 106 This software was written by Daniel Braniss <danny@cs.huji.ac.il>
 107 .Sh BUGS
 108 The lun discovery method is old-fashioned.