- Agents >
- Automation Agent >
- Automation Agent Configuration
Automation Agent Configuration¶
On this page
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 for the Ops Manager settings and their values.
Warning
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 per Operating System¶
The location of the Automation Agent configuration file depends on your operating system:
Operating System | Installation Method | Config File Path |
RHEL, CentOS, Amazon Linux and Ubuntu | package manager | /etc/mongodb-mms/automation-agent.config |
OS X or other Linux distributions | tar |
/path/to/install/local.config |
Windows | msi |
C:\MMSData\Automation\automation-agent.config |
Settings¶
Ops Manager provides default values for many of the Automation Agent Configuration settings.
Connection Settings¶
-
mmsGroupId
¶ Type: string
Specifies the ID of your Ops Manager group. 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 group.
Server Pool
Do not set if adding the server to a server pool. To add the server to a server pool, set
serverPoolKey
,serverPoolPropertiesFile
, andserverPoolStateFile
instead.
-
mmsApiKey
¶ Type: string
Specifies the Ops Manager agent API key of your Ops Manager group. To retrieve this key from 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 group.
Server Pool
Do not set if adding the server to a server pool. To add the server to a server pool, set
serverPoolKey
,serverPoolPropertiesFile
, andserverPoolStateFile
instead.
-
mmsBaseUrl
¶ Type: string
Specifies the URL of the Ops Manager Application.
Set this to the URL of your Ops Manager Application.
-
serverPoolKey
¶ Specifies the Server Pool Key. Required if adding the server to a server pool. If using a server pool, do not set
mmsGroupId
andmmsApiKey
The server pool key associates this server to the server pool.
To find the server pool key, in the Admin menu, go to Server Pool view and click on the Agent Configuration tab.
-
serverPoolPropertiesFile
¶ Specifies the full filepath of a file that contains server properties. Required if adding the server to a server pool. If using a server pool, do not set
mmsGroupId
andmmsApiKey
The properties file contains key/value pairs of the form
<property>=<value>
. The Ops Manager Administrator decides on both the property names and values.Note
Ensure that the properties file contains the desired property names and values before starting the Automation Agent on the server.
Once the server is registered with the pool, changes to the properties file do not take effect until the server is first removed and the Automation Agent restarted.
The properties and the values in this file may be presented to the user during server request as options when a user requests servers from the server pool. That is, the user can request servers that match certain properties.
The Ops Manager Administrator determines which properties to display to the user in the server request screen. For details, see Servers Request Options.
Ensure the Automation Agent can read the file.
-
serverPoolStateFile
¶ Specifies the full filepath of the file to be used by the Automation Agent. Required if adding the server to a server pool. If using a server pool, do not set
mmsGroupId
andmmsApiKey
Ensure that the directory path to the file exists and the agent has read and write access to the directory. The file itself need not exist; however, if it does exist, the agent must have read and write access to the file.
-
logFile
¶ 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
.
-
mmsConfigBackup
¶ Type:
Specifies the path to the Ops Manager automation configuration backup file. This file describes the desired state of the deployment.
Note
When Ops Manager is installed, it stores this configuration backup file in
/var/lib/mongodb-mms-automation/
.
-
dialTimeoutSeconds
¶ 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.Note
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¶
-
logLevel
¶ Type: string
Specifies the level of logging granularity.
Choose from the following severity levels, from most to least verbose:
DEBUG
INFO
WARN
ERROR
FATAL
By default,
logLevel
isINFO
.Each level includes the log items included in the succeeding levels.
Example
- If you choose
DEBUG
, the Automation Agent logs all messages, includingINFO
,WARN
,ERROR
andFATAL
. - If you choose
FATAL
, the Automation Agent only logsFATAL
messages.
-
maxLogFiles
¶ Type: integer
Specifies the maximum number of rotated log files to retain.
By default,
maxLogFiles
is10
. You can change the value to retain a different quantity of rotated log files.
-
maxLogFileSize
¶ 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.
-
maxLogFileDurationHrs
¶ Type: float
Specifies the number of hours after which the logs (regular and verbose) are rotated. This is optional.
Note
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:
This rotates the Automation Agent regular and verbose logs.
HTTP Proxy Settings¶
-
httpProxy
¶ 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.
-
krb5ConfigLocation
¶ Type: string
Specifies an absolute path to an non-system-standard location for the Kerberos configuration file.
Note
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.
Ops Manager SSL Settings¶
Specify the settings the Automation Agent uses when communicating with Ops Manager using SSL.
-
sslTrustedMMSServerCertificate
¶ 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.
-
sslRequireValidMMSServerCertificates
¶ Type: boolean
Specifies if the Automation Agent should validate SSL certificates presented by Ops Manager.
Warning
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 tofalse
is only recommended for testing purposes.
-
sslMMSServerClientCertificate
¶ 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 withClient Certificate Mode
set toRequired for Agents Only
orRequired for All Requests
.See also
See
Client Certificate Mode
in Ops Manager Configuration for how to specify this setting in the Ops Manager Application.
-
sslMMSServerClientCertificatePassword
¶ Type: string
Specifies the password needed to decrypt the private key in the
sslMMSServerClientCertificate
file. This setting is required when the client certificatePEM
file is encrypted.