Export-CauReport
Exports one or more Updating Run reports into an HTML or CSV-formatted document.
Syntax
Export-CauReport
[-InputReport] <CauReport[]>
[-Format] <OutputType>
[-Path] <String>
[-PassThru]
[-Force]
[-TimeZone <TimeZoneInfo>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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: Get a detailed version of the last CAU report for the specified cluster
$CauReport = Get-CauReport -ClusterName "Contoso-FC1" -Last -Detailed
$CauReport | Export-CauReport -Format HTML -Path "C:\temp\contoso-fc1_last.html" -TimeZone ([system.timezoneinfo]::Utc)This command 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 |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| 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 |
| Accepted values: | Csv, Html |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputReport
Specifies an array of CAU report objects, such as generated from a call to Get-CauReport with the Detailed parameter.
| Type: | CauReport[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet doesn't generate any output.
| 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: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeZone
Specifies the 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 isn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ClusterAwareUpdating.CauReport
Outputs
Microsoft.ClusterAwareUpdating.CauReport