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

Set-VBRHvCloudReplicaJob

Short Description

Modifies a Hyper-V cloud replication job.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRHvCloudReplicaJob -Job <CBackupJob> [-Name <string>] [-Datastore <VBRCloudDatastore>] [-Entity <IHvItem[]>] [-Suffix <string>] [-Description <string>] [-SourceRepository <CBackupRepository[]>] [-BackupRepository <CBackupRepository>] [-EnableNetworkMapping] [-SourceNetwork <VBRHvServerNetworkInfo[]>] [-TargetNetwork <VBRCloudServerNetworkInfo[]>] [-UseWANAccelerator] [-SourceWANAccelerator <CWanAccelerator>] [-SourceProxy <CHvProxy[]>] [-EnableSeeding] [-RepositorySeed <CBackupRepository>] [-EnableVMMapping] [-OriginalVM <CHvVmItem[]>] [-ReplicaVM <COib[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies an existing Hyper-V cloud 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 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

Entity

Specifies the array of VMs you want to replicate.

False

Named

False

False

Datastore

Specifies the cloud disk volume to which you want to replicate.

Accepts VBRCloudDatastore type.

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

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

Backup
Repository

Specifies the backup repository which 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

Used to set the source network for the EnableNetworkMapping parameter.

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

Accepts VBRHvServerNetworkInfo 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

Use
WAN
Accelerator

Indicates that the data must be transferred via WAN accelerators.

Use the SourceWANAccelerator parameter to set the WAN accelerator on the source side.

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

EnableSeeding

Indicates if replica seeding must be used for the replication job.

False

Named

False

False

RepositorySeed

For replica seeding.

Specifies the backup repository on which a backup used as a seed for the replication job resides.

False

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

EnableVMMapping

Indicates if replica mapping must be used for the replication job.

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

This example shows how to apply custom settings to a cloud replica job.

  1. Run Get-VBRJob to get the job you want to modify. Save the job to the $job variable.
  2. Run Find-VBRHvEntity to get the VMs you want to add to the job. Save the VMs to the $vms variable.
  3. Run Get-VBRCloudServer to get the cloud server on which the replica will be created. Save the server to the $cloudServer variable.
  4. Run Get-VBRCloudDatastore to specify the new cloud datastore to which you will replicate. Use the $cloudServer variable. Save the datastore to the $NewCloudDatastore variable.
  5. Run Set-VBRHvCloudReplicaJob to modify the replica job settings. Use the saved variables.

PS C:\PS> $job = Get-VBRJob –Name “Hv Cloud Replica Job”

PS C:\PS> $vms = Find-VBRHvEntity -Name fileserver*

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

PS C:\PS> $NewCloudDatastore = Get-VBRCloudDatastore -CloudServer $NewCloudServer –Name “KLMDatastore”

PS C:\PS> Set-VBRHvCloudReplicaJob –Job $job -Entity $vms –Datastore $NewCloudDatastore

Related Commands

Get-VBRJob

Get-VBRCloudServer

Get-VBRCloudDatastore

Find-VBRHvEntity

Get-VBRBackupRepository

Get-VBRHvServerNetworkInfo

Get-VBRCloudServerNetworkInfo

Get-VBRWANAccelerator

Get-VBRHvProxy

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 Endpoint Backup Documentation

Veeam Management Pack Documentation