---
title: "New-VBRMongoDBProcessingOptions"
description: "This cmdlet applies to application backup policies and sets new MongoDB replica set processing options. When setting procession options, you can choose between two types of backup node selection: Automatic backup node selection Preferred backup..."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrmongodbprocessingoptions.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 > New-VBRMongoDBProcessingOptions"
dateModified: "2026-09-02"
---

# New-VBRMongoDBProcessingOptions

## Short Description
Creates processing options for each MongoDB replica set.

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

## Syntax

This cmdlet provides the following parameter sets:

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

```
New-VBRMongoDBProcessingOptions -BackupObject <VBRDiscoveredMongoDB> [-AllowBackupFromPrimary <Boolean>]
 [-AutoSelectBackupSourceNode] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>PreferredNodeSelection</code></p>

```
New-VBRMongoDBProcessingOptions -BackupObject <VBRDiscoveredMongoDB> [-AllowBackupFromPrimary <Boolean>]
 -BackupSourceNode <VBRDiscoveredMongoDBReplicaSetNode> [-AllowBackupSourceNodeFailover <Boolean>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet applies to application backup policies and sets new MongoDB replica set processing options.

When setting procession options, you can choose between two types of backup node selection:

- Automatic backup node selection
- Preferred backup node selection

## 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">AllowBackupFromPrimary</span></p>
        </td>
        <td>
          <p>Allows backup from primary nodes.</p><p><strong>Note:</strong> This parameter is required only in cases where there is more than one node.</p>
        </td>
        <td style="width:10%;">
          <p><code>Boolean</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AllowBackupSourceNodeFailover</span></p>
        </td>
        <td>
          <p>Allows switching to automatic node selection if the manually selected node is not available and the <code>AutoSelectBackupSourceNode</code> parameter is not enabled.</p>
        </td>
        <td style="width:10%;">
          <p><code>Boolean</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AutoSelectBackupSourceNode</span></p>
        </td>
        <td>
          <p>Selects the backup node automatically.</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>True (ByPropertyName)</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 replica sets. The cmdlet adds these entities to the application backup policy.</p><p>Accepts the <a href="vbrdiscoveredmongodb.md"><code>VBRDiscoveredMongoDB</code></a> 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><a href="vbrdiscoveredmongodb.md"><code>VBRDiscoveredMongoDB</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">BackupSourceNode</span></p>
        </td>
        <td>
          <p>Specifies the selected node to be backed up.</p><p>Keep in mind the following limitations for node selection:</p><ul><li><p>The node must be operational. If there are any node operational errors and the <code>AllowBackupSourceNodeFailover</code> parameter is enabled, you can proceed with the node selection.</p><p>If the node is primary, it must be the only operational node and the AllowBackupFromPrimary parameter must be enabled. Otherwise, the backup operation fails.</p></li><li><p>Nodes used in previous backup operations are used again, if no node has been specifically selected.</p></li><li><p>Repeated use of a primary node in multiple backup operations is possible only if the <code>AllowBackupFromPrimary</code> parameter is set and there are no additional nodes. Otherwise, the backup operation fails.</p></li></ul><p><strong>Note:</strong> This parameter is not required when <code>AutoSelectBackupSourceNode</code> is used.</p><p>Accepts the <a href="vbrdiscoveredmongodbreplicasetnode.md"><code>VBRDiscoveredMongoDBReplicaSetNode</code></a> 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><a href="vbrdiscoveredmongodbreplicasetnode.md"><code>VBRDiscoveredMongoDBReplicaSetNode</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)</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 [`VBRMongoDBProcessingOptions`](vbrmongodbprocessingoptions.md) object that defines MongoDB database processing settings.

## Examples

::: example
### Example 1. Set Automatic Node Selection To Allow Backup From Primary Node

This example shows how to set automatic node selection to be able to perform backup operations from the primary node.

```
$rs = Get-VBRDiscoveredApplication -MongoDBEntityType ReplicaSet
$procop = New-VBRMongoDBProcessingOptions -BackupObject $rs[0] -AllowBackupFromPrimary $true -AutoSelectBackupSourceNode
```

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-VBRMongoDBProcessingOptions` cmdlet. 

   - Specify the `BackupObject` parameter value with the `$rs` variable.
   - Specify the `AllowBackupFromPrimary` parameter with the `$true` variable.
   - Set the switch parameter `AutoSelectBackupSourceNode`.
   - Save the results to the `$procop` variable.

:::

::: example
### Example 2. Set Preferred Node Selection With Automatic Failover To Allow Backup From Primary Node

This example shows how to set a preferred node with automatic failover to be able to perform backup operations from the primary node.

```
$rs = Get-VBRDiscoveredApplication -MongoDBEntityType ReplicaSet
$node = Get-VBRDiscoveredApplication -MongoDBEntityType ReplicaSetNode
$procop = New-VBRMongoDBProcessingOptions -BackupObject $rs[0] -AllowBackupFromPrimary $true -BackupSourceNode $node[0] -AllowBackupSourceNodeFailover $true
```

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 [`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md) cmdlet to get the replica set node. Specify the `MongoDBEntityType` parameter value. Save the result to the `$node` variable.
3. Run the `New-VBRMongoDBProcessingOptions` cmdlet.

   - Specify the `BackupObject` parameter value with the `$rs` variable.
   - Specify `AllowBackupFromPrimary` parameter value with the `$true` variable.
   - Specify the `BackupSourceNode` parameter value with the `$node` variable.
   - Specify the `AllowBackupSourceNodeFailover` parameter value with the `$true` variable.
   - Save the results to the `$procop` variable.

:::

## Related Commands

[`Get-VBRDiscoveredApplication`](get-vbrdiscoveredapplication.md)