Get-BEActiveJobDetail Help

Synopsis

Gets active job details in Backup Exec.

Syntax

Get-BEActiveJobDetail [[-Name] [<String[]>]] [<CommonParameters>]

Get-BEActiveJobDetail -Job [<BEJob[]>] [[-Name] [<String[]>]] [<CommonParameters>]

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

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

Description

Gets active job details in Backup Exec.

Without parameters, Get-BEActiveJobDetail gets all of the Backup Exec active job details. You can also specify an active job detail by active job detail name or active job detail ID (Guid) or pass a Backup Exec active job status object through the pipeline to Get-BEActiveJobDetail.

Parameters

-Job <BEJob[]>

Specifies one or more job objects to filter the active job details. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEJob.

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

-Name <String[]>

Specifies one or more active job details by active job detail 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 active job details by active job detail 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 <BEActiveJobDetail[]>

Specifies one or more active job detail 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

BackupExec.Management.CLI.BEJob

You can pipe a Backup Exec job object to filter active job details returned by Get-BEActiveJobDetail.

System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec active job detail object to Get-BEActiveJobDetail.

BackupExec.Management.CLI.BEActiveJobDetail

You can pipe a Backup Exec active job detail object to Get-BEActiveJobDetail.

Return Value

BackupExec.Management.CLI.BEActiveJobDetail

Get-BEActiveJobDetail returns objects that represent Backup Exec active job details.

Examples

Example 1

C:\PS> Get-BEActiveJobDetail

This command gets all of the Backup Exec active job detail objects.

Example 2

C:\PS> Get-BEJob "Backup Job 0001" | Get-BEActiveJobDetail

These commands get the active job detail for a job named "Backup Job 0001".