1mpathadm(1M) System Administration Commands mpathadm(1M)
2
3
4
6 mpathadm - multipath discovery and administration
7
9 mpathadm subcommand direct-object [options] [operand]
10
11
13 The mpathadm command enables multipathing discovery and management. The
14 mpathadm command is implemented as a set of subcommands, many with
15 their own options, that are described in the section for that subcom‐
16 mand. Options not associated with a particular subcommand are described
17 under OPTIONS. The mpathadm subcommands operate on a direct-object.
18 These are described in this section for each subcommand. The direct-
19 objects, initiator-port, target-port, andlogical-unit in the subcom‐
20 mands are consistent with SCSI standard definitions.
21
22
23 The mpathadm command supports the following subcommands, which are
24 described in detail in subsections that follow.
25
26 list Display a list of discovered instances for a given object.
27
28
29 show Display information about a given object instance.
30
31
32 modify Modify properties of an object.
33
34
35 enable Enable an object.
36
37
38 disable Disable an object.
39
40
41 failover Cause target port group failover for a logical-unit.
42
43
44 override Set a path to be used over other paths on a logical-unit.
45
46
47
48 The mpathadm subcommands operate on a direct-object. These are
49 described in this section for each subcommand.
50
51 list Subcommand
52 The syntax for the list subcommand is:
53
54 # mpathadm list direct-object [operands...]
55
56
57
58 The list subcommand displays data for following direct-objects:
59
60 mpath-support [mpath-support-name, ...]
61
62 List the multipathing support that can be administered by this CLI.
63 This presents itself in the form of a library name registered
64 through the MPAPI framework. If no mpath-support name mpath-sup‐
65 port-name is specified, all registered multipathing support
66 libraries will be displayed.
67
68
69 initiator-port [initiator-port-name, ...]
70
71 List the initiator ports that are discovered on this system. If no
72 initiator-port-name is specified, all discovered initiator ports
73 are displayed.
74
75
76 {logical-unit | lu} [options] [logical-unit-name, ...]
77
78 List the information on multipath logical units. If no logical-
79 unit-name is specified, all discovered logical-units will be dis‐
80 played.
81
82 Options for list logical-unit are as follows:
83
84 -n, --name name
85
86 Return the logical unit name that is associated with the given
87 name string. This name can be extracted from the output of the
88 mpathadm show lu command.
89
90
91 -t, --target-port target-port-name
92
93 Return the list of logical units names that are associated with
94 the given target-port-name.
95
96
97
98 show Subcommand
99 The syntax for the show subcommand is:
100
101 # mpathadm show direct-object [operands...]
102
103
104
105 The show subcommand displays detailed information for following the
106 direct-objects:
107
108 mpath-support [mpath-support-name, ...]
109
110 Show the detailed information on the given mpath-support-name if
111 the name exists. If the given mpath-support-name supports only a
112 limited set of device products, the list of device products will be
113 listed as part of the output.
114
115
116 initiator-port initiator-port-name[,initiator-port-name, ...]
117
118 Show the detailed information for the given initiator-port-name.
119
120
121 {logical-unit | lu} [logical-unit-name, ...]
122
123 Display the detailed information on multipath logical unit(s),
124 including path and target port group information. Note that the
125 name property in the logical unit information represents the iden‐
126 tifier for this LUN, derived from the hardware, and used by this
127 system. If the name is derived from SCSI Inquiry Vital Product Data
128 (VPD) page 83h, the name type property represents an associated
129 identifier type defined by the SCSI standards.
130
131
132 modify Subcommand
133 The syntax for the modify subcommand is:
134
135 # mpathadm modify direct-object [options] [operands...]
136
137
138
139 The modify subcommand modifies characteristics of the following direct-
140 objects:
141
142 mpath-support [options] mpath-support-name, ...
143
144 Configuration management of an mpath-support. Options to modify
145 mpath-support are as follows:
146
147 -a, --autofailback on | off
148
149 Set autofailback. Applicable only when mpath-support provides
150 auto failback support.
151
152
153 -p, --autoprobe on | off
154
155 Set autoprobing. Applicable only when mpath-support provides
156 auto probing support.
157
158
159 -b, --loadbalance loadbalance-type
160
161 Change the default load balance type. The loadbalance type is
162 one of the supported types listed in the show mpath-support
163 output.
164
165
166
167 {logical-unit | lu} [options] logical-unit-name, ...
168
169 Configuration management of a logical unit. Options to modify logi‐
170 cal-unit are as follows:
171
172 -a, --autofailback on | off
173
174 Set autofailback. Applicable only when mpath-support provides
175 auto failback support
176
177
178 -p, --autoprobe on | off
179
180 Set autoprobing. Applicable only when mpath-support provides
181 auto probing support.
182
183
184 -b, --loadbalance loadbalance-type
185
186 Set load balance type for the logical unit. Applicable only
187 when load balance configuration is supported at the logical
188 unit level.
189
190
191
192 enable Subcommand
193 The syntax for the enable subcommand is:
194
195 # mpathadm disable [options]
196
197
198
199 The enable subcommand supports the following direct-objects to be
200 enabled:
201
202 path -i initiator-port-name -t target-port-name
203 -l logical-unit-name
204
205 The path that consists of the specified initiator port, target
206 port, and logical unit will be enabled.
207
208
209 disable Subcommand
210 The syntax for the disable subcommand is:
211
212 # mpathadm disable [options]
213
214
215
216 The disable subcommand supports the following direct-objects to be dis‐
217 abled:
218
219 path -i initiator-port-name -t target-port-name
220 -l logical-unit-name
221
222 The path that consists of the specified initiator port, target
223 port, and logical unit will be disabled.
224
225
226 failover Subcommand
227 The syntax for the failover subcommand is:
228
229 # mpathadm failover direct-object [operand]
230
231
232
233 The failover subcommand supports failover for the following direct-
234 objects:
235
236 {logical-unit | lu} logical-unit-name
237
238 The target port group will failover when the given logical-unit is
239 asymmetric and supports explicit state change. The currently active
240 target port group will be changed to the standby state and the
241 standby target port group will be active.
242
243
244 override Subcommand
245 The syntax for the override subcommand is:
246
247 # mpathadm override [options]
248
249
250
251 The override subcommand controls whether or not the following direct-
252 objects override another:
253
254 path {-i initiator-port-name -t target-port-name | -c}
255 -l logical-unit-name
256
257 Cause a path that consists of the specified initiator port, target
258 port, and logical unit to override other paths on the logical unit.
259 Once a path overrides other paths, the mpath-support uses only that
260 path regardless of any other path selection configuration. The -c
261 option cancels the setting. The path that consists of the specified
262 initiator port, target port, and logical unit will be disabled.
263
264 Options for override path are as follows:
265
266 -i, --initiator-port initiator-port-name
267
268 Represent the initiator port element of a path. Options -t and
269 -l must also be included.
270
271
272 -t, --target-port target-port-name
273
274 Represent the target port element of a path. Options -i and -l
275 must also be included.
276
277
278 -l, --logical-unit logical-unit
279
280 Represent the logical unit element of a path. Options -i and -t
281 must also be included.
282
283
284 -c, --cancel
285
286 Cancels overriding setting for the given logical unit. Option
287 -l must also be included.
288
289
290
292 The following options are supported:
293
294 -V, --version Display the version information.
295
296
297 -?, --help Display context help. Can be used following an
298 mpathadm command with no arguments, following a sub‐
299 command, or following a subcommand direct-object com‐
300 bination. Responds with help information appropriate
301 for your entry. For example, if you enter:
302
303 # mpathadm add mpath-support-help
304
305
306 ... mpathadm responds with a display of the options
307 available for that combination of subcommand and
308 direct-object.
309
310
312 Example 1 Obtaining a List of Multipathing Support
313
314
315 The following command uses the list subcommand to list all currently
316 registered mpath-support libraries.
317
318
319 # mpathadm list mpath-support
320 mpath-support: libmpscsi_vhci.so
321
322
323
324 Example 2 Displaying the Properties of a Particular Multipathing Sup‐
325 port
326
327
328 The following command uses the show subcommand to display the proper‐
329 ties for a currently registered mpath-support library.
330
331
332 # mpathadm show mpath-support libmpscsi_vhci.so
333 mpath-support: libmpscsi_vhci.so
334 Vendor: Sun Microsystems
335 Driver Name: scsi_vhci
336 Default Load Balance: round-robin
337 Supported Load Balance Types:
338 round-robin
339 logical-block
340 Allows To Activate Target Port Group Access: yes
341 Allows Path Override: no
342 Supported Auto Failback Config: 1
343 Auto Failback: on
344 Failback Polling Rate (current/max): 0/0
345 Supported Auto Probing Config: 0
346 Auto Probing: NA
347 Probing Polling Rate (current/max): NA/NA
348 Supported Devices:
349 Vendor: SUN
350 Product: T300
351 Revision:
352 Supported Load Balance Types:
353 round-robin
354 Vendor: SUN
355 Product: T4
356 Revision:
357 Supported Load Balance Types:
358 round-robin
359
360
361
362 Example 3 Obtaining a List of Initiator Ports Discovered Through the
363 mpath-support Libraries
364
365
366 The following command uses the list initiator-port subcommand to dis‐
367 play a list of initiator ports discovered by the currently registered
368 mpath-support libraries.
369
370
371 # mpathadm list initiator-port
372 Initiator-Port: iqn.1986-03.com.sun:01:080020b7ac2b.437a3b3e,4000002a0000
373 Initiator-Port: 2000000173018713
374 Initiator-Port: 2000000173818713
375
376
377
378 Example 4 Displaying the Properties of a Particular Initiator Port
379
380
381 The following command uses the show initiator-port subcommand to dis‐
382 play the properties of a particular initiator port discovered using the
383 list initiator-port subcommand in an example above.
384
385
386 # mpathadm show initiator-port 2000000173018713
387 initiator-port: 2000000173018713
388 Transport Type: Fibre Channel
389 OS device File: devices/pci@1f,4000/pci@2/SUNW,qlca@5/fp@0,0:fc
390
391
392
393 Example 5 Displaying the Properties of a Particular Logical Unit
394
395
396 The following command uses the show logical-unit subcommand to display
397 the properties of the logical unit with the specified name.
398
399
400 # mpathadm show lu /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2
401 Logical Unit: /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2
402 mpath-support libmpscsi_vhci.so
403 Vendor: SUN
404 Product: T4
405 Revision: 0301
406 Name Type: SCSI Inquiry VPD Page 83 type 3
407 Name: 60003ba27d2120004204ac2b000dab00
408 Asymmetric: yes
409 Current Load Balance: round-robin
410 Logical Unit Group ID: NA
411 Aauto Failback: on
412 Auto Probing: NA
413
414 Paths:
415 Initiator Port Name: 2000000173818713
416 Target Port Name: 20030003ba27d212
417 Override Path: NA
418 Path State: OK
419 Disabled: no
420
421 Initiator Port Name: 2000000173018713
422 Target Port Name: 20030003ba27d095
423 Override Path: NA
424 Path State: OK
425 Disabled: no
426
427 Target Port Group:
428 ID: 2
429 Explicit Failover: yes
430 Access State: standby
431 Target Ports:
432 Name: 20030003ba27d212
433 Relative ID: 0
434
435 ID: 5
436 Explicit Failover: yes
437 Access State: active
438 Target Ports
439 Name: 20030003ba27d095
440 Relative ID: 0
441
442
443
444 Example 6 Enabling a Path
445
446
447 The following command uses the enable path subcommand to enable the
448 path with the specified initiator port, target port, and logical unit.
449
450
451 # mpathadm enable path -i 2000000173018713 -t 20030003ba27d095 \
452 -l /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2
453
454
455
456 Example 7 Modifying mpath-support To Turn On autofailback
457
458 # mpathadm modify mpath-support -a on libmpscsi_vhci.so
459
460
461
463 See attributes(5) for descriptions of the following attributes:
464
465
466
467
468 ┌─────────────────────────────┬────────────────────────────────┐
469 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
470 ├─────────────────────────────┼────────────────────────────────┤
471 │Availability │SUNWmpapi │
472 ├─────────────────────────────┼────────────────────────────────┤
473 │ │SUNWmpapir (exec_attr(4) entry) │
474 ├─────────────────────────────┼────────────────────────────────┤
475 │Interface Stability │Evolving │
476 └─────────────────────────────┴────────────────────────────────┘
477
479 stmsboot(1M), libMPAPI(3LIB), exec_attr(4), attributes(5)
480
481
482
483SunOS 5.11 4 May 2009 mpathadm(1M)