Get-BEReport Help

Synopsis

Gets Backup Exec reports.

Syntax

Get-BEReport [[-Name] [<String[]>]] [-Category {Alerts | Archive | Configuration | Jobs | Media | Devices | Custom}] [<CommonParameters>]

Get-BEReport [-Id] [<Guid[]>] [<CommonParameters>]

Get-BEReport -InputObject [<BEReport[]>] [<CommonParameters>]

Description

Gets Backup Exec reports.

Without parameters, Get-BEReport gets all of the Backup Exec reports. You can also specify a particular report by report name or report ID (Guid) or pass a Backup Exec report object through the pipeline to Get-BEReport.

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

Parameters

-Category

Specifies one or more category values to filter the reports. To specify multiple values, use commas to separate the values.

The valid values are:
Alerts
Archive
Configuration
Jobs
Media
Devices
Custom

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

-Name <String[]>

Specifies one or more reports by report name (wildcards accepted). To specify multiple names, use commas to separate the names.

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

-Id <Guid[]>

Specifies one or more reports by report ID (Guid). To specify multiple IDs, use commas to separate the IDs.

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

-InputObject <BEReport[]>

Specifies one or more report objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.

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

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

Input Types

System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec report object to Get-BEReport.

BackupExec.Management.CLI.BEReport

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

Return Value

BackupExec.Management.CLI.BEReport

Get-BEReport returns objects that represent Backup Exec reports.

Examples

Example 1

C:\PS> Get-BEReport

This command gets all of the Backup Exec report objects.

Example 2

C:\PS> Get-BEReport -Name "Audit Log"

This command gets the Backup Exec report object named "Audit Log".

Example 3

C:\PS> Get-BEReport -Name "Media*"

This command gets all of the Backup Exec report objects that match the wildcard "Media*".

Example 4

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.