File: VirtualNicManager.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 (131 lines) | stat: -rw-r--r-- 2,574 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.. _str: https://docs.python.org/2/library/stdtypes.html

.. _vim.Task: ../../vim/Task.rst

.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5

.. _vim.fault.HostConfigFault: ../../vim/fault/HostConfigFault.rst

.. _vmodl.fault.InvalidArgument: ../../vmodl/fault/InvalidArgument.rst

.. _vim.ExtensibleManagedObject: ../../vim/ExtensibleManagedObject.rst

.. _vim.host.VirtualNicManagerInfo: ../../vim/host/VirtualNicManagerInfo.rst

.. _vim.host.VirtualNicManager.NetConfig: ../../vim/host/VirtualNicManager/NetConfig.rst


vim.host.VirtualNicManager
==========================
  The VirtualNicManager managed object describes the special Virtual NIC configuration of the host.


:extends: vim.ExtensibleManagedObject_
:since: `vSphere API 4.0`_


Attributes
----------
    info (`vim.host.VirtualNicManagerInfo`_):
       Network configuration.


Methods
-------


QueryNetConfig(nicType):
   Get the NetConfig for the specified nicType


  Privilege:
               Host.Config.Network



  Args:
    nicType (`str`_):
       The NicType




  Returns:
    `vim.host.VirtualNicManager.NetConfig`_:
         

  Raises:

    `vim.fault.HostConfigFault`_: 
       for any other failure.

    `vmodl.fault.InvalidArgument`_: 
       if nicType is invalid


SelectVnicForNicType(nicType, device):
   Select the NicType of the VirtualNic. Selecting a device automatically deselects the previous selection if NetConfig#multiSelectAllowed is false for the specified nicType. Else, the device is added to the list of selected nics.


  Privilege:
               Host.Config.Network



  Args:
    nicType (`str`_):
       The type of VirtualNic that would be selected


    device (`str`_):
       The device that uniquely identifies the VirtualNic.




  Returns:
    None
         

  Raises:

    `vim.fault.HostConfigFault`_: 
       for any other failure.

    `vmodl.fault.InvalidArgument`_: 
       if nicType is invalid, or device represents a nonexistent or invalid VirtualNic


DeselectVnicForNicType(nicType, device):
   Deselect the VirtualNic to be a special type.


  Privilege:
               Host.Config.Network



  Args:
    nicType (`str`_):
       The type of VirtualNic that would be deselected


    device (`str`_):
       The device that uniquely identifies the VirtualNic.




  Returns:
    None
         

  Raises:

    `vim.fault.HostConfigFault`_: 
       for any other failure.

    `vmodl.fault.InvalidArgument`_: 
       if nicType is invalid, device represents a nonexistent or invalid VirtualNic, or the VirtualNic is not selected