Docs Menu

Docs HomeMongoDB Manual

Cluster Parameters

On this page

  • Syntax
  • Parameters
  • Learn More

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

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.

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.

←  ReferenceauditConfig →