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