Edit

Share via

Remove-CMCollectionDirectMembershipRule

  • Reference
Module:
ConfigurationManager

Remove a direct membership rule from a device or user collection.

Syntax

Remove-CMCollectionDirectMembershipRule
      -CollectionName <String>
      -ResourceName <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -CollectionName <String>
      -Resource <IResultObject[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -CollectionName <String>
      -ResourceId <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -CollectionId <String>
      -Resource <IResultObject[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -CollectionId <String>
      -ResourceId <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -CollectionId <String>
      -ResourceName <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -InputObject <IResultObject>
      -Resource <IResultObject[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -InputObject <IResultObject>
      -ResourceId <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CMCollectionDirectMembershipRule
      -InputObject <IResultObject>
      -ResourceName <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use this cmdlet to remove a direct membership rule from a device or user collection. A direct membership rule lets you explicitly choose the members of the collection. Default collections don't have direct membership rules. 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.

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

Note

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

Examples

Example 1: Remove the local machine from a collection of test devices

This example uses the Windows environment variable ComputerName to remove it from the collection named Test Devices. It uses the Force parameter to not prompt for confirmation.

Remove-CMCollectionDirectMembershipRule -CollectionName 'Test Devices' -ResourceName $env:ComputerName -Force

Parameters

-CollectionId

Specify the ID of the collection with the direct rule to remove. For example, "XYZ0003F".

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 collection with the direct rule to remove.

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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Run the command without asking for confirmation.

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

-InputObject

Specify a collection object with the direct rule to remove. To get this object, use the Get-CMCollection, Get-CMDeviceCollection, or Get-CMUserCollection cmdlets.

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

-Resource

Specify an array of resource objects to remove from the collection. To get this object, use the Get-CMResource, Get-CMDevice, or Get-CMUser cmdlets.

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

-ResourceId

Specify an array of resource IDs to remove from the collection. This value is the ResourceId property of the SMS_Resource class. For example, "33555693".

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

-ResourceName

Specify an array of resource names to remove from the collection.

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

-WhatIf

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

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Notes

This cmdlet is similar to Remove-CMDeviceCollectionDirectMembershipRule and Remove-CMUserCollectionDirectMembershipRule, which are specific to the type of collection. This cmdlet works with either device or user collections.