openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
83249a66e5d25c7c026db43aa25c79444d158c10
deb-python-pyvmomi/docs/vim/Network.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.5 KiB
Raw Blame History

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.