---
title: "New-VBRUnstructuredBackupArchivalOptions"
description: "This cmdlet defines a scope of file versions backed-up by file backup job or object storage backup job to keep on an archive repository."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-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 > New-VBRUnstructuredBackupArchivalOptions"
dateModified: "2026-08-19"
---

# New-VBRUnstructuredBackupArchivalOptions

## Short Description
Defines 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
```
New-VBRUnstructuredBackupArchivalOptions [-ArchivalType <VBRUnstructuredBackupArchivalType>]
 [-InclusionMask <String[]>] [-ExclusionMask <String[]>] [<CommonParameters>]
```

## Detailed Description
This cmdlet defines a scope of file versions backed-up by file backup job or object storage backup job to keep on an archive repository. You can include all files, define certain files to keep on archive repository or exclude certain files from the repository.

## 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>
    </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
### Example 1. Defining Scope of Files to Keep on Archive Repository

This command defines a scope of file versions to keep on archive repositories. The archive repository will keep only file versions with PDF and DOCX extensions.

```
New-VBRUnstructuredBackupArchivalOptions -ArchivalType InclusionMask -InclusionMask ('*.pdf', '*.docx')
```

:::

::: example
### Example 2. Excluding Files from Backup Scope

This command excludes a scope of file versions. The archive repository will not keep .EXE file extensions.

```
New-VBRUnstructuredBackupArchivalOptions -ArchivalType ExclusionMask -ExclusionMask '*.exe'
```

:::