Remove-WdsClient
Remove-WdsClient
Removes a pre-staged client from AD DS or the stand-alone server device database, or clears the Pending Devices database.
Syntax
Parameter Set: PendingClientByStatus
Remove-WdsClient -PendingClientStatus <PendingClientStatusFlag> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: PrestagedClientByDeviceId
Remove-WdsClient -DeviceID <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: PrestagedClientByDeviceIdDomain
Remove-WdsClient -DeviceID <String> -Domain [-AsJob] [-CimSession <CimSession[]> ] [-DomainName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: PrestagedClientByDeviceIdSearchForest
Remove-WdsClient -DeviceID <String> -SearchForest [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: PrestagedClientByDeviceName
Remove-WdsClient -DeviceName <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: PrestagedClientByDeviceNameDomain
Remove-WdsClient -DeviceName <String> -Domain [-AsJob] [-CimSession <CimSession[]> ] [-DomainName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: PrestagedClientByDeviceNameSearchForest
Remove-WdsClient -DeviceName <String> -SearchForest [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Remove-WdsClient cmdlet removes a pre-staged client from Active Directory® Domain Services (AD DS) or the stand-alone server device database, or clears the Pending Devices database.
To remove pre-staged client from AD DS, specify the name of the computer or the device ID, which is a GUID, media access control (MAC) address, or Dynamic Host Configuration Protocol (DHCP) identifier associated with the computer. 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 clear the Pending Devices database, specify whether to remove 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 (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? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (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? |
True (ByPropertyName) |
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 (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.
Examples
Example 1: Remove a device by using its ID from a specified domain
This command removes the pre-staged device that has the specified ID. The cmdlet searches the domain named TSQA.Contoso.com for the device.
PS C:\> Remove-WdsClient -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -Domain -DomainName "TSQA.Contoso.com"
Example 2: Remove a device by using its name from a specified domain
This command removes the pre-staged device named TSQA014. The cmdlet searches the domain named TSQA.Contoso.com for the device.
PS C:\> Remove-WdsClient -DeviceName "TSQA014" -Domain -DomainName "TSQA.Contoso.com"
Example 3: Remove a device by using its ID
This command removes a pre-staged device that has the specified ID. The cmdlet searches the entire forest for the device.
PS C:\> Remove-WdsClient -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -SearchForest
Example 4: Remove a device by using its name
This command removes a pre-staged device named TSQA073. The cmdlet searches the entire forest for the device.
PS C:\> Remove-WdsClient -DeviceName "TSQA073" -SearchForest
Example 5: Remove all approved devices in the local domain
This command removes pre-staged devices that have a pending status of Approved. Because the command does not specify the Domain parameter or the SearchForest parameter, it removes devices only in the local domain.
PS C:\> Remove-WdsClient -PendingClientStatus Approved