15f7be9a52
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
53 lines
2.1 KiB
ReStructuredText
53 lines
2.1 KiB
ReStructuredText
.. _int: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vSphere API 4.0: ../../../vim/version.rst#vimversionversion5
|
|
|
|
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
|
|
|
|
.. _EnableMultipathPath: ../../../vim/host/StorageSystem.rst#enableMultipathPath
|
|
|
|
.. _DisableMultipathPath: ../../../vim/host/StorageSystem.rst#disableMultipathPath
|
|
|
|
.. _HostMultipathStateInfo: ../../../vim/host/MultipathStateInfo.rst
|
|
|
|
.. _vim.host.PlugStoreTopology.Device: ../../../vim/host/PlugStoreTopology/Device.rst
|
|
|
|
.. _vim.host.PlugStoreTopology.Target: ../../../vim/host/PlugStoreTopology/Target.rst
|
|
|
|
.. _vim.host.PlugStoreTopology.Adapter: ../../../vim/host/PlugStoreTopology/Adapter.rst
|
|
|
|
|
|
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.
|