File: Path.rst

package info (click to toggle)
python-pyvmomi 6.7.1-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 14,984 kB
  • sloc: python: 9,206; xml: 77; makefile: 11
file content (52 lines) | stat: -rw-r--r-- 2,117 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. _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.