Get-BEJobHistory Help

Synopsis

Gets job histories in Backup Exec.

Syntax

Get-BEJobHistory [[-Name] [<String[]>]] [-JobStatus {Unknown | Canceled | Completed | SucceededWithExceptions | OnHold | Error | Missed | Recovered | Resumed | Succeeded | ThresholdAbort | Dispatched | DispatchFailed | InvalidSchedule | InvalidTimeWindow | NotInTimeWindow | Queued | Disabled | Active | Ready | Scheduled | Superseded | ToBeScheduled | Linked | RuleBlocked}] [-JobType {Unknown | Backup | Restore | Verify | Catalog | Utility | Report | Duplicate | TestRun | ResourceDiscovery | CopyJob | Archive | RestoreFromArchive | DeleteFromArchive | Install | ConvertToVirtual}] [-FromLastJobRun [<SwitchParameter>]] [-FromStartTime [<DateTime>]] [-ToStartTime [<DateTime>]] [<CommonParameters>]

Get-BEJobHistory -Job [<BEJob[]>] [[-Name] [<String[]>]] [-JobStatus {Unknown | Canceled | Completed | SucceededWithExceptions | OnHold | Error | Missed | Recovered | Resumed | Succeeded | ThresholdAbort | Dispatched | DispatchFailed | InvalidSchedule | InvalidTimeWindow | NotInTimeWindow | Queued | Disabled | Active | Ready | Scheduled | Superseded | ToBeScheduled | Linked | RuleBlocked}] [-JobType {Unknown | Backup | Restore | Verify | Catalog | Utility | Report | Duplicate | TestRun | ResourceDiscovery | CopyJob | Archive | RestoreFromArchive | DeleteFromArchive | Install | ConvertToVirtual}] [-FromLastJobRun [<SwitchParameter>]] [-FromStartTime [<DateTime>]] [-ToStartTime [<DateTime>]] [<CommonParameters>]

Get-BEJobHistory -Storage [<BEStorage[]>] [[-Name] [<String[]>]] [-JobStatus {Unknown | Canceled | Completed | SucceededWithExceptions | OnHold | Error | Missed | Recovered | Resumed | Succeeded | ThresholdAbort | Dispatched | DispatchFailed | InvalidSchedule | InvalidTimeWindow | NotInTimeWindow | Queued | Disabled | Active | Ready | Scheduled | Superseded | ToBeScheduled | Linked | RuleBlocked}] [-JobType {Unknown | Backup | Restore | Verify | Catalog | Utility | Report | Duplicate | TestRun | ResourceDiscovery | CopyJob | Archive | RestoreFromArchive | DeleteFromArchive | Install | ConvertToVirtual}] [-FromLastJobRun [<SwitchParameter>]] [-FromStartTime [<DateTime>]] [-ToStartTime [<DateTime>]] [<CommonParameters>]

Get-BEJobHistory -AgentServer [<BEAgentServer[]>] [[-Name] [<String[]>]] [-JobStatus {Unknown | Canceled | Completed | SucceededWithExceptions | OnHold | Error | Missed | Recovered | Resumed | Succeeded | ThresholdAbort | Dispatched | DispatchFailed | InvalidSchedule | InvalidTimeWindow | NotInTimeWindow | Queued | Disabled | Active | Ready | Scheduled | Superseded | ToBeScheduled | Linked | RuleBlocked}] [-JobType {Unknown | Backup | Restore | Verify | Catalog | Utility | Report | Duplicate | TestRun | ResourceDiscovery | CopyJob | Archive | RestoreFromArchive | DeleteFromArchive | Install | ConvertToVirtual}] [-FromLastJobRun [<SwitchParameter>]] [-FromStartTime [<DateTime>]] [-ToStartTime [<DateTime>]] [<CommonParameters>]

Get-BEJobHistory [-Id] [<Guid[]>] [-FromLastJobRun [<SwitchParameter>]] [-ToStartTime [<DateTime>]] [-FromStartTime [<DateTime>]] [<CommonParameters>]

Get-BEJobHistory -InputObject [<BEJobHistory[]>] [-FromLastJobRun [<SwitchParameter>]] [-ToStartTime [<DateTime>]] [-FromStartTime [<DateTime>]] [<CommonParameters>]

Description

Gets job histories in Backup Exec.

Without parameters, Get-BEJobHistory gets all of the Backup Exec job histories. You can also specify a job history by job history name or job history ID (Guid) or pass a Backup Exec job history object through the pipeline to Get-BEJobHistory.

Parameters

-FromStartTime <DateTime>

Specifies a DateTime object to filter job histories with a start time that is after the specified DateTime.

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

-ToStartTime <DateTime>

Specifies a DateTime object to filter job histories with a start time that is before the specified DateTime.

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

-FromLastJobRun <SwitchParameter>

Returns the job histories from the most recent run of a job.

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

-Job <BEJob[]>

Specifies one or more job objects to filter the job histories. 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

-Storage <BEStorage[]>

Specifies one or more storage objects to filter the job histories. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEStorage.

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

-AgentServer <BEAgentServer[]>

Specifies one or more agent server objects to filter the job histories. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEAgentServer.

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

-Name <String[]>

Specifies one or more job histories by job history 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

-JobStatus

Specifies one or more job status objects to filter the job histories. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEJobStatus.

The valid values are:
Unknown
Canceled
Completed
SucceededWithExceptions
OnHold
Error
Missed
Recovered
Resumed
Succeeded
ThresholdAbort
Dispatched
DispatchFailed
InvalidSchedule
InvalidTimeWindow
NotInTimeWindow
Queued
Disabled
Active
Ready
Scheduled
Superseded
ToBeScheduled
Linked
RuleBlocked

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

-JobType

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

The valid values are:
Unknown
Backup
Restore
Verify
Catalog
Utility
Report
Duplicate
TestRun
ResourceDiscovery
CopyJob
Archive
RestoreFromArchive
DeleteFromArchive
Install
ConvertToVirtual

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

-Id <Guid[]>

Specifies one or more job histories by job history 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 <BEJobHistory[]>

Specifies one or more job history 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 job histories returned by Get-BEJobHistory.

BackupExec.Management.CLI.BEAgentServer

You can pipe a Backup Exec agent server object to filter job histories returned by Get-BEJobHistory.

System.Guid

You can pipe a System.Guid that contains the ID of a Backup Exec job history object to Get-BEJobHistory.

BackupExec.Management.CLI.BEJobHistory

You can pipe a Backup Exec job history object to Get-BEJobHistory.

Return Value

BackupExec.Management.CLI.BEJobHistory

Get-BEJobHistory returns objects that represent Backup Exec job histories.

Examples

Example 1

C:\PS> Get-BEJobHistory

This command gets all of the Backup Exec job histories.

Example 2

C:\PS> Get-BEJob "Job 01" | Get-BEJobHistory

These commands get all of the Backup Exec job histories for the Backup Exec job named "Job 01".

Example 3

C:\PS> Get-BEAgentServer -Local | Get-BEJobHistory

These commands get all of the Backup Exec job histories for the local computer.