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
79 lines
4.7 KiB
ReStructuredText
79 lines
4.7 KiB
ReStructuredText
.. _int: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _bool: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _DVPortStatus: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo.rst
|
|
|
|
.. _HostCapability: ../../../vim/host/Capability.rst
|
|
|
|
.. _vSphere API 4.0: ../../../vim/version.rst#vimversionversion5
|
|
|
|
.. _vim.NumericRange: ../../../vim/NumericRange.rst
|
|
|
|
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
|
|
|
|
.. _VMwareDVSConfigSpec: ../../../vim/dvs/VmwareDistributedVirtualSwitch/ConfigSpec.rst
|
|
|
|
.. _DistributedVirtualPort: ../../../vim/dvs/DistributedVirtualPort.rst
|
|
|
|
.. _vmDirectPathGen2Active: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo.rst#vmDirectPathGen2Active
|
|
|
|
.. _vmDirectPathGen2Supported: ../../../vim/host/Capability.rst#vmDirectPathGen2Supported
|
|
|
|
.. _vmDirectPathGen2InactiveReasonOther: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo.rst#vmDirectPathGen2InactiveReasonOther
|
|
|
|
.. _vmDirectPathGen2InactiveReasonNetwork: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo.rst#vmDirectPathGen2InactiveReasonNetwork
|
|
|
|
.. _vmDirectPathGen2InactiveReasonExtended: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo.rst#vmDirectPathGen2InactiveReasonExtended
|
|
|
|
.. _DVPortStatusVmDirectPathGen2InactiveReasonOther: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo/VmDirectPathGen2InactiveReasonOther.rst
|
|
|
|
.. _DVPortStatusVmDirectPathGen2InactiveReasonNetwork: ../../../vim/dvs/DistributedVirtualPort/RuntimeInfo/VmDirectPathGen2InactiveReasonNetwork.rst
|
|
|
|
|
|
vim.dvs.DistributedVirtualPort.RuntimeInfo
|
|
==========================================
|
|
The `DVPortStatus`_ data object contains runtime information about a `DistributedVirtualPort`_ .
|
|
:extends: vmodl.DynamicData_
|
|
:since: `vSphere API 4.0`_
|
|
|
|
Attributes:
|
|
linkUp (`bool`_):
|
|
|
|
Indicates whether the port is in linkUp status.
|
|
blocked (`bool`_):
|
|
|
|
Indicates whether the port is blocked by switch implementation.
|
|
vlanIds (`vim.NumericRange`_, optional):
|
|
|
|
VLAN ID of the port.
|
|
trunkingMode (`bool`_, optional):
|
|
|
|
True if the port VLAN tagging/stripping is disabled.
|
|
mtu (`int`_, optional):
|
|
|
|
Maximum transmission unit (MTU) of the port. You can set the MTU only at the switch level ( `VMwareDVSConfigSpec`_ ). If you attempt to change it at the portgroup or port level, the Server throws an exception.
|
|
linkPeer (`str`_, optional):
|
|
|
|
Name of the connected entity.
|
|
macAddress (`str`_, optional):
|
|
|
|
The MAC address that is used at this port.
|
|
statusDetail (`str`_, optional):
|
|
|
|
Additional information regarding the current status of the port.
|
|
vmDirectPathGen2Active (`bool`_, optional):
|
|
|
|
Indicates whether VMDirectPath Gen 2 is active on this port. If false, the reason(s) for inactivity will be provided in one or more of `vmDirectPathGen2InactiveReasonNetwork`_ , `vmDirectPathGen2InactiveReasonOther`_ , and `vmDirectPathGen2InactiveReasonExtended`_ .If the host software is not capable of VMDirectPath Gen 2, this property will be unset. See `HostCapability`_ . `vmDirectPathGen2Supported`_ .
|
|
vmDirectPathGen2InactiveReasonNetwork (`str`_, optional):
|
|
|
|
If `vmDirectPathGen2Active`_ is false, this array will be populated with reasons for the inactivity that are related to network state or configuration. The reasons are chosen from the `DVPortStatusVmDirectPathGen2InactiveReasonNetwork`_ values.Other reasons for inactivity will be provided in `vmDirectPathGen2InactiveReasonOther`_ . If there is a reason for inactivity that cannot be described by the available constants, `vmDirectPathGen2InactiveReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive.
|
|
vmDirectPathGen2InactiveReasonOther (`str`_, optional):
|
|
|
|
If `vmDirectPathGen2Active`_ is false, this array will be populated with reasons for the inactivity that are not related to network state or configuration. The reasons are chosen from the `DVPortStatusVmDirectPathGen2InactiveReasonOther`_ values.Network-related reasons for inactivity will be provided in `vmDirectPathGen2InactiveReasonNetwork`_ . If there is a reason for inactivity that cannot be described by the available constants, `vmDirectPathGen2InactiveReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive.See `vmDirectPathGen2Supported`_
|
|
vmDirectPathGen2InactiveReasonExtended (`str`_, optional):
|
|
|
|
If `vmDirectPathGen2Active`_ is false, this property may contain an explanation provided by the platform, beyond the reasons (if any) listed in `vmDirectPathGen2InactiveReasonNetwork`_ and/or `vmDirectPathGen2InactiveReasonOther`_ .
|