Add-VBRvCloudBackupCopyJob

In this article

    Short Description

    Creates a vCloud backup copy job.

    Applies to

    Platform: VMware

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    This cmdlet provides two parameter sets.

    • For data transfer with WAN accelerators:

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

    • For direct data transfer:

    Add-VBRvCloudBackupCopyJob -DirectOperation [-Name <string>] [-Description <string>] [-Entity <IVcdItem[]>] [-Backup <CBackup[]>] [-BackupJob <CBackupJob[]>] [-Repository <CBackupRepository>] [-EnableImmediateCopy] [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new vCloud backup copy job. The vCloud backup copy job uses a cloud repository as the target.

    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, Veeam Universal License 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

    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 job.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Backup

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

    False

    Named

    False

    False

    BackupJob

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

    False

    Named

    False

    False

    Repository

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

    Default: default backup repository.

    False

    Named

    False

    False

    SourceAccelerator

    Specifies the WAN accelerator on the source side.

    If you select the mode using WAN accelerators, the -DirectOperation parameter should be omitted.

    True

    Named

    False

    False

    TargetAccelerator

    Specifies the WAN accelerator on the target side.

    If you select the mode using WAN accelerators, the -DirectOperation parameter should be omitted.

    True

    Named

    False

    False

    Description

    Specifies the description of the backup copy job.

    False

    Named

    False

    False

    DirectOperation

    Enables the direst operation method sending the data directly to the target backup repository without performing data deduplication.

    If you select the direct operation mode, the -TargetAccelerator and -SourceAccelerator parameters should be omitted.

    False

    Named

    False

    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 logs as soon as they appear.

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

    False

    Named

    False

    False

    <CommonParameters>

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

    Example 1

    This command creates a backup copy job named "vCloud CopyJob1" with the following parameters:

    • 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-VBRvCloudEntity 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.

     

    Add-VBRvCloudBackupCopyJob -SourceAccelerator $wansource -TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms -Repository $repository

    Example 2

    This command creates a direct backup copy job with the following parameters:

    • 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 not set to copy the VMs to the default backup repository.

     

    Get-VBRBackup -Name "DC Backup" | Add-VBRvCloudBackupCopyJob -DirectOperation -Name "DC CopyJob"

    Related Commands

    Get-VBRBackup

    Get-VBRJob

    Get-VBRBackupRepository

    Get-VBRWANAccelerator