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

Using NetBackup Command Line Interface (CLI) to create a BigData policy for MongoDB clusters

You can also use the CLI method to create a BigData policy for MongoDB.

For more information about the commands, refer to the NetBackup Commands Reference Guide.

To create a BigData policy using NetBackup CLI method

  1. Log on as an Administrator.
  2. Navigate to /usr/openv/netbackup/bin/admincmd on UNIX or install_path\NetBackup\bin\admincmd\ on Windows.
  3. Create a new BigData policy using the default settings.

    bppolicynew policyname

  4. View the details about the new policy using the -L option.

    bpplinfo policyname -L

  5. Modify and update the policy type as BigData.

    bpplinfo PolicyName -modify -v -M MasterServerName -pt BigData

  6. Specify the Application_Type as MongoDB.

    bpplinclude PolicyName -add "Application_Type=mongodb"

    Note:

    The parameter values for Application_Type=mongodb are case-sensitive.

  7. Specify the backup host on which you want the backup operations to be performed for MongoDB.

    bpplinclude PolicyName -add "Backup_Host=IP_address or hostname"

    Note:

    The backup host must have a Linux operating system. The backup host can be a NetBackup client or a media server or a master server.

  8. Specify the MongoDB directory or folder name that you want to backup.

    bpplinclude PolicyName -add "ALL_DATABASES"

  9. Modify and update the policy storage type for BigData policy.

    bpplinfo PolicyName -residence STUName -modify

  10. Specify the host name based on your MongoDB setup as follows:

    • Sharded MongoDB cluster

      The client name as seen in the MongoDB shell and the mongod port number of the primary configuration server in the following format:

      MongoDBNode-portnumber

    • Replica set MongoDB cluster

      The client name as seen in the MongoDB shell and the mongod port number of the primary node of the replica set in the following format:

      MongoDBNode-portnumber

    • Standalone MongoDB setup

      The client name as seen in the MongoDB shell and the mongod port number of the standalone node in the following format:

      MongoDBNode-portnumber

    bpplclients PolicyName -M "MasterServerName" -add "MongoDB_configserver" "Linux" "RedHat"

    Warning:

    Do not enter the node that acts an Arbiter node for MongoDB.

  11. Assign a schedule for the created BigData policy as per your requirements.

    bpplsched PolicyName -add Schedule_Name -cal 0 -rl 0 -st sched_type -window 0 0

    Here, sched_type value can be specified as follows:

    Schedule Type

    Description

    FULL

    Full backup

    INCR

    Differential Incremental backup

    The default value for sched_type is FULL.

    Once you set the schedule, MongoDB data is backed up automatically as per the set schedule without any further user intervention.

  12. Alternatively, you can also perform a manual backup for MongoDB data.

    For performing a manual backup operation, execute all the steps from Step 1 to Step 11.

  13. For a manual backup operation, navigate to /usr/openv/netbackup/bin

    Initiate a manual backup operation for an existing BigData policy using the following command:

    bpbackup -i -p PolicyName -s Schedule_Name -S MasterServerName -t 44

    Here, -p refers to policy, -s refers to schedule, -S refers to master server, and -t 44 refers to BigData policy type.