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

vim.host.BootDeviceSystem

The HostBootDeviceSystem managed object provides methods to query and update a host boot device configuration.

since

VI API 2.5

Attributes

Methods

QueryBootDevices():

Retrieves a list of the available boot devices for the host system.

Privilege:

System.Read

Args:

Returns:
vim.host.BootDeviceInfo:

The boot device information for the host. The returned object has a list of HostBootDevice data objects; each boot device object defines a description and a key to identify the device. The order of devices in the list is unpredictable. The returned HostBootDeviceInfo data object also contains the key of the current boot device.

UpdateBootDevice(key):

Sets the current boot device for the host system.

Privilege:

Host.Config.Maintenance

Args:
key (str):

The key of the HostBootDevice from which the host will boot.

Returns:

None

Raises:

vmodl.fault.NotSupported:

if the host does not support updating bootDevices.