| Skip Navigation Links | |
| Exit Print View | |
![]() | man pages section 1M: System Administration Commands Oracle Solaris 11 Information Library |
- multipath discovery and administration
mpathadmsubcommanddirect-object [options] [operand]
Thempathadm command enables multipathing discovery and management. Thempathadm command isimplemented as a set of subcommands, many with their own options, thatare described in the section for that subcommand. Options not associated witha particular subcommand are described under OPTIONS. Thempathadm subcommands operate on adirect-object. These are described in this section for each subcommand. Thedirect-objects,initiator-port,target-port, andlogical-unit in the subcommands are consistent with SCSI standard definitions.
Thempathadm command supports the following subcommands, which are described in detailin subsections that follow.
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.
Thempathadm subcommands operate on adirect-object. These are described in thissection for each subcommand.
The syntax for thelist subcommand is:
# mpathadm listdirect-object [operands...]
Thelist subcommand displays data for following direct-objects:
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 namempath-support-name is specified, all registered multipathing support libraries will be displayed.
List the initiator ports that are discovered on this system. If noinitiator-port-name is specified, all discovered initiator ports are displayed.
List the information on multipath logical units. If nological-unit-name is specified, all discovered logical-units will be displayed.
Options forlist logical-unit are as follows:
Return the logical unit name that is associated with the given name string. This name can be extracted from the output of thempathadmshow lu command.
Return the list of logical units names that are associated with the giventarget-port-name.
The syntax for theshow subcommand is:
# mpathadm showdirect-object [operands...]
Theshow subcommand displays detailed information for following the direct-objects:
Show the detailed information on the givenmpath-support-name if the name exists. If the givenmpath-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 giveninitiator-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 themodify subcommand is:
# mpathadm modifydirect-object [options] [operands...]
Themodify subcommand modifies characteristics of the following direct-objects:
Configuration management of anmpath-support. Options to modify mpath-support are as follows:
Setautofailback. Applicable only when mpath-support provides auto failback support.
Setautoprobing. Applicable only when mpath-support provides auto probing support.
Change the default load balance type. Theloadbalance type is one of the supported types listed in theshow mpath-support output.
Configuration management of a logical unit. Options to modifylogical-unit are as follows:
Setautofailback. Applicable only whenmpath-support provides auto failback support
Setautoprobing. Applicable only whenmpath-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 theenable subcommand is:
# mpathadm disable [options]
Theenable subcommand supports the following direct-objects to be enabled:
The path that consists of the specified initiator port, target port, and logical unit will be enabled.
The syntax for thedisable subcommand is:
# mpathadm disable [options]
Thedisable subcommand supports the following direct-objects to be disabled:
The path that consists of the specified initiator port, target port, and logical unit will be disabled.
The syntax for thefailover subcommand is:
# mpathadm failoverdirect-object [operand]
Thefailover subcommand supports failover for the following direct-objects:
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 theoverride subcommand is:
# mpathadm override [options]
Theoverride subcommand controls whether or not the following direct-objects override another:
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:
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:
Display the version information.
Display context help. Can be used following anmpathadm 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 thelist subcommand to list all currently registeredmpath-support libraries.
#mpathadm list mpath-supportmpath-support: libmpscsi_vhci.so
Example 2 Displaying the Properties of a Particular Multipathing Support
The following command uses theshow subcommand to display the properties fora currently registeredmpath-support library.
#mpathadm show mpath-support libmpscsi_vhci.sompath-support: libmpscsi_vhci.so Vendor: Sun Microsystems Driver Name: scsi_vhci Default Load Balance: round-robin Supported Load Balance Types: round-robin logical-blockAllows To Activate Target Port Group Access: yesAllows Path Override: noSupported Auto Failback Config: 1Auto Failback: onFailback Polling Rate (current/max): 0/0Supported Auto Probing Config: 0Auto Probing: NAProbing Polling Rate (current/max): NA/NASupported 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 thempath-support Libraries
The following command uses thelist initiator-port subcommand to display a list ofinitiator ports discovered by the currently registeredmpath-support libraries.
#mpathadm list initiator-portInitiator-Port: iqn.1986-03.com.sun:01:080020b7ac2b.437a3b3e,4000002a0000Initiator-Port: 2000000173018713Initiator-Port: 2000000173818713
Example 4 Displaying the Properties of a Particular Initiator Port
The following command uses theshow initiator-port subcommand to display the properties ofa particular initiator port discovered using thelist initiator-port subcommand in an exampleabove.
#mpathadm show initiator-port 2000000173018713initiator-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 theshow logical-unit subcommand to display the properties ofthe logical unit with the specified name.
#mpathadm show lu /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2Logical 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: NAPaths: 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: noTarget 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 theenable path subcommand to enable the path withthe specified initiator port, target port, and logical unit.
#mpathadm enable path -i 2000000173018713 -t 20030003ba27d095 \ -l /dev/rdsk/c4t60003BA27D2120004204AC2B000DAB00d0s2
Example 7 Modifyingmpath-support To Turn Onautofailback
#mpathadm modify mpath-support -a on libmpscsi_vhci.so
Seeattributes(5) for descriptions of the following attributes:
|
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.Legal Notices | ![]() ![]() |