---
title: "Set-VBRPluginBackupCopyJob"
description: "This example modifies plug-in backup copy jobs. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrpluginbackupcopyjob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Copy > Plug-In Backup Copy Job > Set-VBRPluginBackupCopyJob"
dateModified: "2026-08-19"
---

# Set-VBRPluginBackupCopyJob

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

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

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

## Detailed Description
This example modifies plug-in backup copy jobs.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## 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">AnyTime</span></p>
        </td>
        <td>
          <p>Defines that the job will run continuously. If you provide this parameter, the job will run at any time. Otherwise, the job will run only during permitted hours.</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">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 modify 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 assign this description to the 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">ExcludedJob</span></p>
        </td>
        <td>
          <p>Specifies an array of plug-in backup jobs that you do not want to process by a plug-in backup copy job. The cmdlet will replace an existing list of excluded plug-in backup jobs with the array of specified excluded plug-in backup jobs.</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 on the different from the target repository host.</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">Job</span></p>
        </td>
        <td>
          <p>Specifies a plug-in backup copy job. The cmdlet will modify this job.</p><p>Accepts the <code>VBRPluginBackupCopyJob</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>VBRPluginBackupCopyJob</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">Name</span></p>
        </td>
        <td>
          <p>Specifies a name of a plug-in backup copy job. The cmdlet will assign this name to the 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">NotificationOptions</span></p>
        </td>
        <td>
          <p>Specifies notification settings. The cmdlet will modify a plug-in backup 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-VBRRPONotificationOptions</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 replace the existing source plug-in backup job with the specified plug-in backup 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 replace the existing source repository with the specified 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">StorageOptions</span></p>
        </td>
        <td>
          <p>Specifies settings for compression and storage optimization of the target backup repository. The cmdlet will modify a plug-in backup 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>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
The cmdlet returns the `VBRPluginBackupCopyJob` object that contains settings for plug-in backup copy jobs.

## Examples

::: example
### Example 1. Modifying Target Repository of Plug-In Backup Copy Job

This example shows how to change the target repository for a plug-in backup copy job.

```
$pluginjob = Get-VBRPluginJob -Name "Plug-in backup 04"
$targetrepository = Get-VBRBackupRepository -Name "TR08"
Set-VBRPluginBackupCopyJob -Job $pluginjob -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 `Set-VBRPluginBackupCopyJob` cmdlet. Set the `$pluginjob` variable as the `Job` parameter value. Set the `$targetrepository` variable as the `TargetRepository` parameter value.

:::

::: example
### Example 2. Excluding Jobs from Plug-In Backup Copy Job

This example shows how to exclude the `SAP backint backup 09` plug-in backup job from processing by the `Plug-in backup 09` plug-in backup copy job.

```
$pluginjob = Get-VBRPluginJob -Name "Plug-in backup 09"
$excludedjob = Get-VBRPluginJob -Name "SAP backint backup 09"
Set-VBRPluginBackupCopyJob -Job $pluginjob -ExcludedJob $excludedjob
```

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-VBRPluginJob`](get-vbrpluginjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$excludedjob` variable.
3. Run the `Set-VBRPluginBackupCopyJob` cmdlet. Set the `$pluginjob` variable as the `Job` parameter value. Set the `$excludedjob` variable as the `ExcludedJob` parameter value.

:::

::: example
### Example 3. Modifying Storage Optimization Settings of Plug-In Backup Copy Job

This example shows how to modify storage optimization settings for a plug-in backup copy job. The plug-in backup copy job will run with the following storage optimization settings:

- The compression level is set to optimal.
- The backup target storage type is set to `LocalTarget`.

```
$pluginjob = Get-VBRPluginJob -Name "Plug-in backup 09"
$storage = New-VBRPluginCopyJobStorageOptions -CompressionLevel Optimal -StorageOptimizationType LocalTarget
Set-VBRPluginBackupCopyJob -Job $pluginjob -StorageOptions $storage
```

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 [`New-VBRPluginCopyJobStorageOptions`](new-vbrplugincopyjobstorageoptions.md) cmdlet. Set the `Optimal` value for the `CompressionLevel` parameter. Set the `LocalTarget` option for the `StorageOptimizationType` parameter.
3. Run the `Set-VBRPluginBackupCopyJob` cmdlet. Set the `$pluginjob` variable as the `Job` parameter value. Set the `$storage` variable as the `StorageOptions` parameter value.

:::

## Related Commands

- [`Get-VBRPluginJob`](get-vbrpluginjob.md)
- [`New-VBRPluginCopyJobStorageOptions`](new-vbrplugincopyjobstorageoptions.md)