---
title: "Set-VBRConfigurationBackupJob"
description: "This cmdlet modifies settings of the configuration backup job. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrconfigurationbackupjob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Configuration Backup > Set-VBRConfigurationBackupJob"
dateModified: "2026-08-19"
---

# Set-VBRConfigurationBackupJob

## Short Description
Modifies the configuration backup job.

**Platform**: VMware, Hyper-V

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

## Syntax
```
Set-VBRConfigurationBackupJob [-Enable] [-Repository <CBackupRepository>]
 [-ScheduleOptions <VBRConfigurationBackupScheduleOptions>] [-RestorePointsToKeep <Int32>] [-EnableEncryption]
 [-EncryptionKey <VBREncryptionKey>] [-NotificationOptions <VBRNotificationOptions>] [-PassThru] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings of the configuration 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">Enable</span></p>
        </td>
        <td>
          <p>Defines that the job will run automatically on schedule.</p><p>If set to <code>$False</code>, you will need to run the job manually.</p><p>Default: <code>True</code>.</p><p><strong>Note</strong>: To disable the configuration job schedule, specify the <code>$false</code> value for the <code>Enable</code> parameter.</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">EnableEncryption</span></p>
        </td>
        <td>
          <p>If set to <code>true</code>, the configuration backup will be encrypted.</p><p>Use the <code>EncryptionKey</code> parameter to specify the encryption key.</p><p><strong>Note</strong>: if you have created at least one password in the Password Manager on the backup server, you must enable encryption for the configuration backup.</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">EncryptionKey</span></p>
        </td>
        <td>
          <p>Used to set the encryption key for the <code>EnableEncryption</code> parameter.</p><p>Specifies the encryption key you want to use to encrypt the data.</p><p>Accepts the <a href="pscryptokey.md"><code>VBREncryptionKey</code></a> object. To get this object, run the <a href="get-vbrencryptionkey.md"><code>Get-VBREncryptionKey</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBREncryptionKey</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">NotificationOptions</span></p>
        </td>
        <td>
          <p>Specifies email notification options for the configuration backup job.</p><p>Accepts the <a href="vbrnotificationoptions.md"><code>VBRNotificationOptions</code></a> object. Run the <a href="new-vbrnotificationoptions.md"><code>New-VBRNotificationOptions</code></a> cmdlet to create this object.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrnotificationoptions.md"><code>VBRNotificationOptions</code></a></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">PassThru</span></p>
        </td>
        <td>
          <p>Defines that the command returns the output object to the Windows PowerShell console.</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">Repository</span></p>
        </td>
        <td>
          <p>Specifies the backup repository where you want to store the configuration backups.</p><p>You cannot specify a cloud repository that is created on base of scale-out backup repository.</p><p>Accepts the <code>CBackupRepository</code> object or string (repository name). To get this object, run the <a href="get-vbrbackuprepository.md"><code>Get-VBRBackupRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackupRepository</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">RestorePointsToKeep</span></p>
        </td>
        <td>
          <p>Specifies the number of restore points you want to keep on disk.</p><p>You can set <code>1</code> to <code>255</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>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ScheduleOptions</span></p>
        </td>
        <td>
          <p>Specifies the schedule for the configuration backup job.</p><p>Accepts the <a href="vbrconfigurationbackupscheduleoptions.md"><code>VBRConfigurationBackupScheduleOptions</code></a> object. To get this object, run the <a href="new-vbrconfigurationbackupscheduleoptions.md"><code>New-VBRConfigurationBackupScheduleOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrconfigurationbackupscheduleoptions.md"><code>VBRConfigurationBackupScheduleOptions</code></a></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
[`VBRConfigurationBackupJob`](vbrconfigurationbackupjob.md)

## Examples

::: example
### Example 1. Disabling Configuration Backup Job

This command disables the configuration backup job.

```
Set-VBRConfigurationBackupJob -Enable:$False
```

:::

::: example
### Example 2. Modifying Configuration Backup Schedule and Enabling Encryption

This command modifies the configuration backup schedule and enables encryption. The job is set to run at 00:00 every Saturday.

```
$daily = New-VBRDailyOptions -Period "05:00" -DayOfWeek Saturday
$dailyschedule = New-VBRConfigurationBackupScheduleOptions -Type Daily -DailyOptions $daily
$encryptionkey = Get-VBREncryptionKey -Description "veeam encryption"
Set-VBRConfigurationBackupJob -ScheduleOptions $dailyschedule -EnableEncryption -EncryptionKey $encryptionkey
```

Perform the following steps:

1. Run the [`New-VBRDailyOptions`](new-vbrdailyoptions.md) cmdlet. Specify the `Period` and the `DayOfWeek` parameter values. Save the result to the `$daily` variable.
2. Run the [`New-VBRConfigurationBackupScheduleOptions`](new-vbrconfigurationbackupscheduleoptions.md) cmdlet. Set the `Daily` option for the `Type` parameter. Set the `$daily` variable as the `DailyOptions` parameter value. Save the result to the `$dailyschedule` variable.
3. Run the [`Get-VBREncryptionKey`](get-vbrencryptionkey.md) cmdlet. Specify the `Description` parameter value. Save it to the `$encryptionkey` variable.
4. Run the `Set-VBRConfigurationBackupJob` cmdlet. Set the `$dailyschedule` variable as the `ScheduleOptions` parameter value. Provide the `EnableEncryption` parameter. Set the `$encryptionkey` variable as the `EncryptionKey` parameter value.

:::

## Related Commands

- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`New-VBRConfigurationBackupScheduleOptions`](new-vbrconfigurationbackupscheduleoptions.md)
- [`Get-VBREncryptionKey`](get-vbrencryptionkey.md)