getParameter
getParametergetParameteris an administrative command for retrieving the values of parameters. Use thedb.adminCommand( { command } )method to run thegetParametercommand in theadmindatabase.The
getParametercommand has the following syntax:{ getParameter: <value>, <parameter> : <value>, comment: <any> } The command takes the following fields:
FieldTypeDescriptiongetParameterint,'*'Specify a value of:
'*'to return all parameters available togetParameter, ignoring the<parameter>field.any numerical value to return the value for the specified
<parameter>.
<parameter>stringString name of the parameter to retrieve.
The value for
<value>does not affect output.commentanyOptional. A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:
mongod log messages, in the
attr.command.cursor.commentfield.Database profiler output, in the
command.commentfield.currentOpoutput, in thecommand.commentfield.
A comment can be any valid BSON type (string, integer, object, array, etc).
New in version 4.4.
Behavior
getParameter runs on the admin database only, and returns
an error if run on any other database.
The possible value for <parameter> may vary depending on what version and
storage engine in use. See Retrieve All Parameters for an
example of listing the available parameters.
Examples
Retrieve Single Parameter
The following operation runs getParameter on the admin
database using a value of saslHostName to retrieve the value for
that parameter:
db.adminCommand( { getParameter : 1, "saslHostName" : 1 } )
The command returns the following output:
Note
The output may vary depending on the version and specific configuration of your MongoDB instance.
{ "saslHostName" : "www.example.net:27018", "ok" : 1 }
Retrieve All Parameters
The following operation runs getParameter with a value of
'*' to retrieve all parameters:
db.adminCommand( { getParameter : '*' } )
Note
The output may vary depending on the version of MongoDB and the specific configuration of the running MongoDB instance.
Tip
See also:
setParameter for more about these parameters.