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

Set-VBRViReplicaJob

Short Description

Modifies VMware replication jobs.

Applies to

Platform: VMware

For Hyper-V, run Set-VBRHvReplicaJob.

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRViReplicaJob -Job <CBackupJob> [-Name <string>] [-Server <Object>] [-Entity <IViItem[]>] [-Datastore <VBRViDatastoreBase>] [-ResourcePool <CViResourcePoolItem>] [-Folder <CViFolderItem>] [-Suffix <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [-EnableNetworkMapping] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRViNetworkInfo[]>] [-SourceProxy <CViProxy[]>] [-TargetProxy <CViProxy[]>] [-UseWANAccelerator] [-SourceWANAccelerator <CWanAccelerator>] [-TargetWANAccelerator <CWanAccelerator>] [-RestorePointsToKeep <int>] [-ReplicateFromBackup] [-SourceRepository <CBackupRepository[]>] [-EnableReIp] [-ReIpRule <VBRViReplicaReIpRule[]>] [-DiskType <EDiskCreationMode> {Source | Thick | Thin | ThickEagerZeroed}] [-EnableSeeding] [-RepositorySeed <CBackupRepository>] [-EnableVMMapping] [-OriginalVM <CViVmItem[]>] [-ReplicaVM <CViVmItem[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies an existing VMware replication job. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the replication job you want to modify.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

Name

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

False

Named

False

False

Server

Specifies the target host where the created replica will be stored.

True

Named

False

False

Entity

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

True

Named

True (ByValue,
ByProperty
Name)

False

Datastore

Specifies the datastore to which you want to replicate.

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.

Default: "_replica".

False

Named

False

False

Backup
Repository

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

Default: default backup repository.

False

Named

False

False

Description

Specifies the description of the new job.

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

For network mapping.

Specifies the array of production networks to which the VMs in 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

For network mapping.

Specifies the array of networks in the DR site. The replicated VMs will be connected to these networks.

Accepts VBRViNetworkInfo 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 you want to assign to the job.

Default: automatic selection.

False

Named

False

False

Target
Proxy

Specifies the target proxy you want to assign to the job.

Default: automatic selection.

False

Named

False

False

UseWAN
Accelerator

Indicates that the data will be transferred via WAN accelerators.

Use the SourceWANAccelerator and TargetWANAccelerator parameters to set the pair of WAN accelerators.

False

Named

False

Fals

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 you want to keep.

Permitted values: 1 to 28.

Default: 7.

False

Named

False

False

Replicate
FromBackup

For building replica from backup files.

If set to $true, the job will use the backups in repository to build the replica. Use the SourceRepository parameter to set the repository.

False

Named

False

False

Source
Repository

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

EnableReIp

Indicates that the re-IP rules must be used. Use the ReIpRule parameter to set the re-IP rules.

False

Named

False

False

ReIpRule

Specifies the re-IP rules.

Accepts VBRViReplicaReIpRule type.

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

EnableSeeding

Indicates that the replication job will use seeding.

False

Named

False

False

RepositorySeed

For replica seeding.

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

False

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

EnableVMMapping

Indicates that the replication job will use replica mapping.

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

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

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

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

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 1

This example shows how to configure a re-IP rule for a replication job.

  1. Run Get-VBRJob to get the replication job and save it to the $job variable.
  2. Run New-VBRViReplicaReIpRule to create a new re-IP rule. Save it to the $reiprule variable.
  3. Run Set-VBRViReplicaJob. Use $job and $reiprule variables.

PS C:\PS> $job = Get-VBRJob -Name "Apache Replication"

PS C:\PS> $reiprule = New-VBRViReplicaReIpRule -SourceIp 172.16.*.* -SourceMask 255.255.0.0 -TargetIp 172.17.*.* -TargetMask 255.255.0.0 -TargetGateway 172.17.0.1

PS C:\PS> Set-VBRViReplicaJob -Job $job -EnableReIp -ReIpRule $reiprule

Example 2

This example shows how to configure seeding for a replication job.

  1. Run Get-VBRJob to get the replication job and save it to the $job variable.
  2. Run Get-VBRBackupRepository to get the backup repository where the seed backup resides and save it to the $repository variable.
  3. Run Set-VBRViReplicaJob. Use the $job and $repository variables.

PS C:\PS> $job = Get-VBRJob -Name "Apache Replication"

PS C:\PS> $repository = Get-VBRBackupRepository -Name "Backup Volume 01"

PS C:\PS> Set-VBRViReplicaJob -Job $job -EnableSeeding -RepositorySeed $repository

Example 3

This example shows how to configure VM mapping for a replication job.

  1. Run Get-VBRJob to get the replication job and save it to the $job variable.
  2. Run Find-VBRViEntity to get the original VM that you want to map. Save it to the $originalvm variable.
  3. Run Find-VBRViEntity to get the replica VM. Save it to the $replicavm variable.
  4. Run Set-VBRViReplicaJob. Use the $job, $originalvm and $replicavm variables.

PS C:\PS> $job = Get-VBRJob -Name "Apache Replication"

PS C:\PS> $originalvm = Find-VBRViEntity -Server "Production Host" -Name "Original VM"

PS C:\PS> $replicavm = Find-VBRViEntity -Server "DR Host" -Name "Replica VM"

PS C:\PS> Set-VBRViReplicaJob -Job $job -EnableVMMapping -OriginalVM $originalvm -ReplicaVM $replicavm

Related Commands

Get-VBRJob

Get-VBRServer

Find-VBRViEntity

Find-VBRViDatastore

Find-VBRViResourcePool

Find-VBRViFolder

Get-VBRBackupRepository

Get-VBRViProxy

Get-VBRWANAccelerator

Get-VBRViServerNetworkInfo

New-VBRViReplicaReIpRule

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