Edit

Share via

Get-CauReport

Module:
ClusterAwareUpdating Module

Gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters.

Syntax

AllParamsSet (Default) 

Get-CauReport
    [[-ClusterName] <String>]
    [-Detailed]
    [-Credential <PSCredential>]
    [<CommonParameters>]

RangeParamSet 

Get-CauReport
    [[-ClusterName] <String>]
    [[-StartDate] <DateTime>]
    [[-EndDate] <DateTime>]
    [-Detailed]
    [-Credential <PSCredential>]
    [<CommonParameters>]

LastParamSet 

Get-CauReport
    [[-ClusterName] <String>]
    [-Last]
    [-Detailed]
    [-Credential <PSCredential>]
    [<CommonParameters>]

SpecificReportParamSet 

Get-CauReport
    [[-ClusterName] <String>]
    [-Report <CauReportSummary>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Description

The Get-CauReport cmdlet gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters. This cmdlet can return a list of all Updating Run reports between the specified StartDate and EndDate parameters, or if the Last parameter is specified instead of dates, then the cmdlet returns the most recent Updating Run report. By default, the report contains summaries only, but more detail can be obtained with the Detailed parameter or by using the Report parameter and specifying a Cluster-Aware Updating (CAU) report summary object.

Examples

Example 1: Get a detailed list of updating runs from the specified cluster

Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed

This command gets a detailed list of the updating runs performed on the cluster named Contoso-FC1 on 01/01/2012 or later.

Example 2: Get a detailed list of updating runs from a date span from the specified cluster

Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed

This command gets a detailed list of the updating runs performed on the cluster called Contoso-FC1 starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012.

Example 3: Get the last updating run summary from the specified cluster

$CauReportSummary = Get-CauReport "Contoso-FC1" -Last
Get-CauReport "Contoso-FC1" -Report $CauReportSummary

The first command gets the last updating run report summary from the cluster named Contoso-FC1 and stores the result in the variable named $CauReportSummary.

The second command gets the detailed report from the information stored in the $CauReportSummary variable.

Parameters

-ClusterName

Specifies the name of the cluster for which this cmdlet gets reports. This parameter is only required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.

Parameter properties

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

Parameter sets

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

-Credential

Specifies the administrative credentials for the target cluster.

Parameter properties

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

-Detailed

Specifies that cmdlet gets full results for one or more runs, instead of just summary information.

Parameter properties

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

Parameter sets

AllParamsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
RangeParamSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
LastParamSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EndDate

Specifies that this cmdlet gets only the reports for runs before this time.

Parameter properties

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

Parameter sets

RangeParamSet
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Last

Indicates that this cmdlet gets only the most recent run report.

Parameter properties

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

Parameter sets

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

-Report

Specifies the report summary that this cmdlet gets detailed results for the run.

Parameter properties

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

Parameter sets

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

-StartDate

Specifies that this cmdlet gets only the reports for runs after this time.

Parameter properties

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

Parameter sets

RangeParamSet
Position:1
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.ClusterAwareUpdating.CauReportSummary

Outputs

Microsoft.ClusterAwareUpdating.CauReport

Microsoft.ClusterAwareUpdating.CauReportSummary