Add-VBRvCDCloudReplicaJob

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 {Source | Thick | Thin | ThickEagerZeroed}] [-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>][-HighPriority] [<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

Type

Required

Position

Accept
Pipeline
Input

Entity

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

Accepts the IViItem[] object. To get this object, run the Find-VBRViEntity cmdlet.

True

Named

True (ByValue,
ByPropertyName)

OrganizationvDC

Specifies the cloud organization VDC. The job will store the replicas on the selected organization VDC.

Accepts the VBRvCDCloudOrganizationvDC object. To get this object, run the Get-VBRvCDCloudOrganizationvDC cmdlet.

True

Named

True (ByValue,
ByPropertyName)

StoragePolicy

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

Accepts the VBRvCDCloudStoragePolicy object. To get this object, run the Get-VBRvCDCloudStoragePolicy cmdlet.

True

Named

True (ByValue,
ByPropertyName)

Name

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

String

True

Named

False

Description

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

String

True

Named

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 object. To get this object, run the Get-VBRvCDCloudvApp cmdlet.

False

Named

True (ByValue,
ByPropertyName)

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.

String

False

Named

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 object. To get this object, run the Get-VBRBackupRepository cmdlet.

False

Named

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.

Accepts the CBackupRepository[] object. To get this object, run the Get-VBRBackupRepository cmdlet.

False

Named

False

EnableNetworkMapping

Enables network mapping.

Use the following parameters to set the network mapping rules:

  • SourceNetwork
  • TargetNetwork

SwitchParameter

False

Named

False

SourceNetwork

For the network mapping option.

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

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

Accepts the VBRViNetworkInfo object. To get this object, run the Get-VBRViServerNetworkInfo cmdlet.

False

Named

False

TargetNetwork

For the network mapping option.

Specifies the network in the Disaster Recovery site. The replicated VMs will be connected to these networks.

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

Accepts the VBRvCDCloudNetworkInfo object. To get this object, run the Get-VBRvCDCloudNetworkInfo cmdlet.

False

Named

False

SourceProxy

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

Default: Automatic selection

Accepts the CViProxy[] object. To get this object, run the Get-VBRViProxy cmdlet.

False

Named

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.

Accepts the CWanAccelerator object. To get this object, run the Get-VBRWANAccelerator cmdlet.

False

Named

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 thin.

Default: Source.

EDiskCreationMode

False

Named

False

RepositorySeed

For replica seeding.

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

Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

False

Named

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.

Accepts the CViVmItem[] object. To get this object, run the Find-VBRViEntity cmdlet.

False

Named

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 object. To get this object, run the Get-VBRvCDCloudVM cmdlet.

False

Named

False

Force

Defines that the cmdlet will create a job even if the geographic location of the VMs added to the job and the target cloud host location do not match.

SwitchParameter

False

Named

False

HighPriority

Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

CBackupJob

Examples

Creating vCD Cloud Replication Job

This example shows how to create a vCD cloud replication job.

$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

Perform the following steps:

  1. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to $vm variable.
  2. Run the Get-VBRvCDCloudOrganizationvDC cmdlet. Specify the Name parameter value. Save the result to the $vdc variable.
  3. Run the Get-VBRvCDCloudvApp cmdlet. Set the $vdc variable as the OrganizationvDC parameter value. Save the result to the $vApp variable.
  4. Run the Get-VBRvCDCloudStoragePolicy cmdlet. Specify the Name parameter value. Save the result to the $policy variable.
  5. Run the Add-VBRvCDCloudReplicaJob cmdlet. Specify the following settings:
  • Specify the Name parameter value.
  • Set the $vm variable as the Entity parameter value.
  • Set the $vdc variable as the OrganizationvDC parameter value.
  • Set the $vapp variable as the vApp parameter value.
  • Set the $policy variable as the StoragePolicy parameter value.

Related Commands