Veritas NetBackup for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup (8.2)
  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. Installing and deploying MongoDB plug-in for NetBackup
    1.  
      Deploying the MongoDB plug-in
    2.  
      Operating system and platform compatibility
    3.  
      Downloading the plug-in
    4.  
      Installing the MongoDB plug-in and the required EEBs
    5.  
      Prerequisites and the best practices for deploying the MongoDB plug-in
    6.  
      Post installation procedures
    7.  
      Verifying the installation of 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.  
      Contents of the MongoDB plug-in installer package file
    2.  
      Sample MongodB configuration utility workflow to add and update MongodB credentials

Managing backup hosts

A backup host acts as a proxy client which hosts all the backup and restore operations for MongoDB clusters. In case of MongoDB plug-in for NetBackup, backup host performs all the backup and restore operations without any separate agent installed on the MongoDB cluster.

The backup host must have a Linux operating system. NetBackup supports only RHEL and SUSE platforms as a backup host.

The backup host can be a NetBackup client or a media server or a master server. Veritas recommends that you have media server as a backup host.

Consider the following before adding a backup host:

  • For backup and restore operations, you can add one or more backup hosts.

  • A master, media, or client can perform the role of a backup host.

  • MongoDB plug-in for NetBackup is installed on all the backup hosts.

  • When using multiple backup host, make sure that all backup hosts are communicating with the media server.

You can add a backup host while configuring BigData policy using either the NetBackup Administration Console or Command Line Interface.

For more information on how to create a policy, see See Creating a BigData backup policy.

To add a backup host

  • In the Backup Selections tab, click New and add the backup host in the following format:

    Backup_Host=<FQDN_or_hostname>

    For more information on how to create a policy, See Creating a BigData backup policy.

    Alternatively, you can also add a backup host using the following command:

    For Windows:

    bpplinclude PolicyName -add "Backup_Host=FQDN_or_hostname"

    For UNIX:

    bpplinclude PolicyName -add "Backup_Host=FQDN_or_hostname"

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

    For more information, See Using NetBackup Command Line Interface (CLI) to create a BigData policy for MongoDB clusters .

To remove a backup host

  1. In the Backup Selections tab, select the backup host that you want to remove.
  2. Right click the selected backup host and click Delete.

    Alternatively, you can also remove a backup host using the following command:

    For Windows:

    bpplinclude PolicyName -delete "Backup_Host=FQDN_or_hostname"

    For UNIX:

    bpplinclude PolicyName -delete "Backup_Host=FQDN_or_hostname"

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