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.
語法
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>]
詳細描述
The Remove-WdsClient cmdlet removes a pre-staged client from Active Directory® 網域服務 (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.
參數
-AsJob
別名 |
無 |
必要？ |
false |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
false |
接受萬用字元？ |
false |
-CimSession<CimSession[]>
在遠端工作階段或遠端電腦上執行 Cmdlet。輸入電腦名稱或工作階段物件，例如 New-CimSession 或 Get-CimSession Cmdlet 的輸出。預設為本機電腦上的目前工作階段。
別名 |
Session |
必要？ |
false |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
false |
接受萬用字元？ |
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.
別名 |
無 |
必要？ |
true |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
True (ByPropertyName) |
接受萬用字元？ |
false |
-DeviceName<String>
Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.
別名 |
無 |
必要？ |
true |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
True (ByPropertyName) |
接受萬用字元？ |
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.
別名 |
無 |
必要？ |
true |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
false |
接受萬用字元？ |
false |
-DomainName<String>
Specifies a domain name. Specify a value for this parameter only if you specify the Domain parameter.
別名 |
無 |
必要？ |
false |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
True (ByPropertyName) |
接受萬用字元？ |
false |
-PendingClientStatus<PendingClientStatusFlag>
Specifies a pending client status. 此參數接受的值包括：
-- Any
-- Approved
-- Denied
-- Pending
別名 |
無 |
必要？ |
true |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
True (ByPropertyName) |
接受萬用字元？ |
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.
別名 |
無 |
必要？ |
true |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
false |
接受萬用字元？ |
false |
-ThrottleLimit<Int32>
指定為執行此 Cmdlet 可建立的最大同時作業數。如果省略這個參數或輸入 0 的值，則 Windows PowerShell® 會根據在電腦上執行的 CIM Cmdlet 數目，計算 Cmdlet 的最佳節流限制。節流限制僅適用於目前 Cmdlet，不適用於工作階段或電腦。
別名 |
無 |
必要？ |
false |
位置？ |
named |
預設值 |
無 |
接受管線輸入？ |
false |
接受萬用字元？ |
false |
<CommonParameters>
此 Cmdlet 支援一般參數：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 與 -OutVariable。如需詳細資訊，請參閱 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
輸入
輸入類型是您可以使用管線處理方式傳遞給 Cmdlet 的物件類型。
輸出
輸出類型是 Cmdlet 所發出的物件類型。
範例
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