Remove-CMUserCollectionFromDistributionPointGroup
Remove-CMUserCollectionFromDistributionPointGroup
Removes a user collection from a distribution point group in Configuration Manager.
Syntax
Parameter Set: SearchByIdMandatory
Remove-CMUserCollectionFromDistributionPointGroup -DistributionPointGroupId <String> -UserCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Remove-CMUserCollectionFromDistributionPointGroup -DistributionPointGroupName <String> -UserCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Remove-CMUserCollectionFromDistributionPointGroup -InputObject <IResultObject> -UserCollectionName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMUserCollectionFromDistributionPointGroup cmdlet removes a user collection from a distribution point group in Microsoft System Center 2012 SP1 Configuration Manager. Distribution point groups contain distribution points that have a common purpose, such as supporting mobile device clients. A distribution point group simplifies tasks that involve the individual distribution points in a group.
Parameters
-DistributionPointGroupId<String>
Specifies an ID of a distribution group in Configuration Manager.
Aliases |
GroupId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroupName<String>
Specifies a name of a distribution point group in Configuration Manager.
Aliases |
GroupName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a distribution point group object. To obtain a distribution point group object, use the Get-CMDistributionPointGroup cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserCollectionName<String>
Specifies a name of a user collection in Configuration Manager.
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: Remove a user collection by name
This command removes a user collection from a distribution point group by using a distribution point group ID and a user collection name.
PS C:\> Remove-CMUserCollectionFromDistributionPointGroup -DistributionPointGroupId "DPG-01" -UserCollectionName "Mobile Users"
Example 2: Remove a user collection by distribution point group name
This command removes a user collection from a distribution point group by using a distribution point group name and a user collection name.
PS C:\> Remove-CMUserCollectionFromDistributionPointGroup -DistributionPointGroupName "All Downtown" -UserCollectionName "Mobile Users"
Example 3: Remove a user collection by input object
This command removes a user collection from a distribution point group by using an input object and a user collection.
PS C:\> Remove-CMUserCollectionFromDistributionPointGroup -InputObject IRObject-013 -UserCollectionName "All Remote"