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