Clear-CMComponentStatusMessage
Applies To: System Center 2012 Configuration Manager SP1
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Clear-CMComponentStatusMessage
Removes component status messages from Configuration Manager.
Syntax
Parameter Set: SearchByName
Clear-CMComponentStatusMessage -Severity <Severity> [-ComponentName <String> ] [-MachineName <String> ] [-SiteCode <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Clear-CMComponentStatusMessage cmdlet removes specified component status messages.
Microsoft System Center 2012 Configuration Manager indicates whether operations succeed or fail and include other information in component status messages. Threads or processes send component status messages to System Center 2012 Configuration Manager sites, identified by site codes.
You can define which messages to remove by the severity of the message, the component that created the message, the computer that hosts that component, or the System Center 2012 Configuration Manager site that receives the message.
Parameters
-ComponentName<String>
Specifies an array of names of threads or processes. A thread or process sends a component status message.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MachineName<String>
Specifies an array of names of computers. A computer hosts a component that sends a status message.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Severity<Severity>
Classifies status messages. The acceptable values of this parameter are:
-- ALL
-- Error
-- Information
-- Warning
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteCode<String>
Specifies a site code for a Configuration Manager site. A system sends a status message to this site.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
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.
Examples
Example 1: Clear all specified messages
This command removes all the status messages for the component named SMS_HIERARCHY_MANAGER on the computer Host21.Western.Contoso.com for the site that has the site code CM1.
PS C:\> Clear-CMComponentStatusMessage -Severity ALL -ComponentName "SMS_HIERARCHY_MANAGER" -MachineName "Host21.Western.Contoso.com" -SiteCode "CM1"
Example 2: Clear specified error messages
This command removes error status messages for the component named SMS_DISTRIBUTION_MANAGER on the computer Host21.Western.Contoso.com for the site that has the site code CM1.
PS C:\> Clear-CMComponentStatusMessage -Severity Error -ComponentName "SMS_DISTRIBUTION_MANAGER" -MachineName "Host21.Western.Contoso.com" -SiteCode "CM1"