Edit

Share via

Get-CMUserCollectionExcludeMembershipRule

  • Reference
Module:
ConfigurationManager

Get an exclude membership rule for a user collection.

Syntax

Get-CMUserCollectionExcludeMembershipRule
   -CollectionName <String>
   [-ExcludeCollectionName <String>]
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -CollectionName <String>
   -ExcludeCollection <IResultObject>
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -CollectionName <String>
   -ExcludeCollectionId <String>
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -CollectionId <String>
   -ExcludeCollection <IResultObject>
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -CollectionId <String>
   -ExcludeCollectionId <String>
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -CollectionId <String>
   [-ExcludeCollectionName <String>]
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -InputObject <IResultObject>
   -ExcludeCollection <IResultObject>
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -InputObject <IResultObject>
   -ExcludeCollectionId <String>
   [<CommonParameters>]
Get-CMUserCollectionExcludeMembershipRule
   -InputObject <IResultObject>
   [-ExcludeCollectionName <String>]
   [<CommonParameters>]

Description

Use this cmdlet to get one or more exclude membership rules for a user collection. An exclude membership rule excludes the members of another collection from the user collections where the rule is applied.

Configuration Manager dynamically updates the membership of the user collection on a schedule if the membership of the excluded collection changes.

For more information, see How to create collections in Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Get the exclude membership rules for a user collection

This command gets the rules that exclude the members of the collection with ID XYZ00089 from the user collection with ID XYZ00012.

Get-CMUserCollectionExcludeMembershipRule -CollectionId "XYZ00012" -ExcludeCollectionId "XYZ00089"

Parameters

-CollectionId

Specify the ID of the user collection to get the rule. This value is the CollectionID property, for example, XYZ00012. Since default collections don't have exclude membership rules, this ID starts with the site code and not SMS.

Type:String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-CollectionName

Specify the name of the user collection to get the rule.

Type:String
Aliases:Name
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExcludeCollection

Specify an object for the excluded collection to get the rule. To get this object, use the Get-CMCollection or Get-CMUserCollection cmdlets.

Type:IResultObject
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExcludeCollectionId

Specify the ID of the excluded collection to get the rule. This value is the CollectionID property, for example, XYZ00012. You can exclude default collections, so this value can start with either the site code or SMS.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExcludeCollectionName

Specify the name of the excluded collection to get the rule.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specify an object for the user collection to get the rule. To get this object, use the Get-CMCollection or Get-CMUserCollection cmdlets.

Type:IResultObject
Aliases:Collection
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object