mirror of
https://github.com/opnsense/src.git
synced 2026-06-11 01:30:30 -04:00
First round of cleanups.
Approved by: re (blanket)
This commit is contained in:
Christian Brueffer
parent
f62e5595fd
commit
064d25a08a
3 changed files with 48 additions and 34 deletions
|
|
@ -45,14 +45,15 @@ use of the SCSI protocol over TCP/IP networks,
|
|||
the
|
||||
.Nm
|
||||
program is the userland side of an iSCSI session, see
|
||||
iscsi_initiator(4).
|
||||
.Xr iscsi_initiator 4 .
|
||||
It has 2 modes of operation, if -d (discovery session) is specified,
|
||||
it will print out the
|
||||
.Em target names
|
||||
returned by the target and exit.
|
||||
In the second mode, it will, after a succesful login/negotiation, run
|
||||
In the second mode, it will, after a successful login/negotiation, run
|
||||
in daemon mode, monitoring the connection, and will try to reconnect
|
||||
in case of a network/target failure. It will terminate/logout the session
|
||||
in case of a network/target failure.
|
||||
It will terminate/logout the session
|
||||
when a SIGHUP signal is received.
|
||||
The flags are as follows:
|
||||
.Bl -tag -width variable=value
|
||||
|
|
@ -65,17 +66,21 @@ and exit.
|
|||
.It Fl c Ar file
|
||||
a file containing configuration
|
||||
.Em key-options ,
|
||||
see iscsi.conf(5)
|
||||
see
|
||||
.Xr iscsi.conf 5
|
||||
.It Fl n Ar nickname
|
||||
if
|
||||
.Sy -c file
|
||||
is specified, then search for the block named
|
||||
.Em nickname
|
||||
in that file, see iscsi.conf(5)
|
||||
in that file, see
|
||||
.Xr iscsi.conf 5
|
||||
.It Fl t Ar target
|
||||
is the target's IP address or name
|
||||
.It Ar variable Ns = Ns Ar value
|
||||
see iscsi.conf(5) for the complete list of variables/options and their
|
||||
see
|
||||
.Xr iscsi.conf 5
|
||||
for the complete list of variables/options and their
|
||||
possible values.
|
||||
.El
|
||||
.Sh EXAMPLES
|
||||
|
|
@ -87,21 +92,23 @@ with the target and
|
|||
print to stdout the list of available targetnames/targetadresses.
|
||||
Note: this listing does not necessarily mean availability, since
|
||||
depending on the target configuration, a discovery session might
|
||||
not need login/access permition, but a
|
||||
not need login/access permission, but a
|
||||
.Em full session
|
||||
certainly does.
|
||||
.sp
|
||||
.Dl iscontrol -c /etc/iscsi.conf -n myiscsi
|
||||
.Pp
|
||||
will read options from file /etc/iscsi.conf, use the targetaddress
|
||||
will read options from
|
||||
.Pa /etc/iscsi.conf ,
|
||||
use the targetaddress
|
||||
found in the block nicknamed myiscsi, login and negotiate
|
||||
whatever options are specified, and start an iscsi-session.
|
||||
.Sh SEE ALSO
|
||||
.Xr iscsi_initiator 4 ,
|
||||
.Xr iscsi.conf 5 ,
|
||||
.Xr camcontrol 8 ,
|
||||
.Xr da 4 ,
|
||||
.Xr sa 4
|
||||
.Xr iscsi_initiator 4 ,
|
||||
.Xr sa 4 ,
|
||||
.Xr iscsi.conf 5 ,
|
||||
.Xr camcontrol 8
|
||||
.Sh STANDARDS
|
||||
RFC 3720
|
||||
.\"Sh HISTORY
|
||||
|
|
@ -110,7 +117,7 @@ RFC 3720
|
|||
should probably load the iscsi_initiator module if needed.
|
||||
.br
|
||||
Not all functions/specifications have been implemented yet, noticeably
|
||||
missing are the Task Management Funtions.
|
||||
missing are the Task Management Functions.
|
||||
The error recovery, though not
|
||||
.Em fully compliant
|
||||
does a brave effort to recover from network disconnects.
|
||||
|
|
|
|||
|
|
@ -35,7 +35,8 @@ The file
|
|||
.Nm ,
|
||||
is read by the
|
||||
.Xr iscontrol 8
|
||||
program, it contains declarations and parameter/key-options.
|
||||
program.
|
||||
It contains declarations and parameter/key-options.
|
||||
The syntax is very simple,
|
||||
.D1 Li variable = value;
|
||||
and they can be grouped via a
|
||||
|
|
@ -55,13 +56,16 @@ The following are specified in the iSCSI RFC 3720,
|
|||
for a full description see sections 11/12 of the RFC.
|
||||
.Bl -tag -width MaxConnections
|
||||
.It Cm AuthMethod
|
||||
current only supported authentication method is CHAP, with
|
||||
digest either MD5 or SHA. Default is none.
|
||||
currently only supported authentication method is CHAP, with
|
||||
digest either MD5 or SHA.
|
||||
Default is none.
|
||||
.It Cm HeaderDigest
|
||||
a
|
||||
.Em digest
|
||||
is calculated on the header of all iSCSI PDUs, and
|
||||
checked. Only CRC32C is implemented. Default is none.
|
||||
checked.
|
||||
Only CRC32C is implemented.
|
||||
Default is none.
|
||||
.It Cm DataDigest
|
||||
same as for HeaderDigest, but on the data part of the iSCSI PDU.
|
||||
.It Cm MaxConnections
|
||||
|
|
@ -118,7 +122,7 @@ option.
|
|||
.It Cm ErrorRecoveryLevel
|
||||
Only level 0 is supported.
|
||||
.It Cm SessionType
|
||||
either Discovery or Normal, default is Normal, see the
|
||||
either Discovery or Normal, default is Normal, see the
|
||||
.Fl d
|
||||
flag of
|
||||
.Cm iscontrol .
|
||||
|
|
@ -128,7 +132,7 @@ The following are not specified in the
|
|||
.Sy RFC 3720
|
||||
.Bl -tag -width sockbufsize
|
||||
.It Cm port
|
||||
The iscsi port used by the iscsi protocol, defaults to 3260.
|
||||
The iSCSI port used by the iSCSI protocol, defaults to 3260.
|
||||
.It Cm tags
|
||||
Sets the
|
||||
.Em tag opening
|
||||
|
|
@ -137,23 +141,25 @@ to the value specified.
|
|||
overrides the compiled value of
|
||||
.Sy luns ,
|
||||
see
|
||||
.Xr iscsi_initiator 4 . This value can only be reduced.
|
||||
.Xr iscsi_initiator 4 .
|
||||
This value can only be reduced.
|
||||
.It Cm sockbufsize
|
||||
sets the receiver and transmitter socket buffer size to
|
||||
.Em size,
|
||||
in kilobites. The default is 128.
|
||||
in kilobytes.
|
||||
The default is 128.
|
||||
.El
|
||||
.sp
|
||||
If
|
||||
.Em AutheMethod
|
||||
.Em AuthMethod
|
||||
is set to
|
||||
.Cm CHAP ,
|
||||
then the following must also be set:
|
||||
.Bl -tag -width chapSecret
|
||||
.It Cm chapSecret
|
||||
this
|
||||
.Em shared-secret.
|
||||
Can be either an ascci string (e.g. hello world), a hex string (e.g
|
||||
.Em shared-secret .
|
||||
Can be either an ASCII string (e.g. hello world), a hex string (e.g
|
||||
0xababcd0987654321...), or base64 string (eg 0b...)
|
||||
.It Cm chapIName
|
||||
the chap-name, defaults to
|
||||
|
|
@ -188,7 +194,7 @@ chaptest {
|
|||
}
|
||||
.Ed
|
||||
.Sh ERRORS
|
||||
The parsing is very primitive, so don't expect - at the moment - any
|
||||
The parsing is very primitive, so do not expect - at the moment - any
|
||||
error messages.
|
||||
.Sh SEE ALSO
|
||||
.Xr iscsi_initiator 4 ,
|
||||
|
|
|
|||
|
|
@ -47,11 +47,12 @@ iscsi_initiator_load="YES"
|
|||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
implements the kernel side of the Internet ISCSI (iSCSI) network
|
||||
implements the kernel side of the Internet SCSI (iSCSI) network
|
||||
protocol standard, the user land companion is
|
||||
.Xr iscontrol 8, and permits access to remote
|
||||
.Xr iscontrol 8 ,
|
||||
and permits access to remote
|
||||
.Em virtual
|
||||
SCSI devices via the
|
||||
SCSI devices via
|
||||
.Xr cam 4 .
|
||||
.Sh SYSCTL VARIABLES
|
||||
.Bl -tag -width ".Va net.iscsi.n.targeaddress"
|
||||
|
|
@ -83,21 +84,21 @@ see
|
|||
.El
|
||||
.Sh FILES
|
||||
The
|
||||
.NM
|
||||
.Nm
|
||||
driver creates the following:
|
||||
.Bl -tag -width ".Pa /dev/iscsi%dxx" -compact
|
||||
.Pp
|
||||
.It Pa /dev/iscsi
|
||||
used to creat new sessions.
|
||||
used to create new sessions.
|
||||
.It Pa /dev/iscsi%d
|
||||
for each new session.
|
||||
.El
|
||||
.\" .Sh ERRORS
|
||||
.Sh SEE ALSO
|
||||
.Xr iscontrol 8 ,
|
||||
.Xr cam 4 ,
|
||||
.Xr camcontrol 8
|
||||
.Xr camcontrol 8 ,
|
||||
.Xr iscontrol 8
|
||||
.Sh STANDARDS
|
||||
ISCSI RFC 3720
|
||||
iSCSI RFC 3720
|
||||
.\" .Sh HISTORY
|
||||
.\" .Sh AUTHORS
|
||||
.Sh BUGS
|
||||
|
|
|
|||
Loading…
Reference in a new issue