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

Add-VBRViCloudReplicaJob

Short Description

Creates a new VMware cloud replication job.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRViCloudReplicaJob -Entity <IViItem[]> -Server <VBRCloudServer> -Datastore <VBRCloudDatastore> [-Name <string>] [-Description <string>] [-Suffix <string>] [-BackupRepository <CBackupRepository>] [-SourceRepository <CBackupRepository[]>] [-EnableNetworkMapping] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRCloudServerNetworkInfo[]>] [-SourceProxy <CViProxy[]>] [-SourceWANAccelerator <CWanAccelerator>] [-DiskType <EDiskCreationMode> {Source | Thick | Thin | ThickEagerZeroed}] [-RepositorySeed <CBackupRepository>] [-OriginalVM <CViVmItem[]>] [-ReplicaVM <COib[]>]  [<CommonParameters>]

Detailed Description

This cmdlet creates a new VMware cloud replication job. Cloud replication creates a VM replica on a cloud host and maintains it in synch with the original VM.

Note that cloud replication does not support replica from backup.

When you create a replication job, you can configure the following additional settings:

  • Network mapping: this option allows you to configure network mapping rules if the production site and the cloud host uses separate virtual networks. Use the EnableNetworkMapping parameter to enable the network mapping and the SourceNetwork and the TargetNetwork parameters to select the networks.
  • Proxy server: this option allows you to assign particular proxy server for the data transfer. Use the SourceProxy parameter to set the proxy explicitly or leave the default (Automatic selection).
  • WAN accelerators: this option allows you to use the built-in WAN accelerators to optimize the data transfer. Note that WAN accelerators must work in pair, so you can use the WAN acceleration only if the cloud provider has a WAN accelerator on the target side. Use the SourceWANAccelerator parameter to set the source WAN accelerator.
  • Ri-IP rules: this option allows you to configure different IP addressing scheme for the production site and the cloud host. You need to create an object containing the re-IP rules beforehand by running New-VBRViReplicaReIpRule. Then pass the created object to the ReIpRule parameter of this cmdlet.

Note that when you create a replica job, you need to run it manually unless you enable a job schedule.

Run Start-VBRJob to start the created job manually.

Run Set-VBRJobSchedule to set schedule for the job and run it automatically.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Entity

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

True

Named

True (ByValue,
ByProperty
Name)

False

Server

Specifies the cloud host allocated by the service provider under the hardware plan. The replicas will be created on this host.

Accepts VBRCloudServer type.

True

Named

False

False

Datastore

Specifies the cloud datastore to which you want to replicate.

Accepts VBRCloudDatastore type.

False

Named

False

False

Name

Specifies the name you want to assign to the cloud replication job.

False

Named

False

False

Description

Specifies the description of the new job.

False

Named

False

False

Suffix

Specifies the suffix that will be appended to the name of the VM you are replicating. This name will be used to register the replicated VM on the target server.

If omitted, the replicated VMs will have the '_replica' suffix by default.

False

Named

False

False

Backup
Repository

Specifies the user backup repository that will be used to store replica metadata files.

If not set, the default backup repository will be used.

False

Named

False

False

Source
Repository

Used for building replica from backup files.

Specifies the backup repository that will be used to read the VM data from the already existing backup chain.

You cannot specify cloud repository.

False

Named

False

False

Enable
Network
Mapping

Indicates that the network mapping must be used. Use the SourceNetwork and the TargetNetwork parameters to set the network mapping rules.

False

Named

False

False

Source
Network

Used to set the source network for the EnableNetworkMapping parameter.

Specifies the production network to which VMs added to the job are connected.

Accepts VBRViNetworkInfo type.

NOTE: The number of the source and the target networks must be the same.

False

Named

False

False

Target
Network

Used to set the target network for the EnableNetworkMapping parameter.

Specifies the network in the DR site to which VM replicas must be connected.

Accepts VBRCloudServerNetworkInfo type.

NOTE: The number of the source and the target networks must be the same.

False

Named

False

False

Source
Proxy

Specifies the source proxy that will be used by the job.

Default: Automatic selection.

False

Named

False

False

Source
WAN
Accelerator

Specifies the WAN accelerator configured in the source site that will be used for data transfer.

Note that you can set the source WAN accelerator only if the cloud provider has a target WAN accelerator configured.

False

Named

False

False

DiskType

Specifies the format that will be used to restore replica disk files:

  • Source: the restored replica disks will be the same format as source.
  • Thick: the restored replica disks will be thick.
  • Thin: the restored replica disks will be thick.

Default: Source.

False

Named

False

False

RepositorySeed

For replica seeding.

Specifies the backup repository where the seed (the full backup) resides.

False

Named

False

False

OriginalVM

For replica mapping.

Specifies the production VM you want to replicate using replica mapping.

The replication job will map this VM to a selected replica VM on the DR site.

Use the ReplicaVM parameter to specify the replica VM on the DR site.

False

Named

False

False

ReplicaVM

For replica mapping.

Specifies the VM on the DR site you want to use as the replication target. The replication job will map the production VM to this VM.

Use the OriginalVM parameter to specify the production VM.

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

This example shows how to create a cloud replica job.

  1. Run Find-VBRViEntity to get the VM you want to replicate. Save it to the $vm variable.
  2. Run Get-VBRCloudServer to get the cloud server on which the replica will be created. Save the server to the $cloudServer variable.
  3. Run Get-VBRCloudDatastore to specify the cloud datastore to which you will replicate. Use the $cloudServer variable. Save the datastore to the $cloudDatastore variable.
  4. Run Add-VBRViCloudReplicaJob to create the replica job. Use the $vm, $cloudServer and $cloudDatastore variables.

PS C:\PS> $vm = Find-VBRViEntity -Name “web_application_server”

PS C:\PS> $cloudServer = Get-VBRCloudServer -Name 104.45.95.227

PS C:\PS> $cloudDatastore = Get-VBRCloudDatastore -CloudServer $cloudServer –Name “ABCDatastore”

PS C:\PS> Add-VBRViCloudReplicaJob -Name “Cloud Replica Job” -Entity $vm -Server $cloudServer -Datastore $cloudDatastore

Related Commands

Find-VBRViEntity

Get-VBRCloudServer

Get-VBRCloudDatastore

Get-VBRBackupRepository

Get-VBRViServerNetworkInfo

Get-VBRViProxy

Get-VBRWANAccelerator

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