Cluster Parameters

On this page

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB server.

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.

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.

Back

Reference

auditConfig