Set-CMStatusFilterRule

  • Reference
Module:
ConfigurationManager

Modifies settings for a Configuration Manager filter rule for status messages.

Syntax

Set-CMStatusFilterRule
   [-AllowDeleteAfterDays <Int32>]
   [-ComponentName <String>]
   [-ForwardToStatusSummarizer <Boolean>]
   [-MessageId <Int32>]
   [-MessageType <MessageType>]
   -Name <String>
   [-Priority <PriorityChangeType>]
   [-ProcessLowerPriorityRule <Boolean>]
   [-ProgramPath <String>]
   [-PropertyId <String>]
   [-PropertyValue <String>]
   [-ReplicateToParentSite <Boolean>]
   [-ReplicationPriority <ReplicationPriority>]
   [-ReportToEventLog <Boolean>]
   [-RunProgram <Boolean>]
   [-SeverityType <SeverityType>]
   [-SiteCode <String>]
   [-SiteSystemServerName <String>]
   [-Source <String>]
   [-StatusFilterRuleSiteCode <String>]
   [-WriteToDatabase <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMStatusFilterRule cmdlet modifies settings for a Configuration Manager filter rule for status messages. Configuration Manager checks a status message against rules in order of priority. A rule can specify that rules with lower priority do not apply to a message after that rule applied.

Status filter rules specify how Configuration Manager responds to status messages. Each filter rule contains criteria and actions for status messages. You configure status filter rules for each site, not across all sites.

To change the priority of a rule, use the rule name to specify the rule.

Note

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

Examples

Example 1: Increase the priority of a rule

PS XYZ:\> Set-CMStatusFilterRule -Name "Status change to critical" -SiteCode "CM1" -Priority Increase

This command increases the priority of a filter rule that has the specified name in a site that has the site code CM1.

Parameters

-AllowDeleteAfterDays

Type:Int32
Aliases:AllowUserDeleteMessagesAfterThresholdDays
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComponentName

Specifies the Configuration Manager component that corresponds to the status messages.

Type:String
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

-ForwardToStatusSummarizer

Indicates whether to forward to the status summarizer.

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

-MessageId

Specifies a message ID in Configuration Manager.

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

-MessageType

Specifies a status message type in Configuration Manager.

Valid values are:

  • Audit
  • Detail
  • Milestone
  • None
Type:MessageType
Accepted values:None, Milestone, Detail, Audit
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies an array of names for status filter rules.

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

-Priority

Specifies a change in priority. Configuration Manager checks status messages against rules in order of rule priority. Valid values are: Decrease and Increase.

Type:PriorityChangeType
Accepted values:Increase, Decrease
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProcessLowerPriorityRule

Indicates whether to process a lower priority rule, which prevents further rule processing.

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

-ProgramPath

Specifies a path to a program that runs when a status message matches the status filter rule.

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

-PropertyId

Specifies a property ID in Configuration Manager.

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

-PropertyValue

Specifies a value for the corresponding PropertyId parameter.

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

-ReplicateToParentSite

Indicates whether to pass a message to the parent site.

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

-ReplicationPriority

Specifies a replication priority for sending status messages to the parent site.

Valid values are:

  • High
  • Low
  • Medium
Type:ReplicationPriority
Accepted values:High, Medium, Low
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReportToEventLog

Indicates whether to report an event in the Windows event log.

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

-RunProgram

Indicates whether to run a program when a status message matches a filter rule.

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

-SeverityType

Specifies the severity of a status message.

Valid values are:

  • Error
  • Informational
  • None
  • Warning
Type:SeverityType
Accepted values:None, Informational, Warning, Error
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SiteCode

Specifies the site code for a Configuration Manager site.

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

-SiteSystemServerName

Specifies the name of a site system server in Configuration Manager.

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

-Source

Specifies the status message source to match. The possible sources are the following:

  • Client
  • SMS Provider
  • Site Server
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StatusFilterRuleSiteCode

Specifies a site code for the site from which the status message originated.

Type:String
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

-WriteToDatabase

Indicates whether to write a message to the database. Specify a value of $True for this parameter to enable the AllowUserDeleteMessagesAfterThresholdDays parameter.

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

Inputs

None