Navigation

Install or Update the Backup Agent from an Archive

Important

This page describes how to install the agent manually. The easier way to install and run the Backup Agent is through Automation, as described in Install or Update the Backup Agent through Automation.

The Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and transmits the operations to the Cloud Manager service.

The Backup Agent relies on the Cloud Manager Monitoring Agent to populate the list of sharded clusters and replica sets eligible for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may be incomplete or out-of-date. If you have not already installed and configured the Monitoring Agent, please refer to the Install or Update the Monitoring Agent documentation.

Considerations

MongoDB Requirements

Cloud Manager only supports backing up replica sets and sharded clusters, and does not support backing up standalone instances.

Cloud Manager only supports backup for replica sets or sharded clusters that run MongoDB 2.6 or later.

All backed up replica sets and config servers should maintain oplog entries for at least 1 hour over the last 24 hour period.

Agent Architecture

To avoid resource contention, run the agent on a host other than the hosts where the MongoDB instances are running. Be sure the agent can access the MongoDB hosts.

Running on Amazon EC2

If you run the Backup Agent on Amazon EC2, do not use the t1.micro instance type, which has a CPU scheduling policy that does not typically provide sufficient capacity to support a Backup Agent for a production deployment. Use a larger instance type instead.

Backup Directory

After you install the Backup Agent, do not use the agent’s directory location for anything other than the agent itself. The Backup Agent periodically deletes the contents of its root directory.

Prerequisites

Monitoring Agent

Your deployment must have a running Monitoring Agent. To install the Monitoring Agent, see Monitoring Agent.

Backup Agent Host

Run the Backup Agent on a host that:

  • Is separate from your MongoDB instances. This avoids system resource contention.
  • Can connect to your MongoDB instances. Check network settings for connections between the agent and MongoDB hosts. For a list of needed ports, see open ports for agents.
  • Has at least 2 CPU cores and 3 GB of RAM above platform requirements. With each backup job it runs, the Backup Agent further impacts host performance.

Firewall

If your MongoDB instances operate within a firewall, configure your network infrastructure to allow outbound connections from the Backup Agent on port 443 (HTTPS) to api- backup.mongodb.com.

Access Control

If you use the Backup feature with a MongoDB deployment that uses authentication, before installing the Backup Agent, you must create a user in MongoDB with the appropriate access. See Configure Backup Agent for Access Control.

Acquire an Agent API Key

Cloud Manager Agents require one Agent API Key per project to communicate with the Cloud Manager.

If you do not have an existing Agent API Key for your Cloud Manager project, you need to create one:

  1. Navigate to Agents, then Agent API Keys

  2. Click plus icon Generate.

    Note

    The button appears only if the current user is the project owner and the project either has no Agent API keys or just the Original Group API key. An Original Group API key exists only in projects created prior to the new Agent API Key model. The new model allows a project to have more than one key and permits any of the project’s agents to use any of the keys. For more information, see Manage Agent API Keys. If you do not see the + Generate Key button and do not remember your existing agent api key, you can generate a key on the Agent API Keys tab. To navigate to the tab, select Deployment view, then click the Agents tab and then the Agent API Keys tab.

  3. Enter your password and click Verify.

  4. Click plus icon Generate again.

    Important

    When you generate an Agent API key, Cloud Manager displays it one time only. You must copy it and store it in a secure place. Cloud Manager will never display the full key again.

Install the Backup Agent from an Archive

You can also access install instructions in Cloud Manager, including commands you can copy and paste: click Deployment, then Agents, then Downloads & Settings.

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

1

Log in to the Cloud Manager.

2
3

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
4

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

5

Change into the extracted binary directory.

Change into the directory that was created after extracting the Backup Agent binary:

cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64
cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64
6

Edit the local.config file.

In the directory where you installed the Backup Agent, edit the local.config file.

Update the following configuration keys:

Key Change
mmsGroupId Set to your ProjectID.
mmsApiKey Set to the project’s agent API key.
mothership Set to the Backup Server URL displayed in the modal.
7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

For RHEL / CentOS (7.x) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

1

Log in to the Cloud Manager.

2

Navigate to Agent Downloads.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
3

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
4

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

5

Change into the extracted binary directory.

Change into the directory that was created after extracting the Backup Agent binary:

cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64
cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64
6

Edit the local.config file.

In the directory where you installed the Backup Agent, edit the local.config file.

Update the following configuration keys:

Key Change
mmsGroupId Set to your ProjectID.
mmsApiKey Set to the project’s agent API key.
mothership Set to the Backup Server URL displayed in the modal.
7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

For Ubuntu (16.04) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

1

Log in to the Cloud Manager.

2

Navigate to Agent Downloads.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
3

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
4

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

5

Change into the extracted binary directory.

Change into the directory that was created after extracting the Backup Agent binary:

cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64
cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64
6

Edit the local.config file.

In the directory where you installed the Backup Agent, edit the local.config file.

Update the following configuration keys:

Key Change
mmsGroupId Set to your ProjectID.
mmsApiKey Set to the project’s agent API key.
mothership Set to the Backup Server URL displayed in the modal.
7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

For all other Linux distributions:

1

Log in to the Cloud Manager.

2

Navigate to Agent Downloads.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
3

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
4

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

5

Change into the extracted binary directory.

Change into the directory that was created after extracting the Backup Agent binary:

cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64
cd mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le
cd mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64
6

Edit the local.config file.

In the directory where you installed the Backup Agent, edit the local.config file.

Update the following configuration keys:

Key Change
mmsGroupId Set to your ProjectID.
mmsApiKey Set to the project’s agent API key.
mothership Set to the Backup Server URL displayed in the modal.
7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

Update the Backup Agent from an Archive

You can also access update instructions in Cloud Manager, including commands you can copy and paste: click Deployment, then Agents, then Downloads & Settings.

For RHEL / CentOS (7.x) and SUSE 12 on x64 architecture:

1

Log in the the host where the Backup Agent is installed.

2

Stop any currently running Backup Agents.

Issue the following command with the system shell:

pkill -f mongodb-mms-backup-agent
3

Log in to the Cloud Manager.

4

Select the Linux distribution for your Agent host.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
5

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
6

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

For RHEL / CentOS (7.x) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

1

Log in the the host where the Backup Agent is installed.

2

Stop any currently running Backup Agents.

Issue the following command with the system shell:

pkill -f mongodb-mms-backup-agent
3

Log in to the Cloud Manager.

4

Select the Linux distribution for your Agent host.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
5

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
6

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

For Ubuntu (16.04) on PowerPC architecture (managing MongoDB 3.4 or later deployments only):

1

Log in the the host where the Backup Agent is installed.

2

Stop any currently running Backup Agents.

Issue the following command with the system shell:

pkill -f mongodb-mms-backup-agent
3

Log in to the Cloud Manager.

4

Select the Linux distribution for your Agent host.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
5

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
6

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

For all other Linux distributions:

1

Log in the the host where the Backup Agent is installed.

2

Stop any currently running Backup Agents.

Issue the following command with the system shell:

pkill -f mongodb-mms-backup-agent
3

Log in to the Cloud Manager.

4

Select the Linux distribution for your Agent host.

  1. Click Deployment.
  2. Click Agents.
  3. Click Downloads & Settings.
  1. Click RHEL/CentOS 7.X, SUSE12 - TAR.
  1. Click RHEL/CentOS 7.X Power (ppc64le) - TAR.
  1. Click Ubuntu 16.X Power (ppc64le) - TAR.
  1. Click Other Linux - TAR.
5

Download the latest version of the Backup Agent archive.

From a system shell on the host that will run the Backup Agent, issue a curl command to download the archive for your platform:

curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_x86_64.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.rhel7_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.ubuntu1604_ppc64le.tar.gz
curl -OL https://cloud.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-7.6.0.1059.linux_x86_64.tar.gz
6

Extract the Backup Agent.

You can install the Backup Agent in any directory. You can move the archive to another directory before extracting.

tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_x86_64.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.rhel7_ppc641e.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.ppc64le.ubuntu1604.tar.gz
tar -xvzf mongodb-mms-backup-agent-{bagent-version}.linux_x86_64.tar.gz

When the command completes, the Backup Agent is installed.

7

Optional: Configure the Backup Agent to use a proxy server.

To configure the agent to connect to Cloud Manager via a proxy server, you must specify the server in the httpProxy environment variable. In the <install-directory>/local.config file, set the httpProxy value to the URL of to your proxy server:

httpProxy="http://proxy.example.com:9000"
8

Start the Backup Agent.

Issue the following command:

nohup ./mongodb-mms-backup-agent \
  --config=local.config \
  >> backup-agent.log 2>&1 &

Next Steps

After you have successfully installed the Backup Agent, see Back up a Deployment to enable backup for a replica set.

Additional Information

The README included with the downloaded package also provides information about the Backup Agent.

For details about backup operations, see FAQ: Backup and Restore.