te
Copyright 2008 Sun Microsystems, Inc. All Rights reserved. Use is subject to license terms.
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. 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
stmsboot - administration program for the Solaris I/O multipathing feature

/usr/sbin/stmsboot [[-d | -e [-D (fp | mpt) ]]
 | -u | -L | -l controller_number]

The Solaris I/O multipathing feature is a multipathing solution for storage devices that is part of the Solaris operating environment. This feature was formerly known as Sun StorEdge Traffic Manager (STMS) or MPxIO.

The stmsboot program is an administrative command to manage enumeration of multipath-capable devices with Solaris I/O multipathing. Solaris I/O multipathing-enabled devices are enumerated under scsi_vhci(7D), providing multipathing capabilities. Solaris I/O multipathing-disabled devices are enumerated under the physical controller.

In the /dev and /devices trees, Solaris I/O multipathing-enabled devices receive new names that indicate that they are under Solaris I/O multipathing control. This means a device will have a different name from its original name (after enabling) when it is under Solaris I/O multipathing control. The stmsboot command automatically updates /etc/vfstab and dump configuration to reflect the device names changes when enabling or disabling Solaris I/O multipathing. One reboot is required for changes to take effect.

The following options are supported:

-e [ -D fp | mpt ]

-d [ -D fp | mpt ]

-u

-L

-l controller_number

The primary function of stmsboot is to control the enabling and disabling of Solaris I/O multipathing on the host. The utility automatically updates vfstab(4) and dumpadm(1M) configuration to reflect device name changes. The system administrator is responsible for modifying application configuration (for example, backup software, DBMS, and so forth) to reflect updated device names.

The -L and -l options display the mapping between multipathed and non-multipathed device names. These options function only after changes to the Solaris I/O multipathing configuration have taken effect, that is, following the reboot after invoking stmsboot -e.

ZFS datasets, including ZFS root datasets, are correctly handled by stmsboot.

Example 1 Enabling Solaris I/O Multipathing

To enable Solaris I/O multipathing for all multipath-capable controllers, run:

# stmsboot -e

To enable Solaris I/O multipathing on multipath-capable mpt(7D) controller ports, enter:

# stmsboot -D mpt -e

To enable Solaris I/O Multipathing on multipath-capable fibre channel controller ports, enter:

# stmsboot -D fp -e

Example 2 Disabling Solaris I/O Multipathing

To disable Solaris I/O multipathing on all multipath-capable controllers, enter:

# stmsboot -d

To disable Solaris I/O multipathing on multipath-capable mpt(7D) controller ports, enter:

# stmsboot -D mpt -d

To disable Solaris I/O multipathing on multipath-capable fibre channel controller ports, enter:

# stmsboot -D fp -d

Example 3 Enabling Solaris I/O Multipathing on Selected Ports

To enable Solaris I/O multipathing on specific fibre channel controller ports and disable the feature on others, manually edit the /kernel/drv/fp.conf file. (Seefp(7D).) The following command will update vfstab(4) and dumpadm(1M) configurations to reflect the changed device names:

# stmsboot -u

A similar procedure involving the /kernel/drv/mpt.conf file should be followed for devices attached by means of the mpt(7D) driver.

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Obsolete

dumpadm(1M), fsck(1M), mpathadm(1M), ufsdump(1M), zfs(1M), zpool(1M), dumpdates(4), vfstab(4), emlxs(7D), fcp(7D), fp(7D), mpt(7D), qlc(7D), scsi_vhci(7D)

Solaris SAN Configuration and Multipathing Guide (see http://docs.sun.com)

Consult a particular storage product's system administrator's guide and release notes for further information specific to that product.

Solaris I/O multipathing is not supported on all devices. After enabling Solaris I/O multipathing, only supported devices are placed under Solaris I/O multipathing control. Non-supported devices remain unchanged.

For Solaris releases prior to the current release, the -e and -d options replace mpxio-disable property entries with a global mpxio-disable entry in fp.conf.

The following applies to Sun StoreEdge T3, 3910, 3960, 6120, and 6320 storage subsystems.

To place your Sun StorEdge disk subsystem under Solaris I/O multipathing control, in addition to enabling Solaris I/O multipathing, the mp_support of the subsystem must be set to mpxio mode. The preferred sequence is to change the subsystem's mp_support to mpxio mode, then run stmsboot -e. If Solaris I/O multipathing is already enabled but the subsystem's mp_support is not in mpxio mode, then change the mp_support to mpxio mode and run stmsboot -u.

Refer to the Sun StorEdge Administrator's Guide for your subsystem for more details.

The ufsdump(1M) command records details of filesystem dumps in /etc/dumpdates (see dumpdates(4)). Among other items, the entries contain device names. An effect of the "active" stmsboot options (-e, -d, and -u) is to change the device name of a storage device.

Because stmsboot does not modify dumpdates, entries will refer to obsolete device names, that is, device names that were in effect before Solaris I/O multipathing configuration changes were performed. In this situation ufsdump will behave as if no previous dump of the filesystem had been performed. A level 0 dump will be performed.

If possible, invoke stmsboot -e before installing Sun Cluster software. After executing stmsboot, install Sun Cluster software normally.

If Sun Cluster software is installed before executing stmsboot, follow this procedure:

On each machine in the cluster where Solaris I/O multipathing is required, execute:

# stmsboot -e

...and allow the system to reboot.

When the system comes up, enter the following two commands:

To disable the Solaris multipathing feature, use stmsboot -d (instead of stmsboot -e), then follow the procedure above.

To view mappings between the old and new device names, run stmsboot -L. To view did device name mappings, run /usr/cluster/bin/scdidadm -L.

With active-passive storage arrays, it is possible that while your host is rebooting the array controller could failover the path that a particular target is using. In this scenario, fsck(1M) will fail to open the physical path listed in /etc/vfstab. The svc:/system/filesystem/local:default SMF service will transition to a maintenance state as a result. To rectify this, consult the documentation for your storage array to failback the path. The mpathadm(1M) can assist with determining the active and passive path(s).

On x86 platforms, the current Solaris release does not support disabling Solaris I/O multipathing of boot devices attached by means of fibre channel. Solaris I/O multipathing is always enabled for supported fibre channel-attached boot devices. Disabling Solaris I/O multipathing in this situation must be performed on a per-port basis. See fp(7D).

Executing devfsadm -C removes obsolete device entries that stmsboot relies on. This will prevent correct operation of the -d option for boot devices (regardless of platform type) and the -L option.