Edit

Share via

Add-CMUserCollectionExcludeMembershipRule

Module:
ConfigurationManager Module

Add an exclude membership rule to a user collection.

Syntax

ByNameAndName (Default) 

Add-CMUserCollectionExcludeMembershipRule
    -CollectionName <String>
    -ExcludeCollectionName <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameAndValue 

Add-CMUserCollectionExcludeMembershipRule
    -CollectionName <String>
    -ExcludeCollection <IResultObject>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameAndId 

Add-CMUserCollectionExcludeMembershipRule
    -CollectionName <String>
    -ExcludeCollectionId <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdAndValue 

Add-CMUserCollectionExcludeMembershipRule
    -CollectionId <String>
    -ExcludeCollection <IResultObject>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdAndId 

Add-CMUserCollectionExcludeMembershipRule
    -CollectionId <String>
    -ExcludeCollectionId <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdAndName 

Add-CMUserCollectionExcludeMembershipRule
    -CollectionId <String>
    -ExcludeCollectionName <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueAndValue 

Add-CMUserCollectionExcludeMembershipRule
    -InputObject <IResultObject>
    -ExcludeCollection <IResultObject>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueAndId 

Add-CMUserCollectionExcludeMembershipRule
    -InputObject <IResultObject>
    -ExcludeCollectionId <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueAndName 

Add-CMUserCollectionExcludeMembershipRule
    -InputObject <IResultObject>
    -ExcludeCollectionName <String>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to add an exclude membership rule to a user collection. An exclude membership rule excludes the members of another collection from the user collections where the rule is applied.

You can't add membership rules to default collections. Any collection that you target should have an ID that starts with the site code, not SMS. You can exclude a default collection, so the ID of an excluded collection can start with SMS.

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

When you add an exclude membership rule to a collection, a resource may no longer be a member of the user collection. This action can cause any software or configuration deployment to not apply to a user.

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: Add an exclude collection rule to a user collection

This command excludes the members of the Remote Users collection, which has the ID XYZ00017, from the user collection with ID XYZ00012.

Add-CMUserCollectionExcludeMembershipRule -CollectionId "XYZ00012" -ExcludeCollectionId "XYZ00017"

Parameters

-CollectionId

Specify the ID of the user collection to add 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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

ByIdAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

ByNameAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExcludeCollection

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExcludeCollectionId

Specify the ID of the excluded collection to add 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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExcludeCollectionName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByNameAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Collection

Parameter sets

ByValueAndValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueAndName
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object