Add-CMDeviceCollectionExcludeMembershipRule
Add-CMDeviceCollectionExcludeMembershipRule
Adds an exclude membership rule to one or more Configuration Manager device collections.
Syntax
Parameter Set: ByCollectionIdAndExcludeCollectionId
Add-CMDeviceCollectionExcludeMembershipRule -CollectionId <String> -ExcludeCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionIdAndExcludeCollectionName
Add-CMDeviceCollectionExcludeMembershipRule -CollectionId <String> -ExcludeCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionIdAndExcludeCollectionValue
Add-CMDeviceCollectionExcludeMembershipRule -CollectionId <String> -ExcludeCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionNameAndExcludeCollectionId
Add-CMDeviceCollectionExcludeMembershipRule -CollectionName <String> -ExcludeCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionNameAndExcludeCollectionName
Add-CMDeviceCollectionExcludeMembershipRule -CollectionName <String> -ExcludeCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionNameAndExcludeCollectionValue
Add-CMDeviceCollectionExcludeMembershipRule -CollectionName <String> -ExcludeCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionValueAndExcludeCollectionId
Add-CMDeviceCollectionExcludeMembershipRule -Collection <IResultObject> -ExcludeCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionValueAndExcludeCollectionName
Add-CMDeviceCollectionExcludeMembershipRule -Collection <IResultObject> -ExcludeCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByCollectionValueAndExcludeCollectionValue
Add-CMDeviceCollectionExcludeMembershipRule -Collection <IResultObject> -ExcludeCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-CMDeviceCollectionExcludeMembershipRule cmdlet adds a rule that excludes the members of another collection from the device collections where the rule is applied. You can specify the device collections where the rule is applied by name, ID, or by an object that represents the collections. You can specify the collection whose members are excluded by name, ID, or an object that represents the collection.
Microsoft System Center 2012 SP1 Configuration Manager dynamically updates the membership of the device collection on a schedule if the membership of the excluded collection changes. For more information on these rules, see Introduction to Collections in Configuration Manager (https://go.microsoft.com/fwlink/p/?LinkID=259433) on TechNet.
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 IDs of the device collections 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 |
-ExcludeCollection<IResultObject>
Specifies an object that represents the collection whose members are excluded from the device collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ExcludeCollectionId<String>
Specifies the ID of the collection whose members are excluded in the device collection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ExcludeCollectionName<String>
Specifies the name of the collection whose members are excluded from 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: Add an exclude collection rule to a single device collection
This command excludes the members of the All Mobile Devices collection, which has the ID SMSDM001, from the device collection, which has the ID 9990000D0.
PS C:\> Add-CMDeviceCollectionExcludeMembershipRule -CollectionId "9990000D" -ExcludeCollectionId "SMSDM001"
Related topics
Get-CMDeviceCollectionExcludeMembershipRule