setClusterParameter (original) (raw)

setClusterParameter

setClusterParameter is an administrative command for modifying values of cluster parameters. Cluster parameters are configurable parameters which affect all nodes in a replica set or sharded cluster.

You must issue the setClusterParameter command against the admindatabase.

This command is available in deployments hosted in the following environments:

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Important

This command is not supported in MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

db.adminCommand(

   {

     setClusterParameter: { <parameter>: <value> }

   }

)

For the available cluster parameters, including examples, seeCluster Parameters for a Self-Managed Deployment.

• You can only run setClusterParameter on the admin database. If you run the command on any other database, MongoDB returns an error.
• You can only run setClusterParameter on a replica set primary or on asharded cluster.
• You cannot run setClusterParameter on a standalone deployment.
• setClusterParameter accepts only one parameter at a time.

When authentication is enabled, setClusterParameteronly works when authenticated as a user with a role that has access to the setClusterParameter action.

The parameter modifications made using setClusterParameterare persisted on replica sets and sharded clusters. This ensures that parameter modifications made using setClusterParameter survive restarts.

When using Stable API V1 with apiStrict set to true, you cannot usesetClusterParameter to modify cluster parameters.