---
title: "New-VBRBackupCacheOptions"
description: "Defines backup cache settings for Veeam Agent for Microsoft Windows backup jobs. This cmdlet creates the VBRBackupCacheOptions object."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrbackupcacheoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Agent Management > Working with Veeam Agent Backup Jobs and Policies > Veeam Agent Job Advanced Settings > New-VBRBackupCacheOptions"
dateModified: "2026-08-19"
---

# New-VBRBackupCacheOptions

## Short Description
Defines backup cache settings for Veeam Agent for Microsoft Windows backup jobs.

## Syntax
```
New-VBRBackupCacheOptions [-Enable] [-Type <VBRBackupCacheSelectionType>] [-LocalPath <String>]
 [-SizeLimit <Int32>] [-SizeUnit <VBRBackupCacheSizeUnit>] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates the `VBRBackupCacheOptions` object. This object defines backup cache settings that you can apply to backup jobs created by Veeam Agent for Microsoft Windows.

::: important

You can apply backup cache settings to Veeam Agent backup jobs that are targeted at the following types of backup location:

- Veeam backup repository.
- Veeam Cloud Connect 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">Enable</span></p>
        </td>
        <td>
          <p>Defines that the backup cache option is enabled.</p><p>If you provide this parameter, backup files will remain in the cache of the protected computers until these computers are able to connect to Veeam Backup & Replication.</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">LocalPath</span></p>
        </td>
        <td>
          <p>For the <code>Manual</code> option of the <code>Type</code> parameter.</p><p>Specifies a path to the folder on a protected computer. The cmdlet will keep the cached data in the specified folder.</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">SizeLimit</span></p>
        </td>
        <td>
          <p>Specifies a size limit of a backup cache file in numbers. Veeam Agent Backup jobs will not add new backup cache files when this limit is exceeded.</p><p>Provide the <code>SizeUnit</code> parameter to specify the unit of measure.</p><p>Default: <code>10</code>.</p><p><strong>Note</strong>: To run the script, you must provide this parameter.</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">SizeUnit</span></p>
        </td>
        <td>
          <p>For the <code>SizeLimit</code> option.</p><p>Specifies the measure unit of a backup cache size limit. You can specify one of the following units:</p><ul><li><code>GB</code></li><li><code>TB</code></li></ul><p>Default: <code>GB</code>.</p><p><strong>Note</strong>: To run the script, you must provide this parameter.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRBackupCacheSizeUnit</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">Type</span></p>
        </td>
        <td>
          <p>Specifies how to choose the location to keep cached data. You can specify one of the following options:</p><ul><li><code>Automatic</code>: use this option if you want Veeam Agent automatically define location for the backup cache on on each computer added to the backup policy.</li><li><code>Manual</code>: use this option if you want explicitly define the location to keep cached data on every computer. Provide the <code>LocalPath</code> parameter to specify a path to the folder where the cached data must be stored.</li></ul><p>Default: <code>Automatic</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRBackupCacheSelectionType</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
This cmdlet returns the `VBRBackupCacheOptions` object that contains backup cache settings.

## Examples

::: example
### Example 1. Defining Backup Cache Settings with Automatic Location Option

This command defines the following backup cache settings:

- Veeam Backup & Replication will select the location to keep the backup cache automatically.
- Veeam Agent Backup jobs will not create backup cache files when the backup cache exceeds 5 GB.

```
New-VBRBackupCacheOptions -Enable -Type Automatic -SizeLimit 5 -SizeUnit GB
```

:::

::: example
### Example 2. Defining Backup Cache Settings with Manual Location Option

This command defines the following backup cache settings:

- The location to keep backup cache is specified explicitly.
- Veeam Backup & Replication will keep cache in the `C:\Backup` folder on the protected computer.
- Veeam Agent Backup jobs will not create backup cache files when the backup cache exceeds 10 TB.

```
New-VBRBackupCacheOptions -Enable -Type Manual -LocalPath "C:\Backup" -SizeLimit 10 -SizeUnit TB
```

:::