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.
Syntax
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>]
Detailed Description
The Get-WdsClient cmdlet gets client devices from the Pending Device database, or pre-staged clients from Active Directory® Domain Services (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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
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 |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceName<String>
Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
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 |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DomainName<String>
Specifies a domain name. Specify a value for this parameter only if you specify the Domain parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PendingClientStatus<PendingClientStatusFlag>
Specifies a pending client status. The acceptable values for this parameter are:
-- Any
-- Approved
-- Denied
-- Pending
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
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 |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
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 |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient
Examples
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