This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRComputerBackupJob

Short Description

Returns Veeam Agent backup jobs and Veeam Agent backup policies.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Get-VBRComputerBackupJob [-Name <string[]>] [-Mode <VBRComputerBackupJobMode> {ManagedByAgent | ManagedByBackupServer}]  [<CommonParameters>]

Detailed Description

This cmdlet returns an array of Veeam Agent backup jobs and Veeam Agent backup policies.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies a name of a Veeam Agent backup job or a Veeam Agent backup policy.

String[]

False

Named

False

Mode

Specifies the Veeam Agent backup job mode. You can specify either of the following backup job modes:

  • ManagedByAgent: use this option to get the backup policy.
  • ManagedByBackupServer: use this option to get a Veeam Agent backup job.

VBRComputerBackupJobMode

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

This cmdlet returns the VBRComputerBackupJob[] object that contains settings of Veeam Agent backup jobs and Veeam Agent backup policies.

Examples

Example 1. Getting all Veeam Agent Backup Jobs

This command returns an array of all Veeam Agent backup jobs and Veeam Agent backup policies that are added to Veeam Backup & Replication.

Get-VBRComputerBackupJob

Example 2. Getting Veeam Agent Backup Job by Name

This command returns the Agent Job 05 Veeam Agent backup job.

Get-VBRComputerBackupJob -Name "Agent Job 05"

Example 3. Getting Veeam Agent Backup Policy

This command returns an array of Veeam Agent backup policies.

Get-VBRComputerBackupJob -Mode ManagedByAgent