Invoke-BEReport Help

Synopsis

Runs a Backup Exec report.

Syntax

Invoke-BEReport -Report [<BEReport>] [-Path] [<String>] [[-Format] {Html | Pdf | Csv | Xml | Xls}] [-AuditLogCategory {Alert | AuditLog | DeviceAndMedia | EncryptionKey | ErrorHandlingRules | Job | LogonAccount | ServerConfiguration}] [-AgentServer [<BEAgentServer[]>]] [-MediaVault [<BEMediaVault[]>]] [-MediaSet [<BEMediaSet[]>]] [-DaysBefore [<Int32>]] [-BackupExecServer [<BEBackupExecServer[]>]] [-DaysAfter [<Int32>]] [-MaximumEventCount [<Int32>]] [-WithinHour [<Int32>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Runs a Backup Exec report.

Reports are run by passing the results of Get-BEReport to Invoke-BEReport.

To get the filter parameters that apply to a report, use the ValidFilters property of the objects returned by Get-BEReport.

Parameters

-Report <BEReport>

Specifies the report to run.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-Path <String>

Specifies the path for the file where the report output is written.

Required	true
Position	0
Accepts pipeline input	false
Accepts wildcard characters	false

-Format

Specifies the report output format.

The valid values are:
Html
Pdf
Csv
Xml
Xls

Required	false
Position	1
Accepts pipeline input	false
Accepts wildcard characters	false

-DaysBefore <Int32>

Specifies the number of days prior to the current day to begin the filter process on the data to be included in the report.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-DaysAfter <Int32>

Specifies the number of days after the current day to begin the filter process on the data to be included in the report.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-WithinHour <Int32>

Specifies the number of hours either before or after the present hour to filter the data to be included in the report.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-MaximumEventCount <Int32>

Specifies the number of events to include in the report.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-BackupExecServer <BEBackupExecServer[]>

Filters the report based on Backup Exec servers. See Get-BEBackupExecServer.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-AgentServer <BEAgentServer[]>

Filters the report based on specific backed up servers. See Get-BEAgentServer.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-AuditLogCategory

Filters the report based on audit log categories.

The valid values are:
Alert
AuditLog
DeviceAndMedia
EncryptionKey
ErrorHandlingRules
Job
LogonAccount
ServerConfiguration

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-MediaSet <BEMediaSet[]>

Filters the report based on media sets. See Get-BEMediaSet.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-MediaVault <BEMediaVault[]>

Filters the report based on media vaults. See Get-BEMediaVault.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

BackupExec.Management.CLI.BEReport

You can pipe a Backup Exec report object to Invoke-BEReport.

Return Value

System.IO.FileInfo

Invoke-BEReport returns the file object where the report results are written.

Example

C:\PS> Get-BEReport "Audit Log" | Invoke-BEReport -Path .\AuditLog.html | Invoke-Item

These commands run the report named "Audit Log" and displays the report in the default web browser.