New-CMStatusFilterRule
New-CMStatusFilterRule
Creates a rule in Configuration Manager.
Syntax
Parameter Set: Default
New-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 New-CMStatusFilterRule cmdlet creates a rule that triggers one or more actions that alerts an administrator to a specific message in Microsoft System Center 2012 SP1 Configuration Manager.
Parameters
-AllowUserDeleteMessagesAfterThresholdDays<Int32>
Specifies how long, in days, to retain messages. Set the WriteToDatabase parameter to enable this setting.
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 a name for the status filter rule.
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 a System Center 2012 Configuration Manager site code that defines the status rule.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteSystemServerName<String>
Specifies a name of the site system server.
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.
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 status filter rule.
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. Must be set 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: Create a status filter rule
This command creates a status filter rule.
PS C:\> New-CMStatusFilterRule -SiteCode "Contoso2" -Name "11211" -TargetSiteCode "Contoso2" -Source "SMS Provider" -System "Contoso-test" -Component "1111" -MessageType Milestone -SeverityType Informational -MessageId "1234" -PropertyName "403" -PropertyValue "123" -WriteToDatabase $True -AllowDeleteMessagesTimeDays 20 -ReportToEventLog $False -ReplicateToParentSite $False -RunProgram $False -ForwardToStatusSummarizers $True -ProcessLowerPriorityRules $True