Remove-CMDistributionPointFromGroup
Remove-CMDistributionPointFromGroup
Removes a Configuration Manager distribution point from a distribution point group.
Syntax
Parameter Set: RemoveDistributionPointFromGroupById_Id
Remove-CMDistributionPointFromGroup -DistributionPointGroupId <String> -DistributionPointId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupById_Name
Remove-CMDistributionPointFromGroup -DistributionPointGroupName <String> -DistributionPointId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupById_Object
Remove-CMDistributionPointFromGroup -DistributionPointGroup <IResultObject> -DistributionPointId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupByName_Id
Remove-CMDistributionPointFromGroup -DistributionPointGroupId <String> -DistributionPointName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupByName_Name
Remove-CMDistributionPointFromGroup -DistributionPointGroupName <String> -DistributionPointName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupByName_Object
Remove-CMDistributionPointFromGroup -DistributionPointGroup <IResultObject> -DistributionPointName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupByObject_Id
Remove-CMDistributionPointFromGroup -DistributionPoint <IResultObject> -DistributionPointGroupId <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupByObject_Name
Remove-CMDistributionPointFromGroup -DistributionPoint <IResultObject> -DistributionPointGroupName <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveDistributionPointFromGroupByObject_Object
Remove-CMDistributionPointFromGroup -DistributionPoint <IResultObject> -DistributionPointGroup <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMDistributionPointFromGroup cmdlet removes a Microsoft System Center 2012 SP1 Configuration Manager distribution point from a distribution point group. Distribution point groups provide a logical grouping of distribution points for content distribution.
To remove a distribution point, specify both the distribution point to remove and the distribution point group. You can specify these values by ID or name, or you can use the Get-CMDistributionPoint cmdlet or the Get-CMDistributionPointGroup cmdlet to obtain the relevant object.
Parameters
-DistributionPoint<IResultObject>
Specifies a distribution point object. To obtain a distribution point object, use the Get-CMDistributionPoint cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroup<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 |
-DistributionPointGroupId<String>
Specifies the ID of a distribution point group.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointGroupName<String>
Specifies the name of a distribution point group.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointId<String>
Specifies the ID of a distribution point.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DistributionPointName<String>
Specifies the name of a distribution point.
Aliases |
none |
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 |
-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 distribution point by using an ID
This command removes a distribution point that has an ID of SMS000022 from a distribution point group that has the ID SMS000067.
PS C:\> Remove-CMDistributionPointFromGroup -DistributionPointGroupId "SMS000067" -DistributionPointId "SMS000022"
Example 2: Remove a distribution point by using a name
This command removes a distribution point, specified by its name, from a distribution point group that has the ID SMS000067. This command uses the Force parameter, therefore, it does not prompt you before it removes the distribution point.
PS C:\> Remove-CMDistributionPointFromGroup -DistributionPointGroupId "SMS000067" -DistributionPointName "Western office distribution point" -Force