Remove-CMSoftwareUpdateGroup
Remove-CMSoftwareUpdateGroup
Removes Configuration Manager software update groups.
Syntax
Parameter Set: SearchByIdMandatory
Remove-CMSoftwareUpdateGroup -Id <String[]> [-Force] [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Remove-CMSoftwareUpdateGroup -Name <String[]> [-Force] [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Remove-CMSoftwareUpdateGroup -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMSoftwareUpdateGroup cmdlet removes software update groups from Microsoft System Center 2012 SP1 Configuration Manager. You can specify each software update group that you are removing by using the group IDs or names. If you remove a software update group, you can use the Get-CMSoftwareUpdateGroup cmdlet to return a software update group object and use that object to specify the group that you want to remove.
Parameters
-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 |
-Id<String[]>
Specifies an array of software update group IDs.
Aliases |
CIId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies the software update group object to remove. To obtain a software update group object, use Get-CMSoftwareUpdateGroup.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of software update group names.
Aliases |
LocalizedDisplayName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SecuredScopeNames<String>
Specifies a security scope name. This name identifies the security scope from which you remove the software update groups. A security scope name can be either Default or the name of a custom security scope.
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 software update group by using an ID
This command removes the software update group that has the ID ST10000B.
PS C:\> Remove-CMSoftwareUpdateGroup -Id "ST10000B"
Example 2: Remove a software update group by using a name
This command removes the software update group named SUGroupD01.
PS C:\> Remove-CMSoftwareUpdateGroup -Name "SUGroupD01"
Example 3: Remove a software update group by using an object variable
The first command gets the software update group that has the ID ST10000B, and then stores it in the variable $SubObj.
The second command removes the software update group by using the $SubObj variable.
PS C:\> $SubObj=Get-CMSoftwareUpdateGroup -Id "ST10000B"
PS C:\> Remove-CMSoftwareUpdateGroup -SoftwareUpdateGroup $SubObj