---
title: "Set-VBRMongoDBBackupJob"
description: "This cmdlet modifies MongoDB Backup application backup policies. 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-vbrmongodbbackupjob.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Plug-Ins for Enterprise Applications, MongoDB Backup and Epic EHR System Protection > Working with Managed Veeam Plug-Ins, MongoDB Backup and Epic EHR System Protection > Application Backup Policy Settings for MongoDB > Set-VBRMongoDBBackupJob"
dateModified: "2026-08-20"
---

# Set-VBRMongoDBBackupJob

## Short Description
Modifies MongoDB backup policies.

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

## Syntax
```
Set-VBRMongoDBBackupJob -Job <VBRMongoDBBackupJob> [-Name <String>] [-Description <String>]
 [-BackupObject <Object[]>] [-SourceBackup <CBackup>] [-BackupRepository <CBackupRepository>]
 [-RetentionPolicy <Int32>] [-ActiveFullOptions <VBRFullBackupOptions>]
 [-SyntheticFullOptions <VBRFullBackupOptions>] [-StorageOptions <VBRStorageOptions>]
 [-ProcessingOptions <VBRMongoDBProcessingOptions[]>]
 [-OplogProcessingOptions <VBRMongoDBOplogProcessingOptions[]>] [-CompactFullOptions <VBRFullBackupOptions>]
 [-HealthCheckOptions <VBRHealthCheckOptions>] [-EnableSchedule] [-ScheduleOptions <VBRServerScheduleOptions>]
 [-GFSOptions <VBRComputerGFSOptions>] [-EnableGFSRetention] [-HighPriority]
 [-NotificationOptions <VBRNotificationOptions>] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies MongoDB Backup application backup policies.

::: 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">ActiveFullOptions</span></p>
        </td>
        <td>
          <p>Creates an active full backup schedule for MongoDB backup policies.</p><p>Accepts the <code>VBRFullBackupOptions</code> object. To get this object, run the <a href="new-vbrfullbackupoptions.md"><code>New-VBRFullBackupOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRFullBackupOptions</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">BackupObject</span></p>
        </td>
        <td>
          <p>Specifies an array of discovered application entities: protection groups and replica sets. The cmdlet will add these entities to the application backup policy.</p><p>Accepts the <code>Object[]</code> object. To get this object, run the <a href="get-vbrdiscoveredapplication.md"><code>Get-VBRDiscoveredApplication</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>Object[]</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">BackupRepository</span></p>
        </td>
        <td>
          <p>Specifies the target backup location for the application backup policy.</p><p>Accepts the <code>CBackupRepository</code> object. 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">CompactFullOptions</span></p>
        </td>
        <td>
          <p>Specifies the schedule for the compact operation of full backups created by the MongoDB backup policy.</p><p>Veeam Backup & Replication defragments and compacts a full backup per the schedule settings specified in the <code>VBRFullBackupOptions</code> object.</p><p>Accepts the <code>VBRFullBackupOptions</code> object. To get this object, run the <a href="new-vbrfullbackupoptions.md"><code>New-VBRFullBackupOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRFullBackupOptions</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">Description</span></p>
        </td>
        <td>
          <p>Specifies the description of the application backup policy.</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">EnableGFSRetention</span></p>
        </td>
        <td>
          <p>Enables GFS retention for MongoDB backup policies.</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">EnableSchedule</span></p>
        </td>
        <td>
          <p>Enables the option to schedule the application backup policy to run on a regular basis.</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">GFSOptions</span></p>
        </td>
        <td>
          <p>Specifies GFS retention settings for MongoDB backup policies.</p><p>Accepts the <code>VBRComputerGFSOptions</code> object. To get this object, run the <a href="new-vbrcomputergfsoptions.md"><code>New-VBRComputerGFSOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSOptions</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">HealthCheckOptions</span></p>
        </td>
        <td>
          <p>Defines the health check schedule options.</p><p>Accepts the <code>VBRHealthCheckOption</code> object. To get this object, run the <a href="new-vbrhealthcheckoptions.md"><code>New-VBRHealthCheckOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRHealthCheckOptions</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">HighPriority</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it first.</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">Job</span></p>
        </td>
        <td>
          <p>Specifies the MongoDB backup policy that you want to modify.</p><p>Accepts the <a href="vbrmongodbbackupjob.md"><code>VBRMongoDBBackupJob</code></a> object. To get this object, run the <a href="get-vbrapplicationbackupjob.md"><code>Get-VBRApplicationBackupJob</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrmongodbbackupjob.md"><code>VBRMongoDBBackupJob</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies the name that you want to assign to the application backup policy.</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">NotificationOptions</span></p>
        </td>
        <td>
          <p>Specifies notification settings for the application backup policy.</p><p>Accepts the <code>VBRNotificationOptions</code> object. To define this object, run the <a href="new-vbrnotificationoptions.md"><code>New-VBRNotificationOptions</code></a> cmdlet.</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">OplogProcessingOptions</span></p>
        </td>
        <td>
          <p>Specifies oplog processing settings for the application backup policy.</p><p>Accepts the <a href="vbrmongodboplogprocessingoptions.md"><code>VBRMongoDBOplogProcessingOptions[]</code></a> object. To create this object, run the <a href="new-vbrmongodboplogprocessingoptions.md"><code>New-VBRMongoDBOplogProcessingOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrmongodboplogprocessingoptions.md"><code>VBRMongoDBOplogProcessingOptions[]</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">ProcessingOptions</span></p>
        </td>
        <td>
          <p>Specifies processing settings for the application backup policy.</p><p>Accepts the <a href="vbrmongodbprocessingoptions.md"><code>VBRMongoDBProcessingOptions</code></a> object. To create this object, run the <a href="new-vbrmongodbprocessingoptions.md"><code>New-VBRMongoDBProcessingOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrmongodbprocessingoptions.md"><code>VBRMongoDBProcessingOptions[]</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">RetentionPolicy</span></p>
        </td>
        <td>
          <p>Specifies the retention policy for backups created by MongoDB Backup.</p><p><strong>Note</strong>: The retention policy specifies only the number of days.</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 policy.</p><p>Accepts the <code>VBRServerScheduleOptions</code> object. To create this object, run the <a href="new-vbrserverscheduleoptions.md"><code>New-VBRServerScheduleOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRServerScheduleOptions</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">SourceBackup</span></p>
        </td>
        <td>
          <p>Specifies a backup file. The cmdlet will download metadata of this backup file from the long-term repository.</p><p>Accepts the <code>CBackup</code> object. To get this object, run the<a href="get-vbrbackup.md"><code> Get-VBRBackup</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CBackup</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">StorageOptions</span></p>
        </td>
        <td>
          <p>Specifies storage options that you want to modify.</p><p>Accepts the <code>VBRStorageOptions</code> object. To create this object, run the <a href="new-vbrstorageoptions.md"><code>New-VBRStorageOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRStorageOptions</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">SyntheticFullOptions</span></p>
        </td>
        <td>
          <p>Creates a synthetic full backup schedule for MongoDB backup policies.</p><p>Accepts the <code>VBRFullBackupOptions</code> object. To get this object, run the <a href="new-vbrfullbackupoptions.md"><code>New-VBRFullBackupOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRFullBackupOptions</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 `VBRMongoDBBackupJob` object that contains settings of backup copy jobs.

## Examples

::: example
### Example 1. Applying New Storage Settings to MongoDB Backup Policy

This example shows how to apply new storage settings to an existing MongoDB backup policy.

```
$job = Get-VBRApplicationBackupJob -Name "MongoDBBackupPolicy"
$storage = New-VBRStorageOptions -CompressionLevel Optimal -StorageOptimizationType LocalTarget
Set-VBRMongoDBBackupJob -Job $job -StorageOptions $storage
```

Perform the following steps:

1. Run the [`Get-VBRApplicationBackupJob`](get-vbrapplicationbackupjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$job` variable.
2. Run the [`New-VBRStorageOptions`](new-vbrstorageoptions.md) cmdlet. Set the `Optimal` option for the `CompressionLevel` parameter. Set the `LocalTarget` option for the `StorageOptimizationType` parameter. Save the result to the `$storage` variable.
3. Run the `Set-VBRMongoDBBackupJob` cmdlet. Specify the `Job` parameter value with the `$job` variable. Specify the `StorageOptions` parameter value with the `$storage` variable.

:::

::: example
### Example 2. Applying New Retention Policy to MongoDB Backup Policy

This example shows how to modify an existing MongoDB backup policy. The policy will run with the following settings:

- The policy will create a full backup on a regular basis.
- Veeam Backup & Replication will apply the retention policy for the backups created by this policy.

```
$job = Get-VBRApplicationBackupJob -Name "MongoDBBackupJob"
$fulloptions = New-VBRFullBackupOptions -Enable -ScheduleType Weekly -SelectedDays Sunday, Wednesday
Set-VBRMongoDBBackupJob -Job $job -ActiveFullOptions $fulloptions -RetentionPolicy 7
```

Perform the following steps:

1. Run the [`Get-VBRApplicationBackupJob`](get-vbrapplicationbackupjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$job` variable.
2. Run the [`New-VBRFullBackupOptions`](new-vbrfullbackupoptions.md) cmdlet. Provide the `Enable` parameter. Specify the `ScheduleType` and `SelectedDays` parameter values. Save the result to the `$fulloptions` variable.
3. Run the `Set-VBRMongoDBBackupJob` cmdlet. 

   - Specify the `Job` parameter value with the `$job` variable. 
   - Specify the `ActiveFullOptions` parameter value with the `$fulloptions` variable. 
   - Specify the `RetentionPolicy` parameter value.

:::

::: example
### Example 3. Change Existing Oplog Processing Options

This example shows how to change existing oplog processing and retention settings, and add them to an existing MongoDB oplog application backup policy.

```
$rs = Get-VBRDiscoveredApplication -MongoDBEntityType ReplicaSet
$oplogOptions = New-VBRMongoDBOplogProcessingOptions -BackupObject $rs[0] -EnableOplogProcessing
$newOplogOptions = Set-VBRMongoDBOplogProcessingOptions -Options $oplogOptions -BackupObject $rs[0] -OplogRetentionPolicy KeepLastDays -OplogRetentionPeriod 7
$backupRepo = Get-VBRBackupRepository
Add-VBRMongoDBBackupJob -Name ps_mongo_job -BackupObject $rs[0] -BackupRepository $backupRepo[0] -OplogProcessingOptions $newOplogOptions[0]
```

Perform the following steps:

1. Run the [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md) cmdlet to get the replica set. Specify the `MongoDBEntityType` parameter value. Save the result to the `$rs` variable.
2. Run the [`New-VBRMongoDBOplogProcessingOptions`](new-vbrmongodboplogprocessingoptions.md) cmdlet.

   - Specify the `BackupObject` parameter value with the `$rs` variable.
   - Set the switch parameter `EnableOplogProcessing`.
   - Save the result to the `$oplogOptions` variable.

3. Run the [`Set-VBRMongoDBOplogProcessingOptions`](set-vbrmongodboplogprocessingoptions.md) cmdlet.

   - Specify the `Options` parameter value with the `$oplogOptions` variable.
   - Specify the `BackupObject` parameter value with the `$rs` variable.
   - Specify the `OplogRetentionPolicy` parameter value with the `KeepLastDays` variable.
   - Specify the `OplogRetentionPeriod` parameter value with the number of days of retention.
   - Save the result to the `$newOplogOptions` variable.

4. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Save the result to the `$backupRepo` variable.
5. Run the [`Add-VBRMongoDBBackupJob`](add-vbrmongodbbackupjob.md) cmdlet.

   - Specify the `Name` parameter value with the name of the backup job.
   - Specify the `BackupObject` parameter value with the `$rs` variable.
   - Specify the `BackupRepository` parameter value with the `$backupRepo` variable.
   - Specify the `OplogProcessingOptions` parameter value with the `$newOplogOptions` variable.

:::

## Related Commands

- [`Get-VBRProtectionGroup`](get-vbrprotectiongroup.md)
- [`Get-VBRApplicationBackupJob`](get-vbrapplicationbackupjob.md)
- [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md)
- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`New-VBRFullBackupOptions`](new-vbrfullbackupoptions.md)
- [`New-VBRHealthCheckOptions`](new-vbrhealthcheckoptions.md)
- [`New-VBRStorageOptions`](new-vbrstorageoptions.md)
- [`New-VBRNotificationOptions`](new-vbrnotificationoptions.md)
- [`New-VBRDatabaseProcessingOptions`](new-vbrdatabaseprocessingoptions.md)
- [`New-VBRMongoDBOplogProcessingOptions`](new-vbrmongodboplogprocessingoptions.md)
- [`Set-VBRMongoDBOplogProcessingOptions`](set-vbrmongodboplogprocessingoptions.md)