Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBRViBackupCopyJob

Short Description

Creates a VMware backup copy job.

Applies to

Platform: VMware

For Hyper-V, run Add-VBRHvBackupCopyJob.

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides two parameter sets.

  • For data transfer with WAN accelerators:

Add-VBRViBackupCopyJob -SourceAccelerator <CWanAccelerator> -TargetAccelerator <CWanAccelerator> [-Name <string>][-Entity <IViItem[]>] [-Backup <CBackup[]>][-BackupJob <CBackupJob[]>] [-Repository <CBackupRepository>][-Description <string>][<CommonParameters>]

  • For direct data transfer:

Add-VBRViBackupCopyJob -DirectOperation [-Name <string>] [-Entity <IViItem[]>] [-Backup <CBackup[]>] [-BackupJob <CBackupJob[]>] [-Repository <CBackupRepository>] [-Description <string>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new VMware backup copy job.

To add the VMs for the backup copy job, you can add VMs, backups or backup jobs. Veeam will use this data to copy the backups of the needed VM.

You can transfer data in the following ways:

  • Using WAN accelerators. This mode is recommended for off-site backups.

To create and run a backup copy job using WAN accelerators you need to have source and target WAN accelerators created. Run Add-VBRWANAccelerator to create a WAN accelerator. WAN optimization is available only in Veeam Backup & Replication Enterprise Plus Edition.

  • Directly. With this method, the job sends the data directly to the target backup repository without performing data deduplication. This mode is recommended for on-site backups, or off-site backups using fast connections.

Use an appropriate parameter set for each way.

Note that the backup copy job is created in disabled state. Run Enable-VBRJob to start the job running on the defined schedule.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Source
Accelerator

Specifies the WAN accelerator on the source side.

Remember to set the pair of source and target WAN accelerators.

True

Named

False

False

Target
Accelerator

Specifies the WAN accelerator on the target side.

Remember to set the pair of source and target WAN accelerators.

True

Named

False

False

Direct
Operation

Indicates that the data will be sent directly to the target backup repository without performing data deduplication.

True

Named

False

False

Name

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

False

Named

False

False

Entity

Specifies the array of VMs you want to add to the backup copy job.

NOTE: You can create a job without source and link it to a backup job after.

False

Named

True (ByValue,
ByProperty
Name)

False

Backup

Specifies the array of backup. The cmdlet will add VMs from these backups to the backup copy job.

False

Named

False

False

BackupJob

Specifies the array of backup jobs. The cmdlet will add VMs processed by these jobs to the backup copy job.

False

Named

False

False

Repository

Specifies the backup repository to where you want to copy the VM data.

Default: default backup repository.

False

Named

False

False

Description

Specifies the description of the backup copy job.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command creates a backup copy job that will use WAN accelerators:

  • The source and target WAN accelerators are obtained with Get-VBRWANAccelerator and assigned to $wansource and $wantarget variables accordingly beforehand.
  • The VMs to copy are obtained with Find-VBRViEntity and assigned to the $vms variable beforehand.
  • The repository to where the VM data will be copied is obtained with Get-VBRBackupRepository and assigned to the $repository variable beforehand.

PS C:\PS> Add-VBRViBackupCopyJob -SourceAccelerator $wansource -TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms -Repository $repository

Example 2

This command creates a direct backup copy job that will copy backups to the default backup repository:

  • The name of the job is "DC CopyJob".
  • The backup job named "DC Backup" with the VMs to be copied is obtained with Get-VBRBackup and piped down.
  • The Repository parameter is omitted.

PS C:\PS> Get-VBRBackup -Name "DC Backup" | Add-VBRViBackupCopyJob -DirectOperation -Name "DC CopyJob"

Related Commands

Get-VBRWANAccelerator

Find-VBRViEntity

Get-VBRBackup

Get-VBRJob

Get-VBRBackupRepository

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation