Edit

Share via


Get-CMSiteStatusMessage

Gets site system status messages.

Syntax

Default (Default)

Get-CMSiteStatusMessage
    [-Component <String[]>]
    [-ComputerName <String[]>]
    [-FilterHashtable <Hashtable>]
    [-MessageId <Int32[]>]
    [-Module <String[]>]
    [-PassThru]
    [-Severity <Severity[]>]
    [-SiteCode <String[]>]
    [-StartDateTime <DateTime>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

Description

The Get-CMSiteStatusMessage cmdlet gets status messages for one or more Configuration Manager site system components. A status message is a message that a Configuration Manager component generates that contains information about the success, failure, or operation of site system components. Configuration Manager stores status messages in a Configuration Manager site database. You can view status messages in the Status Message Viewer.

Note

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

Examples

Example 1: Get site status messages

PS XYZ:\> Get-CMSiteStatusMessage -ViewingPeriod "2012/09/03 02:16:10.000" -ComputerName "cmcen-dist02" -Severity Error -SiteCode "CM2"

This command gets the site status messages that Configuration Manager receives on or after September 3, 2012 and that have an error severity. Configuration Manager gets the status messages from the Configuration Manager site that has the site code CM2 on the computer named cmcen-dist02.tsqa.contoso.com.

Parameters

-Component

The Get-CMSiteStatusMessage cmdlet gets status messages for one or more Configuration Manager site system components. A status message is a message that a Configuration Manager component generates that contains information about the success, failure, or operation of site system components. Configuration Manager stores status messages in a Configuration Manager site database. You can view status messages in the Status Message Viewer.

Note

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:True
DontShow:False
Aliases:ComponentName, Components, ComponentNames

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

Specifies the fully qualified ___domain name (FQDN) of the server that hosts the site system role.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:True
DontShow:False
Aliases:ComputerNames

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FilterHashtable

The Get-CMSiteStatusMessage cmdlet gets status messages for one or more Configuration Manager site system components. A status message is a message that a Configuration Manager component generates that contains information about the success, failure, or operation of site system components. Configuration Manager stores status messages in a Configuration Manager site database. You can view status messages in the Status Message Viewer.

Note

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

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MessageId

The Get-CMSiteStatusMessage cmdlet gets status messages for one or more Configuration Manager site system components. A status message is a message that a Configuration Manager component generates that contains information about the success, failure, or operation of site system components. Configuration Manager stores status messages in a Configuration Manager site database. You can view status messages in the Status Message Viewer.

Note

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

Parameter properties

Type:

Int32[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:MessageIds

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Module

The Get-CMSiteStatusMessage cmdlet gets status messages for one or more Configuration Manager site system components. A status message is a message that a Configuration Manager component generates that contains information about the success, failure, or operation of site system components. Configuration Manager stores status messages in a Configuration Manager site database. You can view status messages in the Status Message Viewer.

Note

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:True
DontShow:False
Aliases:ModuleName, Modules, ModuleNames

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Severity

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

  • All
  • Error
  • Information
  • Warning

Parameter properties

Type:

Severity[]

Default value:None
Accepted values:All, Error, Information, Warning
Supports wildcards:False
DontShow:False
Aliases:Severities

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SiteCode

Specifies the site code of the Configuration Manager site that hosts the site system role.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SiteCodes

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartDateTime

The Get-CMSiteStatusMessage cmdlet gets status messages for one or more Configuration Manager site system components. A status message is a message that a Configuration Manager component generates that contains information about the success, failure, or operation of site system components. Configuration Manager stores status messages in a Configuration Manager site database. You can view status messages in the Status Message Viewer.

Note

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

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ViewingPeriod

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

IResultObject

IResultObject