Get-VMFirmware
Get-VMFirmware
Gets the firmware configuration of a virtual machine.
Syntax
Parameter Set: VMName
Get-VMFirmware [-VMName] <String[]> [-ComputerName <String[]> ] [ <CommonParameters>]
Parameter Set: VMObject
Get-VMFirmware [-VM] <VirtualMachine[]> [ <CommonParameters>]
Parameter Set: VMSnapshot
Get-VMFirmware [-VMSnapshot] <VMSnapshot> [ <CommonParameters>]
Detailed Description
The Get-VMFirmware cmdlet gets the firmware configuration of a virtual machine. Note: This cmdlet is supported only on Generation 2 virtual machines.
Parameters
-ComputerName<String[]>
Specifies an array of Hyper-V hosts. The cmdlet gets the virtual machine firmware from the hosts you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies an array of virtual machine objects. The cmdlet gets the firmware configuration for the virtual machines you specify. To obtain a virtual machine object, use the Get-VM cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies an array of names of virtual machines. The cmdlet gets the firmware configuration for the virtual machines you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMSnapshot<VMSnapshot>
Specifies the virtual machine snapshot to be used with the VM when retrieving the firmware configuration.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.HyperV.PowerShell.VMFirmware
Notes
- Note: This cmdlet is supported only on Generation 2 virtual machines.
Examples
Example 1
This example returns a virtual machine firmware object for the virtual machine “Test VM”.
PS C:\> Get-VMFirmware "Test VM"