share/man/man8/iscsiadm.8

   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 8 "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
  14
  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
  33
  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
  46
  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
  55
  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
  64
  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
  73
  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
  93
  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
 101 .ad
 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.
 111 .sp
 112 The \fIdiscovery-address\fR parameter is formatted as:
 113 .sp
 114 .in +2
 115 .nf
 116 <\fIIP address\fR>[:\fIport\fR]
 117 .fi
 118 .in -2
 119
 120 If \fIport\fR is not specified, the default of 3260 will be used.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBisns-server\fR \fIisns-server\fR [...]\fR
 127 .ad
 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.
 138 .sp
 139 The \fIisns-server\fR parameter is formatted as:
 140 .sp
 141 .in +2
 142 .nf
 143 \fIIP_address\fR[:\fIport\fR]
 144 .fi
 145 .in -2
 146
 147 If a port is not specified, the default of 3205 is used.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBstatic-config\fR \fIstatic_target\fR [...]\fR
 154 .ad
 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.
 160 .sp
 161 The \fIstatic_target\fR parameter is formatted as:
 162 .sp
 163 .in +2
 164 .nf
 165 \fI<target-name>\fR,\fI<target address>\fR[:\fIport-number\fR][,\fItpgt\fR]
 166 .fi
 167 .in -2
 168
 169 \fI<target-name>\fR can be up to 223 characters.
 170 .RE
 171
 172 .SS "\fBlist\fR Subcommand"
 173 .sp
 174 .LP
 175 The syntax for the \fBlist\fR subcommand is:
 176 .sp
 177 .in +2
 178 .nf
 179 # iscsiadm list \fIdirect-object\fR [\fIoptions\fR]
 180 .fi
 181 .in -2
 182
 183 .sp
 184 .LP
 185 The \fBlist\fR subcommand displays data for the following \fIdirect-object\fRs:
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fBdiscovery\fR\fR
 190 .ad
 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
 196 .TP
 197 .ie t \(bu
 198 .el o
 199 iSNS (Internet Storage Name Service)
 200 .RE
 201 .RS +4
 202 .TP
 203 .ie t \(bu
 204 .el o
 205 Static
 206 .RE
 207 .RS +4
 208 .TP
 209 .ie t \(bu
 210 .el o
 211 SendTargets
 212 .RE
 213 .RE
 214
 215 .sp
 216 .ne 2
 217 .na
 218 \fB\fBinitiator-node\fR\fR
 219 .ad
 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.
 227 .RE
 228
 229 .sp
 230 .ne 2
 231 .na
 232 \fB\fBstatic-config\fR [\fIstatic_target\fR[, ...]]\fR
 233 .ad
 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.
 238 .RE
 239
 240 .sp
 241 .ne 2
 242 .na
 243 \fB\fBtarget\fR [\fB-S\fR] [\fB-v\fR] [\fItarget\fR[, ...]]\fR
 244 .ad
 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.
 251 .sp
 252 When used with the \fB-S\fR option for a specified target, this subcommand
 253 returns:
 254 .RS +4
 255 .TP
 256 .ie t \(bu
 257 .el o
 258 target name
 259 .RE
 260 .RS +4
 261 .TP
 262 .ie t \(bu
 263 .el o
 264 logical unit number
 265 .RE
 266 .RS +4
 267 .TP
 268 .ie t \(bu
 269 .el o
 270 vendor ID
 271 .RE
 272 .RS +4
 273 .TP
 274 .ie t \(bu
 275 .el o
 276 product ID
 277 .RE
 278 .RS +4
 279 .TP
 280 .ie t \(bu
 281 .el o
 282 OS device name (for example, \fB/dev/rdsk/c0t2d0s0\fR)
 283 .RE
 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.
 287 .sp
 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.
 292 .RE
 293
 294 .sp
 295 .ne 2
 296 .na
 297 \fB\fBtarget-param\fR [\fB-v\fR] \fItarget\fR [...]\fR
 298 .ad
 299 .sp .6
 300 .RS 4n
 301 Lists a target's default and user-defined parameters.
 302 .RE
 303
 304 .sp
 305 .ne 2
 306 .na
 307 \fB\fBdiscovery-address\fR [\fB-v\fR] [\fIdiscovery-address\fR[, ...]]\fR
 308 .ad
 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.
 313 .sp
 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.
 318 .RE
 319
 320 .sp
 321 .ne 2
 322 .na
 323 \fB\fBisns-server\fR [\fB-v\fR] [\fIisns-server\fR[, ...]]\fR
 324 .ad
 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.
 329 .sp
 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.
 334 .RE
 335
 336 .SS "\fBmodify\fR Subcommand"
 337 .sp
 338 .LP
 339 The syntax for the \fBmodify\fR subcommand is:
 340 .sp
 341 .in +2
 342 .nf
 343 # iscsiadm modify \fIdirect_object\fR [\fIoptions\fR]
 344 .fi
 345 .in -2
 346
 347 .sp
 348 .LP
 349 The \fBmodify\fR subcommand supports the following \fIdirect_object\fRs:
 350 .sp
 351 .ne 2
 352 .na
 353 \fB\fBdiscovery\fR [\fIoptions\fR]\fR
 354 .ad
 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.
 360 .sp
 361 Options for \fBmodify discovery\fR are as follows:
 362 .sp
 363 .ne 2
 364 .na
 365 \fB\fB-i\fR, \fB-iSNS\fR \fBenable\fR | \fBdisable\fR\fR
 366 .ad
 367 .sp .6
 368 .RS 4n
 369 Enable or disable iSNS discovery.
 370 .RE
 371
 372 .sp
 373 .ne 2
 374 .na
 375 \fB\fB-s\fR, \fB-\fR\fB-static\fR \fBenable\fR | \fBdisable\fR\fR
 376 .ad
 377 .sp .6
 378 .RS 4n
 379 Enable or disable static discovery.
 380 .RE
 381
 382 .sp
 383 .ne 2
 384 .na
 385 \fB\fB-t\fR, \fB-\fR\fB-sendtargets\fR \fBenable\fR | \fBdisable\fR\fR
 386 .ad
 387 .sp .6
 388 .RS 4n
 389 Enable or disable SendTargets discovery.
 390 .RE
 391
 392 .RE
 393
 394 .sp
 395 .ne 2
 396 .na
 397 \fB\fBinitiator-node\fR [\fIoptions\fR]\fR
 398 .ad
 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.
 406 .sp
 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
 411 .TP
 412 .ie t \(bu
 413 .el o
 414 \fB-r\fR, \fB--radius-server\fR
 415 .RE
 416 .RS +4
 417 .TP
 418 .ie t \(bu
 419 .el o
 420 \fB-R\fR, \fB--radius-access\fR
 421 .RE
 422 .RS +4
 423 .TP
 424 .ie t \(bu
 425 .el o
 426 \fB-P\fR, \fB--radius-shared-secret\fR
 427 .RE
 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
 431 .TP
 432 .ie t \(bu
 433 .el o
 434 \fB-h\fR, \fB--headerdigest\fR
 435 .RE
 436 .RS +4
 437 .TP
 438 .ie t \(bu
 439 .el o
 440 \fB-d\fR, \fB--datadigest\fR
 441 .RE
 442 .RS +4
 443 .TP
 444 .ie t \(bu
 445 .el o
 446 \fB-c\fR, \fB--configured-sessions\fR
 447 .RE
 448 Options for \fBmodify initiator-node\fR are as follows:
 449 .sp
 450 .ne 2
 451 .na
 452 \fB\fB-A\fR, \fB-\fR\fB-node-alias\fR \fI<initiator node alias>\fR\fR
 453 .ad
 454 .sp .6
 455 .RS 4n
 456 Modifies the initiator node alias. Maximum length of 223 characters.
 457 .RE
 458
 459 .sp
 460 .ne 2
 461 .na
 462 \fB\fB-a\fR, \fB-\fR\fB-authentication\fR \fBchap\fR | \fBnone\fR\fR
 463 .ad
 464 .sp .6
 465 .RS 4n
 466 Sets the authentication mode.
 467 .RE
 468
 469 .sp
 470 .ne 2
 471 .na
 472 \fB\fB-C\fR, \fB-\fR\fB-CHAP-secret\fR\fR
 473 .ad
 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.
 478 .RE
 479
 480 .sp
 481 .ne 2
 482 .na
 483 \fB\fB-c\fR, \fB--configured-sessions\fR \fI<num_sessions>\fR | \fI<IP
 484 address>\fR[,\fI<IP address>\fR\&...]\fR
 485 .ad
 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).
 491 .RE
 492
 493 .sp
 494 .ne 2
 495 .na
 496 \fB\fB-d\fR, \fB--datadigest\fR \fBnone\fR | \fBCRC32\fR\fR
 497 .ad
 498 .sp .6
 499 .RS 4n
 500 Sets whether CRC32 is enabled to check SCSI data transfers.
 501 .RE
 502
 503 .sp
 504 .ne 2
 505 .na
 506 \fB\fB-H\fR, \fB-\fR\fB-CHAP-name\fR \fICHAP name\fR\fR
 507 .ad
 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.
 514 .RE
 515
 516 .sp
 517 .ne 2
 518 .na
 519 \fB\fB-h\fR, \fB--headerdigest\fR \fBnone\fR | \fBCRC32\fR\fR
 520 .ad
 521 .sp .6
 522 .RS 4n
 523 Sets whether CRC32 is enabled to check SCSI packet headers.
 524 .RE
 525
 526 .sp
 527 .ne 2
 528 .na
 529 \fB\fB-N\fR, \fB-\fR\fB-node-name\fR \fI<initiator node name>\fR\fR
 530 .ad
 531 .sp .6
 532 .RS 4n
 533 Modifies the initiator node name. Maximum of 223 characters.
 534 .LP
 535 Note -
 536 .sp
 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.
 541 .RE
 542 .RE
 543
 544 .sp
 545 .ne 2
 546 .na
 547 \fB\fB-P\fR, \fB--radius-shared-secret\fR (exclusive)\fR
 548 .ad
 549 .sp .6
 550 .RS 4n
 551 Sets the RADIUS shared secret.
 552 .RE
 553
 554 .sp
 555 .ne 2
 556 .na
 557 \fB\fB-R\fR, \fB--radius-access\fR \fBenable\fR | \fBdisable\fR\fR
 558 .ad
 559 .sp .6
 560 .RS 4n
 561 Sets whether a RADIUS server will be used.
 562 .RE
 563
 564 .sp
 565 .ne 2
 566 .na
 567 \fB\fB-r\fR, \fB--radius-server\fR \fI<IP address>\fR[:\fI<port>\fR]\fR
 568 .ad
 569 .sp .6
 570 .RS 4n
 571 Sets the IP address and port of the radius server to be used.
 572 .RE
 573
 574 .sp
 575 .ne 2
 576 .na
 577 \fB\fB-T\fR, \fB-\fR\fB-tunable-param\fR
 578 <<\fItunable-prop\fR>=<\fIvalue\fR>, ...>\fR
 579 .ad
 580 .sp .6
 581 .RS 4n
 582 Specify one or more tunable parameters for all targets that initiator node
 583 connected.
 584 .LP
 585 Note -
 586 .sp
 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.
 590 .RE
 591 Supported tunable-prop options are:
 592 .sp
 593 .ne 2
 594 .na
 595 \fB\fBrecv-login-rsp-timeout\fR\fR
 596 .ad
 597 .sp .6
 598 .RS 4n
 599 Session Login Response Time
 600 .sp
 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.
 604 .RE
 605
 606 .sp
 607 .ne 2
 608 .na
 609 \fB\fBconn-login-max\fR\fR
 610 .ad
 611 .sp .6
 612 .RS 4n
 613 Maximized Connection Retry Time
 614 .sp
 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.
 618 .RE
 619
 620 .sp
 621 .ne 2
 622 .na
 623 \fB\fBpolling-login-delay\fR\fR
 624 .ad
 625 .sp .6
 626 .RS 4n
 627 Login Retry Time Interval
 628 .sp
 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.
 632 .RE
 633
 634 .RE
 635
 636 .RE
 637
 638 .sp
 639 .ne 2
 640 .na
 641 \fB\fBtarget-param\fR [\fIoptions\fR] \fItarget\fR\fR
 642 .ad
 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.
 654 .sp
 655 Options for \fBmodify target-param\fR are as follows:
 656 .sp
 657 .ne 2
 658 .na
 659 \fB\fB-B\fR, \fB-\fR\fB-bi-directional-authentication enable | disable\fR\fR
 660 .ad
 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.
 665 .RE
 666
 667 .sp
 668 .ne 2
 669 .na
 670 \fB\fB-C\fR, \fB-\fR\fB-CHAP-secret\fR\fR
 671 .ad
 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.
 676 .RE
 677
 678 .sp
 679 .ne 2
 680 .na
 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
 683 .ad
 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).
 689 .RE
 690
 691 .sp
 692 .ne 2
 693 .na
 694 \fB\fB-d\fR, \fB-\fR\fB-datadigest\fR \fBnone\fR | \fBCRC32\fR\fR
 695 .ad
 696 .sp .6
 697 .RS 4n
 698 Sets whether CRC32 is enabled or disabled for the data.
 699 .RE
 700
 701 .sp
 702 .ne 2
 703 .na
 704 \fB\fB-H\fR, \fB-\fR\fB-CHAP-name\fR \fICHAP name\fR\fR
 705 .ad
 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.
 713 .RE
 714
 715 .sp
 716 .ne 2
 717 .na
 718 \fB\fB-h\fR, \fB-\fR\fB-headerdigest\fR \fBnone\fR | \fBCRC32\fR\fR
 719 .ad
 720 .sp .6
 721 .RS 4n
 722 Sets whether CRC32 is enabled or disabled for the header.
 723 .RE
 724
 725 .sp
 726 .ne 2
 727 .na
 728 \fB\fB-p\fR, \fB-\fR\fB-login-param\fR\fR
 729 .ad
 730 .sp .6
 731 .RS 4n
 732 Specify one or more login parameter settings.
 733 .LP
 734 Note -
 735 .sp
 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.
 739 .RE
 740 The login parameters are derived from iSCSI proposed standard RFC 3720. Valid
 741 values are:
 742 .sp
 743 .ne 2
 744 .na
 745 \fB\fBdataseqinorder\fR\fR
 746 .ad
 747 .RS 22n
 748 \fByes\fR or \fBno\fR
 749 .RE
 750
 751 .sp
 752 .ne 2
 753 .na
 754 \fB\fBdefaulttime2retain\fR\fR
 755 .ad
 756 .RS 22n
 757 0-3600
 758 .RE
 759
 760 .sp
 761 .ne 2
 762 .na
 763 \fB\fBdefaulttime2wait\fR\fR
 764 .ad
 765 .RS 22n
 766 0-3600
 767 .RE
 768
 769 .sp
 770 .ne 2
 771 .na
 772 \fB\fBfirstburstlength\fR\fR
 773 .ad
 774 .RS 22n
 775 512 to 2^24-1
 776 .RE
 777
 778 .sp
 779 .ne 2
 780 .na
 781 \fB\fBimmediatedata\fR\fR
 782 .ad
 783 .RS 22n
 784 \fByes\fR or \fBno\fR
 785 .RE
 786
 787 .sp
 788 .ne 2
 789 .na
 790 \fB\fBinitialr2t\fR\fR
 791 .ad
 792 .RS 22n
 793 \fByes\fR or \fBno\fR
 794 .RE
 795
 796 .sp
 797 .ne 2
 798 .na
 799 \fB\fBmaxburstlength\fR\fR
 800 .ad
 801 .RS 22n
 802 512 to 2^24-1
 803 .RE
 804
 805 .sp
 806 .ne 2
 807 .na
 808 \fB\fBdatapduinorder\fR\fR
 809 .ad
 810 .RS 22n
 811 \fByes\fR or \fBno\fR
 812 .RE
 813
 814 .sp
 815 .ne 2
 816 .na
 817 \fB\fBmaxoutstandingr2t\fR\fR
 818 .ad
 819 .RS 22n
 820 1 to 65535
 821 .RE
 822
 823 .sp
 824 .ne 2
 825 .na
 826 \fB\fBmaxrecvdataseglen\fR\fR
 827 .ad
 828 .RS 22n
 829 512 to 2^24-1
 830 .RE
 831
 832 .RE
 833
 834 .sp
 835 .ne 2
 836 .na
 837 \fB\fB-T\fR, \fB-\fR\fB-tunable-param\fR
 838 <<\fItunable-prop\fR>=<\fIvalue\fR>, ...>\fR
 839 .ad
 840 .sp .6
 841 .RS 4n
 842 Specify one or more tunable parameters for all targets that initiator node
 843 connected.
 844 .LP
 845 Note -
 846 .sp
 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.
 850 .RE
 851 Supported \fItunable-prop\fR options are:
 852 .sp
 853 .ne 2
 854 .na
 855 \fB\fBrecv-login-rsp-timeout\fR\fR
 856 .ad
 857 .sp .6
 858 .RS 4n
 859 Session Login Response Time
 860 .sp
 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.
 864 .RE
 865
 866 .sp
 867 .ne 2
 868 .na
 869 \fB\fBconn-login-max\fR\fR
 870 .ad
 871 .sp .6
 872 .RS 4n
 873 Maximized Connection Retry Time
 874 .sp
 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.
 878 .RE
 879
 880 .sp
 881 .ne 2
 882 .na
 883 \fB\fBpolling-login-delay\fR\fR
 884 .ad
 885 .sp .6
 886 .RS 4n
 887 Login Retry Time Interval
 888 .sp
 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.
 892 .RE
 893
 894 .RE
 895
 896 .RE
 897
 898 .SS "\fBremove\fR Subcommand"
 899 .sp
 900 .LP
 901 The syntax for the \fBremove\fR subcommand is:
 902 .sp
 903 .in +2
 904 .nf
 905 # iscsiadm remove \fIdirect_object\fR
 906 .fi
 907 .in -2
 908
 909 .sp
 910 .LP
 911 The \fBremove\fR subcommand supports the following \fIdirect_object\fRs:
 912 .sp
 913 .ne 2
 914 .na
 915 \fB\fBdiscovery-address\fR \fIdiscovery-address\fR, ...\fR
 916 .ad
 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.
 927 .sp
 928 \fIdiscovery-address\fR must be formatted as:
 929 .sp
 930 .in +2
 931 .nf
 932 \fI<IP address>\fR[:\fI<port>\fR]
 933 .fi
 934 .in -2
 935
 936 There are no options associated with this direct object.
 937 .RE
 938
 939 .sp
 940 .ne 2
 941 .na
 942 \fB\fBisns-server\fR \fIisns-server\fR, ...\fR
 943 .ad
 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.
 954 .sp
 955 \fIisns-server\fR must be formatted as:
 956 .sp
 957 .in +2
 958 .nf
 959 \fIIP_address\fR[:\fIport\fR]
 960 .fi
 961 .in -2
 962
 963 There are no options associated with this direct object.
 964 .RE
 965
 966 .sp
 967 .ne 2
 968 .na
 969 \fB\fBstatic-config\fR \fIstatic_target\fR, ...\fR
 970 .ad
 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.
 977 .sp
 978 \fIstatic_target\fR must be formatted as:
 979 .sp
 980 .in +2
 981 .nf
 982 \fI<target-name>\fR,\fI<target-address>\fR[:\fIport-number\fR][,\fItpgt\fR]
 983 .fi
 984 .in -2
 985
 986 There are no options associated with this direct object.
 987 .RE
 988
 989 .sp
 990 .ne 2
 991 .na
 992 \fB\fBtarget-param\fR \fItarget-name\fR\fR
 993 .ad
 994 .sp .6
 995 .RS 4n
 996 Removes target specified by \fItarget-name\fR. The target name is formatted as:
 997 .sp
 998 .in +2
 999 .nf
1000 \fI<target-name>\fR
1001 .fi
1002 .in -2
1003
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.
1007 .RE
1008
1009 .SS "Proper Use of Discovery Methods"
1010 .sp
1011 .LP
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
1016 .sp
1017 .LP
1018 The following generic options are supported:
1019 .sp
1020 .ne 2
1021 .na
1022 \fB\fB-V\fR, \fB-\fR\fB-version\fR\fR
1023 .ad
1024 .RS 17n
1025 Displays version information. Stops interpretation of subsequent arguments.
1026 .RE
1027
1028 .sp
1029 .ne 2
1030 .na
1031 \fB\fB-?\fR, \fB-\fR\fB-help\fR\fR
1032 .ad
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:
1038 .sp
1039 .in +2
1040 .nf
1041 # \fBiscsiadm modify initiator-node --help\fR
1042 .fi
1043 .in -2
1044 .sp
1045
1046 \&...\fBiscsiadm\fR responds with a display of the options available for that
1047 combination of subcommand and direct object.
1048 .RE
1049
1050 .SH EXAMPLES
1051 .LP
1052 \fBExample 1 \fRAdding a Discovery Address
1053 .sp
1054 .LP
1055 The following command uses the \fBadd\fR subcommand to add a discovery address.
1056
1057 .sp
1058 .in +2
1059 .nf
1060 # \fBiscsiadm add discovery-address 10.0.0.1:3260 10.0.0.2:3260\fR
1061 .fi
1062 .in -2
1063 .sp
1064
1065 .LP
1066 \fBExample 2 \fRAdding a Static Target
1067 .sp
1068 .LP
1069 The following command uses the \fBadd\fR subcommand to add a static target.
1070
1071 .sp
1072 .in +2
1073 .nf
1074 # \fBiscsiadm add static-config \e
1075 iqn.1999-08.com.array:sn.01234567,10.0.0.1:3260\fR
1076 .fi
1077 .in -2
1078 .sp
1079
1080 .LP
1081 \fBExample 3 \fRListing Current Discovery Settings
1082 .sp
1083 .LP
1084 The following command uses the \fBlist\fR subcommand to list current discovery
1085 settings.
1086
1087 .sp
1088 .in +2
1089 .nf
1090 # \fBiscsiadm list discovery\fR
1091         Discovery:
1092                 Static: enabled
1093                 Send Targets: disabled
1094                 iSNS: enabled
1095 .fi
1096 .in -2
1097 .sp
1098
1099 .LP
1100 \fBExample 4 \fRObtaining Verbose Discovery Output
1101 .sp
1102 .LP
1103 The following commands uses the \fB-v\fR option (one with, one without) with
1104 the \fBlist\fR subcommand to obtain verbose output.
1105
1106 .sp
1107 .in +2
1108 .nf
1109 # \fBiscsiadm list discovery-address\fR
1110         Discovery Address: 10.0.0.1:3260
1111         Discovery Address: 10.0.0.2:3260
1112
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
1119 .fi
1120 .in -2
1121 .sp
1122
1123 .LP
1124 \fBExample 5 \fRDisplaying Information on the Initiator
1125 .sp
1126 .LP
1127 The following command uses the \fBlist\fR subcommand to display information on
1128 the initiator.
1129
1130 .sp
1131 .in +2
1132 .nf
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
1148 .fi
1149 .in -2
1150 .sp
1151
1152 .LP
1153 \fBExample 6 \fRDisplaying Static Configuration Information
1154 .sp
1155 .LP
1156 The following command uses the \fBlist\fR subcommand to display information
1157 about static configurations.
1158
1159 .sp
1160 .in +2
1161 .nf
1162 # \fBiscsiadm list static-config\fR
1163         Static target: eui.210000203787a693,10.0.0.1:3260
1164 .fi
1165 .in -2
1166 .sp
1167
1168 .LP
1169 \fBExample 7 \fRDisplaying Target Information
1170 .sp
1171 .LP
1172 The following commands show the use of the \fBlist\fR subcommand with various
1173 options to display information about targets.
1174
1175 .sp
1176 .in +2
1177 .nf
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
1222 .fi
1223 .in -2
1224 .sp
1225
1226 .LP
1227 \fBExample 8 \fRDisplaying Target Parameter Information
1228 .sp
1229 .LP
1230 The following command uses the \fBlist\fR subcommand to display target
1231 information for a specific target.
1232
1233 .sp
1234 .in +2
1235 .nf
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
1261 .fi
1262 .in -2
1263 .sp
1264
1265 .LP
1266 \fBExample 9 \fREnabling Static Discovery Method
1267 .sp
1268 .LP
1269 The following command uses the \fBmodify\fR subcommand to enable the static
1270 discovery method.
1271
1272 .sp
1273 .in +2
1274 .nf
1275 # \fBiscsiadm modify discovery --static enable\fR
1276 .fi
1277 .in -2
1278 .sp
1279
1280 .LP
1281 \fBExample 10 \fRSetting the IP Address for the Radius Server
1282 .sp
1283 .LP
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.
1286
1287 .sp
1288 .in +2
1289 .nf
1290 # \fBiscsiadm modify initiator --radius-server 10.0.0.1\fR
1291 .fi
1292 .in -2
1293 .sp
1294
1295 .LP
1296 \fBExample 11 \fRSetting the Node Name for Initiator
1297 .sp
1298 .LP
1299 The following command uses the \fBmodify\fR subcommand to set the node name for
1300 the initiator node.
1301
1302 .sp
1303 .in +2
1304 .nf
1305 # \fBiscsiadm modify initiator-node -N iqn.2004-10.com.SUN.host-1\fR
1306 .fi
1307 .in -2
1308 .sp
1309
1310 .LP
1311 \fBExample 12 \fRChanging Target Parameters
1312 .sp
1313 .LP
1314 The following command uses the \fBmodify\fR subcommand to change the target
1315 parameters for a specified target.
1316
1317 .sp
1318 .in +2
1319 .nf
1320 # \fBiscsiadm modify target-param -d none -h none eui.210000203787a693\fR
1321 .fi
1322 .in -2
1323 .sp
1324
1325 .LP
1326 \fBExample 13 \fRRemoving a Discovery Address
1327 .sp
1328 .LP
1329 The following command uses the \fBremove\fR subcommand to remove a discovery
1330 address.
1331
1332 .sp
1333 .in +2
1334 .nf
1335 # \fBiscsiadm remove discovery-address 10.0.0.1:3260\fR
1336 .fi
1337 .in -2
1338 .sp
1339
1340 .LP
1341 \fBExample 14 \fRRemoving Target Parameters
1342 .sp
1343 .LP
1344 The following command uses the \fBremove\fR subcommand to remove a set of
1345 target parameters.
1346
1347 .sp
1348 .in +2
1349 .nf
1350 # \fBiscsiadm remove target-param eui.210000203787a693\fR
1351 .fi
1352 .in -2
1353 .sp
1354
1355 .SH ATTRIBUTES
1356 .sp
1357 .LP
1358 See \fBattributes\fR(5) for descriptions of the following attributes:
1359 .sp
1360
1361 .sp
1362 .TS
1363 box;
1364 c | c
1365 l | l .
1366 ATTRIBUTE TYPE  ATTRIBUTE VALUE
1367 _
1368 Interface Stability     Committed
1369 .TE
1370
1371 .SH SEE ALSO
1372 .sp
1373 .LP
1374 \fBattributes\fR(5), \fBiscsi\fR(7D), \fBscsi_vhci\fR(7D)
1375 .sp
1376 .LP
1377 \fISystem Administration Guide: Devices and File Systems\fR