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

Set-VBREC2BackupCopyJob

Short Description

Modifies backup copy jobs for backups of Amazon EC2 instances.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Set-VBREC2BackupCopyJob -Job <CBackupJob> [-Name <string>] [-Description <string>] [-Backup <VBREC2Backup[]>][-Repository <CBackupRepository>] [-RecoveryPointObjective <VBRRecoveryPointObjective>] [-RetentionPolicy <VBRRetentionPolicy>] [-BackupWindowOptions <VBRBackupWindowOptions>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies backup copy jobs that copy backups of Amazon EC2 instances.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies a backup copy job that you want to modify.

True

Named

True (ByValue)

 

Name

Specifies a name of a backup copy job.

False

Named

False

 

Description

Specifies a description of a backup copy job.

False

Named

False

 

Backup

Specifies an array of EC2 instance backups that you want to copy.

Accepts the VBREC2Backup[] object. To get this object, run the Get-VBREC2Backup cmdlet.

False

Named

False

 

Repository

Specifies a target backup repository. The cmdlet will copy EC2 instance backups to this repository.

Accepts the CBackupRepository type.

False

Named

False

 

RecoveryPointObjective

Specifies a backup copy interval. The cmdlet will copy new restore points of EC2 instance backups to the target backup repository.

Accepts the VBRRetentionPolicy object. To get this object, run the following cmdlets:

False

Named

False

 

RetentionPolicy

Specifies a number of restore points to keep on a target backup repository.

Accepts the VBRRetentionPolicy type.

False

Named

False

 

BackupWindowOptions

Specifies the period of time when a backup copy job is allowed to run.

Accepts the VBRBackupWindowOptions type.

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.

Example

This example shows how to add an Amazon EC2 instance to a backup copy job.

  1. Run Get-VBRJob to get a backup copy job that you want to modify. Save the result to the $vm variable.
  2. Run Get-VBREC2Backup to get an Amazon EC2 instance that you want to add to the backup copy job. Save the result to the $instance variable.
  3. Run Set-VBREC2BackupCopyJob with the $instance and $copyjob variables.

$copyjob = Get-VBRJob -Name "VMEC2 Instance Copy Job SRV10"

$instance = Get-VBREC2Backup -Name "VMEC2 Instance SRV10 01"

Set-VBREC2BackupCopyJob -Job $copyjob -Backup $vm

Related Commands

Get-VBRJob

Get-VBREC2Backup