8980 BIOS clock is sometimes one hour fast
[unleashed.git] / usr / src / man / man1m / iscsiadm.1m
blob781ce9f8d0502ed81a27a88caba817c2ebb967ef
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" 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
5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH ISCSIADM 1M "Jul 16, 2009"
7 .SH NAME
8 iscsiadm \- enable management of iSCSI initiators
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBiscsiadm\fR \fIsubcommand\fR \fIdirect-object\fR [\fIoptions\fR] [\fIoperand\fR]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBiscsiadm\fR command enables management of the iSCSI (Internet SCSI)
19 initiator on a host. \fBiscsiadm\fR is implemented as a set of subcommands,
20 many with their own options, which are described in the section for that
21 subcommand. Options not associated with a particular subcommand are described
22 under OPTIONS.
23 .sp
24 .LP
25 \fBiscsiadm\fR works only when the following service is online:
26 .sp
27 .in +2
28 .nf
29 svc:/network/iscsi/initiator:default
30 .fi
31 .in -2
32 .sp
34 .sp
35 .LP
36 The \fBiscsiadm\fR command supports the following subcommands, which are
37 described in detail in subsections that follow:
38 .sp
39 .ne 2
40 .na
41 \fB\fBadd\fR\fR
42 .ad
43 .RS 10n
44 Adds element(s) to an object.
45 .RE
47 .sp
48 .ne 2
49 .na
50 \fB\fBlist\fR\fR
51 .ad
52 .RS 10n
53 Lists element(s) of an object.
54 .RE
56 .sp
57 .ne 2
58 .na
59 \fB\fBmodify\fR\fR
60 .ad
61 .RS 10n
62 Modifies attributes of an object.
63 .RE
65 .sp
66 .ne 2
67 .na
68 \fB\fBremove\fR\fR
69 .ad
70 .RS 10n
71 Removes an element from an object.
72 .RE
74 .sp
75 .LP
76 The \fBiscsiadm\fR subcommands operate on a \fIdirect-object\fR. These are
77 described in the section for each subcommand.
78 .sp
79 .LP
80 The \fBiscsiadm\fR command supports the Internet Storage Name Service (iSNS)
81 for the discovery of iSCSI targets. The command supports the Challenge
82 Handshake Authentication Protocol (CHAP) for authentication.
83 .SS "\fBadd\fR Subcommand"
84 .sp
85 .LP
86 The syntax for the \fBadd\fR subcommand is:
87 .sp
88 .in +2
89 .nf
90 # iscsiadm add \fIdirect_object\fR [\fIoperands\fR...]
91 .fi
92 .in -2
94 .sp
95 .LP
96 The \fBadd\fR subcommand adds the following \fIdirect_object\fRs:
97 .sp
98 .ne 2
99 .na
100 \fB\fBdiscovery-address\fR \fIdiscovery-address\fR [...]\fR
102 .sp .6
103 .RS 4n
104 Adds a target to a list of discovery addresses. A discovery address (as in the
105 syntax shown below) is an IP \fIaddress\fR:\fIport\fR combination used in a
106 SendTargets discovery session. Using this discovery approach, a target device
107 can inform an initiator of the target address and target name of each target
108 exposed by that device. Connection to a target is not attempted unless the
109 SendTargets method of discovery has been enabled on the host. You enable this
110 method with the \fBmodify\fR subcommand.
112 The \fIdiscovery-address\fR parameter is formatted as:
114 .in +2
116 <\fIIP address\fR>[:\fIport\fR]
118 .in -2
120 If \fIport\fR is not specified, the default of 3260 will be used.
124 .ne 2
126 \fB\fBisns-server\fR \fIisns-server\fR [...]\fR
128 .sp .6
129 .RS 4n
130 Add an iSNS server to the list of iSNS server addresses. An iSNS server address
131 (specified in the syntax shown below) is an IP address-port combination used in
132 an iSNS discovery session. By using iSNS discovery, an iSNS server can provide
133 an initiator with information about a portal and the name of each target that
134 belongs to the same discovery domain as that of the initiator. Connection to
135 the iSNS server is not attempted unless the iSNS method of discovery has been
136 enabled on the host. You enable this method with the \fBmodify\fR subcommand,
137 described below.
139 The \fIisns-server\fR parameter is formatted as:
141 .in +2
143 \fIIP_address\fR[:\fIport\fR]
145 .in -2
147 If a port is not specified, the default of 3205 is used.
151 .ne 2
153 \fB\fBstatic-config\fR \fIstatic_target\fR [...]\fR
155 .sp .6
156 .RS 4n
157 Adds a target to the list of statically configured targets. A connection to the
158 target will not be attempted unless the static configuration method of
159 discovery has been enabled.
161 The \fIstatic_target\fR parameter is formatted as:
163 .in +2
165 \fI<target-name>\fR,\fI<target address>\fR[:\fIport-number\fR][,\fItpgt\fR]
167 .in -2
169 \fI<target-name>\fR can be up to 223 characters.
172 .SS "\fBlist\fR Subcommand"
175 The syntax for the \fBlist\fR subcommand is:
177 .in +2
179 # iscsiadm list \fIdirect-object\fR [\fIoptions\fR]
181 .in -2
185 The \fBlist\fR subcommand displays data for the following \fIdirect-object\fRs:
187 .ne 2
189 \fB\fBdiscovery\fR\fR
191 .sp .6
192 .RS 4n
193 Lists the discovery methods and their current activation state, enabled or
194 disabled. Discovery methods are:
195 .RS +4
197 .ie t \(bu
198 .el o
199 iSNS (Internet Storage Name Service)
201 .RS +4
203 .ie t \(bu
204 .el o
205 Static
207 .RS +4
209 .ie t \(bu
210 .el o
211 SendTargets
216 .ne 2
218 \fB\fBinitiator-node\fR\fR
220 .sp .6
221 .RS 4n
222 Lists information for the initiator node on the host. The iSCSI initiator node
223 represents a logical HBA and is a logical host connection point for iSCSI
224 targets. The parameter values listed in the response are default parameter
225 settings for the initiator. Each connected target for an initiator can have
226 parameter values that differ from the parameter values on the initiator node.
230 .ne 2
232 \fB\fBstatic-config\fR [\fIstatic_target\fR[, ...]]\fR
234 .sp .6
235 .RS 4n
236 Lists the target name and address for specified targets or, if no static
237 targets are specified, all statically discovered targets.
241 .ne 2
243 \fB\fBtarget\fR [\fB-S\fR] [\fB-v\fR] [\fItarget\fR[, ...]]\fR
245 .sp .6
246 .RS 4n
247 Lists a target's current parameters, connection state, and which method was
248 used for the target's discovery. Reports information for specified targets or,
249 if no targets are specified, all targets that have been discovered or have had
250 parameters modified by the \fBmodify target\fR subcommand.
252 When used with the \fB-S\fR option for a specified target, this subcommand
253 returns:
254 .RS +4
256 .ie t \(bu
257 .el o
258 target name
260 .RS +4
262 .ie t \(bu
263 .el o
264 logical unit number
266 .RS +4
268 .ie t \(bu
269 .el o
270 vendor ID
272 .RS +4
274 .ie t \(bu
275 .el o
276 product ID
278 .RS +4
280 .ie t \(bu
281 .el o
282 OS device name (for example, \fB/dev/rdsk/c0t2d0s0\fR)
284 The \fB-v\fR options gives more details, such as the current login parameters,
285 the detailed connection information, and the discovery method used to discover
286 the target.
288 A return of \fBNA\fR as the discovery method parameter indicates that the
289 target was created with a \fBiscsiadm modify target-param\fR command and does
290 not exist as a discovered object. To remove such targets, use \fBiscsiadm
291 remove target-param\fR.
295 .ne 2
297 \fB\fBtarget-param\fR [\fB-v\fR] \fItarget\fR [...]\fR
299 .sp .6
300 .RS 4n
301 Lists a target's default and user-defined parameters.
305 .ne 2
307 \fB\fBdiscovery-address\fR [\fB-v\fR] [\fIdiscovery-address\fR[, ...]]\fR
309 .sp .6
310 .RS 4n
311 Lists the \fBdiscovery-address\fR objects that have been added using the
312 \fBiscsiadm add discovery-address\fR subcommand.
314 When used with the \fB-v\fR option, lists all known targets at a specified
315 \fIdiscovery-address\fR. The \fB-v\fR option returns one or more target names
316 along with zero or more target addresses and associated target portal group
317 tags (TPGT), if applicable.
321 .ne 2
323 \fB\fBisns-server\fR [\fB-v\fR] [\fIisns-server\fR[, ...]]\fR
325 .sp .6
326 .RS 4n
327 Lists the \fBisns-server\fR objects that have been added using the
328 \fBiscsiadm\fR \fBadd\fR \fBisns-server\fR subcommand.
330 When used with the \fB-v\fR option, this subcommand lists all known targets at
331 a specified \fBisns-server\fR address. The \fB-v\fR option returns one of more
332 target names along with zero or more target addresses and associated target
333 portal group tags, if applicable.
336 .SS "\fBmodify\fR Subcommand"
339 The syntax for the \fBmodify\fR subcommand is:
341 .in +2
343 # iscsiadm modify \fIdirect_object\fR [\fIoptions\fR]
345 .in -2
349 The \fBmodify\fR subcommand supports the following \fIdirect_object\fRs:
351 .ne 2
353 \fB\fBdiscovery\fR [\fIoptions\fR]\fR
355 .sp .6
356 .RS 4n
357 Enabling a discovery method initiates a discovery using that method. Disabling
358 a discovery method that is currently enabled does not affect connections to any
359 targets that have already been discovered by that method.
361 Options for \fBmodify discovery\fR are as follows:
363 .ne 2
365 \fB\fB-i\fR, \fB-iSNS\fR \fBenable\fR | \fBdisable\fR\fR
367 .sp .6
368 .RS 4n
369 Enable or disable iSNS discovery.
373 .ne 2
375 \fB\fB-s\fR, \fB-\fR\fB-static\fR \fBenable\fR | \fBdisable\fR\fR
377 .sp .6
378 .RS 4n
379 Enable or disable static discovery.
383 .ne 2
385 \fB\fB-t\fR, \fB-\fR\fB-sendtargets\fR \fBenable\fR | \fBdisable\fR\fR
387 .sp .6
388 .RS 4n
389 Enable or disable SendTargets discovery.
395 .ne 2
397 \fB\fBinitiator-node\fR [\fIoptions\fR]\fR
399 .sp .6
400 .RS 4n
401 Modifies an initiator's properties. If a target is currently connected, this
402 operation can succeed. However, the modified set of parameters will not be in
403 effect for that target until an existing connection session no longer exists
404 and a new connection has been established. The options \fB-C\fR and
405 \fB-\fR\fB-CHAP-secret\fR require a CHAP secret entry in response to a prompt.
407 For iSCSI booting when the Solaris I/O multipathing feature (formerly known as
408 Sun StorEdge Traffic Manager [STMS] or MPxIO) is disabled, you can modify only
409 the following initiator-node options:
410 .RS +4
412 .ie t \(bu
413 .el o
414 \fB-r\fR, \fB--radius-server\fR
416 .RS +4
418 .ie t \(bu
419 .el o
420 \fB-R\fR, \fB--radius-access\fR
422 .RS +4
424 .ie t \(bu
425 .el o
426 \fB-P\fR, \fB--radius-shared-secret\fR
428 For iSCSI booting when the Solaris I/O multipathing feature is enabled, you can
429 modify only the following initiator-node options:
430 .RS +4
432 .ie t \(bu
433 .el o
434 \fB-h\fR, \fB--headerdigest\fR
436 .RS +4
438 .ie t \(bu
439 .el o
440 \fB-d\fR, \fB--datadigest\fR
442 .RS +4
444 .ie t \(bu
445 .el o
446 \fB-c\fR, \fB--configured-sessions\fR
448 Options for \fBmodify initiator-node\fR are as follows:
450 .ne 2
452 \fB\fB-A\fR, \fB-\fR\fB-node-alias\fR \fI<initiator node alias>\fR\fR
454 .sp .6
455 .RS 4n
456 Modifies the initiator node alias. Maximum length of 223 characters.
460 .ne 2
462 \fB\fB-a\fR, \fB-\fR\fB-authentication\fR \fBchap\fR | \fBnone\fR\fR
464 .sp .6
465 .RS 4n
466 Sets the authentication mode.
470 .ne 2
472 \fB\fB-C\fR, \fB-\fR\fB-CHAP-secret\fR\fR
474 .sp .6
475 .RS 4n
476 Sets the CHAP secret value. There is no default value. Maximum length is 16
477 characters; minimum required length is 12 characters.
481 .ne 2
483 \fB\fB-c\fR, \fB--configured-sessions\fR \fI<num_sessions>\fR | \fI<IP
484 address>\fR[,\fI<IP address>\fR\&...]\fR
486 .sp .6
487 .RS 4n
488 Sets the number of configured iSCSI sessions that will be created for each
489 iSCSI target. The feature should be used in combination with the Solaris I/O
490 multipathing feature described in \fBscsi_vhci\fR(7D).
494 .ne 2
496 \fB\fB-d\fR, \fB--datadigest\fR \fBnone\fR | \fBCRC32\fR\fR
498 .sp .6
499 .RS 4n
500 Sets whether CRC32 is enabled to check SCSI data transfers.
504 .ne 2
506 \fB\fB-H\fR, \fB-\fR\fB-CHAP-name\fR \fICHAP name\fR\fR
508 .sp .6
509 .RS 4n
510 Specifies a CHAP username. If you do not use this option, upon initialization,
511 the CHAP name is set to the initiator node name. When the authentication method
512 is set to CHAP (see \fB-a\fR/\fB-\fR\fB-authentication\fR option, above), the
513 CHAP username is displayed with the command \fBiscsiadm list initiator-node\fR.
517 .ne 2
519 \fB\fB-h\fR, \fB--headerdigest\fR \fBnone\fR | \fBCRC32\fR\fR
521 .sp .6
522 .RS 4n
523 Sets whether CRC32 is enabled to check SCSI packet headers.
527 .ne 2
529 \fB\fB-N\fR, \fB-\fR\fB-node-name\fR \fI<initiator node name>\fR\fR
531 .sp .6
532 .RS 4n
533 Modifies the initiator node name. Maximum of 223 characters.
535 Note -
537 .RS 2
538 During Solaris installation, the initiator node name is set to a globally
539 unique value. Changing this value can adversely affect operation within the
540 iSCSI network.
545 .ne 2
547 \fB\fB-P\fR, \fB--radius-shared-secret\fR (exclusive)\fR
549 .sp .6
550 .RS 4n
551 Sets the RADIUS shared secret.
555 .ne 2
557 \fB\fB-R\fR, \fB--radius-access\fR \fBenable\fR | \fBdisable\fR\fR
559 .sp .6
560 .RS 4n
561 Sets whether a RADIUS server will be used.
565 .ne 2
567 \fB\fB-r\fR, \fB--radius-server\fR \fI<IP address>\fR[:\fI<port>\fR]\fR
569 .sp .6
570 .RS 4n
571 Sets the IP address and port of the radius server to be used.
575 .ne 2
577 \fB\fB-T\fR, \fB-\fR\fB-tunable-param\fR
578 <<\fItunable-prop\fR>=<\fIvalue\fR>, ...>\fR
580 .sp .6
581 .RS 4n
582 Specify one or more tunable parameters for all targets that initiator node
583 connected.
585 Note -
587 .RS 2
588 These values should only be modified by an administrator with a good working
589 knowledge of the parameter's impact within the iSCSI network.
591 Supported tunable-prop options are:
593 .ne 2
595 \fB\fBrecv-login-rsp-timeout\fR\fR
597 .sp .6
598 .RS 4n
599 Session Login Response Time
601 The \fBrecv-login-rsp-timeout\fR option specifies how long iSCSI initiator will
602 wait for the response of iSCSI session login request from the iSCSI target.
603 Valid value is from 0 to 60*60, default to 60 seconds.
607 .ne 2
609 \fB\fBconn-login-max\fR\fR
611 .sp .6
612 .RS 4n
613 Maximized Connection Retry Time
615 The \fBconn-login-max\fR option lets the iSCSI initiator reestablish the
616 connection to the target in case of IO timeout or connection failure during the
617 given time window.  Valid value is from 0 to 60*60, default to 180 seconds.
621 .ne 2
623 \fB\fBpolling-login-delay\fR\fR
625 .sp .6
626 .RS 4n
627 Login Retry Time Interval
629 The \fBpolling-login-delay\fR option specifies the time interval between each
630 login retry when iSCSI initiator to target IO timeout or connection failure.
631 Valid value is from 0 to 60*60, default to 60 seconds.
639 .ne 2
641 \fB\fBtarget-param\fR [\fIoptions\fR] \fItarget\fR\fR
643 .sp .6
644 .RS 4n
645 Modifies a target's parameters. If a target is currently connected, the modify
646 operation will succeed, although the modified settings might not take effect
647 for a few seconds. To confirm that these settings are active, use \fBiscsiadm
648 list target\fR \fB-v\fR. If a specified target is not associated with any
649 discovery method, a target object is created with the specified parameters.
650 After using this command to modify a target's parameters, the new parameters
651 will persist until they are modified or removed with a \fBiscsiadm remove
652 target-param\fR command on that target. The options \fB-C\fR and
653 \fB-\fR\fB-CHAP-secret\fR require a CHAP secret entry in response to a prompt.
655 Options for \fBmodify target-param\fR are as follows:
657 .ne 2
659 \fB\fB-B\fR, \fB-\fR\fB-bi-directional-authentication enable | disable\fR\fR
661 .sp .6
662 .RS 4n
663 Sets the bidirectional option. If set to \fBenable\fR, the initiator performs
664 bidirectional authentication for the specified target.
668 .ne 2
670 \fB\fB-C\fR, \fB-\fR\fB-CHAP-secret\fR\fR
672 .sp .6
673 .RS 4n
674 Sets the target's CHAP secret value. There is no default value. Maximum
675 acceptable length is 16 characters.
679 .ne 2
681 \fB\fB-c\fR, \fB-\fR\fB-configured-sessions\fR \fI<num_sessions>\fR | \fI<IP
682 address>\fR[,\fI<IP address>\fR\&...]\fR
684 .sp .6
685 .RS 4n
686 Sets the number of configured iSCSI sessions that will be created for each
687 iSCSI target. The feature should be used in combination with the Solaris I/O
688 multipathing feature described in \fBscsi_vhci\fR(7D).
692 .ne 2
694 \fB\fB-d\fR, \fB-\fR\fB-datadigest\fR \fBnone\fR | \fBCRC32\fR\fR
696 .sp .6
697 .RS 4n
698 Sets whether CRC32 is enabled or disabled for the data.
702 .ne 2
704 \fB\fB-H\fR, \fB-\fR\fB-CHAP-name\fR \fICHAP name\fR\fR
706 .sp .6
707 .RS 4n
708 Sets a CHAP username. If you do not use this option, upon initialization, the
709 CHAP name is set to the target name. When the authentication method is set to
710 CHAP (see \fB-a\fR/\fB-\fR\fB-authentication\fR option, under the
711 \fBinitiator-node\fR direct object, above), the CHAP username is displayed with
712 the command \fBiscsiadm list initiator-node\fR.
716 .ne 2
718 \fB\fB-h\fR, \fB-\fR\fB-headerdigest\fR \fBnone\fR | \fBCRC32\fR\fR
720 .sp .6
721 .RS 4n
722 Sets whether CRC32 is enabled or disabled for the header.
726 .ne 2
728 \fB\fB-p\fR, \fB-\fR\fB-login-param\fR\fR
730 .sp .6
731 .RS 4n
732 Specify one or more login parameter settings.
734 Note -
736 .RS 2
737 These values should only be modified by an administrator with a good working
738 knowledge of the parameter's impact within the iSCSI network.
740 The login parameters are derived from iSCSI proposed standard RFC 3720. Valid
741 values are:
743 .ne 2
745 \fB\fBdataseqinorder\fR\fR
747 .RS 22n
748 \fByes\fR or \fBno\fR
752 .ne 2
754 \fB\fBdefaulttime2retain\fR\fR
756 .RS 22n
757 0-3600
761 .ne 2
763 \fB\fBdefaulttime2wait\fR\fR
765 .RS 22n
766 0-3600
770 .ne 2
772 \fB\fBfirstburstlength\fR\fR
774 .RS 22n
775 512 to 2^24-1
779 .ne 2
781 \fB\fBimmediatedata\fR\fR
783 .RS 22n
784 \fByes\fR or \fBno\fR
788 .ne 2
790 \fB\fBinitialr2t\fR\fR
792 .RS 22n
793 \fByes\fR or \fBno\fR
797 .ne 2
799 \fB\fBmaxburstlength\fR\fR
801 .RS 22n
802 512 to 2^24-1
806 .ne 2
808 \fB\fBdatapduinorder\fR\fR
810 .RS 22n
811 \fByes\fR or \fBno\fR
815 .ne 2
817 \fB\fBmaxoutstandingr2t\fR\fR
819 .RS 22n
820 1 to 65535
824 .ne 2
826 \fB\fBmaxrecvdataseglen\fR\fR
828 .RS 22n
829 512 to 2^24-1
835 .ne 2
837 \fB\fB-T\fR, \fB-\fR\fB-tunable-param\fR
838 <<\fItunable-prop\fR>=<\fIvalue\fR>, ...>\fR
840 .sp .6
841 .RS 4n
842 Specify one or more tunable parameters for all targets that initiator node
843 connected.
845 Note -
847 .RS 2
848 Tunable values should only be modified by an administrator with a good working
849 knowledge of the parameter's impact within the iSCSI network.
851 Supported \fItunable-prop\fR options are:
853 .ne 2
855 \fB\fBrecv-login-rsp-timeout\fR\fR
857 .sp .6
858 .RS 4n
859 Session Login Response Time
861 The \fBrecv-login-rsp-timeout\fR option specifies how long iSCSI initiator will
862 wait for the response of iSCSI session login request from the iSCSI target.
863 Valid value is from 0 to 60*60, default to 60 seconds.
867 .ne 2
869 \fB\fBconn-login-max\fR\fR
871 .sp .6
872 .RS 4n
873 Maximized Connection Retry Time
875 The \fBconn-login-max\fR option lets the iSCSI initiator reestablish the
876 connection to the target in case of IO timeout or connection failure during the
877 given time window.  Valid value is from 0 to 60*60, default to 180 seconds.
881 .ne 2
883 \fB\fBpolling-login-delay\fR\fR
885 .sp .6
886 .RS 4n
887 Login Retry Time Interval
889 The \fBpolling-login-delay\fR option specifies the time interval between each
890 login retry when iSCSI initiator to target IO timeout or connection failure.
891 Valid value is from 0 to 60*60, default to 60 seconds.
898 .SS "\fBremove\fR Subcommand"
901 The syntax for the \fBremove\fR subcommand is:
903 .in +2
905 # iscsiadm remove \fIdirect_object\fR
907 .in -2
911 The \fBremove\fR subcommand supports the following \fIdirect_object\fRs:
913 .ne 2
915 \fB\fBdiscovery-address\fR \fIdiscovery-address\fR, ...\fR
917 .sp .6
918 .RS 4n
919 Removes a target device from the list of discovery addresses. A discovery
920 address (as in the syntax shown below) is an IP address-port combination used
921 in a SendTargets discovery session. Using this discovery approach, a target
922 device can inform an initiator of the target address and target name of each
923 target exposed by that device. If any target exposed by the discovery address
924 is currently mounted or there is active I/O on the device, an error of "logical
925 unit in use" is returned and the operation fails. If the associated devices are
926 not in use, they are removed.
928 \fIdiscovery-address\fR must be formatted as:
930 .in +2
932 \fI<IP address>\fR[:\fI<port>\fR]
934 .in -2
936 There are no options associated with this direct object.
940 .ne 2
942 \fB\fBisns-server\fR \fIisns-server\fR, ...\fR
944 .sp .6
945 .RS 4n
946 Removes an iSNS server from the list of iSNS server addresses. An iSNS server
947 address (specified in the syntax shown below) is an IP address-port combination
948 used in an iSNS discovery session. By using iSNS discovery, an iSNS server can
949 provide an initiator with information about a portal and the name of each
950 target that belongs to the same discovery domain as that of the initiator. If
951 any target discovered by means of iSNS is currently mounted or there is active
952 I/O on the device, an error of "logical unit in use" is returned and the
953 operation fails. If the associated devices are not in use, they are removed.
955 \fIisns-server\fR must be formatted as:
957 .in +2
959 \fIIP_address\fR[:\fIport\fR]
961 .in -2
963 There are no options associated with this direct object.
967 .ne 2
969 \fB\fBstatic-config\fR \fIstatic_target\fR, ...\fR
971 .sp .6
972 .RS 4n
973 Removes a target from the list of statically discovered targets. If the target
974 being removed is currently mounted or there is active I/O on the device, an
975 error of "logical unit in use" is returned and the operation fails. If a device
976 is not in use, it will be removed.
978 \fIstatic_target\fR must be formatted as:
980 .in +2
982 \fI<target-name>\fR,\fI<target-address>\fR[:\fIport-number\fR][,\fItpgt\fR]
984 .in -2
986 There are no options associated with this direct object.
990 .ne 2
992 \fB\fBtarget-param\fR \fItarget-name\fR\fR
994 .sp .6
995 .RS 4n
996 Removes target specified by \fItarget-name\fR. The target name is formatted as:
998 .in +2
1000 \fI<target-name>\fR
1002 .in -2
1004 There are no options associated with this direct object. For iSCSI booting when
1005 the Solaris I/O multipathing feature (formerly known as Sun StorEdge Traffic
1006 Manager [STMS] or MPxIO) is enabled, you cannot remove the target.
1009 .SS "Proper Use of Discovery Methods"
1012 Do not configure a target to be discovered by both static and dynamic discovery
1013 methods. The consequence of using redundant discovery methods might be slow
1014 performance when communicating with the iSCSI target device.
1015 .SH OPTIONS
1018 The following generic options are supported:
1020 .ne 2
1022 \fB\fB-V\fR, \fB-\fR\fB-version\fR\fR
1024 .RS 17n
1025 Displays version information. Stops interpretation of subsequent arguments.
1029 .ne 2
1031 \fB\fB-?\fR, \fB-\fR\fB-help\fR\fR
1033 .RS 17n
1034 Displays help information. Can be used following an \fBiscsiadm\fR command with
1035 no arguments, following a subcommand, or following a subcommand-direct object
1036 combination. Responds with help information appropriate for your entry. For
1037 example, if you enter:
1039 .in +2
1041 # \fBiscsiadm modify initiator-node --help\fR
1043 .in -2
1046 \&...\fBiscsiadm\fR responds with a display of the options available for that
1047 combination of subcommand and direct object.
1050 .SH EXAMPLES
1052 \fBExample 1 \fRAdding a Discovery Address
1055 The following command uses the \fBadd\fR subcommand to add a discovery address.
1058 .in +2
1060 # \fBiscsiadm add discovery-address 10.0.0.1:3260 10.0.0.2:3260\fR
1062 .in -2
1066 \fBExample 2 \fRAdding a Static Target
1069 The following command uses the \fBadd\fR subcommand to add a static target.
1072 .in +2
1074 # \fBiscsiadm add static-config \e
1075 iqn.1999-08.com.array:sn.01234567,10.0.0.1:3260\fR
1077 .in -2
1081 \fBExample 3 \fRListing Current Discovery Settings
1084 The following command uses the \fBlist\fR subcommand to list current discovery
1085 settings.
1088 .in +2
1090 # \fBiscsiadm list discovery\fR
1091         Discovery:
1092                 Static: enabled
1093                 Send Targets: disabled
1094                 iSNS: enabled
1096 .in -2
1100 \fBExample 4 \fRObtaining Verbose Discovery Output
1103 The following commands uses the \fB-v\fR option (one with, one without) with
1104 the \fBlist\fR subcommand to obtain verbose output.
1107 .in +2
1109 # \fBiscsiadm list discovery-address\fR
1110         Discovery Address: 10.0.0.1:3260
1111         Discovery Address: 10.0.0.2:3260
1113 # \fBiscsiadm list discovery-address -v 10.0.0.1:3260\fR
1114         Discovery Address: 10.0.0.1:3260
1115                 Target name: eui.210000203787d1f7
1116                         Target address:    10.0.0.1:3260
1117                 Target name: eui.210000203787a693
1118                         Target address:    10.0.0.1:3260
1120 .in -2
1124 \fBExample 5 \fRDisplaying Information on the Initiator
1127 The following command uses the \fBlist\fR subcommand to display information on
1128 the initiator.
1131 .in +2
1133 # \fBiscsiadm list initiator-node\fR
1134 Initiator node name: iqn.1986-03.com.company.central.interopv20-1
1135 Initiator node alias: interopv20-1
1136         Login Parameters (Default/Configured):
1137                 Header Digest: NONE/NONE
1138                 Data Digest: NONE/NONE
1139         Authentication Type: CHAP
1140                 CHAP Name: iqn.1986-03.com.company.central.interopv20-1
1141         RADIUS Server: NONE
1142         RADIUS access: disabled
1143         Tunable Parameters (Default/Configured):
1144                 Session Login Response Time: 60/-
1145                 Maximum Connection Retry Time: 180/-
1146                 Login Retry Time Interval: 60/-
1147         Configured Sessions: 1
1149 .in -2
1153 \fBExample 6 \fRDisplaying Static Configuration Information
1156 The following command uses the \fBlist\fR subcommand to display information
1157 about static configurations.
1160 .in +2
1162 # \fBiscsiadm list static-config\fR
1163         Static target: eui.210000203787a693,10.0.0.1:3260
1165 .in -2
1169 \fBExample 7 \fRDisplaying Target Information
1172 The following commands show the use of the \fBlist\fR subcommand with various
1173 options to display information about targets.
1176 .in +2
1178 # \fBiscsiadm list target\fR
1179 Target: iqn.2004-05.com.abcStorage:Tgt-1
1180         Alias: -
1181         TPGT: 12288
1182         ISID: 4000002a0000
1183         Connections: 1# \fBiscsiadm list target -v iqn.2004-05.com.abcStorage:Tgt-1\fR
1184 Target: iqn.2004-05.com.abcStorage:Tgt-1
1185         Alias: -
1186         TPGT: 12288
1187         ISID: 4000002a0000
1188         Connections: 1
1189                 CID: 0
1190                   IP address (Local): 10.4.52.158:32803
1191                   IP address (Peer): 10.4.49.70:3260
1192                   Discovery Method: SendTargets
1193                   Login Parameters (Negotiated):
1194                         Data Sequence In Order: yes
1195                         Data PDU In Order: yes
1196                         Default Time To Retain: 20
1197                         Default Time To Wait: 2
1198                         Error Recovery Level: 0
1199                         First Burst Length: 65536
1200                         Immediate Data: yes
1201                         Initial Ready To Transfer (R2T): yes
1202                         Max Burst Length: 262144
1203                         Max Outstanding R2T: 1
1204                         Max Receive Data Segment Length: 65536
1205                         Max Connections: 1
1206                         Header Digest: NONE
1207                         Data Digest: NONE
1208 # \fBiscsiadm list target -S iqn.2004-05.com.abcStorage:Tgt-1\fR
1209 Target: iqn.2004-05.com.abcStorage:Tgt-1
1210         Alias: -
1211         TPGT: 12288
1212         ISID: 4000002a0000
1213         Connections: 1
1214         LUN: 6
1215              Vendor:  ABCStorage
1216              Product: iSCSI Target
1217              OS Device Name: /dev/rdsk/c3t1d0s2
1218         LUN: 5
1219              Vendor:  ABCStorage
1220              Product: iSCSI Target
1221              OS Device Name: /dev/rdsk/c3t0d0s2
1223 .in -2
1227 \fBExample 8 \fRDisplaying Target Parameter Information
1230 The following command uses the \fBlist\fR subcommand to display target
1231 information for a specific target.
1234 .in +2
1236 # \fBiscsiadm list target-param -v iqn.2004-05.com.abcStorage:Tgt-1\fR
1237 Target: iqn.2004-05.com.abcStorage:Tgt-1
1238         Alias: -
1239         Bi-directional Authentication: disabled
1240         Authentication Type: NONE
1241         Login Parameters (Default/Configured):
1242                 Data Sequence In Order: yes/-
1243                 Data PDU In Order: yes/-
1244                 Default Time To Retain: 20/-
1245                 Default Time To Wait: 2/-
1246                 Error Recovery Level: 0/-
1247                 First Burst Length: 65536/-
1248                 Immediate Data: yes/-
1249                 Initial Ready To Transfer (R2T): yes/-
1250                 Max Burst Length: 262144/-
1251                 Max Outstanding R2T: 1/-
1252                 Max Receive Data Segment Length: 65536/-
1253                 Max Connections: 1/-
1254                 Header Digest: NONE/-
1255                 Data Digest: NONE/-
1256         Tunable Parameters (Default/Configured):
1257                 Session Login Response Time: 60/-
1258                 Maximum Connection Retry Time: 180/-
1259                 Login Retry Time Interval: 60/-
1260         Configured Sessions: 1
1262 .in -2
1266 \fBExample 9 \fREnabling Static Discovery Method
1269 The following command uses the \fBmodify\fR subcommand to enable the static
1270 discovery method.
1273 .in +2
1275 # \fBiscsiadm modify discovery --static enable\fR
1277 .in -2
1281 \fBExample 10 \fRSetting the IP Address for the Radius Server
1284 The following command uses the \fBmodify\fR subcommand to set the IP address
1285 for the radius server, which will be used for CHAP authentication.
1288 .in +2
1290 # \fBiscsiadm modify initiator --radius-server 10.0.0.1\fR
1292 .in -2
1296 \fBExample 11 \fRSetting the Node Name for Initiator
1299 The following command uses the \fBmodify\fR subcommand to set the node name for
1300 the initiator node.
1303 .in +2
1305 # \fBiscsiadm modify initiator-node -N iqn.2004-10.com.SUN.host-1\fR
1307 .in -2
1311 \fBExample 12 \fRChanging Target Parameters
1314 The following command uses the \fBmodify\fR subcommand to change the target
1315 parameters for a specified target.
1318 .in +2
1320 # \fBiscsiadm modify target-param -d none -h none eui.210000203787a693\fR
1322 .in -2
1326 \fBExample 13 \fRRemoving a Discovery Address
1329 The following command uses the \fBremove\fR subcommand to remove a discovery
1330 address.
1333 .in +2
1335 # \fBiscsiadm remove discovery-address 10.0.0.1:3260\fR
1337 .in -2
1341 \fBExample 14 \fRRemoving Target Parameters
1344 The following command uses the \fBremove\fR subcommand to remove a set of
1345 target parameters.
1348 .in +2
1350 # \fBiscsiadm remove target-param eui.210000203787a693\fR
1352 .in -2
1355 .SH ATTRIBUTES
1358 See \fBattributes\fR(5) for descriptions of the following attributes:
1363 box;
1364 c | c
1365 l | l .
1366 ATTRIBUTE TYPE  ATTRIBUTE VALUE
1368 Interface Stability     Committed
1371 .SH SEE ALSO
1374 \fBattributes\fR(5), \fBiscsi\fR(7D), \fBscsi_vhci\fR(7D)
1377 \fISystem Administration Guide: Devices and File Systems\fR