Edit

Disable-CMAlert

  • Reference
Module:
ConfigurationManager

Disable alerts

Syntax

Disable-CMAlert
       -InputObject <IResultObject>
       [-PassThru]
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-CMAlert
       -Id <String>
       [-PassThru]
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Disable-CMAlert
       -Name <String>
       [-PassThru]
       [-DisableWildcardHandling]
       [-ForceWildcardHandling]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Use this cmdlet to disable one or more alerts in Configuration Manager.

Configuration Manager doesn't evaluate the condition for a disabled alert. It doesn't update a disabled alert, even if the state of the alert changes.

Note

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

Examples

Example 1: Disable an alert by using alert ID

This command disables an alert that has the ID 16777218.

Disable-CMAlert -Id "16777218"

Example 2: Disable an alert by using alert object variable

The first command gets an alert object that has the ID 16777221, and then stores it in the $AlertObj variable.

The second command disables the alert stored in the $AlertObj variable.

$AlertObj = Get-CMAlert -Id "16777221"
Disable-CMAlert -InputObject $AlertObj

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-Id

Specify the ID of an alert to disable. You can get the ID of an alert by using the Get-CMAlert cmdlet.

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

-InputObject

Specify an alert object to disable. To get this object, use the Get-CMAlert cmdlet.

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

-Name

Specify the name of an alert to disable. You can get the name of an alert by using the Get-CMAlert cmdlet.

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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object