PowerCLI Reference



This cmdlet retrieves hosts firmware information.


Get-VMHostFirmware [-VMHost] <VMHost[]> [-BackupConfiguration] -DestinationPath <String> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves firmware information for the hosts specified by the VMHost parameter. To specify a server different from the default one, use the Server parameter. To run this cmdlet, you need to have the "Host.Config.Firmware" permission to the ESX.


NameTypeDescriptionRequired?Pipeline InputDefault Value
VMHostVMHost[]Specifies the hosts for which you want to retrieve firmware information.trueTrue (ByValue)
BackupConfigurationSwitchParameterIndicates that you want to backup the host firmware configuration and download the bundle to the specified DestinationPath.falseFalse
DestinationPathStringSpecifies a destination path where to download the host configuration backup bundle if the BackupConfiguration parameter is set.trueFalse
ServerVIServer[]This parameter is required when you specify the host by name. In this case, the host with the specified name is searched on the specified servers and firmware information is retrieved from it. If a VMHost object is passed to the VMHost parameter, the Server parameter is not used.falseFalse

Return Type

Zero or more HostFirmware or HostFirmwareBundle objects


This functionality applies to ESXi Embedded only.


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

Get-VMHostFirmware -VMHost $vmhost

Retrieves the firmware information for the specified host.

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

Get-VMHostFirmware -VMHost $vmhost -BackupConfiguration -DestinationPath C:\Downloads

Backups a server configuration for the virtual machine host stored in the $vmhost variable, and downloads the configuration files into the specified folder.

Copyright © VMware, Inc. All rights reserved.