---
title: "Set-VBRHistoryOptions"
description: "This cmdlet modifies job sessions history settings. 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-vbrhistoryoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Veeam Backup & Replication Settings > Specifying Session History Settings > Set-VBRHistoryOptions"
dateModified: "2026-08-19"
---

# Set-VBRHistoryOptions

## Short Description
Modifies job sessions history settings.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>KeepAll</code></p>

```
Set-VBRHistoryOptions [-KeepAllSessions] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>RetentionNumber</code></p>

```
Set-VBRHistoryOptions [-RetentionLimitWeeks <Int32>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet modifies job sessions history settings.

::: 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">KeepAllSessions</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup & Replication will not delete the session information from the database.</p><p>Default: <code>False.</code></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">RetentionLimitWeeks</span></p>
        </td>
        <td>
          <p>Specifies a period in weeks. Veeam Backup & Replication will keep the session information from the database for this period of time.</p><p>Default: <code>13.</code></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>
    </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 `VBRHistoryOptions` object that contains job sessions history settings.

## Examples

::: example
### Example 1. Modifying Session History Settings to Keep all Sessions

This command modifies history settings. According to these settings, Veeam Backup & Replication will keep all sessions information in the database.

```
Set-VBRHistoryOptions -KeepAllSessions
KeepAllSessions RetentionLimitWeeks
--------------- -------------------
           True                  -1
```

:::

::: example
### Example 2. Modifying Session History Settings to Keep Sessions for Several Weeks

This command modifies history settings.  According to these settings, Veeam Backup & Replication will keep session information in the database for `7` weeks.

```
Set-VBRHistoryOptions -RetentionLimitWeeks 7
KeepAllSessions RetentionLimitWeeks
--------------  -------------------
         False                    8
```

:::