Get-BEJob Help

Synopsis

Gets jobs in Backup Exec.

Syntax

Get-BEJob [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

Get-BEJob -Storage [<BEStorage[]>] [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

Get-BEJob -MediaSet [<BEMediaSet[]>] [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

Get-BEJob -MediaVault [<BEMediaVault[]>] [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

Get-BEJob -BackupDefinition [<BEBackupDefinition[]>] [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

Get-BEJob -AgentServer [<BEAgentServer[]>] [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

Get-BEJob -BackupExecServer [<BEBackupExecServer[]>] [[-Name] [<String[]>]] [-Status {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}] [-TaskType {None | OnetimeBackup | Full | IndependentFull | Incremental | Differential | Duplicate | ConvertToVirtual | ConvertBackupToVirtual | Archive | Verify | DelayedCatalog | ExportMediaToVault | TestRun}] [-IsActive [<Boolean>]] [-TaskName [<String[]>]] [<CommonParameters>]

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

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

Description

Gets jobs in Backup Exec.

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

Parameters

-Storage <BEStorage[]>

Specifies the storage device that you want to use for the backup job. See Get-BEStorage.

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

-MediaSet <BEMediaSet[]>

Specifies one or more media set objects to filter the jobs. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEMediaSet.

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

-MediaVault <BEMediaVault[]>

Specifies one or more media vault objects to filter the jobs. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEMediaVault.

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

-BackupDefinition <BEBackupDefinition[]>

Specifies one or more backup definition objects to filter the jobs. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEBackupDefinition.

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 jobs. 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

-BackupExecServer <BEBackupExecServer[]>

Specifies one or more Backup Exec server objects to filter the jobs. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BEBackupExecServer.

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

-Name <String[]>

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

-TaskName <String[]>

Specifies one or more task name values to filter the jobs. To specify multiple values, use commas to separate the values.

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

-IsActive <Boolean>

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

The valid values are:
$true
$false

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

-Status

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

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 jobs. 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

-TaskType

Specifies one or more task type objects to filter the jobs. Enter a variable that contains the objects, or type a command or expression that gets the objects. See Get-BETaskType.

The valid values are:
None
OnetimeBackup
Full
IndependentFull
Incremental
Differential
Duplicate
ConvertToVirtual
ConvertBackupToVirtual
Archive
Verify
DelayedCatalog
ExportMediaToVault
TestRun

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

-Id <Guid[]>

Specifies one or more jobs by job 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 <BEJob[]>

Specifies one or more job 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.BEStorage

You can pipe a Backup Exec storage object to filter jobs returned by Get-BEJob.

BackupExec.Management.CLI.BEMediaSet

You can pipe a Backup Exec media set object to filter jobs returned by Get-BEJob.

BackupExec.Management.CLI.BEMediaVault

You can pipe a Backup Exec media vault object to filter jobs returned by Get-BEJob.

BackupExec.Management.CLI.BEBackupDefinition

You can pipe a Backup Exec backup definition object to filter jobs returned by Get-BEJob.

BackupExec.Management.CLI.BEAgentServer

You can pipe a Backup Exec agent server object to filter jobs returned by Get-BEJob.

System.Guid

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

BackupExec.Management.CLI.BEJob

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

Return Value

BackupExec.Management.CLI.BEJob

Get-BEJob returns objects that represent Backup Exec jobs.

Examples

Example 1

C:\PS> Get-BEJob

This command gets all of the Backup Exec jobs.

Example 2

C:\PS> Get-BEJob -Name "Job 01"

This command gets the Backup Exec job named "Job 01".

Example 3

C:\PS> Get-BEJob -Name "Job*"

This command gets all of the Backup Exec jobs that match the wildcard "Job*".

Example 4

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

These commands wait for the Backup Exec job named "Job 01" to complete.

Example 5

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

These commands place the Backup Exec job named "Job 01" on hold.

Example 6

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

These commands resumes the Backup Exec job named "Job 01".

Example 7

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

These commands cancel the Backup Exec job named "Job 01".