Get-PcsvDevice

Get-PcsvDevice

Gets information about a remote hardware device.

構文

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

詳細説明

The Get-PcsvDevice cmdlet gets information about a remote device. The cmdlet connects to a remote device, for example, a baseboard management controller, and collects hardware inventory information and information about the firmware installed on the device. The cmdlet communicates with the remote device by using the Intelligent Platform Management Interface (IPMI) or WS-Management (WSMAN) protocols.

パラメーター

-AsJob

-Authentication<Authentication>

Specifies an authentication method to use for devices managed by WS-Management. Do not specify this parameter for devices managed by using 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.

-CimSession<CimSession[]>

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

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

-ManagementProtocol<ManagementProtocol>

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

-- WSMAN
-- IPMI

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 (PCSV) profiles. Refer to your hardware documentation for supported management protocols.

-Port<UInt16>

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

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

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

-SkipCNCheck

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

Specify this parameter only for managing devices by using WSMAN over HTTPS. Be sure to specify this parameter only for trusted computers.

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

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

-ThrottleLimit<Int32>

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

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

-UseSSL

Indicates that the server connects to the target computer by using SSL. WSMAN 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.

<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

  A MSFT_PCSVDevice instance (derived from CIM_PhysicalComputerSystemView) that is used to represent the remote device.

例

Example 1: Get information from a remote IPMI device

This example connects with an IPMI device and returns hardware and firmware information for the device.

The first command uses the Get-Credential cmdlet to create a credential, and then stores it in the $Credential variable. The cmdlet prompts you for a user name and password. For more information, type Get-Help Get-Credential.

The second command returns the hardware and firmware information from the target computer. The command connects with the remote hardware device that has the management IP address 10.0.0.29 by using the IPMI management protocol and the default port (623). The command specifies the credential object stored in the $Credential variable.

The EnabledState property indicates whether the machine is on or off or in an alternate state, such as quiesce.

PS C:\> $Credential = Get-Credential Admin
PS C:\> Get-PCSVDevice -TargetAddress "10.0.0.29" -ManagementProtocol IPMI -Credential $Credential

Example 2: Get information from a remote WSMAN device

This example connects with a WS-Management device by using a custom port, and returns the hardware and firmware information for the device. The remote device uses a self-signed certificate for authentication, so the Get-PcsvDevice cmdlet specifies the SkipCACheck and SkipCNCheck parameters. Specify these parameters only for connecting to trusted remote hardware devices.

The first command uses the Get-Credential cmdlet to create a credential, and then stores it in the $Credential variable. The cmdlet prompts you for a user name and password. For more information, type Get-Help Get-Credential.

The second command returns the hardware and firmware information from the target computer. The command connects with the target computer that has the management IP address 10.0.0.30 by using the WS-Management protocol, SSL, and port 664. The command specifies the credential object stored in the $Credential variable.

The command specifies that the client connects by using HTTPS without validating that a CA authority signed the server certificate. The command specifies that the certificate common name (CN) of the server does not need to match the host name of the server. The command specifies that the cmdlet skips the revocation check of server certificates.

PS C:\> $Credential = Get-Credential Admin
PS C:\> Get-PcsvDevice -TargetAddress "10.0.0.30" -Credential $Credential -ManagementProtocol WSMan -Port 664 -UseSSL -SkipCACheck -SkipCNCheck -SkipRevocationCheck

Example 3: Get information from a remote WSMAN device over HTTP

This example connects with a WS-Management using HTTP. Since the traffic is unencrypted, additional configuration on the management client is required.

The first two commands create the configuration that the WS-Management client on Windows requires to enable unecrypted WSMAN traffic. This is a one-time only configuration.

The third command uses the Get-Credential cmdlet to create a credential, and then stores it in the $Credential variable. The cmdlet prompts you for a user name and password. For more information, type Get-Help Get-Credential.

The fourth command connects with the target computer that has the management IP address 10.0.0.30 by using the WS-Management protocol and port 16992. The command specifies the credential object stored in the $Credential variable. The command specifies the Digest authentication method for the device.

PS C:\> Set-Item WSMan:\localhost\Client\TrustedHosts "10.0.0.30"
PS C:\> Set-Item WSMan:\localhost\Client\AllowUnencrypted true
PS C:\> $Credential = Get-Credential Admin
PS C:\> Get-PCSVDevice -TargetAddress 10.0.0.30 -ManagementProtocol WSMan -Port 16992 -Credential $Credential -Authentication Digest

関連トピック

Start-PcsvDevice

Stop-PcsvDevice

Restart-PcsvDevice