Remove-CMSoftwareUpdateAutoDeploymentRule
Remove-CMSoftwareUpdateAutoDeploymentRule
Removes Configuration Manager deployment rules for automatic software updates.
Syntax
Parameter Set: SearchByIdMandatory
Remove-CMSoftwareUpdateAutoDeploymentRule -Id <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Remove-CMSoftwareUpdateAutoDeploymentRule -Name <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Remove-CMSoftwareUpdateAutoDeploymentRule -InputObject <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CMSoftwareUpdateAutoDeploymentRule cmdlet removes specified Microsoft System Center 2012 Configuration Manager deployment rules for automatic software updates.
System Center 2012 Configuration Manager uses rules to manage automatic deployment of software updates. When a rule runs, System Center 2012 Configuration Manager adds updates that qualify for the rule to a software update group. The System Center 2012 Configuration Manager server downloads content files and copies them to distribution points, and then updates client computers.
You can specify rules to remove by ID or by name, or specify a rule object by using the Get-CMSoftwareUpdateAutoDeploymentRule cmdlet. This cmdlet deletes rules permanently. You can use the Disable-CMSoftwareUpdateAutoDeploymentRule cmdlet to suspend a rule.
Parameters
-Force
Removes a deployment rule object without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Id<String[]>
Specifies an array of IDs for rules for automatic deployment of software updates. This value is the AutoDeploymentID property of the deployment rule object.
Aliases |
AutoDeploymentId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a software update automatic deployment rule object. To obtain a deployment rule object, use the Get-CMSoftwareUpdateAutoDeploymentRule cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name of a rule for automatic deployment of software updates.
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 deployment rule by name
This command removes a rule named Weekly Driver Updates. Because the command does not include the Force parameter, the cmdlet prompts you before it deletes the rule.
PS C:\> Remove-CMSoftwareUpdateAutoDeploymentRule -Name "Weekly Driver Updates"
Example 2: Remove a deployment rule by ID
This command disables a deployment rule that has the ID 16777217. This command includes the Force parameter, so the cmdlet does not prompt you before it removes the rule.
PS C:\> Remove-CMSoftwareUpdateAutoDeploymentRule -Id "16777217" -Force
Example 3: Remove a deployment rule by using a variable
This example removes a rule named Weekly Driver Updates.
The first command gets a deployment rule that has the specified name and stores it in the $CMSUADR variable.
The second command removes the rule stored in the variable.
PS C:\> $CMSUADR = Get-CMSoftwareUpdateAutoDeploymentRule -Name "Weekly Driver Updates"
PS C:\> Remove-CMSoftwareUpdateAutoDeploymentRule -InputObject $CMSUADR -Force
Related topics
Disable-CMSoftwareUpdateAutoDeploymentRule
Enable-CMSoftwareUpdateAutoDeploymentRule