projects / dragonfly.git / blame
| Commit | Line | Data |
|---|---|---|
| e25c779e MD |
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 | .\" | |
| ef8e7823 | 25 | .\" $FreeBSD: src/share/man/man4/iscsi_initiator.4,v 1.2 2007/07/24 18:08:16 brueffer Exp $ |
| e25c779e | 26 | .\" |
| ef8e7823 | 27 | .Dd August 24, 2009 |
| e25c779e | 28 | .Dt ISCSI_INITIATOR 4 |
| fb5b3747 | 29 | .Os |
| e25c779e MD |
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 "the following are informative only:" | |
| 64 | .It Va net.iscsi.driver_version | |
| 65 | the current version of the driver. | |
| 66 | .It Va net.iscsi.sessions | |
| 67 | the number of current active sessions. | |
| 68 | .It Va net.iscsi.n.targetname | |
| 69 | is the targe name of session | |
| 70 | .Em n . | |
| 71 | .It Va net.iscsi.n.targeaddress | |
| 72 | is the IP address of the target of session | |
| 73 | .Em n . | |
| 74 | .It Va net.iscsi.n.stats | |
| 75 | are some statistics for session | |
| d66f7d85 | 76 | .Em n |
| e25c779e MD |
77 | .It Va net.iscsi.n.pid |
| 78 | is the | |
| 79 | .Em "process id" | |
| 80 | of the userland side of session | |
| 81 | .Em n , | |
| 82 | see | |
| 83 | .Xr iscontrol 8 . | |
| 84 | .El | |
| 85 | .Sh FILES | |
| 86 | The | |
| 87 | .Nm | |
| 88 | driver creates the following: | |
| e25c779e | 89 | .Pp |
| ef8e7823 | 90 | .Bl -tag -width ".Pa /dev/iscsi%dxx" -compact |
| e25c779e MD |
91 | .It Pa /dev/iscsi |
| 92 | used to create new sessions. | |
| 93 | .It Pa /dev/iscsi%d | |
| 94 | for each new session. | |
| 95 | .El | |
| 96 | .Sh SEE ALSO | |
| 97 | .Xr cam 4 , | |
| 98 | .Xr camcontrol 8 , | |
| 99 | .Xr iscontrol 8 | |
| 100 | .Sh STANDARDS | |
| 101 | iSCSI RFC 3720 | |
| 102 | .\" .Sh HISTORY | |
| 103 | .\" .Sh AUTHORS | |
| 104 | .Sh BUGS | |
| 105 | The lun discovery method is old-fashioned. |