openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
master
deb-python-pyvmomi/docs/vim/host/VirtualNicConnection.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

1.1 KiB
Raw Permalink Blame History

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