Navigation

Ops Manager Application Settings

Ops Manager stores configuration settings both globally in the Ops Manager Application Database and locally on each server. Global settings apply to all your Ops Manager servers. Local settings apply to the server on which they are configured. Any local settings on a server override the global settings.

You configure global settings through the Ops Manager interface during installation. You can edit global settings at any time through the Admin interface by clicking the General tab and then clicking Ops Manager Config. If you wish to bypass the Ops Manager interface’s initial configuration and use a configuration file, see Bypass Initial Configuration via the User Interface.

You may also include global configuration file settings that do not have a corresponding setting in the Ops Manager interface. To add configuration file settings:

  1. Click the Admin link in the top right corner of Ops Manager to access the settings panels.
  2. From the General tab, go to Ops Manager Config and select the Custom tab.

Note

You configure local settings through a server’s conf-mms.properties file. Each server’s conf-mms.properties must contain the connection string and authentication settings for accessing the Ops Manager Application Database. The conf-mms.properties file also contains any overrides of global settings specific to that server. For more information, see Ops Manager Configuration Settings.

Web Server & Email

Configure global settings through the Admin interface. Ops Manager stores global settings in the Ops Manager Application database.

Web Server

URL to Access Ops Manager

Type: string

FQDN and port number of the Ops Manager Application.

To use a port other than 8080, see Manage Ops Manager Ports.

http://mms.example.com:8080

Corresponds to mms.centralUrl.

HTTPS PEM Key File

Type: string

Absolute path to the PEM file that contains the Ops Manager Application’s valid certificate and private key. The PEM file is required if the Ops Manager Application uses HTTPS to encrypt connections between the Ops Manager Application, the agents, and the web interface.

The default port for HTTPS access to the Ops Manager Application is 8443, as set in <install_dir>/conf/mms.conf file. If you change this default, you must also change the port specified in the URL to Access Ops Manager setting.

Corresponds to mms.https.PEMKeyFile.

HTTPS PEM Key File Password

Type: string

Password for the HTTPS PEM key file. This is required if the PEM file contains an encrypted private key. If storing this in the conf-mms.properties file, you can encrypt the password using the Ops Manager credentialstool.

Corresponds to mms.https.PEMKeyFilePassword.

Client Certificate Mode

Type: string

Default: None

Specifies if Ops Manager requires clients to present valid TLS/SSL client certificates when connecting to it. Accepted values are:

  • None
  • Required for Agents Only
  • Required for All Requests

Corresponds to mms.https.ClientCertificateMode.

CA File

Type: string

Specifies the filesystem location of a certificate authority file containing the list of acceptable client certificates.

/path/to/ca_file.pem

If you want to use a private certificate authority, you must add the mms.https.CAFile as a custom property on the Custom tab of the Ops Manager Config page in the Admin interface.

Corresponds to mms.https.CAFile.

Load Balancer Remote IP Header

Type: string

If you use a load balancer with the Ops Manager Application, set this to the HTTP header field the load balancer uses to identify the originating client’s IP address to the Ops Manager host. When you specify Load Balancer Remote IP Header, do not allow clients to connect directly to any Ops Manager host. A load balancer placed in front of the Ops Manager hosts must not return cached content.

Once Load Balancer Remote IP Header is set, Ops Manager enables the following HTTP headers:

HTTP Header Forwards to Ops Manager
X-Forwarded-Host Original host that the client requested in the Host HTTP request header.
X-Forwarded-Proto Protocol used to make the HTTP request.
X-Forwarded-Server Hostname of the proxy server.
X-Proxied-Https HTTPS status of a request.

To learn more, see Configure a Highly Available Ops Manager Application.

Corresponds to mms.remoteIp.header.

Email

The following email address settings are mandatory. You must define these settings before you can use the Ops Manager Application.

From Email Address

Type: string

Email address used for sending the general emails, such as Ops Manager alerts. You can include an alias with the email address.

Ops Manager Alerts <mms-alerts@example.com>

Corresponds to mms.fromEmailAddr.

Reply To Email Address

Type: string

Email address from which to send replies to general emails.

Corresponds to mms.replyToEmailAddr.

Admin Email Address

Type: string

Email address of the Ops Manager admin. This address receives emails related to problems with Ops Manager.

Corresponds to mms.adminEmailAddr.

Email Delivery Method Configuration

Type: string

Default: SMTP Email Server

Email interface to use.

This setting is labeled in different ways for the user interface and the configuration file.

Delivery Method UI Setting
AWS SES AWS Simple Email Service
SMTP SMTP Email Server

If you set this to SMTP Email Server, you must set:

If you set this to AWS Simple Email Service, you must set:

Corresponds to mms.emailDaoClass.

SMTP

Conditional. The following settings appear if Email Delivery Method Configuration is SMTP Email Server.

Transport

Type: string

Default: smtp

Transfer protocol your email provider specifies:

  • smtp (standard SMTP)
  • smtps (secure SMTP)

Corresponds to mms.mail.transport.

SMTP Server Hostname

Type: string

Default: localhost

Email hostname your email provider specifies.

mail.example.com

Corresponds to mms.mail.hostname.

SMTP Server Port

Type: number

Default: 25

Port number for SMTP your email provider specifies.

Corresponds to mms.mail.port.

Username

Type: string

User name of the email account. If unset, defaults to disabled SMTP authentication.

Corresponds to mms.mail.username.

Password

Type: string

Password for the email account. If unset, defaults to disabled SMTP authentication.

Corresponds to mms.mail.password.

Use SSL

Type: boolean

Default: false

Set this to true if the transfer protocol uses TLS/SSL.

Corresponds to mms.mail.tls.

AWS SES

Conditional. The following settings appear if Email Delivery Method Configuration is AWS Simple Email Service.

AWS Endpoint

Type: string

Default: https://email.us-east-1.amazonaws.com

Sets the sending API endpoint for the AWS SES.

Corresponds to aws.ses.endpoint.

AWS Access Key

Type: string

Access key ID for AWS.

Corresponds to aws.accesskey.

AWS Secret Key

Type: string

Secret access key for AWS.

Corresponds to aws.accesskey.

User Authentication

User Authentication

User Authentication Method

Type: string

Default: Application Database

Select whether to store authentication credentials in the Ops Manager Application Database or in an LDAP directory.

Accepted values are:

  • Application Database
  • LDAP

Corresponds to mms.userSvcClass.

The user interface displays different settings depending on whether you store credentials in the Ops Manager Application Database or in an external authentication source.

Application Database

Password Changes Before Reuse

Type: number

Number of previous passwords to remember. You cannot reuse a remembered password as a new password.

Corresponds to mms.password.minChangesBeforeReuse.

Failed Login Attempts Before Account Lock

Type: number

Number of failed login attempts before an account becomes locked. Only an an Ops Manager Administrator can unlock a locked account.

Corresponds to mms.password.maxFailedAttemptsBeforeAccountLock.

Days Inactive Before Account Lock

Type: number

Maximum number of days with no visits to the Ops Manager website before Ops Manager locks an account.

Corresponds to mms.password.maxDaysInactiveBeforeAccountLock.

Days Before Password Change Required

Type: number

Number of days a password is valid before the password expires.

Corresponds to mms.password.maxDaysBeforeChangeRequired.

Invitation Only Mode

Type: boolean

If true, new users can register by invitation only. The invitation provides a URL that displays the registration link. If false, new users can register if they have the Ops Manager URL.

Corresponds to mms.user.invitationOnly.

LDAP

These settings configure Ops Manager to use an LDAP server for authentication. If you use LDAP authentication, users must belong to an LDAP group to log into Ops Manager. You must create LDAP groups for each Ops Manager user role.

Settings that begin with mms.ldap.global.role assign Ops Manager global roles to the members of the specified LDAP groups. Specify groups using the format used by the LDAP attribute specified in the LDAP User Group setting. You can specify multiple groups using the ;; delimiter. To change the default delimiter, use the mms.ldap.group.separator setting. Each Ops Manager global role provides its level of access to all the Ops Manager projects in the deployment. To provide access to specific groups, use group-level roles.

LDAP URI

Type: string

URI for the LDAP or LDAPS server.

ldaps://acme-dc1.acme.example.com:3890

Corresponds to mms.ldap.url.

LDAP SSL CA File

Type: string

A file containing one or more trusted certificates in PEM format. Use this setting if you are using LDAPS and the server is using a certificate that is not from a well-known Certificate Authority.

/opt/CA.pem

Corresponds to mms.ldap.ssl.CAFile.

LDAP SSL PEM Key File

Type: string

A file containing a client certificate and private key. Use this setting when your TLS/SSL LDAP server requires client certificates.

/opt/keyFile.pem

Corresponds to mms.ldap.ssl.PEMKeyFile.

LDAP SSL PEM Key File Password

Type: string

Password for LDAP SSL PEM Key File. Use this setting if the PEMKeyFile is encrypted.

Corresponds to mms.ldap.ssl.PEMKeyFilePassword.

LDAP Bind Dn

Type: string

LDAP user used to execute searches for other users.

authUser@acme.example.com

Corresponds to mms.ldap.bindDn.

LDAP Bind Password

Type: string

Password for the search user.

Corresponds to mms.ldap.bindPassword.

LDAP User Base Dn

Type: string

Base Distinguished Name (DN) that Ops Manager uses to search for users.

DC=acme,DC=example,DC=com

Corresponds to mms.ldap.user.baseDn.

LDAP Group Base Dn

Base Distinguished Name (DN) that Ops Manager uses to search for groups. If not specified, it will default to the value specified in LDAP User Base Dn

OU=groups,DC=acme,DC=com

Corresponds to mms.ldap.group.baseDn.

LDAP User Search Attribute

Type: string

LDAP field used for the LDAP search. This is typically a username or an email address. The value of this field is also used as the Ops Manager username.

Corresponds to mms.ldap.user.searchAttribute.

LDAP Group Member Attribute

Field on the group entry containing user Distinguished Names (DN). The groupOfNames or groupOfUniqueNames object classes are commonly used.

member

Corresponds to mms.ldap.group.member.

LDAP User Group

Type: string

LDAP user attribute that contains the list of LDAP groups the user belongs to. The LDAP attribute can use any format to list the projects, including Common Name (cn) or Distinguished Name (dn). All Ops Manager settings in this configuration file that specify projects must match the chosen format.

memberOf

Corresponds to mms.ldap.user.group.

LDAP Global Role Owner

Type: string

LDAP group that has full privileges for the Ops Manager deployment, including full access to all Ops Manager projects and all administrative permissions. Users in the specified LDAP group receive the global owner role in Ops Manager. Specify the project using the format that is used by the LDAP attribute specified in the LDAP User Group setting.

CN=MMSGlobalOwner,OU=MMS,OU=acme Groups,DC=acme,DC=example,DC=com

Corresponds to mms.ldap.global.role.owner.

LDAP Referral

Default: ignore

LDAP field used to set how to handle referrals. Accepts two values:

  • ignore: Ignore referrals.
  • follow: Automatically follow any referrals.

Corresponds to mms.ldap.referral.

LDAP User First Name

Type: string

LDAP user attribute that contains the user’s first name. After successful LDAP authentication, Ops Manager synchronizes the specified LDAP attribute with the first name from the Ops Manager user record.

Per RFC2256, the default LDAP attribute is givenName.

givenName

Corresponds to mms.ldap.user.firstName.

LDAP User Last Name

Type: string

LDAP user attribute that contains the user’s last name. After successful LDAP authentication, Ops Manager synchronizes the specified LDAP attribute with the last name from the Ops Manager user record.

Per RFC2256, the default LDAP attribute is sn for surname.

sn

Corresponds to mms.ldap.user.lastName.

LDAP User Email

Type: string

LDAP user attribute that contains the user’s email address. After successful LDAP authentication, Ops Manager synchronizes the specified LDAP attribute with the email address from the Ops Manager user record.

Per RFC2256, the default LDAP attribute is mail.

mail

Corresponds to mms.ldap.user.email.

LDAP Global Role Automation Admin

Type: string

LDAP group whose members have the global automation admin role in Ops Manager. Specify projects using the format used by the LDAP attribute specified in the LDAP User Group setting. You can specify multiple projects using the ;; delimiter. To change the default delimiter, use the mms.ldap.project.separator setting.

CN=MMS-AutomationAdmin,OU=MMS,OU=acme Groups,DC=acme,DC=example,DC=com

Each Ops Manager global role provides its level of access to all the Ops Manager projects in the deployment. To provide access to specific projects, use group-level roles.

Corresponds to mms.ldap.global.role.automationAdmin.

LDAP Global Role Backup Admin

Type: string

LDAP group whose members have the global backup admin role in Ops Manager.

CN=MMS-BackupAdmin,OU=MMS,OU=acme Groups,DC=acme,DC=example,DC=com

Corresponds to mms.ldap.global.role.backupAdmin.

LDAP Global Role Monitoring Admin

Type: string

LDAP group whose members have the global monitoring admin role in Ops Manager.

CN=MMS-MonitoringAdmin,OU=MMS,OU=acme Groups,DC=acme,DC=example,DC=com

Corresponds to mms.ldap.global.role.monitoringAdmin.

LDAP Global Role User Admin

Type: string

LDAP group whose members have the global user admin role in Ops Manager.

CN=MMS-UserAdmin,OU=MMS,OU=acme Groups,DC=acme,DC=example,DC=com

Corresponds to mms.ldap.global.role.userAdmin.

LDAP Global Role Read Only

Type: string

LDAP group whose members have the global read-only role in Ops Manager.

CN=MMS-ReadOnly,OU=MMS,OU=acme Groups,DC=acme,DC=example,DC=com

Corresponds to mms.ldap.global.role.readOnly.

Multi-Factor Authentication (MFA)

Multi-factor Auth Level

Type: string

Default: OFF

Configures the two-factor authentication “level”:

Setting Description
OFF Disables two-factor authentication. Ops Manager does not use two-factor authentication.
OPTIONAL Users can choose to set up two-factor authentication for their Ops Manager account.
REQUIRED_FOR_GLOBAL_ROLES Users who possess a global role must set up two-factor authentication. Two factor authentication is optional for all other users.
REQUIRED All users must set up two-factor authentication for their Ops Manager account.

Two-factor authentication is recommended for the security of your Ops Manager deployment.

Warning

If enabling mms.multiFactorAuth.level through the configuration file, you must create a user account first before updating the configuration file. Otherwise, you cannot login to Ops Manager.

Note

If you enable Twilio integration (optional), ensure that Ops Manager servers can access the twilio.com domain.

Corresponds to mms.multiFactorAuth.level.

Multi-factor Auth Allow Reset

Type: boolean

Default: false

When true, Ops Manager allows users to reset their two-factor authentication settings via email in an analogous fashion to resetting their passwords.

To reset two-factor authentication, a user must:

  • be able to receive email at the address associated with the user account.
  • know the user account’s password.
  • know the agent API key for each Ops Manager project the user belongs to.

Corresponds to mms.multiFactorAuth.allowReset.

Multi-factor Auth Issuer

Type: string

If Google Authenticator provides two-factor authentication, this string is the issuer in the Google Authenticator app. If left blank, the issuer is the domain name of the Ops Manager installation.

Corresponds to mms.multiFactorAuth.issuer.

Other Authentication Options

ReCaptcha Enabled On Registration

Default: false

Flag that indicates you want a new user to validate themselves using reCaptcha validation when they register to use Ops Manager.

Set to true to require reCaptcha validation when a new user registers.

This setting requires a reCaptcha account.

Corresponds to reCaptcha.enabled.registration.

ReCaptcha Enabled On Login

Type: boolean

Default: false

Flag that indicates you want a user to validate themselves using reCaptcha validation when they log into Ops Manager.

Set to true to require reCaptcha validation when a user logs in.

This setting requires a reCaptcha account.

Corresponds to reCaptcha.enabled.

Session Max Hours

Type: number

Number of hours before a session on the Ops Manager website expires.

Set this value to 0 to use browser session cookies only.

Corresponds to mms.session.maxHours.

New Device Login Notification

Flag that indicates the user should be notified that they have logged in from a new device.

Corresponds to mms.login.newDeviceNotification.enabled.

ReCaptcha Public Key

Type: string

ReCaptcha public key associated with your account.

Corresponds to reCaptcha.public.key.

ReCaptcha Private Key

Type: string

ReCaptcha private key associated with your account.

Corresponds to reCaptcha.private.key.

Backup

The following settings determine:

  • How much Ops Manager compresses file system store snapshots.
  • How frequently Ops Manager takes snapshots.
  • How long Ops Manager stores snapshots.

To set these values, click the Admin link, then the General tab, then the Ops Manager Config page, and then the Backup section.

See also

See Snapshot Frequency and Retention Policy to learn more about how often snapshots are taken and how long they can be retained.

Backup Snapshots

File System Store Gzip Compression Level

Type: integer

Default: 6

Determines how much Ops Manager compresses file system-based snapshots. The level ranges from 0 to 9:

  • 0 provides no compression.
  • 1 to 9 increases the degree of compression at a cost of how fast the snapshot is compressed. Level 1 compresses snapshots the least but at the fastest speed. Level 9 compresses snapshots the most but at the slowest speed.

Note

Changing File System Store Gzip Compression Level affects new snapshots only. It does not affect the compression level of existing snapshots.

Corresponds to backup.fileSystemSnapshotStore.gzip.compressionLevel.

Backup Snapshots Schedule

Snapshot Interval

Type: integer

Default: 24

Specifies the time, in hours, between two consecutive snapshots.

Accepted values are:

6, 8, 12, or 24

Corresponds to brs.snapshotSchedule.interval.

Base Retention of Snapshots

Type: integer

Default: 2

Specifies how many days an interval snapshot is stored.

Accepted values are: 2, 3, 4, or 5 .

Corresponds to brs.snapshotSchedule.retention.base.

Daily Retention of Snapshots

Type: integer

Default: 0

Specifies how many days a daily snapshot is stored.

Accepted values are:

  • No daily retention
  • One of the following integers: 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, or 360

Corresponds to brs.snapshotSchedule.retention.daily.

Weekly Retention of Snapshots

Type: integer

Default: 2

Specifies how many weeks a weekly snapshot is stored.

Accepted values are:

  • No weekly retention
  • One of the following integers: 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, and 52

Corresponds to brs.snapshotSchedule.retention.weekly.

Monthly Retention of Snapshots

Type: integer

Default: 1

Specifies how many months a monthly snapshot is stored.

Accepted values are:

  • No monthly retention
  • One of the following integers: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, or 36

Corresponds to brs.snapshotSchedule.retention.monthly.

Restore Digest Method

Type: string

Default: SHA1

Specifies whether or not to generate a SHA1 checksum for restore archive files.

Accepted values are SHA1 or NONE.

Corresponds to brs.restore.digest.method.

KMIP Server Configuration

KMIP Server Host

Type: string

Default: None

Specifies the hostname of a KMIP server.

Corresponds to backup.kmip.server.host.

KMIP Server Port

Type: integer

Default: 5696

Specifies the port of the KMIP server.

Corresponds to backup.kmip.server.port.

KMIP Server CA File

Type: string

Default: /opt/mongodb-mms/classes/kmip_server_test.pem

Specifies a .PEM-format file that contains one or more certificate authorities.

Corresponds to backup.kmip.server.ca.file.

Queryable Snapshot Configuration

Proxy Server Port

Type: integer

Default: 25999

Port for the queryable backup host.

Note

After updating Proxy Server Port, restart the Web Server for the change to take effect.

Corresponds to brs.queryable.proxyPort.

Proxy Server PEM File

Type: string

Default: /etc/mongodb-mms/queryable-backup.pem

Required if using Queryable Snapshot. The Certificate Authority PEM file that contains one or more trusted certificates and the associated private keys.

Proxy Server PEM File has the following restrictions:

  • The PEM should use a key length greater than 512-bit. Using a 2048-bit RSA key is recommended.
  • The PEM should use a message digest stronger than sha1, such as sha256.

Note

After updating Proxy Server PEM File, restart the Web Server for the change to take effect.

Corresponds to brs.queryable.pem.

Proxy Server PEM File Password

Type: string

Required if Proxy Server PEM File is encrypted.

Note

After updating Proxy Server PEM File Password, restart the Web Server for the change to take effect.

Corresponds to brs.queryable.pem.pwd.

Expiration

Type: integer

Default: 24

Duration time in hours for a Queryable Snapshop once initiated.

Corresponds to brs.queryable.expiration.

Read Cache Size

Default: 512

Size (in megabytes) that you allocate from the JVM heap for the global snapshot cache. The global snapshot cache optimizes repeated queries for the same snapshot data to the Queryable Snapshots.

Important

MongoDB does not advise changing this value unless MongoDB support directs you to change it.

Corresponds to brs.queryable.lruCacheCapacityMB.

Queryable Startup Timeout

Default: 60

Number of seconds to wait for the Queryable Snapshot to prepare before timing out.

Corresponds to brs.queryable.mounttimeout.

Mongo Connection Timeout

Default: 30

Number of seconds to wait for a connection to the Queryable Snapshot mongod instance before timing out.

Corresponds to brs.queryable.connecttimeout.

Permissions

Usage Information Collection

Toggle to On to allow MongoDB, Inc. to collect generic usage information.

Miscellaneous

HTTP/HTTPS Proxy

Proxy Host

Type: string

Specify the hostname of the HTTP or HTTPS proxy to which you wish to connect.

proxy.example.com

Corresponds to http.proxy.host.

Proxy Port

Type: integer

Specify the port on which you wish to connect to the host. You must specify both the Proxy Port and Proxy Host to use a proxy.

Corresponds to http.proxy.port.

Proxy Username

Type: string

If the proxy requires authentication, use this setting to specify the username with which to connect to the proxy.

Corresponds to http.proxy.username.

Proxy Password

Type: string

If the proxy requires authentication, use this setting to specify the password with which to connect to the proxy.

Corresponds to http.proxy.password.

Twilio Integration

To receive alert notifications via SMS or 2FA code, you must have a Twilio account.

Account SID

Type: string

Twilio account ID.

Corresponds to twilio.account.sid.

Twilio Auth Token

Type: string

Twilio API token.

Corresponds to twilio.auth.token.

Twilio From Number

Type: string

Twilio phone number.

Corresponds to twilio.from.num.

MongoDB Version Management

The following settings determine how Ops Manager knows what MongoDB releases exist and how the MongoDB binaries are supplied to the Ops Manager server. The Automation Agents and Backup Daemons use these binaries when deploying MongoDB.

Installer Download Source

Type: string

Default: Direct Connection to MongoDB

Indicates the source of MongoDB installer binaries.

Accepted values for Installer Download Source include:

  • Direct connection to MongoDB
  • Ops Manager Application Server

If your Automation Agents and Backup Daemons do not have internet access to download MongoDB binaries, set Installer Download Source to Direct connection to MongoDB .

If you set Installer Download Source to Direct connection to MongoDB, you must set Ops Manager gets installers from:.

Accepted values for Ops Manager gets installers from: include:

  • Direct connection to MongoDB
  • Ops Manager Application Server Hard Drive

If you set Installer Download Source to Direct connection to MongoDB and Ops Manager gets installers from: to Ops Manager Application Server Hard Drive, an Ops Manager admin must upload the version manifest and the MongoDB binaries to the Ops Manager host, as described in Configure Deployment to Have Limited Internet Access.

Corresponds to automation.versions.source.

Versions Directory

Type: string

Default: Windows: C:\MMSData\MongoDBReleases Linux / macOS: /opt/mongodb/mms/mongodb-releases/

Specify the directory on the Ops Manager Application server where Ops Manager stores the MongoDB binaries. The Automation Agent accesses the binaries when installing or changing versions of MongoDB on your deployments. If you set Version Manifest Source to run in Local mode, the Backup Daemons also access the MongoDB binaries from this directory. See Configure Deployment to Have Limited Internet Access for more information.

Corresponds to automation.versions.directory.

Backup Versions Auto Download

Type: boolean

Default: True

Flag indicating whether the Backup Daemons automatically install the versions of MongoDB that the Backup Daemons need.

true The daemons retrieve the binaries from MongoDB Inc. over the internet.
false Backup Daemons do not have internet access and require that an Ops Manager administrator manually download and extract every archived version of a MongoDB release that the backup daemons need. The administrator must place the extracted binaries into the Versions Directory on the Ops Manager hosts.

Warning

Set to false when Ops Manager is running in Local Mode.

Corresponds to mongodb.release.autoDownload.

Backup Versions Auto Download Enterprise Builds

Type: boolean

Flag indicating whether the Backup Daemons automatically install the Enterprise editions of the versions of MongoDB that the Backup Daemons need. Requires Backup Versions Auto Download be set to true.

Warning

If you plan on running MongoDB Enterprise on Linux hosts, then you must manually install a set of dependencies to each host before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies.

See Configure Deployment to Have Limited Internet Access.

Corresponds to mongodb.release.autoDownload.enterprise.

Required Module For Backup

Type: string

Default: Enterprise Preferred

Specifies whether to use MongoDB Community or Enterprise binaries for backup.

Accepted values are:

  • Enterprise Preferred
  • Enterprise Required
  • Community Required

When Enterprise Required or Community Required is selected, Ops Manager only uses those binaries for backup. When Enterprise Preferred is selected, Ops Manager uses Enterprise binaries if available and Community binaries if they are not.

Note

When Enterprise Required is selected, you must either set Backup Versions Auto Download Enterprise Builds to true or manually place Enterprise binaries in the Versions Directory in Local Mode.

Warning

Backup fails when either Enterprise Required or Community Required is selected, but the Versions Directory does not contain the required binary.

Corresponds to mongodb.release.modulePreference.

Default Monitoring Data Retention

Ops Manager gathers metric data at a 10-second granularity. The Default Monitoring Data Retention table determines how long Ops Manager stores metric data. For each increasing granularity level, Ops Manager computes the data based on the averages from the previous granularity level.

The table determines the default settings for new groups. If you change the settings, Ops Manager prompts you whether to also apply the settings to existing groups. To change the settings for a specific group without changing the Ops Manager default settings, see Projects Page.

Increasing the retention period for a granularity requires more storage on the Ops Manager Application Database.

Note

Decreasing the retention period for existing groups does not immediately recovery available disk space on the file system and can actually use more disk space in the short term during the transition to the shorter retention period.

Default Monitoring Data Retention 1 Minute

Type: string

Default: 2 days

Length of time that Ops Manager stores metric data at the minute granularity level. Ops Manager computes the data based on the averages from the hourly granularity level.

The default setting applies to new projects. If you change this settings, Ops Manager prompts you whether to also apply that change to existing projects. To change the settings for a specific project without changing the Ops Manager default settings, see Projects Page.

Accepted values are:

  • 2 days
  • 14 days

Increasing the retention period for a granularity requires more storage on the Ops Manager Application Database.

Default Monitoring Data Retention 1 Hour

Type: string

Default: 2 months

Length of time that Ops Manager stores metric data at the hourly granularity level. Ops Manager computes the data based on the averages from the daily granularity level.

The default setting applies to new projects. If you change this settings, Ops Manager prompts you whether to also apply that change to existing projects. To change the settings for a specific project without changing the Ops Manager default settings, see Projects Page.

Accepted values are:

  • 2 months
  • 12 months

Increasing the retention period for a granularity requires more storage on the Ops Manager Application Database.

Default Monitoring Data Retention 1 Day

Type: string

Default: Forever

Length of time that Ops Manager stores metric data at the daily granularity level.

The default setting applies to new projects. If you change this settings, Ops Manager prompts you whether to also apply that change to existing projects. To change the settings for a specific project without changing the Ops Manager default settings, see Projects Page.

Increasing the retention period for a granularity requires more storage on the Ops Manager Application Database.

Alerts

Webhook URL

Corresponds to mms.alerts.webhook.adminEndpoint.

Webhook Secret

Corresponds to mms.alerts.webhook.adminSecret.