Edit a Backup's Settings
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Available backup settings depend on the FCV
value of your MongoDB database.
To edit Backup's settings:
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.
Backup Settings Available to All FCVs
Edit Snapshot Schedule and Retention Policy
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.
Configure the snapshot settings.
Enter the following information as needed.
Take snapshots every ... hours and save for ... daysSets how frequently, in hours, Cloud Manager takes a base snapshot of the deployment and the number of days Cloud Manager retains base snapshots.
Changes to the snapshot schedule affect your snapshot storage costs.
Create cluster checkpoint every ... minutes (Sharded Clusters only)Sets how frequently, in minutes, Cloud Manager creates a Checkpoints in between snapshots of a sharded cluster. Checkpoints provide restore points that you can use to create custom point-in-time snapshots.
IMPORTANT: You may use checkpoints for clusters that run MongoDB with
Feature Compatibility Version
of 4.0 or earlier. Checkpoints were removed from MongoDB instances with FCV 4.2 or later.Store daily snapshots forSets the number of days that Cloud Manager retains daily snapshots.Store weekly snapshots forSets the number of weeks that Cloud Manager retains weekly snapshots.Store monthly snapshots forSets the number of months that Cloud Manager retains monthly snapshots.
Ops Manager takes monthly snapshots every 28 days, not by calendar month.
Day of Week for Full SnapshotSets the day of the week when Cloud Manager takes a full snapshot. This ensures a recent complete backup.
Cloud Manager sets the default value to a random weekday.
Click Submit.
Edit Security Credentials
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.
Provide the authentication information.
Enter the following information as needed and click Submit.
Auth Mechanism | The authentication mechanism that the MongoDB host uses. MongoDB Community options include:
MongoDB Enterprise options also include: |
DB Username | For See Configure MongoDB Agent for Authentication or Configure MongoDB Agent for LDAP. |
DB Password | For Username/Password or LDAP authentication, the
password used to authenticate the MongoDB Agent with the MongoDB
deployment. |
Allows TLS for connections | If checked, Backup uses TLS to connect to MongoDB. |
Modify the Storage Engine Your Backups Use
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.
Select the storage engine.
Select the storage engine. See: Storage Engine for more about choosing an appropriate storage engine for your backup.
Backup Settings Available to FCV 4.2 and Later
Edit the Preferred Member for Backup
When each snapshot starts, Cloud Manager selects a replica set member to run the snapshot. This automatically selected member should have the least performance impact on the replica set. You can override the default selection.
Important
Use default selection whenever possible. This choice ensures backup availability.
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.
Backup Settings Available to FCV 4.0 and Earlier
Enable Cluster Checkpoints
Important
You may use checkpoints for clusters that run MongoDB with
Feature Compatibility Version
of 4.0 or earlier. Checkpoints were removed from
MongoDB instances with FCV 4.2 or later.
Cluster checkpoints provide restore points in between scheduled snapshots. You can use checkpoints to create custom snapshots at points in time between regular snapshots.
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.
Edit the Namespaces Filter
The Namespaces Filter specifies which databases and collections Cloud Manager backs up.
Note
Namespace filtering is supported only for Cloud Manager versions
6.0.8
and later. Your MongoDB deployments must have
featureCompatibilityVersion
values of 4.0
and earlier,
or 6.0.1
and later.
In MongoDB Cloud Manager, go to the Continuous Backup page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Continuous Backup in the sidebar.
The Continuous Backup page displays.