New-VBRMongoDBProcessingOptions

Short Description

Creates processing options for each MongoDB replica set.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

Set automatic node selection.

New-VBRMongoDBProcessingOptions -BackupObject <VBRDiscoveredMongoDB> [-AllowBackupFromPrimary <Boolean>] [-AutoSelectBackupSourceNode] [<CommonParameters>]

Set preferred node selection.

New-VBRMongoDBProcessingOptions -BackupObject <VBRDiscoveredMongoDB> [-AllowBackupFromPrimary <Boolean>] -BackupSourceNode <VBRDiscoveredMongoDBReplicaSetNode> [-AllowBackupSourceNodeFailover <Boolean>] [<CommonParameters>]

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
BackupObject	Specifies an array of discovered replica sets. The cmdlet adds these entities to the application backup policy.	Accepts the VBRDiscoveredMongoDB object. To get this object, run the Get-VBRDiscoveredApplication cmdlet.	True	Named	True (ByPropertyName, ByValue)
AllowBackupFromPrimary	Allows backup from primary nodes. Note: This parameter is required only in cases where there is more than one node.	Boolean	False	Named	True (ByPropertyName)
BackupSourceNode	Specifies the selected node to be backed up. Keep in mind the following limitations for node selection: The node must be operational. If there are any node operational errors and the AllowBackupSourceNodeFailover parameter is enabled, you can proceed with the node selection. If the node is primary, it must be the only operational node and the AllowBackupFromPrimary parameter must be enabled. Otherwise, the backup operation fails. Nodes used in previous backup operations are used again, if no node has been specifically selected. Repeated use of a primary node in multiple backup operations is possible only if the AllowBackupFromPrimary parameter is set and there are no additional nodes. Otherwise, the backup operation fails. Note: This parameter is not required when AutoSelectBackupSourceNode is used.	Accepts the VBRDiscoveredMongoDBReplicaSetNode object. To get this object, run the Get-VBRDiscoveredApplication cmdlet.	True	Named	True (ByPropertyName)
AutoSelectBackupSourceNode	Selects the backup node automatically.	SwitchParameter	False	Named	True (ByPropertyName)
AllowBackupSourceNodeFailover	Allows switching to automatic node selection if the manually selected node is not available and the AutoSelectBackupSourceNode parameter is not enabled.	Boolean	False	Named	True (ByPropertyName)

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRMongoDBProcessingOptions object that defines MongoDB database processing settings.

Examples

New-VBRMongoDBProcessingOptions 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:

Run the Get-VBRDiscoveredApplication cmdlet to get the replica set. Specify the MongoDBEntityType parameter value. Save the result to the $rs variable.
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.

New-VBRMongoDBProcessingOptions 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:

Run the Get-VBRDiscoveredApplication cmdlet to get the replica set. Specify the MongoDBEntityType parameter value. Save the result to the $rs variable.
Run the Get-VBRDiscoveredApplication cmdlet to get the replica set node. Specify the MongoDBEntityType parameter value. Save the result to the $node variable.
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 Command

Get-VBRDiscoveredApplication