Remove-CMDeviceCollectionIncludeMembershipRule
Remove-CMDeviceCollectionIncludeMembershipRule
Removes an include membership rule from one or more device collection in the Configuration Manager hierarchy.
Syntax
Parameter Set: ByCollectionNameAndIncludeCollectionName
Remove-CMDeviceCollectionIncludeMembershipRule -CollectionName <String> -IncludeCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionIdAndIncludeCollectionId
Remove-CMDeviceCollectionIncludeMembershipRule -CollectionId <String> -IncludeCollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionIdAndIncludeCollectionName
Remove-CMDeviceCollectionIncludeMembershipRule -CollectionId <String> -IncludeCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionNameAndIncludeCollectionId
Remove-CMDeviceCollectionIncludeMembershipRule -CollectionName <String> -IncludeCollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionValueAndIncludeCollectionId
Remove-CMDeviceCollectionIncludeMembershipRule -Collection <IResultObject> -IncludeCollectionId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionValueAndIncludeCollectionName
Remove-CMDeviceCollectionIncludeMembershipRule -Collection <IResultObject> -IncludeCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMDeviceCollectionIncludeMembershipRule cmdlet removes an include rule from the specified collections. You can specify the device collections by using their names, Ids, or by specifying an input object that represents the collections.
For more information about collection rules, see Introduction to Collections in Configuration Manager.
Parameters
-Collection<IResultObject>
Specifies a Configuration Manager device collection object. To obtain a device collection object, use the Get-CMDeviceCollection cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CollectionId<String>
Specifies the ID of the device collection where the rule is applied.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CollectionName<String>
Specifies the name of the device collection where the rule is applied.
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 at the command line before the rule is removed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IncludeCollectionId<String>
Specifies the ID of the collection whose members are included in the device collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IncludeCollectionName<String>
Specifies the name of the collection whose members are included in the device collections.
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: Removes an include membership rule from a single collection
This example removes the rule for the All Mobile Devices (Id SMSD001) collection from the Windows 7 device collection.
PS C:\> Remove-CMDeviceCollectionIncludeRule -Name "Windows 7" -IncludecollectionId "smsd001"