---
title: "Set-VBRUnstructuredBackupArchivalOptions"
description: "This cmdlet modifies settings of a scope of file versions to keep on an archive repository for file backup job or object storage backup job. To modify settings, specify new values for the necessary parameters."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrunstructuredbackuparchivaloptions.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-VBRUnstructuredBackupArchivalOptions"
dateModified: "2026-08-19"
---

# Set-VBRUnstructuredBackupArchivalOptions

## Short Description
Modifies a scope of file versions to keep on an archive repository for file backup job or object storage backup job.

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

## Syntax
```
Set-VBRUnstructuredBackupArchivalOptions -Options <VBRUnstructuredBackupArchivalOptions>
 [-ArchivalType <VBRUnstructuredBackupArchivalType>] [-InclusionMask <String[]>] [-ExclusionMask <String[]>] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings of a scope of file versions to keep on an archive repository for file backup job or object storage backup job.

::: 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">ArchivalType</span></p>
        </td>
        <td>
          <p>Specifies the filter settings for file versions that you want to keep on the archive repository. You can specify one of the following filter settings:</p><ul><li><code>All</code>: use this option if you want to keep all types of file versions on the archive repository.</li><li><code>InclusionMask</code>: use this option if you want to keep only file versions with specific extensions on the archive repository. Use the <code>InclusionMask</code> parameter to specify these extensions.</li><li><code>ExclusionMask</code>: use this option if you do not want to keep file versions with specific extensions on the archive repository. Use the <code>ExclusionMask</code> parameter to specify these extensions.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupArchivalType</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">ExclusionMask</span></p>
        </td>
        <td>
          <p>For the <code>ArchivalType</code> parameter with the <code>ExclusionMask</code> value.</p><p>Specifies a file mask for files and folders that you do not want to add to the file backup job or object storage backup 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">InclusionMask</span></p>
        </td>
        <td>
          <p>For the <code>ArchivalType</code> parameter with the <code>InclusionMask</code> value.</p><p>Specifies a file mask for files and folders that you want to add to the file backup job or object storage backup job. The cmdlet will back up only these files and folders.</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">Options</span></p>
        </td>
        <td>
          <p>Specifies the scope of file versions. The cmdlet will modify this scope.</p><p>Accepts the <code>VBRUnstructuredBackupArchivalOptions</code> object. To create this object, run the <a href="new-vbrunstructuredbackuparchivaloptions.md"><code>New-VBRUnstructuredBackupArchivalOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRUnstructuredBackupArchivalOptions</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>
    </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 `VBRUnstructuredBackupArchivalOptions` object that contains scope settings of files to keep on an archive repository for file backup job or object storage backup job.

## Examples

::: example
### Modifying Scope of File Versions

This example shows how to modify a scope of file versions that are located on an archive repository. The archive repository will have the following file version settings:

- The long-term repository will keep .`DOCX` and .`PDF` file extensions.
- The long-term repository will not keep .`EXE` and `.JPEG`  file extensions.

```
$archiveoptions = New-VBRUnstructuredBackupArchivalOptions -ArchivalType ExclusionMask -ExclusionMask ('*.jpeg', '*.exe')
Set-VBRUnstructuredBackupArchivalOptions -Options $archiveoptions -ArchivalType InclusionMask -InclusionMask ('*.docx', '*.pdf')
```

Perform the following steps:

1. Run the [`New-VBRUnstructuredBackupArchivalOptions`](new-vbrunstructuredbackuparchivaloptions.md) cmdlet. Specify the `ArchivalType` and `ExclusionMask` parameters values. Save the result to the `$archiveoptions` variable.
2. Run the `Set-VBRUnstructuredBackupArchivalOptions` cmdlet. Specify the following settings:

   - Set the `$archiveoptions` variable as the `Options` parameter value.
   - Set the `InclusionMask` as the `ArchivalType` parameter value.
   - Specify the `InclusionMask` parameter value.

:::

## Related Commands

[`New-VBRUnstructuredBackupArchivalOptions`](new-vbrunstructuredbackuparchivaloptions.md)