Data Object - HostMultipathInfoPath

Property of
HostMultipathInfoLogicalUnit
Extends
DynamicData
See also
HostHostBusAdapter, HostMultipathInfoLogicalUnit, HostTargetTransport

Data Object Description

Path is a storage entity that represents a topological path from a host bus adapter to a SCSI logical unit. Each path is unique although each host bus adapter/SCSI logical unit pair can have multiple paths.

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
adapterxsd: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
keyxsd:string

The identifier of the Path.
lunxsd:string

The logical unit at one endpoint of this path.
namexsd:string

Name of path.

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

pathStatexsd:stringDeprecated. As of VI API 4.0:
  • System reported path states are available in state.
  • Paths slated for I/O can be found using isWorkingPath.

The 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

The 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
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition