Creating a MongoDB Client

To perform IntelliSnap back up and restore operations on MongoDB shared clusters or replica sets, you must first create a MongoDB client on the Command Center.

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.
  • When protecting MongoDB deployments that has authentication enabled, use a database user that has any of the following roles:
    • Root role on the admin database. This is a superuser role.
    • A subset of roles (backup, restore, clusterMonitor, hostManager) on the admin database. 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, ensure the same database user is created on all the sharded servers and the config server.

    For information on 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.

  • Verify that you have a server plan with log backup RPO configuration in the Command Center. For more information, see Creating a Server Plan.


  1. From the navigation pane, click Protect > Big Data.

    The Instances page appears.

  2. Click Add cluster > MongoDB.

    The Add MongoDB cluster dialog box appears.

  3. In the Cluster name box, type a name for the new instance.
  4. From the Master Node list, select the MongoDB node that the Commvault software connects to, and uses for managing and initiating MongoDB data protection operations.

    The master node must connect to other nodes of the cluster to gather information for controlling the identified secondary 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.

    To install the MongoDB agent on a new master node, complete the following steps:

    1. Click .

      If no master nodes are available, to download and install the MongoDB agent on a new 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 be used for the SSH connection to the server.
      5. In the Installation location, type the path where you want to install the agent.
    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.
  5. In the Binary path box, type the full path to the MongoDB binary files.
  6. In the OS user name, type the user account that you will use to access the master node.
  7. In the Port Number box, type the port number on which the MongoDB server is running in a replica set.

    In the case of a sharded cluster, this is the port number where the mongos service is running .

  8. In the DB User Name and Password boxes, type the credentials for a user that can connect to the MongoDB database. The Commvault software connects to the database with this user.

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

  9. From the Plan list, select a server plan.
  10. 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: 2/24/2021 2:15:21 PM