NAME

luxadm - administration program for the Sun Enterprise Network Array (SENA) and SPARCstorage Array (SSA) subsystems

SYNOPSIS

luxadm [ options . . . ] subcommand [ options . . . ] enclosure [ ,dev ] . . . | pathname . . .

DESCRIPTION

The luxadm program is an administrative command that manages both the SENA and SPARCstorage Array subsystems. luxadm performs a variety of control and query tasks depending on the command line arguments and options used.

The command line must contain a subcommand. The command line may also contain options, usually at least one enclosure name or pathname, and other parameters depending on the subcommand. You need specify only as many characters as are required to uniquely identify a subcommand.

Specify the device that a subcommand interacts with by entering a pathname. For the SENA subsystem, a disk device or enclosure services controller may instead be specified by entering the World Wide Name (WWN) for the device or a port to the device. The device may also be specified by entering the name of the SENA enclosure, and an optional identifier for the particular device in the enclosure.

Pathname

Specify the device or controller by either a complete physical pathname or a complete logical pathname.

For SENA, a typical physical pathname for a device is:

/devices/sbus@1f,0/SUNW,socal@1,0/sf@0,0/ssd@w2200002037000f96,0:a,raw

or

/devices/io-unit@f,e0200000/sbi@0,0/SUNW,socal@2,0/sf@0,0/ssd@34,0:a,raw

For all SENA IBs (Interface Boards) on the system, a logical link to the physical paths is kept in the directory /dev/es. An example of a logical link is /dev/es/ses0.

For SENA, the WWN may be used in place of the pathname to select a device or SENA subsystem IB. The WWN is a unique 16 hexadecimal digit value that specifies either the port used to access the device or the device itself. A typical WWN value is: 2200002037000f96.

See NOTES for more information on the WWN formats.

For the SPARCstorage Array controller, a typical physical pathname is:

/devices/. . . /. . . /SUNW,soc@3,0/SUNW,pln@axxxxxxx, xxxxxxxx :ctlr

In order to make it easier to address the SPARCstorage Array controller, a logical pathname of the form cN is supported, where N is the logical controller number. luxadm uses the cN name to find an entry in the /dev/rdsk directory of a disk that is attached to the SPARCstorage Array controller. The /dev/rdsk entry is then used to determine the physical name of the SPARCstorage Array controller.

For a SPARCstorage Array disk, a typical physical pathname is:

/devices/. . . /. . . /SUNW,soc@3,0/SUNW,pln@axxxxxxx, xxxxxxxx /ssd@0,0:c,raw

and a typical logical pathname is:

/dev/rdsk/c1t0d0s2

Enclosure

For SENA, a device may be identified by its enclosure name and slotname:

box_name[,fslot_number]
box_name[,rslot_number]

box_name is the name of the SENA enclosure, as specified by the enclosure_name subcommand. When used without the optional slot_number parameter, the box_name identifies the SENA subsystem IB.

f or r specifies the front or rear slots in the SENA enclosure.

slot_number specifies the slot number of the device in the SENA enclosure, 0-6 or 0-10.

See disks(1M) and devlinks(1M) for additional information on logical names for disks and subsystems.

OPTIONS

The following options are supported by all subcommands:

-e

Expert mode. This option is not recommended for the novice user.

-v

Verbose mode.

Options that are specific to particular subcommands are described with the subcommand in the USAGE section.

OPERANDS

The following operands are supported:

enclosure

The box_name of the SENA.

pathname

The logical or physical path of a SENA IB, SPARCstorage Array controller (cN name) or disk devic. pathname can also be the WWN of a SENA IB or SENA disk.

USAGE

Subcommands

display enclosure[,dev] . . . | pathname . . .

display -p pathname . . .

display -r enclosure[,dev] . . . | pathname . . .

display -v enclosure[,dev] . . . | pathname . . .

Displays enclosure or device specific data.

Subsystem data consists of enclosure environmental sense information and status for all subsystem devices, including disks.

Disk data consists of inquiry, capacity, and configuration information.

-p

Displays performance information for the device or subsystem specified by pathname. This option only applies to subsystems that accumulate

performance information.

-r

Displays error information for the device specified by the pathname, or, if the path is a SENA, for all devices on the loop. The -r option only applies to SENA subsystems.

-v

Displays in verbose mode, including mode sense data.

probe [ -p ]

Finds and displays information about all attached SENA subsystems, including the logical pathname, the WWNs, and enclosure names. This subcommand warns the user if it finds different SENAs with the same enclosure names.

-p

Includes the physical pathname in the display.

download [ -s ] [ -w WWN ] [ -f filename_path ] enclosure. . . | pathname. . .

Download the prom image pointed to by filename_path to the SENA subsystem Interface Board unit or the SPARCstorage Array controllers specified by the enclosure or pathname. The SPARCstorage Array must be reset in order to use the downloaded code.

When the SENA's download is complete, the SENA will be reset and the downloaded code executed. If no filename is specified, the default prom image will be used. The default prom image for the SPARCstorage Array controller is in usr/lib/firmware/ssa/ssafirmware. The default prom image for the SENA is in the directory usr/lib/locale/C /LC_MESSAGES and is named ibfirmware. The SENA firmware is language dependent so The LANG environment variable is used to find the directory that contains the firmware. The default directory is C.

-s

Save. The -s option is used to save the downloaded firmware in the FEPROM. If -s is not specified, the downloaded firmware will not be saved across power cycles. The -s option does not apply to the SPARCstorage Array controller as it always writes the downloaded firmware into the FEPROM. When using the -s option, the download subcommand modifies the FEPROM on the subsystem and should be used with caution.

-w WWN

Change the SPARCstorage Array controller's World Wide Name. WWN is a 12-digit hex number; leading zeros are required. The -w option applies only to the SPARCstorage Array. The new SPARCstorage Array controller's image will have the least significant 6 bytes of the 8-byte World Wide Name modified to WWN.

enclosure_name new_name enclosure | pathname

Change the enclosure name of the enclosure or enclosures specified by the enclosure or pathname. The new name (new_name) must be 16 or less characters. Only alphabetic or numeric characters are acceptable. This

subcommand applies only to the SENA.

fc_s_download [ -F ] [ -f fcode-file ]

Download the fcode contained in the file fcode-file into all the FC/S Sbus Cards. This command is interactive and expects user confirmation before downloading the fcode. When invoked without the -f fcode-file option, the current version of the fcode in each FC/S Sbus card is printed. When the -F option is used, the fcode is forcibly downloaded, but the command still expects user confirmation before the download. The version of the FC/S Sbus Cards fcode that was released with this version of the Operating System is kept in the directory usr/lib/firmware/fc_s and is named fc_s_fcode.

Use fc_s_download only in single-user mode. Using fc_s_download to update a host adapter while there is I/O activity through that adapter will cause the adapter to reset.

fcal_s_download [ -f fcode-file ]

Download the fcode contained in the file fcode-file into all the FC100/S Sbus Cards. This command is interactive and expects user confirmation before downloading the fcode. When invoked without the -f option, the current version of the fcode in each FC100/S Sbus card is printed. The version of the FC100/S Sbus Cards fcode that was released with this version of the operating system is kept in the directory usr/lib/firmware/fc_s and is named fcal_s_fcode.

Use fcal_s_download only in single-user mode. Using fcal_s_download to update a host adapter while there is I/O activity through that adapter will cause the adapter to reset.

inquiry enclosure[,dev ] . . . | pathname . . .

Display the inquiry information for the selected device specified by the enclosure or pathname.

insert_device [ enclosure, dev . . . ]

Assist the user in the hot insertion of a new device or a chain of new devices. Refer to NOTES for limitations on hotplug operations. This subcommand applies only to the SENA.

If more than one enclosure has been specified, concurrent hot insertions on multiple busses can be performed. With no arguments to the subcommand, entire enclosures can be inserted.

This subcommand guides the user interactively through the hot insertion steps of a new device or chain of devices:

Informs the user that the device(s) can be safely inserted.

Requests confirmation from the user that the list(s) is/are as expected. Creates the logical device names for the new devices.

Displays the logical pathname for the devices.

led enclosure,dev . . . | pathname. . .

Display the current state of the LED associated with the disk specified by the enclosure or pathname. This subcommand only applies to subsystems that support this functionality.

led_blink enclosure,dev . . . | pathname . . .

Requests the subsystem to start blinking the LED associated with the disk specified by the enclosure or pathname. This subcommand only applies to subsystems that support this functionality.

led_off enclosure,dev . . . | pathname . . .

Requests the subsystem to disable (turn off) the LED associated with the disk specified by the enclosure or pathname. On a SENA subsystem, this may or may not cause the LED to turn off or stop blinking depending on the state of the SENA subsystem. Refer to the SENA Array Installation and Service Manual (p/n 802-7573). This subcommand only applies to subsystems that support this functionality.

led_on pathname . . .

Requests the subsystem to enable (turn on) the LED associated with the disk specified by the enclosure or pathname. This subcommand only applies to subsystems that support this functionality.

power_off enclosure [, dev ] . . . | pathname [ enclosure-port] . . . | controller tray-number

When a SENA is addressed, this subcommand causes the SENA subsystem to go into the power-save mode. The SENA drives are not available when in the power-save mode. When an Enclosure Services card within the SPARCstorage Array is addressed, the RSM tray is powered down. When a drive in a SENA is addressed the drive is set to the drive off/unmated state. In the drive off/unmated state, the drive is spun down (stopped) and in bypass mode.

power_on enclosure [ ,dev] . . .| pathname . . .

Causes the SENA subsystem to go out of the power-save mode, when this subcommand is addressed to a SENA. There is no programmatic way to power on the SPARCstorage Array RSM tray. When this subcommand is addressed to a drive the drive is set to its normal start-up state.

release enclosure[,dev] | pathname

Release a reservation held on the specified disk(s). If the pathname is of the SPARCstorage Array controller, then all of the disks in the SPARCstorage Array will be released.

remove_device enclosure[,dev] . . . | pathname . . .

Assists the user in hot removing a device or a chain of devices. This subcommand can also be used to remove entire enclosures. This subcommand applies only to the SENA. Refer to NOTES for limitations on hotplug

operations.

This subcommand guides the user interactively through the hot removal of a device or devices, and:

offlines the device, which will fail if the disk is open,

informs the user that device(s) can be safely removed,

informs the user which device to remove by blinking the activity LED on the enclosure,

requests confirmation from the user that the lists are as expected, and,

removes the logical device names for the device that was removed.

reserve enclosure[,dev] pathname

Reserve the specified disk(s) for exclusive use by the issuing host. If the pathname is of the SPARCstorage Array controller, then all of the disks in the SPARCstorage Array will be reserved.

set_boot_dev [ -y ] pathname

Set the boot-device variable in the system PROM to the physical device name specified by pathname, which can be a block special device or a mount-point. The command normally runs interactively requesting confirmation for setting the default boot-device in the PROM. The -y option can be used to run it non-interactively, in which case no confirmation is requested or required.

start [ -t tray-number ] pathname . . .

Spin up the specified disk(s). If pathname specifies the SPARCstorage Array controller, this action applies to all disks in the SPARCstorage Array.

-t

Spin up all disks in the tray specified by tray-number. pathname must specify the SPARCstorage Array controller.

stop [ -t tray-number ] pathname . . .

Spin down the specified disk(s). If pathname specifies the SPARCstorage Array controller, this action applies to all disks in the SPARCstorage Array.

-t

Spin down all disks in the tray specified by tray-number. pathname must specify the SPARCstorage Array controller.

SPARCstorage Array Subcommands

fast_write [ -s ] -c pathname

fast_write [ -s ] -d pathname

fast_write [ -s ] -e pathname

Enable or disable the use of the NVRAM to enhance the performance of writes in the SPARCstorage Array. pathname refers to the SPARCstorage Array controller or to an individual disk.

-s

Cause the SPARCstorage Array to save the change so it will persist across power-cycles.

-c

Enable fast writes for synchronous writes only.

-d

Disable fast writes.

-e

Enable fast writes.

nvram_data pathname

Display the amount of fast write data in the NVRAM for the specified disk. This command can only be used for an individual disk.

perf_statistics -d pathname
perf_statistics -e pathname

Enable or disable the accumulation of performance statistics for the specified SPARCstorage Array controller. The accumulation of performance statistics must be enabled before using the display -psubcommand. This subcommand can be issued only to the SPARCstorage Array controller.

-d

Disable the accumulation of performance statistics.

-e

Enable the accumulation of performance statistics.

purge pathname

Purge any fast write data from NVRAM for one disk, or all disks if the controller is specified. This option should be used with caution, usually only when a drive has failed.

sync_cache pathname

Flush all outstanding writes for the specified disk from NVRAM to the media. If pathname specifies the controller, this action applies to all disks in the SPARCstorage Array subsystem.

Enclosure Services Card Subcommands

The env_display and alarm* subcommands apply only to an Enclosure Services Card (SES) in a RSM tray in a SPARCstorage Array. The RSM tray is addressed by using the logical or physical path of the SES device or by specifying the controller followed by the tray number. The controller is addressed by cN or the physical path to the SSA's controller.

alarm pathname | controller tray_number

Display the current state of audible alarm.

alarm_off pathname | controller tray_number

Disable the audible alarm for this RSM tray.

alarm_on pathname | controller tray_number

Enable the audible alarm for this RSM tray.

alarm_set controller-pathname | controller tray_number [ seconds ]

Set the audible alarm setting to seconds.

env_display pathname | controller tray_number

Display the environmental information for the specified unit.

Expert Mode Subcommands

The following subcommands are for expert use only, and are applicable only to the SENA subsystem. They should only be used by users that are knowledgeable about the SENA subsystem and fiber channel loops.

-e forcelip enclosure [ , dev] . . . | pathname . . .

Force the link to reinitialize, using the Loop Initialization Primitive (LIP) sequence. The enclosure or pathname can specify any device on the loop. This is an expert only command and should be used with caution. It will reset all ports on the loop.

-e rdls enclosure [ , dev] . . . | pathname . . .

Read and display the link error status information for all available devices on the loop that contains the device specified by the enclosure or pathname.

EXAMPLES

The following example finds and displays all of the SENAs on a system:

array% luxadm probe

The following example displays an SSA:

array% luxadm display c1

The following example displays a SENA:

array% luxadm display /dev/es/ses0

The following example displays of two subsystems using the enclosure names:

array% luxadm display BOB system1

The following example displays information about the first disk in the front of the enclosure named BOB ,f1.Use f to specify the front disks. Use r to specify the rear disks.

array% luxadm display BOB ,f1

The following example displays information about a SENA disk or enclosure with the port WWN of 2200002037001246 :

array% luxadm display 2200002037001246

The following example uses only as many characters as are required to uniquely identify a subcommand:

array% luxadm disp BOB

The following example displays error information about the loop that the enclosure BOB is on:

array% luxadm display -r BOB

The following example downloads new firmware into the Interface Board in the enclosure named BOB (that this is using the default path for the file to download):

array% luxadm download BOB

The following example displays information from the SCSI inquiry command from all individual disks on the system, using only as many characters as necessary to uniquely identify the inquiry subcommand:

array% luxadm inq /dev/rdsk/c?t?d?s2

The following example hotplugs a new drive into the first slot in the front of the enclosure named BOB ,f1:

array% luxadm insert_device BOB ,f1

The following example runs an expert subcommand. The subcommand forces a loop initialization on the loop that the enclosure BOB is on:

array% luxadm -e forcelip BOB

ENVIRONMENT

See environ(5) for descriptions of the following environment variables that affect the execution of luxadm:

LANG

EXIT STATUS

The following exit values are returned:

0

Successful completion.

-1

An error occurred.

FILES

usr/lib/firmware/fc_s/fcal_s_fcode

usr/lib/firmware/fc_s/fc_s_fcode
usr/lib/firmware/ssa/ssafirmware
usr/lib/locale/C/LC_MESSAGES/ibfirmware

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

usr/sbin

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWluxop

SEE ALSO

devlinks(1M), disks(1M), ssaadm(1M), attributes(5), environ(5), ses(7D) Snively, R., Tutorial for SCSI use of IEEE company_ID, X3T10/97-101r2, February 25, 1996 SENA Array Installation and Service Manual (p/n 802-7573).

NOTES

See the SENA Array Installation and Service Manual for additional information on the SENA. Refer to Tutorial for SCSI use of IEEE company_ID, R. Snively. for additonal information regarding the IEEE extended WWN. See SEE ALSO.