summaryrefslogtreecommitdiff
path: root/usr/src/man/man1m/iscsiadm.1m
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man1m/iscsiadm.1m')
-rw-r--r--usr/src/man/man1m/iscsiadm.1m97
1 files changed, 9 insertions, 88 deletions
diff --git a/usr/src/man/man1m/iscsiadm.1m b/usr/src/man/man1m/iscsiadm.1m
index e1e61604a7..781ce9f8d0 100644
--- a/usr/src/man/man1m/iscsiadm.1m
+++ b/usr/src/man/man1m/iscsiadm.1m
@@ -3,7 +3,7 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH iscsiadm 1M "16 Jul 2009" "SunOS 5.11" "System Administration Commands"
+.TH ISCSIADM 1M "Jul 16, 2009"
.SH NAME
iscsiadm \- enable management of iSCSI initiators
.SH SYNOPSIS
@@ -37,45 +37,37 @@ The \fBiscsiadm\fR command supports the following subcommands, which are
described in detail in subsections that follow:
.sp
.ne 2
-.mk
.na
\fB\fBadd\fR\fR
.ad
.RS 10n
-.rt
Adds element(s) to an object.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBlist\fR\fR
.ad
.RS 10n
-.rt
Lists element(s) of an object.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBmodify\fR\fR
.ad
.RS 10n
-.rt
Modifies attributes of an object.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBremove\fR\fR
.ad
.RS 10n
-.rt
Removes an element from an object.
.RE
@@ -95,7 +87,7 @@ The syntax for the \fBadd\fR subcommand is:
.sp
.in +2
.nf
-# iscsiadm add \fIdirect_object\fR [\fIoperands\fR...]
+# iscsiadm add \fIdirect_object\fR [\fIoperands\fR...]
.fi
.in -2
@@ -104,7 +96,6 @@ The syntax for the \fBadd\fR subcommand is:
The \fBadd\fR subcommand adds the following \fIdirect_object\fRs:
.sp
.ne 2
-.mk
.na
\fB\fBdiscovery-address\fR \fIdiscovery-address\fR [...]\fR
.ad
@@ -131,7 +122,6 @@ If \fIport\fR is not specified, the default of 3260 will be used.
.sp
.ne 2
-.mk
.na
\fB\fBisns-server\fR \fIisns-server\fR [...]\fR
.ad
@@ -159,7 +149,6 @@ If a port is not specified, the default of 3205 is used.
.sp
.ne 2
-.mk
.na
\fB\fBstatic-config\fR \fIstatic_target\fR [...]\fR
.ad
@@ -196,7 +185,6 @@ The syntax for the \fBlist\fR subcommand is:
The \fBlist\fR subcommand displays data for the following \fIdirect-object\fRs:
.sp
.ne 2
-.mk
.na
\fB\fBdiscovery\fR\fR
.ad
@@ -226,7 +214,6 @@ SendTargets
.sp
.ne 2
-.mk
.na
\fB\fBinitiator-node\fR\fR
.ad
@@ -241,7 +228,6 @@ parameter values that differ from the parameter values on the initiator node.
.sp
.ne 2
-.mk
.na
\fB\fBstatic-config\fR [\fIstatic_target\fR[, ...]]\fR
.ad
@@ -253,7 +239,6 @@ targets are specified, all statically discovered targets.
.sp
.ne 2
-.mk
.na
\fB\fBtarget\fR [\fB-S\fR] [\fB-v\fR] [\fItarget\fR[, ...]]\fR
.ad
@@ -308,7 +293,6 @@ remove target-param\fR.
.sp
.ne 2
-.mk
.na
\fB\fBtarget-param\fR [\fB-v\fR] \fItarget\fR [...]\fR
.ad
@@ -319,7 +303,6 @@ Lists a target's default and user-defined parameters.
.sp
.ne 2
-.mk
.na
\fB\fBdiscovery-address\fR [\fB-v\fR] [\fIdiscovery-address\fR[, ...]]\fR
.ad
@@ -336,7 +319,6 @@ tags (TPGT), if applicable.
.sp
.ne 2
-.mk
.na
\fB\fBisns-server\fR [\fB-v\fR] [\fIisns-server\fR[, ...]]\fR
.ad
@@ -358,7 +340,7 @@ The syntax for the \fBmodify\fR subcommand is:
.sp
.in +2
.nf
-# iscsiadm modify \fIdirect_object\fR [\fIoptions\fR]
+# iscsiadm modify \fIdirect_object\fR [\fIoptions\fR]
.fi
.in -2
@@ -367,7 +349,6 @@ The syntax for the \fBmodify\fR subcommand is:
The \fBmodify\fR subcommand supports the following \fIdirect_object\fRs:
.sp
.ne 2
-.mk
.na
\fB\fBdiscovery\fR [\fIoptions\fR]\fR
.ad
@@ -380,7 +361,6 @@ targets that have already been discovered by that method.
Options for \fBmodify discovery\fR are as follows:
.sp
.ne 2
-.mk
.na
\fB\fB-i\fR, \fB-iSNS\fR \fBenable\fR | \fBdisable\fR\fR
.ad
@@ -391,7 +371,6 @@ Enable or disable iSNS discovery.
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR, \fB-\fR\fB-static\fR \fBenable\fR | \fBdisable\fR\fR
.ad
@@ -402,7 +381,6 @@ Enable or disable static discovery.
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR, \fB-\fR\fB-sendtargets\fR \fBenable\fR | \fBdisable\fR\fR
.ad
@@ -415,7 +393,6 @@ Enable or disable SendTargets discovery.
.sp
.ne 2
-.mk
.na
\fB\fBinitiator-node\fR [\fIoptions\fR]\fR
.ad
@@ -471,7 +448,6 @@ modify only the following initiator-node options:
Options for \fBmodify initiator-node\fR are as follows:
.sp
.ne 2
-.mk
.na
\fB\fB-A\fR, \fB-\fR\fB-node-alias\fR \fI<initiator node alias>\fR\fR
.ad
@@ -482,7 +458,6 @@ Modifies the initiator node alias. Maximum length of 223 characters.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR, \fB-\fR\fB-authentication\fR \fBchap\fR | \fBnone\fR\fR
.ad
@@ -493,7 +468,6 @@ Sets the authentication mode.
.sp
.ne 2
-.mk
.na
\fB\fB-C\fR, \fB-\fR\fB-CHAP-secret\fR\fR
.ad
@@ -505,7 +479,6 @@ characters; minimum required length is 12 characters.
.sp
.ne 2
-.mk
.na
\fB\fB-c\fR, \fB--configured-sessions\fR \fI<num_sessions>\fR | \fI<IP
address>\fR[,\fI<IP address>\fR\&...]\fR
@@ -519,7 +492,6 @@ multipathing feature described in \fBscsi_vhci\fR(7D).
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR, \fB--datadigest\fR \fBnone\fR | \fBCRC32\fR\fR
.ad
@@ -530,7 +502,6 @@ Sets whether CRC32 is enabled to check SCSI data transfers.
.sp
.ne 2
-.mk
.na
\fB\fB-H\fR, \fB-\fR\fB-CHAP-name\fR \fICHAP name\fR\fR
.ad
@@ -544,7 +515,6 @@ CHAP username is displayed with the command \fBiscsiadm list initiator-node\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-h\fR, \fB--headerdigest\fR \fBnone\fR | \fBCRC32\fR\fR
.ad
@@ -555,7 +525,6 @@ Sets whether CRC32 is enabled to check SCSI packet headers.
.sp
.ne 2
-.mk
.na
\fB\fB-N\fR, \fB-\fR\fB-node-name\fR \fI<initiator node name>\fR\fR
.ad
@@ -574,7 +543,6 @@ iSCSI network.
.sp
.ne 2
-.mk
.na
\fB\fB-P\fR, \fB--radius-shared-secret\fR (exclusive)\fR
.ad
@@ -585,7 +553,6 @@ Sets the RADIUS shared secret.
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR, \fB--radius-access\fR \fBenable\fR | \fBdisable\fR\fR
.ad
@@ -596,7 +563,6 @@ Sets whether a RADIUS server will be used.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR, \fB--radius-server\fR \fI<IP address>\fR[:\fI<port>\fR]\fR
.ad
@@ -607,7 +573,6 @@ Sets the IP address and port of the radius server to be used.
.sp
.ne 2
-.mk
.na
\fB\fB-T\fR, \fB-\fR\fB-tunable-param\fR
<<\fItunable-prop\fR>=<\fIvalue\fR>, ...>\fR
@@ -626,7 +591,6 @@ knowledge of the parameter's impact within the iSCSI network.
Supported tunable-prop options are:
.sp
.ne 2
-.mk
.na
\fB\fBrecv-login-rsp-timeout\fR\fR
.ad
@@ -641,7 +605,6 @@ Valid value is from 0 to 60*60, default to 60 seconds.
.sp
.ne 2
-.mk
.na
\fB\fBconn-login-max\fR\fR
.ad
@@ -656,7 +619,6 @@ given time window. Valid value is from 0 to 60*60, default to 180 seconds.
.sp
.ne 2
-.mk
.na
\fB\fBpolling-login-delay\fR\fR
.ad
@@ -675,7 +637,6 @@ Valid value is from 0 to 60*60, default to 60 seconds.
.sp
.ne 2
-.mk
.na
\fB\fBtarget-param\fR [\fIoptions\fR] \fItarget\fR\fR
.ad
@@ -694,7 +655,6 @@ target-param\fR command on that target. The options \fB-C\fR and
Options for \fBmodify target-param\fR are as follows:
.sp
.ne 2
-.mk
.na
\fB\fB-B\fR, \fB-\fR\fB-bi-directional-authentication enable | disable\fR\fR
.ad
@@ -706,7 +666,6 @@ bidirectional authentication for the specified target.
.sp
.ne 2
-.mk
.na
\fB\fB-C\fR, \fB-\fR\fB-CHAP-secret\fR\fR
.ad
@@ -718,7 +677,6 @@ acceptable length is 16 characters.
.sp
.ne 2
-.mk
.na
\fB\fB-c\fR, \fB-\fR\fB-configured-sessions\fR \fI<num_sessions>\fR | \fI<IP
address>\fR[,\fI<IP address>\fR\&...]\fR
@@ -732,7 +690,6 @@ multipathing feature described in \fBscsi_vhci\fR(7D).
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR, \fB-\fR\fB-datadigest\fR \fBnone\fR | \fBCRC32\fR\fR
.ad
@@ -743,7 +700,6 @@ Sets whether CRC32 is enabled or disabled for the data.
.sp
.ne 2
-.mk
.na
\fB\fB-H\fR, \fB-\fR\fB-CHAP-name\fR \fICHAP name\fR\fR
.ad
@@ -758,7 +714,6 @@ the command \fBiscsiadm list initiator-node\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-h\fR, \fB-\fR\fB-headerdigest\fR \fBnone\fR | \fBCRC32\fR\fR
.ad
@@ -769,7 +724,6 @@ Sets whether CRC32 is enabled or disabled for the header.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR, \fB-\fR\fB-login-param\fR\fR
.ad
@@ -787,111 +741,91 @@ The login parameters are derived from iSCSI proposed standard RFC 3720. Valid
values are:
.sp
.ne 2
-.mk
.na
\fB\fBdataseqinorder\fR\fR
.ad
.RS 22n
-.rt
\fByes\fR or \fBno\fR
.RE
.sp
.ne 2
-.mk
.na
\fB\fBdefaulttime2retain\fR\fR
.ad
.RS 22n
-.rt
0-3600
.RE
.sp
.ne 2
-.mk
.na
\fB\fBdefaulttime2wait\fR\fR
.ad
.RS 22n
-.rt
0-3600
.RE
.sp
.ne 2
-.mk
.na
\fB\fBfirstburstlength\fR\fR
.ad
.RS 22n
-.rt
512 to 2^24-1
.RE
.sp
.ne 2
-.mk
.na
\fB\fBimmediatedata\fR\fR
.ad
.RS 22n
-.rt
\fByes\fR or \fBno\fR
.RE
.sp
.ne 2
-.mk
.na
\fB\fBinitialr2t\fR\fR
.ad
.RS 22n
-.rt
\fByes\fR or \fBno\fR
.RE
.sp
.ne 2
-.mk
.na
\fB\fBmaxburstlength\fR\fR
.ad
.RS 22n
-.rt
512 to 2^24-1
.RE
.sp
.ne 2
-.mk
.na
\fB\fBdatapduinorder\fR\fR
.ad
.RS 22n
-.rt
\fByes\fR or \fBno\fR
.RE
.sp
.ne 2
-.mk
.na
\fB\fBmaxoutstandingr2t\fR\fR
.ad
.RS 22n
-.rt
1 to 65535
.RE
.sp
.ne 2
-.mk
.na
\fB\fBmaxrecvdataseglen\fR\fR
.ad
.RS 22n
-.rt
512 to 2^24-1
.RE
@@ -899,7 +833,6 @@ values are:
.sp
.ne 2
-.mk
.na
\fB\fB-T\fR, \fB-\fR\fB-tunable-param\fR
<<\fItunable-prop\fR>=<\fIvalue\fR>, ...>\fR
@@ -918,7 +851,6 @@ knowledge of the parameter's impact within the iSCSI network.
Supported \fItunable-prop\fR options are:
.sp
.ne 2
-.mk
.na
\fB\fBrecv-login-rsp-timeout\fR\fR
.ad
@@ -933,7 +865,6 @@ Valid value is from 0 to 60*60, default to 60 seconds.
.sp
.ne 2
-.mk
.na
\fB\fBconn-login-max\fR\fR
.ad
@@ -948,7 +879,6 @@ given time window. Valid value is from 0 to 60*60, default to 180 seconds.
.sp
.ne 2
-.mk
.na
\fB\fBpolling-login-delay\fR\fR
.ad
@@ -972,7 +902,7 @@ The syntax for the \fBremove\fR subcommand is:
.sp
.in +2
.nf
-# iscsiadm remove \fIdirect_object\fR
+# iscsiadm remove \fIdirect_object\fR
.fi
.in -2
@@ -981,7 +911,6 @@ The syntax for the \fBremove\fR subcommand is:
The \fBremove\fR subcommand supports the following \fIdirect_object\fRs:
.sp
.ne 2
-.mk
.na
\fB\fBdiscovery-address\fR \fIdiscovery-address\fR, ...\fR
.ad
@@ -1009,7 +938,6 @@ There are no options associated with this direct object.
.sp
.ne 2
-.mk
.na
\fB\fBisns-server\fR \fIisns-server\fR, ...\fR
.ad
@@ -1037,7 +965,6 @@ There are no options associated with this direct object.
.sp
.ne 2
-.mk
.na
\fB\fBstatic-config\fR \fIstatic_target\fR, ...\fR
.ad
@@ -1061,7 +988,6 @@ There are no options associated with this direct object.
.sp
.ne 2
-.mk
.na
\fB\fBtarget-param\fR \fItarget-name\fR\fR
.ad
@@ -1092,23 +1018,19 @@ performance when communicating with the iSCSI target device.
The following generic options are supported:
.sp
.ne 2
-.mk
.na
\fB\fB-V\fR, \fB-\fR\fB-version\fR\fR
.ad
.RS 17n
-.rt
Displays version information. Stops interpretation of subsequent arguments.
.RE
.sp
.ne 2
-.mk
.na
\fB\fB-?\fR, \fB-\fR\fB-help\fR\fR
.ad
.RS 17n
-.rt
Displays help information. Can be used following an \fBiscsiadm\fR command with
no arguments, following a subcommand, or following a subcommand-direct object
combination. Responds with help information appropriate for your entry. For
@@ -1438,13 +1360,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.TS
-tab() box;
-cw(2.75i) |cw(2.75i)
-lw(2.75i) |lw(2.75i)
-.
-ATTRIBUTE TYPEATTRIBUTE VALUE
+box;
+c | c
+l | l .
+ATTRIBUTE TYPE ATTRIBUTE VALUE
_
-Interface StabilityCommitted
+Interface Stability Committed
.TE
.SH SEE ALSO
generated by cgit v1.2.3 (git 2.39.1) at 2025-06-22 18:58:09 +0000