Build-Report

SYNOPSIS

Builds a migration report.

SYNTAX

Build-Report [-Customer] <String> [-Source] <String> [-Target] <String> [-Mode] <String>
 [[-LogFolder] <String>] [[-MigrationReport] <String>] [[-LimitBy] <String>] [-TotalsOnly] [[-Format] <String>]
 [<CommonParameters>]

DESCRIPTION

Use the Build-Report cmdlet to generate various reports from a set of logs.

EXAMPLES

Example 1: Rclone errors

Build-Report -Mode RcloneErrors -LogFolder 'C:\Temp\logs' -Format Csv

Generates a report of Rclone errors from the logs in C:\Temp\logs and outputs as CSV.

Example 2: Rclone unique errors

Build-Report -Mode RcloneErrorsUnique -LogFolder 'C:\Temp\logs' -Format Csv

Generates a report of unique Rclone errors from the logs in C:\Temp\logs and outputs as CSV.

Example 3: Rclone job performance

Build-Report -Mode RclonePerformanceByJob -LogFolder 'C:\Temp\logs' -Format Csv

Generates a report of Rclone job performance from the logs in C:\Temp\logs and outputs as CSV.

Example 4: Rclone migration performance

Build-Report -Mode RclonePerformanceByMigration -LogFolder 'C:\Temp\logs' -Format Csv

Generates a report of Rclone migration performance from the logs in C:\Temp\logs and outputs as CSV.

Example 5: TMC errors

Build-Report -Mode TmcErrors -LogFolder 'C:\Temp\job_logs' -Format Csv

Generates a report of TMC errors from the logs in C:\Temp\job_logs and outputs as CSV.

Example 6: TMC unique errors

Build-Report -Mode TmcErrorsUnique -LogFolder 'C:\Temp\job_logs' -Format Csv

Generates a report of unique TMC errors from the logs in C:\Temp\job_logs and outputs as CSV.

Example 7: TMC job performance

Build-Report -Mode 'TmcPerformanceByJob' -Format Csv

Generates a report of TMC job performance from Migration Report for Project.csv and outputs as CSV.

Example 8: TMC migration performance

Build-Report -Mode 'TmcPerformanceByMigration' -Format Csv

Generates a report of TMC migration performance from Migration Report for Project.csv and outputs as CSV.

Example 9: TMC user items (by job)

Build-Report -Mode 'TmcItemsByUser'

Generates a report of items migrated by user from Migration Report for Project.csv and outputs as text. Note that the report contains per-job item totals.

Example 10: TMC user items (cumulative)

Build-Report -Mode 'TmcItemsByUser' -TotalsOnly

Generates a report of items migrated by user from Migration Report for Project.csv and outputs as text. Note that the report contains cumulative totals across all jobs.

PARAMETERS

-Customer

The name of the customer for which the report is being generated. Use quotes around names that contain spaces. For example, 'Sample Customer'.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Format

Specifies the output format for report data.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Csv, Json, Objects, Text

Required: False
Position: 7
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False

-LimitBy

Specifies the data by which the report set will be limited when General.MaxReports is set in config.psd1. For example, if General.MaxReports is set to 10, using -LimitBy DurationMinutes will only output the 10 longest-running jobs or migrations.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Jobs, DurationMinutes, TransferredGb, TransferredObjects, TransfersAttempted, TransfersCompleted

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LogFolder

The path to a folder containing job logs.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MigrationReport

The name of a migration export exported from TMC. If not specified, this defaults to Migration Report for Project.csv.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mode

Determines the type of report to build.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: RcloneErrors, RcloneErrorsUnique, RcloneWarnings, RcloneWarningsUnique, RclonePerformanceByJob, RclonePerformanceByMigration, TmcErrors, TmcErrorsUnique, TmcWarnings, TmcWarningsUnique, TmcItemsByUser, TmcPerformanceByJob, TmcPerformanceByMigration

Required: True
Position: 3
Default value: ErrorsAndWarnings
Accept pipeline input: False
Accept wildcard characters: False

-Source

Specifies the source platform for the report data.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Amazon WorkMail, Domino, Exchange, GoDaddy 365, Google Consumer, Google Workspace, GroupWise, IMAP, Kerio, Microsoft 365, NSF, PST, Zimbra

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

Specifies the target platform for the report data.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Amazon WorkMail, GoDaddy 365, Google Consumer, Google Workspace, IMAP, Microsoft 365

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

-TotalsOnly

Indicates that when running in TmcItemsByUser mode and with Text format, only cumulative totals should be reported.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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

None

OUTPUTS

System.Object[]

NOTES

RELATED LINKS

TMCTools configuration options