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

-DestinationPath  <String>
-VMHost  <VMHost[]>
[-BackupConfiguration]
[-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
  • wildcards
  • pipeline
  • 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.
    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.

    -VMHost  <VMHost[]>
    [-ResetToDefaults]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • Specifies the host whose firmware you want to configure (it must be an ESX visor).
    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.

    -VMHost  <VMHost[]>
    [-Force]
    [-HostCredential  <PSCredential>]
    [-HostPassword  <SecureString>]
    [-HostUser  <String>]
    [-Restore]
    [-Server  <VIServer[]>]
    [-SourcePath  <String>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VMHost
    VMHost[] named
  • wildcards
  • pipeline
  • 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
    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

    Feedback

    Was this page helpful?