iscsi_manage.8

iscsi源代码 UNH的progect 有initiator端和target端的源码

.\" /***************************************************************************
.\"     Copyright 2003-2004 UNH Interoperability Lab
.\" ***************************************************************************/
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ISCSI_MANAGE 8"
.TH ISCSI_MANAGE 8 "20 Jul 2004" Linux "UNH-iSCSI"
.SH "NAME"
iscsi_manage \- a tool to configure parameters and options for the UNH iSCSI
initiator and target modules

.SH "SYNOPSIS"

iscsi_manage\ \ role\ \ action\ \ [host=number]\ \ [target=number]\ \ [parameter[=value]]*

.SH "DESCRIPTION"
.PP
iscsi_manage is a tool to configure parameters and options for the UNH iSCSI
initiator and target modules. 
.PP
iscsi_manage allows a user to
change the default value associated with an option or parameter,
and for iSCSI negotiable parameters, it also allows a user to
set the type of negotiation to be performed for that parameter.

.SH OPTIONS
.PP
The iscsi_manage command is invoked with two mandatory arguments, followed
by any number of optional arguments in any order.
The [parameter[=value]] argument can be repeated any number of times.
\fB
.IP "role" 4
\fR
This mandatory first argument determines the module that is being 
configured.
.Vb 2
init   \- configure the UNH iSCSI initiator module
target \- configure the UNH iSCSI target module
.Ve
\fB
.IP "action" 4
\fR
This mandatory second argument specifies the operation to be performed on 
the option parameter.  It can be one of the following:
.Vb 7
\&set     \- sets a parameter's value and its negotiation type so that
          the parameter will be negotiated and its value can be
          changed by negotiation.
\&setr    \- sets a parameter's value and its negotiation type so that
          the parameter will be negotiated but its value cannot be
          changed by negotiation.
\&setp    \- sets a parameter's value and its negotiation type so that
          the parameter will not be negotiated.
\&unset   \- undoes a previous "set", "setr" or "setp".
\&restore \- restores the value and negotiation type of all parameters
          with the default set of values (i.e., the set of values
          the parameters took when the module was first installed).
          No "parameter=value" argument should follow this action.
\&force   \- forces options for the local module operation.
\&snack   \- sets options related to the local snack interface.
.Ve
\fB
.IP "host=value" 
\fR
This argument is optional, with a default host value of 0 if not given.
If the value of the "role" argument is "init",
this specifies the SCSI Host Adapter (HBA)
number assigned by the kernel to the iSCSI initiator module. 
This HBA number can be determined by doing: 
.Vb 1
\&     ls /proc/scsi/iscsi_initiator/
.Ve
If the value of the "role" argument is "target",
this specifies the target number 
assigned by the SCSI target Mid-Level to the iSCSI target.
\fB
.IP "[target=id]" 
\fR
This argument is optional, with a default target value of 0 if not given.
This parameter refers to the target (session) id being 
configured.
\fB
.IP "parameter=value" 4
\fR
At least one occurrence of this argument must be given for all actions
except "restore", when it must NOT be given at all.

In all of the following, a <number> can be a decimal number (i.e., 0, 1,
47, 589, etc.) or a hexadecimal number (i.e., 0x1a, 0xffff, etc.).
Also in all of the following, a <boolean-value> is the case-sensitive
string "Yes" or "No" (without the quote marks).

For the "set", "setr", "setp" and "unset" values for action, this
mandatory argument
specifies the name of a parameter and a value or list of
values with which it is to be configured.
The possible forms of this argument are given next
(names are case-sensitive):

.Vb 28
\&AuthMethod=<list-of-values>
\&DataDigest=<list-of-values>
\&DataPDUInOrder=<boolean-value>
\&DataSequenceInOrder=<boolean-value>
\&DefaultTime2Retain=<numerical-value-0-to-3600>
\&DefaultTime2Wait=<numerical-value-0-to-3600>
\&ErrorRecoveryLevel=<numerical-value-0-to-1>
\&FirstBurstLength=<numerical-value-512-to-(2**24-1)>
\&HeaderDigest=<list-of-values>
\&IFMarker=<boolean-value>
\&IFMarkInt=<numeric-range-from-1-to-65535>
\&IFMarkInt=<numeric-value-from-1-to-65535>|Reject
\&ImmediateData=<boolean-value>
\&InitialR2T=<boolean-value>
\&InitiatorAlias=<iSCSI-local-name-value>
\&InitiatorName=<iSCSI-name-value>
\&MaxBurstLength=<numerical-value-512-to-(2**24-1)>
\&MaxConnections=<numerical-value-from-1-to-65535>
\&MaxOutstandingR2T=<numerical-value-from-1-to-65535>
\&MaxRecvDataSegmentLength=<numerical-value-512-to-(2**24-1)>
\&OFMarker=<boolean-value>
\&OFMarkInt=<numeric-range-from-1-to-65535>
\&OFMarkInt=<numeric-value-from-1-to-65535>|Reject
\&SessionType=Discovery|Normal
\&TargetAddress=<hostname-or-ipaddress>[:<tcp-port>],<portal-number>
\&TargetAlias=<iSCSI-local-name-value>
\&TargetName=<iSCSI-name-value>
\&TargetPortalGroupTag=<16-bit-binary-value>
.Ve
and
.Vb 1
\&X<#><IANA-registered-string>=<iSCSI-name-value>
.Ve
.PP
For more details about the parameters, please refer to 
Sections 3, 11 and 12, and Appendix A, of
the iSCSI 1.0 Protocol Draft from the IP Storage Working 
Group [http://www.ietf.org/internet-drafts/draft-ietf-ips-iscsi_20.txt].

.PP
When the action is "force", the parameter=value argument has one of the forms: 
.Vb 3
\&    <option>
\&    <option>=<number>
\&    <option>=<string>
.Ve

The acceptable case-sensitive options are (unless mentioned otherwise,
an option can be used on either the initiator or target module):
.IP "s" 4
Forces login negotiation to enter security parameter negotiation phase,
even if there are no security parameters to negotiate.
.IP "o" 4
Forces login negotiation to enter operational parameter negotiation phase,
even if there are no operational parameters to negotiate.
.IP "f" 4
Forces the initiator to use flat space addressing method when packing
a LUN value into the LUN field of a PDU.  This method enables the 
LUN value to occupy 14 bits, representing up to 16384 devices.
Without this option, the peripheral device addressing method is used in
packing the LUN field, which limits the LUN value to 8 bits, representing
up to 256 devices.  (Initiator only, illegal on target.)
.IP "r" 4
Forces the responder during negotiations to always reply to any offer,
even if the response is optional. Without this option, optional