Cluster Parameters for a Self-Managed Deployment

On this page

You can use MongoDB cluster parameters to specify configuration options that affect all nodes in a replica set or sharded cluster.

Syntax

To set cluster parameters for your deployment, run the following command on the admin database:

db.adminCommand( { setClusterParameter:{ <parameter>: <value> } } )

To view the current cluster parameter values, run the following command on the admin database:

db.adminCommand( { getClusterParameter: "*" } )

To learn more about setting and viewing cluster parameters, see setClusterParameter and getClusterParameter.

To modify cluster parameters, you must authenticate as a user that has one of the following roles:

MongoDB provides the following cluster parameters:

Name	Availability	Description
`auditConfig`	Available for both `mongod` and `mongos`.	Object that contains information on audit configurations from `mongod` and `mongos` server instances.
`changeStreamOptions`	Available for both `mongod` and `mongos`.	An object that contains change stream configuration options. You can only set `changeStreamOptions` on `mongos` or a replica set primary. The value is set cluster-wide.
`defaultMaxTimeMS`	Available for both `mongod` and `mongos`.	Specifies a default time limit in milliseconds for individual read operations to complete. If a query specifies a `maxTimeMS()` option, that value overrides the `defaultMaxTimeMS` value. `defaultMaxTimeMS` applies to the following read operations: `aggregate` (except `$merge` and `$out` stages) `count` `dbHash` `distinct` `find`

Back

Configuration File Settings and Command-Line Options Mapping

auditConfig