Remove-CMDevice
Remove-CMDevice
Removes Configuration Manager client devices.
Syntax
Parameter Set: SearchByIdMandatory
Remove-CMDevice -DeviceId <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Remove-CMDevice -DeviceName <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Remove-CMDevice -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMDevice cmdlet removes one or more Microsoft System Center 2012 Configuration Manager client devices. Do not remove a client if you want to uninstall the client or remove it from a collection.
Removing a device client manually deletes the client record from the System Center 2012 Configuration Manager database. Typically, you should not use this action unless it is for troubleshooting scenarios. If you delete the client record and the System Center 2012 Configuration Manager client is still installed and communicating with System Center 2012 Configuration Manager, Heartbeat Discovery recreates the client record the System Center 2012 Configuration Manager database, although the client history and any previous associations are lost.
When you remove a mobile device client that was enrolled by System Center 2012 Configuration Manager, this action also revokes the PKI certificate that was issued to the mobile device and this certificate is then rejected by the management point, even if IIS does not check the Certificate Revocation List (CRL). Certificates on mobile device legacy clients are not revoked when you delete these clients.
Parameters
-DeviceId<String[]>
Specifies an array of device IDs.
Aliases |
ResourceId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceName<String[]>
Specifies an array of device names.
Aliases |
Name |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Removes the device without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a CMDevice object. To obtain a CMDevice object, use the Get-CMDevice cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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 an ID
This command removes the device that has the ID 2097152000.
PS C:\> Remove-CMDevice -DeviceId "2097152000"
Example 2: Remove a device by using a name
This command removes the device named Cmcen-dist02.
PS C:\> Remove-CMDevice -DeviceName "Cmcen-dist02"