Edit

Add-CMUserCollectionIncludeMembershipRule

  • Reference
Module:
ConfigurationManager

Add an include membership rule to a user collection.

Syntax

Add-CMUserCollectionIncludeMembershipRule
   -CollectionName <String>
   -IncludeCollectionName <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -CollectionName <String>
   -IncludeCollection <IResultObject>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -CollectionName <String>
   -IncludeCollectionId <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -CollectionId <String>
   -IncludeCollection <IResultObject>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -CollectionId <String>
   -IncludeCollectionId <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -CollectionId <String>
   -IncludeCollectionName <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -InputObject <IResultObject>
   -IncludeCollection <IResultObject>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -InputObject <IResultObject>
   -IncludeCollectionId <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionIncludeMembershipRule
   -InputObject <IResultObject>
   -IncludeCollectionName <String>
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to add an include membership rule to a user collection. An include membership rule includes the members of another collection to the user collection 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 include a default collection, so the ID of an included collection can start with SMS.

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

When you add an include membership rule to a collection, resources may become members of the collection. This action can cause any software or configuration deployment to apply to users in the included collection.

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 include membership rule

This command adds the user collection named All Users with an include membership rule. The rule is added to the user collection named Users.

Add-CMUserCollectionIncludeMembershipRule -CollectionName "Users" -IncludeCollectionName "All Users"

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 include 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 add the rule.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeCollection

Specify an object for the included collection to add to 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

-IncludeCollectionId

Specify the ID of the included collection to add to the rule. This value is the CollectionID property, for example, XYZ00012. You can include 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

-IncludeCollectionName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

Type:IResultObject
Aliases:Collection
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

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

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object