setParameter
On this page
Definition
setParameter
setParameter
is an administrative command for modifying options normally set on the command line. You must issue thesetParameter
command against the admin database.
Compatibility
This command is available in deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
Note
This command has limited support in M0, M2, M5, and M10 clusters. For more information, see Unsupported Commands.
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
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.