Automation Configuration Parameters

array of objects

Required

Specification objects for the MongoDB instances found in the processes array. Each MongoDB instance in processes must have a specification object in mongoDbVersions[n].

string

Required

Name of the specification object. The specification object is attached to a MongoDB instance through the instance's processes.version parameter in this configuration.

array of objects

Required

Builds available for this MongoDB instance.

string

Required

Platform for this MongoDB instance.

string

Required

URL from which to download MongoDB for this instance.

string

Required

Commit identifier that identifies the state of the code used to build the MongoDB process. The MongoDB buildInfo command returns the gitVersion identifier.

array

Required

List of modules for this version. Corresponds to the modules parameter that the buildInfo command returns.

string

Required

Processor's architecture. Cloud Manager accepts amd64 or ppc64le.

integer

Deprecated

Processor's bus width. Don't remove or make modifications to this parameter.

Boolean

Optional

Set to true if this is a Windows build that requires either Windows 7 later or Windows Server 2008 R2 or later.

string

Optional

URL from which the required version of the Microsoft Visual C++ redistributable can be downloaded.

array of strings

Optional

String values that list the command-line options to be specified when running the Microsoft Visual C++ redistributable installer. Each command-line option is a separate string in the array.

string

Optional

Name of the Microsoft Visual C++ runtime DLL file that the agent checks to determine if a new version of the Microsoft Visual C++ redistributable is needed.

string

Optional

Minimum version of the Microsoft Visual C++ runtime DLL that must be present to skip over the installation of the Microsoft Visual C++ redistributable.

array

Required

Contains objects that define the mongos and mongod instances that Cloud Manager monitors. Each object defines a different instance.

object

Required

MongoDB configuration object for MongoDB versions 2.6 and later.

The processes.args2_6 object accepts most MongoDB settings and parameters for MongoDB versions 2.6 and later. To learn more, see MongoDB Settings and Automation Support.

string

Optional

Hostname alias (often a DNS CNAME) for the host on which the process runs. If an alias is specified, the MongoDB Agent prefers this alias over the hostname specified in processes.hostname when connecting to the host. You can also specify this alias in replicaSets.host and sharding.configServer.

integer

Required

Schema version of the user credentials for MongoDB database users. This should match all other elements of the processes array that belong to the same cluster.

• Cloud Manager accepts 3 and 5 for this parameter.

• MongoDB 3.x and 4.x clusters default to 5.

• MongoDB 2.6 clusters default to 3.

To learn more, see Upgrade to SCRAM-SHA-1 in the MongoDB 3.0 release notes.

string

Optional

Delivery URL for the restore. Cloud Manager sets this when creating a restore. To cancel an in-progress restore operation, set this option to CANCEL.

To learn more, see Automate Backup Restoration through the API.

string

Conditional

Name of the sharded cluster. Set this value to the same value in the sharding.name parameter in the sharding array for the mongos.

• Required for a mongos.

• Not needed for a mongod.

string

Optional

Consistency and isolation properties set for the data read from replica sets and replica set shards. MongoDB Atlas accepts the following values:

• "available"

• "local"

• "majority"

boolean

Optional

Flag that indicates whether the write acknowledgement must be written to the on-disk journal.

string

Optional

Desired number of mongod instances that must acknowledge a write operation in a replica sets and replica set shards. MongoDB Atlas accepts the following values:

• Any number 0 or greater

• "majority"

number

Optional

Desired time limit for the write concern expressed in milliseconds. Set this value when you set defaultRWConcern.defaultWriteConcern.w to a value greater than 1.

Boolean

Optional

Flag that indicates if this process should be shut down. Set to true to shut down the process.

string

Required

Version of MongoDB with which this process has feature compatibility. Changing this value can enable or disable certain features that persist data incompatible with MongoDB versions earlier or later than the featureCompatibilityVersion you choose.

• Cloud Manager accepts 3.2, 3.6, 4.0 and 4.2 as parameter values. If you have an existing deployment, Cloud Manager only accepts a featureCompatibilityVersion equal to or one release older than the MongoDB version you deployed. To learn which of these parameter values is supported for each MongoDB version, and which features each of these values enable or disable, see setFeatureCompatibilityVersion in the MongoDB Manual.

• Cloud Manager sets this parameter to match the MongoDB version for new deployments.

• Cloud Manager doesn't automatically increment this parameter when you upgrade a host from one MongoDB version to the next.

To learn more, see setFeatureCompatibilityVersion.

string

Required

Name of the host that serves this process. This defaults to localhost.

string

Optional

Timestamp in ISO 8601 date and time format in UTC when Cloud Manager last reclaimed free space on a cluster's disks. During certain operations, MongoDB might move or delete data but it doesn't free the currently unused space. Cloud Manager reclaims the disk space in a rolling fashion across members of the replica set or shards.

To reclaim this space:

• Immediately, set this value to the current time as an ISO 8601 timestamp.

• Later, set this value to a future ISO 8601 timestamp. Cloud Manager reclaims the space after the current time passes the provided timestamp.

To remove any ambiguity as to when you intend to reclaim the space on the cluster's disks, specify a time zone with your ISO 8601 timestamp. For example, to set processes.lastCompact to 28 January 2021 at 2:43:52 PM US Central Standard Time, use "processes.lastCompact" : "2021-01-28T14:43:52-06:00"

string

Optional

Timestamp in ISO 8601 date and time format in UTC when Cloud Manager last restarted this process. If you set this parameter to the current timestamp, Cloud Manager forces a restart of this process after you upload this configuration. If you set this parameter for multiple processes in the same cluster, the Cloud Manager restarts the selected processes in a rolling fashion across members of the replica set or shards.

string

Optional

Timestamp in ISO 8601 date and time format in UTC of the last initial sync process that Cloud Manager performed on the node.

To trigger the init sync process on the node immediately, set this value to the current time as an ISO 8601 timestamp.

WARNING: Use this parameter with caution. During initial sync, Automation removes the entire contents of the node's dbPath directory.

If you set this parameter:

• On the secondary node, the MongoDB Agent checks whether the specified timestamp is later than the time of the last resync, and if confirmed, starts init sync on this node.

  For example, to set processes.lastResync on the secondary node to 28 May 2021 at 2:43:52 PM US CentralStandard Time, use:

  "processes.lastResync" : "2021-05-28T14:43:52-06:00"

  If the MongoDB Agent confirms that this timestamp is later than the recorded time of the last resync, it starts init sync on the node.

• On the primary node, the MongoDB Agent waits until you ask the primary node to become the secondary with the rs.stepDown() method, and then starts init sync on this node.

• On all of the nodes in the same cluster, including the primary, the MongoDB Agent checks whether the specified timestamp is later than the time of the last resync, and if confirmed, starts init sync on the secondary nodes in a rolling fashion. The MongoDB Agent waits until you ask the primary node to become the secondary with the rs.stepDown() method, and then starts init sync on this node.

To learn more, see Initial Sync.

string

Optional

Timestamp in ISO 8601 date and time format in UTC when Cloud Manager last rotated the master KMIP key. If you set this parameter to the current timestamp, Cloud Manager rotate the key after you upload this configuration.

object

Optional

MongoDB configuration object for rotating the MongoDB logs of a process.

integer

Optional

Total number of log files that Cloud Manager retains. If you don't set this value, the total number of log files defaults to 0. Cloud Manager bases rotation on your other processes.logRotate settings.

integer

Optional

Maximum number of total log files to leave uncompressed, including the current log file. The default is 5.

number

Optional

Maximum percentage of total disk space that Cloud Manager can use to store the log files expressed as decimal. If this limit is exceeded, Cloud Manager deletes compressed log files until it meets this limit. Cloud Manager deletes the oldest log files first.

The default is 0.02.

number

Required

Maximum size in MB for an individual log file before Cloud Manager rotates it. Cloud Manager rotates the log file immediately if it meets the value given in either this sizeThresholdMB or the processes.logRotate.timeThresholdHrs limit.

integer

Required

Maximum duration in hours for an individual log file before the next rotation. The time is since the last rotation.

Cloud Manager rotates the log file once the file meets either this timeThresholdHrs or the processes.logRotate.sizeThresholdMB limit.

Boolean

Optional

Flag that indicates if MongoDB Agent automates this process.

• This defaults to false.

• Set to true to disable Automation on this process. The MongoDB Agent takes no further actions on this process.

• Set to false to enable Automation on this process. The MongoDB Agent automates actions on this process.

string

Required

Unique name to identify the instance.

integer

Optional

Number of cores that Cloud Manager should bind to this process. The MongoDB Agent distributes processes across the cores as evenly as possible.

string

Required

Type of MongoDB process being run. Cloud Manager accepts mongod or mongos for this parameter.

string

Required

Name of the mongoDbVersions specification used with this instance.

array

Optional

Configuration of each replica set. The MongoDB Agent uses the values in this array to create valid replica set configuration documents. The agent regularly checks that replica sets are configured correctly. If a problem occurs, the agent reconfigures the replica set according to its configuration document. The array can contain the following top-level fields from a replica set configuration document: _id; version; and members.

To learn more, see replSetGetConfig.

string

Required

The name of the replica set.

string

Optional

Protocol version of the replica set.

array

Optional

Objects that define each member of the replica set. The members.host field must specify the host

To learn more, see replSetGetConfig and replSetGetConfig.

integer

Optional

Any positive integer that indicates the member of the replica set.

string

Optional

Hostname, and port number when applicable, that serves this replica set member.

boolean

Optional

Flag that indicates whether this replica set member acts as an arbiter.

boolean

Optional

Flag that indicates whether the mongod process builds indexes on this replica set member.

boolean

Optional

Flag that indicates whether the replica set allows this member to accept read operations.

number

Optional

Relative eligibility for Cloud Manager to select this replica set member as a primary. Larger number increase eligibility. This value can be between 0 and 1000, inclusive for data-bearing nodes. Arbiters can have values of 0 or 1.

object

Optional

List of user-defined labels and their values applied to this replica set member.

integer

Optional

Amount of time in seconds that this replica set memberr should lag behind the primary.

number

Optional

Quantity of votes this replica set member can cast for a replica set election. All data bearing nodes can have 0 or 1 votes. Arbiters always have 1 vote.

object

Optional

Instructions to the MongoDB Agent to force a replica set to use the Configuration Version specified in replicaSets.force.CurrentVersion.

With this object, the MongoDB Agent can force a replica set to accept a new configuration to recover from a state in which a minority of its members are available.

integer

Optional

Configuration Version that the MongoDB Agent forces the replica set to use. Set to -1 to force a replica set to accept a new configuration.

WARNING: Forcing a replica set reconfiguration might lead to a rollback of majority-committed writes. Proceed with caution. Contact MongoDB Support if you have questions about the potential impacts of this operation.

array of objects

Optional

Objects that define the configuration of each sharded cluster. Each object in the array contains the specifications for one cluster. The MongoDB Agent regularly checks each cluster's state against the specifications. If the specification and cluster don't match, the agent will change the configuration of the cluster, which might cause the balancer to migrate chunks.

boolean

Conditional

Flag that indicates whether Cloud Manager Automation manages all sharded collections and tags in the deployment

string

Conditional

Name of the cluster. This must correspond with the value in processes.cluster for a mongos.

string

Conditional

Name of the config server replica set.

You can add this array parameter if your config server runs as a replica set.

If you run legacy mirrored config servers that don't run as a replica set, use sharding.configServer.

array of strings

Conditional

Names of the config server hosts. The host names match the names used in each host's processes.name parameter.

IMPORTANT: MongoDB 3.4 removes support for mirrored config servers. If your sharded cluster runs MongoDB 3.4 or later, use sharding.configServerReplica.

array of objects

Conditional

Objects that define the sharded collections and their shard keys.

string

Conditional

namespace of the sharded collection. The namespace is the combination of the database name and the name of the collection. For example, testdb.testcoll.

array of arrays

Conditional

Collection's shard keys. It contains:

• One array if your cluster uses one shard key.

• Multiple arrays if your cluster uses a compound shard key.

boolean

Conditional

Flag that indicates whether MongoDB enforces uniqueness for the shard key.

array of objects

Conditional

Cluster's shards.

string

Conditional

Name of the shard.

string

Conditional

Name of the shard's replica set. This is specified in the replicaSets._id parameter.

array of strings

Conditional

Zones assigned to this shard.

You can add this array parameter if you use zoned sharding.

array of objects

Conditional

Definition of zones for zoned sharding. Each object in this array defines a zone and configures the shard key range for that zone.

string

Conditional

Namespace of the collection that uses zoned sharding. The namespace combines the database name and the name of the collection. For example: testdb.testcoll.

array

Conditional

Minimum value of the shard key range.

Specify the field name, field type, and value in a document of the following form.

{
  "field" : <string>,
  "fieldType" : <string>,
  "value" : <string>
}

fieldType must be one of the following:

• string

• integer

• long

• double

• decimal

• date

• timestamp

• oid

• minKey

• maxKey

value must be passed in as a string value.

To use a compound shard key, specify each field in a separate document, as shown in the example after this table. For more information on shard keys, see Shard Keys in the MongoDB manual.

array

Conditional

Maximum value of the shard key range.

Specify the field name, field type, and value in a document of the following form.

{
  "field" : <string>,
  "fieldType" : <string>,
  "value" : <string>
}

fieldType must be one of the following:

• string

• integer

• long

• double

• decimal

• date

• timestamp

• oid

• minKey

• maxKey

value must be passed in as a string value.

To use a compound shard key, specify each field in a separate document, as shown in the example after this table. For more information on shard keys, see Shard Keys in the MongoDB manual.

string

Conditional

Name of the zone associated with the shard key range specified by sharding.tags.min and sharding.tags.max.

array of objects

Optional

Roles and privileges that MongoDB has assigned to a cluster's user-defined roles. Each object describes a different user-defined role. Objects in this array contain the same fields as documents in the system roles collection, except for the _id field.

string

Conditional

Name of the user-defined role.

string

Conditional

Database to which the user-defined role belongs.

array of documents

Conditional

Privileges this role can perform.

string

Conditional

Specifies the resources upon which the privilege actions apply.

string

Conditional

Actions permitted on the resource.

To learn more, see Privilege Actions.

array of documents

Conditional

Roles from which this role inherits privileges.

array of documents

Optional

Authentication restrictions that the MongoDB server enforces on this role.

WARNING: If a user inherits multiple roles with incompatible authentications restrictions, that user becomes unusable. For example, if a user inherits one role in which the clientSource field is [198.51.100.0] and another role in which the clientSource field is [203.0.113.0], the server is unable to authenticate the user. For more information about authentication in MongoDB, see Authentication.

array of strings

Conditional

If present, when authenticating a user, the MongoDB server verifies that the client's IP address is either in the given list or belongs to a CIDR range in the list. If the client's IP address is not present, the MongoDB server does not authenticate the user.

array of strings

Conditional

Comma-separated array of IP addresses to which the client can connect. If present, the MongoDB server verifies that it accepted the client's connection from an IP address in the given array. If the MongoDB server accepts a connection from an unrecognized IP address, the MongoDB server does not authenticate the user.