Set-PcsvDeviceBootConfiguration

Set-PcsvDeviceBootConfiguration

Modifies the boot configuration on the remote hardware device.

構文

Parameter Set: InputObject (cdxml)
Set-PcsvDeviceBootConfiguration -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-OneTimeBootSource] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByComputerName
Set-PcsvDeviceBootConfiguration [-TargetAddress] <String> [-Credential] <PSCredential> [-ManagementProtocol] <ManagementProtocol> [[-Port] <UInt16> ] [-AsJob] [-Authentication <Authentication> ] [-CimSession <CimSession[]> ] [-PassThru] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-ThrottleLimit <Int32> ] [-TimeoutSec <UInt32> ] [-UseSSL] [-OneTimeBootSource] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-PcsvDeviceBootConfiguration cmdlet modifies the boot configuration for a remote hardware device. To retrieve the current boot configuration for a device, use the Get-PcsvDevice cmdlet.

The StructuredBootString property of the returned instance lists the valid boot sources, and the OneTimeBootSource property indicates whether one of the valid boot sources has already been configured to be the primary boot source for the next time the device undergoes a full restart.

パラメーター

-AsJob

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Authentication<Authentication>

Specifies an authentication method to use for devices managed by Web Services for Management (WS-Management). Do not use this parameter for devices managed by using Intelligent Platform Management Interface (IPMI). このパラメーターに対して使用できる値:

-- Basic
-- Digest
-- Default

If you specify Default for this parameter and a value of WSMAN for the ManagementProtocol parameter, the cmdlet uses Basic authentication.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-CimSession<CimSession[]>

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

エイリアス

Session

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Credential<PSCredential>

Specifies a PSCredential object based on a user name and password. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential. This parameter specifies the credential for the remote hardware device.

エイリアス

なし

必須?

true

位置は?

3

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-InputObject<CimInstance[]>

Specifies an array of devices, as MSFT_PCSVDevice objects, to manage. To obtain MSFT_PCSVDevice objects, use the Get-PcsvDevice cmdlet. This parameter specifies the credential for the remote hardware device.

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-ManagementProtocol<ManagementProtocol>

Specifies a management protocol used to communicate with a device. このパラメーターに対して使用できる値:

-- WSMAN
-- IPMI

Refer to your hardware documentation for supported management protocols.

Specify WSMAN for devices that represent information by using Systems Management Architecture for Server Hardware (SMASH), Desktop and mobile Architecture for System Hardware (DASH) or Physical Computer System View profiles.

エイリアス

MP

必須?

true

位置は?

4

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-OneTimeBootSource<String>

Specifies a one-time boot source, in the format CIM:<identifier>:<index>. For example, you can specify a boot source as CIM:Network:1. The StructuredBootString property of the PcsvDevice instance contains a list of valid boot sources.

エイリアス

OT,NextBoot

必須?

true

位置は?

2002

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Port<UInt16>

Specifies a network port on the remote computer to use for the management connection. If you do not specify a port, the cmdlet uses the following default values:

-- IPMI and WSMAN over HTTP. Port 623
-- WSMAN over HTTPS. Port 664.

エイリアス

なし

必須?

false

位置は?

5

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-SkipCACheck

Indicates that the client connects by using HTTPS without validating that a trusted CA signed the server certificate. Do not specify this parameter if you specify a value of IPMI for the ManagmentProtocol parameter.

Do not specify this parameter unless you can establish trust in another way, such as if the remote computer is part of a network that is physically secure and isolated, or if the remote computer is a trusted host in a Windows Remote Management (WinRM) configuration.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-SkipCNCheck

Indicates that the certificate common name of the server does not need to match the hostname of the server. Do not specify this parameter if you specify a value of IPMI for the ManagmentProtocol parameter.

Specify this parameter only for remote operations with WS-Management devices that use the HTTPS protocol. Use this parameter only for trusted computers.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-SkipRevocationCheck

Indicates that the cmdlet skips the revocation check of server certificates. Do not specify this parameter if you specify a value of IPMI for the ManagmentProtocol parameter.

Be sure to specify this parameter only for trusted computers.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-TargetAddress<String>

Specifies the name or IP address of the management port on the remote hardware device. For server hardware, this is typically a dedicated Baseboard Management Controller (BMC) IP address. For other devices, like network switches, this is the IP address of their management port. For desktop and mobile devices, the BMC sometimes shares the same IP address as the computer.

エイリアス

CN,ComputerName,IpAddress

必須?

true

位置は?

2

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-TimeoutSec<UInt32>

Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection attempt.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-UseSSL

Indicates that the cmdlet connects to a remote device by using SSL. WS-Management encrypts all content transmitted over the network. Specify this parameter to use the additional protection of HTTPS instead of HTTP. If you specify this parameter and SSL is not available on the connection port, the command fails.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

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

入力

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

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/HardwareManagement/MSFT_PCSVDevice

    The PCSV device is only returned as output if the PassThru parameter is specified.

Example 1 Modify the device boot configuration to use PXE boot

This example configures the boot source to use Pre-Boot Execution Environment (PXE) boot the next time the system boots.

The first command uses the Get-Credential cmdlet to get credentials, and stores the credentials in the variable named $MyCred. The cmdlet prompts you for a user name and password. For more information, type Get-Help Get-Credential.

The second command modifies the device boot configuration for the target computer, by using the OneTimeBootSource parameter to specify the boot configuration.

PS C:\> $MyCred = Get-Credential
PS C:\> Set-PCSVDeviceBootConfiguration -TargetAdress 10.1.12.43 -ManagementProtocol WSMan -Credential $MyCred -UseSSL -OneTimeBootSource "CIM:Network:1"

Example 2: Modify the device boot configuration to use the DVD drive

This example configures the boot source to use the DVD drive for the next time the system boots.

The first command uses the Get-Credential cmdlet to get credentials, and stores the credentials in the variable named $MyCred. The cmdlet prompts you for a user name and password. For more information, type Get-Help Get-Credential.

The second command uses the Get-PcsvDevice cmdlet to retrieve the configuration for the target computer, and passes the output to the Set-PcsvDeviceBootConfiguration cmdlet by using the pipeline operator.

PS C:\> $MyCred = Get-Credential
PS C:\> Get-PCSVDevice -TargetAddress 10.1.12.43 -ManagementProtocol WSMan -Credential $MyCred -UseSSL | Set-PcsvDeviceBootConfiguration -OneTimeBootSource "CIM:CD/DVD:1"

関連トピック

Get-PcsvDevice