Veritas NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup (, 9.0)
  1. Overview of protecting MongoDB using NetBackup
      About protecting a sharded, replica set, or standalone MongoDB cluster using NetBackup
      Protecting MongoDB data using NetBackup
      NetBackup for MongoDB terminologies
      Prerequisites and the best practices for protecting MongoDB
  2. Verify the pre-requisites for the MongoDB plug-in for NetBackup
      Operating system and platform compatibility
      Prerequisites for configuring the MongoDB plug-in
  3. Configuring NetBackup for MongoDB
      About the MongoDB configuration tool
      Prerequisites for manually creating the mongodb.conf file
    3. Configuring backup options for MongoDB using the mongodb.conf file
        Whitelisting the configuration file path on NetBackup master server
      Obtaining the RSA key of the MongoDB nodes
    5. Adding MongoDB credentials in NetBackup
        About the credential configuration file
        How to add the MongoDB credentials in NetBackup
        About the MongoDB roles for protecting the data
      Using a non-root user as a host user
    7. Managing backup hosts
        Whitelisting a NetBackup client on NetBackup master server
  4. Backing up MongoDB using NetBackup
    1. Backing up MongoDB data
        Backing up a MongoDB cluster
      Prerequisites for backing up a MongoDB cluster
    3. Configuring NetBackup policies for MongoDB plug-in
        Creating a BigData backup policy
        Creating BigData policy using the NetBackup Administration Console
        Using the Policy Configuration Wizard to create a BigData policy for MongoDB clusters
        Using the NetBackup Policies utility to create a BigData policy for MongoDB clusters
        Using NetBackup Command Line Interface (CLI) to create a BigData policy for MongoDB clusters
  5. Restoring or recovering MongoDB data using NetBackup
      Restoring MongoDB data
      Prerequisites for MongoDB restore and recovery
    3. About the restore scenarios for MongoDB database from the BAR interface
        High-level steps involved in the Restore and Recovery process
      Using the BAR interface to restore the MongoDB data on the same cluster
      Using the BAR interface to restore the MongoDB data on an alternate cluster
      About restoring MongoDB data in a high availability setup on an alternate client
    7. Recovering a MongoDB database using the command line
        Creating or modifying the rename file
        Using the command line to recover a MongoDB database
      Manual steps after the recovery process
  6. Troubleshooting
      About NetBackup for MongoDB debug logging
      Known limitations for MongoDB protection using NetBackup
  7. Appendix A. Additional information
      Sample MongodB configuration utility workflow to add and update MongodB credentials

NetBackup for MongoDB terminologies

The following table defines the terms you come across when using NetBackup for protecting MongoDB cluster.

Table: NetBackup terminologies



Compound job

A backup job for MongoDB data is a compound job.

  • The backup job runs a discovery job for getting information of the data to be backed up.

  • Child jobs are created for each backup host that performs the actual data transfer.

  • After the backup is complete, the job cleans up the snapshots on the backup nodes, removes the thin client and is marked complete.

Discovery job

When a backup job is executed, first a discovery job is created. The discovery job communicates with the config server and gathers information of the shards that need to be backed up and the associated nodes.

At the end of the discovery, the job populates a workload discovery file that NetBackup then uses to distribute the workload amongst the backup hosts.

Child job

For backup, a separate child job is created for each backup host to transfer data to the storage media. A child job can transfer data blocks from multiple secondary nodes.

Workload discovery file

During discovery, when the backup host communicates with the config server, a workload discovery file is created. The file contains information about the data files to be backed up and the associated data nodes.

Workload distribution file

After the discovery is complete, NetBackup creates a workload distribution file for each backup host. These files contain information of the data that is backed up by the respective backup host.

Parallel streams

The NetBackup parallel streaming framework allows data blocks from multiple secondary nodes to be backed up using multiple backup hosts simultaneously.

Backup host

The backup host acts as a proxy client. All the backup and the restore operations are executed through the backup host.

You can configure media servers, clients, or a master server as a backup host.

The backup host is also used as destination client during restores.

BigData policy

The BigData policy is introduced to:

  • Specify the application type.

  • Allow backing up distributed multi-node environments.

  • Associate backup hosts.

  • Perform workload distribution.

Application server

  • Sharded MongoDB cluster:

    Application server is the MongoDB primary config server.

  • Replica set MongoDB cluster:

    Application server is the primary node of MongoDB.

  • Standalone cluster:

    Application server is the standalone node.

Primary config server

In a high-availability scenario, the primary config server is the MongoDB instance running in a primary role on a config server replica set. The primary config server must have at least one associated mongos service running on the same host.

Fail-over config server

In a high-availability scenario, the config server other than the primary config server that is specified as alternate_config_server in the mongodb.conf file is referred as the fail-over config server.