Add-VBRMongoDBBackupJob

Short Description

Creates MongoDB backup policies.

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

Syntax

Add-VBRMongoDBBackupJob [-Name <String>] [-Description <String>] -BackupObject <Object[]>

[-SourceBackup <CBackup>] -BackupRepository <CBackupRepository> [-RetentionPolicy <Int32>]

[-StorageOptions <VBRStorageOptions>] [-SyntheticFullOptions <VBRFullBackupOptions>]

[-ActiveFullOptions <VBRFullBackupOptions>] [-HealthCheckOptions <VBRHealthCheckOptions>]

[-CompactFullOptions <VBRFullBackupOptions>] [-NotificationOptions <VBRNotificationOptions>]

[-ProcessingOptions <VBRMongoDBProcessingOptions[]>]

[-OplogProcessingOptions <VBRMongoDBOplogProcessingOptions[]>] [-EnableSchedule]

[-ScheduleOptions <VBRServerScheduleOptions>] [-GFSOptions <VBRComputerGFSOptions>] [-HighPriority] [<CommonParameters>]

Detailed Description

This cmdlet creates MongoDB Backup application backup policies.

For application backup policies, you must specify a container object with discovered application entities (protection groups, protection group child objects, replica sets) that you plan to back up and the target location for storing backups. To create application backup policies, do the following:

Run one of the following cmdlets:
1. Run the Get-VBRProtectionGroup cmdlet to get the protection group.
2. Run the Get-VBRDiscoveredApplication cmdlet to get the replica set.
Run the Get-VBRBackupRepository cmdlet to get the repository.
Run the Add-VBRMongoDBBackupJob cmdlet to create application backup policy.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ActiveFullOptions	Creates an active full backup schedule for MongoDB backup policies. Accepts the `VBRFullBackupOptions` object. To get this object, run the `New-VBRFullBackupOptions` cmdlet.	`VBRFullBackupOptions`	False	Named	False
BackupObject	Specifies an array of discovered application entities: protection groups and replica sets. 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[]`	True	Named	False
BackupRepository	Specifies the target backup location for the application backup policy. Accepts the `CBackupRepository` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository`	True	Named	False
CompactFullOptions	Specifies the schedule for the compact operation of full backups created by the MongoDB backup policy. Veeam Backup & Replication defragments and compacts a full backup per the schedule settings specified in the `VBRFullBackupOptions` object. Accepts the `VBRFullBackupOptions` object. To get this object, run the `New-VBRFullBackupOptions` cmdlet.	`VBRFullBackupOptions`	False	Named	False
Description	Specifies the description of the application backup policy.	`String`	False	Named	False
EnableSchedule	Enables the option to schedule the application backup policy to run on a regular basis.	`SwitchParameter`	False	Named	False
GFSOptions	Specifies GFS retention settings for MongoDB backup policy. Accepts the `VBRComputerGFSOptions` object. To get this object, run the `New-VBRComputerGFSOptions` cmdlet.	`VBRComputerGFSOptions`	False	Named	False
HealthCheckOptions	Defines the health check schedule options. Accepts the `VBRHealthCheckOption` object. To get this object, run the `New-VBRHealthCheckOptions` cmdlet.	`VBRHealthCheckOptions`	False	Named	False
HighPriority	Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it first.	`SwitchParameter`	False	Named	False
Name	Specifies the name that you want to assign to the application backup policy.	`String`	False	Named	False
NotificationOptions	Specifies notification settings for the application backup policy. Accepts the `VBRNotificationOptions` object. To define this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	False	Named	False
OplogProcessingOptions	Specifies oplog processing settings for the application backup policy. Accepts the `VBRMongoDBOplogProcessingOptions[]` object. To create this object, run the `New-VBRMongoDBOplogProcessingOptions` cmdlet.	`VBRMongoDBOplogProcessingOptions[]`	False	Named	False
ProcessingOptions	Specifies processing settings for the application backup policy. Accepts the `VBRMongoDBProcessingOptions` object. To create this object, run the `New-VBRMongoDBProcessingOptions` cmdlet.	`VBRMongoDBProcessingOptions[]`	False	Named	False
RetentionPolicy	Specifies the retention policy for backups created by MongoDB backup. Note: The retention policy specifies only the number of days.	`Int32`	False	Named	False
ScheduleOptions	Specifies the settings for the application backup policy schedule. Accepts the `VBRServerScheduleOptions` object. To create this object, run the `New-VBRServerScheduleOptions` cmdlet.	`VBRServerScheduleOptions`	False	Named	False
SourceBackup	Specifies a backup file. The cmdlet will download metadata of this backup file from the long-term repository. Accepts the `CBackup` object. To get this object, run the `Get-VBRBackup` cmdlet.	`CBackup`	False	Named	False
StorageOptions	Specifies storage options that you want to modify. Accepts the `VBRStorageOptions` object. To create this object, run the `New-VBRStorageOptions` cmdlet.	`VBRStorageOptions`	False	Named	False
SyntheticFullOptions	Creates a synthetic full backup schedule for MongoDB backup policies. Accepts the `VBRFullBackupOptions` object. To get this object, run the `New-VBRFullBackupOptions` cmdlet.	`VBRFullBackupOptions`	False	Named	False

<CommonParameters>

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

Examples

Add-VBRMongoDBBackupJob Example 1. Creating a MongoDB Backup Policy for a Replica Set

This example shows how to set up a MongoDB backup policy for a single replica set.

$rs = Get-VBRDiscoveredApplication -MongoDBEntityType ReplicaSet[0]

$backupRepo = Get-VBRBackupRepository -Name 'BackupRepo1'

Add-VBRMongoDBBackupJob -Name MongoDB_Backup_Job1 -BackupObject $rs -BackupRepository $backupRepo

Perform the following steps:

Run the Get-VBRDiscoveredApplication cmdlet. Specify the MongoDBEntityType parameter value. Save the result to the $rs variable.
The Get-VBRDiscoveredApplication cmdlet will return an array of replica sets. Mind the ordinal number of the necessary replica set. An array starts with 0. In this example, it is the first replica set in the array.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $backupRepo variable.
Run the Add-VBRMongoDBBackupJob cmdlet.
- Specify the Name parameter with the name of the backup policy.
- Specify the BackupObject parameter value with the the $rs variable.
- Specify the BackupRepository parameter value the $backupRepo variable.

Add-VBRMongoDBBackupJob Example 2. Creating a MongoDB Backup Policy for a Protection Group

This example shows how to set up a MongoDB backup policy for a protection group.

$pg = Get-VBRProtectionGroup -ContainerType MongoDB[0]

$backupRepo = Get-VBRBackupRepository -Name 'BackupRepo1'

Add-VBRMongoDBBackupJob -Name MongoDB_Backup_Job2 -BackupObject $pg -BackupRepository $backupRepo

Perform the following steps:

Run the Get-VBRProtectionGroup cmdlet. Specify the ContainerType parameter value. Save the result to the $pg variable.
The Get-VBRProtectionGroup cmdlet will return an array of protection groups. Mind the ordinal number of the necessary protection group. An array starts with 0. In this example, it is the first protection group in the array.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $backupRepo variable.
Run the Add-VBRMongoDBBackupJob cmdlet.
- Specify the Name parameter with the name of the backup policy.
- Specify the BackupObject parameter value with the $pg variable.
- Specify the BackupRepository parameter value with the $backupRepo variable.

Add-VBRMongoDBBackupJob Example 3. Enable Oplog Processing in MongoDB Application Backup Policies

This example shows how to enable the processing of oplogs and add them to an existing MongoDB oplog application backup policy.

$rs = Get-VBRDiscoveredApplication -MongoDBEntityType ReplicaSet

$oplogOptions = New-VBRMongoDBOplogProcessingOptions -BackupObject $rs[0] -EnableOplogProcessing -OplogBackupPeriod 30

$backupRepo = Get-VBRBackupRepository

Add-VBRMongoDBBackupJob -Name ps_mongo_job -BackupObject $rs -BackupRepository $backupRepo -OplogProcessingOptions $oplogOptions

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 parameter value with the $rs variable.
- Set the switch parameter EnableOplogProcessing.
- Specify the OplogBackupPeriod parameter with a number of minutes.
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 application backup policy.
- 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 $oplogOptions variable.