Files
deb-python-pyvmomi/docs/vim/DistributedVirtualSwitch/Summary.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.4 KiB

vim.DistributedVirtualSwitch.Summary

Summary of the distributed switch configuration.

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

name (str):

The name of the switch.

uuid (str):

The generated UUID of the switch.

numPorts (int):

Current number of ports, not including conflict ports.

productInfo (vim.dvs.ProductSpec, optional):

The product information for the implementation of the switch.

hostMember (vim.HostSystem, optional):

The names of the hosts that join the switch.

vm (vim.VirtualMachine, optional):

The Virtual Machines with Virtual NICs that connect to the switch. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

host (vim.HostSystem, optional):

The hosts with Virtual NICs that connect to the switch.

portgroupName (str, optional):

The names of the portgroups that are defined on the switch.

description (str, optional):

A description string of the switch.

contact (vim.DistributedVirtualSwitch.ContactInfo, optional):

The human operator contact information.

numHosts (int, optional):

The number of hosts in the switch. The value of this property is not affected by the privileges granted to the current user.