Definition
setParametersetParameteris an administrative command for modifying options normally set on the command line. You must issue thesetParametercommand against the admin database.
Compatibility
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.
Syntax
db.adminCommand(
{
setParameter: 1,
<parameter>: <value>
}
)For the available parameters, including examples, see MongoDB Server Parameters for a Self-Managed Deployment.
Behavior
Persistence
Commands issued by the admin command setParameter do not survive server restarts. For a persistent option use the --setParameter command line option or the setParameter configuration file setting.
Stable API
When using Stable API V1 with apiStrict set to true, you cannot use setParameter to modify server parameters.