Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
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]
mpathadm subcommand direct-object [options] [operand]
The mpathadm command enables multipathing discovery and management. The mpathadm command is implemented as a set of subcommands, many with their own options, that are described in the section for that subcommand. Options not associated with a particular subcommand are described under OPTIONS. The mpathadm subcommands operate on a direct-object. These are described in this section for each subcommand. The direct-objects, initiator-port, target-port, andlogical-unit in the subcommands are consistent with SCSI standard definitions.
The mpathadm command supports the following subcommands, which are described in detail in subsections that follow. list
Display a list of discovered instances for a given object.
Display information about a given object instance.
Modify properties of an object.
Enable an object.
Disable an object.
Cause target port group failover for a logical-unit.
Set a path to be used over other paths on a logical-unit.
The mpathadm subcommands operate on a direct-object. These are described in this section for each subcommand.
The syntax for the list subcommand is:
# mpathadm list direct-object [operands...]
The list subcommand displays data for following direct-objects: mpath-support [mpath-support-name, ...]
List the multipathing support that can be administered by this CLI. This presents itself in the form of a library name registered through the MPAPI framework. If no mpath-support name mpath-support-name is specified, all registered multipathing support libraries will be displayed.
List the initiator ports that are discovered on this system. If no initiator-port-name is specified, all discovered initiator ports are displayed.
List the information on multipath logical units. If no logical-unit-name is specified, all discovered logical-units will be displayed. Options for list logical-unit are as follows: -n, --name name
Return the logical unit name that is associated with the given name string. This name can be extracted from the output of the mpathadm show lu command.
Return the list of logical units names that are associated with the given target-port-name.
The syntax for the show subcommand is:
# mpathadm show direct-object [operands...]
The show subcommand displays detailed information for following the direct-objects: mpath-support [mpath-support-name, ...]
Show the detailed information on the given mpath-support-name if the name exists. If the given mpath-support-name supports only a limited set of device products, the list of device products will be listed as part of the output.
Show the detailed information for the given initiator-port-name.
Display the detailed information on multipath logical unit(s), including path and target port group information. Note that the name property in the logical unit information represents the identifier for this LUN, derived from the hardware, and used by this system. If the name is derived from SCSI Inquiry Vital Product Data (VPD) page 83h, the name type property represents an associated identifier type defined by the SCSI standards.
The syntax for the modify subcommand is:
# mpathadm modify direct-object [options] [operands...]
The modify subcommand modifies characteristics of the following direct-objects: mpath-support [options] mpath-support-name, ...
Configuration management of an mpath-support. Options to modify mpath-support are as follows: -a, --autofailback on | off
Set autofailback. Applicable only when mpath-support provides auto failback support.
Set autoprobing. Applicable only when mpath-support provides auto probing support.
Change the default load balance type. The loadbalance type is one of the supported types listed in the show mpath-support output.
Configuration management of a logical unit. Options to modify logical-unit are as follows: -a, --autofailback on | off
Set autofailback. Applicable only when mpath-support provides auto failback support
Set autoprobing. Applicable only when mpath-support provides auto probing support.
Set load balance type for the logical unit. Applicable only when load balance configuration is supported at the logical unit level.
The syntax for the enable subcommand is:
# mpathadm disable [options]
The enable subcommand supports the following direct-objects to be enabled: path -i initiator-port-name -t target-port-name
-l logical-unit-name
The path that consists of the specified initiator port, target port, and logical unit will be enabled.
The syntax for the disable subcommand is:
# mpathadm disable [options]
The disable subcommand supports the following direct-objects to be disabled: path -i initiator-port-name -t target-port-name
-l logical-unit-name
The path that consists of the specified initiator port, target port, and logical unit will be disabled.
The syntax for the failover subcommand is:
# mpathadm failover direct-object [operand]
The failover subcommand supports failover for the following direct-objects: {logical-unit | lu} logical-unit-name
The target port group will failover when the given logical-unit is asymmetric and supports explicit state change. The currently active target port group will be changed to the standby state and the standby target port group will be active.
The syntax for the override subcommand is:
# mpathadm override [options]
The override subcommand controls whether or not the following direct-objects override another: path {-i initiator-port-name -t target-port-name | -c}
-l logical-unit-name
Cause a path that consists of the specified initiator port, target port, and logical unit to override other paths on the logical unit. Once a path overrides other paths, the mpath-support uses only that path regardless of any other path selection configuration. The -c option cancels the setting. The path that consists of the specified initiator port, target port, and logical unit will be disabled. Options for override path are as follows: -i, --initiator-port initiator-port-name
Represent the initiator port element of a path. Options -t and -l must also be included.
Represent the target port element of a path. Options -i and -l must also be included.
Represent the logical unit element of a path. Options -i and -t must also be included.
Cancels overriding setting for the given logical unit. Option -l must also be included.
The following options are supported: -V, --version
Display the version information.
Display context help. Can be used following an mpathadm command with no arguments, following a subcommand, or following a subcommand direct-object combination. Responds with help information appropriate for your entry. For example, if you enter:
# mpathadm add mpath-support-help
... mpathadm responds with a display of the options available for that
combination of subcommand and direct-object.
Example 1 Obtaining a List of Multipathing Support
The following command uses the list subcommand to list all currently registered mpath-support libraries.
# mpathadm list mpath-support mpath-support: libmpscsi_vhci.so
Example 2 Displaying the Properties of a Particular Multipathing Support
The following command uses the show subcommand to display the properties for a currently registered mpath-support library.
# mpathadm show mpath-support libmpscsi_vhci.so mpath-support: libmpscsi_vhci.so Vendor: Sun Microsystems Driver Name: scsi_vhci Default Load Balance: round-robin Supported Load Balance Types: round-robin logical-block Allows To Activate Target Port Group Access: yes Allows Path Override: no Supported Auto Failback Config: 1 Auto Failback: on Failback Polling Rate (current/max): 0/0 Supported Auto Probing Config: 0 Auto Probing: NA Probing Polling Rate (current/max): NA/NA Supported Devices: Vendor: SUN Product: T300 Revision: Supported Load Balance Types: round-robin Vendor: SUN Product: T4 Revision: Supported Load Balance Types: round-robin
Example 3 Obtaining a List of Initiator Ports Discovered Through the mpath-support Libraries
The following command uses the list initiator-port subcommand to display a list of initiator ports discovered by the currently registered mpath-support libraries.
# mpathadm list initiator-port Initiator-Port: iqn.1986-03.com.sun:01:080020b7ac2b.437a3b3e,4000002a0000 Initiator-Port: 2000000173018713 Initiator-Port: 2000000173818713
Example 4 Displaying the Properties of a Particular Initiator Port
The following command uses the show initiator-port subcommand to display the properties of a particular initiator port discovered using the list initiator-port subcommand in an example above.
# mpathadm show initiator-port 2000000173018713 initiator-port: 2000000173018713 Transport Type: Fibre Channel OS device File: devices/pci@1f,4000/pci@2/SUNW,qlca@5/fp@0,0:fc
Example 5 Displaying the Properties of a Particular Logical Unit
The following command uses the show logical-unit subcommand to display the properties of the logical unit with the specified name.
# mpathadm show lu /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2 Logical Unit: /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2 mpath-support libmpscsi_vhci.so Vendor: SUN Product: T4 Revision: 0301 Name Type: SCSI Inquiry VPD Page 83 type 3 Name: 60003ba27d2120004204ac2b000dab00 Asymmetric: yes Current Load Balance: round-robin Logical Unit Group ID: NA Aauto Failback: on Auto Probing: NA Paths: Initiator Port Name: 2000000173818713 Target Port Name: 20030003ba27d212 Override Path: NA Path State: OK Disabled: no Initiator Port Name: 2000000173018713 Target Port Name: 20030003ba27d095 Override Path: NA Path State: OK Disabled: no Target Port Group: ID: 2 Explicit Failover: yes Access State: standby Target Ports: Name: 20030003ba27d212 Relative ID: 0 ID: 5 Explicit Failover: yes Access State: active Target Ports Name: 20030003ba27d095 Relative ID: 0
Example 6 Enabling a Path
The following command uses the enable path subcommand to enable the path with the specified initiator port, target port, and logical unit.
# mpathadm enable path -i 2000000173018713 -t 20030003ba27d095 \e
-l /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2
Example 7 Modifying mpath-support To Turn On autofailback
# mpathadm modify mpath-support -a on libmpscsi_vhci.so
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Evolving |
stmsboot(1M), libMPAPI(3LIB), exec_attr(4), attributes(5)