Files
deb-python-pyvmomi/docs/vim/host/VirtualNic.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

2.0 KiB

vim.host.VirtualNic

The HostVirtualNic data object describes a virtual network adapter representing an adapter that connects to a virtual switch. A host virtual NIC differs from a physical NIC:
  • A host virtual NIC is a virtual device that is connected to a virtual switch.
  • A physical NIC (
  • HostNetworkInfo
  • .
  • pnic
  • ) corresponds to a physical device that is connected to the physical network.
  • A host virtual NIC provides access to the external network through a virtual switch that is bridged through a Physical NIC to a physical network (
  • HostNetworkConfig
  • .
  • vswitch
  • [].
  • spec
  • .
  • bridge
  • )
extends

vmodl.DynamicData

Attributes:

device (str):

Device name.

key (str):

Linkable identifier.

portgroup (str):

If the Virtual NIC is connecting to a vSwitch, this property is the name of portgroup connected. If the Virtual NIC is connecting to a DistributedVirtualSwitch, this property is an empty string.

spec (vim.host.VirtualNic.Specification):

Configurable properties for the virtual network adapter object.

port (vim.host.PortGroup.Port, optional):

Port on the port group that the virtual network adapter is using when it is enabled ( DistributedVirtualPort . key ).