Documentation home for Transend tools
Build-FolderReport
SYNOPSIS
Builds a TMC folder report.
SYNTAX
Build-FolderReport [-LogFolder] <String> [[-Mode] <String>] [[-Format] <String>] [<CommonParameters>]
DESCRIPTION
Use the Build-FolderReport cmdlet to generate folder count information from a
set of job logs.
EXAMPLES
Example 1
Build-FolderReport -LogFolder 'C:\Temp\job_logs' -Mode 'All'
Generates a folder report from the job logs in C:\Temp\job_logs. Because the
All mode is specified, all folders are included in the report.
Example 2
Build-FolderReport -LogFolder 'C:\Temp\job_logs' -Mode 'SuspectCounts'
Generates a folder report from the job logs in C:\Temp\job_logs. Because the
SuspectCounts mode is specified, only folders with suspicious message totals
are included in the report.
PARAMETERS
-Format
Specifies the output format for report data.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Csv, Json, Objects
Required: False
Position: 2
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False
-LogFolder
The path to a folder containing job logs.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Mode
Controls the output from Build-FolderReport. Supported values are All and
SuspectCounts.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: All, SuspectCounts
Required: False
Position: 1
Default value: All
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.