Gets client devices from the pending device database, or pre-staged devices from Active Directory or the stand-alone server device database.
PowerShell · Risk: Low · Documentation Verified
Last verified: 2026-10-26
Microsoft WDS reference: Gets client devices from the pending device database, or pre-staged devices from Active Directory or the stand-alone server device database. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Get-WdsClient. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / WDS · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.
-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.
-DeviceID (required)
Specifies the ID of the computer. This identifier is the GUID of a network adapter, a MAC address, or a DHCP unique identifier associated with the computer.
-DeviceName
Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.
-Domain (required)
Indicates that the cmdlet refers to pre-staged clients in the domain specified by the *DomainName* parameter, instead of the domain of the server that runs Windows Deployment Services or the whole forest.
-DomainName
Specifies a domain name. Specify a value for this parameter only if you specify the *Domain* parameter.
-PendingClientStatus (required)
Specifies a pending client status. The acceptable values for this parameter are: - Any - Approved - Denied - Pending
-RequestId (required)
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 (required)
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
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.
Prerequisites
Windows with the WDS module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.
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. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.