---
title: "Add-VBRPluginBackupCopyJob"
description: "This cmdlet creates plug-in backup copy jobs. To create plug-in backup copy jobs, you must specify at least one source that contains the data you want to add to the copy job."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbrpluginbackupcopyjob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Copy > Plug-In Backup Copy Job > Add-VBRPluginBackupCopyJob"
dateModified: "2026-08-19"
---

# Add-VBRPluginBackupCopyJob

## Short Description
Creates plug-in backup copy jobs.

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

## Syntax
```
Add-VBRPluginBackupCopyJob -TargetRepository <CBackupRepository> [-Name <String>] [-Description <String>]
 [-SourceJob <VBRPluginBackupJob[]>] [-ExcludedJob <VBRPluginBackupJob[]>]
 [-SourceRepository <CBackupRepository[]>] [-ApplicationDataRetention <Int32>]
 [-NotificationOptions <VBRNotificationOptions>] [-StorageOptions <VBRPluginCopyJobStorageOptions>]
 [-BackupWindowOptions <VBRBackupWindowOptions>] [-RPOWarningOptions <VBRRpoNotificationOption[]>] [-Force] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates plug-in backup copy jobs. To create plug-in backup copy jobs, you must specify at least one source that contains the data you want to add to the copy job. Plug-in backup copy jobs use one of the following sources:

- The existing plug-in backup job created to back up Oracle RMAN or SAP HANA. Run the [`Get-VBRPluginJob`](get-vbrpluginjob.md) cmdlet to get the plug-in backup job.
- Backup files that are stored in the source repositories. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet to get the source repository.

::: note

The backup copy job is created in the disabled state. Run the [`Enable-VBRPluginJob`](enable-vbrpluginjob.md) cmdlet to run the job manually.

:::

## 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">ApplicationDataRetention</span></p>
        </td>
        <td>
          <p>Specifies the number of days. The cmdlet will create a plug-in backup copy job with the specified amount of days.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</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">BackupWindowOptions</span></p>
        </td>
        <td>
          <p>Specifies backup window settings for a job. The cmdlet will create the plug-in backup copy job with these settings.</p><p>Accepts the <a href="vbrbackupwindowoptions.md"><code>VBRBackupWindowOptions</code></a> object. To create this object, run the <a href="new-vbrbackupwindowoptions.md"><code>New-VBRBackupWindowOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrbackupwindowoptions.md"><code>VBRBackupWindowOptions</code></a></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 a description of a plug-in backup copy job. The cmdlet will create the job with this description.</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">ExcludedJob</span></p>
        </td>
        <td>
          <p>Specifies a plug-in backup job that you do not want to process by a plug-in backup copy job. The cmdlet will not add databases processed by this job to the plug-in backup copy job.</p><p>Accepts the <code>VBRPluginBackupJob[]</code> object. To get this object, run the <a href="get-vbrpluginjob.md"><code>Get-VBRPluginJob</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRPluginBackupJob[]</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">Force</span></p>
        </td>
        <td>
          <p>Defines that the job will be created even if the source repository is located in the different geographic location than the target repository.</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 a name of a plug-in backup copy job. The cmdlet will create the job with this name.</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">NotificationOptions</span></p>
        </td>
        <td>
          <p>Specifies notification settings. The cmdlet will create the plug-in backup copy job with these settings.</p><p>Accepts the <code>VBRNotificationOptions</code> object. To create this object, run the <a href="new-vbrnotificationoptions.md"><code>New-VBRNotificationOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrnotificationoptions.md"><code>VBRNotificationOptions</code></a></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">RPOWarningOptions</span></p>
        </td>
        <td>
          <p>Specifies an array of the number of hours when data must be copied from the source repository to the target repository.</p><p>Default: <code>1</code>.</p><p>Accepts the <code>VBRRpoNotificationOption[]</code> object. To create this object, run the <a href="new-vbrrponotificationoption.md"><code>New-VBRRPONotificationOption</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrrponotificationoption.md"><code>VBRRpoNotificationOption[]</code></a></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">SourceJob</span></p>
        </td>
        <td>
          <p>Specifies a plug-in backup job. The cmdlet will add databases processed by this job to the plug-in backup copy job.</p><p>Accepts the <code>VBRPluginBackupJob[]</code> object. To get this object, run the <a href="get-vbrpluginjob.md"><code>Get-VBRPluginJob</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRPluginBackupJob[]</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">SourceRepository</span></p>
        </td>
        <td>
          <p>Specifies a backup repository that contains backups of databases, created by a plug-in backup job. The cmdlet will add backups located on this repository to the plug-in backup copy job.</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">StorageOptions</span></p>
        </td>
        <td>
          <p>Specifies settings for compression and storage optimization of the target backup repository. The cmdlet will create the plug-in backup copy job with these settings.</p><p>Accepts the <code>VBRPluginCopyJobStorageOptions</code> object. To create this object, run the <a href="new-vbrplugincopyjobstorageoptions.md"><code>New-VBRPluginCopyJobStorageOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRPluginCopyJobStorageOptions</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">TargetRepository</span></p>
        </td>
        <td>
          <p>Specifies a target backup repository. The cmdlet will copy plug-in backups to this 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>True</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
The cmdlet returns the `VBRPluginBackupCopyJob` object that contains settings for plug-in backup copy jobs.

## Examples

::: example
### Example 1. Creating Plug-In Backup Copy Job Using Existing Plug-In Backup Job

This example shows how to create a plug-in backup copy job using the existing plug-in backup job.

```
$pluginjob = Get-VBRPluginJob -Name "SAP backint backup 07"
$targetrepository = Get-VBRBackupRepository -Name "TR05"
Add-VBRPluginBackupCopyJob -SourceJob $pluginjob -Name "Plug-in backup 03" -TargetRepository $targetrepository
```

Perform the following steps:

1. Run the [`Get-VBRPluginJob`](get-vbrpluginjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$pluginjob` variable.
2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$targetrepository` variable.
3. Run the `Add-VBRPluginBackupCopyJob` cmdlet. Specify the following settings:

   - Set the `$pluginjob` variable as the `SourceJob` parameter value.
   - Specify the `Name` parameter value.
   - Set the `$targetrepository` as the `TargetRepository` parameter value.

:::

::: example
### Example 2. Creating Plug-In Backup Copy Job Using Source Repository

This example shows how to create a plug-in backup copy job using the source repository.

```
$sourcerepository = Get-VBRBackupRepository -Name "SR09"
$targetrepository = Get-VBRBackupRepository -Name "TR07"
Add-VBRPluginBackupCopyJob -Name "Plug-in backup 05" -SourceRepository $sourcerepository -TargetRepository $targetrepository
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$sourcerepository` variable.
2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$targetrepository` variable.
3. Run the `Add-VBRPluginBackupCopyJob` cmdlet. Specify the following settings:

   - Specify the `Name` parameter value.
   - Set the `$sourcerepository` variable as the `SourceRepository` parameter value.
   - Set the `$targetrepository` as the `TargetRepository` parameter value.

:::

::: example
### Example 3. Creating Plug-In Backup Copy Job Using Job and Source Repository

This example shows how to create a plug-in backup copy job using the existing backup copy job and a source repository.

```
$pluginjob = Get-VBRPluginJob -Name "SAP backint backup 11"
$sourcerepository = Get-VBRBackupRepository -Name "SR013"
$targetrepository = Get-VBRBackupRepository -Name "TR015"
Add-VBRPluginBackupCopyJob -SourceJob $pluginjob -Name "Plug-in backup 17" -SourceRepository $sourcerepository -TargetRepository $targetrepository
```

Perform the following steps:

1. Run the [`Get-VBRPluginJob`](get-vbrpluginjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$pluginjob` variable.
2. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$sourcerepository` variable.
3. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$targetrepository` variable.
4. Run the `Add-VBRPluginBackupCopyJob` cmdlet. Specify the following settings:

   - Set the `$pluginjob` variable as the `SourceJob` parameter value.
   - Specify the `Name` parameter value.
   - Set the `$sourcerepository` variable as the `SourceRepository` parameter value.
   - Set the `$targetrepository` variable as the `TargetRepository` parameter value.

:::

## Related Commands

- [`Get-VBRPluginJob`](get-vbrpluginjob.md)
- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)