Set-VBRViCloudReplicaJob

In this article

    Short Description

    Modifies a VMware cloud replication job.

    Applies to

    Platform: VMware

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

    Syntax

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

    Detailed Description

    This cmdlet modifies an existing VMware cloud replication job. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Starting from Veeam Backup & Replication version 9.5 Update 3, the cmdlet checks if the data of the VMs added to the job changes its geographical location.

    Set-VBRViCloudReplicaJob Note:

    The cmdlet will not run if the geographical location of the VMs added to the job and the target cloud host location do not match. If you still want to run the cmdlet, use the Force parameter.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the replication job you want to modify.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

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

    False

    Named

    False

    False

    Entity

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

    False

    Named

    True (ByProperty
    Name)

    False

    Datastore

    Specifies the cloud datastore 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

    BackupRepository

    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

    EnableNetworkMapping

    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

    SourceNetwork

    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

    TargetNetwork

    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

    SourceProxy

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

    Default: automatic selection.

    False

    Named

    False

    False

    UseWANAccelerator

    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

    SourceWANAccelerator

    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

    SourceRepository

    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

    DiskType

    Specifies the disks that you want to replicate: Source, Thick, Thin.

    Default: Source.

    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 (ByValue,
    ByProperty
    Name)

    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 (ByValue,
    ByProperty
    Name)

    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 (ByValue,
    ByProperty
    Name)

    False

    Force

    Indicates that the cmdlet will modify the cloud replication job even if the geographical location of the VMs added to the job and the target cloud host location do not match.

    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

    This example shows how to apply custom settings to the cloud replica job named “Cloud Replica Job”.

    1. Run Get-VBRJob to get the job you want to modify. Save the job to the $job 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 new cloud datastore to which you will replicate. Use the $cloudServer variable. Save the datastore to the $NewCloudDatastore variable.
    4. Run Set-VBRViCloudReplicaJob to modify the replica job settings. Use the saved variables.

    $job = Get-VBRJob –Name “Cloud Replica Job”

    $cloudServer = Get-VBRCloudServer -Name 104.45.95.227

    $NewCloudDatastore = Get-VBRCloudDatastore -CloudServer $NewCloudServer –Name “CDEDatastore”

    Set-VBRViCloudReplicaJob –Job $job –Datastore $NewCloudDatastore

    Related Commands

    Get-VBRJob

    Find-VBRViEntity

    Get-VBRCloudServer

    Get-VBRCloudDatastore

    Get-VBRBackupRepository

    Get-VBRViServerNetworkInfo

    Get-VBRViProxy

    Get-VBRWANAccelerator

    Get-VBRLocation

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.