---
title: "Add-VBRHvReplicaJob"
description: "Creates Hyper-V replication jobs. Platform: Hyper-V For VMware, run the Add-VBRViReplicaJobCreates VMware replication jobs. cmdlet."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbrhvreplicajob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Replication > Replication Jobs > Add-VBRHvReplicaJob"
dateModified: "2026-08-19"
---

# Add-VBRHvReplicaJob

## Short Description
Creates Hyper-V replication jobs.

**Platform**: Hyper-V

For VMware, run the [`Add-VBRViReplicaJob`](add-vbrvireplicajob.md) cmdlet.

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

## Syntax
```
Add-VBRHvReplicaJob [-Name <String>] -Server <CHost> [-Path <String>] -Entity <IHvItem[]> [-Suffix <String>]
 [-Description <String>] [-SourceRepository <CBackupRepository[]>] [-BackupRepository <CBackupRepository>]
 [-ReIpRule <IHvReIpRule[]>] [-RepositorySeed <CBackupRepository>] [-OriginalVM <CHvVmItem[]>]
 [-ReplicaVM <CHvVmItem[]>] [-Force] [-HighPriority] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates a new Hyper-V replication job.

You can select a data source from which VM data must be read:

- Actual VM: Veeam Backup & Replication will copy an actual VM from production storage. The created replica will mirror an actual VM state.

  Use the `Entity` parameter to indicate the VMs you want to replicate.

- Replica from backup files:  Veeam Backup & Replication will build a replica from backup files stored in a backup repository. The created replica will be in the latest state the VM is available in backups.

  Use the `Entity` parameter to indicate the VMs you want to replicate and the `BackupRepository` parameter to set the repository from where the backup files must be read.

Note that when you create a replica job, you need to run it manually unless you enable a job schedule.

Run the [`Start-VBRJob`](start-vbrjob.md) cmdlet to start the created job manually.

Run the [`Set-VBRJobSchedule`](set-vbrjobschedule.md) cmdlet to set schedule for the job and run it automatically.

::: note

The cmdlet will not run if the geographic location of the VMs added to the job and the job target repository location do not match. If you still want to run the cmdlet, use the `Force` parameter.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the backup repository that will be used to store replica metadata files.</p><p>Default: default backup repository.</p><p>Accepts the <code>CBackupRepository</code> object. To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies the description of the replication job.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Entity</span></p>
        </td>
        <td>
          <p>Specifies the array of VMs you want to add to this job.</p><p>Accepts the <code>IHvItem[]</code> object. To get this object, run the <a href="find-vbrhventity.md"><code>Find-VBRHvEntity</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>IHvItem[]</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will create a job even if the geographic location of the VMs added to the job and the target host location do not match.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">HighPriority</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies the name you want to assign to the replication job.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">OriginalVM</span></p>
        </td>
        <td>
          <p>For replica mapping.</p><p>Specifies the production VM you want to replicate using replica mapping.</p><p>The replication job will map this VM to a selected replica VM on the DR site.</p><p>Use the <code>ReplicaVM</code> parameter to specify the replica VM on the DR site.</p><p>Accepts the <code>CHvVmItem[]</code> object. To get this object, run the <a href="find-vbrhventity.md"><code>Find-VBRHvEntity</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHvVmItem[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Path</span></p>
        </td>
        <td>
          <p>Specifies the Hyper-V volume where the created replica will be stored.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ReIpRule</span></p>
        </td>
        <td>
          <p>Specifies the re-IP rules.</p><p>Accepts the <a href="vbrhvreplicareiprule.md"><code>VBRHvReplicaReIpRule</code></a> or <a href="vbrhvreplicareipipv6rule.md"><code>VBRHvReplicaReIpIPv6Rule</code></a> object. To get this object, run the <a href="get-vbrhvreplicareiprule.md"><code>Get-VBRHvReplicaReIpRule</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>IHvReIpRule[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ReplicaVM</span></p>
        </td>
        <td>
          <p>For replica mapping.</p><p>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.</p><p>Use the <code>OriginalVM</code> parameter to specify the production VM.</p><p>Accepts the <code>CHvVmItem[]</code> object. To get this object, run the <a href="find-vbrhventity.md"><code>Find-VBRHvEntity</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHvVmItem[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">RepositorySeed</span></p>
        </td>
        <td>
          <p>For replica seeding.</p><p>Specifies the backup repository where the seed (the full backup) resides.</p><p>Accepts the <code>CBackupRepository</code> object. To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Server</span></p>
        </td>
        <td>
          <p>Specifies the target Hyper-V host where the created replica will be stored.</p><p>Accepts the <code>CHost</code> object. To get this object, run the <a href="get-vbrserver.md"><code>Get-VBRServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHost</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SourceRepository</span></p>
        </td>
        <td>
          <p>For building replica from backup files.</p><p>Specifies the backup repository that will be used to read the VM data from the already existing backup chain.</p><p>You cannot specify cloud repository.</p><p>Accepts the <code>CBackupRepository[]</code> object. To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Suffix</span></p>
        </td>
        <td>
          <p>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.</p><p>Default: "_replica".</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
`CBackupJob`

## Examples

::: example
### Example 1. Creating VM Replica from Production Storage

This example shows how to create a VM replica from a production storage.

```
$entity = Find-VBRHvEntity -Name "sql02"
$targetserver = Get-VBRServer -Type HvServer -Name "Hv_Server"
Add-VBRHvReplicaJob -Name "SQL02 Replica job" -Entity $entity -Server $targetserver -Path "c:\Replicas" -Suffix "_replicated" -Description "SQL02 replication"
```

Perform the following steps:

1. Run the [`Find-VBRHvEntity`](find-vbrhventity.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$entity` variable.
2. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Set the `HvServer` value as the `Type` parameter value. Specify the `Name` parameter value. Save it to the `$targetserver` variable.
3. Run the `Add-VBRHvReplicaJob` cmdlet. Specify the following settings:

   - Specify the `Name` parameter value.
   - Set the `$entity` variable as the `Entity` parameter value.
   - Set the `$targetserver` variable as the `Server` parameter value.
   - Specify the `Path` parameter value.
   - Specify the `Suffix` parameter value.
   - Specify the `Description` parameter value.

:::

::: example
### Example 2. Creating VM Replica from Backup Files

This example shows how to create a VM replica from backup files.

```
$sql02 = Find-VBRHvEntity -Name "HvExchange"
$targetserver = Get-VBRServer -Type HvServer -Name "Hv_Server"
$repository = Get-VBRBackupRepository -Name "Backups Vol2"
Add-VBRHvReplicaJob -Name "SQL02 Replica job" -Server $targetserver -Path "c:\Replicas" -Entity $sql02 -Description "SQL02 replication" -SourceRepository $repository
```

Perform the following steps:

1. Run the [`Find-VBRHvEntity`](find-vbrhventity.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$sql02` variable.
2. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Set the `HvServer` value as the `Type` parameter value. Specify the `Name` parameter value. Save it to the `$targetserver` variable.
3. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save it to the `$repository` variable.
4. Run the `Add-VBRHvReplicaJob` cmdlet. Specify the following settings:

   - Specify the `Name` parameter value.
   - Set the `$targetserver` variable as the `Server` parameter value.
   - Specify the `Path` parameter value.
   - Set the `$sql02` variable as the `Entity` parameter value.
   - Specify the `Description` parameter value.
   - Set the `$repository` variable as the `SourceRepository` parameter value.

:::

## Related Commands

- [`Get-VBRServer`](get-vbrserver.md)
- [`Find-VBRHvEntity`](find-vbrhventity.md)
- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`Get-VBRLocation`](get-vbrlocation.md)