File: Network.rst

package info (click to toggle)
python-pyvmomi 6.7.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 14,980 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (70 lines) | stat: -rw-r--r-- 1,568 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. _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.