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

Add-VBRViReplicaJob

In this article

Short Description

Creates a new VMware replication job.

Applies to

Platform: VMware

For Hyper-V, run Add-VBRHvReplicaJob.

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRViReplicaJob -Server <CHost> -Entity <IViItem[]> [-Name <string>] [-Datastore <CViDatastoreItem>] [-StoragePolicy <VBRViStoragePolicy>] [-ResourcePool <CViResourcePoolItem>] [-Folder <CViFolderItem>] [-Suffix <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [-EnableNetworkMapping] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRViNetworkInfo[]>] [-SourceProxy <CViProxy[]>] [-TargetProxy <CViProxy[]>] [-SourceWANAccelerator <CWanAccelerator>] [-TargetWANAccelerator <CWanAccelerator>] [-RestorePointsToKeep <int>] [-SourceRepository <CBackupRepository[]>] [-ReIpRule <VBRViReplicaReIpRule[]>] [-DiskType <EDiskCreationMode> {Source | Thick | Thin}] [<CommonParameters>]

Related Commands

Get-VBRServer

Find-VBRViEntity

Find-VBRViDatastore

Find-VBRViStoragePolicy

Find-VBRViResourcePool

Find-VBRViFolder

Get-VBRBackupRepository

Get-VBRViServerNetworkInfo

Get-VBRViProxy

Get-VBRWANAccelerator

New-VBRViReplicaReIpRule

Detailed Description

This cmdlet creates a new VMware replication job.

You can select a data source from which VM data must be read:

Actual VM: Veeam Backup & Replication will copy an actual VM from production storage. The created replica will mirror an actual VM state.

Use the Entity parameter to indicate the VMs you want to replicate.

Replica from backup files: Veeam Backup & Replication will build a replica from backup files stored on a backup repository. The created replica will be in the latest state the VM is available in backups.

Use the Entity parameter to indicate the VMs you want to replicate and the SourceRepository parameter to set the repository from where the backup files must be read.

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

Storage policy profile: you can apply a particular VMware storage policy profile to virtual disks of the replica VM. Use the StoragePolicy parameter to set the profile.
Network mapping: this option allows you to configure network mapping rules if the production site and DR site 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 servers: this options allow you to configure particular proxy servers for the data transfer. Use the SourceProxy and the TargetProxy parameters to set the proxies.
WAN accelerators: this options allow you to use the built-in WAN accelerators to optimize the data transfer. Use the SourceWANAccelerator and the TargetWANAccelerator parameters to set the WAN accelerators. Note that WAN acceleration is available only in the Enterprise Plus edition.
Ri-IP rules: this option allows you to configure different IP addressing scheme for the production and the DR sites. You need to create an object containing the re-IP rules before hand by running New-VBRViReplicaReIpRule. 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
Name	Specifies the string with the name of the created replication job. If not set, Veeam Backup & Replication will give the default job name.	False	Named	False	False
Server	Specifies the host where the created replica should be stored.	True	Named	False	False
Entity	Specifies the VM(s) that you want to replicate. You can assign multiple VMs to this object.	True	Named	True (ByValue, ByProperty Name)	False
Datastore	Specifies the datastore to which you want to replicate.	False	Named	False	False
Storage Policy	Specifies the VMware storage policy profile that must be applied to the replica virtual disks.	False	Named	False	False
Resource Pool	Specifies the resource pool to which you want to replicate.	False	Named	False	False
Folder	Specifies the folder to which you want to replicate.	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 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
Description	Specifies the description of the new job. If not set, Veeam Backup & Replication will enter date and time of creation by default.	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. Use the TargetNetwork parameter to set the target network. 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. Use the SourceNetwork parameter to set the source network. 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
Target Proxy	Specifies the target 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. Remember to set the pair of source and target WAN accelerators. Default: not set.	False	Named	False	False
Target WAN Accelerator	Specifies the WAN accelerator configured in the target site that will be used for data transfer. Remember to set the pair of source and target WAN accelerators. Default: not set.	False	Named	False	False
Restore Points ToKeep	Specifies the number of restore points that will be kept. Permitted values: 1 to 28. Default: 7.	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.	False	Named	False	False
ReIpRule	Specifies the re-IP rules. Accepts VBRViReplicaReIpRule object.	False	Named	False	False
DiskType	Specifies the disks that you want to replicate: Source, Thick, Thin. Default: Source.	False	Named	False	False

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 adds a new job named "DC Replication Job" replicating a VM named "DC".

The VM to replicate is obtained with Find-VBRViEntity and piped down.
The server and the resource pool to locate the replica are obtained with Get-VBRServer and Find-VBRViResourcePool and assigned to the $server and $pool variables accorgingly beforehand.
The replica is created with the suffix "_replicated".
The description of the job is "DC Replication Job".

PS C:\PS> Find-VBRViEntity -Name "DC" | Add-VBRViReplicaJob -Name "DC Replication Job" -Server $server -ResourcePool $pool -Suffix "_replicated"

Example 2

This command creates a new job named "DC Replication Job" replicating a VM represented by the $vm variable.

The VM to replicate is obtained with Find-VBRViEntity and assigned to the variable beforehand.
The server where the replica will reside is obtained with Get-VBRServer and assigned to the $server variable beforehand.
The datastore and the resource pool to locate the replica are obtained with Find-VBRViDatastore and Find-VBRViResourcePool and assigned to the $datastore and $pool variables accorgingly beforehand.
The replica is created with the suffix "_replicated".
The description of the job is "DC Replication Job".

PS C:\PS> Add-VBRViReplicaJob -Name "DC Replication Job" -Server $server -Entity $vm -Datastore $datastore -ResourcePool $pool -Suffix "_replicated" -Description "DC Replication Job"