vSphere PowerCLI Cmdlets Reference

Set-VMHostFirmware

Synopsis

Sets hosts firmware.

Syntax

Set-VMHostFirmware [-VMHost] <VMHost> [-BackupConfiguration] -DestinationPath <String> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-VMHostFirmware [-VMHost] <VMHost> [-ResetToDefaults] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-VMHostFirmware [-VMHost] <VMHost> [-Restore] [-SourcePath <String>] [-Force] [-HostCredential <PSCredential>] [-HostUser <String>] [-HostPassword <SecureString>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VMHostFirmware

Detailed Description

Sets hosts firmware.
If the BackupConfiguration parameter is set, backups the host configuration and downloads the bundle to the specified DestinationPath. In order to use the Restore and Reset parameters the host needs to be in maintenance mode. Note that the Backup functionality of Set-Firmware is deprecated and will be removed in a following release. For making backups, use the Get-VMHostFirmware cmdlet instead.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHostSpecify the host whose firmware you want to configure (it must be an ESX visor).truetrue (ByValue)
BackupConfigurationSwitchParameterIndicate that you want to backup the host firmware configuration and download the bundle to the specified DestinationPath.falsefalse
ConfirmSwitchParameterIf 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.falsefalse$true
DestinationPathStringSpecify a destination path where to download the host configuration backup bundle if the BackupConfiguration parameter is set.truefalse
ForceSwitchParameterIndicate that you want to apply the configuration even if the bundle is mismatched. Use this parameter in combination with the Restore parameter.falsefalse
HostCredentialPSCredentialSpecify the credential object you want to use for the authentication with the host when uploading a firmware configuration bundle. Do not use this parameter if -HostUser and -HostPassword are specified.falsefalse
HostPasswordSecureStringSpecify a password for the authentication with the host when uploading a firmware configuration bundle.falsefalse
HostUserStringSpecify a username for the authentication with the host when uploading a firmware configuration bundle.falsefalse
ResetToDefaultsSwitchParameterIndicate that you want to reset all configuration options, 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.falsefalse
RestoreSwitchParameterIndicate 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 a maintenance mode in order to perform this operation.falsefalse
ServerVIServer[]Specify the vSphere servers 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.falsefalse
SourcePathStringSpecify 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.falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

HostFirmware or HostFirmwareBundle

Notes

This functionality is available on ESXi Embedded only.

Examples

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

Set-VMHostFirmware -VMHost Host -DestinationPath 'c:\' -BackupConfiguration

Sets the Firmware of Host and stores the configuration to the specified file path.

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

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 --------------

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

Set-VMHostFirmware -VMHost Host1, Host2 -Restore -SourcePath c:\StoredBundles -HostUser User -HostPassword Pass

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


Copyright © 1998 - 2010 VMware, Inc. All rights reserved.