NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  1. Overview of protecting MongoDB using NetBackup
    1.  
      About protecting a sharded, replica set, or standalone MongoDB cluster using NetBackup
    2.  
      Protecting MongoDB data using NetBackup
    3.  
      NetBackup for MongoDB terminologies
    4.  
      Limitations
    5.  
      Prerequisites and the best practices for protecting MongoDB
  2. Verify the pre-requisites for the MongoDB plug-in for NetBackup
    1.  
      Operating system and platform compatibility
    2.  
      Prerequisites for configuring the MongoDB plug-in
  3. Configuring NetBackup for MongoDB
    1.  
      About the MongoDB configuration tool
    2.  
      Prerequisites for manually creating the mongodb.conf file
    3. Configuring backup options for MongoDB using the mongodb.conf file
      1.  
        Including the configuration file path in the allowed list on the NetBackup primary server
    4.  
      Obtaining the RSA key of the MongoDB nodes
    5. Adding MongoDB credentials in NetBackup
      1.  
        About the credential configuration file
      2.  
        How to add the MongoDB credentials in NetBackup
      3.  
        About the MongoDB roles for protecting the data
    6.  
      Host user requirements
    7. Managing backup hosts
      1.  
        Including a NetBackup client on NetBackup primary server allowed list
  4. Backing up MongoDB using NetBackup
    1. About backing up MongoDB data
      1.  
        Backing up a MongoDB cluster
    2.  
      Prerequisites for backing up a MongoDB cluster
    3. Configuring NetBackup policies for MongoDB plug-in
      1.  
        Creating a BigData backup policy for MongoDB clusters with web UI
  5. Restoring or recovering MongoDB data using NetBackup
    1.  
      About restoring MongoDB data
    2.  
      Prerequisites for MongoDB restore and recovery
    3.  
      Restore the MongoDB data on the same cluster
    4.  
      Restore the MongoDB data on an alternate cluster
    5.  
      Restoring MongoDB data in a high availability setup to an alternate client
    6.  
      Manual steps after the recovery process
  6. Troubleshooting
    1.  
      About NetBackup for MongoDB debug logging
    2.  
      Known limitations for MongoDB protection using NetBackup
  7. Appendix A. Additional information
    1.  
      Sample MongodB configuration utility workflow to add and update MongodB credentials

About the credential configuration file

The credential configuration file is required for authentication. You can create this file at any location and use the path when you add the MongoDB node credentials.

Add the credentials of the MongoDB node using the tpconfig command for the application server that is specified in the Clients tab in the backup policy.

Multiple MongoDB nodes must be separated using a comma.

  • For sharded MongoDB cluster, add all the mongod and mongos ports in the following format:

    mongod_hostname:mongod_port

    mongos_hostname:mongos_port

  • For replica set MongoDB cluster and standalone MongoDB cluster, add the mongod port in the following format:

    mongod_hostname:mongod_port

Refer to the following sample credential file that contains all the authentication types:

  • No Authentication

    {
"app.server.com:26050" : {
    "AuthType":"NOAUTH",
    "HostUser":"root",
    "HostPassword":"password",
    "HostRsaKey":"b2352722053ac9f40bc1XXXXXXXXXXXXXXXXXXXXXXXXX419fa241ba9431fd6b9"
    }
}

  • Simple Authentication

    {
"app3.server.com:26051" : {
    "AuthType":"SIMPLEAUTH",
    "HostUser":"root",
    "HostPassword":"password",
    "HostRsaKey":"b2352722053ac9f40bc1XXXXXXXXXXXXXXXXXXXXXXXXX419fa241ba9431fd6b9",
    "AppUserId":"admin",
    "AppUserPassword":"password"
    }
}

  • Certificate-based authentication

    {
"app4.server.com:26052" : {
    "AuthType":"CERTAUTH",
    "HostUser":"root",
    "HostPassword":"password",
    "HostRsaKey":"b2352722053ac9f40bc1XXXXXXXXXXXXXXXXXXXXXXXXX419fa241ba9431fd6b9",
    "ServerPemPath":"/root/certs/user1.pem",
    "CAPemPath":"/root/certs/mongo-CA-cert.crt",
    "Passkey":"password",
    "CADir":"/root/",
    "CARole":"root",
    "CertificateUser":"CN=user1,OU=nbu,O=vtas,L=pune,ST=mh,C=in"
    }
}