Get-CauReport

Get-CauReport

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

Parameters

-ClusterName<String>

Specifies the name of the cluster for which this cmdlet gets 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.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the administrative credentials for the target cluster.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Detailed

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EndDate<DateTime>

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


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Last

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Report<CauReportSummary>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StartDate<DateTime>

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


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

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: Get a detailed list of updating runs from the specified cluster

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


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

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

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.


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

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

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.


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

Related topics

Community Additions

ADD
Show: