You were redirected from a different version of the documentation. Click here to go back.

Automation Agent Configuration

Legacy Automation Agent is EoL for Ops Manager 4.4

Update from the legacy Automation Agent to the MongoDB Agent.

This page describes possible settings for Automation Agent. These values are set after first launching Ops Manager and not through manual editing of these files.

See Ops Manager Configuration Settings for the Ops Manager settings and their values.


If you edit these settings through the Settings or Deployments, in the case of authentication or SSL, in Ops Manager, those changes overwrite any changes made manually in this configuration file.

Configuration File Location on Each Platform

The location of the Automation Agent configuration file depends on your platform:



Ops Manager provides default values for many of the Automation Agent Configuration settings.

Connection Settings


Type: string

Specifies the ID of your Ops Manager project. In Ops Manager, click Settings, then Agents and then click on the appropriate operating system under Agent Downloads.

When the Automation Agent Installation Instructions box appears, these values can be copied directly from this box using the Copy buttons.

This setting is usually set when the Automation Agent is installed and is required to bind the server to a project.


Type: string

Specifies the Ops Manager agent API key of your Ops Manager project.

You can use an Agent API key that you have already generated for the project. Otherwise, you can generate a new Agent API key. A project can have more than one Agent API key, and any of the project’s agents can use any of the keys. For more information, see Manage Agent API Keys.

To generate an Agent API key, go to the Agent API Keys tab. To navigate to the tab, from the Deployment view, click the Agents tab and then the Agent API Keys tab.


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.

This setting is usually set when the Automation Agent is installed and is required to bind the server to a project.


Type: string

Specifies the URL of the Ops Manager Application.


Type: string

Specifies the path to which Ops Manager should write the Automation Agent’s log.

By default, this path is /var/log/mongodb-mms-automation/automation-agent.log.



Specifies the path to the Ops Manager automation configuration backup file. This file describes the desired state of the deployment.



When Ops Manager is installed, it stores this configuration backup file in /var/lib/mongodb-mms-automation/.


Type: int

Specifies the number of seconds to wait before a connection times out. By default, connections time out after 40 seconds. However, The Automation Agent may frequently time out of connections for one or more of the following reasons:

  • High network latency
  • High server load
  • Large SSL keys
  • Lack of SSL accelerator
  • Insufficient CPU speed

MongoDB recommends gradually increasing the value of the dialTimeoutSeconds Automation Agent configuration setting to prevent frequent premature connection timeouts.



Increasing this value also increases the time required to deploy configuration changes to the Automation Agent. Experiment with small, incremental increases until you determine the optimum value for your deployment.

Logging Settings


Type: string

Specifies the level of logging granularity.

Choose from the following severity levels, from most to least verbose:

  • INFO
  • WARN

By default, logLevel is INFO.


Each level includes the log items included in the succeeding levels.


  • If you choose DEBUG, the Automation Agent logs all messages, including INFO, WARN, ERROR and FATAL.
  • If you choose FATAL, the Automation Agent only logs FATAL messages.

Type: integer

Specifies the maximum number of rotated log files to retain.

By default, maxLogFiles is 10. You can change the value to retain a different quantity of rotated log files.


Type: integer

Specifies the maximum size, in bytes, of a log file before the logs are rotated. If unspecified, the Automation Agent does not rotate logs based on file size. This is optional.


Type: float

Specifies the number of hours after which the logs (regular and verbose) are rotated. This is optional.


On UNIX- and Linux-based systems you can manually rotate the Automation Agent logs. Issue a user signal 1 kill command for the Automation Agent process:

kill -SIGUSR1 <automationAgentID>

This rotates the Automation Agent regular and verbose logs.

HTTP Proxy Settings


Type: string

Specifies the URL of an HTTP proxy server the Automation Agent can use.


MongoDB Kerberos Settings

Specify these settings if the Automation Agent authenticates to hosts using Kerberos.


Type: string

Specifies an absolute path to an non-system-standard location for the Kerberos configuration file.



Ops Manager creates a Kerberos Credential (Ticket) Cache for each agent automatically when Kerberos is enabled. If you want to override the location of the Kerberos Credential Cache, you must set the KRB5CCNAME environment variable to the desired file name and path before running the agent.


Type string

Specifies the KRB5CC environment variable that the Automation Agent sets for Backup Agent process. Used only to authenticate the Backup Agent to your MongoDB deployment when the Automation Agent starts the agent.


Type string

Specifies the KRB5CC environment variable that the Automation Agent sets for the Monitoring Agent process. Used only to authenticate the Monitoring Agent to your MongoDB deployment when the Automation Agent starts the agent.


Ops Manager SSL Settings

Specify the settings the Automation Agent uses when communicating with Ops Manager using SSL.


Type: string

Specifies the absolute path that contains the trusted CA certificates in PEM format. The absolute path must be used because the Automation Agent may pass this certificate to the other agents, which may have different paths relative to the Automation Agent. This certificate verifies that the agent is talking to the designated Ops Manager instance.



If you need to have your Automation Agents download their MongoDB installers from the Internet while using TLS and a private Certificate Authority signed your certificates (httpsCAFile parameter is set), raise a ticket with MongoDB Support to help you configure your Ops Manager Application.


Type: boolean

Specifies if the Automation Agent should validate SSL certificates presented by Ops Manager.


Setting this option to false disables certificate verification and makes connections between the Automation Agent and Ops Manager susceptible to man-in-the-middle attacks. Setting this option to false is only recommended for testing purposes.


Type: string

Specifies the path to the file containing the client’s private key, certificate, and optional intermediate certificates in PEM format. The Automation Agent uses the client certificate when connecting to Ops Manager over SSL if Ops Manager requires client certificates, such as when Ops Manager runs with Client Certificate Mode set to Required for Agents Only or Required for All Requests.

See also

See Client Certificate Mode in Ops Manager Configuration Settings for how to specify this setting in the Ops Manager Application.


Type: string

Specifies the password needed to decrypt the private key in the sslMMSServerClientCertificate file. This setting is required when the client certificate PEM file is encrypted.