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
23 lines
1.1 KiB
ReStructuredText
23 lines
1.1 KiB
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5
|
|
|
|
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
|
|
|
|
.. _vim.dvs.PortConnection: ../../vim/dvs/PortConnection.rst
|
|
|
|
|
|
vim.host.VirtualNicConnection
|
|
=============================
|
|
DataObject which provides a level of indirection when identifying VirtualNics during configuration. This dataObject lets users specify a VirtualNic in terms of the portgroup/Dv Port the Virtual NIC is connected to. This is useful in cases where VirtualNic will be created as part of a configuration operation and the created VirtualNic is referred to in some other part of configuration. e.g: for configuring VMotion
|
|
:extends: vmodl.DynamicData_
|
|
:since: `vSphere API 4.0`_
|
|
|
|
Attributes:
|
|
portgroup (`str`_, optional):
|
|
|
|
Name of the portgroup to which the virtual nic is connected to. If this parameter is set, use a virtual nic connected to a legacy portgroup.
|
|
dvPort (`vim.dvs.PortConnection`_, optional):
|
|
|
|
Identifier for the DistributedVirtualPort. If the virtual nic is to be connected to a DVS, #dvPort will be set instead of #portgroup
|