Add-VBRvCDCloudReplicaJob

In this article

    Short Description

    Creates vCD cloud replication jobs.

    Applies to

    Platform: VMware

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

    Syntax

    Add-VBRvCDCloudReplicaJob -Entity <IViItem[]> -OrganizationvDC <VBRvCDCloudOrganizationvDC> -StoragePolicy <VBRvCDCloudStoragePolicy> [-OriginalVM <CViVmItem[]>] [-RepositorySeed <CBackupRepository>] [-DiskType <EDiskCreationMode>] [-SourceWANAccelerator <CWanAccelerator>] [-SourceProxy <CViProxy[]>] [-TargetNetwork <VBRvCDCloudNetworkInfo[]>] [-SourceNetwork <VBRViNetworkInfo[]>] [-EnableNetworkMapping <SwitchParameter>] [-SourceRepository <CBackupRepository[]>] [-BackupRepository <CBackupRepository>] [-Suffix <String>] [-vApp <VBRvCDCloudvApp>] [-Description <String>] [-Name <String>] [-ReplicaVM <VBRvCDCloudVM[]>] [-Force <SwitchParameter>] [<CommonParameters>]

    Detailed Description

    This cmdlet creates vCD cloud replication jobs. Only the tenant can create vCD cloud replication jobs.

    Add-VBRvCDCloudReplicaJob Note:

    To allow the tenant to create vCD cloud replication jobs, the Service provider must configure the infrastructure in VMware vCloud Director. It includes the following elements:

    • The Organization vDC
    • The vCD storage policy settings

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Entity

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

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    OrganizationvDC

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

    Accepts the VBRvCDCloudOrganizationvDC type.

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    StoragePolicy

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

    Accepts the VBRvCDCloudStoragePolicy type.

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    Name

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

    True

    Named

    False

    False

    Description

    Specifies the description that you want to assign to the cloud replication job.

    True

    Named

    False

    False

    vApp

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

    NOTE: if you do not specify the vApp container, the job will store the replicas on the default vApp.

    Accepts the VBRvCDCloudvApp type.

    False

    Named

    True (ByValue,
    ByPropertyName)

    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

    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

    EnableNetworkMapping

    Enables network mapping.

    Use the following parameters to set the network mapping rules:

    • SourceNetwork
    • TargetNetwork

    False

    Named

    False

    False

    SourceNetwork

    For the network mapping option.

    Specifies the 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 the network in 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.

    Default: Automatic selection

    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

    DiskType

    This parameter is not available for vCD Cloud Replica jobs.

    False

    Named

    False

    False

    RepositorySeed

    For replica seeding.

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

    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 create a 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 create a vCD cloud replication job.

    1. Run Find-VBRViEntity to get the VMs that you want to add to the replication job. Save the result to $vm variable.
    2. Run Get-VBRvCDCloudOrganizationvDC to get the OrganizationDC that will store VM replicas. Save the result to the $vdc variable.
    3. Run Get-VBRvCDCloudvApp with the $vdc variable to get the vApp that will keep VM replicas. Save the result to the $vApp variable.
    4. Run Get-VBRvCDCloudStoragePolicy to get the vCD cloud storage policy that you want to apply to VM replicas. Save the result to the $policy variable.
    5. Run Add-VBRvCDCloudReplicaJob with the variables obtained beforehand.

    $vm = Find-VBRViEntity -Name "vCD VM"

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

    $vApp = Get-VBRvCDCloudvApp -OrganizationvDC $vdc

    $policy = Get-VBRvCDCloudStoragePolicy -Name "Silver Policy"

    Add-VBRvCDCloudReplicaJob -Name "ReplicaJob" -Entity $vm -OrganizationvDC $vdc -vApp $vapp -StoragePolicy $policy

    Related Commands

    Find-VBRViEntity

    Get-VBRvCDCloudOrganizationvDC

    Get-VBRvCDCloudvApp

    Get-VBRvCDCloudStoragePolicy