Edit

Share via


Set-CMStatusReportingComponent

Sets an object representing a status reporting component.

Syntax

SearchByValueMandatory (Default)

Set-CMStatusReportingComponent
    -InputObject <IResultObject>
    [-ClientLogChecked <Boolean>]
    [-ClientLogFailureChecked <Boolean>]
    [-ClientLogType <StatusReportOrLogType>]
    [-ClientReportChecked <Boolean>]
    [-ClientReportFailureChecked <Boolean>]
    [-ClientReportType <StatusReportOrLogType>]
    [-ServerLogChecked <Boolean>]
    [-ServerLogFailureChecked <Boolean>]
    [-ServerLogType <StatusReportOrLogType>]
    [-ServerReportChecked <Boolean>]
    [-ServerReportFailureChecked <Boolean>]
    [-ServerReportType <StatusReportOrLogType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory

Set-CMStatusReportingComponent
    -Name <String>
    [-ClientLogChecked <Boolean>]
    [-ClientLogFailureChecked <Boolean>]
    [-ClientLogType <StatusReportOrLogType>]
    [-ClientReportChecked <Boolean>]
    [-ClientReportFailureChecked <Boolean>]
    [-ClientReportType <StatusReportOrLogType>]
    [-ServerLogChecked <Boolean>]
    [-ServerLogFailureChecked <Boolean>]
    [-ServerLogType <StatusReportOrLogType>]
    [-ServerReportChecked <Boolean>]
    [-ServerReportFailureChecked <Boolean>]
    [-ServerReportType <StatusReportOrLogType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchBySiteCodeMandatory

Set-CMStatusReportingComponent
    [-ClientLogChecked <Boolean>]
    [-ClientLogFailureChecked <Boolean>]
    [-ClientLogType <StatusReportOrLogType>]
    [-ClientReportChecked <Boolean>]
    [-ClientReportFailureChecked <Boolean>]
    [-ClientReportType <StatusReportOrLogType>]
    [-ServerLogChecked <Boolean>]
    [-ServerLogFailureChecked <Boolean>]
    [-ServerLogType <StatusReportOrLogType>]
    [-ServerReportChecked <Boolean>]
    [-ServerReportFailureChecked <Boolean>]
    [-ServerReportType <StatusReportOrLogType>]
    [-SiteCode <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMStatusReportingComponent cmdlet sets an object that represents a status reporting component. A status reporting component object specifies information about the client configuration and server configuration components.

You can configure the reporting component to check log files and monitor the severity of entries in the log files.

Note

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

Examples

Example 1: Set status reporting component

This command sets a client report type and a server report type.

Set-CMStatusReportingComponent -SiteCode "CM1" -ClientReportType AllMilestones -ServerReportType AllMilestones

Parameters

-ClientLogChecked

Indicates whether a client log is checked.

Parameter properties

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

-ClientLogFailureChecked

Indicates whether a client log failure is checked.

Parameter properties

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

-ClientLogType

Specifies a type of client log.

Parameter properties

Type:StatusReportOrLogType
Default value:None
Accepted values:AllMilestonesAndAllDetails, AllMilestones, ErrorAndWarningMilestones, ErrorMilestones
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

-ClientReportChecked

Indicates whether a client report is checked.

Parameter properties

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

-ClientReportFailureChecked

Indicates whether a client failure is checked.

Parameter properties

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

-ClientReportType

Specifies a type of report.

Parameter properties

Type:StatusReportOrLogType
Default value:None
Accepted values:AllMilestonesAndAllDetails, AllMilestones, ErrorAndWarningMilestones, ErrorMilestones
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

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

-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

-InputObject

Specifies an object output from another cmdlet.

Parameter properties

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

Parameter sets

SearchByValueMandatory
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies a name for a status reporting component in Configuration Manager.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SiteName

Parameter sets

SearchByNameMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServerLogChecked

Indicates whether a server log is checked.

Parameter properties

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

-ServerLogFailureChecked

Indicates whether a server log failure is checked.

Parameter properties

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

-ServerLogType

Specifies a server log type.

Parameter properties

Type:StatusReportOrLogType
Default value:None
Accepted values:AllMilestonesAndAllDetails, AllMilestones, ErrorAndWarningMilestones, ErrorMilestones
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

-ServerReportChecked

Indicates whether a server report is checked.

Parameter properties

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

-ServerReportFailureChecked

Indicates whether a server report failure is checked.

Parameter properties

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

-ServerReportType

Specifies a report type.

Parameter properties

Type:StatusReportOrLogType
Default value:None
Accepted values:AllMilestonesAndAllDetails, AllMilestones, ErrorAndWarningMilestones, ErrorMilestones
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

-SiteCode

Specifies a site code for a Configuration Manager site.

Parameter properties

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

Parameter sets

SearchBySiteCodeMandatory
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject