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.
Sintaxis
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>]
Descripción detallada
The Get-WdsClient cmdlet gets client devices from the Pending Device database, or pre-staged clients from Servicios de dominio de 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
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-CimSession<CimSession[]>
Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.
Alias |
Session |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByValue, ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-DeviceName<String>
Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByValue, ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-DomainName<String>
Specifies a domain name. Specify a value for this parameter only if you specify the Domain parameter.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-PendingClientStatus<PendingClientStatusFlag>
Specifies a pending client status. Los valores aceptables para este parámetro son los siguientes:
-- Any
-- Approved
-- Denied
-- Pending
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByValue, ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByValue, ByPropertyName) |
¿Aceptar caracteres comodín? |
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.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ThrottleLimit<Int32>
Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient
Ejemplos
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