1 '\" te
   2 .\"  Copyright (c) 2003, 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LUXADM 1M "May 13, 2017"
   7 .SH NAME
   8 luxadm \- administer Sun Fire 880 storage subsystem and FC_AL devices
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBluxadm\fR [\fIoptions\fR]... \fIsubcommand\fR [\fIoptions\fR]... \fIenclosure\fR
  13      [,\fIdev\fR] | \fIpathname\fR...
  14 .fi
  15 
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBluxadm\fR program is an administrative command that manages the
  19 \fBSENA\fR, Sun Fire 880 internal storage subsystem, and individual Fiber
  20 Channel Arbitrated Loop (\fBFC_AL\fR) devices. \fBluxadm\fR performs a variety
  21 of control and query tasks depending on the command line arguments and options
  22 used.
  23 .sp
  24 .LP
  25 The command line must contain a subcommand. The command line may also contain
  26 options, usually at least one enclosure name or pathname, and other parameters
  27 depending on the subcommand. You need specify only as many characters as are
  28 required to uniquely identify a subcommand.
  29 .sp
  30 .LP
  31 Specify the device that a subcommand interacts with by entering a pathname. For
  32 the \fBSENA\fR subsystem, a disk device or enclosure services controller may
  33 instead be specified by entering the World Wide Name (\fBWWN\fR) for the device
  34 or a port to the device. The device may also be specified by entering the name
  35 of the \fBSENA\fR enclosure, and an optional identifier for the particular
  36 device in the enclosure. The individual \fBFC_AL\fR devices may be specified by
  37 entering the \fBWWN\fR for the device or a port to the device.
  38 .SS "Pathname"
  39 .LP
  40 Specify the device or controller by either a complete physical pathname or a
  41 complete logical pathname.
  42 .sp
  43 .LP
  44 For \fBSENA,\fR a typical physical pathname for a device is:
  45 .sp
  46 .in +2
  47 .nf
  48 /devices/sbus@1f,0/SUNW,socal@1,0/sf@0,0/ssd@w2200002037000f96,
  49          0:a,raw
  50 .fi
  51 .in -2
  52 .sp
  53 
  54 .sp
  55 .LP
  56 For all \fBSENA IBs\fR (Interface Boards) and Sun Fire 880 SES device
  57 controllers on the system, a logical link to the physical paths is kept in the
  58 directory \fB/dev/es\fR. An example of a logical link is \fB/dev/es/ses0\fR.
  59 .sp
  60 .LP
  61 The \fBWWN\fR may be used in place of the pathname to select an \fBFC_AL\fR
  62 device, \fBSENA\fR subsystem IB, or Sun Fire 880 internal storage subsystem.
  63 The \fBWWN\fR is a unique 16 hexadecimal digit value that specifies either the
  64 port used to access the device or the device itself. A typical \fBWWN\fR value
  65 is:
  66 .sp
  67 .in +2
  68 .nf
  69 2200002037000f96
  70 .fi
  71 .in -2
  72 .sp
  73 
  74 .sp
  75 .LP
  76 See NOTES for more information on the \fBWWN\fR formats.
  77 .sp
  78 .LP
  79 For a disk in a Sun Fire 880 internal storage subsystem, a typical physical
  80 pathname is:
  81 .sp
  82 .in +2
  83 .nf
  84 /devices/pci@8,600000/SUNW,qlc@2/fp@0,0/ssd@w2100002037a6303c,0:a
  85 .fi
  86 .in -2
  87 .sp
  88 
  89 .sp
  90 .LP
  91 and a typical logical pathname is:
  92 .sp
  93 .in +2
  94 .nf
  95 /dev/rdsk/c2t8d0s2
  96 .fi
  97 .in -2
  98 .sp
  99 
 100 .sp
 101 .LP
 102 For individual FC_AL devices, a typical physical pathname is:
 103 .sp
 104 .in +2
 105 .nf
 106 /devices/sbus@3.0/SUNW,socal@d,10000/sf@0,0/ssd@w2200002037049fc3,0:a,raw
 107 .fi
 108 .in -2
 109 .sp
 110 
 111 .sp
 112 .LP
 113 and a typical logical pathname is:
 114 .sp
 115 .in +2
 116 .nf
 117 /dev/rdsk/c1t0d0s2
 118 .fi
 119 .in -2
 120 .sp
 121 
 122 .SS "Enclosure"
 123 .LP
 124 For \fBSENA,\fR a device may be identified by its enclosure name and slotname:
 125 .br
 126 .in +2
 127 \fIbox_name\fR[\fB,f\fR\fIslot_number\fR]
 128 .in -2
 129 .br
 130 .in +2
 131 \fIbox_name\fR[\fB,r\fR\fIslot_number\fR]
 132 .in -2
 133 .sp
 134 .LP
 135 \fIbox_name\fR is the name of the \fBSENA\fR enclosure, as specified by the
 136 \fBenclosure_name\fR subcommand. When used without the optional
 137 \fIslot_number\fR parameter, the \fIbox_name\fR identifies the \fBSENA\fR
 138 subsystem \fBIB.\fR
 139 .sp
 140 .LP
 141 \fBf\fR or \fBr\fR specifies the front or rear slots in the \fBSENA\fR
 142 enclosure.
 143 .sp
 144 .LP
 145 \fIslot_number\fR specifies the slot number of the device in the \fBSENA\fR
 146 enclosure, \fB0-6\fR or \fB0-10\fR.
 147 .sp
 148 .LP
 149 For a Sun Fire 880 internal storage subsystem, a device may also be identified
 150 by its enclosure name and slot name. However, there is only one set of disks:
 151 .sp
 152 .in +2
 153 .nf
 154 \fIbox_name\fR[,\fIsslot_number\fR]
 155 .fi
 156 .in -2
 157 .sp
 158 
 159 .sp
 160 .LP
 161 \fIbox_name\fR is the name of the Sun Fire 880 enclosure, as specified by the
 162 \fBenclosure_name\fR subcommand. When used without the optional
 163 \fIslot_number\fR parameter, \fIbox_name\fR identifies the Sun Fire 880
 164 internal storage subsystem enclosure services device. Use \fIs\fR to specify
 165 the disk slot number in the Sun Fire 880 internal storage subsystem, \fB0\fR -
 166 \fB11\fR.
 167 .sp
 168 .LP
 169 See \fBdisks\fR(1M) and \fBdevlinks\fR(1M) for additional information on
 170 logical names for disks and subsystems.
 171 .SH OPTIONS
 172 .LP
 173 The following options are supported by all subcommands:
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB-e\fR\fR
 178 .ad
 179 .RS 6n
 180 Expert mode. This option is not recommended for the novice user.
 181 .RE
 182 
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB-v\fR\fR
 187 .ad
 188 .RS 6n
 189 Verbose mode.
 190 .RE
 191 
 192 .sp
 193 .LP
 194 Options that are specific to particular subcommands are described with the
 195 subcommand in the \fBUSAGE\fR section.
 196 .SH OPERANDS
 197 .LP
 198 The following operands are supported:
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fIenclosure\fR\fR
 203 .ad
 204 .sp .6
 205 .RS 4n
 206 The \fIbox_name\fR of the \fBSENA\fR or Sun Fire 880 internal storage
 207 subsystem.
 208 .RE
 209 
 210 .sp
 211 .ne 2
 212 .na
 213 \fB\fIfibre_channel_HBA_port\fR\fR
 214 .ad
 215 .sp .6
 216 .RS 4n
 217 The path to the host controller port. A typical path is:
 218 .sp
 219 .in +2
 220 .nf
 221  /devices/pci@8,600000/pci@1/SUNW,qlc@4/fp@0,0:devctl
 222 .fi
 223 .in -2
 224 .sp
 225 
 226 .RE
 227 
 228 .sp
 229 .ne 2
 230 .na
 231 \fB\fIpathname\fR\fR
 232 .ad
 233 .sp .6
 234 .RS 4n
 235 The logical or physical path of a \fBSENA IB\fR, Sun Fire 880 internal storage
 236 subsystem, or disk device. \fIpathname\fR can also be the \fBWWN\fR of a
 237 \fBSENA IB\fR, \fBSENA\fR disk, or individual \fBFC_AL\fR device.
 238 .RE
 239 
 240 .SH USAGE
 241 .SS "Subcommands"
 242 .ne 2
 243 .na
 244 \fB\fBdisplay\fR \fIenclosure\fR[,\fIdev\fR]\|.\|.\|.\||
 245 \fIpathname\fR\|.\|.\|.\fR
 246 .ad
 247 .br
 248 .na
 249 \fB\fBdisplay\fR \fB-p\fR \fIpathname\fR\|.\|.\|.\fR
 250 .ad
 251 .br
 252 .na
 253 \fB\fBdisplay\fR \fB-r\fR \fIenclosure\fR[,\fIdev\fR]\|.\|.\|.\||
 254 \fIpathname\fR\|.\|.\|.\fR
 255 .ad
 256 .br
 257 .na
 258 \fB\fBdisplay\fR \fB-v\fR \fIenclosure\fR[,\fIdev\fR]\|.\|.\|.\||
 259 \fIpathname\fR\|.\|.\|.\fR
 260 .ad
 261 .sp .6
 262 .RS 4n
 263 Displays enclosure or device specific data.
 264 .sp
 265 Subsystem data consists of enclosure environmental sense information and status
 266 for all subsystem devices, including disks.
 267 .sp
 268 Disk data consists of inquiry, capacity, and configuration information.
 269 .sp
 270 .ne 2
 271 .na
 272 \fB\fB-p\fR\fR
 273 .ad
 274 .RS 6n
 275 Displays performance information for the device or subsystem specified by
 276 \fIpathname\fR. This option only applies to subsystems that accumulate
 277 performance information.
 278 .RE
 279 
 280 .sp
 281 .ne 2
 282 .na
 283 \fB\fB-r\fR\fR
 284 .ad
 285 .RS 6n
 286 Displays error information for the \fBFC_AL\fR device specified by the
 287 pathname, or, if the path is a \fBSENA,\fR for all devices on the loop. The
 288 \fB-r\fR option only applies to \fBSENA\fR subsystems and individual
 289 \fBFC_AL\fR devices.
 290 .RE
 291 
 292 .sp
 293 .ne 2
 294 .na
 295 \fB\fB-v\fR\fR
 296 .ad
 297 .RS 6n
 298 Displays in verbose mode, including mode sense data.
 299 .RE
 300 
 301 .RE
 302 
 303 .sp
 304 .ne 2
 305 .na
 306 \fB\fBdownload\fR [ \fB-s\fR ] [ \fB-f\fR \fIfilename_path\fR ]
 307 \fIenclosure\fR.\|.\|.\fR
 308 .ad
 309 .sp .6
 310 .RS 4n
 311 Download the prom image pointed to the SENA subsystem Interface Board unit or
 312 the Sun Fire 880 internal storage subsystem specified by the enclosure or
 313 pathname.
 314 .sp
 315 When the \fBSENA's\fR download is complete, the \fBSENA\fR will be reset and
 316 the downloaded code executed. If no filename is specified, the default prom
 317 image will be used. The default prom image for the \fBSENA\fR is in the
 318 directory \fBusr/lib/locale/C/LC_MESSAGES\fR and is named \fBibfirmware\fR
 319 .sp
 320 When the Sun Fire 880 internal storage subsystem's download is complete, the
 321 subsystem resets and the downloaded code begins execution. The default firmware
 322 image for the Sun Fire 880 internal storage subsystem is in:
 323 \fB/usr/platform/SUNW,Sun-Fire-880/lib/images/int_fcbpl_fw\fR.
 324 .sp
 325 .ne 2
 326 .na
 327 \fB\fB-s\fR\fR
 328 .ad
 329 .RS 6n
 330 Save. The \fB-s\fR option is used to save the downloaded firmware in the
 331 FEPROM. If \fB-s\fR is not specified, the downloaded firmware will not be saved
 332 across power cycles.
 333 .sp
 334 The \fB-s\fR option does not apply to the Sun Fire 880 internal storage
 335 subsystem as it always stores downloaded firmware in the flash memory.
 336 .sp
 337 When using the \fB-s\fR option, the \fBdownload\fR subcommand modifies the
 338 \fBFEPROM\fR on the subsystem and should be used with \fIcaution\fR.
 339 .RE
 340 
 341 .RE
 342 
 343 .sp
 344 .ne 2
 345 .na
 346 \fB\fBenclosure_name\fR \fInew_name\fR \fIenclosure\fR | \fIpathname\fR\fR
 347 .ad
 348 .sp .6
 349 .RS 4n
 350 Change the enclosure name of the enclosure or enclosures specified by the
 351 enclosure or pathname. The new name (\fInew_name\fR) must be 16 or less
 352 characters. Only alphabetic or numeric characters are acceptable. This
 353 subcommand applies only to the SENA and the Sun Fire 880 internal storage
 354 subsystem.
 355 .RE
 356 
 357 .sp
 358 .ne 2
 359 .na
 360 \fB\fBfailover primary\fR | \fBsecondary\fR \fIpathname\fR\fR
 361 .ad
 362 .sp .6
 363 .RS 4n
 364 Select which Sun Storage T3 storage array partner group controller accesses a
 365 given logical volume. If \fBprimary\fR is specified, the logical volume is
 366 accessed through the primary controller. If \fBsecondary\fR is specified, the
 367 logical volume is accessed through the secondary controller specified by
 368 \fIpathname\fR.
 369 .RE
 370 
 371 .sp
 372 .ne 2
 373 .na
 374 \fB\fBfcal_s_download\fR [ \fB-f\fR \fIfcode-file\fR ]\fR
 375 .ad
 376 .sp .6
 377 .RS 4n
 378 Download the fcode contained in the file \fIfcode-file\fR into \fIall\fR the
 379 \fBFC100/S\fR Sbus Cards. This command is interactive and expects user
 380 confirmation before downloading the fcode.
 381 .sp
 382 Use \fBfcal_s_download\fR \fIonly\fR in single-user mode. Using
 383 \fBfcal_s_download\fR to update a host adapter while there is \fBI/O\fR
 384 activity through that adapter \fIwill\fR cause the adapter to reset. Newly
 385 updated FCode will not be executed or visible until a system reboot.
 386 .sp
 387 .ne 2
 388 .na
 389 \fB\fB-f\fR \fIfcode-file\fR\fR
 390 .ad
 391 .RS 17n
 392 When invoked without the \fB-f\fR option, the current version of the fcode in
 393 each \fBFC100/S\fR Sbus card is printed.
 394 .RE
 395 
 396 .RE
 397 
 398 .sp
 399 .ne 2
 400 .na
 401 \fB\fBfcode_download\fR \fB-p\fR\fR
 402 .ad
 403 .br
 404 .na
 405 \fB\fBfcode_download\fR \fB-d\fR \fIdir-name\fR\fR
 406 .ad
 407 .sp .6
 408 .RS 4n
 409 Locate the installed \fBFC/S\fR, \fBFC100/S, FC100/P\fR, or \fBFC100/2P\fR host
 410 bus adapter cards and download the FCode files in \fIdir-name\fR to the
 411 appropriate cards. The command determines the correct card for each type of
 412 file, and is interactive. User confirmation is required before downloading the
 413 FCode to each device.
 414 .sp
 415 Use \fBfcode_download\fR to load FCode only in single-user mode. Using
 416 \fBfcode_download\fR to update a host adapter while there is \fBI/O\fR activity
 417 through that adapter causes the adapter to reset. Newly updated FCode will not
 418 be executed or visible until a system reboot.
 419 .sp
 420 .ne 2
 421 .na
 422 \fB\fB-d\fR \fIdir-name\fR\fR
 423 .ad
 424 .RS 15n
 425 Download the FCode files contained in the directory \fIdir-name\fR to the
 426 appropriate adapter cards.
 427 .RE
 428 
 429 .sp
 430 .ne 2
 431 .na
 432 \fB\fB-p\fR\fR
 433 .ad
 434 .RS 15n
 435 Prints the current version of FCode loaded on each card. No download is
 436 performed.
 437 .RE
 438 
 439 .RE
 440 
 441 .sp
 442 .ne 2
 443 .na
 444 \fB\fBinquiry\fR \fIenclosure\fR[,\fIdev\fR ]\|.\|.\|.\| |
 445 \fIpathname\fR\|.\|.\|.\fR
 446 .ad
 447 .sp .6
 448 .RS 4n
 449 Display the inquiry information for the selected device specified by the
 450 enclosure or pathname.
 451 .RE
 452 
 453 .sp
 454 .ne 2
 455 .na
 456 \fB\fBinsert_device\fR [ \fIenclosure\fR,\fIdev\fR\|.\|.\|. ]\fR
 457 .ad
 458 .sp .6
 459 .RS 4n
 460 Assist the user in the hot insertion of a new device or a chain of new devices.
 461 Refer to \fBNOTES\fR for limitations on hotplug operations. This subcommand
 462 applies only to the \fBSENA\fR, Sun Fire 880 internal storage subsystem, and
 463 individual FC_AL drives. For the \fBSENA\fR, if more than one enclosure has
 464 been specified, concurrent hot insertions on multiple busses can be performed.
 465 With no arguments to the subcommand, entire enclosures or individual
 466 \fBFC_AL\fR drives can be inserted. For the \fBSENA\fR or the Sun Fire 880
 467 internal storage subsystem, this subcommand guides the user interactively
 468 through the hot insertion steps of a new device or chain of devices. If a list
 469 of disks was entered it will ask the user to verify the list of devices to be
 470 inserted is correct, at which point the user can continue or quit. It then
 471 interactively asks the user to insert the disk(s) or enclosure(s) and then
 472 creates and displays the logical pathnames for the devices.
 473 .RE
 474 
 475 .sp
 476 .ne 2
 477 .na
 478 \fB\fBled\fR \fIenclosure\fR,\fIdev\fR\|.\|.\|.\|| \fIpathname\fR.\|.\|.\fR
 479 .ad
 480 .sp .6
 481 .RS 4n
 482 Display the current state of the \fBLED\fR associated with the disk specified
 483 by the enclosure or pathname. This subcommand only applies to subsystems that
 484 support this functionality.
 485 .RE
 486 
 487 .sp
 488 .ne 2
 489 .na
 490 \fB\fBled_blink\fR \fIenclosure\fR,\fIdev\fR\|.\|.\|.\||
 491 \fIpathname\fR\|.\|.\|.\fR
 492 .ad
 493 .sp .6
 494 .RS 4n
 495 Requests the subsystem to start blinking the \fBLED\fR associated with the disk
 496 specified by the enclosure or pathname. This subcommand only applies to
 497 subsystems that support this functionality.
 498 .RE
 499 
 500 .sp
 501 .ne 2
 502 .na
 503 \fB\fBled_off\fR \fIenclosure\fR,\fIdev\fR\|.\|.\|.\||
 504 \fIpathname\fR\|.\|.\|.\fR
 505 .ad
 506 .sp .6
 507 .RS 4n
 508 Requests the subsystem to disable (turn off) the \fBLED\fR associated with the
 509 disk specified by the enclosure or pathname. On a \fBSENA\fR subsystem, this
 510 may or may not cause the \fBLED\fR to turn off or stop blinking depending on
 511 the state of the \fBSENA\fR subsystem. Refer to the \fBSENA\fR Array
 512 Installation and Service Manual (p/n 802-7573). This subcommand only applies to
 513 subsystems that support this functionality.
 514 .RE
 515 
 516 .sp
 517 .ne 2
 518 .na
 519 \fB\fBled_on\fR \fIpathname\fR\|.\|.\|.\fR
 520 .ad
 521 .sp .6
 522 .RS 4n
 523 Requests the subsystem to enable (turn on) the \fBLED\fR associated with the
 524 disk specified by the pathname. This subcommand only applies to subsystems that
 525 support this functionality.
 526 .RE
 527 
 528 .sp
 529 .ne 2
 530 .na
 531 \fB\fBpower_off\fR [ \fB-F\fR ] \fIenclosure\fR[,\fIdev\fR]\|.\|.\|. |
 532 \fIpathname\fR \|.\|.\|.\fR
 533 .ad
 534 .sp .6
 535 .RS 4n
 536 When a \fBSENA\fR is addressed, this subcommand causes the \fBSENA\fR subsystem
 537 to go into the power-save mode. The \fBSENA\fR drives are not available when in
 538 the power-save mode. When a drive in a \fBSENA\fR is addressed the drive is set
 539 to the drive off/unmated state. In the drive off/unmated state, the drive is
 540 spun down (stopped) and in bypass mode. This command does not apply to the Sun
 541 Fire 880 internal storage subsystem.
 542 .sp
 543 .ne 2
 544 .na
 545 \fB\fB-F\fR\fR
 546 .ad
 547 .RS 6n
 548 The force option only applies to the \fBSENA.\fR Instructs \fBluxadm\fR to
 549 attempt to power off one or more devices even if those devices are being used
 550 by this host (and are, therefore, busy).
 551 .sp
 552 \fBWarning\fR: Powering off a device which has data that is currently being
 553 used will cause unpredictable results. Users should attempt to power off the
 554 device normally (without \fB-F\fR) first, only resorting to this option when
 555 sure of the consequences of overriding normal checks.
 556 .RE
 557 
 558 .RE
 559 
 560 .sp
 561 .ne 2
 562 .na
 563 \fB\fBpower_on\fR \fIenclosure\fR[\fB,\fR\fIdev\fR]\|.\|.\|\fR
 564 .ad
 565 .sp .6
 566 .RS 4n
 567 Causes the \fBSENA\fR subsystem to go out of the power-save mode, when this
 568 subcommand is addressed to a \fBSENA.\fR. When this subcommand is addressed to
 569 a drive the drive is set to its normal start-up state. This command does not
 570 apply to the Sun Fire 880 internal storage subsystem.
 571 .RE
 572 
 573 .sp
 574 .ne 2
 575 .na
 576 \fB\fBprobe\fR [ \fB-p\fR ]\fR
 577 .ad
 578 .sp .6
 579 .RS 4n
 580 Finds and displays information about all attached \fBSENA\fR subsystems, Sun
 581 Fire 880 internal storage subsystems, and individual \fBFC_AL\fR devices,
 582 including the logical pathname, the \fBWWNs,\fR and enclosure names. This
 583 subcommand warns the user if it finds different \fBSENAs\fR with the same
 584 enclosure names.
 585 .sp
 586 .ne 2
 587 .na
 588 \fB\fB-p\fR\fR
 589 .ad
 590 .RS 6n
 591 Includes the physical pathname in the display.
 592 .RE
 593 
 594 .RE
 595 
 596 .sp
 597 .ne 2
 598 .na
 599 \fB\fBqlgc_s_download\fR [ \fB-f\fR \fIfcode-file\fR ]\fR
 600 .ad
 601 .sp .6
 602 .RS 4n
 603 Download the FCode contained in the file \fIfcode-file\fR into all the
 604 \fBFC100/P\fR, \fBFC100/2P\fR \fBPCI\fR host adapter cards. This command is
 605 interactive and expects user confirmation before downloading the FCode to each
 606 device. Only use \fBqlgc_s_download\fR in single-user mode. Using
 607 \fBqlgc_s_download\fR to update a host adapter while there is\fB I/O\fR
 608 activity through that adapter will cause the adapter to reset. Newly updated
 609 FCode will not be executed or visible until a system reboot.
 610 .sp
 611 .ne 2
 612 .na
 613 \fB\fB-f\fR \fIfcode-file\fR\fR
 614 .ad
 615 .RS 17n
 616 When invoked without the \fB-f\fR option, the current version of the FCode in
 617 each \fBFC100/P\fR,\fB FC100/2P PCI\fR card is printed.
 618 .RE
 619 
 620 .RE
 621 
 622 .sp
 623 .ne 2
 624 .na
 625 \fB\fBrelease\fR \fIpathname\fR\fR
 626 .ad
 627 .sp .6
 628 .RS 4n
 629 Release a reservation held on the specified disk. The pathname should be the
 630 physical or logical pathname for the disk.
 631 .sp
 632 This subcommand is included for historical and diagnostic purposes only.
 633 .RE
 634 
 635 .sp
 636 .ne 2
 637 .na
 638 \fB\fBremove_device\fR [ \fB-F\fR ] \fIenclosure\fR[,\fIdev\fR]\|.\|.\|.\||
 639 \fIpathname\fR\|.\|.\|.\fR
 640 .ad
 641 .sp .6
 642 .RS 4n
 643 Assists the user in hot removing a device or a chain of devices. This
 644 subcommand can also be used to remove entire enclosures. This subcommand
 645 applies to the \fBSENA\fR, Sun Fire 880 internal storage subsystem, and
 646 individual \fBFC_AL\fR drives. Refer to \fBNOTES\fR for limitations on hotplug
 647 operations. For the \fBSENA\fR, Sun Fire 880 internal storage subsystem, and
 648 individual \fBFC_AL\fR devices, this subcommand guides the user through the hot
 649 removal of a device or devices. During execution it will ask the user to verify
 650 the list of devices to be removed is correct, at which point the user can
 651 continue or quit. It then prepares the disk(s) or enclosure(s) for removal and
 652 interactively asks the user to remove the disk(s) or enclosure(s).
 653 .sp
 654 For Multi-Hosted disk, the steps taken are:
 655 .RS +4
 656 .TP
 657 .ie t \(bu
 658 .el o
 659 Issue the \fBluxadm\fR \fBremove_device\fR command on the first host. When
 660 prompted to continue, wait.
 661 .RE
 662 .RS +4
 663 .TP
 664 .ie t \(bu
 665 .el o
 666 Issue the \fBluxadm\fR \fBremove_device\fR command on the secondary hosts. When
 667 prompted to continue, wait.
 668 .RE
 669 .RS +4
 670 .TP
 671 .ie t \(bu
 672 .el o
 673 Continue with the \fBremove_device\fR command on the first host. Remove the
 674 device when prompted to do so.
 675 .RE
 676 .RS +4
 677 .TP
 678 .ie t \(bu
 679 .el o
 680 Complete the \fBluxadm\fR \fBremove_device\fR command on the additional hosts.
 681 .RE
 682 .sp
 683 .ne 2
 684 .na
 685 \fB\fB-F\fR\fR
 686 .ad
 687 .RS 6n
 688 Instructs \fBluxadm\fR to attempt to hot plug one or more devices even if those
 689 devices are being used by this host (and are, therefore, \fBbusy\fR or
 690 \fBreserved\fR), to \fBforce\fR the hotplugging operation.
 691 .sp
 692 \fBWarning\fR: Removal of a device which has data that is currently being used
 693 will cause unpredictable results. Users should attempt to hotplug normally
 694 (without \fB-F\fR) first, only resorting to this option when sure of the
 695 consequences of overriding normal hotplugging checks.
 696 .RE
 697 
 698 .RE
 699 
 700 .sp
 701 .ne 2
 702 .na
 703 \fB\fBreserve\fR \fIpathname\fR\fR
 704 .ad
 705 .sp .6
 706 .RS 4n
 707 Reserve the specified disk for exclusive use by the issuing host. The pathname
 708 used should be the physical or logical pathname for the disk.
 709 .sp
 710 This subcommand is included for historical and diagnostic purposes only.
 711 .RE
 712 
 713 .sp
 714 .ne 2
 715 .na
 716 \fB\fBset_boot_dev\fR [ \fB-y\fR ] \fIpathname\fR\fR
 717 .ad
 718 .sp .6
 719 .RS 4n
 720 Set the boot-device variable in the system \fBPROM\fR to the physical device
 721 name specified by \fIpathname\fR, which can be a block special device or the
 722 pathname of the directory on which the boot file system is mounted. The command
 723 normally runs interactively requesting confirmation for setting the default
 724 boot-device in the \fBPROM\fR. The \fB-y\fR option can be used to run it
 725 non-interactively, in which case no confirmation is requested or required.
 726 .RE
 727 
 728 .sp
 729 .ne 2
 730 .na
 731 \fB\fBstart\fR \fIpathname\fR\fR
 732 .ad
 733 .sp .6
 734 .RS 4n
 735 Spin up the specified disk(s) in a SENA.
 736 .RE
 737 
 738 .sp
 739 .ne 2
 740 .na
 741 \fB\fBstop\fR \fIpathname\fR...\fR
 742 .ad
 743 .sp .6
 744 .RS 4n
 745 Spin down the specified disks in a SENA.
 746 .RE
 747 
 748 .SS "SENA, Sun Fire 880 Internal Storage Subsystem, and Individual FC_AL Drive Expert Mode Subcommands"
 749 .LP
 750 The following subcommands are for expert use only, and are applicable only to
 751 the \fBSENA\fR, Sun Fire 880 internal storage subsystem, and fiber channel
 752 loops. They should only be used by users that are knowledgeable about the
 753 \fBSENA\fR subsystem and fiber channel loops.
 754 .sp
 755 .LP
 756 If you specify a disk to an expert subcommand that operates on a bus, the
 757 subcommand operates on the bus to which the specified disk is attached.
 758 .sp
 759 .ne 2
 760 .na
 761 \fB\fB-e\fR \fBbypass\fR \fB[\fR\fB-ab\fR\fB]\fR \fIenclosure\fR,\fIdev\fR\fR
 762 .ad
 763 .br
 764 .na
 765 \fB\fB-e\fR \fBbypass\fR \fB-f\fR \fIenclosure\fR\fR
 766 .ad
 767 .sp .6
 768 .RS 4n
 769 Request the enclosure services controller to set the LRC (Loop Redundancy
 770 Circuit) to the bypassed state for the port and device specified.
 771 .sp
 772 This subcommand supports the following options:
 773 .sp
 774 .ne 2
 775 .na
 776 \fB\fB-a\fR\fR
 777 .ad
 778 .RS 6n
 779 Bypass port \fBa\fR of the device specified.
 780 .RE
 781 
 782 .sp
 783 .ne 2
 784 .na
 785 \fB\fB-b\fR\fR
 786 .ad
 787 .RS 6n
 788 Bypass port \fBb\fR of the device specified.
 789 .RE
 790 
 791 .RE
 792 
 793 .sp
 794 .ne 2
 795 .na
 796 \fB\fB-e\fR \fBdump_map\fR \fIfibre_channel_HBA_port\fR\fR
 797 .ad
 798 .sp .6
 799 .RS 4n
 800 Display WWN data for a target device or host bus adapter on the specified fibre
 801 channel port. If there are no target devices on the specified port, an error is
 802 returned.
 803 .RE
 804 
 805 .sp
 806 .ne 2
 807 .na
 808 \fB\fB-e\fR \fBenable\fR \fB[\fR\fB-ab\fR\fB]\fR \fIenclosure\fR,\fIdev\fR\fR
 809 .ad
 810 .br
 811 .na
 812 \fB\fB-e\fR \fBenable\fR \fB-f\fR \fIenclosure\fR\fR
 813 .ad
 814 .sp .6
 815 .RS 4n
 816 Request the enclosure services controller to set the LRC (Loop Redundancy
 817 Circuit) to the enabled state for the port and device specified.
 818 .sp
 819 This subcommand supports the following options:
 820 .sp
 821 .ne 2
 822 .na
 823 \fB\fB-a\fR\fR
 824 .ad
 825 .RS 6n
 826 Enable port \fBa\fR of the device specified.
 827 .RE
 828 
 829 .sp
 830 .ne 2
 831 .na
 832 \fB\fB-b\fR\fR
 833 .ad
 834 .RS 6n
 835 Enable port \fBb\fR of the device specified.
 836 .RE
 837 
 838 .RE
 839 
 840 .sp
 841 .ne 2
 842 .na
 843 \fB\fB\fR\fB-e\fR \fBforcelip\fR \fIenclosure\fR[\fB,\fR\fIdev\fR] \|.\|.\|. |
 844 \fIpathname\fR\|.\|.\|.\fR
 845 .ad
 846 .sp .6
 847 .RS 4n
 848 Force the link to reinitialize, using the Loop Initialization Primitive
 849 (\fBLIP\fR) sequence. The enclosure or pathname can specify any device on the
 850 loop. Use the pathname to specify a specific path for multiple loop
 851 configurations.
 852 .sp
 853 This is an expert only command and should be used with caution. It will reset
 854 all ports on the loop.
 855 .RE
 856 
 857 .sp
 858 .ne 2
 859 .na
 860 \fB\fB\fR\fB-e\fR \fBrdls\fR \fIenclosure\fR[\fB,\fR\fIdev\fR] \|.\|.\|. |
 861 \fIpathname\fR\|.\|.\|.\fR
 862 .ad
 863 .sp .6
 864 .RS 4n
 865 Read and display the link error status information for all available devices on
 866 the loop that contains the device specified by the enclosure or pathname.
 867 .RE
 868 
 869 .SS "Other Expert Mode Subcommands"
 870 .LP
 871 See \fBNOTES\fR for limitations of these subcommands. They should only be used
 872 by users that are knowledgeable about the systems they are managing.
 873 .sp
 874 .LP
 875 These commands do not apply to the Sun Fire 880 internal storage subsystem.
 876 .sp
 877 .ne 2
 878 .na
 879 \fB\fB\fR\fB-e\fR \fBbus_getstate\fR \fIpathname\fR\fR
 880 .ad
 881 .RS 29n
 882 Get and display the state of the specified bus.
 883 .RE
 884 
 885 .sp
 886 .ne 2
 887 .na
 888 \fB\fB\fR\fB-e\fR \fBbus_quiesce\fR \fIpathname\fR\fR
 889 .ad
 890 .RS 29n
 891 Quiesce the specified bus.
 892 .RE
 893 
 894 .sp
 895 .ne 2
 896 .na
 897 \fB\fB\fR\fB-e\fR \fBbus_reset\fR \fIpathname\fR\fR
 898 .ad
 899 .RS 29n
 900 Reset the specified bus only.
 901 .RE
 902 
 903 .sp
 904 .ne 2
 905 .na
 906 \fB\fB\fR\fB-e\fR \fBbus_resetall\fR \fIpathname\fR\fR
 907 .ad
 908 .RS 29n
 909 Reset the specified bus and all devices.
 910 .RE
 911 
 912 .sp
 913 .ne 2
 914 .na
 915 \fB\fB\fR\fB-e\fR \fBbus_unquiesce\fR \fIpathname\fR\fR
 916 .ad
 917 .RS 29n
 918 Unquiesce the specified bus. the specified device.
 919 .RE
 920 
 921 .sp
 922 .ne 2
 923 .na
 924 \fB\fB\fR\fB-e\fR \fBdev_getstate\fR \fIpathname\fR\fR
 925 .ad
 926 .RS 29n
 927 Get and display the state of the specified device.
 928 .RE
 929 
 930 .sp
 931 .ne 2
 932 .na
 933 \fB\fB\fR\fB-e\fR \fBdev_reset\fR \fIpathname\fR\fR
 934 .ad
 935 .RS 29n
 936 Reset the specified device.
 937 .RE
 938 
 939 .sp
 940 .ne 2
 941 .na
 942 \fB\fB\fR\fB-e\fR \fBoffline\fR \fIpathname\fR\fR
 943 .ad
 944 .RS 29n
 945 Take the specified device offline.
 946 .RE
 947 
 948 .sp
 949 .ne 2
 950 .na
 951 \fB\fB\fR\fB-e\fR \fBonline\fR \fIpathname\fR\fR
 952 .ad
 953 .RS 29n
 954 Put the specified device online.
 955 .RE
 956 
 957 .SH EXAMPLES
 958 .LP
 959 \fBExample 1 \fRDisplaying the \fBSENA\fRs and Individual FC_AL Devices on a
 960 System
 961 .sp
 962 .LP
 963 The following example finds and displays all of the \fBSENA\fRs and individual
 964 \fBFC_AL\fR devices on a system:
 965 
 966 .sp
 967 .in +2
 968 .nf
 969 example% \fBluxadm probe\fR
 970 .fi
 971 .in -2
 972 .sp
 973 
 974 .LP
 975 \fBExample 2 \fRDisplaying a \fBSENA\fR or Sun Fire 880 Internal Storage
 976 Subsystem
 977 .sp
 978 .LP
 979 The following example displays a \fBSENA\fR or Sun Fire 880 internal storage
 980 subsystem:
 981 
 982 .sp
 983 .in +2
 984 .nf
 985 example% \fBluxadm display /dev/es/ses0\fR
 986 .fi
 987 .in -2
 988 .sp
 989 
 990 .LP
 991 \fBExample 3 \fRDisplaying Two Subsystems
 992 .sp
 993 .LP
 994 The following example displays two subsystems using the enclosure names:
 995 
 996 .sp
 997 .in +2
 998 .nf
 999 example% \fBluxadm display BOB system1\fR
1000 .fi
1001 .in -2
1002 .sp
1003 
1004 .LP
1005 \fBExample 4 \fRDisplaying Information about the First Disk
1006 .sp
1007 .LP
1008 The following example displays information about the first disk in the front of
1009 the enclosure named \fBBOB.\fR Use \fBf\fR to specify the front disks. Use
1010 \fBr\fR to specify the rear disks.
1011 
1012 .sp
1013 .in +2
1014 .nf
1015 example% \fBluxadm display BOB,f0\fR
1016 .fi
1017 .in -2
1018 .sp
1019 
1020 .LP
1021 \fBExample 5 \fRDisplaying Information on a Sun Fire 880 Internal Storage
1022 Subsystem
1023 .sp
1024 .LP
1025 The Sun Fire 880 internal storage subsystem has only one set of disks. In this
1026 case, use \fIs\fR to specify the slot:
1027 
1028 .sp
1029 .in +2
1030 .nf
1031 example% \fBluxadm display BOB,s0\fR
1032 .fi
1033 .in -2
1034 .sp
1035 
1036 .LP
1037 \fBExample 6 \fRDisplaying Information about a \fBSENA\fR disk, an Enclosure,
1038 or an Individual \fBFC_AL\fR Drive
1039 .sp
1040 .LP
1041 The following example displays information about a \fBSENA\fR disk, an
1042 enclosure, or an individual \fBFC_AL\fR drive with the port \fBWWN\fR of
1043 \fB2200002037001246\fR:
1044 
1045 .sp
1046 .in +2
1047 .nf
1048 example% \fBluxadm display 2200002037001246\fR
1049 .fi
1050 .in -2
1051 .sp
1052 
1053 .LP
1054 \fBExample 7 \fRUsing Unique Characters to Issue a Subcommand
1055 .sp
1056 .LP
1057 The following example uses only as many characters as are required to uniquely
1058 identify a subcommand:
1059 
1060 .sp
1061 .in +2
1062 .nf
1063 example% \fBluxadm disp BOB\fR
1064 .fi
1065 .in -2
1066 .sp
1067 
1068 .LP
1069 \fBExample 8 \fRDisplaying Error Information
1070 .sp
1071 .LP
1072 The following example displays error information about the loop that the
1073 enclosure \fBBOB\fR is on:
1074 
1075 .sp
1076 .in +2
1077 .nf
1078 example% \fBluxadm display \fR\fB-r\fR\fB BOB\fR
1079 .fi
1080 .in -2
1081 .sp
1082 
1083 .LP
1084 \fBExample 9 \fRDownloading New Firmware into the Interface Board
1085 .sp
1086 .LP
1087 The following example downloads new firmware into the Interface Board in the
1088 enclosure named \fBBOB\fR (using the default path for the file to download):
1089 
1090 .sp
1091 .in +2
1092 .nf
1093 example% \fBluxadm download \fR\fB-s\fR\fB BOB\fR
1094 .fi
1095 .in -2
1096 .sp
1097 
1098 .LP
1099 \fBExample 10 \fRDisplaying Information from the \fBSCSI\fR Inquiry Command
1100 .sp
1101 .LP
1102 The following example displays information from the \fBSCSI\fR inquiry command
1103 from all individual disks on the system, using only as many characters as
1104 necessary to uniquely identify the inquiry subcommand:
1105 
1106 .sp
1107 .in +2
1108 .nf
1109 example% \fBluxadm inq /dev/rdsk/c?t?d?s2\fR
1110 .fi
1111 .in -2
1112 .sp
1113 
1114 .LP
1115 \fBExample 11 \fRHotplugging
1116 .sp
1117 .LP
1118 The following example hotplugs a new drive into the first slot in the front of
1119 the enclosure named \fBBOB:\fR
1120 
1121 .sp
1122 .in +2
1123 .nf
1124 example% \fBluxadm insert_device BOB,f0\fR
1125 .fi
1126 .in -2
1127 .sp
1128 
1129 .sp
1130 .LP
1131 The following example hotplugs a new drive into the first slot in the Sun Fire
1132 880 internal storage subsystem named SF880-1:
1133 
1134 .sp
1135 .in +2
1136 .nf
1137 example% \fBluxadm insert_device SF880-1,s0\fR
1138 .fi
1139 .in -2
1140 .sp
1141 
1142 .LP
1143 \fBExample 12 \fRRunning an Expert Subcommand
1144 .sp
1145 .LP
1146 The following example runs an expert subcommand. The subcommand forces a loop
1147 initialization on the loop that the enclosure \fBBOB\fR is on:
1148 
1149 .sp
1150 .in +2
1151 .nf
1152 example% \fBluxadm \fR\fB-e\fR\fB forcelip BOB\fR
1153 .fi
1154 .in -2
1155 .sp
1156 
1157 .LP
1158 \fBExample 13 \fRUsing the Expert Mode Hot Plugging Subcommands
1159 .sp
1160 .LP
1161 An example of using the expert mode hot plugging subcommands to hot remove a
1162 disk follows. See \fBNOTES\fR for hot plugging limitations.
1163 
1164 .sp
1165 .LP
1166 The first step reserves the SCSI device so that it can't be accessed by way of
1167 its second SCSI bus:
1168 
1169 .sp
1170 .in +2
1171 .nf
1172 example# \fBluxadm reserve /dev/rdsk/c1t8d0s2\fR
1173 .fi
1174 .in -2
1175 .sp
1176 
1177 .LP
1178 \fBExample 14 \fRTaking the Disk to be Removed Offline
1179 .sp
1180 .LP
1181 The next two steps take the disk to be removed offline then quiesce the bus:
1182 
1183 .sp
1184 .in +2
1185 .nf
1186 example# \fBluxadm \fR\fB-e\fR\fB offline /dev/rdsk/c1t8d0s2\fR
1187 example# \fBluxadm -e bus_quiesce /dev/rdsk/c1t8d0s2\fR
1188 .fi
1189 .in -2
1190 .sp
1191 
1192 .LP
1193 \fBExample 15 \fRUnquiescing the Bus
1194 .sp
1195 .LP
1196 The user then removes the disk and continues by unquiescing the bus, putting
1197 the disk back online, then unreserving it:
1198 
1199 .sp
1200 .in +2
1201 .nf
1202 example# \fBluxadm \fR\fB-e\fR\fB bus_unquiesce /dev/rdsk/c1t8d0s2\fR
1203 example# \fBluxadm \fR\fB-e\fR\fB online /dev/rdsk/c1t8d0s2\fR
1204 example# \fBluxadm release /dev/rdsk/c1t8d0s2\fR
1205 .fi
1206 .in -2
1207 .sp
1208 
1209 .SH ENVIRONMENT VARIABLES
1210 .LP
1211 See \fBenviron\fR(5) for a description of the \fBLANG\fR environment variable
1212 that affects the execution of \fBluxadm\fR.
1213 .SH EXIT STATUS
1214 .LP
1215 The following exit values are returned:
1216 .sp
1217 .ne 2
1218 .na
1219 \fB\fB0\fR\fR
1220 .ad
1221 .RS 9n
1222 Successful completion.
1223 .RE
1224 
1225 .sp
1226 .ne 2
1227 .na
1228 \fB\fB\(mi1\fR\fR
1229 .ad
1230 .RS 9n
1231 An error occurred.
1232 .RE
1233 
1234 .SH FILES
1235 .ne 2
1236 .na
1237 \fB\fBusr/lib/firmware/fc_s/fc_s_fcode\fR\fR
1238 .ad
1239 .sp .6
1240 .RS 4n
1241 
1242 .RE
1243 
1244 .sp
1245 .ne 2
1246 .na
1247 \fB\fBusr/lib/locale/C/LC_MESSAGES/ibfirmware\fR\fR
1248 .ad
1249 .sp .6
1250 .RS 4n
1251 
1252 .RE
1253 
1254 .SH SEE ALSO
1255 .LP
1256 \fBdevlinks\fR(1M), \fBdisks\fR(1M), \fBattributes\fR(5), \fBenviron\fR(5),
1257 \fBses\fR(7D)
1258 .SH NOTES
1259 .LP
1260 Currently, only some device drivers
1261 support hot plugging. If hot plugging is attempted on a disk or bus where it is
1262 not supported, an error message of the form:
1263 .sp
1264 .in +2
1265 .nf
1266 luxadm: can't acquire "PATHNAME": No such file or directory
1267 .fi
1268 .in -2
1269 .sp
1270 
1271 .sp
1272 .LP
1273 will be displayed.
1274 .sp
1275 .LP
1276 You must be careful not to quiesce a bus that contains the root or the
1277 \fB/usr\fR filesystems or any swap data. If you do quiesce such a bus a
1278 deadlock can result, requiring a system reboot.