- Reference >
- Automation Agent >
- Automation Agent Configuration
Automation Agent Configuration¶
On this page
Configuration File¶
The location of the Automation Agent configuration file depends on your operating system:
RHEL, CentOS, Amazon Linux, and Ubuntu all use a package manager to install the agent. The package manager creates the following agent configuration file:
/etc/mongodb-mms/automation-agent.config
OS X, Windows, and other Linux systems use either a
tar
ormsi
file for the installation. The Automation Agent stores its configuration in the following file:<installation directory>/local.config
Settings¶
Ops Manager provides default values for many of the Automation Agent
Configuration settings. However, you must set the
mmsGroupId
and mmsApiKey
values.
Connection Settings¶
-
mmsGroupId
¶ Type: string
Required. The ID of your Ops Manager group. You can find it in Ops Manager under the Group Settings page in the Settings tab.
For example:
-
mmsApiKey
¶ Type: string
Required. The Ops Manager agent API key for the group. To retrieve the key from the Ops Manager interface, click the Settings tab, then the Group Settings page.
For example:
-
mmsBaseUrl
¶ Type: string
The URL of the Ops Manager Web Server.
Set this to the URL of your HTTP Service. For example:
-
logFile
¶ Type: string
The path to which Ops Manager should write the automation agent’s log. By default, the path is
/var/log/mongodb-mms-automation/automation-agent.log
, but you can choose an alternate location if desired.For example:
-
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/
.
Logging Settings¶
-
logLevel
¶ Type: string
The level of logging granularity. You can choose from the following severity levels, from most verbose to least. By default,
logLevel
isINFO
.DEBUG
ROUTINE
INFO
WARN
ERROR
DOOM
For example:
Each level includes the log items covered by the following levels. For instance, if you choose
DEBUG
, the Automation Agent logs all messages, includingROUTINE
,INFO
,WARN
,ERROR
, andDOOM
. By contrast, if you chooseDOOM
, the Automation Agent only logsDOOM
messages.
-
maxLogFiles
¶ Type: integer
The maximum number of rotate log files to retain. By default,
maxLogFiles
is10
. You can change the value to retain a different number of rotated log files. For example:
-
maxLogFileSize
¶ Type: integer
Specifies the maximum size, in bytes, that a log file can be before triggering log rotation. For example:
HTTP Proxy Settings¶
-
httpProxy
¶ Type: string
To configure the Automation Agent to use an HTTP proxy, specify the URL of the proxy. For example:
MongoDB Kerberos Settings¶
Specify these settings if the Automation Agent authenticates to hosts using Kerberos. See Configure the Backup Agent for Kerberos.
-
krb5ConfigLocation
¶ Type: string
The absolute path to an non-system-standard location for the Kerberos configuration file. For example:
MongoDB SSL Settings¶
-
sslTrustedMMSServerCertificate
¶ Type: string
The path on disk that contains the trusted certificate authority certificates in PEM format. Because the Automation agent can pass
sslTrustedMMSServerCertificate
to the other agents, which may have different paths relative to the automation agent, specify the absolute path to the certificate. This certificate verifies that the agent is talking to the Ops Manager servers.
-
sslRequireValidMMSServerCertificates
¶ Type: boolean
Use this option to disable certificate verification by setting this value to
false
. This configuration is recommended only for testing purposes as it makes connections susceptible to man-in-the-middle attacks.