Managed Object - HostFirmwareSystem

Property of
HostConfigManager
Since
VI API 2.5


Managed Object Description

NOTE: This managed object type and all of its methods are experimental and subject to change in future releases.

The FirmwareSystem managed object type provides access to the firmware of an embedded ESX host. It provides operations to backup/restore/reset the configuration of an embedded ESX host.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
BackupFirmwareConfiguration, QueryFirmwareConfigUploadURL, ResetFirmwareToFactoryDefaults, RestoreFirmwareConfiguration

BackupFirmwareConfiguration

Backup the configuration of the host.

A bundle containing the configuration of the host is generated. The bundle can be downloaded using a HTTP GET operation on the URL returned.

Required Privileges
Host.Config.Firmware

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirmwareSystem used to make the method call.

Return Value

Type Description
xsd:string

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryFirmwareConfigUploadURL

Return the URL on the host to which the configuration bundle must be uploaded for a restore operation.
Required Privileges
Host.Config.Firmware

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirmwareSystem used to make the method call.

Return Value

Type Description
xsd:string

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.

Required Privileges
Host.Config.Firmware

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirmwareSystem used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidStateThrown if the host is not in maintenance mode.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RestoreFirmwareConfiguration

Restore the configuration of the host to that specified in the bundle.

The bundle is expected to be uploaded to the URL retrieved via queryConfigUploadURL. This method will reset all configuration options, including the "admin" password, to the values in the bundle. The host will be rebooted immediately. The host needs to be in maintenance mode before this operation can be performed.

Required Privileges
Host.Config.Firmware

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostFirmwareSystem used to make the method call.
forcexsd:boolean

Forces application of the configuration even if the bundle is mismatched.

Return Value

Type Description
None

Faults

Type Description
FileFaultThrown if the file was not accessible.
InvalidBundleThrown if the bundle does not have the expected contents.
InvalidStateThrown if the host is not in maintenance mode.
MismatchedBundleThrown if the uuid / build number in the bundle doesnot match the uuid / build number of the host and parameter 'force' is set to false.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition