Get-VMFirmware

Module:
hyper-v
Gets the firmware configuration of a virtual machine.

Syntax 

Get-VMFirmware
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [<CommonParameters>]
Get-VMFirmware
   [-VM] <VirtualMachine[]>
   [<CommonParameters>]
Get-VMFirmware
   [-VMSnapshot] <VMSnapshot>
   [<CommonParameters>]

Description

The Get-VMFirmware cmdlet gets the firmware configuration of a virtual machine. Note: This cmdlet is supported only on Generation 2 virtual machines.

Examples

Example 1 

PS C:\> Get-VMFirmware "Test VM"

This example returns a virtual machine firmware object for the virtual machine "Test VM".

Required Parameters

-VM

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.

Type: VirtualMachine[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMName

Specifies an array of names of virtual machines. The cmdlet gets the firmware configuration for the virtual machines you specify.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMSnapshot

Specifies the virtual machine snapshot to be used with the VM when retrieving the firmware configuration.

Type: VMSnapshot
Aliases: VMCheckpoint
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

Specifies an array of Hyper-V hosts. The cmdlet gets the virtual machine firmware from the hosts you specify.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type: PSCredential[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.HyperV.PowerShell.VMFirmware

Notes

  • Note: This cmdlet is supported only on Generation 2 virtual machines.