Share via


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.

Sintaxe

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

Descrição detalhada

The Get-WdsClient cmdlet gets client devices from the Pending Device database, or pre-staged clients from Serviços de Domínio do 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.

Parâmetros

-AsJob

Aliases

nenhuma

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-CimSession<CimSession[]>

Executa o cmdlet em uma sessão remota ou em um computador remoto. Insira um nome do computador ou um objeto de sessão, como a saída de um cmdlet New-CimSession ou Get-CimSession. O padrão é a sessão atual do computador local.

Aliases

Session

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

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

Aliases

nenhuma

Necessário?

true

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

True (ByValue, ByPropertyName)

Aceitar caracteres curinga?

false

-DeviceName<String>

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

Aliases

nenhuma

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

True (ByValue, ByPropertyName)

Aceitar caracteres curinga?

false

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

Aliases

nenhuma

Necessário?

true

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-DomainName<String>

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

Aliases

nenhuma

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-PendingClientStatus<PendingClientStatusFlag>

Specifies a pending client status. Os valores aceitáveis para este parâmetro são:

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

Aliases

nenhuma

Necessário?

true

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

True (ByValue, ByPropertyName)

Aceitar caracteres curinga?

false

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

Aliases

nenhuma

Necessário?

true

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

True (ByValue, ByPropertyName)

Aceitar caracteres curinga?

false

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

Aliases

nenhuma

Necessário?

true

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-ThrottleLimit<Int32>

Especifica o número máximo de operações simultâneas que podem ser estabelecidas para executar o cmdlet. Se esse parâmetro for omitido ou um valor de 0 for inserido, o Windows PowerShell® calculará o limite ideal de restrição para o cmdlet com base no número de cmdlets do CIM que estão em execução no computador. O limite de restrição se aplica somente ao cmdlet atual, e não à sessão ou ao computador.

Aliases

nenhuma

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet dá suporte a parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet.

Saídas

O tipo de saída é o tipo de objeto emitido pelo cmdlet.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient

Exemplos

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

Tópicos relacionados

Approve-WdsClient

Deny-WdsClient

New-WdsClient

Remove-WdsClient

Set-WdsClient