Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

stmsboot(8)

Name

stmsboot - administration program for the Oracle Solaris I/O multipathing feature

Synopsis

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

Description

The Oracle Solaris I/O multipathing feature is a multipathing solution for storage devices that is part of the Oracle 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 Oracle Solaris I/O multipathing. The Oracle Solaris I/O multipathing-enabled devices are enumerated under scsi_vhci(4D), providing multipathing capabilities. Oracle Solaris I/O multipathing-disabled devices are enumerated under the physical controller.

In the /dev and /devices trees, the Oracle Solaris I/O multipathing-enabled devices receive new names that indicate that they are under the Oracle Solaris I/O multipathing control. This means a device will have a different name from its original name (after enabling) when it is under Oracle 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 Oracle Solaris I/O multipathing. One reboot is required for changes to take effect.

Options

The following options are supported:

–e [ –D fp | mpt | mpt_sas | iscsi ]

Enables Oracle Solaris I/O multipathing on all supported multipath-capable controller ports, including fp(4D), mpt(4D), mpt_sas(4D), and iscsi(4D) port drivers. Multipath-capable ports include fibre channel (fp(4D)) controller ports and SAS (mpt(4D) or mpt_sas(4D)) controller ports. Following this enabling, you are prompted to reboot. During the reboot, vfstab and the dump configuration will be updated to reflect the device name changes. Specifying –D mpt, –D mpt_sas, or –D fp limits the enabling operation to ports attached using the specified driver.

–d [ –D fp | mpt | mpt_sas | iscsi ]

Disables Oracle Solaris I/O multipathing on all supported multipath-capable controller ports, including fp(4D), mpt(4D), mpt_sas(4D), and iscsi(4D) port drivers. Multipath-capable ports include fibre channel (fp(4D)) controller ports and SAS (mpt(4D) or mpt_sas(4D)) controller ports. Following this disabling, you are prompted to reboot. During the reboot, vfstab and the dump configuration will be updated to reflect the device name changes. Specifying –D mpt, –D mpt_sas, or –D fp limits the disabling operation to ports attached using the specified driver.

–u [ –D fp | mpt | mpt_sas | iscsi ]

Updates vfstab and the dump configuration after you have manually modified the configuration to have Oracle Solaris I/O multipathing enabled or disabled on specific fp(4D), mpt(4D), mpt_sas(4D), and iscsi(4D) controller ports. This option prompts you to reboot. During the reboot, vfstab and the dump configuration will be updated to reflect the device name changes.

–L

Display the device name changes from non-Solaris I/O multipathing device names to Oracle Solaris I/O multipathing device names for multipath-enabled controller ports. If Oracle Solaris I/O multipathing is not enabled, then no mappings are displayed.

–l controller_number

Display the device name changes from non-Solaris I/O multipathing device names to Oracle Solaris I/O multipathing device names for the specified controller. If the Oracle Solaris I/O multipathing is not enabled, then no mappings are displayed.

Note that mpt_sas(4D) has MPxIO turned on by default. This means that when using the –L or –l option with –D mpt_sas, stmsboot does not display any non-multipathed and multipathed device names.

Usage

The primary function of stmsboot is to control the enabling and disabling of the Oracle Solaris I/O multipathing on the host. The utility automatically updates vfstab(5) and dumpadm(8) 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 Oracle 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.

Examples

Example 1 Enabling Oracle Solaris I/O Multipathing

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

# stmsboot -e

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

# stmsboot -D mpt -e

To enable Oracle Solaris I/O multipathing on multipath-capable mpt_sas(4D) controller ports, enter:

# stmsboot -D mpt_sas -e

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

# stmsboot -D fp -e

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

# stmsboot -D iscsi -e
Example 2 Disabling Oracle Solaris I/O Multipathing

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

# stmsboot -d

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

# stmsboot -D mpt -d

To disable Oracle Solaris I/O multipathing on multipath-capable mpt_sas(4D) controller ports, enter:

# stmsboot -D mpt_sas -d

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

# stmsboot -D iscsi -d

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

# stmsboot -D fp -d
Example 3 Enabling Oracle Solaris I/O Multipathing on Selected Ports

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

# stmsboot -u

A similar procedure involving the /etc/driver/drv/mpt.conf file should be followed for devices attached by means of the mpt(4D) driver. For devices attached by means of the iscsi(4D) driver, follow a similar procedure that uses the /etc/driver/drv/iscsi.conf file.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/device-administration, system/library
Interface Stability
Obsolete

See Also

emlxs(4D), fcp(4D), fp(4D), iscsi(4D), mpt(4D), mpt_sas(4D), qlc(4D), scsi_vhci(4D), ufsdump(5), vfstab(5), dumpadm(8), fsck(8), mpathadm(8), ufsdump(8), zfs(8), zpool(8)

Managing SAN Devices and I/O Multipathing in Oracle Solaris 11.4

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

Notes

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

For Oracle 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.

Using ufsdump

The ufsdump(8) command records details of filesystem dumps in /etc/dumpdates (see ufsdump(5)). 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 the Oracle 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.

Procedure to Use stmsboot in Conjunction with Oracle Solaris Cluster

If possible, invoke stmsboot –e before installing Oracle Solaris Cluster software. After executing stmsboot, install Oracle Solaris Cluster software normally.

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


Note -  Complete all steps on a single node before beginning any of the steps on a second node.
  • On each machine in the cluster where Oracle Solaris I/O multipathing is required, execute the following steps on one cluster node at a time and allow the system to reboot.

    # stmsboot -e
  • When the system comes up, enter the following two commands:

    1. # /usr/cluster/bin/scdidadm -C

    2. # /usr/cluster/bin/scdidadm -r

      The preceding commands update did mappings with new device names while preserving did instance numbers for disks that are connected to multiple cluster nodes. did instance numbers of the local disks might not be preserved. For this reason, the did disk names for local disks might change.

      The remaining steps are required only if local did number changes require editing of /etc/vfstab. If such editing is not required, run /usr/cluster/bin/scgdevs command and then /usr/cluster/bin/clquorum status command from the cluster node to complete the procedure on this node.

  • Update /etc/vfstab to reflect any new did disk names for your local disks.

  • Reboot the system.

To disable the Oracle 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(8) 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(8) can assist with determining the active and passive path(s).

Limitations

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

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.