1stmsboot(1M) System Administration Commands stmsboot(1M)
2
6 stmsboot - administration program for the Solaris I/O multipathing fea‐
7 ture
8
10 /usr/sbin/stmsboot [[-d | -e [-D (fp | mpt) ]]
11 | -u | -L | -l controller_number]
12
15 The Solaris I/O multipathing feature is a multipathing solution for
16 storage devices that is part of the Solaris operating environment. This
17 feature was formerly known as Sun StorEdge Traffic Manager (STMS) or
18 MPxIO.
19 The stmsboot program is an administrative command to manage enumeration
22 of multipath-capable devices with Solaris I/O multipathing. Solaris I/O
23 multipathing-enabled devices are enumerated under scsi_vhci(7D), pro‐
24 viding multipathing capabilities. Solaris I/O multipathing-disabled
25 devices are enumerated under the physical controller.
26 In the /dev and /devices trees, Solaris I/O multipathing-enabled
29 devices receive new names that indicate that they are under Solaris I/O
30 multipathing control. This means a device will have a different name
31 from its original name (after enabling) when it is under Solaris I/O
32 multipathing control. The stmsboot command automatically updates
33 /etc/vfstab and dump configuration to reflect the device names changes
34 when enabling or disabling Solaris I/O multipathing. One reboot is
35 required for changes to take effect.
36
38 The following options are supported:
39 -e [ -D fp | mpt ]
41 Enables Solaris I/O multipathing on all supported multipath-capable
43 controller ports. Multipath-capable ports include fibre channel
44 (fp(7D)) controller ports and SAS (mpt(7D)) controller ports. Fol‐
45 lowing this enabling, you are prompted to reboot. During the
46 reboot, vfstab and the dump configuration will be updated to
47 reflect the device name changes. Specifying either -D mpt or -D fp
48 limits the enabling operation to ports attached using the specified
49 driver.
50 -d [ -D fp | mpt ]
53 Disables Solaris I/O multipathing on all supported multipath-capa‐
55 ble controller ports. Multipath-capable ports include fibre channel
56 (fp(7D)) controller ports and SAS (mpt(7D)) controller ports. Fol‐
57 lowing this disabling, you are prompted to reboot. During the
58 reboot, vfstab and the dump configuration will be updated to
59 reflect the device name changes. Specifying either -D mpt or -D fp
60 limits the disabling operation to ports attached using the speci‐
61 fied driver.
62 -u
65 Updates vfstab and the dump configuration after you have manually
67 modified the configuration to have Solaris I/O multipathing enabled
68 or disabled on specific multipath-capable controller ports. This
69 option prompts you to reboot. During the reboot, vfstab and the
70 dump configuration will be updated to reflect the device name
71 changes.
72 -L
75 Display the device name changes from non-Solaris I/O multipathing
77 device names to Solaris I/O multipathing device names for multi‐
78 path-enabled controller ports. If Solaris I/O multipathing is not
79 enabled, then no mappings are displayed.
80 -l controller_number
83 Display the device name changes from non-Solaris I/O multipathing
85 device names to Solaris I/O multipathing device names for the spec‐
86 ified controller. If Solaris I/O multipathing is not enabled, then
87 no mappings are displayed.
88
91 The primary function of stmsboot is to control the enabling and dis‐
92 abling of Solaris I/O multipathing on the host. The utility automati‐
93 cally updates vfstab(4) and dumpadm(1M) configuration to reflect device
94 name changes. The system administrator is responsible for modifying
95 application configuration (for example, backup software, DBMS, and so
96 forth) to reflect updated device names.
97 The -L and -l options display the mapping between multipathed and non-
100 multipathed device names. These options function only after changes to
101 the Solaris I/O multipathing configuration have taken effect, that is,
102 following the reboot after invoking stmsboot -e.
103 ZFS datasets, including ZFS root datasets, are correctly handled by
106 stmsboot.
107
109 Example 1 Enabling Solaris I/O Multipathing
110 To enable Solaris I/O multipathing for all multipath-capable con‐
113 trollers, run:
114 # stmsboot -e
117 To enable Solaris I/O multipathing on multipath-capable mpt(7D) con‐
122 troller ports, enter:
123 # stmsboot -D mpt -e
126 To enable Solaris I/O Multipathing on multipath-capable fibre channel
131 controller ports, enter:
132 # stmsboot -D fp -e
135 Example 2 Disabling Solaris I/O Multipathing
139 To disable Solaris I/O multipathing on all multipath-capable con‐
142 trollers, enter:
143 # stmsboot -d
146 To disable Solaris I/O multipathing on multipath-capable mpt(7D) con‐
151 troller ports, enter:
152 # stmsboot -D mpt -d
155 To disable Solaris I/O multipathing on multipath-capable fibre channel
160 controller ports, enter:
161 # stmsboot -D fp -d
164 Example 3 Enabling Solaris I/O Multipathing on Selected Ports
168 To enable Solaris I/O multipathing on specific fibre channel controller
171 ports and disable the feature on others, manually edit the /ker‐
172 nel/drv/fp.conf file. (Seefp(7D).) The following command will update
173 vfstab(4) and dumpadm(1M) configurations to reflect the changed device
174 names:
175 # stmsboot -u
178 A similar procedure involving the /kernel/drv/mpt.conf file should be
183 followed for devices attached by means of the mpt(7D) driver.
184
187 See attributes(5) for descriptions of the following attributes:
188 ┌─────────────────────────────┬─────────────────────────────┐
193 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
194 ├─────────────────────────────┼─────────────────────────────┤
195 │Availability │SUNWcsu, SUNWcslr │
196 ├─────────────────────────────┼─────────────────────────────┤
197 │Interface Stability │Obsolete │
198 └─────────────────────────────┴─────────────────────────────┘
199
201 dumpadm(1M), fsck(1M), mpathadm(1M), ufsdump(1M), zfs(1M), zpool(1M),
202 dumpdates(4), vfstab(4), emlxs(7D), fcp(7D), fp(7D), mpt(7D), qlc(7D),
203 scsi_vhci(7D)
204 Solaris SAN Configuration and Multipathing Guide (see
207 http://docs.sun.com)
208 Consult a particular storage product's system administrator's guide and
211 release notes for further information specific to that product.
212
214 Solaris I/O multipathing is not supported on all devices. After
215 enabling Solaris I/O multipathing, only supported devices are placed
216 under Solaris I/O multipathing control. Non-supported devices remain
217 unchanged.
218 For Solaris releases prior to the current release, the -e and -d
221 options replace mpxio-disable property entries with a global mpxio-dis‐
222 able entry in fp.conf.
223 Enabling Solaris I/O Multipathing on a Sun StorEdge Disk Array
225 The following applies to Sun StoreEdge T3, 3910, 3960, 6120, and 6320
226 storage subsystems.
227 To place your Sun StorEdge disk subsystem under Solaris I/O multi‐
230 pathing control, in addition to enabling Solaris I/O multipathing, the
231 mp_support of the subsystem must be set to mpxio mode. The preferred
232 sequence is to change the subsystem's mp_support to mpxio mode, then
233 run stmsboot -e. If Solaris I/O multipathing is already enabled but the
234 subsystem's mp_support is not in mpxio mode, then change the mp_support
235 to mpxio mode and run stmsboot -u.
236 Refer to the Sun StorEdge Administrator's Guide for your subsystem for
239 more details.
240 Using ufsdump
242 The ufsdump(1M) command records details of filesystem dumps in
243 /etc/dumpdates (see dumpdates(4)). Among other items, the entries con‐
244 tain device names. An effect of the "active" stmsboot options (-e, -d,
245 and -u) is to change the device name of a storage device.
246 Because stmsboot does not modify dumpdates, entries will refer to obso‐
249 lete device names, that is, device names that were in effect before
250 Solaris I/O multipathing configuration changes were performed. In this
251 situation ufsdump will behave as if no previous dump of the filesystem
252 had been performed. A level 0 dump will be performed.
253 Procedure to Use stmsboot in Conjunction with Sun Cluster
255 If possible, invoke stmsboot -e before installing Sun Cluster software.
256 After executing stmsboot, install Sun Cluster software normally.
257 If Sun Cluster software is installed before executing stmsboot, follow
260 this procedure:
261 On each machine in the cluster where Solaris I/O multipathing is
264 required, execute:
265 # stmsboot -e
267 ...and allow the system to reboot.
272 When the system comes up, enter the following two commands:
275 1. # /usr/cluster/bin/scdidadm -C
277 2. # /usr/cluster/bin/scdidadm -r
279 The preceding commands update did mappings with new device
281 names while preserving did instance numbers for disks that
282 are connected to multiple cluster nodes. did instance num‐
283 bers of the local disks might not be preserved. For this
284 reason, the did disk names for local disks might change.
285 3. Update /etc/vfstab to reflect any new did disk names for
287 your local disks.
288 4. Reboot the system.
290 To disable the Solaris multipathing feature, use stmsboot -d (instead
293 of stmsboot -e), then follow the procedure above.
294 To view mappings between the old and new device names, run stmsboot -L.
297 To view did device name mappings, run /usr/cluster/bin/scdidadm -L.
298 With active-passive storage arrays, it is possible that while your host
301 is rebooting the array controller could failover the path that a par‐
302 ticular target is using. In this scenario, fsck(1M) will fail to open
303 the physical path listed in /etc/vfstab. The svc:/system/filesys‐
304 tem/local:default SMF service will transition to a maintenance state as
305 a result. To rectify this, consult the documentation for your storage
306 array to failback the path. The mpathadm(1M) can assist with determin‐
307 ing the active and passive path(s).
308
310 On x86 platforms, the current Solaris release does not support dis‐
311 abling Solaris I/O multipathing of boot devices attached by means of
312 fibre channel. Solaris I/O multipathing is always enabled for supported
313 fibre channel-attached boot devices. Disabling Solaris I/O multipathing
314 in this situation must be performed on a per-port basis. See fp(7D).
315 Executing devfsadm -C removes obsolete device entries that stmsboot
318 relies on. This will prevent correct operation of the -d option for
319 boot devices (regardless of platform type) and the -L option.
320SunOS 5.11 15 Dec 2008 stmsboot(1M)