Navigation
This version of the documentation is archived and no longer supported. It will be removed on EOL_DATE. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.
This version of the manual is no longer supported. It will be removed on EOL_DATE.

Restore Overview

To restore a deployment from a backup, select a snapshot or point in time from which you want to restore your database. Ops Manager provides you with the files from which you can restore your database.

You can restore a single MongoDB database, a replica set, or a sharded cluster. You may select to restore from:

If you are restoring from a point in time, you must download the MongoDB Backup Restore Utility to your target host. The MBRU requests and applies oplog entries between the latest complete snapshot and the point in time you chose.

Note

For sharded clusters, enable checkpoints before restoring to a point between snapshots.

You can restore your backup in one of the following ways:

You may cancel a restore by going to the Backup > Restore History tab and clicking on Cancel.

Automated Restore

If you choose to have Ops Manager automation restore your backup, the Automation Agent removes all existing data from the target hosts and replaces that data with new backup data from your snapshot.

Prerequisites

To perform automated restores, you must have:

  • An Automation Agent installed on the source and all target hosts.

  • A Monitoring Agent on the target deployment that can connect to all hosts in the target deployment.

  • The Backup Admin and Automation Admin roles in Ops Manager.

  • A target cluster whose featureCompatibilityVersion is greater than or equal to the source cluster’s featureCompatibilityVersion.

    Example

    Run the following command to retrieve the featureCompatibilityVersion of a given host:

    db.adminCommand( { getParameter: 1, featureCompatibilityVersion: 1 } )
    

    The featureCompatibilityVersion of each host in the target cluster must be greater than or equal to the featureCompatibilityVersion of any host in the source cluster.

    See setFeatureCompatibilityVersion for complete documentation on changing the featureCompatibilityVersion flag.

  • The following compatibility matrix lists the supported source cluster FCV of each MongoDB version. The MongoDB version of each host in the target cluster must support the FCV of the snapshot of the source cluster.

    Source Cluster FCV MongoDB 3.2 MongoDB 3.4 MongoDB 3.6
    3.2  
    3.4  
    3.6    

Restore to Different Project

You can choose to restore to a cluster of a different project:

  • To restore to another Ops Manager project, you must have Automation Admin or Backup Admin roles for the target project.
  • To restore to another MongoDB Atlas project, you must have Project Owner role for the target project.

Potential Causes for Automated Restore Failure

An automated restore can fail when certain storage settings of the backup’s database and target database do not match:

No method exists to check for mismatches before attempting a restore. If a restore attempt fails, Ops Manager displays any mismatched settings. If you still want to restore the backup’s database, fix the settings in the target database that do not match backup’s database, then retry the restoring the backup’s database.

Important

MongoDB removed the MMAPv1 storage engine in MongoDB 4.2. If you edit your deployment’s configuration to change your storage engine to WiredTiger Storage Engine, Ops Manager restarts the MongoDB processes.

Restore Procedures

To perform an automated restore, see the procedure for the deployment you want to restore:

Manual Restore

Prerequisites

To perform manual restores, you must have the Backup Admin role in Ops Manager.

Considerations

Restore File Format

Ops Manager provides each snapshot as an uncompressed (.tar) or compressed (.tar.gz) archive containing a complete copy of the data directory.

Choosing compressed snapshots results in faster delivery, but requires sufficient space on the target host for both the compressed snapshot and its extracted database files.

Restore Process Flows

The following pages illustrate the process flows for manual restores using the different restore methods:

Manual Restore Procedures

To perform a manual restore, see the procedure for the deployment you want to restore: