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

vim.host.VirtualSwitch

The virtual switch is a software entity to which multiple virtual network adapters can connect to create a virtual network. It can also be bridged to a physical network.

extends

vmodl.DynamicData

Attributes:

name (str):

The name of the virtual switch. Maximum length is 32 characters.

key (str):

The virtual switch key.

numPorts (int):

The number of ports that this virtual switch currently has.

numPortsAvailable (int):

The number of ports that are available on this virtual switch. There are a number of networking services that utilize a port on the virtual switch and are not accounted for in the Port array of a PortGroup. For example, each physical NIC attached to a virtual switch consumes one port. This property should be used when attempting to implement admission control for new services attaching to virtual switches.

mtu (int, optional):

The maximum transmission unit (MTU) associated with this virtual switch in bytes.

portgroup (vim.host.PortGroup, optional):

The list of port groups configured for this virtual switch.

pnic (vim.host.PhysicalNic, optional):

The set of physical network adapters associated with this bridge.

spec (vim.host.VirtualSwitch.Specification):

The specification of a PortGroup.