HostMultipathInfoPath

HostMultipathInfoPath
HostMultipathInfoPath

The HostMultipathInfoPath data object 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".

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "name": "string",
    "pathState": "string",
    "state": "string",
    "isWorkingPath": false,
    "adapter": "string",
    "lun": "string",
    "transport": {
        "_typeName": "string"
    }
}
string
key
Required

Identifier of the path.

string
name
Required

Name of path.

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

string
pathState
Required

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 MultipathStateEnum

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.
string
state
Optional

System-reported state of the path.

Must be one of the values of MultipathStateEnum

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.
boolean
isWorkingPath
Optional

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.

string
adapter
Required

The host bus adapter at one endpoint of this path.

string
lun
Required

The logical unit at one endpoint of this path.

transport
Optional

Transport information for the target end of the path.

Property Of