Set-VMHostFirmware

Name	Type	Description	Required?	Pipeline Input	Default Value
VMHost	VMHost[]	Specifies the host whose firmware you want to configure (it must be an ESX visor).	true	True (ByValue)
BackupConfiguration	SwitchParameter	The Backup functionality of Set-VMHostFirmware is deprecated and scheduled for removal. For making backups, use the Get-VMHostFirmware cmdlet instead. Indicates that you want to backup the host firmware configuration and download the bundle to the path specified by the DestinationPath parameter.	false	False
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	False
DestinationPath	String	Specifies a destination path where to download the host configuration backup bundle if the BackupConfiguration parameter is set.	true	False
Force	SwitchParameter	Indicates that you want to apply the configuration even if the bundle is mismatched. Use this parameter in combination with the Restore parameter.	false	False
HostCredential	PSCredential	Specifies the credential object you want to use for authenticating with the host when uploading a firmware configuration bundle. Do not use this parameter if the HostUser and HostPassword parameters are specified.	false	False
HostPassword	SecureString	Specifies a password for the authenticating with the host when uploading a firmware configuration bundle.	false	False
HostUser	String	Specifies a username for authenticating with the host when uploading a firmware configuration bundle.	false	False
ResetToDefaults	SwitchParameter	Indicates that you want to reset all configuration settings, including the "admin" password, to the factory defaults. The host is rebooted immediately. The host needs to be in a maintenance in order to perform this operation.	false	False
Restore	SwitchParameter	Indicates that you want to restore the configuration of the host to the one that is specified in the provided bundle. The bundle is uploaded to the URL retrieved via Get-VMHostFirmware. This method resets all configuration options, including the "admin" password, to the values in the bundle. The host is rebooted immediately. The host needs to be in maintenance mode in order to perform this operation.	false	False
Server	VIServer[]	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.	false	False
SourcePath	String	Specifies the path to the host configuration backup bundle you want to restore. The bundle is uploaded to an URL address which you can retrieve by using the Get-VMHostFirmware cmdlet.	false	False
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	False

-------------------------- Example 1 --------------------------

Set-VMHost -VMHost Host -State 'Maintenance'

Set-VMHostFirmware -VMHost Host -Restore

Restore the host firmware by using the default path for the firmware bundle. You can store the bundle to the default path through HTTP by using the upload URL specified in the firmware bundle object:

$bundle = Get-VMHostFirmware

$uploadUrl = $bundle.UploadUrl

-------------------------- Example 2 --------------------------

Set-VMHost -VMHost Host -State 'Maintenance'

Set-VMHostFirmware -VMHost Host -Restore -SourcePath c:\bundleToRestore.tgz -HostUser user -HostPassword pass

Restore the host firmware by specifying a firmware bundle as a source path.

-------------------------- Example 3 --------------------------

Set-VMHost -VMHost Host -State 'Maintenance'

Set-VMHostFirmware -VMHost Host -ResetToDefaults

Reset the host configuration to the factory default settings.

-------------------------- Example 4 --------------------------

Get-VMHostFirmware -VMHost Host1, Host2 -BackupConfiguration -DestinationPath c:\StoredBundles

Set-VMHost -VMHost Host1, Host2 -State 'Maintenance'

Get-VMHost -Name Host1, Host2 | Set-VMHostFirmware -Restore -SourcePath c:\StoredBundles -HostUser user -HostPassword pass

Restore multiple hosts firmware by specifying the firmware bundle as a source path directory. The command determines which bundle is needed for each host by the bundle name.

PowerCLI Reference

Synopsis