Data Object Description

HostMultipathInfoPath

Path objects are identified by a key. The specifics of how the key is formatted are dependent on the implementation. Example implementations include using strings like "vmhba1:0:0:0".

Properties

Name	Type	Description
adapter	xsd:string	The host bus adapter at one endpoint of this path.
isWorkingPath*	xsd:boolean	A path, managed by a given path selection policy(psp) plugin, is denoted to be a Working Path if the psp plugin is likely to select the path for performing I/O in the near future. *Since* vSphere API 4.0
key	xsd:string	Identifier of the path.
lun	xsd:string	The logical unit at one endpoint of this path.
name	xsd:string	Name of path. Use this name to configure LogicalUnit multipathing policy using EnableMultipathPath and DisableMultipathPath.
pathState	xsd:string	Deprecated. As of VI API 4.0: System reported path states are available in state. Paths slated for I/O can be found using isWorkingPath. State of the path. Must be one of the values of MultipathState active Path can be used for I/O and is currently a working path. standby Path can be used for I/O but is not a working path or can be used if active paths fail. disabled Path has been administratively disabled. dead Path cannot be used for I/O. unknown Path is in unknown error state.
state*	xsd:string	System-reported state of the path. Must be one of the values of MultipathState active Path can be used for I/O. standby Path can be used for I/O if active paths fail. disabled Path has been administratively disabled. dead Path cannot be used for I/O. unknown Path is in unknown error state. *Since* vSphere API 4.0
transport*	HostTargetTransport	Transport information for the target end of the path.
Properties inherited from DynamicData
None

Name

Type

Description

adapter

xsd:string

The host bus adapter at one endpoint of this path.

isWorkingPath*

xsd:boolean

A path, managed by a given path selection policy(psp) plugin, is denoted to be a Working Path if the psp plugin is likely to select the path for performing I/O in the near future.

Since vSphere API 4.0

key

xsd:string

Identifier of the path.

lun

xsd:string

The logical unit at one endpoint of this path.

name

xsd:string

Name of path.

Use this name to configure LogicalUnit multipathing policy using EnableMultipathPath and DisableMultipathPath.

pathState

xsd:string

Deprecated. As of VI API 4.0:

System reported path states are available in state.

Paths slated for I/O can be found using isWorkingPath.

State of the path. Must be one of the values of MultipathState

active: Path can be used for I/O and is currently a working path.
standby: Path can be used for I/O but is not a working path or can be used if active paths fail.
disabled: Path has been administratively disabled.
dead: Path cannot be used for I/O.
unknown: Path is in unknown error state.

state*

xsd:string

System-reported state of the path. Must be one of the values of MultipathState

active: Path can be used for I/O.
standby: Path can be used for I/O if active paths fail.
disabled: Path has been administratively disabled.
dead: Path cannot be used for I/O.
unknown: Path is in unknown error state.

Since vSphere API 4.0

transport*

HostTargetTransport

Transport information for the target end of the path.

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostMultipathInfoPath">
            <complexContent>
               <extension base="pbm:DynamicData">
                  <sequence>
                     <element name="key" type="xsd:string"/>
                     <element name="name" type="xsd:string"/>
                     <element name="pathState" type="xsd:string"/>
                     <element name="state" type="xsd:string" minOccurs="0"/>
                     <element name="isWorkingPath" type="xsd:boolean" minOccurs="0"/>
                     <element name="adapter" type="xsd:string"/>
                     <element name="lun" type="xsd:string"/>
                     <element name="transport" type="pbm:HostTargetTransport" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - HostMultipathInfoPath(vim.host.MultipathInfo.Path)

Data Object Description