Veritas NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  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.  
        Whitelisting the configuration file path on NetBackup master 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.  
      Using a non-root user as a host user
    7. Managing backup hosts
      1.  
        Whitelisting a NetBackup client on NetBackup master server
  4. Backing up MongoDB using NetBackup
    1. 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
      2.  
        Creating BigData policy using the NetBackup Administration Console
      3.  
        Using the Policy Configuration Wizard to create a BigData policy for MongoDB clusters
      4.  
        Using the NetBackup Policies utility to create a BigData policy for MongoDB clusters
      5.  
        Using NetBackup Command Line Interface (CLI) to create a BigData policy for MongoDB clusters
  5. Restoring or recovering MongoDB data using NetBackup
    1.  
      Restoring MongoDB data
    2.  
      Prerequisites for MongoDB restore and recovery
    3. About the restore scenarios for MongoDB database from the BAR interface
      1.  
        High-level steps involved in the Restore and Recovery process
    4.  
      Using the BAR interface to restore the MongoDB data on the same cluster
    5.  
      Using the BAR interface to restore the MongoDB data on an alternate cluster
    6.  
      About restoring MongoDB data in a high availability setup on an alternate client
    7. Recovering a MongoDB database using the command line
      1.  
        Creating or modifying the rename file
      2.  
        Using the command line to recover a MongoDB database
    8.  
      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
  8.  
    Index

About NetBackup for MongoDB debug logging

NetBackup maintains process-specific logs for the various processes that are involved in the backup and restore operations. Examining these logs can help you to find the root cause of an issue.

These log folders must already exist in order for logging to occur. If these folders do not exist, you must create them.

Additionally, after every job (backup/restore), mdbserver log(s) that are created on the MongoDB nodes are copied to the respective backup hosts from where it was processed. These logs are kept in the nbaapireq_handler folder so that they can be collected by nbsu or nbcplogs utilities. To retain uniqueness of log file names collected from different hosts to a single folder, each log file name is prefixed with the hostname. For example, if the log files generated by mdbserver on hosts MDBSERVER1 and MDBSERVER2 for a backup job are "root.mdbserver.121219_00001.log", they are copied back to the backup host as MDBSERVER1-root.mdbserver.121219_00001.log and MDBSERVER2-root.mdbserver.121219_00001.log.

The log folders reside on the following directories

  • On Windows: install_path\NetBackup\logs

  • On UNIX or Linux: /usr/openv/netbackup/logs

Table: NetBackup logs related to MongoDB

Log Folder

Messages related to

Logs reside on

install_path/NetBackup/logs/nbaapidiscv

BigData framework, discovery, and MongoDB configuration file logs

Backup host

install_path/NetBackup/logs/bpbrm

Policy validation, backup, and restore operations

Media server

install_path/NetBackup/logs/bpbkar

Backup

Backup host

install_path/NetBackup/logs/tar

Restore and MongoDB configuration file

Backup host

install_path/NetBackup/logs/nbaapireq_handler

nbaapireq_handler and mdbserver

Backup host

For more details, refer to the NetBackup Logging Reference Guide.