Add-VBRBackupJob (obsolete)

Short Description

Creates a new backup job.

Important

This cmdlet is obsolete.

In Veeam Backup & Replication 6 this cmdlet was replaced by Add-VBRViBackupJob and Add-VBRHvBackupJob due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.

Syntax

Add-VBRBackupJob [-Name] <String> [[-Type] <String>] [-Server] <CHost> [-Folder] <String> [-FileName <String>]

-Objects <String[]> [-Description <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new backup job that processes the specified VMs on the specified host.
This cmdlet is obsolete — use the Add-VBRViBackupJobCreates VMware backup jobs. or Add-VBRHvBackupJobCreates Hyper-V backup jobs. cmdlet instead.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Description

Specifies the description of the backup job.

String

False

Named

False

FileName

Specifies the name of the backup file. By default, the backup file is given the same name as the job.

String

False

Named

False

Folder

Specifies the full path to the folder where the created backup files must be stored.

String

True

3

False

Name

Specifies the name you want to assign to the backup job.

String

True

0

False

Objects

Specifies an array of names of VMs that you want to add to the backup job.

String[]

True

Named

True (ByPropertyName, ByValue)

Server

Specifies the host where the VMs that you want to back up reside. Accepts the CHost object. To get this object, run the Get-VBRServerReturns hosts connected to the backup infrastructure. cmdlet.

CHost

True

2

False

Type

Specifies the type of the backup job.

String

False

1

False

<CommonParameters>

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

Examples

Creating a Backup Job

This example shows how to create a backup job.

$server = Get-VBRServer -Name "172.18.21.25"

Add-VBRBackupJob -Name "My Backup Job" -Server $server -Folder "D:\Backup" -Objects "VM01" -Description "Weekly backup job"

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Add-VBRBackupJob cmdlet.
    • Set the $server variable as the Server parameter value.
    • Specify the Name, Folder, Objects, and Description parameter values.

Page updated 2026-08-19

Page content applies to build 13.1.1.18