---
title: "Set-VBRNASBackupArchivalOptions (obsolete)"
description: "This cmdlet modifies settings of retention policy for file versions that are kept on the long-term repository. To modify settings, specify new values for the necessary parameters."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrnasbackuparchivaloptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Obsolete Cmdlets > Set-VBRNASBackupArchivalOptions (obsolete)"
dateModified: "2026-08-19"
---

# Set-VBRMySQLProcessingOptions

## Short Description
Modifies retention policy for file versions.

::: note

This cmdlet is obsolete. Run the [`Set-VBRUnstructuredBackupArchivalOptions`](new-vbrunstructuredbackuparchivaloptions.md) cmdlet instead.

:::

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

## Syntax

This cmdlet provides the following parameter sets:

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

```
Set-VBRMySQLProcessingOptions -Options <VBRMySQLProcessingOptions> [-Credentials <CCredentials>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>PasswordFilePath</code></p>

```
Set-VBRMySQLProcessingOptions -Options <VBRMySQLProcessingOptions> [-PasswordFilePath <String>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet modifies settings of retention policy for file versions that are kept on the long-term repository.

::: 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">Credentials</span></p>
        </td>
        <td>
          <p>Specifies the MySQL credentials that Veeam Agent will use to connect to the MySQL Server. Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CCredentials</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 retention policy for file versions. The cmdlet will modify the settings of this policy.</p><p>Accepts the <code>VBRNASBackupArchivalOptions</code> object. To create this object, run the <a href="new-vbrnasbackuparchivaloptions.md"><code>New-VBRNASBackupArchivalOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRMySQLProcessingOptions</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 (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PasswordFilePath</span></p>
        </td>
        <td>
          <p>Specifies the absolute path for the password file. Veeam Agent will use this password file to connect to the MySQL Server. Default: /root/.my.cnf.</p><p>Note:</p><ul><li>Start the absolute path with the / symbol. · The cmdlet will return an error if you provide this parameter when the Credentials parameter is already specified.</li></ul>
        </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
[`VBRNASBackupArchivalOptions`](vbrnasbackuparchivaloptions.md)

## Examples

::: example
### Modifying Filter Settings of Retention Policy for Deleted File Versions

This example shows how to modify filter settings of the retention policy for deleted file versions. The retention policy will have the following 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-VBRNASBackupArchivalOptions -ArchivalType ExclusionMask -ExclusionMask ('*.jpeg', '*.exe')
$newArchiveOptions = Set-VBRNASBackupArchivalOptions -Options $archiveOptions -ArchivalType InclusionMask -InclusionMask ('*.docx', '*.pdf')
```

Perform the following steps:

1. Run the [`New-VBRNASBackupArchivalOptions`](new-vbrnasbackuparchivaloptions.md) cmdlet. Specify the `ExclusionMask` parameter value. Save the result to the `$archiveOptions` variable.
2. Run the `Set-VBRNASBackupArchivalOptions` 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.
   - Save the result to the `$newArchiveOptions` variable to be used with other cmdlets.

:::

## Related Commands

[`New-VBRNASBackupArchivalOptions`](new-vbrnasbackuparchivaloptions.md)