Set-VMFirmware

Set-VMFirmware

Sets the firmware configuration of a virtual machine.

構文

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>]

詳細説明

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

パラメーター

-BootOrder<VMComponentObject[]>

Specifies an array of devices. The boot order determines the order of the devices from which to boot. このパラメーターに指定できる値は、次のとおりです。

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

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

-CimSession<Microsoft.Management.Infrastructure.CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。コンピューター名またはセッション オブジェクト (New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など) を入力します。既定値は、ローカル コンピューター上の現在のセッションです。

-ComputerName<String[]>

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

-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.

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

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

-EnableSecureBoot<OnOffState]>

Specifies whether to enable secure boot. このパラメーターに指定できる値は、次のとおりです。

  -- On
  -- Off

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

-FirstBootDevice<VMComponentObject>

Specifies the device from which to attempt to boot from first. このパラメーターに指定できる値は、次のとおりです。

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

The VMBootSource value describes a boot entry in firmware NVRAM.

-Passthru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットから出力は生成されません。

-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.

-PreferredNetworkBootProtocol<IPProtocolPreference]>

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

-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.

-SecureBootTemplateId<Nullable [System.Guid]>

Specifies the ID of the secure boot template.

-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.

-VMFirmware<VMFirmware[]>

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

-VMName<String[]>

Specifies an array of names of virtual machines for which you want to modify the firmware configuration.

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

• Microsoft.HyperV.Powershell.VMFirmware

説明

• Note: This cmdlet is supported only when run against Generation 2 virtual machines.

使用例

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

関連項目

Get-VMFirmware