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
71 lines
1.5 KiB
ReStructuredText
71 lines
1.5 KiB
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vim.Task: ../vim/Task.rst
|
|
|
|
.. _vim.HostSystem: ../vim/HostSystem.rst
|
|
|
|
.. _vim.ManagedEntity: ../vim/ManagedEntity.rst
|
|
|
|
.. _vim.VirtualMachine: ../vim/VirtualMachine.rst
|
|
|
|
.. _vim.Network.Summary: ../vim/Network/Summary.rst
|
|
|
|
.. _vim.fault.ResourceInUse: ../vim/fault/ResourceInUse.rst
|
|
|
|
|
|
vim.Network
|
|
===========
|
|
Represents a network accessible by either hosts or virtual machines. This can be a physical network or a logical network, such as a VLAN.Networks are created:
|
|
* explicitly when configuring a host.
|
|
* automatically when adding a host to VirtualCenter.
|
|
* automatically when adding a new virtual machine to a host or to VirtualCenter.
|
|
*
|
|
* To configure network access for hosts and virtual machines, use
|
|
* `DistributedVirtualSwitch`_
|
|
* and
|
|
* `DistributedVirtualPortgroup`_
|
|
* managed objects.
|
|
|
|
|
|
:extends: vim.ManagedEntity_
|
|
|
|
|
|
Attributes
|
|
----------
|
|
name (`str`_):
|
|
Name of this network.
|
|
summary (`vim.Network.Summary`_):
|
|
Properties of a network.
|
|
host (`vim.HostSystem`_):
|
|
Hosts attached to this network.
|
|
vm (`vim.VirtualMachine`_):
|
|
Virtual machines using this network.
|
|
|
|
|
|
Methods
|
|
-------
|
|
|
|
|
|
DestroyNetwork():
|
|
Removes a network. A network can be removed only if it is not used by any host or virtual machine.
|
|
|
|
|
|
Privilege:
|
|
Network.Delete
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
Raises:
|
|
|
|
`vim.fault.ResourceInUse`_:
|
|
if one or more hosts or virtual machines are configured to use the network.
|
|
|
|
|