Scripting Object - VcHostFirmwareSystem

Scripting-object corresponding to
HostFirmwareSystem
Attribute of
VcHostConfigManager

Scripting Object Description

The {@link vim.host.FirmwareSystem} 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.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, backupFirmwareConfiguration, createTrigger, queryFirmwareConfigUploadURL, queryFirmwareQuantumMinutes, queryFirmwareSyncsPerQuantum, resetFirmwareToFactoryDefaults, restoreFirmwareConfiguration, syncFirmwareConfiguration

queryFirmwareSyncsPerQuantum

Retrieve the maximum number of successful calls to {@link #syncConfiguration} that can be made in a given time interval (quantum). The restriction is much tighter for USB backed persistent storage, to prolong the life of the flash drive, which has a limited number of rewrites. @since vim unstable version

Parameters

NameTypeDescription
None

Return Value

Type Description
Number

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

queryFirmwareQuantumMinutes

Retrieve the duration in minutes of the time quantum during which a limited number of successful calls to {@link #syncConfiguration} can be made. See {@link #querySyncsPerQuantum}. @since vim unstable version

Parameters

NameTypeDescription
None

Return Value

Type Description
Number

queryFirmwareConfigUploadURL

Return the URL on the host to which the configuration bundle must be uploaded for a restore operation. See {@link vim.host.FirmwareSystem#restoreConfiguration}. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
String

restoreFirmwareConfiguration

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

Upload the bundle to the URL returned by the {@link vim.host.FirmwareSystem#queryConfigUploadURL} method. The {@link vim.host.FirmwareSystem#restoreConfiguration} 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. @since VI API 2.5

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
None

syncFirmwareConfiguration

Writes the configuration of the firmware system to persistent storage. In ESX Server 3i, configuration changes are not persisted immediately. This operation notifies the system to force changes to be written through to persistent store. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
String

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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None