Get-CauReport

Get-CauReport

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

Syntax

Parameter Set: AllParamsSet
Get-CauReport [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-Detailed] [ <CommonParameters>]

Parameter Set: LastParamSet
Get-CauReport [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-Detailed] [-Last] [ <CommonParameters>]

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

Parameter Set: SpecificReportParamSet
Get-CauReport [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-Report <CauReportSummary> ] [ <CommonParameters>]

Detailed Description

The Get-CauReport cmdlet retrieves 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 for which to return the detailed results.

Parameters

-ClusterName<String>

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

-Credential<PSCredential>

Specifies the administrative credentials for the target cluster.

-Detailed

Specifies that the full results for one or more runs will be returned, instead of just summary information.

-EndDate<DateTime>

Retrieves only the reports for Runs before this time.

-Last

Retrieves only the most recent Run report.

-Report<CauReportSummary>

Retrieves detailed results for the Run represented by the specified report summary.

-StartDate<DateTime>

Retrieves only the reports from Runs on or after this time.

<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.

• Microsoft.ClusterAwareUpdating.CauReportSummary

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.ClusterAwareUpdating.CauReport
• Microsoft.ClusterAwareUpdating.CauReportSummary

Examples

EXAMPLE 1

This example returns a detailed list of the Updating Runs performed on the cluster called Contoso-FC1 on 01/01/2012 or later.

PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed

EXAMPLE 2

This example returns 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.

PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed

EXAMPLE 3

This example uses a CAU report summary object called $CauReportSummary to return a detailed report of the last Updating Run performed on the cluster called Contoso-FC1.

PS C:\> $CauReportSummary=Get-CauReport Contoso-FC1 -Last
Get-CauReport Contoso-FC1 -Report $CauReportSummary

Related topics

Export-CauReport