Docs Menu
Docs Home
MongoDB Cloud Manager

MongoDB Agent Prerequisites

On this page

  • Hardware Requirements
  • Set Host Network Access
  • Set Host Permissions

This section describes the requirements for the hosts that run the MongoDB Agent.

Hosts that run MongoDB Agents must run on a 64-bit version of one of the following hardware architectures and operating systems. The following table lists the MongoDB Server versions that you can deploy with the MongoDB Agent on the associated platforms:

RHEL/CentOS/Oracle Linux 7
RHEL/Rocky/Alma Linux/Oracle Linux 8
RHEL/Rocky/Alma Linux/Oracle Linux 9
Amazon Linux 2
Amazon Linux 2023
Debian 8
Debian 9
Debian 10
Debian 11
Ubuntu 16.x
Ubuntu 18.x
Ubuntu 20.x
Ubuntu 22.x 1
Amazon Linux 2
Amazon Linux 2023
Ubuntu 20.x
Ubuntu 22.x
PowerPC/ ppc64le
RHEL/ Centos 7
RHEL/ CentOS 8
zSeries/ 390x

1 MongoDB Connector for BI isn't supported on Ubuntu 22.04.

The MongoDB Agent must run on 64-bit architectures.

MongoDB recommends a minimum of 2 CPU cores and 2 GB of RAM for MongoDB Agent hosts.

If you activate backup, all MongoDB Agent hosts require at least an additional 2 CPU cores and 3 GB of RAM beyond basic platform requirements. Each backup job that the MongoDB Agent runs further impacts host performance.

The hosts that serve the MongoDB deployments must:

  • Resolve each FQDN to a unique IP address. Run the following command in the shell to resolve the FQDN:

    dig +short
  • Set the Common Name or Subject Alternative Name value of any SSL certificates to the MongoDB host's FQDN.

The network configuration must allow each MongoDB Agent to make a direct connection to each MongoDB deployment listed on the Deployment page. Cloud Manager does not support port forwarding.

If you install the MongoDB Agent on a host that is running a MongoDB process, the agent must have:

  • Permission to stop any MongoDB processes. The MongoDB Agent restarts the process using the Agent's own set of MongoDB binaries. If you installed MongoDB with a package manager, use the same package manager to install the MongoDB Agent. This gives the MongoDB Agent the same owner as MongoDB.

  • Read and Write permissions on the MongoDB data directory and log directory.

If you deploy the MongoDB Agent to a host that doesn't have MongoDB installed, ensure the user that owns the MongoDB Agent has Read and Write permissions on the MongoDB data and log directories you plan to use.

The MongoDB Agent requires 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, create one:

  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If the Deployment page is not already displayed, click Deployment in the sidebar.


Click the Agents tab.

  1. Click Agent API Keys.

  2. Click Generate.


    This button appears if both of the following criteria are true:

    • The current user is the Project Owner.

    • The project has no Agent API Keys other than the Original Group API Key with an exclamation next to it. This type of key exists in projects created before the new Agent API Key model. In the new model, you can create multiple Agent API Keys in a project, and any the project's MongoDB Agents can use any of the keys.

  3. In the Generate Key modal, provide a description of the new Agent API Key in the Description box.

  4. Click Generate.


    When you generate an Agent API Key, Cloud Manager displays it one time only. You must copy this key. Treat it like a password; store it in a secure place. Cloud Manager never displays the full key again.

← MongoDB Agent