Set-VBRvCDReplicaJob

Short Description

Modifies vCD replication jobs.

Applies to

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

Syntax

Set-VBRvCDReplicaJob -Job <VBRvCDReplicaJob> [-SourceObject <IVcdItem[]>] [-Name <string>] [-Description <string>] [-ExcludedObject <IVcdItem[]>] [-SourceNetwork <VBRvCDOrgVdcNetworkInfo[]>] [-TargetNetwork <VBRvCDOrgVdcNetworkInfo[]>] [-MetadataRepository <CBackupRepository>] [-Suffix <string>] [-RestorePointsToKeep <int>] [-RepositorySeed <CBackupRepository>] [-OriginalVApp <CVcdVappItem[]>] [-ReplicaVApp <CVcdVappItem[]>] [-GuestProcessingOptions <VBRReplicaApplicationProcessingOptions>] [-SourceProxy <CViProxy[]>] [-TargetProxy <CViProxy[]>] [-SourceWanAccelerator <CWanAccelerator>] [-TargetWanAccelerator <CWanAccelerator>] [-ScheduleOptions   <VBRServerScheduleOptions>] [-CompressionLevel <VBRCompressionLevel> {None | DedupeFriendly | Optimal | High | Extreme}] [-NotificationOptions <VBRNotificationOptions>] [-HighPriority] [<CommonParameters>]

Detailed Description

Modifies vCD replication jobs. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies the vCD replication jobs that you want to modify.

Accepts the VBRvCDReplicaJob object. To create this object, run the Get-VBRvCDReplicaJob cmdlet.

True

Named

True (ByValue)

SourceObject

Specifies an array of vApps that you want to replicate.

Accepts the IVcdItem[] object. To create this object, run the Find-VBRvCloudEntity cmdlet.

False

Named

True (ByValue, ByPropertyName)

Name

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

String

False

Named

False

Description

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

String

False

Named

False

ExcludedObject

Specifies an array of VM containers that you want to exclude from the vDC replication job. You can exclude the following types of vCloud source objects:

  • Organization
  • Organization VDC
  • vApp

Accepts the IVcdItem[] object. To create this object, run the Find-VBRvCloudEntity cmdlet.

False

Named

False

EnableNetworkMapping

Enables network mapping.

SwitchParameter

False

Named

False

SourceNetwork

For the network mapping option.

Specifies an 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 VBRvCDOrgVdcNetworkInfo[] object. To create this object, run the Get-VBRVCDOrgVdcNetworkInfo 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 VBRvCDOrgVdcNetworkInfo[] object. To create this object, run the Get-VBRVCDOrgVdcNetworkInfo cmdlet.

False

Named

False

MetadataRepository

Specifies a backup repository that will store metadata for vDC replicas.

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

False

Named

False

Suffix

Specifies the suffix that the cmdlet will add to the name of vDC replicas.

Default: "_replica".

String

False

Named

False

RestorePointsToKeep

Specifies a number of restore points you want to keep for of vDC replicas.

Permitted values: 1 to 28.

Default: 7.

Int

False

Named

False

EnableInitialSeeding

Enables replica seeding.

SwitchParameter

False

Named

False

RepositorySeed

For replica seeding.

Specifies the backup repository that keeps a full backup of a VM that you want to replicate.

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

False

Named

False

EnableReplicaMapping

Enables replica mapping.

SwitchParameter

False

Named

False

OriginalVApp

For replica mapping.

Specifies a production vApp that you want to replicate using replica mapping.

The vDC replication job will map this vApp to the vApp on the disaster recovery site.

Use the ReplicaVApp parameter to specify the vApp on the disaster recovery site.

Accepts the CVcdVappItem[] object. To create this object, run the Find-VBRvCloudEntity cmdlet.

False

Named

False

ReplicaVApp

For replica mapping.

Specifies a vApp on the disaster recovery site. The cmdlet will map the production vApp to this vApp, and the vDC replication job will replicate data to this vApp.

Use the OriginalVApp parameter to specify the production vApp.

Accepts the CVcdVappItem[] object. To create this object, run the Find-VBRvCloudEntity cmdlet.

False

Named

False

EnableGuestProcessing

Enables guest processing options.

SwitchParameter

False

Named

False

GuestProcessingOptions

Specifies guest processing options of a vDC replication job.

Accepts the VBRReplicaApplicationProcessingOptions object. To create this object, run the New-VBRReplicaApplicationProcessingOptions cmdlet.

False

Named

False

SourceProxy

Specifies an array of the source proxies. The cmdlet will assign these proxies to the vDC replication job.

Default: Automatic selection.

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

False

Named

False

TargetProxy

Specifies an array of the target proxies. The cmdlet will assign these proxies to the vDC replication job.

Default: Automatic selection.

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

False

Named

False

EnableWanAccelerators

Enables the WAN accelerator option.

SwitchParameter

False

Named

False

SourceWanAccelerator

Specifies the WAN accelerator configured in the source site. The cmdlet will use this WAN accelerator data transfer.

Default: Not set.

CWanAccelerator

False

Named

False

TargetWanAccelerator

Specifies the WAN accelerator configured in the target site. The cmdlet will use this WAN accelerator data transfer.

Default: Not set.

CWanAccelerator

False

Named

False

EnableScheduleOptions

Enables schedule for a vDC replication job.

SwitchParameter

False

Named

False

ScheduleOptions

Specifies a schedule for a vDC replication job.

Accepts the VBRServerScheduleOptions object. To get this object, run the New-VBRServerScheduleOptions cmdlet.

False

Named

False

CompressionLevel

Specifies the compression level of the replicated data:

  • None: use this option if you do not want to enable data compression.
  • Dedupe-friendly: use this option to set a dedupe-friendly compression level.
  • Optimal: use this option to set an optimal compression level.
  • High: use this option to set a high compression level.
  • Extreme: use this option to set an extreme compression level.

Default: Optimal.

VBRCompressionLevel

False

Named

False

NotificationOptions

Specifies notification options of a vDC replication job.

Accepts the VBRNotificationOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet.

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.

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.

Output Object

The cmdlet returns the VBRvCDReplicaJob object that defines settings of the vDC replication jobs.

Examples

Modifying vDC Replicas Metadata Repository

This example shows how to assign the Repository08 metadata repository to the Win20049 vDC replication job.

$job = Get-VBRvCDReplicaJob -Name "Win20049"

$repository = Get-VBRBackupRepository -Name "Repository08"

Set-VBRvCDReplicaJob -Job $job -MetadataRepository $repository

Perform the following steps:

  1. Run the Get-VBRvCDReplicaJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  3. Run the Set-VBRvCDReplicaJob cmdlet. Set the $job variable as the Job parameter value. Set the $repository variable as the MetadataRepository parameter value.

Related Commands