vCenter Storage Monitoring Service API
|
| Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - HostFirmwareSystem(vim.host.FirmwareSystem)
- Property of
- HostConfigManager
- Since
- VI API 2.5
Managed Object Description
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.Properties
| Name | Type | Description |
|---|---|---|
| None | ||
Methods
| Methods defined in this Managed Object |
|---|
| BackupFirmwareConfiguration, QueryFirmwareConfigUploadURL, ResetFirmwareToFactoryDefaults, RestoreFirmwareConfiguration |
BackupFirmwareConfiguration(backupConfiguration)
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.
- Required Privileges
- Host.Config.Firmware
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostFirmwareSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| xsd:string | URL that identifies the location of the backup bundle. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
QueryFirmwareConfigUploadURL(queryConfigUploadURL)
Return the URL on the host to which the configuration bundle must be uploaded for a restore operation. See RestoreFirmwareConfiguration.- Required Privileges
- Host.Config.Firmware
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostFirmwareSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| xsd:string | URL that identifies the location for the restore operation. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
ResetFirmwareToFactoryDefaults(resetToFactoryDefaults)
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostFirmwareSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidState | Thrown if the host is not in maintenance mode. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RestoreFirmwareConfiguration(restoreConfiguration)
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.
- Required Privileges
- Host.Config.Firmware
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostFirmwareSystem used to make the method call. |
| force | xsd:boolean |
Forces application of the configuration even if the bundle
is mismatched.
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| FileFault | Thrown if the file was not accessible. |
| InvalidBundle | Thrown if the bundle does not have the expected contents. |
| InvalidState | Thrown if the host is not in maintenance mode. |
| MismatchedBundle | Thrown 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. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
| Top of page | Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |