Add-CMUserCollectionIncludeMembershipRule

Add-CMUserCollectionIncludeMembershipRule

Adds an include membership rule to one or more Configuration Manager user collections.

Syntax

Parameter Set: ByCollectionIdAndIncludeCollectionId
Add-CMUserCollectionIncludeMembershipRule -CollectionId <String> -IncludeCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionIdAndIncludeCollectionName
Add-CMUserCollectionIncludeMembershipRule -CollectionId <String> -IncludeCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionIdAndIncludeCollectionValue
Add-CMUserCollectionIncludeMembershipRule -CollectionId <String> -IncludeCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionNameAndIncludeCollectionId
Add-CMUserCollectionIncludeMembershipRule -CollectionName <String> -IncludeCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionNameAndIncludeCollectionName
Add-CMUserCollectionIncludeMembershipRule -CollectionName <String> -IncludeCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionNameAndIncludeCollectionValue
Add-CMUserCollectionIncludeMembershipRule -CollectionName <String> -IncludeCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionValueAndIncludeCollectionId
Add-CMUserCollectionIncludeMembershipRule -Collection <IResultObject> -IncludeCollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionValueAndIncludeCollectionName
Add-CMUserCollectionIncludeMembershipRule -Collection <IResultObject> -IncludeCollectionName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByCollectionValueAndIncludeCollectionValue
Add-CMUserCollectionIncludeMembershipRule -Collection <IResultObject> -IncludeCollection <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-CMUserCollectionIncludeMembershipRule cmdlet adds a rule that includes the members of another collection in 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 included by using its name, ID, or an object that represents the collection.

Microsoft System Center 2012 SP1 Configuration Manager dynamically updates the membership of the user collection on a schedule if the membership of the included 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 user collection object where the rule is applied. 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 ID of the 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

-CollectionName<String>

Specifies the name of the 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

-IncludeCollection<IResultObject>

Specifies an object that represents the collection whose members are included in the user collections.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IncludeCollectionId<String>

Specifies the ID for the collection whose members are included in the user collections.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IncludeCollectionName<String>

Specifies the name of the collection whose members are included in the user 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 include membership rule to a user collection

This command adds an include membership rule that has the ID SMSDM001 to the Configuration Manager user collection that has the ID 9990000D.

PS C:\> Add-CMUserCollectionIncludeMembershipRule -CollectionId "9990000D" -IncludeCollectionId "SMSDM001"

Get-CMUserCollection

Get-CMUserCollectionIncludeMembershipRule

Remove-CMUserCollectionIncludeMembershipRule