Get-WdsClient

Get-WdsClient

Gets client devices from the pending device database, or pre-staged devices from Active Directory or the stand-alone server device database.

構文

Parameter Set: PrestagedClientByDeviceName
Get-WdsClient [-AsJob] [-CimSession <CimSession[]> ] [-DeviceName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PendingClientByRequestId
Get-WdsClient -RequestId <UInt32> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PendingClientByStatus
Get-WdsClient -PendingClientStatus <PendingClientStatusFlag> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PrestagedClientByDeviceId
Get-WdsClient -DeviceID <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PrestagedClientByDeviceIdDomain
Get-WdsClient -DeviceID <String> -Domain [-AsJob] [-CimSession <CimSession[]> ] [-DomainName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PrestagedClientByDeviceIdSearchForest
Get-WdsClient -DeviceID <String> -SearchForest [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PrestagedClientByDeviceNameDomain
Get-WdsClient -Domain [-AsJob] [-CimSession <CimSession[]> ] [-DeviceName <String> ] [-DomainName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: PrestagedClientByDeviceNameSearchForest
Get-WdsClient -SearchForest [-AsJob] [-CimSession <CimSession[]> ] [-DeviceName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

詳細説明

The Get-WdsClient cmdlet gets client devices from the Pending Device database, or pre-staged clients from Active Directory® ドメイン サービス (AD DS) or the stand-alone server device database.

You can get client devices or pre-staged clients by specifying a name or an ID. An ID is a GUID, media access control (MAC) address, or Dynamic Host Configuration Protocol (DHCP) identifier associated with the computer.

When you get clients from AD DS, you can specify a client within AD DS domain of the server that runs Windows Deployment Services, within a specified domain, or anywhere in the current AD DS forest.

To get pre-staged clients from the Pending Devices database, specify whether to get devices that are approved, denied, or pending.

パラメーター

-AsJob

-CimSession<CimSession[]>

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

-DeviceID<String>

Specifies the ID of the computer. This identifier is the GUID of a network interface card, a MAC address, or a DHCP unique identifier associated with the computer.

-DeviceName<String>

Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.

-Domain

Indicates that the cmdlet refers to pre-staged clients within the domain specified by the DomainName parameter, instead of the domain of the server that runs Windows Deployment Services or the entire forest.

-DomainName<String>

Specifies a domain name. Specify a value for this parameter only if you specify the Domain parameter.

-PendingClientStatus<PendingClientStatusFlag>

Specifies a pending client status. このパラメーターに対して使用できる値:

-- Any
-- Approved
-- Denied
-- Pending

-RequestId<UInt32>

Specifies the request ID that the server that runs Windows Deployment Services allocates to a device in the Pending Device database. If you do not specify this parameter, the cmdlet gets all devices that match the value specified in the PendingClientStatus parameter.

-SearchForest

Indicates that the cmdlet refers to pre-staged devices anywhere in the current AD DS forest. If you do not specify this parameter and do not specify the Domain parameter, the cmdlet looks for pre-staged devices in the local domain.

-ThrottleLimit<Int32>

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

<CommonParameters>

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

入力

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

出力

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

• Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient

例

Example 1: Get a device in a domain by specifying its ID

This command gets the device that has the specified ID. The command looks for this device in the AD DS domain named TSQA.Contoso.com.

PS C:\> Get-WdsClient -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -Domain -DomainName "TSQA.Contoso.com"

Example 2: Get a device in a domain by specifying its ID

This command gets the device named TSQA076. The command looks for this device in the AD DS domain named TSQA.Contoso.com.

PS C:\> Get-WdsClient -DeviceName "TSQA076" -Domain "TSQA.Contoso.com"

Example 3: Get a device in the current forest by specifying its ID

This command gets the device that has the specified ID. The command looks for this device in the current AD DS forest.

PS C:\> Get-WdsClient -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -SearchForest

Example 4: Get a device in the current forest by specifying its name

This command gets the device named TSQA022. The command looks for this device in the current AD DS forest.

PS C:\> Get-WdsClient -DeviceName "TSQA022" -SearchForest

Example 5: Get all pending devices

This command gets all clients that have a status of Pending in the Pending Devices database.

PS C:\> Get-WdsClient -PendingClientStatus Pending

Example 6: Get a pending device by specifying its request ID

This command gets the client that has the request ID 21 in the Pending Devices database.

PS C:\> Get-WdsClient -RequestId 21

関連トピック

Approve-WdsClient

Deny-WdsClient

New-WdsClient

Remove-WdsClient

Set-WdsClient