Configuring a MongoDB Client

After you install the MongoDB Agent, configure a client for the MongoDB instance that you want to protect.

The client computer is the interface that you use to manage the MongoDB instance.

Before You Begin

  • A secondary node is required to perform backups in replica set configuration. In a sharded cluster configuration, each sharded server has to be a replica set with at least one secondary node.
  • If the client name and the MongoDB host name are different, the mongodb host name must have an IP address resolvable by Commvault, and must be part of the bind_ip command line option on the MongoDB server.
  • Verify that all mongod and mongos instances are running with config files. The config files must be in YAML format on all 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 sharded cluster deployments, ensure the same database user is created on all the sharded servers and the config server.

  • Commvault software is not required on the arbitor node of the MongoDB cluster. During the discovery of nodes, no client is associated with the arbitor node. However, this does not affect the backup or restore operations.
  • 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. From the CommCell Browser, expand Client Computers, point to New Client > Big Data Apps, and then click MongoDB.

    The Create MongoDB Client dialog box appears.

  2. On the General tab, enter the MongoDB cluster details:
    1. In the Client Name box, type a unique name for the pseudo-client.
    2. In the Instance Name box, type the name that represents the MongoDB cluster in the CommCell Console.
    3. 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.

      In sharded cluster deployments, the mongos node is the master node. In replication set deployments, any node in the replication set is the master node.

    4. In the Master Hostname box, type the MongoDB master node server host name.
    5. In the OS User Name box, type the operating system user name.
    6. 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: The Commvault software currently supports MongoDB authentication only in Linux environment.

    7. In the Binary path box, type the full path to the MongoDB binary files.
    8. In the Port Number box, type the port number that the Commvault software uses for the MongoDB connection.
  3. On the Storage Device tab, on the Data Storage Policy tab, from the Storage Policy used by default subclient list, select the storage policy.
  4. On the Details tab, click Discover.

    The software discovers the MongoDB nodes, and then displays the following details by default:

    • The physical client name.
    • The MongoDB node host name.
    • The name of the shard that the client is part of, If the client computer is part of a MongoDB shard.
    • The MongoDB type, for example, replica set, or mongos router.
    • The MongoDB role, for example primary server, secondary server or arbitor.

      Note: You can customize the column layout to include the log file path, the MongoDB version or the port number. For more information, see Customizing CommCell Console Columns and Windows.

  5. Click OK.


The software creates the following entities:

  • The client
  • An instance with the name that you specified
  • A default subclient

Last modified: 10/1/2020 9:22:23 AM