Complete the Big Data Guided Setup for MongoDB


The big data guided setup guides you through creating a server backup plan and adding the MongoDB cluster.

Go to the Big Data Guided Setup

  1. From the navigation pane, go to Guided setup.

    The Welcome page appears.

  2. On the Protect tab, at the bottom of the page, click More.

  3. Click the Big data apps tile.

    The Big data app setup page appears.

    If you already completed the guided setup, the Apps page appears.

Create a Server Backup Plan That You Can Use for MongoDB

If you already have a server backup plan that you can use, you can skip this step.

  1. On the Create server backup plan page, click Create a new plan, and then specify the settings for a server backup plan that you can use for the MongoDB cluster.



Plan name

  1. Fill in the following plan information:

    1. Choose whether to create a new plan or use a base plan.

    2. If you selected Create a new plan, in the Plan name, enter a name for the server plan.

    3. If you selected Use existing base plan, specify the plan name and select a base plan.

Backup destinations

  1. Click Add copy.

    The Add copy dialog box appears.

  2. In Name, enter a name for the backup destination.

  3. From the Storage list, select the storage to use for the backups.

    You can use the MRR cool storage class (Metallic Recovery Reserve) for creating secondary copies, but not for creating primary copies.

  4. To specify the start time for backups on a specific date and later, move the Backups On and After toggle key to the right.

  5. For Retention rules, enter the amount of time to retain the backups.

  6. To specify additional backups, such as weekly full backups, move the Extended retention rules toggle key to the right, and then add rules.

  7. Click Save.

  8. To add additional regions to the backup destination, move the Multi-region toggle key to the right, and then select the regions.

    You can also add more regions and associate the storage copy to the region.


  1. For Backup frequency, click Add.

    The Add backup frequency dialog box appears.

    1. From the Backup type list, select the backup type, and from the for list, select All agents or Databases.

    2. Specify the frequency of the backup.

    3. To specify the client time zone or to add exceptions, move the Advanced toggle key to the right.

      • From the time zone list, select the time zone according to which the backups must run.

      • To add exceptions when backups must not run, click Exceptions and add exceptions for any day or week of a month.

        These exceptions will repeat every month.

  2. For Backup window (if incremental and differential backups are supported for the workload), specify when you want incremental and differential backups to run.

  3. For Full backup window, specify when you want full backups to run.

Snapshot options

  1. Under Snapshot options, do the following:

    1. Specify how to retain snapshots:

      • To specify a number of jobs to retain on a snapshot copy, select Number of snap recovery points, and then enter the number of jobs to retain.

      • To specify a retention period, select Retention period, and then enter the amount of time to retain the jobs.

    2. If you don't want to create backup copies, move the Enable backup copy toggle key to the left to turn it off.

    3. For Backup copy frequency, enter how often to run backup copy jobs.

Database options

  1. Under Database options, do the following:

    1. For Log backup RPO, enter how often to run log backups.

    2. To automatically back up the database logs to the MediaAgent cache, do the following:

      1. Move the Use disk cache for log backups toggle key to the right.

      2. For Commit, enter how often to commit the logs to the CommServe computer.

        Disk caching of database logs applies to the following: Informix, Microsoft SQL Server on Windows, Oracle, Oracle RAC, and SAP HANA.

Override restrictions

  • Leave the Allow plan to be overridden check box cleared.

Add the MongoDB Cluster

  1. On the Add a big data app page, from the Application type list, select MongoDB.

    If no MongoDB master node is found, a message appears, with a link that you can use to download and install the Commvault software on the master node so that you can select it from the Master node list.

  2. In the Cluster name box, enter a name for the cluster.

  3. From the Master node list, select the master node.

  4. In the Binary path box, enter the path to the folder that contains the mongod or mongos executable file.

    The Commvault software uses mongo/mongosh, mongod, mongodump, and mongorestore for backup and restore operations. Keep the binaries in bin path and verify that the bin path is same across all the nodes in the cluster.

  5. In the OS user name box, enter the OS user name that you want to use to run the MongoDB servers.

    Commvault software uses the OS user name to start the MongoDB servers after the restore operation.

    Note: The OS user must have the permission to start the server and have ownership of the files in dbPath.

  6. In Port number box, enter the mongod or mongos port number.

  7. To back up MongoDB clusters in both Windows and Linux environments, under Database authentication, you can enter the credentials of an account to authenticate with.

    Note: Log backups with authentication are not supported on Windows.

    The account must have one of the following on the admin database:

    • The root role. This is a superuser role.

    • The backup, restore, clusterMonitor, and hostManager roles. If you do not want to assign a superuser role to the database user, use these roles.

  8. From Plan, select the server backup plan to use for the cluster.

  9. Click Save.