Edit

Share via

Add-CMUserCollectionDirectMembershipRule

  • Reference
Module:
ConfigurationManager

Add a direct membership rule to a user collection.

Syntax

Add-CMUserCollectionDirectMembershipRule
   -InputObject <IResultObject>
   [-PassThru]
   -Resource <IResultObject[]>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionDirectMembershipRule
   -CollectionId <String>
   [-PassThru]
   -ResourceId <Int32[]>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionDirectMembershipRule
   -CollectionId <String>
   [-PassThru]
   -Resource <IResultObject[]>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionDirectMembershipRule
   -CollectionName <String>
   [-PassThru]
   -ResourceId <Int32[]>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionDirectMembershipRule
   -CollectionName <String>
   [-PassThru]
   -Resource <IResultObject[]>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-CMUserCollectionDirectMembershipRule
   -InputObject <IResultObject>
   [-PassThru]
   -ResourceId <Int32[]>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to add a direct membership rule to a user collection. A direct membership rule lets you explicitly choose the members of the user collection. 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. 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 a direct membership rule to a user collection

This command adds a direct membership rule to the user collection with ID XYZ00057. It adds the resource with ID 16777210 to the collection.

Add-CMUserCollectionDirectMembershipRule -CollectionId "XYZ00057" -ResourceId "16777210"

Parameters

-CollectionId

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

Type:String
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
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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-Resource

Specify an array of resource objects to add to the user collection with this direct membership rule. To get this object, use the Get-CMResource or Get-CMUser cmdlets.

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

-ResourceId

Specify an array of IDs of the resources to add to the user collection with this direct membership rule. This value is the ResourceID property, for example 16777219.

Type:Int32[]
Aliases:ResourceIds
Position:Named
Default value:None
Required:True
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject[]

Outputs

System.Object