Files
deb-python-pyvmomi/docs/vim/host/PlugStoreTopology/Path.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

2.1 KiB

vim.host.PlugStoreTopology.Path

This data object type is an association class that describes a Path and its associated Device. A Path may be claimed by at most one Device.

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

key (str):

The identifier for the Path.

name (str):

Name of path. Use this property to correlate this path object to other path objects.The state of the Path can be retrieved from the data object (@link vim.host.MultipathStateInfo.Path} on the HostMultipathStateInfo data object.Use this name to configure LogicalUnit multipathing policy using EnableMultipathPath and DisableMultipathPath .

channelNumber (int, optional):

The channel number for a path if applicable.

targetNumber (int, optional):

The target number for a path if applicable. The target number is not guaranteed to be consistent across reboots or rescans of the adapter.

lunNumber (int, optional):

The LUN number for a path if applicable.

adapter (vim.host.PlugStoreTopology.Adapter, optional):

The adapter that provided the Path.

target (vim.host.PlugStoreTopology.Target, optional):

The target of the Path if any.

device (vim.host.PlugStoreTopology.Device, optional):

The device that claimed the Path if any.