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.


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.

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.


Automation Agent

The Automation Agent must be running on the server where you want to install the Backup Agent. To install the Automation Agent, see Automation Agent.

Monitoring Agent

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


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-


To install the agent, click Deployment, then Servers, then click a server’s ellipsis icon () and select Install Backup Agent.

To update the agent, click the link Cloud Manager provides when your agent is out-of-date. When the agent needs updating, Cloud Manager displays a warning on the Deployment page and provides a link to perform the update.

Next Steps

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