Files
deb-python-pyvmomi/docs/vim/host/VMotionSystem.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.0 KiB

vim.host.VMotionSystem

The VMotionSystem managed object describes the VMotion configuration of the host.

extends

vim.ExtensibleManagedObject

Attributes

netConfig (vim.host.VMotionSystem.NetConfig):

VMotion network configuration.

ipConfig (vim.host.IpConfig):

IP configuration of the VMotion VirtualNic.

Methods

UpdateIpConfig(ipConfig):

Update the IP configuration of VMotion VirtualNic.

Privilege:

Host.Config.Network

Args:

ipConfig (vim.host.IpConfig):

Returns:

None

Raises:

vim.fault.NotFound:

if no VirtualNic is selected for VMotion.

vim.fault.HostConfigFault:

for any other failure

vmodl.fault.InvalidArgument:

if the IpConfig is invalid or cannot be used.

SelectVnic(device):

Select the VirtualNic to be used for VMotion.

Privilege:

Host.Config.Network

Args:
device (str):

The device that uniquely identifies the VirtualNic.

Returns:

None

Raises:

vim.fault.HostConfigFault:

for any other failure

vmodl.fault.InvalidArgument:

if key represents a nonexistent or invalid VirtualNic.

DeselectVnic():

Indicate that no VirtualNic should be used for VMotion.

Privilege:

Host.Config.Network

Args:

Returns:

None

Raises:

vim.fault.HostConfigFault:

is a failure occurred