Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Export-CauReport

Export-CauReport

clusterawareupdating.dll

Synopsis

Exports one or more Updating Run reports into an HTML or CSV-formatted document.

Syntax

Export-CauReport [-InputReport] [-Format] [-Path] [-Force] [-PassThru] [-TimeZone] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Export-CauReport cmdlet exports one or more Updating Run reports into an HTML or CSV-formatted document. Each Run report summarizes both the node-level and cluster-level summary status for the Updating Run.

Pipe one or more reports from the Get-CauReport cmdlet with the Detailed parameter, and control the content in the report by specifying appropriate parameters for the Get-CauReport cmdlet. For example, the Last parameter specifies the most recent Updating Run.

Parameters

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Format <OutputType>

Specifies the format of the output report. The acceptable values for this parameter are:  CSV or HTML.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputReport <CauReport[]>

Specifies one or more CAU report objects, such as generated from a call to Get-CauReport with the Detailed parameter.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Passes the CAU report object back through the pipeline for further processing.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String>

Specifies the local or complete path of the file to save the exported report.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TimeZone <TimeZoneInfo>

Allows formatting of the report timestamps to match the specified time zone.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.ClusterAwareUpdating.CauReport

Return Type

Microsoft.ClusterAwareUpdating.CauReport

Notes

None

Examples

EXAMPLE 1

This example gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then exports that report in HTML format to the path C:\temp\contoso-fc1_last.html. The timestamps in the report are formatted in the Coordinated Universal Time (UTC) zone.

PS C:\> Get-CauReport -ClusterName Contoso-FC1 -Last -Detailed | Export-CauReport -Format HTML -Path C:\temp\contoso-fc1_last.html -TimeZone ([system.timezoneinfo]::Utc)

Online Version
Get-CauReport
Invoke-CauRun