Edit

Set-CMAlert

  • Reference
Module:
ConfigurationManager

Changes properties of Configuration Manager alerts.

Syntax

Set-CMAlert
   [-Comment <String>]
   -InputObject <IResultObject>
   [-NewName <String>]
   [-ParameterValue <String>]
   [-Severity <Severities>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMAlert
   [-Comment <String>]
   -Id <String>
   [-NewName <String>]
   [-ParameterValue <String>]
   [-Severity <Severities>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMAlert
   [-Comment <String>]
   -Name <String>
   [-NewName <String>]
   [-ParameterValue <String>]
   [-Severity <Severities>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMAlert cmdlet changes the properties of one or more Configuration Manager alerts.

Note

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

Examples

Example 1: Set alert properties

PS XYZ:\> Set-CMAlert -Id "16777223" -Comments "Editing severity" -Severity 2

This command changes the values of the Comments and Severity properties for an alert that has the ID 16777223.

Example 2: Set alert properties by using alert object variable

PS XYZ:\> $AlertObj = Get-CMAlert -Id "16777221"
PS XYZ:\> Set-CMAlert -InputObject $AlertObj -Comments "Updating alert"

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

The second command changes the Comments property of the alert stored in the $AlertObj variable.

Parameters

-Comment

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

-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

Specifies an alert ID. You can obtain 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

Specifies a CMAlert object. To obtain a CMAlert object, use Get-CMAlert.

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

-Name

Specifies an alert name. You can obtain the name of an alert by using Get-CMAlert.

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

-NewName

Specifies a new name for the alert.

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

-ParameterValue

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

-Severity

Specifies the severity of an alert. The acceptable values for this parameter are:

  • 1: Error
  • 2: Warning
  • 3: Informational
Type:Severities
Accepted values:Error, Warning, Informational
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 doesn't 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