Set-VBRMongoDBOplogProcessingOptions

Short Description

Modifies operations log (oplog) processing options for MongoDB replica sets.

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

Syntax

Set-VBRMongoDBOplogProcessingOptions -Options <VBRMongoDBOplogProcessingOptions> [-BackupObject <Object>]

[-EnableOplogProcessing] [-OplogBackupPeriod <Int32>] [-OplogRetentionPolicy <VBRMongoDBOplogRetentionPolicy>]

[-OplogRetentionPeriod <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet modifies the parameters of existing oplog processing options for MongoDB Replica sets. Use this cmdlet and its parameters to update the oplog backup period, retention period and retention policy.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
BackupObject	Specifies an array of MongoDB replica set and protection group objects. The cmdlet will add these entities to the application backup policy. Accepts the `Object` object. To get this object, run the `Get-VBRDiscoveredApplication` cmdlet.	`Object`	False	Named	True (ByPropertyName)
EnableOplogProcessing	Enables the processing of existing oplogs of MongoDB replica sets.	`SwitchParameter`	False	Named	True (ByPropertyName)
OplogBackupPeriod	Modifies the interval in minutes at which the system collects the oplog backup after an image-level backup operation. Default: 15 minutes.	`Int32`	False	Named	True (ByPropertyName)
OplogRetentionPeriod	Modifies the retention period of the oplog in the backup repository in days. Default: 15 days	`Int32`	False	Named	True (ByPropertyName)
OplogRetentionPolicy	Modifies the oplog retention policy settings: `KeepLastDays`: Retains oplog backup for a specified number of days, regardless of the state of the related full backup. `KeepWithBackup`: Retains oplog backup simultaneously with the related full backup.	`VBRMongoDBOplogRetentionPolicy`	False	Named	True (ByPropertyName)
Options	Specifies the existing processing options for oplogs of MongoDB replica sets. Accepts the `VBRMongoDBOplogProcessingOptions` object. To get this object, run the `New-VBRMongoDBOplogProcessingOptions` cmdlet.	`VBRMongoDBOplogProcessingOptions`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the VBRMongoDBOplogProcessingOptions object that configures processing settings for oplogs for MongoDB replica sets.

Examples

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:

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-VBRMongoDBOplogProcessingOptions cmdlet. Specify the BackupObject and EnableOplogProcessing parameter values. Save the result to the $oplogOptions variable.
Run the Set-VBRMongoDBOplogProcessingOptions 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.
Run the Get-VBRBackupRepository cmdlet. Save the result to the $backupRepo variable.
Run the Add-VBRMongoDBBackupJob 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.