---
title: "Set-VBRUnstructuredBackupSecondaryTarget"
description: "This cmdlet modifies settings of secondary backup repositories. These repositories will keep copies of backup files that were created by file backup jobs and object storage backup jobs."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrunstructuredbackupsecondarytarget.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Unstructured Data Backup > Working with Unstructured Data Source Jobs > Managing Backup Jobs for Protecting Unstructured Data > Set-VBRUnstructuredBackupSecondaryTarget"
dateModified: "2026-08-19"
---

# Set-VBRUnstructuredBackupSecondaryTarget

## Short Description
Modifies settings of secondary backup repositories.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>AllParameterSets (Default)</code></p>

```
Set-VBRUnstructuredBackupSecondaryTarget -SecondaryTarget <VBRUnstructuredBackupSecondaryTarget>
 [-BackupRepository <CBackupRepository>] [-EnableCustomRetention]
 [-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>]
 [-UseCustomEncryptionKey] [-EnableBackupWindow] [-BackupWindow <VBRBackupWindowOptions>]
 [-GfsPolicyOptions <VBRComputerGFSOptions>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>EncryptionKey</code></p>

```
Set-VBRUnstructuredBackupSecondaryTarget -SecondaryTarget <VBRUnstructuredBackupSecondaryTarget>
 [-BackupRepository <CBackupRepository>] [-EnableCustomRetention]
 [-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>]
 [-UseCustomEncryptionKey] [-CustomEncryptionKey <VBREncryptionKey>] [-EnableBackupWindow]
 [-BackupWindow <VBRBackupWindowOptions>] [-GfsPolicyOptions <VBRComputerGFSOptions>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>KmsServer</code></p>

```
Set-VBRUnstructuredBackupSecondaryTarget -SecondaryTarget <VBRUnstructuredBackupSecondaryTarget>
 [-BackupRepository <CBackupRepository>] [-EnableCustomRetention]
 [-CustomRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-CustomRetentionPeriod <Int32>]
 [-UseCustomEncryptionKey] [-CustomKMSServer <VBRKMSServer>] [-EnableBackupWindow]
 [-BackupWindow <VBRBackupWindowOptions>] [-GfsPolicyOptions <VBRComputerGFSOptions>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet modifies settings of secondary backup repositories. These repositories will keep copies of backup files that were created by file backup jobs and object storage backup 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">BackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the backup repository that you want to add as a secondary backup repository to a file backup job or an object storage 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">BackupWindow</span></p>
        </td>
        <td>
          <p>Specifies backup window settings. Veeam Backup & Replication will create copies of backups that were created by file backup jobs or object storage jobs according to these settings.</p><p>Accepts the <a href="vbrbackupwindowoptions.md"><code>VBRBackupWindowOptions</code></a> object. To get 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">CustomEncryptionKey</span></p>
        </td>
        <td>
          <p>Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt data that is stored on the secondary repository.</p><p><strong>Note</strong>: If you do not specify this parameter, Veeam Backup & Replication will apply an encryption key that is set for file backup jobs or object storage jobs.</p><p>Accepts the <code>VBREncryptionKey</code> object. To get this object, run the <a href="get-vbrencryptionkey.md"><code>Get-VBREncryptionKey</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBREncryptionKey</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">CustomKMSServer</span></p>
        </td>
        <td>
          <p>Specifies a KMS server. Veeam Backup & Replication will use keys generated by this KMS server to encrypt data that is stored on the secondary repository.</p><p><strong>Note</strong>: If you do not specify this parameter, Veeam Backup & Replication will use the KMS server that is set to the file backup job or an object storage job.</p><p>Accepts the <code>VBRKMSServer</code> object. To get this object, run the <a href="get-vbrkmsserver.md"><code>Get-VBRKMSServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrkmsserver.md"><code>VBRKMSServer</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">CustomRetentionPeriod</span></p>
        </td>
        <td>
          <p>For the <code>ShortTermRetentionType</code> option.</p><p>Specifies the period of time to keep data on the secondary repository. When this period is passed, Veeam Backup & Replication will move data to the long-term repository.</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">CustomRetentionType</span></p>
        </td>
        <td>
          <p>Specifies a retention policy for the secondary repository. You can set retention policy to either of the following periods:</p><ul><li><code>Daily:</code> use this option if you want Veeam Backup & Replication to apply retention policy daily.</li><li><code>Monthly:</code> use this option if you want Veeam Backup & Replication to apply retention policy monthly.</li></ul><p>Use the <code>ShortTermRetentionPeriod</code> to specify the number of days or months.</p><p><strong>Note</strong>: If you do not specify this parameter, Veeam Backup & Replication will apply the retention policy of file backup jobs or object storage jobs to the secondary repository.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupShortTermRetentionType</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">EnableBackupWindow</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the backup window option.</p><p>If you provide this parameter, Veeam Backup & Replication will create copies of backups that were created by file backup jobs or object storage jobs according to these settings.</p><p>Otherwise, Veeam Backup & Replication will copy data to the repository continuously.</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">EnableCustomRetention</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the custom retention policy.</p><p>If you provide this parameter, Veeam Backup & Replication will apply this policy for backups located on the secondary backup repository. Otherwise, Veeam Backup & Replication will apply the retention policy of file backup jobs or object storage jobs to the secondary 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">GfsPolicyOptions</span></p>
        </td>
        <td>
          <p>Specifies a GFS retention policy for the secondary repository.</p><p>Accepts the <code>VBRComputerGFSOptions</code> object. To create this object, run the <a href="new-vbrcomputergfsoptions.md"><code>New-VBRComputerGFSOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSOptions</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">SecondaryTarget</span></p>
        </td>
        <td>
          <p>Specifies the secondary backup repository. The cmdlet will modify this repository.</p><p>Accepts the <code>VBRUnstructuredBackupSecondaryTarget</code> object. To create this object, run the <a href="new-vbrunstructuredbackupsecondarytarget.md"><code>New-VBRUnstructuredBackupSecondaryTarget</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupSecondaryTarget</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">UseCustomEncryptionKey</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the use of custom data encryption settings.</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>
    </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 `VBRUnstructuredBackupSecondaryTarget` object that contains settings secondary backup repositories.

## Examples

::: example
### Example 1. Enabling Custom Retention Policy

This example shows how to enable custom retention policy for the `SecondaryBackupRepository08` secondary backup repository. The custom retention policy will be enabled with the following settings:

- Veeam Backup & Replication will apply retention policy daily.
- Veeam Backup & Replication will keep data on the secondary repository for 7 days.

```
$repository = Get-VBRBackupRepository -Name "SecondaryBackupRepository08"
Set-VBRUnstructuredBackupSecondaryTarget -SecondaryTarget $repository -EnableCustomRetention -CustomRetentionType Daily -CustomRetentionPeriod 7
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the `Set-VBRUnstructuredBackupSecondaryTarget` cmdlet. Specify the following settings:

   - Set the `$repository` variable as the `SecondaryTarget` parameter value.
   - Provide the `EnableCustomRetention` parameter value.
   - Set the `Daily` option for the `CustomRetentionType` parameter.
   - Specify the `CustomRetentionPeriod` parameter value.

:::

::: example
### Example 2. Enabling Custom Encryption Key

This example shows how to enable custom encryption key for the `SecondaryBackupRepository08` secondary backup repository.

```
$repository = Get-VBRBackupRepository -Name "SecondaryBackupRepository08"
$key = Get-VBREncryptionKey -Description "KeyForEncryption"
Set-VBRUnstructuredBackupSecondaryTarget -SecondaryTarget $repository -UseCustomEncryptionKey -CustomEncryptionKey $key
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the `Get-VBREncryptionKey` cmdlet. Specify the `Description` parameter value. Save the result to the `$key` variable.
3. Run the `Set-VBRUnstructuredBackupSecondaryTarget` cmdlet. Specify the following settings:

   - Set the `$repository` as the `SecondaryTarget` parameter value.
   - Provide the `UseCustomEncryptionKey` parameter.
   - Set the `$key` variable as the `CustomEncryptionKey` parameter value.

:::

## Related Commands

- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`Get-VBREncryptionKey`](get-vbrencryptionkey.md)
- [`New-VBRUnstructuredBackupSecondaryTarget`](new-vbrunstructuredbackupsecondarytarget.md)