openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
15f7be9a526d209fb7f0940cbf6b8e7cc481c0dd
deb-python-pyvmomi/docs/vim/host/VirtualNicManager.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.5 KiB
Raw Blame History

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