Set-CMStatusFilterRule

Set-CMStatusFilterRule

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

Syntax

Parameter Set: SetStatusFilterRulePriority
Set-CMStatusFilterRule -Name <String> -Priority <PriorityChangeType> {Decrease | Increase} -SiteCode <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetStatusFilterRuleProperty
Set-CMStatusFilterRule -Name <String> -SiteCode <String> [-AllowUserDeleteMessagesAfterThresholdDays <Int32> ] [-ComponentName <String> ] [-ForwardToStatusSummarizer <Boolean> ] [-MessageId <String> ] [-MessageType <MessageType> {Audit | Detail | Milestone | None} ] [-ProcessLowerPriorityRule <Boolean> ] [-ProgramPath <String> ] [-PropertyId <String> ] [-PropertyValue <String> ] [-ReplicateToParentSite <Boolean> ] [-ReplicationPriority <ReplicationPriority> {High | Low | Medium} ] [-ReportToEventLog <Boolean> ] [-RunProgram <Boolean> ] [-SeverityType <SeverityType> {Error | Informational | None | Warning} ] [-SiteSystemServerName <String> ] [-Source <String> ] [-StatusFilterRuleSiteCode <String> ] [-WriteToDatabase <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CMStatusFilterRule cmdlet modifies settings for a Microsoft System Center 2012 SP1 Configuration Manager filter rule for status messages. System Center 2012 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 System Center 2012 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.

Parameters

-AllowUserDeleteMessagesAfterThresholdDays<Int32>

Specifies how long, in days, to retain messages. Specify a value of $True for the WriteToDatabase parameter to specify a value for this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ComponentName<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForwardToStatusSummarizer<Boolean>

Indicates whether to forward to the status summarizer.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MessageId<String>

Specifies a message ID in Configuration Manager.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MessageType<MessageType>

Specifies a status message type in Configuration Manager. The acceptable values for this parameter are:

-- Audit
-- Detail
-- Milestone
-- None

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies an array of names for status filter rules.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Priority<PriorityChangeType>

Specifies a change in priority. Configuration Manager checks status messages against rules in order of rule priority. The acceptable values for this parameter are: Decrease and Increase.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ProcessLowerPriorityRule<Boolean>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ProgramPath<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PropertyId<String>

Specifies a property ID in Configuration Manager.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PropertyValue<String>

Specifies a value for the corresponding PropertyId parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReplicateToParentSite<Boolean>

Indicates whether to pass a message to the parent site.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReplicationPriority<ReplicationPriority>

Specifies a replication priority for sending status messages to the parent site. The acceptable values for this parameter are: High, Low, and Medium.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ReportToEventLog<Boolean>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RunProgram<Boolean>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SeverityType<SeverityType>

Specifies the severity of a status message. The acceptable values for this parameter are:

-- Error
-- Informational
-- None
-- Warning

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SiteCode<String>

Specifies the site code for a Configuration Manager site.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SiteSystemServerName<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Source<String>

Specifies the status message source to match. The acceptable values for this parameter are:

-- Client
-- SMS Provider
-- Site Server

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StatusFilterRuleSiteCode<String>

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-WriteToDatabase<Boolean>

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

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: Increase the priority of a rule

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

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

Disable-CMStatusFilterRule

Enable-CMStatusFilterRule

Get-CMStatusFilterRule

New-CMStatusFilterRule

Remove-CMStatusFilterRule