Get-VBRJob

Short Description

Returns existing jobs.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

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

Detailed Description

This cmdlet returns jobs stored in Veeam Backup & Replication database.

With this cmdlet, you can get the following jobs:

  • Backup jobs
  • Replication jobs
  • Backup copy jobs
  • File copy jobs
  • VM Copy jobs
  • Object storage backup jobs

You can get the list of all jobs or look for instances directly by name.

Run the Get-VBRBackupSession or Get-VBRTaskSession cmdlets to get the information on job session or session tasks.

Run the Get-VBRTapeJob cmdlet to get tape jobs.

Run the Get-VBRSureBackupJob cmdlet to get SureBackup jobs.

Run the Get-VBREPJob cmdlet to get Veeam Agent for Microsoft Windows backup jobs.

Important

The Get-VBRJob cmdlet is deprecated for Veeam Agent jobs and policies. Run the Get-VBRComputerBackupJob cmdlet instead.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Name

Specifies the array of job names. The cmdlet will return jobs with these names.

String[]

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the CBackupJob object that contains backup jobs.

Examples

Getting List of Jobs by Name

This command gets the list of backup jobs whose names start with File.

Get-VBRJob -Name "File*"

Page updated 7/19/2024

Page content applies to build 12.2.0.334