Remove-CMDeviceCollection
Updated: March 1, 2013
Applies To: System Center 2012 Configuration Manager SP1
Remove-CMDeviceCollection
Syntax
Parameter Set: SearchByIdMandatory Remove-CMDeviceCollection -CollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByNameMandatory Remove-CMDeviceCollection -Name <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SearchByValueMandatory Remove-CMDeviceCollection -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMDeviceCollection cmdlet removes device collections from the Configuration Manager hierarchy. You can specify the device collections by their name, Id, or an object that represents the collections.
For more information about collection, see Introduction to Collections in Configuration Manager.
Parameters
-CollectionId<String>
Specifies the Ids of the device collections to remove.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Force
Specifies whether you want to suppress the confirmation message that Configuration Manager displays to the administrative user before the collections are removed.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-InputObject<IResultObject>
Specifies an object that represents the device collection to remove.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Name<String>
Specifies the names of the collections to remove.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Confirm
Prompts you for confirmation before executing the command.
Required? | false |
Position? | named |
Default Value | false |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
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.
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
This example removes the specified device collection. Before the collection is removed, a message is displayed at the command line to confirm that you want to remove the collection.
PS C:\> Remove-CMDeviceCollection -name "Windows 7"
