Completing the Big Data Application Setup Wizard for MongoDB

If you do not have any Big Data applications configured previously on the Command Center console, then use this setup wizard to create a client for the MongoDB cluster and discover additional nodes to the MongoDB client.

Complete this procedure as part of the initial configuration for backing up MongoDB shared clusters and replica sets in the Command Center. For more information, see Getting Started.

While creating the client, you will assign a master node that has the MongoDB agent installed. If the agent is not previously installed, you can install the agent on one the nodes and assign it as the master node on the client.

Before You Begin

Review the following requirements:

  • Review the System Requirements requirements for the MongoDB Agent.
  • A secondary node is required to perform backups in a replica set configuration. In a sharded cluster configuration, each sharded server has to be a replica set with at least one secondary node.
  • Verify that all mongod and mongos instances are running with config files. The config files must be in YAML format on all the operating system platforms.
  • For MongoDB databases that have authentication enabled, use a database user that has any of the following roles on the admin database:
    • The Root role. This is a superuser role.
    • A subset of roles (backup, restore, clusterMonitor, hostManager). These roles should be used if the you do not want to assign the superuser role to the database user.

    In a sharded cluster deployments, verify that the same database user is created on all the sharded servers and on the config server.

    For information about how to configure the database user and the required roles for Commvault backup and restore operations, for specific MongoDB versions, go to the MongoDB website (https://docs.mongodb.com).

  • Commvault software is not required on the arbitor node of the MongoDB cluster.
  • On Linux platforms, by default, the default subclient uses the IntelliSnap Native engine (Logical Volume Manager (LVM) snapshots) for the snapshot operations.

    For Linux LVM snaps, there must be adequate free space in the LVM volume group for snapshot creation. The default COW cache size is set to 4096 MB or 5% of the volume size, whichever is greater. To increase the COW cache size, configure the nSnapCowSizeMB additional setting. For instructions on adding the additional setting, see Adding or Modifying Additional Settings from the CommCell Console.


  1. In the navigation pane, click Guided setup.

    The Welcome page appears.

  2. At the bottom of the page, click More.
  3. Click the Big data apps tile.
  4. On the Create server backup plan page, type a name for the plan, then provide information about storage, retention, and backup schedules, and then click Save. For more information, see Creating a Server Plan.

    If you configured a server backup plan as part of the Core Setup, the wizard skips this page.

  5. On the Big Data App Setup page, in the Application Type box, select MongoDB.
  6. From the Master node list, select the MongoDB node that you want the Commvault software to use.

    The master node must connect to other nodes of the cluster to gather information for controlling the identified nodes of the cluster. If the ports between the master node and other nodes of the cluster are blocked, a firewall must be configured for communication.

    If no master nodes are available, complete the following steps:

    1. To download and install the MongoDB agent on the MongoDB master node server, click the here link.

      The Perform remote install on a node dialog box appears.

    2. To install software on the computer, click Select this method to install software packages on your computer, and then enter the following information:
      1. In the Host Name box, type the host name of the node.
      2. In the User name and Password boxes, type the credentials for the server.
      3. Next to OS Type, click the operating system that is installed on the server.
      4. For Unix OS types, in the SSH port number, type the port number to use for the SSH connection to the server.
      5. In the Installation location box, type the path where you want to install the software.
    3. To complete an installation when the software is already installed on the server, click Select this method to complete the installation if the software packages are already installed on your computer, and then enter the following information:
      1. In the Server name box, type the server name.
      2. In the Host name box, type the host name.
    4. Click Install.
  7. In the Binary path box, type the full path to the MongoDB binary files.
  8. In the OS user name, type the user account to use to access the master node.
  9. In the Port number box, enter a port number as follows:
    • If the database uses replica sets, enter the port number for the MongoDB server.
    • If the database uses sharded clusters, enter the port number for the mongos service.
  10. In the DB user name and DB password boxes, type the credentials for a user who can connect to the MongoDB database.

    The Commvault software connects to the database with this user.

    Note: The Commvault software supports MongoDB authentication in both Windows and Linux environments. Log backups with authentication are not supported on Windows.

  11. From the Plan list, select the plan to use for the database.
  12. Click Save.

What to Do Next

You are automatically directed to add the MongoDB cluster nodes to the MongoDB client. For more information, see Adding Cluster Nodes to a MongoDB Client.

Last modified: 1/25/2021 5:56:45 PM