Edit

Export-CauReport

  • Reference
Module:
ClusterAwareUpdating

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

Syntax

Export-CauReport
      [-InputReport] <CauReport[]>
      [-Format] <OutputType>
      [-Path] <String>
      [-Force]
      [-PassThru]
      [-TimeZone <TimeZoneInfo>]
      [-Confirm]
      [-WhatIf]

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.

Examples

EXAMPLE 1

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

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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Format

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

Type:OutputType
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputReport

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

Type:CauReport[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

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

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TimeZone

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

Type:TimeZoneInfo
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ClusterAwareUpdating.CauReport

Outputs

Microsoft.ClusterAwareUpdating.CauReport