15f7be9a52
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
3.2 KiB
vim.host.FirmwareSystem
The HostFirmwareSystem managed object type provides access to the firmware of an embedded ESX host. It provides operations to backup, restore, and reset the configuration of an embedded ESX host.
- since
Attributes
Methods
- ResetFirmwareToFactoryDefaults():
-
Reset the configuration to factory defaults.This method will reset all configuration options, including the "admin" password, to the factory defaults. The host will be rebooted immediately. The host needs to be in maintenance mode before this operation can be performed.
- Privilege:
-
Host.Config.Firmware
Args:
- Returns:
-
None
Raises:
- vim.fault.InvalidState:
-
if the host is not in maintenance mode.
- BackupFirmwareConfiguration():
-
Backup the configuration of the host.The method generates a bundle containing the host configuration. You can use an HTTP GET operation to download the bundle from the returned URL.
- Privilege:
-
Host.Config.Firmware
Args:
- Returns:
-
- str:
-
URL that identifies the location of the backup bundle.
- QueryFirmwareConfigUploadURL():
-
Return the URL on the host to which the configuration bundle must be uploaded for a restore operation. See RestoreFirmwareConfiguration .
- Privilege:
-
Host.Config.Firmware
Args:
- Returns:
-
- str:
-
URL that identifies the location for the restore operation.
- RestoreFirmwareConfiguration(force):
-
Restore the configuration of the host to that specified in the bundle.Upload the bundle to the URL returned by the QueryFirmwareConfigUploadURL method. The RestoreFirmwareConfiguration method will restore all configuration options, including the "admin" password, to the values in the bundle. The host will be rebooted immediately. The host must be in maintenance mode before this operation can be performed.
- Privilege:
-
Host.Config.Firmware
- Args:
-
- force (bool):
-
Forces application of the configuration even if the bundle is mismatched.
- Returns:
-
None
Raises:
- vim.fault.InvalidState:
-
if the host is not in maintenance mode.
- vim.fault.FileFault:
-
if the file was not accessible.
- vim.fault.MismatchedBundle:
-
if the uuid / build number in the bundle does not match the uuid / build number of the host and parameter 'force' is set to false.
- vim.fault.InvalidBundle:
-
if the bundle does not have the expected contents.