This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

MongoDB Agent Prerequisites

    Chip Architectures

    The MongoDB Agent must run on 64-bit architectures.

    Server Networking Access

    The hosts that serve the MongoDB deployments must:

    • Have full networking access to each other through their fully qualified domain names (FQDNs). Each host must be able to reach every other host through the FQDN. To find the FQDN for each host, run the following command in the shell:

      hostname -f
    • 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 every MongoDB deployment listed on the Deployment page. Ops Manager does not support port forwarding.

    Installing to a Host that Already Runs MongoDB

    If you install the MongoDB Agent to a server that is already 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 had installed MongoDB with a package manager, use the same package manager to install the MongoDB Agent. This gives the agent the same owner as MongoDB.
    • Read and Write permissions on the MongoDB data directory and log directory.

    Installing to a Host Before Installing MongoDB

    If you deploy the MongoDB Agent to a server that does not 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.

    Acquire an Agent API Key

    The MongoDB Agent requires one Agent API Key per project to communicate with the Ops Manager Application.

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

    1. Click Deployment.

    2. Navigate to Agents.

    3. Click Agent API Keys.

    4. Click plus icon Generate.


      This button appears if:

      1. The current user is the Project Owner and

      2. The project has no Agent API Keys other than the Original Group API Key.

        The Original Group API Key exists in projects created prior to the new Agent API Key model and is indicated with exclamation circle icon .

      The new model allows a project to have more than one Agent API Key and permits any of the project’s agents to use any of the keys.

      To learn more about the new Agent API Keys, see Manage Agent API Keys.

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

    6. Click Generate.


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

    Disable Windows Firewall Stealth Mode

    Windows Firewall stealth mode should be disabled on the MongoDB hosts on which the MongoDB Agent is installed for best performance.

    Root Access

    To install the MongoDB Agent using a deb package, you must have root access.