This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRViCloudReplicaJob
Short Description
Modifies a VMware cloud replication job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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[]>] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet modifies an existing VMware cloud replication job. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Job | Specifies the replication job you want to modify. Accepts CBackupJob object. | True | Named | True (by Value | False |
Name | Specifies the string with the name of the created replication job. If not set, Veeam Backup & Replication will give the default job name. | False | Named | False | False |
Entity | Specifies the VM(s) that you want to replicate. You can assign multiple VMs to this object. | False | Named | True (by ValueFromPipeline | False |
Datastore | Specifies the cloud datastore to which you want to replicate. Accepts the VBRCloudDatastore object. | 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 |
Backup | Specifies the backup repository which will be used to store replica metadata files. If not set, the default backup repository will be used. | False | Named | False | False |
Description | Specifies the description of the new job. If not set, Veeam Backup & Replication will enter date and time of creation by default. | False | Named | False | False |
Enable | 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 |
Source | Used to set the source network for the EnableNetworkMapping parameter. Specifies the production network to which VMs added to the job are connected. Use the TargetNetwork parameter to set the target network. NOTE: the number of the source and the target networks must be the same. | False | Named | False | False |
Target | Used to set the target network for the EnableNetworkMapping parameter. Specifies the network in the DR site to which VM replicas must be connected. Use the SourceNetwork parameter to set the source network. NOTE: the number of the source and the target networks must be the same. | False | Named | False | False |
Source | Specifies the source proxy that will be used by the job. Default: automatic selection. | False | Named | False | False |
Use | 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 |
Source | 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 |
Source | 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 (by Value | False |
EnableVMMapping | Indicates if replica mapping must be used for the replication job. | 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 (by Value | 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 (by Value | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This example shows how to apply custom settings to the cloud replica job named “Cloud Replica Job”.
- Run Get-VBRJob to get the job you want to modify. Save the job to the $job variable.
- Run Get-VBRCloudServer to get the cloud server on which the replica will be created. Save the server to the $cloudServer variable.
- 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.
- Run Set-VBRViCloudReplicaJob to modify the replica job settings. Use the saved variables.
