Get-VMFirmware
Gets the firmware configuration of a virtual machine.
Syntax
VMName (Default)
Get-VMFirmware
[-VMName] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]
VMObject
Get-VMFirmware
[-VM] <VirtualMachine[]>
[<CommonParameters>]
VMSnapshot
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".
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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ComputerName
Specifies an array of Hyper-V hosts. The cmdlet gets the virtual machine firmware from the hosts you specify.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Parameter properties
| Type: | PSCredential[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | VirtualMachine[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMName
Specifies an array of names of virtual machines. The cmdlet gets the firmware configuration for the virtual machines you specify.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMSnapshot
Specifies the virtual machine snapshot to be used with the VM when retrieving the firmware configuration.
Parameter properties
| Type: | VMSnapshot |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | VMCheckpoint |
Parameter sets
VMSnapshot
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
Microsoft.HyperV.PowerShell.VMFirmware
Notes
- Note: This cmdlet is supported only on Generation 2 virtual machines.