Get-CMUserCollectionExcludeMembershipRule
Get-CMUserCollectionExcludeMembershipRule
Gets the exclude membership rules from one or more user collections in the Configuration Manager hierarchy.
Syntax
Parameter Set: ByCollectionNameAndExcludeCollectionName
Get-CMUserCollectionExcludeMembershipRule -CollectionName <String> -ExcludeCollectionName <String> [ <CommonParameters>]
Parameter Set: ByCollectionIdAndExcludeCollectionId
Get-CMUserCollectionExcludeMembershipRule -CollectionId <String> -ExcludeCollectionId <String> [ <CommonParameters>]
Parameter Set: ByCollectionIdAndExcludeCollectionName
Get-CMUserCollectionExcludeMembershipRule -CollectionId <String> -ExcludeCollectionName <String> [ <CommonParameters>]
Parameter Set: ByCollectionNameAndExcludeCollectionId
Get-CMUserCollectionExcludeMembershipRule -CollectionName <String> -ExcludeCollectionId <String> [ <CommonParameters>]
Parameter Set: ByCollectionValueAndExcludeCollectionId
Get-CMUserCollectionExcludeMembershipRule -Collection <IResultObject> -ExcludeCollectionId <String> [ <CommonParameters>]
Parameter Set: ByCollectionValueAndExcludeCollectionName
Get-CMUserCollectionExcludeMembershipRule -Collection <IResultObject> -ExcludeCollectionName <String> [ <CommonParameters>]
Detailed Description
The Get-CMUserCollectionExcludeMembershipRule cmdlet retrieves the rules that exclude the members of another collection from the user collections where the rule is applied. You can specify the user collections where the rule is applied by using their names, IDs, or by specifying an object that represents the collections. You can specify the collection whose members are excluded by using its name, ID, or an object that represents the collection.
Microsoft System Center 2012 Configuration Manager dynamically updates the membership of the user collection on a schedule if the membership of the excluded collection changes. For more information about membership rules, see Introduction to Collections in Configuration Manager (https://go.microsoft.com/fwlink/p/?LinkID=259433) in the TechNet library.
Parameters
-Collection<IResultObject>
Specifies a Configuration Manager user collection object. To obtain a user collection object, use the Get-CMUserCollection 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 user 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 a user collection where the rule is applied.
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 from the user collections.
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 user collections.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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: Get the exclude membership rule from a user collection
This command gets the rule that excludes the members of the collection that has the ID SMSDM001 from the user collection that has the ID 9990000D.
PS C:\> Get-CMUserCollectionExcludeMembershipRule –CollectionId "9990000D" –ExcludeCollectionId "SMSDM001"
Related topics
Add-CMUserCollectionExcludeMembershipRule