Set-VMHostFirmware Command | Vmware PowerCLI Reference

Set-VMHostFirmware

This cmdlet configures hosts firmware settings. 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 ResetToDefaults parameters, the host needs to be in maintenance mode. The Backup functionality of Set-VMHostFirmware is deprecated and scheduled for removal. For making backups, use the Get-VMHostFirmware cmdlet instead.

Syntax

Set-VMHostFirmware
-DestinationPath < String >
-VMHost < VMHost[] >
[-BackupConfiguration ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 DestinationPath String named
Specifies a destination path where to download the host configuration backup bundle if the BackupConfiguration parameter is set.
required
 VMHost VMHost[] named
  • pipeline
  • wildcards
 Specifies the host whose firmware you want to configure (it must be an ESX visor).
optional BackupConfiguration SwitchParameter named
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.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
Set-VMHostFirmware
-VMHost < VMHost[] >
[-ProgressAction < ActionPreference > ]
[-ResetToDefaults ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 VMHost VMHost[] named
  • pipeline
  • wildcards
 Specifies the host whose firmware you want to configure (it must be an ESX visor).
optional ProgressAction ActionPreference named
optional ResetToDefaults SwitchParameter named
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.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
Set-VMHostFirmware
-VMHost < VMHost[] >
[-Force ]
[-HostCredential < PSCredential > ]
[-HostPassword < SecureString > ]
[-HostUser < String > ]
[-ProgressAction < ActionPreference > ]
[-Restore ]
[-Server < VIServer[] > ]
[-SourcePath < String > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 VMHost VMHost[] named
  • pipeline
  • wildcards
 Specifies the host whose firmware you want to configure (it must be an ESX visor).
optional Force SwitchParameter named
Indicates that you want to apply the configuration even if the bundle is mismatched. Use this parameter in combination with the Restore parameter.
optional HostCredential PSCredential named
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.
optional HostPassword SecureString named
Specifies a password for the authenticating with the host when uploading a firmware configuration bundle.
optional HostUser String named
Specifies a username for authenticating with the host when uploading a firmware configuration bundle.
optional ProgressAction ActionPreference named
optional Restore SwitchParameter named
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.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
optional SourcePath String named
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.

Output

VMware.VimAutomation.ViCore.Types.V1.Host.HostFirmwareBundle

Examples

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:

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.

Related Commands

VMHost

This cmdlet adds a host to be managed by a vCenter Server system.

This cmdlet retrieves the hosts on a vCenter Server system.

This cmdlet moves hosts to another location.

This cmdlet removes the specified hosts from the inventory.

This cmdlet restarts the specified hosts.

This cmdlet modifies the configuration of the host.

This cmdlet starts the specified hosts.

This cmdlet powers off the specified hosts.

This cmdlet suspends hosts.

VMHostAccount

This cmdlet retrieves the host accounts available on a vCenter Server system.

This cmdlet creates a new host user or group account.

This cmdlet removes the specified host accounts.

This cmdlet configures a host account.

VMHostAdvancedConfiguration

This cmdlet retrieves the advanced configuration of the hosts.

This cmdlet modifies the advanced configuration settings of a host.

VMHostAttributes

Gets the identifying attributes of a host.

VMHostAuthentication

This cmdlet retrieves authentication information for the specified hosts.

This cmdlet modifies the host authentication information.

VMHostAvailableTimeZone

This cmdlet retrieves the time zones available on the specified host.

VMHostDiagnosticPartition

This cmdlet retrieves a list of the diagnostic partitions on the specified hosts.

This cmdlet activates or deactivates the diagnostic partitions of hosts.

VMHostDisk

This cmdlet retrieves information about the specified SCSI LUN disk.

VMHostDiskPartition

This cmdlet formats a new VMFS (Virtual Machine File System) on each of the specified host disk partitions.

This cmdlet retrieves the partitions of a host disk (LUN).

VMHostFirewallDefaultPolicy

This cmdlet retrieves the firewall default policy of the specified hosts.

This cmdlet sets the default policy for the specified host firewall.

VMHostFirewallException

This cmdlet retrieves the exceptions from the firewall policy on the specified hosts.

This cmdlet activates or deactivates host firewall exceptions.

VMHostFirmware

This cmdlet retrieves hosts firmware information.

This cmdlet configures hosts firmware settings.

VMHostHardware

This cmdlet retrieves ESXi host hardware and firmware information.

VMHostHba

This cmdlet retrieves information about the available HBAs (Host Bus Adapter).

This cmdlet configures the CHAP properties of the specified iSCSI HBAs.

VMHostImageDb

This cmdlet exports the specified host's base image database to a file that is in a .tgz format.

VMHostImageProfile

Gets the image profile associated with the specified ESXi host.

VMHostMatchingRules

Retrieves the list of rules in the rule set that match a specified host.

VMHostModule

This cmdlet retrieves the option strings of the specified host modules.

This cmdlet overrides the host module options with the given ones.

VMHostNetwork

THis cmdlet retrieves the host networks on a vCenter Server system.

This cmdlet updates the specified virtual network.

VMHostNetworkAdapter

This cmdlet retrieves the host network adapters on a vCenter Server system.

This cmdlet creates a new HostVirtualNIC (Service Console or VMKernel) on the specified host.

This cmdlet removes the specified host network adapters.

This cmdlet configures the specified host network adapter.

VMHostNetworkStack

This cmdlet retrieves the host network stacks on a vCenter Server system.

This cmdlet modifies the specified host network stack.

VMHostNtpServer

This cmdlet adds the specified NTP servers to the NTP server list of the specified hosts.

This cmdlet retrieves the NTP servers on the specified hosts.

This cmdlet removes the specified NTP servers from the NTP server list of the specified hosts.

VMHostPatch

This cmdlet retrieves information about the host patches installed on the specified hosts. This cmdlet is deprecated and will not return any results for ESX hosts version 5.0 and later. Use (Get-ESXCli).software.vib.list() as an alternative.

This cmdlet updates the specified hosts.

VMHostPciDevice

This cmdlet retrieves the PCI devices on the specified hosts.

VMHostProfile

This cmdlet exports the specified host profile to a file.

This cmdlet retrieves the available host profiles.

This cmdlet imports a host profile from a file. The file path must be accessible from the VMware PowerCLI client side.

This cmdlet applies a host profile to the specified host or cluster.

This cmdlet creates a new host profile based on a reference host.

This cmdlet removes the specified host profiles.

This cmdlet modifies the specified host profile.

VMHostProfileCompliance

This cmdlet tests hosts for profile compliance.

VMHostProfileImageCacheConfiguration

Retrieves an image cache configuration for the given host profile.

This cmdlet modifies image cache configuration for given host profile.

VMHostProfileRequiredInput

This cmdlet performs a check whether the available information is sufficient to apply a host profile.

VMHostProfileStorageDeviceConfiguration

Retrieves the storage device configuration for the given host profile.

This cmdlet modifies the storage device configuration for the given host profile.

VMHostProfileUserConfiguration

This cmdlet retrieves the user password configuration for the given host profile.

This cmdlet modifies the user password configuration for the specified account within a host profile.

VMHostProfileVmPortGroupConfiguration

Retrieves the virtual machine port group configuration for the given host profile.

This cmdlet creates a new virtual machine port group configuration.

Removes the given virtual machine port group configuration from the host profile.

This cmdlet modifies the virtual machine port group configuration for the given host profile.

VMHostRoute

This cmdlet retrieves the routes from the routing table of the specified hosts.

This cmdlet creates a new route in the routing table of a host.

This cmdlet removes host routes.

This cmdlet modifies a route in the host routing table.

VMHostService

This cmdlet retrieves information about a host service.

This cmdlet restarts the specified host services.

This cmdlet modifies a host service.

This cmdlet starts the specified host services.

This cmdlet stops the specified host services.

VMHostSnmp

This cmdlet retrieves hosts SNMP configuration.

This cmdlet modifies the host SNMP configuration.

This cmdlet tests the host SNMP.

VMHostStartPolicy

This cmdlet retrieves the start policy of hosts.

This cmdlet modifies the host default start policy.

VMHostStorage

This cmdlet retrieves the host storages on a vCenter Server system.

This cmdlet configures a host storage.

VMHostSysLogServer

This cmdlet displays the remote syslog servers of the specified hosts.

This cmdlet configures the remote syslog server of the specified hosts.

VMHostTPM

This cmdlet retrieves the TPM 2.0 devices from the specified host.