Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Set-VMFirmware

Windows Server Technical Preview and Windows 10

Set-VMFirmware

Sets the firmware configuration of a virtual machine.

Syntax

Parameter Set: VMName
Set-VMFirmware [-VMName] <String[]> [-BootOrder <VMComponentObject[]> ] [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-ConsoleMode <Nullable [Microsoft.HyperV.PowerShell.ConsoleModeType]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-EnableSecureBoot <OnOffState]> ] [-FirstBootDevice <VMComponentObject> ] [-Passthru] [-PauseAfterBootFailure <Nullable [Microsoft.HyperV.PowerShell.OnOffState]> ] [-PreferredNetworkBootProtocol <IPProtocolPreference]> ] [-SecureBootTemplate <System.String> ] [-SecureBootTemplateId <Nullable [System.Guid]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMFirmware
Set-VMFirmware [-VMFirmware] <VMFirmware[]> [-BootOrder <VMComponentObject[]> ] [-ConsoleMode <Nullable [Microsoft.HyperV.PowerShell.ConsoleModeType]> ] [-EnableSecureBoot <OnOffState]> ] [-FirstBootDevice <VMComponentObject> ] [-Passthru] [-PauseAfterBootFailure <Nullable [Microsoft.HyperV.PowerShell.OnOffState]> ] [-PreferredNetworkBootProtocol <IPProtocolPreference]> ] [-SecureBootTemplate <System.String> ] [-SecureBootTemplateId <Nullable [System.Guid]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Set-VMFirmware [-VM] <VirtualMachine[]> [-BootOrder <VMComponentObject[]> ] [-ConsoleMode <Nullable [Microsoft.HyperV.PowerShell.ConsoleModeType]> ] [-EnableSecureBoot <OnOffState]> ] [-FirstBootDevice <VMComponentObject> ] [-Passthru] [-PauseAfterBootFailure <Nullable [Microsoft.HyperV.PowerShell.OnOffState]> ] [-PreferredNetworkBootProtocol <IPProtocolPreference]> ] [-SecureBootTemplate <System.String> ] [-SecureBootTemplateId <Nullable [System.Guid]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-VMFirmware cmdlet sets the firmware configuration of a Generation 2 virtual machine.

Parameters

-BootOrder<VMComponentObject[]>

Specifies an array of devices. The boot order determines the order of the devices from which to boot. The acceptable values for this parameter are:

  -- VMBootSource
  -- VMNetworkAdapter
  -- HardDiskDrive
  -- DVDDrive

The VMBootSource value describes a boot entry in firmware nonvolatile Random Access Memory (NVRAM).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<Microsoft.Management.Infrastructure.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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies the names of the Hyper-V hosts whose firmware configuration you want to modify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConsoleMode<Nullable [Microsoft.HyperV.PowerShell.ConsoleModeType]>

Specifies the console mode type for the virtual machine. This parameter allows a virtual machine to run without graphical user interface.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<System.Management.Automation.PSCredential[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableSecureBoot<OnOffState]>

Specifies whether to enable secure boot. The acceptable values for this parameter are:

  -- On
  -- Off

Secure boot uses a public key infrastructure that protects the integrity of the operating system.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FirstBootDevice<VMComponentObject>

Specifies the device from which to attempt to boot from first. The acceptable values for this parameter are:

  -- VMBootSource
  -- VMNetworkAdapter
  -- HardDiskDrive
  -- DVDDrive

The VMBootSource value describes a boot entry in firmware NVRAM.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Passthru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PauseAfterBootFailure<Nullable [Microsoft.HyperV.PowerShell.OnOffState]>

Specifies the behavior of the virtual machine after a start failure. For a value of On, if the virtual machine fails to start correctly from a device, the virtual machine is paused.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PreferredNetworkBootProtocol<IPProtocolPreference]>

Specifies the IP protocol version to use during a network boot.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SecureBootTemplate<System.String>

Specifies the name of the secure boot template. If secure boot is enabled, you must have a valid secure boot template for the guest operating system to start.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SecureBootTemplateId<Nullable [System.Guid]>

Specifies the ID of the secure boot template.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

Specifies the virtual machine objects for which want to modify the firmware configuration. 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

-VMFirmware<VMFirmware[]>

Specifies an array of virtual machine firmware configurations. The cmdlet sets the firmware configurations you specify.


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 for which you want to modify the firmware configuration.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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 when run against Generation 2 virtual machines.

Examples

Example 1

This example enables secure boot functionality on the virtual machine “Test VM”.


PS C:\> Set-VMFirmware "Test VM" -EnableSecureBoot On

Example 2

This example sets the virtual machine “Test VM” to boot off of the VM network adapter object stored in $vmNetworkAdapter. This object was acquired using get-VMNetworkAdapter.


PS C:\> Set-VMFirmware "Test VM" -FirstBootDevice $vmNetworkAdapter

Example 3

Sets the boot order for the virtual machine “Test VM”. $vmNetworkAdapter contains a VM Network Adapter object (acquired using get-VMNetworkAdapter) and $vmHardDiskDrive contains a VM hard disk object (acquired using get-VMHardDiskDrive). Any existing boot entries not specified by this command will be removed from the virtual machine.


PS C:\> Set-VMFirmware "Test VM" -BootOrder $vmNetworkAdapter, $vmHardDiskDrive

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft