Set-VBRvCDCloudReplicaJob

In this article

    Short Description

    Modifies vCD cloud replication jobs.

    Applies to

    Platform: VMware

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

    Syntax

    Set-VBRvCDCloudReplicaJob -Job <CBackupJob> [-Name <string>] [-Entity <IViItem[]>] [-OrganizationvDC <VBRvCDCloudOrganizationvDC>] [-vApp <VBRvCDCloudvApp>] [-StoragePolicy <VBRvCDCloudStoragePolicy>] [-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 vCD cloud replication jobs.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the vCD cloud replication job that you want to modify.

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    Name

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

    False

    Named

    False

    False

    Entity

    Specifies an array of VMs.The cmdlet will add the selected VMs to the vCD replication job.

    False

    Named

    True (ByPropertyName)

    False

    OrganizationvDC

    Specifies the cloud Organization vDC. The job will store the replicas on the selected Organization vDC.

    Accepts the VBRvCDCloudOrganizationvDC type.

    False

    Named

    False

    False

    vApp

    Specifies the vApp container. The job will store the replicas on the selected vApp.

    Accepts the VBRvCDCloudvApp type.

    False

    Named

    False

    False

    StoragePolicy

    Specifies the vCD cloud storage policy. The job will create replicas per the policy settings.

    Accepts the VBRvCDCloudStoragePolicy 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 user backup repository that will be used to store replica metadata files.

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

    Accepts the CBackupRepository type.

    False

    Named

    False

    False

    Description

    Specifies the description of a new job.

    False

    Named

    False

    False

    EnableNetworkMapping

    Indicates that network mapping will be enabled.

    Use the following parameters to set the network mapping rules:

    • SourceNetwork
    • TargetNetwork

    False

    Named

    False

    False

    SourceNetwork

    For the network mapping option.

    Specifies an array of the production networks, to which the VMs in the job are connected.

    Accepts the VBRViNetworkInfo type.

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

    False

    Named

    False

    False

    TargetNetwork

    For the network mapping option.

    Specifies an array of networks on the Disaster Recovery site. The replicated VMs will be connected to these networks.

    Accepts the VBRvCDCloudNetworkInfo 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.

    False

    Named

    False

    False

    UseWANAccelerator

    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

    False

    SourceWANAccelerator

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

    NOTE: 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 a replica from backup files.

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

    NOTE: You cannot specify a cloud repository.

    False

    Named

    False

    False

    DiskType

    This parameter is not available for vCD Cloud Replica jobs.

    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

    False

    False

    EnableVMMapping

    Indicates that the replication job will use replica mapping.

    False

    Named

    False

    False

    OriginalVM

    For replica mapping.

    Specifies an array of production VMs that you want to replicate using replica mapping.

    The replication job will map these VMs to selected replica VMs on the Disaster Recovery site.

    Use the ReplicaVM parameter to specify the replica VM on the Disaster Recovery site.

    False

    Named

    False

    False

    ReplicaVM

    For replica mapping.

    Specifies an array of VMs on the Disaster Recovery site that you want to use as the replication target. The replication job will map the production VMs to these VMs.

    Use the OriginalVM parameter to specify the production VM.

    Accepts the VBRvCDCloudVM type.

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will modify the job even if the geographical location of the VMs added to the job and the target 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.

    Return Type

    Example

    This example shows how to change the vCD Organization vDC for the existing vCD cloud replication job.

    1. Run Get-VBRJob to get the replication job that you want to modify. Save the result to the $replicaJob variable.
    2. Run Get-VBRvCDCloudOrganizationvDC to get the Organization vDC that will store the VM replicas. Save the result to the $vdc variable.
    3. Run Set-VBRvCDCloudReplicaJob with the $replicaJob and $vdc variables.

    $replicaJob = Get-VBRJob -Name "Replica Job"

    $vdc = Get-VBRvCDCloudOrganizationvDC -Name "New Cloud Organization"

    Set-VBRvCDCloudReplicaJob -Job $replicajob -OrganizationvDC $vdc

    Related Command

    Get-VBRvCDCloudOrganizationvDC

    I want to report a typo

    There is a misspelling right here:

     

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