Add-VBRComputerBackupCopyJob

Short Description

Creates Veeam Agent backup copy jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Create Veeam Agent backup copy jobs that will transfer data directly.

Add-VBRComputerBackupCopyJob -DirectOperation [-Name <string>] [-Description <string>] [-Backup <CBackup[]>][-BackupJob <VBRComputerBackupJob[]>] [-Repository <CBackupRepository>] [-EnableImmediateCopy][-RecoveryPointObjective <VBRRecoveryPointObjective>] [-RetentionPolicy <VBRRetentionPolicy>][-BackupWindowOptions <VBRBackupWindowOptions>] [-NotificationOptions <VBRNotificationOptions>] [-StorageOptions <VBRBackupCopyJobStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-RPOWarningOptions <VBRRpoNotificationOptions>] [-EnableTransactionLogCopy] [<CommonParameters>]

  • Create Veeam Agent backup copy jobs that will transfer data over WAN accelerators.

Add-VBRComputerBackupCopyJob -SourceAccelerator <CWanAccelerator> -TargetAccelerator <CWanAccelerator> [-Name <string>] [-Description <string>] [-Backup <CBackup[]>] [-BackupJob <VBRComputerBackupJob[]>] [-Repository <CBackupRepository>] [-EnableImmediateCopy] [-RecoveryPointObjective <VBRRecoveryPointObjective>][-RetentionPolicy <VBRRetentionPolicy>] [-BackupWindowOptions <VBRBackupWindowOptions>]
[-NotificationOptions<VBRNotificationOptions>] [-StorageOptions <VBRBackupCopyJobStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-RPOWarningOptions <VBRRpoNotificationOptions>][-EnableTransactionLogCopy]  [<CommonParameters>]

Detailed Description

This cmdlet creates Veeam Agent backup copy jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

DirectOperation

Defines that the cmdlet will create a Veeam Agent backup copy job that will transfer data directly from the source backup repository to the target backup repository.

SwitchParameter

True

Named

False

SourceAccelerator

Specifies the WAN accelerator on the source side.

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

Accepts the CWanAccelerator object. To get this object, run the Get-VBRWANAccelerator cmdlet.

True

Named

False

TargetAccelerator

Specifies the WAN accelerator on the target side.

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

Accepts the CWanAccelerator object. To get this object, run the Get-VBRWANAccelerator cmdlet.

True

Named

False

Name

Specifies a name that you want to assign to a Veeam Agent backup copy job.

String

False

Named

False

Description

Specifies a description of a Veeam Agent backup copy job.

String

False

Named

False

Backup

Specifies an array of backups. The cmdlet will add machines from these backups to a Veeam Agent backup copy job.

Note: This parameter is available for a Veeam Agent backup copy job that is created with the periodic backup copy mode.

Accepts the CBackup[] object. To create this object, run the Get-VBRBackup cmdlet.

False

Named

False

BackupJob

Specifies an array of backup jobs. The cmdlet will add machines processed by these jobs to a Veeam Agent backup copy job.

Accepts the VBRComputerBackupJob[] object. To create this object, run the Get-VBRComputerBackupJob cmdlet.

False

Named

False

Repository

Specifies the target backup repository. The cmdlet will copy the machine data to this repository.

Default: Default backup repository.

Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet.

False

Named

False

EnableImmediateCopy

Defines that the cmdlet will enable the immediate copy mode.

If you specify this parameter, Veeam Backup & Replication will copy new restore points and transaction logs as soon as they appear.

Otherwise, Veeam Backup & Replication will copy data from backups once per backup copy interval.

Note:

  • To run the script with the EnableImmediateCopy parameter, you must provide the BackupJob parameter.
  • To copy transaction logs you must provide the EnableTransactionLogCopy parameter.

SwitchParameter

False

Named

False

EnableTransactionLogCopy

Defines that the Veeam Agent backup copy job will process transaction logs of the source job.

SwitchParameter

False

Named

False

RecoveryPointObjective

Specifies a schedule for a Veeam Agent backup copy job with the periodic backup copy mode. The cmdlet will create the job with these settings.

Accepts the VBRRecoveryPointObjective object. To create this object, run the Get-VBRRecoveryPointObjective cmdlet.

False

Named

False

RetentionPolicy

Specifies a retention policy for a Veeam Agent backup copy job. The cmdlet will create the job with these settings. You can specify the following types of retention policies:

  • Simple retention policy: use this option for short-time archiving. To create a job with this type of the policy, provide the VBRSimpleRetentionPolicy object. Run the New-VBRSimpleRetentionPolicy cmdlet to create this object.
  • GFS retention policy: use this option for long-term archiving. To create a job with this type of the policy, provide the VBRRetentionPolicy object. Run the New-VBRGFSRetentionPolicy cmdlet to create this object.

Accepts the following objects:

  • VBRRetentionPolicy. Run the New-VBRGFSRetentionPolicy cmdlet to get this object.
  • VBRSimpleRetentionPolicy. Run the New-VBRSimpleRetentionPolicy cmdlet to create this object.

False

Named

False

BackupWindowOptions

Specifies backup window settings for a Veeam Agent backup copy job. The cmdlet will create the job with these settings.

Accepts the VBRBackupWindowOptions object. To create this object, run the New-VBRBackupWindowOptions cmdlet.

False

Named

False

NotificationOptions

Specifies notification settings for a Veeam Agent backup copy job. The cmdlet will create the job with these settings.

Accepts the VBRNotificationOptions object. To create this object, run the New-VBRNotificationOptions cmdlet.

False

Named

False

StorageOptions

Specifies the storage settings of the backup repository. The cmdlet will create the Veeam Agent backup copy job with these settings.

Accepts the VBRBackupCopyJobStorageOptions object. To create this object, run the New-VBRBackupCopyJobStorageOptions cmdlet.

False

Named

False

HealthCheckOptions

Specifies the health check schedule for a Veeam Agent backup copy job. The cmdlet will create the job with these settings.

Accepts the VBRFullBackupOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet.

False

Named

False

ScriptOptions

Specifies pre-job and post-job script options for a Veeam Agent backup copy job. The cmdlet will create the job with these settings.

Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet.

False

Named

False

RPOWarningOptions

Specifies a period of time when data must be copied from the source repository to the target repository.

Default: 1 hour.

Accepts the VBRRPONotificationOptions object. To create this object, run the New-VBRRPONotificationOptions cmdlet.

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

The cmdlet returns the VBRComputerBackupCopyJob object that contains settings of Veeam Agent backup copy jobs.

Examples

Add-VBRComputerBackupCopyJobExample 1. Creating Veeam Agent Backup Copy Job to Transfer Data Directly

This example shows how to create a Veeam Agent backup copy job that will transfer data directly from the source backup repository to the target backup repository.

$repository = Get-VBRBackupRepository -Name Repository 05

$job = Get-VBRComputerBackupJob -Name "Agent backup job 05"

Add-VBRComputerBackupCopyJob -DirectOperation -Name "Agent Backup Copy 05" -BackupJob $job -Repository $repository

Perform the following steps:

  1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  2. Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  3. Run the Add-VBRComputerBackupCopyJob cmdlet. Specify the following settings:
  • Provide the DirectOperation parameter.
  • Specify the Name parameter value.
  • Set the $job variable as the BackupJob parameter value.
  • Set the $repository variable as the Repository parameter value.

Add-VBRComputerBackupCopyJobExample 2. Creating Veeam Agent Backup Copy Job to Transfer Data over WAN Accelerators

This example shows how to create a Veeam Agent backup copy job that will transfer data over WAN accelerators.

$wansource = Get-VBRWANAccelerator -Name "WAN Source"

$wantarget = Get-VBRWANAccelerator -Name "WAN02 Target"

$backup = Get-VBRBackup -Name "Windows Server Backup"

$repository = Get-VBRBackupRepository -Name Repository 05

Add-VBRComputerBackupCopyJob -SourceAccelerator $wansource -TargetAccelerator $wantarget -Backup $backup -Repository $repository

Perform the following steps:

  1. Run the Get-VBRWANAccelerator cmdlet. Specify the Name parameter value. Save the result to the $wansource variable.
  2. Run the Get-VBRWANAccelerator cmdlet. Specify the Name parameter value. Save the result to the $wantarget variable
  3. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
  4. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  5. Run the Add-VBRComputerBackupCopyJob cmdlet. Specify the following settings:
  • Set the $wansource variable as the SourceAccelerator parameter value.
  • Set the $wantarget variable as the TargetAccelerator parameter value.
  • Set the $backup variable as the Backup parameter value.
  • Set the $repository variable as the Repository parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.