NAME

vicfg-mpath - display path information, change path state


SYNOPSIS

 vicfg-mpath [<conn_options>]  
   [--help |
    --list [--path <path> |--device <device>] |
    --list-compact [--path <path> |--device <device>] |
    --list-map [--path <path> |--device <device>] |
    --list-paths [--device <device>] |
    --list-plugins | 
    --state  [active|off] ]


DESCRIPTION

The vicfg-mpath command supports listing information about Fibre Channel or iSCSI LUNs and changing a path's state. Use vicfg-mpath35 when running against ESX/ESXi 3.5 systems. Use the esxcli command for managing pluggable storage architecture (PSA) and native multipathing (NMP), including path policy modification.


OPTIONS

connection_options

Specifies the target server and authentication information if required. Run vicfg-mpath --help for a list of all connection options.

--device | -d

Used to filter the list commands to display only information about the specified device.

--help

Prints a help message for each command-specific and each connection option. Calling the script with no arguments or with --help has the same effect.

--list | -l <path_or_device>

Lists detailed information for all paths on the system or for the specified path or device.

--list-compact | -L <path_or_device>

Lists all paths with abbreviated information.

--list-map | -m <path_or_device>

Lists all paths and the corresponding adapter and device mappings.

--list-paths | -b <device>

Lists all devices with their corresponding paths, or lists paths for the specified device.

--list-plugins | -G

Lists all multipathing plugins loaded into the system. At a minimum, this command returns NMP (Native Multipathing Plugin). If other MPP plugins have been loaded, they are listed as well. For information about storage array plugins, see the ESX Configuration Guide and the ESXi Configuration Guide. You manage plugins with the esxcli command; run esxcli --help to get started and see the vSphere Command-Line Interface Installation and Scripting Guide for more information.

--path | -P

Used to specify a specific path for operations. The path name may be either the long path UID or the shorter runtime name of the path. Use this option to filter any of the list commands to a specific path.

--state|-s active|off

Sets the state of a given LUN path to either active or off. This option requires that the --path options is set and specifies either the path UID or the path runtime name.

If you are changing a path's state, the change operation fails if I/O is active when the path setting is changed. Reissue the command. You must issue at least one I/O operation before the change takes effect.

--vihost | -h

When you run a vCLI command with the --server option pointing to a vCenter Server system, use --vihost to specify the ESX/ESXi host to run the command against.


EXAMPLES

The following examples assume you are specifying connection options. Run vicfg-mpath --help for a list of common options including connection options.

List all paths on the system with their detailed information:

    vicfg-mpath <conn_options> -l

List detailed information for the specified path:

    vicfg-mpath <conn_options> -l -P ide.vmhba32-ide.0:1-mpx.vmhba32:C0:T1:L0

List a path by specifying its runtime name with its detailed information:

    vicfg-mpath <conn_options> -l -P vmhba32:C0:T1:L0

List paths with its detailed information for a specific device:

    vicfg-mpath <conn_options> -l -d mpx.vmhba32:C0:T1:L0

List all paths with abbreviated information:

    vicfg-mpath <conn_options> -L

List all paths with adapter and device mappings:

    vicfg-mpath <conn_options> -m

List all devices with their corresponding paths:

    vicfg-mpath <conn_options> -b

List all multipathing plugins loaded into the system:

    vicfg-mpath -G

Set the state for a specific path to off. Requires the --path option.

    vicfg-mpath <conn_options> --state off --path <path name>

If you are changing a path's state, the change operation fails if I/O is active when the path setting is changed. Reissue the command. You must issue at least one I/O operation before the change takes effect.