diff options
| -rw-r--r-- | debian/mongo.1 | 3167 | ||||
| -rw-r--r-- | debian/mongod.1 | 6309 | ||||
| -rw-r--r-- | debian/mongodb-parameters.5 | 8327 | ||||
| -rw-r--r-- | debian/mongokerberos.1 | 690 | ||||
| -rw-r--r-- | debian/mongoldap.1 | 1215 | ||||
| -rw-r--r-- | debian/mongos.1 | 3892 | ||||
| -rw-r--r-- | rpm/mongodb-enterprise-init.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-enterprise-unstable-init.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-enterprise-unstable.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-enterprise.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-org-init.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-org-unstable-init.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-org-unstable.spec | 3 | ||||
| -rw-r--r-- | rpm/mongodb-org.spec | 3 |
14 files changed, 11262 insertions, 12362 deletions
diff --git a/debian/mongo.1 b/debian/mongo.1 index 07fe0da64bd..0f831bbf1a1 100644 --- a/debian/mongo.1 +++ b/debian/mongo.1 @@ -1,2074 +1,1861 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGO" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongo \- MongoDB Shell -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Description\fP -.IP \(bu 2 -\fI\%Syntax\fP -.IP \(bu 2 -\fI\%Options\fP -.IP \(bu 2 -\fI\%Files\fP -.IP \(bu 2 -\fI\%Environment\fP -.IP \(bu 2 -\fI\%Keyboard Shortcuts\fP -.IP \(bu 2 -\fI\%Use\fP -.UNINDENT +.TH mongo 1 +.SH LEGACY MONGO SHELL +The \fBmongo\f1 shell has been deprecated in MongoDB v5.0. The +replacement is \fBmongosh\f1\f1\&. +.PP +Older \fBmongo\f1 shell documentation is included with the +corresponding documentation for that \fBMongoDB\f1 release. +.PP +\fIQuick Links to prior versions\f1 +.RS +.IP \(bu 2 +mongo shell v4.4 (https://docs.mongodb.com/v4.4/mongo/) +.IP \(bu 2 +mongo shell v4.2 (https://docs.mongodb.com/v4.2/mongo/) +.IP \(bu 2 +mongo shell v4.0 (https://docs.mongodb.com/v4.0/mongo/) +.RE +.PP +See \fBComparison of the mongo\f1 Shell and mongosh\f1\f1 for more information. .SH DESCRIPTION -.sp -\fI\%mongo\fP is an interactive JavaScript shell interface to +.PP +\fBmongo\f1\f1 is an interactive JavaScript shell interface to MongoDB, which provides a powerful interface for system administrators as well as a way for developers to test queries and -operations directly with the database. \fI\%mongo\fP also provides +operations directly with the database. \fBmongo\f1\f1 also provides a fully functional JavaScript environment for use with a MongoDB. -.sp -The \fI\%mongo\fP shell is included as part of the MongoDB Server installation. MongoDB also provides the \fI\%mongo\fP -shell as a standalone package. To download the standalone \fI\%mongo\fP -shell package: -.INDENT 0.0 -.IP 1. 3 -Access the Download Center for your Edition of MongoDB: -.INDENT 3.0 +.PP +The \fBmongo\f1\f1 shell is included as part of the \fBMongoDB +server installation\f1\&. If you have already installed the +server, the \fBmongo\f1\f1 shell is installed to the same location +as the server binary. +.PP +Alternatively, if you would like to download the \fBmongo\f1\f1 +shell separately from the MongoDB Server, you can install the shell as +a standalone package by following these steps: +.RS .IP \(bu 2 -\fI\%MongoDB Community Download Center\fP +Access the Download Center for your Edition of MongoDB: +.RS +.IP \(bu 4 +MongoDB Community Download Center (https://www.mongodb.com/try/download/community?tck=docs_server) +.IP \(bu 4 +MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise?tck=docs_server) +.RE .IP \(bu 2 -\fI\%MongoDB Enterprise Download Center\fP -.UNINDENT -.IP 2. 3 Select your preferred Version and Platform from the dropdowns. -.IP 3. 3 +.IP \(bu 2 Select the Package to download according to your platform: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 4 +.RS +.IP \(bu 6 Platform -T} T{ +.IP \(bu 6 Download Package -T} -_ -T{ -\fIWindows\fP -T} T{ -Select the \fBzip\fP package to download an archive which -includes the \fI\%mongo\fP shell. -T} -_ -T{ -\fImacOS\fP -T} T{ -Select the \fBtgz\fP package to download an archive which -includes the \fI\%mongo\fP shell. -T} -_ -T{ -\fILinux\fP -T} T{ -Select the \fBshell\fP package to download the -\fI\%mongo\fP shell. -T} -_ -.TE -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -Starting in MongoDB 4.2 (and 4.0.13), the \fI\%mongo\fP shell displays a +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Windows +.IP \(bu 6 +Select the \fBzip\f1 package to download an archive which +includes the \fBmongo\f1\f1 shell. +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +macOS +.IP \(bu 6 +Select the \fBtgz\f1 package to download an archive which +includes the \fBmongo\f1\f1 shell. +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Linux +.IP \(bu 6 +Select the \fBtgz\f1 package to download the +\fBmongo\f1\f1 shell. +.RE +.RE +.IP \(bu 2 +Copy the \fBmongo\f1\f1 shell from the archive to a location on +your filesystem. +.RE +.PP +For additional installation guidance specific to your platform, or to +install the \fBmongo\f1\f1 shell as part of a MongoDB Server +installation, see the \fBinstallation guide for your platform\f1\&. +.RS +.IP \(bu 2 +Starting in MongoDB 4.2 (and 4.0.13), the \fBmongo\f1\f1 shell displays a warning message when connected to non\-genuine MongoDB instances as these instances may behave differently from the official MongoDB instances; e.g. missing or incomplete features, different feature behaviors, etc. .IP \(bu 2 -Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0 +Starting in version 4.0, \fBmongo\f1\f1 disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT -.UNINDENT +more details, see \fBDisable TLS 1.0\f1\&. +.RE .SH SYNTAX -.INDENT 0.0 +.RS .IP \(bu 2 -You can run \fI\%mongo\fP shell without any command\-line +You can run \fBmongo\f1\f1 shell without any command\-line options use the default settings: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo -.ft P -.fi -.UNINDENT -.UNINDENT -.IP \(bu 2 -You can run \fI\%mongo\fP shell with a connection string that specifies the host and port and +.IP +.EX + mongo +.EE +.IP \(bu 2 +You can run \fBmongo\f1\f1 shell with a \fBconnection string\f1 that specifies the host and port and other connection options. For example, the following includes the -\fBtls\fP: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo "mongodb://mongodb0.example.com:27017/testdb?tls=true" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fBtls\fP option is available starting in MongoDB 4.2. In -earlier version, use the \fBssl\fP option. -.sp -To connect \fI\%mongo\fP shell to a replica set, you can -specify in the connection string the replica set members and name: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo "mongodb://mongodb0.example.com.local:27017,mongodb1.example.com.local:27017,mongodb2.example.com.local:27017/?replicaSet=replA" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBtls\f1\f1: +.IP +.EX + mongo "mongodb://mongodb0.example.com:27017/testdb?tls=true" +.EE +.IP +The \fBtls\f1\f1 option is available starting in MongoDB 4.2. In +earlier version, use the \fBssl\f1\f1 option. +.IP +To connect \fBmongo\f1\f1 shell to a replica set, you can +specify in the \fBconnection string\f1 the replica set members and name: +.IP +.EX + mongo "mongodb://mongodb0.example.com.local:27017,mongodb1.example.com.local:27017,mongodb2.example.com.local:27017/?replicaSet=replA" +.EE +.IP For more information on the connection string options, see -/reference/connection\-string\&. +\fBConnection String URI Format\f1\&. .IP \(bu 2 -You can run \fI\%mongo\fP shell with various command\-line +You can run \fBmongo\f1\f1 shell with various command\-line options. For example: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-host mongodb0.example.com:27017 [additional options] - -mongo \-\-host mongodb0.example.com \-\-port 27017 [additional options] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -For more information on the options available, see \fI\%Options\fP\&. -.UNINDENT +.IP +.EX + mongo \-\-host mongodb0.example.com:27017 [additional options] + + mongo \-\-host mongodb0.example.com \-\-port 27017 [additional options] +.EE +.IP +For more information on the options available, see \fBOptions\f1\&. +.RE .SH OPTIONS -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.2" -.INDENT 0.0 +.RS .IP \(bu 2 -MongoDB deprecates the SSL options and insteads adds new +MongoDB deprecates the SSL options and instead adds new corresponding TLS options. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Core Options -.INDENT 0.0 -.TP -.B \-\-shell -Enables the shell interface. If you invoke the \fBmongo\fP command -and specify a JavaScript file as an argument, or use \fI\%\-\-eval\fP to -specify JavaScript on the command line, the \fI\%\-\-shell\fP option +.RE +.SS CORE OPTIONS +.PP +\fBmongo \-\-shell\f1 +.RS +.PP +Enables the shell interface. If you invoke the \fBmongo\f1\f1 command +and specify a JavaScript file as an argument, or use \fB\-\-eval\f1\f1 to +specify JavaScript on the command line, the \fB\-\-shell\f1\f1 option provides the user with a shell prompt after the file finishes executing. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nodb +.RE +.PP +\fBmongo \-\-nodb\f1 +.RS +.PP Prevents the shell from connecting to any database instances. Later, to connect to a database within the shell, see -mongo\-shell\-new\-connections\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-norc -Prevents the shell from sourcing and evaluating \fB~/.mongorc.js\fP on +\fBOpening New Connections\f1\&. +.RE +.PP +\fBmongo \-\-norc\f1 +.RS +.PP +Prevents the shell from sourcing and evaluating ~/.mongorc.js on start up. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quiet +.RE +.PP +\fBmongo \-\-quiet\f1 +.RS +.PP Silences output from the shell during the connection process. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-port <port> -Specifies the port where the \fBmongod\fP or \fBmongos\fP -instance is listening. If \fI\%\-\-port\fP is not specified, -\fBmongo\fP attempts to connect to port \fB27017\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-host <hostname> +.RE +.PP +\fBmongo \-\-port\f1 +.RS +.PP +Specifies the port where the \fBmongod\f1\f1 or \fBmongos\f1\f1 +instance is listening. If \fB\-\-port\f1\f1 is not specified, +\fBmongo\f1\f1 attempts to connect to port \fB27017\f1\&. +.RE +.PP +\fBmongo \-\-host\f1 +.RS +.PP Specifies the name of the host machine where the -\fBmongod\fP or \fBmongos\fP is running. If this is not specified, -\fBmongo\fP attempts to connect to a MongoDB process running on +\fBmongod\f1\f1 or \fBmongos\f1\f1 is running. If this is not specified, +\fBmongo\f1\f1 attempts to connect to a MongoDB process running on the localhost. -.INDENT 7.0 -.TP -.B To connect to a replica set, -Specify the \fBreplica set name\fP +.PP +\fBTo connect to a replica set,\f1 +.RS +.PP +Specify the \fBreplica set name\f1\f1 and a seed list of set members. Use the following form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> -.ft P -.fi -.UNINDENT -.UNINDENT -.TP -.B For TLS/SSL connections (\fB\-\-ssl\fP), -The \fI\%mongo\fP shell verifies that the hostname (specified -in \fI\%\-\-host\fP option or the connection string) -matches the \fBSAN\fP (or, if \fBSAN\fP is not present, the \fBCN\fP) in -the certificate presented by the \fBmongod\fP or -\fBmongos\fP\&. If \fBSAN\fP is present, \fI\%mongo\fP -does not match against the \fBCN\fP\&. If the hostname does not match -the \fBSAN\fP (or \fBCN\fP), the \fI\%mongo\fP shell will fail to +.PP +.EX + <replSetName>/<hostname1><:port>,<hostname2><:port>,<...> +.EE +.RE +.PP +\fBFor TLS/SSL connections (\-\-ssl\f1),\f1 +.RS +.PP +\fBmongosh\f1\f1 verifies that the hostname (specified +in \fB\-\-host\f1\f1 option or the connection string) +matches the \fBSAN\f1 (or, if \fBSAN\f1 is not present, the \fBCN\f1) in +the certificate presented by the \fBmongod\f1\f1 or +\fBmongos\f1\f1\&. If \fBSAN\f1 is present, \fBmongosh\f1\f1 +does not match against the \fBCN\f1\&. If the hostname does not match +the \fBSAN\f1 (or \fBCN\f1), \fBmongosh\f1\f1 will fail to connect. -.sp +.PP Starting in MongoDB 4.2, when performing comparison of SAN, MongoDB supports comparison of DNS names or IP addresses. In previous versions, MongoDB only supports comparisons of DNS names. -.TP -.B For \fI\%DNS seedlist connections\fP, -Specify the connection protocol as \fBmongodb+srv\fP, followed by -the DNS SRV hostname record and any options. The \fBauthSource\fP -and \fBreplicaSet\fP options, if included in the connection string, +.RE +.PP +\fBFor DNS seedlist connections (https://docs.mongodb.com/manual/reference/connection\-string/#dns\-seedlist\-connection\-format/),\f1 +.RS +.PP +Specify the connection protocol as \fBmongodb+srv\f1, followed by +the DNS SRV hostname record and any options. The \fBauthSource\f1 +and \fBreplicaSet\f1 options, if included in the connection string, will override any corresponding DNS\-configured options set in the -TXT record. Use of the \fBmongodb+srv:\fP connection string -implicitly enables TLS/SSL (normally set with \fBssl=true\fP) for +TXT record. Use of the \fBmongodb+srv:\f1 connection string +implicitly enables TLS/SSL (normally set with \fBssl=true\f1) for the client connection. The TLS/SSL option can be turned off by -setting \fBssl=false\fP in the query string. -.sp +setting \fBssl=false\f1 in the query string. +.PP Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongodb+srv://server.example.com/?connectionTimeout=3000ms -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -New in version 3.6. - -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-eval <javascript> +.PP +.EX + mongodb+srv://server.example.com/?connectionTimeout=3000ms +.EE +.RE +.RE +.PP +\fBmongo \-\-eval\f1 +.RS +.PP Evaluates a JavaScript expression that is specified as an argument. -\fBmongo\fP does not load its own environment when evaluating code. +\fBmongo\f1\f1 does not load its own environment when evaluating code. As a result many options of the shell environment are not available. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-username <username>, \-u <username> +.RE +.PP +\fBmongo \-\-username\f1, \fBmongo \-u\f1 +.RS +.PP Specifies a username with which to authenticate to a MongoDB database -that uses authentication. Use in conjunction with the \fI\%\-\-password\fP and -\fI\%\-\-authenticationDatabase\fP options. -.sp -If connecting to a \fI\%MongoDB Atlas\fP cluster -using the \fBMONGODB\-AWS\fP \fI\%authentication mechanism\fP, specify your AWS access key ID in this -field, or in the connection string\&. Alternatively, this value may -also be supplied as the environment variable \fBAWS_ACCESS_KEY_ID\fP\&. -See \fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-password <password>, \-p <password> +that uses authentication. Use in conjunction with the \fB\-\-password\f1\f1 and +\fB\-\-authenticationDatabase\f1\f1 options. +.PP +If connecting to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster +using the \fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1, specify your AWS access key ID in this +field, or in the \fBconnection string\f1\&. Alternatively, this value may +also be supplied as the environment variable \fBAWS_ACCESS_KEY_ID\f1\&. +See \fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.RE +.PP +\fBmongo \-\-password\f1, \fBmongo \-p\f1 +.RS +.PP Specifies a password with which to authenticate to a MongoDB database -that uses authentication. Use in conjunction with the \fI\%\-\-username\fP -and \fI\%\-\-authenticationDatabase\fP options. To force \fBmongo\fP to -prompt for a password, enter the \fI\%\-\-password\fP option as the +that uses authentication. Use in conjunction with the \fB\-\-username\f1\f1 +and \fB\-\-authenticationDatabase\f1\f1 options. To force \fBmongo\f1\f1 to +prompt for a password, enter the \fB\-\-password\f1\f1 option as the last option and leave out the argument. -.sp -If connecting to a \fI\%MongoDB Atlas\fP cluster -using the \fBMONGODB\-AWS\fP \fI\%authentication mechanism\fP, specify your AWS secret access key in -this field, or in the connection string\&. Alternatively, this value may +.PP +If connecting to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster +using the \fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1, specify your AWS secret access key in +this field, or in the \fBconnection string\f1\&. Alternatively, this value may also be supplied as the environment variable -\fBAWS_SECRET_ACCESS_KEY\fP\&. See -\fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-awsIamSessionToken <aws session token> -If connecting to a \fI\%MongoDB Atlas\fP cluster -using the \fBMONGODB\-AWS\fP \fI\%authentication mechanism\fP and using session tokens in addition to +\fBAWS_SECRET_ACCESS_KEY\f1\&. See +\fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.RE +.PP +\fBmongo \-\-apiVersion\f1 +.RS +.PP +Specifies the \fBapiVersion\f1\&. \fB"1"\f1 is +currently the only supported value. +.RE +.PP +\fBmongo \-\-apiStrict\f1 +.RS +.PP +Specifies that the server will respond with \fBAPIStrictError\f1 if your application uses a command or behavior +outside of the \fBVersioned API\f1\&. +.PP +If you specify \fB\-\-apiStrict\f1\f1, you must also specify +\fB\-\-apiVersion\f1\f1\&. +.RE +.PP +\fBmongo \-\-apiDeprecationErrors\f1 +.RS +.PP +Specifies that the server will respond with +\fBAPIDeprecationError\f1 if your application +uses a command or behavior that is deprecated in the specified +\fBapiVersion\f1\&. +.PP +If you specify \fB\-\-apiDeprecationErrors\f1\f1, you must also +specify \fB\-\-apiVersion\f1\f1\&. +.RE +.PP +\fBmongo \-\-awsIamSessionToken\f1 +.RS +.PP +If connecting to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster +using the \fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1 and using session tokens in addition to your AWS access key ID and secret access key, specify your AWS -session token in this field, or in the connection string\&. Alternatively, this value may +session token in this field, or in the \fBconnection string\f1\&. Alternatively, this value may also be supplied as the environment variable -\fBAWS_SESSION_TOKEN\fP\&. See -\fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.sp -Only valid when using the \fBMONGODB\-AWS\fP -\fI\%authentication mechanism\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-help, \-h -Returns information on the options and use of \fBmongo\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-version -Returns the \fBmongo\fP release number. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-verbose +\fBAWS_SESSION_TOKEN\f1\&. See +\fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.PP +Only valid when using the \fBMONGODB\-AWS\f1 +\fBauthentication mechanism\f1\f1\&. +.RE +.PP +\fBmongo \-\-help\f1, \fBmongo \-h\f1 +.RS +.PP +Returns information on the options and use of \fBmongo\f1\f1\&. +.RE +.PP +\fBmongo \-\-version\f1 +.RS +.PP +Returns the \fBmongo\f1\f1 release number. +.RE +.PP +\fBmongo \-\-verbose\f1 +.RS +.PP Increases the verbosity of the output of the shell during the connection process. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-networkMessageCompressors <string> -New in version 3.4. - -.sp +.RE +.PP +\fBmongo \-\-networkMessageCompressors\f1 +.RS +.PP Enables network compression for communication between this -\fBmongo\fP shell and: -.INDENT 7.0 +\fBmongo\f1\f1 shell and: +.RS .IP \(bu 2 -a \fBmongod\fP instance +a \fBmongod\f1\f1 instance .IP \(bu 2 -a \fBmongos\fP instance. -.UNINDENT -.sp +a \fBmongos\f1\f1 instance. +.RE +.PP You can specify the following compressors: -.INDENT 7.0 +.RS .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib (Available starting in MongoDB 3.6) +\fBzlib\f1 (Available starting in MongoDB 3.6) .IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.PP Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed. -.UNINDENT -.UNINDENT -.sp +.PP If you specify multiple compressors, then the order in which you list the compressors matter as well as the communication initiator. For -example, if a \fI\%mongo\fP shell specifies the following network -compressors \fBzlib,snappy\fP and the \fBmongod\fP specifies -\fBsnappy,zlib\fP, messages between \fI\%mongo\fP shell and -\fBmongod\fP uses \fBzlib\fP\&. -.sp +example, if \fBmongosh\f1\f1 specifies the following network +compressors \fBzlib,snappy\f1 and the \fBmongod\f1\f1 specifies +\fBsnappy,zlib\f1, messages between \fBmongosh\f1\f1 and +\fBmongod\f1\f1 uses \fBzlib\f1\&. +.PP If the parties do not share at least one common compressor, messages -between the parties are uncompressed. For example, if a -\fI\%mongo\fP shell specifies the network compressor -\fBzlib\fP and \fBmongod\fP specifies \fBsnappy\fP, messages -between \fI\%mongo\fP shell and \fBmongod\fP are not compressed. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ipv6 -Enables IPv6 support. \fBmongo\fP disables IPv6 by default. -.sp +between the parties are uncompressed. For example, if +\fBmongosh\f1\f1 specifies the network compressor +\fBzlib\f1 and \fBmongod\f1\f1 specifies \fBsnappy\f1, messages +between \fBmongosh\f1\f1 and \fBmongod\f1\f1 are not +compressed. +.RE +.PP +\fBmongo \-\-ipv6\f1 +.RS +.PP +Enables IPv6 support. \fBmongo\f1\f1 disables IPv6 by default. +.PP To connect to a MongoDB cluster via IPv6, you must specify -both \fI\%\-\-ipv6\fP \fIand\fP -\fI\%\-\-host <mongod/mongos IPv6 address>\fP -when starting the \fBmongo\fP shell. -.sp -\fBmongod\fP and \fBmongos\fP disable IPv6 support -by default. Specifying \fI\%\-\-ipv6\fP when connecting to a -\fBmongod/mongos\fP does not enable IPv6 support on the -\fBmongod/mongos\fP\&. For documentation on enabling IPv6 support -on the \fBmongod/mongos\fP, see \fBnet.ipv6\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B <db name> +both \fB\-\-ipv6\f1\f1 \fIand\f1 +\fB\-\-host <mongod/mongos IPv6 address>\f1\f1 +when starting the \fBmongo\f1\f1 shell. +.PP +\fBmongod\f1\f1 and \fBmongos\f1\f1 disable IPv6 support +by default. Specifying \fB\-\-ipv6\f1\f1 when connecting to a +\fBmongod/mongos\f1 does not enable IPv6 support on the +\fBmongod/mongos\f1\&. For documentation on enabling IPv6 support +on the \fBmongod/mongos\f1, see \fBnet.ipv6\f1\f1\&. +.RE +.PP +\fBmongo <db\f1 +.RS +.PP Specifies the name of the database to connect to. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo admin -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The above command will connect the \fBmongo\fP shell to the -admin database of the MongoDB deployment running on the local machine. You may specify a remote +.PP +.EX + mongo admin +.EE +.PP +The above command will connect the \fBmongo\f1\f1 shell to the +\fBadmin database\f1 of the MongoDB deployment running on the local machine. You may specify a remote database instance, with the resolvable hostname or IP address. Separate -the database name from the hostname using a \fB/\fP character. See the +the database name from the hostname using a \fB/\f1 character. See the following examples: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo mongodb1.example.net/test -mongo mongodb1/admin -mongo 10.8.8.10/test -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -This syntax is the \fIonly\fP way to connect to a specific database. -.sp +.PP +.EX + mongo mongodb1.example.net/test + mongo mongodb1/admin + mongo 10.8.8.10/test +.EE +.PP +This syntax is the \fIonly\f1 way to connect to a specific database. +.PP To specify alternate hosts and a database, you must use this syntax and cannot -use \fI\%\-\-host\fP or \fI\%\-\-port\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-enableJavaScriptJIT -New in version 4.0. - -.sp +use \fB\-\-host\f1\f1 or \fB\-\-port\f1\f1\&. +.RE +.PP +\fBmongo \-\-enableJavaScriptJIT\f1 +.RS +.PP Enable the JavaScript engine\(aqs JIT compiler. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-disableJavaScriptJIT -Changed in version 4.0: The JavaScript engine\(aqs JIT compiler is now disabled by default. - -.sp +.RE +.PP +\fBmongo \-\-disableJavaScriptJIT\f1 +.RS +.PP +The JavaScript engine\(aqs JIT compiler is now disabled by default. +.PP Disables the JavaScript engine\(aqs JIT compiler. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-disableJavaScriptProtection -New in version 3.4. - -.sp -Allows fields of type javascript and -javascriptWithScope (*Deprecated*) to be automatically -marshalled to JavaScript functions in the \fI\%mongo\fP +.RE +.PP +\fBmongo \-\-disableJavaScriptProtection\f1 +.RS +.PP +Allows fields of type \fBjavascript\f1 and +\fBjavascriptWithScope (*Deprecated*)\f1 to be automatically +marshalled to JavaScript functions in the \fBmongo\f1\f1 shell. -.sp -With the \fB\-\-disableJavaScriptProtection\fP flag set, it is possible +.PP +With the \fB\-\-disableJavaScriptProtection\f1 flag set, it is possible to immediately execute JavaScript functions contained in documents. The following example demonstrates this behavior within the shell: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -> db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) -WriteResult({ "nInserted" : 1 }) -> var doc = db.test.findOne({ _id: 1 }) -> doc -{ "_id" : 1, "jsFunc" : function (){ print ("hello") } } -> typeof doc.jsFunc -function -> doc.jsFunc() -hello -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The default behavior (when \fI\%mongo\fP starts \fIwithout\fP the -\fB\-\-disableJavaScriptProtection\fP flag) is to convert embedded +.PP +.EX + > db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) + WriteResult({ "nInserted" : 1 }) + > var doc = db.test.findOne({ _id: 1 }) + > doc + { "_id" : 1, "jsFunc" : function (){ print ("hello") } } + > typeof doc.jsFunc + function + > doc.jsFunc() + hello +.EE +.PP +The default behavior (when \fBmongo\f1\f1 starts \fIwithout\f1 the +\fB\-\-disableJavaScriptProtection\f1 flag) is to convert embedded JavaScript functions to the non\-executable MongoDB shell type -\fBCode\fP\&. The following example demonstrates the default behavior +\fBCode\f1\&. The following example demonstrates the default behavior within the shell: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -> db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) -WriteResult({ "nInserted" : 1 }) -> var doc = db.test.findOne({ _id: 1 }) -> doc -{ "_id" : 1, "jsFunc" : { "code" : "function (){print(\e"hello\e")}" } } -> typeof doc.func -object -> doc.func instanceof Code -true -> doc.jsFunc() -2016\-11\-09T12:30:36.808\-08:00 E QUERY [thread1] TypeError: doc.jsFunc is -not a function : -@(shell):1:1 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B <file.js> +.PP +.EX + > db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) + WriteResult({ "nInserted" : 1 }) + > var doc = db.test.findOne({ _id: 1 }) + > doc + { "_id" : 1, "jsFunc" : { "code" : "function (){print(\"hello\")}" } } + > typeof doc.func + object + > doc.func instanceof Code + true + > doc.jsFunc() + 2016\-11\-09T12:30:36.808\-08:00 E QUERY [thread1] TypeError: doc.jsFunc is + not a function : + @(shell):1:1 +.EE +.RE +.PP +\fBmongo <file.js>\f1 +.RS +.PP Specifies a JavaScript file to run and then exit. Generally this should be the last option specified. -.INDENT 7.0 -.INDENT 3.5 -.SS Optional -.sp -To specify a JavaScript file to execute \fIand\fP allow -\fBmongo\fP to prompt you for a password using -\fI\%\-\-password\fP, pass the filename as the first parameter with -\fI\%\-\-username\fP and \fI\%\-\-password\fP as the last options, as +.PP +To specify a JavaScript file to execute \fIand\f1 allow +\fBmongo\f1\f1 to prompt you for a password using +\fB\-\-password\f1\f1, pass the filename as the first parameter with +\fB\-\-username\f1\f1 and \fB\-\-password\f1\f1 as the last options, as in the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo file.js \-\-username username \-\-password -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.sp -Use the \fI\%\-\-shell\fP option to return to a shell after the file +.PP +.EX + mongo file.js \-\-username username \-\-password +.EE +.PP +Use the \fB\-\-shell\f1\f1 option to return to a shell after the file finishes running. -.UNINDENT -.SS Authentication Options -.INDENT 0.0 -.TP -.B \-\-authenticationDatabase <dbname> -Specifies the authentication database where the specified \fI\%\-\-username\fP has been created. -See user\-authentication\-database\&. -.sp -If you do not specify a value for \fI\%\-\-authenticationDatabase\fP, \fBmongo\fP uses the database +.RE +.SS AUTHENTICATION OPTIONS +.PP +\fBmongo \-\-authenticationDatabase\f1 +.RS +.PP +Specifies the authentication database where the specified \fB\-\-username\f1\f1 has been created. +See \fBAuthentication Database\f1\&. +.PP +If you do not specify a value for \fB\-\-authenticationDatabase\f1\f1, \fBmongo\f1\f1 uses the database specified in the connection string. -.sp -If using the GSSAPI (Kerberos), -PLAIN (LDAP SASL), or \fBMONGODB\-AWS\fP -\fI\%authentication mechanisms\fP, you -must set \fI\%\-\-authenticationDatabase\fP to \fB$external\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-authenticationMechanism <name> -\fIDefault\fP: SCRAM\-SHA\-1 -.sp -Specifies the authentication mechanism the \fBmongo\fP instance uses to -authenticate to the \fBmongod\fP or \fBmongos\fP\&. -.sp -Changed in version 4.4: With MongoDB 4.4, the \fBmongo\fP shell adds support for the -new \fBMONGODB\-AWS\fP authentication mechanism when connecting to a -\fI\%MongoDB Atlas\fP cluster. - -.TS -center; -|l|l|. -_ -T{ +.PP +If using the \fBGSSAPI\f1 (Kerberos), +\fBPLAIN\f1 (LDAP SASL), or \fBMONGODB\-AWS\f1 +\fBauthentication mechanisms\f1\f1, you +must set \fB\-\-authenticationDatabase\f1\f1 to \fB$external\f1\&. +.RE +.PP +\fBmongo \-\-authenticationMechanism\f1 +.RS +.PP +\fIDefault\f1: SCRAM\-SHA\-1 +.PP +Specifies the authentication mechanism the \fBmongo\f1\f1 instance uses to +authenticate to the \fBmongod\f1\f1 or \fBmongos\f1\f1\&. +.PP +With MongoDB 4.4, the \fBmongo\f1\f1 shell adds support for the +new \fBMONGODB\-AWS\f1 authentication mechanism when connecting to a +MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster. +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -SCRAM\-SHA\-1 -T} T{ -\fI\%RFC 5802\fP standard +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBSCRAM\-SHA\-1\f1 +.IP \(bu 4 +RFC 5802 (https://tools.ietf.org/html/rfc5802) standard Salted Challenge Response Authentication Mechanism using the SHA\-1 hash function. -T} -_ -T{ -SCRAM\-SHA\-256 -T} T{ -\fI\%RFC 7677\fP standard +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBSCRAM\-SHA\-256\f1 +.IP \(bu 4 +RFC 7677 (https://tools.ietf.org/html/rfc7677) standard Salted Challenge Response Authentication Mechanism using the SHA\-256 hash function. -.sp -Requires featureCompatibilityVersion set to \fB4.0\fP\&. -.sp -New in version 4.0. -T} -_ -T{ -MONGODB\-X509 -T} T{ +.IP +Requires featureCompatibilityVersion set to \fB4.0\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBMONGODB\-X509\f1 +.IP \(bu 4 MongoDB TLS/SSL certificate authentication. -T} -_ -T{ -\fBMONGODB\-AWS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBMONGODB\-AWS\f1 +.IP \(bu 4 External authentication using AWS IAM credentials for use in connecting to a -\fI\%MongoDB Atlas\fP -cluster. See \fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.sp -New in version 4.4. -T} -_ -T{ -GSSAPI (Kerberos) -T} T{ +MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) +cluster. See \fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBGSSAPI\f1 (Kerberos) +.IP \(bu 4 External authentication using Kerberos. This mechanism is -available only in \fI\%MongoDB Enterprise\fP\&. -T} -_ -T{ -PLAIN (LDAP SASL) -T} T{ -External authentication using LDAP. You can also use \fBPLAIN\fP -for authenticating in\-database users. \fBPLAIN\fP transmits +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBPLAIN\f1 (LDAP SASL) +.IP \(bu 4 +External authentication using LDAP. You can also use \fBPLAIN\f1 +for authenticating in\-database users. \fBPLAIN\f1 transmits passwords in plain text. This mechanism is available only in -\fI\%MongoDB Enterprise\fP\&. -T} -_ -.TE -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gssapiHostName -Specify the hostname of a service using GSSAPI/Kerberos\&. \fIOnly\fP required if the hostname of a machine does +MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. +.RE +.RE +.RE +.PP +\fBmongo \-\-gssapiHostName\f1 +.RS +.PP +Specify the hostname of a service using \fBGSSAPI/Kerberos\f1\&. \fIOnly\f1 required if the hostname of a machine does not match the hostname resolved by DNS. -.sp +.PP This option is available only in MongoDB Enterprise. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gssapiServiceName -Specify the name of the service using GSSAPI/Kerberos\&. Only required if the service does not use the -default name of \fBmongodb\fP\&. -.sp +.RE +.PP +\fBmongo \-\-gssapiServiceName\f1 +.RS +.PP +Specify the name of the service using \fBGSSAPI/Kerberos\f1\&. Only required if the service does not use the +default name of \fBmongodb\f1\&. +.PP This option is available only in MongoDB Enterprise. -.UNINDENT -.SS TLS Options -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0 +.RE +.SS TLS OPTIONS +.PP +Starting in version 4.0, \fBmongo\f1\f1 disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full +more details, see \fBDisable TLS 1.0\f1\&. +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tls -New in version 4.2. - -.sp -Enables connection to a \fBmongod\fP or \fBmongos\fP that has +.PP +\fBmongo \-\-tls\f1 +.RS +.PP +Enables connection to a \fBmongod\f1\f1 or \fBmongos\f1\f1 that has TLS/SSL support enabled. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFile <filename> -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS/SSL -certificate and key for the \fI\%mongo\fP shell. Specify the -file name of the \fB\&.pem\fP file using relative or absolute paths. -.sp -This option is required when using the \fI\%\-\-tls\fP -option to connect to a \fBmongod\fP or \fBmongos\fP -instance that requires client certificates\&. That is, the -\fI\%mongo\fP shell present this certificate to the server. -.sp -Changed in version 4.4: \fBmongod\fP / \fBmongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCertificateKeyFile\f1 +.RS +.PP +Specifies the \&.pem file that contains both the TLS/SSL +certificate and key for the \fBmongo\f1\f1 shell. Specify the +file name of the \&.pem file using relative or absolute paths. +.PP +This option is required when using the \fB\-\-tls\f1\f1 +option to connect to a \fBmongod\f1\f1 or \fBmongos\f1\f1 +instance that requires \fBclient certificates\f1\&. That is, the +\fBmongo\f1\f1 shell present this certificate to the server. +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFilePassword <value> -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCertificateKeyFilePassword\f1 +.RS +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-tlsCertificateKeyFile\fP). -.sp -Use the \fI\%\-\-tlsCertificateKeyFilePassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongo\fP will +\fB\-\-tlsCertificateKeyFile\f1\f1). +.PP +Use the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongo\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP If the private key in the PEM file is encrypted and you do not -specify the \fI\%\-\-tlsCertificateKeyFilePassword\fP option, the \fBmongo\fP will prompt for a -passphrase. See ssl\-certificate\-password\&. -.sp +specify the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option, the \fBmongo\f1\f1 will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCAFile <filename> -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCAFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the -\fBmongod\fP/\fBmongos\fP instance. -.sp -Specify the file name of the \fB\&.pem\fP file using relative or +\fBmongod\f1\f1/\fBmongos\f1\f1 instance. +.PP +Specify the file name of the \&.pem file using relative or absolute paths. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCRLFile <filename> -New in version 4.2: In MongoDB 4.0 and earlier, see \fI\%\-\-sslCRLFile\fP\&. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCRLFile\f1 +.RS +.PP +In MongoDB 4.0 and earlier, see \fB\-\-sslCRLFile\f1\f1\&. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidHostnames -New in version 4.2. - -.sp +.RE +.PP +\fBmongo \-\-tlsAllowInvalidHostnames\f1 +.RS +.PP Disables the validation of the hostnames in the certificate presented -by the \fBmongod\fP/\fBmongos\fP instance. Allows -\fBmongo\fP to connect to MongoDB instances even if the hostname in +by the \fBmongod\f1\f1/\fBmongos\f1\f1 instance. Allows +\fBmongo\f1\f1 to connect to MongoDB instances even if the hostname in the server certificates do not match the server\(aqs host. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidCertificates -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsAllowInvalidCertificates\f1 +.RS +.PP Bypasses the validation checks for the certificates presented by the -\fBmongod\fP/\fBmongos\fP instance and allows +\fBmongod\f1\f1/\fBmongos\f1\f1 instance and allows connections to servers that present invalid certificates. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.0, if you specify -\fB\-\-sslAllowInvalidCertificates\fP or -\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the -alias \fB\-\-tlsAllowInvalidateCertificates\fP or -\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509 +.PP +Starting in MongoDB 4.2, if you specify +\fB\-\-tlsAllowInvalidateCertificates\f1 or +\fBnet.tls.allowInvalidCertificates: true\f1 when using x.509 authentication, an invalid certificate is only sufficient to -establish a TLS/SSL connection but is \fIinsufficient\fP for +establish a TLS connection but it is \fIinsufficient\f1 for authentication. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Although available, avoid using the -\fB\-\-sslAllowInvalidCertificates\fP option if possible. If the use of -\fB\-\-sslAllowInvalidCertificates\fP is necessary, only use the option +\fB\-\-sslAllowInvalidCertificates\f1 option if possible. If the use of +\fB\-\-sslAllowInvalidCertificates\f1 is necessary, only use the option on systems where intrusion is not possible. -.sp -If the \fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) runs with the -\fB\-\-sslAllowInvalidCertificates\fP option, the -\fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) will not attempt to validate +.PP +If \fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) runs with the +\fB\-\-sslAllowInvalidCertificates\f1 option, +\fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) will not attempt to validate the server certificates. This creates a vulnerability to expired -\fBmongod\fP and \fBmongos\fP certificates as +\fBmongod\f1\f1 and \fBmongos\f1\f1 certificates as well as to foreign processes posing as valid -\fBmongod\fP or \fBmongos\fP instances. If you +\fBmongod\f1\f1 or \fBmongos\f1\f1 instances. If you only need to disable the validation of the hostname in the -TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\fP\&. -.UNINDENT -.UNINDENT -.sp -When using the \fBallowInvalidCertificates\fP setting, +TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\f1\&. +.PP +When using the \fBallowInvalidCertificates\f1\f1 setting, MongoDB logs as a warning the use of the invalid certificate. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsFIPSMode -New in version 4.2. - -.sp -Directs the \fBmongo\fP to use the FIPS mode of the TLS/SSL +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsFIPSMode\f1 +.RS +.PP +Directs the \fBmongo\f1\f1 to use the FIPS mode of the TLS/SSL library. Your system must have a FIPS compliant library to use -the \fI\%\-\-tlsFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +the \fB\-\-tlsFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateSelector <parameter>=<value> -New in version 4.2: Available on Windows and macOS as an alternative to \fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp -The \fI\%\-\-tlsCertificateKeyFile\fP and \fI\%\-\-tlsCertificateSelector\fP options are mutually exclusive. You can only +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.PP +\fBmongo \-\-tlsCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to \fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP +The \fB\-\-tlsCertificateKeyFile\f1\f1 and \fB\-\-tlsCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store. -.sp -\fI\%\-\-tlsCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-tlsCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.sp -Changed in version 4.4: \fBmongod\fP / \fBmongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsDisabledProtocols <string> -New in version 4.2. - -.sp +.RE +.PP +\fBmongo \-\-tlsDisabledProtocols\f1 +.RS +.PP Disables the specified TLS protocols. The option recognizes the -following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, \fBTLS1_2\fP, and -starting in version 4.0.4 (and 3.6.9 and 3.4.24), \fBTLS1_3\fP\&. -.INDENT 7.0 +following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, \fBTLS1_2\f1, and +starting in version 4.0.4 (and 3.6.9 and 3.4.24), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must also disable at least one of the other -two; for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must also disable at least one of the other +two; for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the -disabled TLS 1.0, specify \fBnone\fP to \fI\%\-\-tlsDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.UNINDENT -.SS SSL Options (Deprecated) -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 +disabled TLS 1.0, specify \fBnone\f1 to \fB\-\-tlsDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.RE +.SS SSL OPTIONS (DEPRECATED) +.PP Starting in version 4.2, the SSL options are deprecated. Use the TLS counterparts instead. The SSL protocol is deprecated and MongoDB supports TLS 1.0 and later. -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0 +.PP +Starting in version 4.0, \fBmongo\f1\f1 disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ssl -Deprecated since version 4.2: Use \fI\%\-\-tls\fP instead. - -.sp -Enables connection to a \fBmongod\fP or \fBmongos\fP that has +more details, see \fBDisable TLS 1.0\f1\&. +.PP +\fBmongo \-\-ssl\f1 +.RS +.PP +Use \fB\-\-tls\f1\f1 instead. +.PP +Enables connection to a \fBmongod\f1\f1 or \fBmongos\f1\f1 that has TLS/SSL support enabled. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateKeyFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS/SSL certificate -and key. Specify the file name of the \fB\&.pem\fP file using relative +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslPEMKeyFile\f1 +.RS +.PP +Use \fB\-\-tlsCertificateKeyFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains both the TLS/SSL certificate +and key. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -This option is required when using the \fB\-\-ssl\fP option to connect -to a \fBmongod\fP or \fBmongos\fP that has -\fBCAFile\fP enabled \fIwithout\fP -\fBallowConnectionsWithoutCertificates\fP\&. -.sp +.PP +This option is required when using the \fB\-\-ssl\f1 option to connect +to a \fBmongod\f1\f1 or \fBmongos\f1\f1 that has +\fBCAFile\f1\f1 enabled \fIwithout\f1 +\fBallowConnectionsWithoutCertificates\f1\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyPassword <value> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateKeyFilePassword\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslPEMKeyPassword\f1 +.RS +.PP +Use \fB\-\-tlsCertificateKeyFilePassword\f1\f1 instead. +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fB\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongo\fP will +\fB\-\-sslPEMKeyFile\f1). Use the \fB\-\-sslPEMKeyPassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongo\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP If the private key in the PEM file is encrypted and you do not -specify the \fI\%\-\-sslPEMKeyPassword\fP option, the \fBmongo\fP will prompt for a -passphrase. See ssl\-certificate\-password\&. -.sp +specify the \fB\-\-sslPEMKeyPassword\f1\f1 option, the \fBmongo\f1\f1 will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCAFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCAFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate chain +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslCAFile\f1 +.RS +.PP +Use \fB\-\-tlsCAFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the -\fB\&.pem\fP file using relative or absolute paths. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +\&.pem file using relative or absolute paths. +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCertificateSelector <parameter>=<value> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateSelector\fP instead. - -.sp -New in version 4.0: Available on Windows and macOS as an alternative to \fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp -\fI\%\-\-tlsCertificateKeyFile\fP and \fI\%\-\-sslCertificateSelector\fP options are mutually exclusive. You can only +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslCertificateSelector\f1 +.RS +.PP +Use \fB\-\-tlsCertificateSelector\f1\f1 instead. +.PP +Available on Windows and macOS as an alternative to \fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP +\fB\-\-tlsCertificateKeyFile\f1\f1 and \fB\-\-sslCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store. -.sp -\fI\%\-\-sslCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-sslCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCRLFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCRLFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +.RE +.PP +\fBmongo \-\-sslCRLFile\f1 +.RS +.PP +Use \fB\-\-tlsCRLFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslFIPSMode -Deprecated since version 4.2: Use \fI\%\-\-tlsFIPSMode\fP instead. - -.sp -Directs the \fBmongo\fP to use the FIPS mode of the TLS/SSL +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslFIPSMode\f1 +.RS +.PP +Use \fB\-\-tlsFIPSMode\f1\f1 instead. +.PP +Directs the \fBmongo\f1\f1 to use the FIPS mode of the TLS/SSL library. Your system must have a FIPS compliant library to use -the \fI\%\-\-sslFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +the \fB\-\-sslFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidCertificates -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidCertificates\fP instead. - -.sp +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.PP +\fBmongo \-\-sslAllowInvalidCertificates\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidCertificates\f1\f1 instead. +.PP Bypasses the validation checks for server certificates and allows the use of invalid certificates to connect. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.0, if you specify -\fB\-\-sslAllowInvalidCertificates\fP or -\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the -alias \fB\-\-tlsAllowInvalidateCertificates\fP or -\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509 +.PP +Starting in MongoDB 4.2, if you specify +\fB\-\-tlsAllowInvalidateCertificates\f1 or +\fBnet.tls.allowInvalidCertificates: true\f1 when using x.509 authentication, an invalid certificate is only sufficient to -establish a TLS/SSL connection but is \fIinsufficient\fP for +establish a TLS connection but it is \fIinsufficient\f1 for authentication. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Although available, avoid using the -\fB\-\-sslAllowInvalidCertificates\fP option if possible. If the use of -\fB\-\-sslAllowInvalidCertificates\fP is necessary, only use the option +\fB\-\-sslAllowInvalidCertificates\f1 option if possible. If the use of +\fB\-\-sslAllowInvalidCertificates\f1 is necessary, only use the option on systems where intrusion is not possible. -.sp -If the \fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) runs with the -\fB\-\-sslAllowInvalidCertificates\fP option, the -\fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) will not attempt to validate +.PP +If \fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) runs with the +\fB\-\-sslAllowInvalidCertificates\f1 option, +\fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) will not attempt to validate the server certificates. This creates a vulnerability to expired -\fBmongod\fP and \fBmongos\fP certificates as +\fBmongod\f1\f1 and \fBmongos\f1\f1 certificates as well as to foreign processes posing as valid -\fBmongod\fP or \fBmongos\fP instances. If you +\fBmongod\f1\f1 or \fBmongos\f1\f1 instances. If you only need to disable the validation of the hostname in the -TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\fP\&. -.UNINDENT -.UNINDENT -.sp -When using the \fBallowInvalidCertificates\fP setting, +TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\f1\&. +.PP +When using the \fBallowInvalidCertificates\f1\f1 setting, MongoDB logs as a warning the use of the invalid certificate. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidHostnames -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidHostnames\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslAllowInvalidHostnames\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidHostnames\f1\f1 instead. +.PP Disables the validation of the hostnames in TLS/SSL certificates. Allows -\fBmongo\fP to connect to MongoDB instances even if the hostname in their +\fBmongo\f1\f1 to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslDisabledProtocols <string> -Deprecated since version 4.2: Use \fI\%\-\-tlsDisabledProtocols\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslDisabledProtocols\f1 +.RS +.PP +Use \fB\-\-tlsDisabledProtocols\f1\f1 instead. +.PP Disables the specified TLS protocols. The option recognizes the -following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, \fBTLS1_2\fP, and -starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\fP\&. -.INDENT 7.0 +following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, \fBTLS1_2\f1, and +starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must also disable at least one of the other -two; for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must also disable at least one of the other +two; for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the -disabled TLS 1.0, specify \fBnone\fP to \fI\%\-\-sslDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.sp -New in version 3.6.5. - -.UNINDENT -.SS Sessions -.INDENT 0.0 -.TP -.B \-\-retryWrites -New in version 3.6. - -.sp +disabled TLS 1.0, specify \fBnone\f1 to \fB\-\-sslDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.RE +.SS SESSIONS +.PP +\fBmongo \-\-retryWrites\f1 +.RS +.PP Enables retryable writes as the default for sessions in the -\fI\%mongo\fP shell. -.sp -For more information on sessions, see sessions\&. -.UNINDENT -.SS Client\-Side Field Level Encryption Options -.INDENT 0.0 -.TP -.B \-\-awsAccessKeyId <string> -An AWS \fI\%Access Key\fP -associated to an IAM user with \fBList\fP and \fBRead\fP permissions for the -AWS Key Management Service (KMS). The \fBmongo\fP shell uses the specified -\fI\%\-\-awsAccessKeyId\fP to access the KMS. -.sp -\fI\%\-\-awsAccessKeyId\fP is required for enabling /core/security\-client\-side\-encryption -for the \fBmongo\fP shell session. \fI\%\-\-awsAccessKeyId\fP requires \fIall\fP of the following +\fBmongo\f1\f1 shell. +.PP +For more information on sessions, see \fBClient Sessions and Causal Consistency Guarantees\f1\&. +.RE +.SS CLIENT-SIDE FIELD LEVEL ENCRYPTION OPTIONS +.PP +\fBmongo \-\-awsAccessKeyId\f1 +.RS +.PP +An AWS Access Key (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html) +associated to an IAM user with \fBList\f1 and \fBRead\f1 permissions for the +AWS Key Management Service (KMS). The \fBmongo\f1\f1 shell uses the specified +\fB\-\-awsAccessKeyId\f1\f1 to access the KMS. +.PP +\fB\-\-awsAccessKeyId\f1\f1 is required for enabling \fBClient\-Side Field Level Encryption\f1 +for the \fBmongo\f1\f1 shell session. \fB\-\-awsAccessKeyId\f1\f1 requires \fIall\f1 of the following command line options: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-awsSecretAccessKey\fP +\fB\-\-awsSecretAccessKey\f1\f1 .IP \(bu 2 -\fI\%\-\-keyVaultNamespace\fP -.UNINDENT -.sp -If \fI\%\-\-awsAccessKeyId\fP is omitted, use the \fBMongo()\fP constructor within the shell +\fB\-\-keyVaultNamespace\f1\f1 +.RE +.PP +If \fB\-\-awsAccessKeyId\f1\f1 is omitted, use the \fBMongo()\f1\f1 constructor within the shell session to enable client\-side field level encryption. -.sp +.PP To mitigate the risk of leaking access keys into logs, consider specifying -an environmental variable to \fI\%\-\-awsAccessKeyId\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-awsSecretAccessKey <string> -An AWS \fI\%Secret Key\fP -associated to the specified \fI\%\-\-awsAccessKeyId\fP\&. -.sp -\fI\%\-\-awsSecretAccessKey\fP is required for enabling /core/security\-client\-side\-encryption -for the \fBmongo\fP shell session. \fI\%\-\-awsSecretAccessKey\fP requires \fIall\fP of the following +an environmental variable to \fB\-\-awsAccessKeyId\f1\f1\&. +.RE +.PP +\fBmongo \-\-awsSecretAccessKey\f1 +.RS +.PP +An AWS Secret Key (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html) +associated to the specified \fB\-\-awsAccessKeyId\f1\f1\&. +.PP +\fB\-\-awsSecretAccessKey\f1\f1 is required for enabling \fBClient\-Side Field Level Encryption\f1 +for the \fBmongo\f1\f1 shell session. \fB\-\-awsSecretAccessKey\f1\f1 requires \fIall\f1 of the following command line options: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-awsAccessKeyId\fP +\fB\-\-awsAccessKeyId\f1\f1 .IP \(bu 2 -\fI\%\-\-keyVaultNamespace\fP -.UNINDENT -.sp -If \fI\%\-\-awsSecretAccessKey\fP and its supporting options are omitted, use \fBMongo()\fP +\fB\-\-keyVaultNamespace\f1\f1 +.RE +.PP +If \fB\-\-awsSecretAccessKey\f1\f1 and its supporting options are omitted, use \fBMongo()\f1\f1 within the shell session to enable client\-side field level encryption. -.sp +.PP To mitigate the risk of leaking access keys into logs, consider specifying -an environmental variable to \fI\%\-\-awsSecretAccessKey\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-awsSessionToken <string> -An AWS \fI\%Session Token\fP -associated to the specified \fI\%\-\-awsAccessKeyId\fP\&. -.sp -\fI\%\-\-awsSessionToken\fP is required for enabling /core/security\-client\-side\-encryption -for the \fBmongo\fP shell session. \fI\%\-\-awsSessionToken\fP requires \fIall\fP of the following +an environmental variable to \fB\-\-awsSecretAccessKey\f1\f1\&. +.RE +.PP +\fBmongo \-\-awsSessionToken\f1 +.RS +.PP +An AWS Session Token (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html) +associated to the specified \fB\-\-awsAccessKeyId\f1\f1\&. +.PP +\fB\-\-awsSessionToken\f1\f1 is required for enabling \fBClient\-Side Field Level Encryption\f1 +for the \fBmongo\f1\f1 shell session. \fB\-\-awsSessionToken\f1\f1 requires \fIall\f1 of the following command line options: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-awsAccessKeyId\fP +\fB\-\-awsAccessKeyId\f1\f1 .IP \(bu 2 -\fI\%\-\-awsSecretAccessKey\fP +\fB\-\-awsSecretAccessKey\f1\f1 .IP \(bu 2 -\fI\%\-\-keyVaultNamespace\fP -.UNINDENT -.sp -If \fI\%\-\-awsSessionToken\fP and its supporting options are omitted, use \fBMongo()\fP +\fB\-\-keyVaultNamespace\f1\f1 +.RE +.PP +If \fB\-\-awsSessionToken\f1\f1 and its supporting options are omitted, use \fBMongo()\f1\f1 within the shell session to enable client\-side field level encryption. -.sp +.PP To mitigate the risk of leaking access keys into logs, consider specifying -an environmental variable to \fI\%\-\-awsSessionToken\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyVaultNamespace <string> -The full namespace (\fB<database>.<collection>\fP) of the collection used as a -key vault for /core/security\-client\-side\-encryption\&. \fI\%\-\-keyVaultNamespace\fP is -required for enabling client\-side field level encryption. for the \fBmongo\fP -shell session. \fBmongo\fP creates the specified namespace if it does not +an environmental variable to \fB\-\-awsSessionToken\f1\f1\&. +.RE +.PP +\fBmongo \-\-keyVaultNamespace\f1 +.RS +.PP +The full namespace (\fB<database>.<collection>\f1) of the collection used as a +key vault for \fBClient\-Side Field Level Encryption\f1\&. \fB\-\-keyVaultNamespace\f1\f1 is +required for enabling client\-side field level encryption. for the \fBmongo\f1\f1 +shell session. \fBmongo\f1\f1 creates the specified namespace if it does not exist. -.sp -\fI\%\-\-keyVaultNamespace\fP requires \fIall\fP of the following command line options: -.INDENT 7.0 +.PP +\fB\-\-keyVaultNamespace\f1\f1 requires \fIall\f1 of the following command line options: +.RS .IP \(bu 2 -\fI\%\-\-awsAccessKeyId\fP +\fB\-\-awsAccessKeyId\f1\f1 .IP \(bu 2 -\fI\%\-\-awsSecretAccessKey\fP -.UNINDENT -.sp -If \fI\%\-\-keyVaultNamespace\fP and its supporting options are omitted, use the \fBMongo()\fP +\fB\-\-awsSecretAccessKey\f1\f1 +.RE +.PP +If \fB\-\-keyVaultNamespace\f1\f1 and its supporting options are omitted, use the \fBMongo()\f1\f1 constructor within the shell session to enable client\-side field level encryption. -.UNINDENT +.RE .SH FILES -.INDENT 0.0 -.TP -.B \fB~/.dbshell\fP -\fI\%mongo\fP maintains a history of commands in the \fB\&.dbshell\fP +.PP +\fB~/.dbshell\f1 +.RS +.PP +\fBmongo\f1\f1 maintains a history of commands in the \&.dbshell file. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%mongo\fP does not record interaction related to +.PP +\fBmongo\f1\f1 does not record interaction related to authentication in the history file, including -\fBauthenticate\fP and \fBdb.createUser()\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \fB~/.mongorc.js\fP -\fI\%mongo\fP will read the \fB\&.mongorc.js\fP file from the home -directory of the user invoking \fI\%mongo\fP\&. In the file, users -can define variables, customize the \fI\%mongo\fP shell prompt, +\fBauthenticate\f1\f1 and \fBdb.createUser()\f1\f1\&. +.RE +.PP +\fB~/.mongorc.js\f1 +.RS +.PP +\fBmongo\f1\f1 will read the \fB\&.mongorc.js\f1 file from the home +directory of the user invoking \fBmongo\f1\f1\&. In the file, users +can define variables, customize the \fBmongo\f1\f1 shell prompt, or update information that they would like updated every time they launch a shell. If you use the shell to evaluate a JavaScript file -or expression either on the command line with \fI\%mongo \-\-eval\fP or -by specifying \fI\%a .js file to mongo\fP, -\fI\%mongo\fP will read the \fB\&.mongorc.js\fP file \fIafter\fP the +or expression either on the command line with \fBmongo \-\-eval\f1\f1 or +by specifying \fBa .js file to mongo\f1, +\fBmongo\f1\f1 will read the \fB\&.mongorc.js\f1 file \fIafter\f1 the JavaScript has finished processing. -.sp -Specify the \fI\%\-\-norc\fP option to disable -reading \fB\&.mongorc.js\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \fB/etc/mongorc.js\fP -Global \fBmongorc.js\fP file which the \fI\%mongo\fP shell -evaluates upon start\-up. If a user also has a \fB\&.mongorc.js\fP -file located in the \fI\%HOME\fP directory, the \fI\%mongo\fP -shell evaluates the global \fB/etc/mongorc.js\fP file \fIbefore\fP -evaluating the user\(aqs \fB\&.mongorc.js\fP file. -.sp -\fB/etc/mongorc.js\fP must have read permission for the user -running the shell. The \fI\%\-\-norc\fP option for \fI\%mongo\fP -suppresses only the user\(aqs \fB\&.mongorc.js\fP file. -.sp -On Windows, the global \fBmongorc.js </etc/mongorc.js>\fP exists -in the \fB%ProgramData%\eMongoDB\fP directory. -.TP -.B \fB/tmp/mongo_edit\fP\fI<time_t>\fP\fB\&.js\fP -Created by \fI\%mongo\fP when editing a file. If the file exists, -\fI\%mongo\fP will append an integer from \fB1\fP to \fB10\fP to the +.PP +Specify the \fB\-\-norc\f1\f1 option to disable +reading \fB\&.mongorc.js\f1\&. +.RE +.PP +\fB/etc/mongorc.js\f1 +.RS +.PP +Global \fBmongorc.js\f1 file which the \fBmongo\f1\f1 shell +evaluates upon start\-up. If a user also has a \&.mongorc.js +file located in the \fBHOME\f1\f1 directory, the \fBmongo\f1\f1 +shell evaluates the global /etc/mongorc.js file \fIbefore\f1 +evaluating the user\(aqs \&.mongorc.js file. +.PP +/etc/mongorc.js must have read permission for the user +running the shell. The \fB\-\-norc\f1\f1 option for \fBmongo\f1\f1 +suppresses only the user\(aqs \&.mongorc.js file. +.PP +On Windows, the global mongorc.js </etc/mongorc.js> exists +in the %ProgramData%\MongoDB directory. +.RE +.PP +\fB/tmp/mongo_edit{<time_t>}.js\f1 +.RS +.PP +Created by \fBmongo\f1\f1 when editing a file. If the file exists, +\fBmongo\f1\f1 will append an integer from \fB1\f1 to \fB10\f1 to the time value to attempt to create a unique file. -.TP -.B \fB%TEMP%mongo_edit\fP\fI<time_t>\fP\fB\&.js\fP -Created by \fBmongo.exe\fP on Windows when editing a file. If -the file exists, \fI\%mongo\fP will append an integer from \fB1\fP -to \fB10\fP to the time value to attempt to create a unique file. -.UNINDENT +.RE +.PP +\fB%TEMP%mongo_edit{<time_t>}.js\f1 +.RS +.PP +Created by \fBmongo.exe\f1\f1 on Windows when editing a file. If +the file exists, \fBmongo\f1\f1 will append an integer from \fB1\f1 +to \fB10\f1 to the time value to attempt to create a unique file. +.RE .SH ENVIRONMENT -.INDENT 0.0 -.TP -.B EDITOR -Specifies the path to an editor to use with the \fBedit\fP shell -command. A JavaScript variable \fBEDITOR\fP will override the value of -\fI\%EDITOR\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B HOME -Specifies the path to the home directory where \fI\%mongo\fP will -read the \fB\&.mongorc.js\fP file and write the \fB\&.dbshell\fP +.PP +\fBEDITOR\f1 +.RS +.PP +Specifies the path to an editor to use with the \fBedit\f1 shell +command. A JavaScript variable \fBEDITOR\f1 will override the value of +\fBEDITOR\f1\f1\&. +.RE +.PP +\fBHOME\f1 +.RS +.PP +Specifies the path to the home directory where \fBmongo\f1\f1 will +read the \&.mongorc.js file and write the \&.dbshell file. -.UNINDENT -.INDENT 0.0 -.TP -.B HOMEDRIVE -On Windows systems, \fI\%HOMEDRIVE\fP specifies the path the -directory where \fI\%mongo\fP will read the \fB\&.mongorc.js\fP -file and write the \fB\&.dbshell\fP file. -.UNINDENT -.INDENT 0.0 -.TP -.B HOMEPATH +.RE +.PP +\fBHOMEDRIVE\f1 +.RS +.PP +On Windows systems, \fBHOMEDRIVE\f1\f1 specifies the path the +directory where \fBmongo\f1\f1 will read the \&.mongorc.js +file and write the \&.dbshell file. +.RE +.PP +\fBHOMEPATH\f1 +.RS +.PP Specifies the Windows path to the home directory where -\fI\%mongo\fP will read the \fB\&.mongorc.js\fP file and write -the \fB\&.dbshell\fP file. -.UNINDENT +\fBmongo\f1\f1 will read the \&.mongorc.js file and write +the \&.dbshell file. +.RE .SH KEYBOARD SHORTCUTS -.sp -The \fI\%mongo\fP shell supports the following keyboard shortcuts: -[1] -.TS -center; -|l|l|. -_ -T{ -\fBKeybinding\fP -T} T{ -\fBFunction\fP -T} -_ -T{ +.PP +The \fBmongo\f1\f1 shell supports the following keyboard shortcuts: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 +Keybinding +.IP \(bu 4 +Function +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Up arrow -T} T{ +.IP \(bu 4 Retrieve previous command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Down\-arrow -T} T{ +.IP \(bu 4 Retrieve next command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Home -T} T{ +.IP \(bu 4 Go to beginning of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 End -T} T{ +.IP \(bu 4 Go to end of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Tab -T} T{ +.IP \(bu 4 Autocomplete method/command -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Left\-arrow -T} T{ +.IP \(bu 4 Go backward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Right\-arrow -T} T{ +.IP \(bu 4 Go forward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-left\-arrow -T} T{ +.IP \(bu 4 Go backward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-right\-arrow -T} T{ +.IP \(bu 4 Go forward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-left\-arrow -T} T{ +.IP \(bu 4 Go backward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-right\-arrow -T} T{ +.IP \(bu 4 Go forward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-A -T} T{ +.IP \(bu 4 Go to the beginning of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-B -T} T{ +.IP \(bu 4 Go backward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-C -T} T{ -Exit the \fI\%mongo\fP shell -T} -_ -T{ +.IP \(bu 4 +Exit the \fBmongo\f1\f1 shell +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-D -T} T{ -Delete a char (or exit the \fI\%mongo\fP shell) -T} -_ -T{ +.IP \(bu 4 +Delete a char (or exit the \fBmongo\f1\f1 shell) +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-E -T} T{ +.IP \(bu 4 Go to the end of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-F -T} T{ +.IP \(bu 4 Go forward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-G -T} T{ +.IP \(bu 4 Abort -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-J -T} T{ +.IP \(bu 4 Accept/evaluate the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-K -T} T{ +.IP \(bu 4 Kill/erase the line -T} -_ -T{ -Ctrl\-L or type \fBcls\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +Ctrl\-L or type \fBcls\f1 +.IP \(bu 4 Clear the screen -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-M -T} T{ +.IP \(bu 4 Accept/evaluate the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-N -T} T{ +.IP \(bu 4 Retrieve next command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-P -T} T{ +.IP \(bu 4 Retrieve previous command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-R -T} T{ +.IP \(bu 4 Reverse\-search command history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-S -T} T{ +.IP \(bu 4 Forward\-search command history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-T -T} T{ +.IP \(bu 4 Transpose characters -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-U -T} T{ +.IP \(bu 4 Perform Unix line\-discard -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-W -T} T{ +.IP \(bu 4 Perform Unix word\-rubout -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-Y -T} T{ +.IP \(bu 4 Yank -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-Z -T} T{ +.IP \(bu 4 Suspend (job control works in linux) -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-H -T} T{ +.IP \(bu 4 Backward\-delete a character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-I -T} T{ +.IP \(bu 4 Complete, same as Tab -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-B -T} T{ +.IP \(bu 4 Go backward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-C -T} T{ +.IP \(bu 4 Capitalize word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-D -T} T{ +.IP \(bu 4 Kill word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-F -T} T{ +.IP \(bu 4 Go forward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-L -T} T{ +.IP \(bu 4 Change word to lowercase -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-U -T} T{ +.IP \(bu 4 Change word to uppercase -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-Y -T} T{ +.IP \(bu 4 Yank\-pop -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-Backspace -T} T{ +.IP \(bu 4 Backward\-kill word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-< -T} T{ +.IP \(bu 4 Retrieve the first command in command history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-> -T} T{ +.IP \(bu 4 Retrieve the last command in command history -T} -_ -.TE -.IP [1] 5 -MongoDB accommodates multiple keybinding. -Since 2.0, \fI\%mongo\fP includes support for basic emacs -keybindings. +.RE +.RE .SH USE -.sp -Typically users invoke the shell with the \fI\%mongo\fP command at +.PP +Typically users invoke the shell with the \fBmongo\f1\f1 command at the system prompt. Consider the following examples for other scenarios. -.SS Connect to a \fBmongod\fP Instance with Access Control -.sp +.SS CONNECT TO A MONGOD INSTANCE WITH ACCESS CONTROL +.PP To connect to a database on a remote host using authentication and a non\-standard port, use the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-username <user> \-\-password \-\-host <host> \-\-port 28015 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongo \-\-username <user> \-\-password \-\-host <host> \-\-port 28015 +.EE +.PP Alternatively, consider the following short form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-u <user> \-p \-\-host <host> \-\-port 28015 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Replace \fB<user>\fP and \fB<host>\fP with the appropriate values for your -situation and substitute or omit the \fI\%\-\-port\fP as +.PP +.EX + mongo \-u <user> \-p \-\-host <host> \-\-port 28015 +.EE +.PP +Replace \fB<user>\f1 and \fB<host>\f1 with the appropriate values for your +situation and substitute or omit the \fB\-\-port\f1\f1 as needed. -.sp -If you do not specify the password to the \fI\%\-\-password\fP or \fI\%\-p\fP command\-line option, the -\fI\%mongo\fP shell prompts for the password. -.SS Connect to a Replica Set Using the DNS Seedlist Connection Format -.sp -New in version 3.6. - -.sp +.PP +If you do not specify the password to the \fB\-\-password\f1\f1 or \fB\-p\f1\f1 command\-line option, the +\fBmongo\f1\f1 shell prompts for the password. +.SS CONNECT TO A REPLICA SET USING THE DNS SEEDLIST CONNECTION FORMAT +.PP To connect to a replica set described using the -connections\-dns\-seedlist, use the \fI\%\-\-host\fP option -to specify the connection string to the \fI\%mongo\fP shell. In +\fBDNS Seed List Connection Format\f1, use the \fB\-\-host\f1\f1 option +to specify the connection string to the \fBmongo\f1\f1 shell. In the following example, the DNS configuration resembles: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Record TTL Class Priority Weight Port Target -_mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27317 mongodb1.example.com. -_mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27017 mongodb2.example.com. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The TXT record for the DNS entry includes the \fBreplicaSet\fP and \fBauthSource\fP options: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Record TTL Class Text -server.example.com. 86400 IN TXT "replicaSet=rs0&authSource=admin" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The following command then connects the \fI\%mongo\fP shell to +.PP +.EX + Record TTL Class Priority Weight Port Target + _mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27317 mongodb1.example.com. + _mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27017 mongodb2.example.com. +.EE +.PP +The TXT record for the DNS entry includes the \fBreplicaSet\f1 and \fBauthSource\f1 options: +.PP +.EX + Record TTL Class Text + server.example.com. 86400 IN TXT "replicaSet=rs0&authSource=admin" +.EE +.PP +The following command then connects the \fBmongo\f1\f1 shell to the replica set: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-host "mongodb+srv://server.example.com/?username=allison" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fI\%mongo\fP shell will automatically prompt you to provide -the password for the user specified in the \fBusername\fP option. -.SS Connect to a MongoDB Atlas Cluster using AWS IAM Credentials -.sp -New in version 4.4. - -.sp -To connect to a \fI\%MongoDB Atlas\fP cluster which -has been configured to support authentication via \fI\%AWS IAM credentials\fP, -provide a connection string to -the \fI\%mongo\fP shell similar to the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://<aws access key id>:<aws secret access key>@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongo \-\-host "mongodb+srv://server.example.com/?username=allison" +.EE +.PP +The \fBmongo\f1\f1 shell will automatically prompt you to provide +the password for the user specified in the \fBusername\f1 option. +.SS CONNECT TO A MONGODB ATLAS CLUSTER USING AWS IAM CREDENTIALS +.PP +To connect to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster which +has been configured to support authentication via AWS IAM credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html), +provide a \fBconnection string\f1 to +the \fBmongo\f1\f1 shell similar to the following: +.PP +.EX + mongo \(aqmongodb+srv://<aws access key id>:<aws secret access key>@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq +.EE +.PP Connecting to Atlas using AWS IAM credentials in this manner uses the -\fBMONGODB\-AWS\fP \fBauthentication mechanism\fP -and the \fB$external\fP \fBauthSource\fP, as shown in this example. -.sp -If using an \fI\%AWS session token\fP -as well, provide it with the \fBAWS_SESSION_TOKEN\fP -\fBauthMechanismProperties\fP value in your -connection string, as follows: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://<aws access key id>:<aws secret access key>@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS&authMechanismProperties=AWS_SESSION_TOKEN:<aws session token>\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1 +and the \fB$external\f1 \fBauthSource\f1\f1, as shown in this example. +.PP +If using an AWS session token (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use\-resources.html) +as well, provide it with the \fBAWS_SESSION_TOKEN\f1 +\fBauthMechanismProperties\f1\f1 value in your +\fBconnection string\f1, as follows: +.PP +.EX + mongo \(aqmongodb+srv://<aws access key id>:<aws secret access key>@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS&authMechanismProperties=AWS_SESSION_TOKEN:<aws session token>\(aq +.EE +.PP If the AWS access key ID, secret access key, or session token include -the \(aqat\(aq sign \fB@\fP, colon \fB:\fP, slash \fB/\fP, or the percent sign \fB%\fP -characters, those characters must be converted using \fI\%percent encoding\fP\&. -.sp +the following characters: +.PP +.EX + : / ? # [ ] @ +.EE +.PP +those characters must be converted using percent encoding (https://tools.ietf.org/html/rfc3986#section\-2.1)\&. +.PP Alternatively, the AWS access key ID, and secret access key, and optionally session token can each be provided outside of the connection -string using the \fI\%\-\-username\fP, \fI\%\-\-password\fP, and -\fI\%\-\-awsIamSessionToken\fP options instead, like so: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq \-\-username <aws access key id> \-\-password <aws secret access key> \-\-awsIamSessionToken <aws session token> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +string using the \fB\-\-username\f1\f1, \fB\-\-password\f1\f1, and +\fB\-\-awsIamSessionToken\f1\f1 options instead, like so: +.PP +.EX + mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq \-\-username <aws access key id> \-\-password <aws secret access key> \-\-awsIamSessionToken <aws session token> +.EE +.PP When provided as command line parameters, these three options do not require percent encoding. -.sp +.PP You may also set these credentials on your platform using standard -\fI\%AWS IAM environment variables\fP\&. -The \fI\%mongo\fP shell checks for the following environment -variables when you use the \fBMONGODB\-AWS\fP -\fBauthentication mechanism\fP: -.INDENT 0.0 +AWS IAM environment variables (https://docs.aws.amazon.com/cli/latest/userguide/cli\-configure\-envvars.html#envvars\-list)\&. +The \fBmongo\f1\f1 shell checks for the following environment +variables when you use the \fBMONGODB\-AWS\f1 +\fBauthentication mechanism\f1\f1: +.RS .IP \(bu 2 -\fBAWS_ACCESS_KEY_ID\fP +\fBAWS_ACCESS_KEY_ID\f1 .IP \(bu 2 -\fBAWS_SECRET_ACCESS_KEY\fP +\fBAWS_SECRET_ACCESS_KEY\f1 .IP \(bu 2 -\fBAWS_SESSION_TOKEN\fP -.UNINDENT -.sp +\fBAWS_SESSION_TOKEN\f1 +.RE +.PP If set, these credentials do not need to be specified in the connection -string or via the explicit options to the \fI\%mongo\fP shell -(i.e. \fI\%\-\-username\fP and \fI\%\-\-password\fP). -.sp -The following example sets these environment variables in the \fBbash\fP +string or via the explicit options to the \fBmongo\f1\f1 shell +(i.e. \fB\-\-username\f1\f1 and \fB\-\-password\f1\f1). +.PP +The following example sets these environment variables in the \fBbash\f1 shell: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -export AWS_ACCESS_KEY_ID=\(aq<aws access key id>\(aq -export AWS_SECRET_ACCESS_KEY=\(aq<aws secret access key>\(aq -export AWS_SESSION_TOKEN=\(aq<aws session token>\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + export AWS_ACCESS_KEY_ID=\(aq<aws access key id>\(aq + export AWS_SECRET_ACCESS_KEY=\(aq<aws secret access key>\(aq + export AWS_SESSION_TOKEN=\(aq<aws session token>\(aq +.EE +.PP Syntax for setting environment variables in other shells will be different. Consult the documentation for your platform for more information. -.sp +.PP You can verify that these environment variables have been set with the following command: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -env | grep AWS -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + env | grep AWS +.EE +.PP Once set, the following example connects to a MongoDB Atlas cluster using these environment variables: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.SS Execute JavaScript Against the \fI\%mongo\fP Shell -.sp -To execute a JavaScript file without evaluating the \fB~/.mongorc.js\fP +.PP +.EX + mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq +.EE +.SS EXECUTE JAVASCRIPT AGAINST THE MONGO SHELL +.PP +To execute a JavaScript file without evaluating the ~/.mongorc.js file before starting a shell session, use the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-shell \-\-norc alternate\-environment.js -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongo \-\-shell \-\-norc alternate\-environment.js +.EE +.PP To execute a JavaScript file with authentication, with password prompted rather than provided on the command\-line, use the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo script\-file.js \-u <user> \-p -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -\fBisInteractive()\fP -.UNINDENT -.UNINDENT -.SS Use \fI\%\-\-eval\fP to Execute JavaScript Code -.sp -You may use the \fI\%\-\-eval\fP option to execute +.PP +.EX + mongo script\-file.js \-u <user> \-p +.EE +.PP +\fBisInteractive()\f1\f1 +.SS USE --EVAL TO EXECUTE JAVASCRIPT CODE +.PP +You may use the \fB\-\-eval\f1\f1 option to execute JavaScript directly from the command line. -.sp +.PP For example, the following operation evaluates a JavaScript string which queries a collection and prints the results as JSON. -.sp -On Linux and macOS, you will need to use single quotes (e.g. \fB\(aq\fP) +.PP +On Linux and macOS, you will need to use single quotes (e.g. \fB\(aq\f1) to enclose the JavaScript, using the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-eval \(aqdb.collection.find().forEach(printjson)\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -On Windows, you will need to use double quotes (e.g. \fB"\fP) +.PP +.EX + mongo \-\-eval \(aqdb.collection.find().forEach(printjson)\(aq +.EE +.PP +On Windows, you will need to use double quotes (e.g. \fB"\f1) to enclose the JavaScript, using the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-eval "db.collection.find().forEach(printjson)" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -/reference/mongo\-shell -.IP \(bu 2 -/reference/method -.IP \(bu 2 -/mongo -.IP \(bu 2 -\fBisInteractive()\fP -.UNINDENT -.UNINDENT -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +.PP +.EX + mongo \-\-eval "db.collection.find().forEach(printjson)" +.EE +.RS +.IP \(bu 2 +\fBmongo\f1 Shell Quick Reference\f1 +.IP \(bu 2 +\fBmongosh\f1 Methods\f1 +.IP \(bu 2 +\fBLegacy mongo\f1 Shell\f1 +.IP \(bu 2 +\fBisInteractive()\f1\f1 +.RE diff --git a/debian/mongod.1 b/debian/mongod.1 index a49aeefc92a..e848aaed888 100644 --- a/debian/mongod.1 +++ b/debian/mongod.1 @@ -1,2248 +1,1979 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGOD" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongod \- MongoDB Server -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Options\fP -.INDENT 2.0 -.IP \(bu 2 -\fI\%Core Options\fP -.IP \(bu 2 -\fI\%Free Monitoring\fP -.IP \(bu 2 -\fI\%LDAP Authentication or Authorization Options\fP -.IP \(bu 2 -\fI\%Storage Options\fP -.IP \(bu 2 -\fI\%WiredTiger Options\fP -.IP \(bu 2 -\fI\%Replication Options\fP -.IP \(bu 2 -\fI\%Sharded Cluster Options\fP -.IP \(bu 2 -\fI\%TLS Options\fP -.IP \(bu 2 -\fI\%SSL Options (Deprecated)\fP -.IP \(bu 2 -\fI\%Profiler Options\fP -.IP \(bu 2 -\fI\%Audit Options\fP -.IP \(bu 2 -\fI\%SNMP Options\fP -.IP \(bu 2 -\fI\%inMemory Options\fP -.IP \(bu 2 -\fI\%Encryption Key Management Options\fP -.UNINDENT -.UNINDENT +.TH mongod 1 +.SH MONGOD .SH SYNOPSIS -.sp -\fI\%mongod\fP is the primary daemon process for the MongoDB +\fBmongod\f1\f1 is the primary daemon process for the MongoDB system. It handles data requests, manages data access, and performs background management operations. -.sp +.PP This document provides a complete overview of all command line options -for \fI\%mongod\fP\&. These command line options are primarily useful -for testing: In common operation, use the configuration file -options to control the behavior of +for \fBmongod\f1\f1\&. These command line options are primarily useful +for testing: In common operation, use the \fBconfiguration file +options\f1 to control the behavior of your database. -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -conf\-file\-command\-line\-mapping -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 +.PP +\fBConfiguration File Settings and Command\-Line Options Mapping\f1 +.PP Starting in version 4.0, MongoDB disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT +more details, see \fBDisable TLS 1.0\f1\&. .SH OPTIONS -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.2" -.INDENT 0.0 +.RS .IP \(bu 2 -MongoDB deprecates the SSL options and insteads adds new +MongoDB removes the \fB\-\-serviceExecutor\f1 command\-line option and the +corresponding \fBnet.serviceExecutor\f1 configuration option. +.RE +.RS +.IP \(bu 2 +MongoDB removes the \fB\-\-noIndexBuildRetry\f1 command\-line option +and the corresponding \fBstorage.indexBuildRetry\f1 option. +.RE +.RS +.IP \(bu 2 +MongoDB deprecates the SSL options and instead adds new corresponding TLS options. .IP \(bu 2 MongoDB adds -\fI\%\-\-tlsClusterCAFile\fP/\fBnet.tls.clusterCAFile\fP\&. (Also availalbe +\fB\-\-tlsClusterCAFile\f1\f1/\fBnet.tls.clusterCAFile\f1\f1\&. (Also available in 3.4.18+, 3.6.9+, 4.0.3+) -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.4" -.INDENT 0.0 -.IP \(bu 2 -MongoDB removes the \fB\-\-noIndexBuildRetry\fP command\-line option -and the corresponding \fBstorage.indexBuildRetry\fP option. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Core Options -.INDENT 0.0 -.TP -.B \-\-help, \-h -Returns information on the options and use of \fBmongod\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-version -Returns the \fBmongod\fP release number. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-config <filename>, \-f <filename> +.RE +.SS CORE OPTIONS +.PP +\fBmongod \-\-help\f1, \fBmongod \-h\f1 +.RS +.PP +Returns information on the options and use of \fBmongod\f1\f1\&. +.RE +.PP +\fBmongod \-\-version\f1 +.RS +.PP +Returns the \fBmongod\f1\f1 release number. +.RE +.PP +\fBmongod \-\-config\f1, \fBmongod \-f\f1 +.RS +.PP Specifies a configuration file for runtime configuration options. The configuration file is the preferred method for runtime configuration of -\fBmongod\fP\&. The options are equivalent to the command\-line -configuration options. See /reference/configuration\-options for +\fBmongod\f1\f1\&. The options are equivalent to the command\-line +configuration options. See \fBConfiguration File Options\f1 for more information. -.sp -Ensure the configuration file uses ASCII encoding. The \fBmongod\fP +.PP +Ensure the configuration file uses ASCII encoding. The \fBmongod\f1\f1 instance does not support configuration files with non\-ASCII encoding, including UTF\-8. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-configExpand <none|rest|exec> -\fIDefault\fP: none -.sp -New in version 4.2. - -.sp -Enables using Expansion Directives +.RE +.PP +\fBmongod \-\-configExpand\f1 +.RS +.PP +\fIDefault\f1: none +.PP +Enables using \fBExpansion Directives\f1 in configuration files. Expansion directives allow you to set externally sourced values for configuration file options. -.sp -\fI\%\-\-configExpand\fP supports the following expansion directives: -.TS -center; -|l|l|. -_ -T{ +.PP +\fB\-\-configExpand\f1\f1 supports the following expansion directives: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBnone\fP -T} T{ -Default. \fBmongod\fP does not expand expansion directives. -\fBmongod\fP fails to start if any configuration file settings +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBnone\f1 +.IP \(bu 4 +Default. \fBmongod\f1\f1 does not expand expansion directives. +\fBmongod\f1\f1 fails to start if any configuration file settings use expansion directives. -T} -_ -T{ -\fBrest\fP -T} T{ -\fBmongod\fP expands \fB__rest\fP expansion directives when +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrest\f1 +.IP \(bu 4 +\fBmongod\f1\f1 expands \fB__rest\f1 expansion directives when parsing the configuration file. -T} -_ -T{ -\fBexec\fP -T} T{ -\fBmongod\fP expands \fB__exec\fP expansion directives when +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBexec\f1 +.IP \(bu 4 +\fBmongod\f1\f1 expands \fB__exec\f1 expansion directives when parsing the configuration file. -T} -_ -.TE -.sp +.RE +.RE +.PP You can specify multiple expansion directives as a comma\-separated -list, e.g. \fBrest, exec\fP\&. If the configuration file contains -expansion directives not specified to \fI\%\-\-configExpand\fP, the \fBmongod\fP +list, e.g. \fBrest, exec\f1\&. If the configuration file contains +expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongod\f1\f1 returns an error and terminates. -.sp -See externally\-sourced\-values for configuration files +.PP +See \fBExternally Sourced Configuration File Values\f1 for configuration files for more information on expansion directives. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-verbose, \-v +.RE +.PP +\fBmongod \-\-verbose\f1, \fBmongod \-v\f1 +.RS +.PP Increases the amount of internal reporting returned on standard output -or in log files. Increase the verbosity with the \fB\-v\fP form by -including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +or in log files. Increase the verbosity with the \fB\-v\f1 form by +including the option multiple times, (e.g. \fB\-vvvvv\f1\&.) +.PP Starting in version 4.2, MongoDB includes the Debug verbosity level -(1\-5) in the log messages\&. For example, -if the verbosity level is 2, MongoDB logs \fBD2\fP\&. In previous -versions, MongoDB log messages only specified \fBD\fP for Debug level. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quiet -Runs \fBmongod\fP in a quiet mode that attempts to limit the amount +(1\-5) in the \fBlog messages\f1\&. For example, +if the verbosity level is 2, MongoDB logs \fBD2\f1\&. In previous +versions, MongoDB log messages only specified \fBD\f1 for Debug level. +.RE +.PP +\fBmongod \-\-quiet\f1 +.RS +.PP +Runs \fBmongod\f1\f1 in a quiet mode that attempts to limit the amount of output. -.sp +.PP This option suppresses: -.INDENT 7.0 +.RS .IP \(bu 2 -output from database commands +output from \fBdatabase commands\f1 .IP \(bu 2 replication activity .IP \(bu 2 connection accepted events .IP \(bu 2 connection closed events -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-port <port> -\fIDefault\fP: -.INDENT 7.0 -.IP \(bu 2 -27017 if \fI\%mongod\fP is not a shard member or a config server member -.IP \(bu 2 -27018 if \fI\%mongod\fP is a \fI\%shard member\fP -.IP \(bu 2 -27019 if \fI\%mongod\fP is a \fI\%config server member\fP -.UNINDENT -.sp +.RE +.RE +.PP +\fBmongod \-\-port\f1 +.RS +.PP +\fIDefault\f1: +.RS +.IP \(bu 2 +27017 if \fBmongod\f1\f1 is not a shard member or a config server member +.IP \(bu 2 +27018 if \fBmongod\f1\f1 is a \fBshard member\f1\f1 +.IP \(bu 2 +27019 if \fBmongod\f1\f1 is a \fBconfig server member\f1\f1 +.RE +.PP The TCP port on which the MongoDB instance listens for client connections. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bind_ip <hostnames|ipaddresses|Unix domain socket paths> -\fIDefault\fP: localhost -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 3.6, \fBmongod\fP bind to localhost -by default. See 3.6\-bind\-to\-localhost\&. -.UNINDENT -.UNINDENT -.sp +.RE +.PP +\fBmongod \-\-bind_ip\f1 +.RS +.PP +\fIDefault\f1: localhost +.PP +Starting in MongoDB 3.6, \fBmongod\f1\f1 bind to localhost +by default. See \fBDefault Bind to Localhost\f1\&. +.PP The hostnames and/or IP addresses and/or full Unix domain socket -paths on which \fBmongod\fP should listen for client connections. You -may attach \fBmongod\fP to any interface. To bind to multiple +paths on which \fBmongod\f1\f1 should listen for client connections. You +may attach \fBmongod\f1\f1 to any interface. To bind to multiple addresses, enter a list of comma\-separated values. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost,/tmp/mongod.sock\fP -.UNINDENT -.UNINDENT -.sp +.PP You can specify both IPv4 and IPv6 addresses, or hostnames that resolve to an IPv4 or IPv6 address. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost, 2001:0DB8:e132:ba26:0d5c:2774:e7f9:d513\fP -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -If specifying an IPv6 address \fIor\fP a hostname that resolves to an -IPv6 address to \fI\%\-\-bind_ip\fP, you must start \fBmongod\fP with -\fI\%\-\-ipv6\fP to enable IPv6 support. Specifying an IPv6 address -to \fI\%\-\-bind_ip\fP does not enable IPv6 support. -.UNINDENT -.UNINDENT -.sp +.PP +If specifying an IPv6 address \fIor\f1 a hostname that resolves to an +IPv6 address to \fB\-\-bind_ip\f1\f1, you must start \fBmongod\f1\f1 with +\fB\-\-ipv6\f1\f1 to enable IPv6 support. Specifying an IPv6 address +to \fB\-\-bind_ip\f1\f1 does not enable IPv6 support. +.PP If specifying a -\fI\%link\-local IPv6 address\fP -(\fBfe80::/10\fP), you must append the -\fI\%zone index\fP -to that address (i.e. \fBfe80::<address>%<adapter\-name>\fP). -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost,fe80::a00:27ff:fee0:1fcf%enp0s3\fP -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.SS Tip -.sp +link\-local IPv6 address (https://en.wikipedia.org/wiki/Link\-local_address#IPv6) +(\fBfe80::/10\f1), you must append the +zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index)) +to that address (i.e. \fBfe80::<address>%<adapter\-name>\f1). +.PP When possible, use a logical DNS hostname instead of an ip address, particularly when configuring replica set members or sharded cluster members. The use of logical DNS hostnames avoids configuration changes due to ip address changes. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Before binding to a non\-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see -/administration/security\-checklist\&. At minimum, consider -enabling authentication and -hardening network infrastructure\&. -.UNINDENT -.UNINDENT -.sp +\fBSecurity Checklist\f1\&. At minimum, consider +\fBenabling authentication\f1 and +\fBhardening network infrastructure\f1\&. +.PP For more information about IP Binding, refer to the -/core/security\-mongodb\-configuration documentation. -.sp -To bind to all IPv4 addresses, enter \fB0.0.0.0\fP\&. -.sp -To bind to all IPv4 and IPv6 addresses, enter \fB::,0.0.0.0\fP or -starting in MongoDB 4.2, an asterisk \fB"*"\fP (enclose the asterisk in +\fBIP Binding\f1 documentation. +.PP +To bind to all IPv4 addresses, enter \fB0.0.0.0\f1\&. +.PP +To bind to all IPv4 and IPv6 addresses, enter \fB::,0.0.0.0\f1 or +starting in MongoDB 4.2, an asterisk \fB"*"\f1 (enclose the asterisk in quotes to avoid filename pattern expansion). Alternatively, use the -\fBnet.bindIpAll\fP setting. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fB\-\-bind_ip\fP and \fB\-\-bind_ip_all\fP are mutually exclusive. -Specifying both options causes \fBmongod\fP to throw an error and +\fBnet.bindIpAll\f1\f1 setting. +.RS +.IP \(bu 2 +\fB\-\-bind_ip\f1 and \fB\-\-bind_ip_all\f1 are mutually exclusive. +Specifying both options causes \fBmongod\f1\f1 to throw an error and terminate. .IP \(bu 2 -The command\-line option \fB\-\-bind\fP overrides the configuration -file setting \fBnet.bindIp\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bind_ip_all -New in version 3.6. - -.sp -If specified, the \fBmongod\fP instance binds to all IPv4 -addresses (i.e. \fB0.0.0.0\fP). If \fBmongod\fP starts with -\fI\%\-\-ipv6\fP, \fI\%\-\-bind_ip_all\fP also binds to all IPv6 addresses -(i.e. \fB::\fP). -.sp -\fBmongod\fP only supports IPv6 if started with \fI\%\-\-ipv6\fP\&. Specifying -\fI\%\-\-bind_ip_all\fP alone does not enable IPv6 support. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +The command\-line option \fB\-\-bind\f1 overrides the configuration +file setting \fBnet.bindIp\f1\f1\&. +.RE +.RE +.PP +\fBmongod \-\-bind_ip_all\f1 +.RS +.PP +If specified, the \fBmongod\f1\f1 instance binds to all IPv4 +addresses (i.e. \fB0.0.0.0\f1). If \fBmongod\f1\f1 starts with +\fB\-\-ipv6\f1\f1, \fB\-\-bind_ip_all\f1\f1 also binds to all IPv6 addresses +(i.e. \fB::\f1). +.PP +\fBmongod\f1\f1 only supports IPv6 if started with \fB\-\-ipv6\f1\f1\&. Specifying +\fB\-\-bind_ip_all\f1\f1 alone does not enable IPv6 support. +.PP Before binding to a non\-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see -/administration/security\-checklist\&. At minimum, consider -enabling authentication and -hardening network infrastructure\&. -.UNINDENT -.UNINDENT -.sp +\fBSecurity Checklist\f1\&. At minimum, consider +\fBenabling authentication\f1 and +\fBhardening network infrastructure\f1\&. +.PP For more information about IP Binding, refer to the -/core/security\-mongodb\-configuration documentation. -.sp -Alternatively, you can set the \fB\-\-bind_ip\fP option to \fB::,0.0.0.0\fP -or, starting in MongoDB 4.2, to an asterisk \fB"*"\fP (enclose the +\fBIP Binding\f1 documentation. +.PP +Alternatively, you can set the \fB\-\-bind_ip\f1 option to \fB::,0.0.0.0\f1 +or, starting in MongoDB 4.2, to an asterisk \fB"*"\f1 (enclose the asterisk in quotes to avoid filename pattern expansion). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fB\-\-bind_ip\fP and \fB\-\-bind_ip_all\fP are mutually exclusive. That +.PP +\fB\-\-bind_ip\f1 and \fB\-\-bind_ip_all\f1 are mutually exclusive. That is, you can specify one or the other, but not both. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clusterIpSourceAllowlist <string> -New in version 3.6. - -.sp -A list of IP addresses/CIDR (\fI\%Classless Inter\-Domain Routing\fP) ranges against which the -\fI\%mongod\fP validates authentication requests from other members of -the replica set and, if part of a sharded cluster, the \fBmongos\fP -instances. The \fI\%mongod\fP verifies that the originating IP is +.RE +.PP +\fBmongod \-\-clusterIpSourceAllowlist\f1 +.RS +.PP +A list of IP addresses/CIDR (Classless Inter\-Domain Routing (https://tools.ietf.org/html/rfc4632)) ranges against which the +\fBmongod\f1\f1 validates authentication requests from other members of +the replica set and, if part of a sharded cluster, the \fBmongos\f1\f1 +instances. The \fBmongod\f1\f1 verifies that the originating IP is either explicitly in the list or belongs to a CIDR range in the list. If the IP address is not present, the server does not authenticate the -\fI\%mongod\fP or \fBmongos\fP\&. -.sp -\fI\%\-\-clusterIpSourceAllowlist\fP has no effect on a \fI\%mongod\fP started without -authentication\&. -.sp -\fI\%\-\-clusterIpSourceAllowlist\fP accepts multiple comma\-separated IPv4/6 addresses or Classless -Inter\-Domain Routing (\fI\%CIDR\fP) ranges: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-clusterIpSourceAllowlist 192.0.2.0/24,127.0.0.1,::1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Ensure \fI\%\-\-clusterIpSourceAllowlist\fP includes the IP address \fIor\fP CIDR ranges that include the -IP address of each replica set member or \fBmongos\fP in the +\fBmongod\f1\f1 or \fBmongos\f1\f1\&. +.PP +\fB\-\-clusterIpSourceAllowlist\f1\f1 has no effect on a \fBmongod\f1\f1 started without +\fBauthentication\f1\&. +.PP +\fB\-\-clusterIpSourceAllowlist\f1\f1 accepts multiple comma\-separated IPv4/6 addresses or Classless +Inter\-Domain Routing (CIDR (https://tools.ietf.org/html/rfc4632)) ranges: +.PP +.EX + mongod \-\-clusterIpSourceAllowlist 192.0.2.0/24,127.0.0.1,::1 +.EE +.PP +Ensure \fB\-\-clusterIpSourceAllowlist\f1\f1 includes the IP address \fIor\f1 CIDR ranges that include the +IP address of each replica set member or \fBmongos\f1\f1 in the deployment to ensure healthy communication between cluster components. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ipv6 -Enables IPv6 support. \fBmongod\fP disables IPv6 support by default. -.sp -Setting \fI\%\-\-ipv6\fP does \fInot\fP direct the \fBmongod\fP to listen on any -local IPv6 addresses or interfaces. To configure the \fBmongod\fP to +.RE +.PP +\fBmongod \-\-clusterIpSourceWhitelist\f1 +.RS +.PP +\fIDeprecated in version 5.0:\f1 +Use \fB\-\-clusterIpSourceAllowlist\f1\f1 instead. +.PP +A list of IP addresses/CIDR (Classless Inter\-Domain Routing (https://tools.ietf.org/html/rfc4632)) ranges against which the +\fBmongod\f1\f1 validates authentication requests from other members of +the replica set and, if part of a sharded cluster, the \fBmongos\f1\f1 +instances. The \fBmongod\f1\f1 verifies that the originating IP is +either explicitly in the list or belongs to a CIDR range in the list. If the +IP address is not present, the server does not authenticate the +\fBmongod\f1\f1 or \fBmongos\f1\f1\&. +.PP +\fB\-\-clusterIpSourceWhitelist\f1\f1 has no effect on a \fBmongod\f1\f1 started without +\fBauthentication\f1\&. +.PP +\fB\-\-clusterIpSourceWhitelist\f1\f1 accepts multiple comma\-separated IPv4/6 addresses or Classless +Inter\-Domain Routing (CIDR (https://tools.ietf.org/html/rfc4632)) ranges: +.PP +.EX + mongod \-\-clusterIpSourceWhitelist 192.0.2.0/24,127.0.0.1,::1 +.EE +.PP +Ensure \fB\-\-clusterIpSourceWhitelist\f1\f1 includes the IP address \fIor\f1 CIDR ranges that include the +IP address of each replica set member or \fBmongos\f1\f1 in the +deployment to ensure healthy communication between cluster components. +.RE +.PP +\fBmongod \-\-ipv6\f1 +.RS +.PP +Enables IPv6 support. \fBmongod\f1\f1 disables IPv6 support by default. +.PP +Setting \fB\-\-ipv6\f1\f1 does \fInot\f1 direct the \fBmongod\f1\f1 to listen on any +local IPv6 addresses or interfaces. To configure the \fBmongod\f1\f1 to listen on an IPv6 interface, you must either: -.INDENT 7.0 -.IP \(bu 2 -Configure \fI\%\-\-bind_ip\fP with one or more IPv6 addresses or -hostnames that resolve to IPv6 addresses, \fBor\fP -.IP \(bu 2 -Set \fI\%\-\-bind_ip_all\fP to \fBtrue\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-listenBacklog <number> -\fIDefault\fP: Target system \fBSOMAXCONN\fP constant -.sp -New in version 3.6. - -.sp +.RS +.IP \(bu 2 +Configure \fB\-\-bind_ip\f1\f1 with one or more IPv6 addresses or +hostnames that resolve to IPv6 addresses, \fBor\f1 +.IP \(bu 2 +Set \fB\-\-bind_ip_all\f1\f1 to \fBtrue\f1\&. +.RE +.RE +.PP +\fBmongod \-\-listenBacklog\f1 +.RS +.PP +\fIDefault\f1: Target system \fBSOMAXCONN\f1 constant +.PP The maximum number of connections that can exist in the listen queue. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Consult your local system\(aqs documentation to understand the limitations and configuration requirements before using this parameter. -.UNINDENT -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP To prevent undefined behavior, specify a value for this -parameter between \fB1\fP and the local system \fBSOMAXCONN\fP +parameter between \fB1\f1 and the local system \fBSOMAXCONN\f1 constant. -.UNINDENT -.UNINDENT -.sp -The default value for the \fBlistenBacklog\fP parameter is set at -compile time to the target system \fBSOMAXCONN\fP constant. -\fBSOMAXCONN\fP is the maximum valid value that is documented for -the \fIbacklog\fP parameter to the \fIlisten\fP system call. -.sp -Some systems may interpret \fBSOMAXCONN\fP symbolically, and others -numerically. The actual \fIlisten backlog\fP applied in practice may -differ from any numeric interpretation of the \fBSOMAXCONN\fP constant -or argument to \fB\-\-listenBacklog\fP, and may also be constrained by -system settings like \fBnet.core.somaxconn\fP on Linux. -.sp -Passing a value for the \fBlistenBacklog\fP parameter that exceeds the -\fBSOMAXCONN\fP constant for the local system is, by the letter of the +.PP +The default value for the \fBlistenBacklog\f1 parameter is set at +compile time to the target system \fBSOMAXCONN\f1 constant. +\fBSOMAXCONN\f1 is the maximum valid value that is documented for +the \fIbacklog\f1 parameter to the \fIlisten\f1 system call. +.PP +Some systems may interpret \fBSOMAXCONN\f1 symbolically, and others +numerically. The actual \fIlisten backlog\f1 applied in practice may +differ from any numeric interpretation of the \fBSOMAXCONN\f1 constant +or argument to \fB\-\-listenBacklog\f1, and may also be constrained by +system settings like \fBnet.core.somaxconn\f1 on Linux. +.PP +Passing a value for the \fBlistenBacklog\f1 parameter that exceeds the +\fBSOMAXCONN\f1 constant for the local system is, by the letter of the standards, undefined behavior. Higher values may be silently integer truncated, may be ignored, may cause unexpected resource consumption, or have other adverse consequences. -.sp +.PP On systems with workloads that exhibit connection spikes, for which it is empirically known that the local system can honor higher -values for the \fIbacklog\fP parameter than the \fBSOMAXCONN\fP constant, -setting the \fBlistenBacklog\fP parameter to a higher value may reduce +values for the \fIbacklog\f1 parameter than the \fBSOMAXCONN\f1 constant, +setting the \fBlistenBacklog\f1 parameter to a higher value may reduce operation latency as observed by the client by reducing the number of connections which are forced into a backoff state. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-maxConns <number> -The maximum number of simultaneous connections that \fBmongod\fP will +.RE +.PP +\fBmongod \-\-maxConns\f1 +.RS +.PP +The maximum number of simultaneous connections that \fBmongod\f1\f1 will accept. This setting has no effect if it is higher than your operating system\(aqs configured maximum connection tracking threshold. -.sp +.PP Do not assign too low of a value to this option, or you will encounter errors during normal application operation. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logpath <path> +.RE +.PP +\fBmongod \-\-logpath\f1 +.RS +.PP Sends all diagnostic logging information to a log file instead of to -standard output or to the host\(aqs syslog system. MongoDB creates +standard output or to the host\(aqs \fBsyslog\f1 system. MongoDB creates the log file at the path you specify. -.sp +.PP By default, MongoDB will move any existing log file rather than overwrite -it. To instead append to the log file, set the \fI\%\-\-logappend\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syslog -Sends all logging output to the host\(aqs syslog system rather -than to standard output or to a log file (\fI\%\-\-logpath\fP). -.sp -The \fI\%\-\-syslog\fP option is not supported on Windows. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fBsyslog\fP daemon generates timestamps when it logs a message, not +it. To instead append to the log file, set the \fB\-\-logappend\f1\f1 option. +.RE +.PP +\fBmongod \-\-syslog\f1 +.RS +.PP +Sends all logging output to the host\(aqs \fBsyslog\f1 system rather +than to standard output or to a log file (\fB\-\-logpath\f1\f1). +.PP +The \fB\-\-syslog\f1\f1 option is not supported on Windows. +.PP +The \fBsyslog\f1 daemon generates timestamps when it logs a message, not when MongoDB issues the message. This can lead to misleading timestamps for log entries, especially when the system is under heavy load. We -recommend using the \fI\%\-\-logpath\fP option for production systems to +recommend using the \fB\-\-logpath\f1\f1 option for production systems to ensure accurate timestamps. -.UNINDENT -.UNINDENT -.sp -Starting in version 4.2, MongoDB includes the component in its log messages to \fBsyslog\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -\&... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syslogFacility <string> -\fIDefault\fP: user -.sp +.PP +Starting in version 4.2, MongoDB includes the \fBcomponent\f1 in its log messages to \fBsyslog\f1\&. +.PP +.EX + ... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... +.EE +.RE +.PP +\fBmongod \-\-syslogFacility\f1 +.RS +.PP +\fIDefault\f1: user +.PP Specifies the facility level used when logging messages to syslog. The value you specify must be supported by your operating system\(aqs implementation of syslog. To use this option, you -must enable the \fI\%\-\-syslog\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logappend -Appends new entries to the end of the existing log file when the \fBmongod\fP -instance restarts. Without this option, \fI\%mongod\fP will back up the +must enable the \fB\-\-syslog\f1\f1 option. +.RE +.PP +\fBmongod \-\-logappend\f1 +.RS +.PP +Appends new entries to the end of the existing log file when the \fBmongod\f1\f1 +instance restarts. Without this option, \fBmongod\f1\f1 will back up the existing log and create a new file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logRotate <string> -\fIDefault\fP: rename -.sp -Determines the behavior for the \fBlogRotate\fP command. -Specify either \fBrename\fP or \fBreopen\fP: -.INDENT 7.0 -.IP \(bu 2 -\fBrename\fP renames the log file. -.IP \(bu 2 -\fBreopen\fP closes and reopens the log file following the typical -Linux/Unix log rotate behavior. Use \fBreopen\fP when using the +.RE +.PP +\fBmongod \-\-logRotate\f1 +.RS +.PP +\fIDefault\f1: rename +.PP +Determines the behavior for the \fBlogRotate\f1\f1 command when +rotating the server log and/or the audit log. Specify either +\fBrename\f1 or \fBreopen\f1: +.RS +.IP \(bu 2 +\fBrename\f1 renames the log file. +.IP \(bu 2 +\fBreopen\f1 closes and reopens the log file following the typical +Linux/Unix log rotate behavior. Use \fBreopen\f1 when using the Linux/Unix logrotate utility to avoid log loss. -.sp -If you specify \fBreopen\fP, you must also use \fI\%\-\-logappend\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-timeStampFormat <string> -\fIDefault\fP: iso8601\-local -.sp +.IP +If you specify \fBreopen\f1, you must also use \fB\-\-logappend\f1\f1\&. +.RE +.RE +.PP +\fBmongod \-\-timeStampFormat\f1 +.RS +.PP +\fIDefault\f1: iso8601\-local +.PP The time format for timestamps in log messages. Specify one of the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBiso8601\-utc\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBiso8601\-utc\f1 +.IP \(bu 4 Displays timestamps in Coordinated Universal Time (UTC) in the ISO\-8601 format. For example, for New York at the start of the -Epoch: \fB1970\-01\-01T00:00:00.000Z\fP -T} -_ -T{ -\fBiso8601\-local\fP -T} T{ +Epoch: \fB1970\-01\-01T00:00:00.000Z\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBiso8601\-local\f1 +.IP \(bu 4 Displays timestamps in local time in the ISO\-8601 format. For example, for New York at the start of the Epoch: -\fB1969\-12\-31T19:00:00.000\-05:00\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.4, \fI\%\-\-timeStampFormat\fP no longer supports \fBctime\fP\&. -An example of \fBctime\fP formatted date is: \fBWed Dec 31 -18:17:54.811\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-traceExceptions +\fB1969\-12\-31T19:00:00.000\-05:00\f1 +.RE +.RE +.PP +Starting in MongoDB 4.4, \fB\-\-timeStampFormat\f1\f1 no longer supports \fBctime\f1\&. +An example of \fBctime\f1 formatted date is: \fBWed Dec 31 +18:17:54.811\f1\&. +.RE +.PP +\fBmongod \-\-traceExceptions\f1 +.RS +.PP For internal diagnostic use only. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-pidfilepath <path> -Specifies a file location to store the process ID (PID) of the \fBmongod\fP -process. The user running the \fBmongod\fP or \fBmongos\fP -process must be able to write to this path. If the \fI\%\-\-pidfilepath\fP option is not +.RE +.PP +\fBmongod \-\-pidfilepath\f1 +.RS +.PP +Specifies a file location to store the process ID (PID) of the \fBmongod\f1\f1 +process. The user running the \fBmongod\f1 or \fBmongos\f1 +process must be able to write to this path. If the \fB\-\-pidfilepath\f1\f1 option is not specified, the process does not create a PID file. This option is generally -only useful in combination with the \fI\%\-\-fork\fP option. -.INDENT 7.0 -.INDENT 3.5 -.IP "Linux" -.sp +only useful in combination with the \fB\-\-fork\f1\f1 option. +.PP On Linux, PID file management is generally the responsibility of -your distro\(aqs init system: usually a service file in the \fB/etc/init.d\fP -directory, or a systemd unit file registered with \fBsystemctl\fP\&. Only -use the \fI\%\-\-pidfilepath\fP option if you are not using one of these init +your distro\(aqs init system: usually a service file in the \fB/etc/init.d\f1 +directory, or a systemd unit file registered with \fBsystemctl\f1\&. Only +use the \fB\-\-pidfilepath\f1\f1 option if you are not using one of these init systems. For more information, please see the respective -Installation Guide for your operating system. -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.IP "macOS" -.sp -On macOS, PID file management is generally handled by \fBbrew\fP\&. Only use -the \fI\%\-\-pidfilepath\fP option if you are not using \fBbrew\fP on your macOS system. +\fBInstallation Guide\f1 for your operating system. +.PP +On macOS, PID file management is generally handled by \fBbrew\f1\&. Only use +the \fB\-\-pidfilepath\f1\f1 option if you are not using \fBbrew\f1 on your macOS system. For more information, please see the respective -Installation Guide for your operating system. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyFile <file> +\fBInstallation Guide\f1 for your operating system. +.RE +.PP +\fBmongod \-\-keyFile\f1 +.RS +.PP Specifies the path to a key file that stores the shared secret that MongoDB instances use to authenticate to each other in a -sharded cluster or replica set\&. \fI\%\-\-keyFile\fP implies -\fI\%\-\-auth\fP\&. See inter\-process\-auth for more +\fBsharded cluster\f1 or \fBreplica set\f1\&. \fB\-\-keyFile\f1\f1 implies +\fB\-\-auth\f1\f1\&. See \fBInternal/Membership Authentication\f1 for more information. -.sp -Starting in MongoDB 4.2, keyfiles for internal membership -authentication use YAML format to allow for +.PP +Starting in MongoDB 4.2, \fBkeyfiles for internal membership +authentication\f1 use YAML format to allow for multiple keys in a keyfile. The YAML format accepts content of: -.INDENT 7.0 +.RS .IP \(bu 2 a single key string (same as in earlier versions), .IP \(bu 2 multiple key strings (each string must be enclosed in quotes), or .IP \(bu 2 sequence of key strings. -.UNINDENT -.sp +.RE +.PP The YAML format is compatible with the existing single\-key keyfiles that use the text file format. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-setParameter <options> +.RE +.PP +\fBmongod \-\-setParameter\f1 +.RS +.PP Specifies one of the MongoDB parameters described in -/reference/parameters\&. You can specify multiple \fBsetParameter\fP +\fBMongoDB Server Parameters\f1\&. You can specify multiple \fBsetParameter\f1 fields. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nounixsocket -Disables listening on the UNIX domain socket. \fI\%\-\-nounixsocket\fP applies only +.RE +.PP +\fBmongod \-\-nounixsocket\f1 +.RS +.PP +Disables listening on the UNIX domain socket. \fB\-\-nounixsocket\f1\f1 applies only to Unix\-based systems. -.sp -The \fBmongod\fP process +.PP +The \fBmongod\f1\f1 process always listens on the UNIX socket unless one of the following is true: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-nounixsocket\fP is set +\fB\-\-nounixsocket\f1\f1 is set .IP \(bu 2 -\fBnet.bindIp\fP is not set +\fBnet.bindIp\f1\f1 is not set .IP \(bu 2 -\fBnet.bindIp\fP does not specify \fBlocalhost\fP or its associated IP address -.UNINDENT -.sp -\fBmongod\fP installed from official \&.deb and \&.rpm packages -have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by +\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address +.RE +.PP +\fBmongod\f1\f1 installed from official \fB\&.deb\f1 and \fB\&.rpm\f1 packages +have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by default. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-unixSocketPrefix <path> -\fIDefault\fP: /tmp -.sp -The path for the UNIX socket. \fI\%\-\-unixSocketPrefix\fP applies only +.RE +.PP +\fBmongod \-\-unixSocketPrefix\f1 +.RS +.PP +\fIDefault\f1: /tmp +.PP +The path for the UNIX socket. \fB\-\-unixSocketPrefix\f1\f1 applies only to Unix\-based systems. -.sp +.PP If this option has no value, the -\fBmongod\fP process creates a socket with \fB/tmp\fP as a prefix. MongoDB +\fBmongod\f1\f1 process creates a socket with \fB/tmp\f1 as a prefix. MongoDB creates and listens on a UNIX socket unless one of the following is true: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBnet.unixDomainSocket.enabled\fP is \fBfalse\fP +\fBnet.unixDomainSocket.enabled\f1\f1 is \fBfalse\f1 .IP \(bu 2 -\fI\%\-\-nounixsocket\fP is set +\fB\-\-nounixsocket\f1\f1 is set .IP \(bu 2 -\fBnet.bindIp\fP is not set +\fBnet.bindIp\f1\f1 is not set .IP \(bu 2 -\fBnet.bindIp\fP does not specify \fBlocalhost\fP or its associated IP address -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-filePermissions <path> -\fIDefault\fP: \fB0700\fP -.sp +\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address +.RE +.RE +.PP +\fBmongod \-\-filePermissions\f1 +.RS +.PP +\fIDefault\f1: \fB0700\f1 +.PP Sets the permission for the UNIX domain socket file. -.sp -\fI\%\-\-filePermissions\fP applies only to Unix\-based systems. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fork -Enables a daemon mode that runs the \fBmongod\fP process in the -background. By default \fBmongod\fP does not run as a daemon: -typically you will run \fBmongod\fP as a daemon, either by using -\fI\%\-\-fork\fP or by using a controlling process that handles the -daemonization process (e.g. as with \fBupstart\fP and \fBsystemd\fP). -.sp -The \fI\%\-\-fork\fP option is not supported on Windows. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auth +.PP +\fB\-\-filePermissions\f1\f1 applies only to Unix\-based systems. +.RE +.PP +\fBmongod \-\-fork\f1 +.RS +.PP +Enables a \fBdaemon\f1 mode that runs the \fBmongod\f1\f1 process in the +background. By default \fBmongod\f1\f1 does not run as a daemon: +typically you will run \fBmongod\f1\f1 as a daemon, either by using +\fB\-\-fork\f1\f1 or by using a controlling process that handles the +daemonization process (e.g. as with \fBupstart\f1 and \fBsystemd\f1). +.PP +Using the \fB\-\-fork\f1\f1 option requires that you configure log +output for the \fBmongod\f1\f1 with one of the following: +.RS +.IP \(bu 2 +\fB\-\-logpath\f1\f1 +.IP \(bu 2 +\fB\-\-syslog\f1\f1 +.RE +.PP +The \fB\-\-fork\f1\f1 option is not supported on Windows. +.RE +.PP +\fBmongod \-\-auth\f1 +.RS +.PP Enables authorization to control user\(aqs access to database resources and operations. When authorization is enabled, MongoDB requires all clients to authenticate themselves first in order to determine the access for the client. -.sp -Configure users via the mongo shell\&. If no users exist, the localhost interface +.PP +Configure users via the \fBmongo shell\f1\&. If no users exist, the localhost interface will continue to have access to the database until you create the first user. -.sp -See Security +.PP +See \fBSecurity\f1 for more information. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noauth +.RE +.PP +\fBmongod \-\-noauth\f1 +.RS +.PP Disables authentication. Currently the default. Exists for future compatibility and clarity. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-transitionToAuth -New in version 3.4: Allows the \fBmongod\fP to accept and create authenticated and -non\-authenticated connections to and from other \fI\%mongod\fP -and \fBmongos\fP instances in the deployment. Used for +.RE +.PP +\fBmongod \-\-transitionToAuth\f1 +.RS +.PP +Allows the \fBmongod\f1\f1 to accept and create authenticated and +non\-authenticated connections to and from other \fBmongod\f1\f1 +and \fBmongos\f1\f1 instances in the deployment. Used for performing rolling transition of replica sets or sharded clusters -from a no\-auth configuration to internal authentication\&. Requires specifying a internal -authentication mechanism such as -\fI\%\-\-keyFile\fP\&. - -.sp -For example, if using keyfiles for -internal authentication, the \fBmongod\fP creates -an authenticated connection with any \fI\%mongod\fP or \fBmongos\fP +from a no\-auth configuration to \fBinternal authentication\f1\&. Requires specifying a \fBinternal +authentication\f1 mechanism such as +\fB\-\-keyFile\f1\f1\&. +.PP +For example, if using \fBkeyfiles\f1 for +\fBinternal authentication\f1, the \fBmongod\f1\f1 creates +an authenticated connection with any \fBmongod\f1\f1 or \fBmongos\f1\f1 in the deployment using a matching keyfile. If the security mechanisms do -not match, the \fBmongod\fP utilizes a non\-authenticated connection instead. -.sp -A \fBmongod\fP running with \fI\%\-\-transitionToAuth\fP does not enforce user access -controls\&. Users may connect to your deployment without any +not match, the \fBmongod\f1\f1 utilizes a non\-authenticated connection instead. +.PP +A \fBmongod\f1\f1 running with \fB\-\-transitionToAuth\f1\f1 does not enforce \fBuser access +controls\f1\&. Users may connect to your deployment without any access control checks and perform read, write, and administrative operations. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -A \fBmongod\fP running with internal authentication and \fIwithout\fP \fI\%\-\-transitionToAuth\fP requires clients to connect -using user access controls\&. Update clients to -connect to the \fBmongod\fP using the appropriate user -prior to restarting \fBmongod\fP without \fI\%\-\-transitionToAuth\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cpu -Forces the \fBmongod\fP process to report the percentage of CPU time in +.PP +A \fBmongod\f1\f1 running with \fBinternal authentication\f1 and \fIwithout\f1 \fB\-\-transitionToAuth\f1\f1 requires clients to connect +using \fBuser access controls\f1\&. Update clients to +connect to the \fBmongod\f1\f1 using the appropriate \fBuser\f1 +prior to restarting \fBmongod\f1\f1 without \fB\-\-transitionToAuth\f1\f1\&. +.RE +.PP +\fBmongod \-\-cpu\f1 +.RS +.PP +Forces the \fBmongod\f1\f1 process to report the percentage of CPU time in write lock, every four seconds. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sysinfo +.RE +.PP +\fBmongod \-\-sysinfo\f1 +.RS +.PP Returns diagnostic system information and then exits. The information provides the page size, the number of physical pages, and the number of available physical pages. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noscripting +.RE +.PP +\fBmongod \-\-noscripting\f1 +.RS +.PP Disables the scripting engine. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-notablescan -Forbids operations that require a collection scan. See \fBnotablescan\fP for additional information. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shutdown -The \fI\%\-\-shutdown\fP option cleanly and safely terminates the \fBmongod\fP -process. When invoking \fBmongod\fP with this option you must set the -\fI\%\-\-dbpath\fP option either directly or by way of the -configuration file and the -\fI\%\-\-config\fP option. -.sp -The \fI\%\-\-shutdown\fP option is available only on Linux systems. -.sp -For additional ways to shut down, see also terminate\-mongod\-processes\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-redactClientLogData -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A \fBmongod\fP running with \fI\%\-\-redactClientLogData\fP redacts any message accompanying a given -log event before logging. This prevents the \fBmongod\fP from writing +.RE +.PP +\fBmongod \-\-notablescan\f1 +.RS +.PP +Forbids operations that require a collection scan. See \fBnotablescan\f1\f1 for additional information. +.RE +.PP +\fBmongod \-\-shutdown\f1 +.RS +.PP +The \fB\-\-shutdown\f1\f1 option cleanly and safely terminates the \fBmongod\f1\f1 +process. When invoking \fBmongod\f1\f1 with this option you must set the +\fB\-\-dbpath\f1\f1 option either directly or by way of the +\fBconfiguration file\f1 and the +\fB\-\-config\f1\f1 option. +.PP +The \fB\-\-shutdown\f1\f1 option is available only on Linux systems. +.PP +For additional ways to shut down, see also \fBStop mongod\f1 Processes\f1\&. +.RE +.PP +\fBmongod \-\-redactClientLogData\f1 +.RS +.PP +A \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given +log event before logging. This prevents the \fBmongod\f1\f1 from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. -.sp -Use \fI\%\-\-redactClientLogData\fP in conjunction with -/core/security\-encryption\-at\-rest and -/core/security\-transport\-encryption to assist compliance with +.PP +Use \fB\-\-redactClientLogData\f1\f1 in conjunction with +\fBEncryption at Rest\f1 and +\fBTLS/SSL (Transport Encryption)\f1 to assist compliance with regulatory requirements. -.sp +.PP For example, a MongoDB deployment might store Personally Identifiable -Information (PII) in one or more collections. The \fBmongod\fP logs events +Information (PII) in one or more collections. The \fBmongod\f1\f1 logs events such as those related to CRUD operations, sharding metadata, etc. It is -possible that the \fBmongod\fP may expose PII as a part of these logging -operations. A \fBmongod\fP running with \fI\%\-\-redactClientLogData\fP removes any message +possible that the \fBmongod\f1\f1 may expose PII as a part of these logging +operations. A \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 removes any message accompanying these events before being output to the log, effectively removing the PII. -.sp -Diagnostics on a \fBmongod\fP running with \fI\%\-\-redactClientLogData\fP may be more difficult +.PP +Diagnostics on a \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 may be more difficult due to the lack of data related to a log event. See the -process logging manual page for an -example of the effect of \fI\%\-\-redactClientLogData\fP on log output. -.sp -On a running \fBmongod\fP, use \fBsetParameter\fP with the -\fBredactClientLogData\fP parameter to configure this setting. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-networkMessageCompressors <string> -\fIDefault\fP: snappy,zstd,zlib -.sp -New in version 3.4. - -.sp +\fBprocess logging\f1 manual page for an +example of the effect of \fB\-\-redactClientLogData\f1\f1 on log output. +.PP +On a running \fBmongod\f1\f1, use \fBsetParameter\f1\f1 with the +\fBredactClientLogData\f1\f1 parameter to configure this setting. +.RE +.PP +\fBmongod \-\-networkMessageCompressors\f1 +.RS +.PP +\fIDefault\f1: snappy,zstd,zlib +.PP Specifies the default compressor(s) to use for -communication between this \fBmongod\fP instance and: -.INDENT 7.0 +communication between this \fBmongod\f1\f1 instance and: +.RS .IP \(bu 2 other members of the deployment if the instance is part of a replica set or a sharded cluster .IP \(bu 2 -a \fBmongo\fP shell +\fBmongosh\f1\f1 .IP \(bu 2 -drivers that support the \fBOP_COMPRESSED\fP message format. -.UNINDENT -.sp +drivers that support the \fBOP_COMPRESSED\f1 message format. +.RE +.PP MongoDB supports the following compressors: -.INDENT 7.0 +.RS .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib (Available starting in MongoDB 3.6) +\fBzlib\f1 (Available starting in MongoDB 3.6) .IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.sp -\fBIn versions 3.6 and 4.0\fP, \fI\%mongod\fP and -\fBmongos\fP enable network compression by default with -\fBsnappy\fP as the compressor. -.sp -\fBStarting in version 4.2\fP, \fI\%mongod\fP and -\fBmongos\fP instances default to both \fBsnappy,zstd,zlib\fP +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.PP +\fBIn versions 3.6 and 4.0\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1 enable network compression by default with +\fBsnappy\f1 as the compressor. +.PP +\fBStarting in version 4.2\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1 instances default to both \fBsnappy,zstd,zlib\f1 compressors, in that order. -.sp -To disable network compression, set the value to \fBdisabled\fP\&. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP +To disable network compression, set the value to \fBdisabled\f1\&. +.PP Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed. -.UNINDENT -.UNINDENT -.sp +.PP If you specify multiple compressors, then the order in which you list the compressors matter as well as the communication initiator. For -example, if a \fBmongo\fP shell specifies the following network -compressors \fBzlib,snappy\fP and the \fI\%mongod\fP specifies -\fBsnappy,zlib\fP, messages between \fBmongo\fP shell and -\fI\%mongod\fP uses \fBzlib\fP\&. -.sp +example, if \fBmongosh\f1\f1 specifies the following network +compressors \fBzlib,snappy\f1 and the \fBmongod\f1\f1 specifies +\fBsnappy,zlib\f1, messages between \fBmongosh\f1\f1 and +\fBmongod\f1\f1 uses \fBzlib\f1\&. +.PP If the parties do not share at least one common compressor, messages -between the parties are uncompressed. For example, if a -\fBmongo\fP shell specifies the network compressor -\fBzlib\fP and \fI\%mongod\fP specifies \fBsnappy\fP, messages -between \fBmongo\fP shell and \fI\%mongod\fP are not compressed. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-timeZoneInfo <path> +between the parties are uncompressed. For example, if +\fBmongosh\f1\f1 specifies the network compressor +\fBzlib\f1 and \fBmongod\f1\f1 specifies \fBsnappy\f1, messages +between \fBmongosh\f1\f1 and \fBmongod\f1\f1 are not +compressed. +.RE +.PP +\fBmongod \-\-timeZoneInfo\f1 +.RS +.PP The full path from which to load the time zone database. If this option is not provided, then MongoDB will use its built\-in time zone database. -.sp -The configuration file included with Linux and macOS packages sets the time -zone database path to \fB/usr/share/zoneinfo\fP by default. -.sp -The built\-in time zone database is a copy of the \fI\%Olson/IANA time zone -database\fP\&. It is updated along with MongoDB -releases, but the release cycle of the time zone database differs from the -release cycle of MongoDB. A copy of the most recent release of the time zone -database can be downloaded from -\fI\%https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -wget https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip -unzip timezonedb\-latest.zip -mongod \-\-timeZoneInfo timezonedb\-2017b/ -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBprocessManagement.timeZoneInfo\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-serviceExecutor <string> -\fIDefault\fP: synchronous -.sp -New in version 3.6. - -.sp -Determines the threading and execution model \fBmongod\fP uses to -execute client requests. The \fB\-\-serviceExecutor\fP option accepts one -of the following values: -.TS -center; -|l|l|. -_ -T{ -Value -T} T{ -Description -T} -_ -T{ -\fBsynchronous\fP -T} T{ -The \fBmongod\fP uses synchronous networking and manages its -networking thread pool on a per connection basis. Previous -versions of MongoDB managed threads in this way. -T} -_ -T{ -\fBadaptive\fP -T} T{ -The \fBmongod\fP uses the new experimental asynchronous -networking mode with an adaptive thread pool which manages -threads on a per request basis. This mode should have more -consistent performance and use less resources when there are -more inactive connections than database requests. -T} -_ -.TE -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-outputConfig -New in version 4.2. - -.sp -Outputs the \fBmongod\fP instance\(aqs configuration options, formatted -in YAML, to \fBstdout\fP and exits the \fBmongod\fP instance. For -configuration options that uses externally\-sourced\-values, -\fI\%\-\-outputConfig\fP returns the resolved value for those options. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP +The configuration file included with Linux and macOS packages sets the +time zone database path to \fB/usr/share/zoneinfo\f1 by default. +.PP +The built\-in time zone database is a copy of the Olson/IANA time zone +database (https://www.iana.org/time\-zones)\&. It is updated along with +MongoDB releases, but the time zone database release cycle +differs from the MongoDB release cycle. The most recent release of +the time zone database is available on our download site (https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip)\&. +.PP +.EX + wget https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip + unzip timezonedb\-latest.zip + mongod \-\-timeZoneInfo timezonedb\-2017b/ +.EE +.PP +MongoDB uses the third party timelib (https://github.com/derickr/timelib) library to provide accurate +conversions between timezones. Due to a recent update, \fBtimelib\f1 +could create inaccurate time zone conversions in older versions of +MongoDB. +.PP +To explicitly link to the time zone database in versions of MongoDB +prior to 5.0, 4.4.7, 4.2.14, and 4.0.25, download the time zone +database (https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip)\&. +and use the \fBtimeZoneInfo\f1\f1 parameter. +.PP +\fBprocessManagement.timeZoneInfo\f1\f1\&. +.RE +.PP +\fBmongod \-\-outputConfig\f1 +.RS +.PP +Outputs the \fBmongod\f1\f1 instance\(aqs configuration options, formatted +in YAML, to \fBstdout\f1 and exits the \fBmongod\f1\f1 instance. For +configuration options that uses \fBExternally Sourced Configuration File Values\f1, +\fB\-\-outputConfig\f1\f1 returns the resolved value for those options. +.PP This may include any configured passwords or secrets previously obfuscated through the external source. -.UNINDENT -.UNINDENT -.sp +.PP For usage examples, see: -.INDENT 7.0 -.IP \(bu 2 -expansion\-directive\-output -.IP \(bu 2 -/tutorial/convert\-command\-line\-options\-to\-yaml -.UNINDENT -.UNINDENT -.SS Free Monitoring -.sp -New in version 4.0. - -.INDENT 0.0 -.TP -.B \-\-enableFreeMonitoring <runtime|on|off> -New in version 4.0: Available for MongoDB Community Edition. - -.sp -Enables or disables free MongoDB Cloud monitoring\&. \fI\%\-\-enableFreeMonitoring\fP accepts the following +.RS +.IP \(bu 2 +\fBOutput the Configuration File with Resolved Expansion Directive Values\f1 +.IP \(bu 2 +\fBConvert Command\-Line Options to YAML\f1 +.RE +.RE +.SS FREE MONITORING +.PP +\fBmongod \-\-enableFreeMonitoring\f1 +.RS +.PP +Available for MongoDB Community Edition. +.PP +Enables or disables \fBfree MongoDB Cloud monitoring\f1\&. \fB\-\-enableFreeMonitoring\f1\f1 accepts the following values: -.TS -center; -|l|l|. -_ -T{ -\fBruntime\fP -T} T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 +Value +.IP \(bu 4 +Description +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBruntime\f1 +.IP \(bu 4 Default. You can enable or disable free monitoring during runtime. -.sp +.IP To enable or disable free monitoring during runtime, see -\fBdb.enableFreeMonitoring()\fP and -\fBdb.disableFreeMonitoring()\fP\&. -.sp +\fBdb.enableFreeMonitoring()\f1\f1 and +\fBdb.disableFreeMonitoring()\f1\f1\&. +.IP To enable or disable free monitoring during runtime when running with access control, users must have required -privileges. See \fBdb.enableFreeMonitoring()\fP and -\fBdb.disableFreeMonitoring()\fP for details. -T} -_ -T{ -\fBon\fP -T} T{ +privileges. See \fBdb.enableFreeMonitoring()\f1\f1 and +\fBdb.disableFreeMonitoring()\f1\f1 for details. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBon\f1 +.IP \(bu 4 Enables free monitoring at startup; i.e. registers for free monitoring. When enabled at startup, you cannot disable free monitoring during runtime. -T} -_ -T{ -\fBoff\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBoff\f1 +.IP \(bu 4 Disables free monitoring at startup, regardless of whether you have previously registered for free monitoring. When disabled at startup, you cannot enable free monitoring during runtime. -T} -_ -.TE -.sp +.RE +.RE +.PP Once enabled, the free monitoring state remains enabled until explicitly disabled. That is, you do not need to re\-enable each time you start the server. -.sp +.PP For the corresponding configuration file setting, see -\fBcloud.monitoring.free.state\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-freeMonitoringTag <string> -New in version 4.0: Available for MongoDB Community Edition. - -.sp +\fBcloud.monitoring.free.state\f1\f1\&. +.RE +.PP +\fBmongod \-\-freeMonitoringTag\f1 +.RS +.PP +Available for MongoDB Community Edition. +.PP Optional tag to describe environment context. The tag can be sent as -part of the free MongoDB Cloud monitoring registration at start up. -.sp +part of the \fBfree MongoDB Cloud monitoring\f1 registration at start up. +.PP For the corresponding configuration file setting, see -\fBcloud.monitoring.free.tags\fP\&. -.UNINDENT -.SS LDAP Authentication or Authorization Options -.INDENT 0.0 -.TP -.B \-\-ldapServers <host1>:<port>,<host2>:<port>,...,<hostN>:<port> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The LDAP server against which the \fBmongod\fP authenticates users or +\fBcloud.monitoring.free.tags\f1\f1\&. +.RE +.SS LDAP AUTHENTICATION OR AUTHORIZATION OPTIONS +.PP +\fBmongod \-\-ldapServers\f1 +.RS +.PP +The LDAP server against which the \fBmongod\f1\f1 authenticates users or determines what actions a user is authorized to perform on a given database. If the LDAP server specified has any replicated instances, you may specify the host and port of each replicated server in a comma\-delimited list. -.sp +.PP If your LDAP infrastructure partitions the LDAP directory over multiple LDAP -servers, specify \fIone\fP LDAP server or any of its replicated instances to -\fI\%\-\-ldapServers\fP\&. MongoDB supports following LDAP referrals as defined in \fI\%RFC 4511 -4.1.10\fP\&. Do not use \fI\%\-\-ldapServers\fP +servers, specify \fIone\f1 LDAP server or any of its replicated instances to +\fB\-\-ldapServers\f1\f1\&. MongoDB supports following LDAP referrals as defined in RFC 4511 +4.1.10 (https://www.rfc\-editor.org/rfc/rfc4511.txt)\&. Do not use \fB\-\-ldapServers\f1\f1 for listing every LDAP server in your infrastructure. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.sp -If unset, \fBmongod\fP cannot use LDAP authentication or authorization\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapValidateLDAPServerConfig <boolean> -\fIAvailable in MongoDB Enterprise\fP -.sp -A flag that determines if the \fI\%mongod\fP instance checks -the availability of the \fI\%LDAP server(s)\fP as part of its startup: -.INDENT 7.0 -.IP \(bu 2 -If \fBtrue\fP, the \fI\%mongod\fP instance performs the +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +If unset, \fBmongod\f1\f1 cannot use \fBLDAP authentication or authorization\f1\&. +.RE +.PP +\fBmongod \-\-ldapValidateLDAPServerConfig\f1 +.RS +.PP +\fIAvailable in MongoDB Enterprise\f1 +.PP +A flag that determines if the \fBmongod\f1\f1 instance checks +the availability of the \fBLDAP server(s)\f1\f1 as part of its startup: +.RS +.IP \(bu 2 +If \fBtrue\f1, the \fBmongod\f1\f1 instance performs the availability check and only continues to start up if the LDAP server is available. .IP \(bu 2 -If \fBfalse\fP, the \fI\%mongod\fP instance skips the +If \fBfalse\f1, the \fBmongod\f1\f1 instance skips the availability check; i.e. the instance starts up even if the LDAP server is unavailable. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryUser <string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The identity with which \fBmongod\fP binds as, when connecting to or +.RE +.RE +.PP +\fBmongod \-\-ldapQueryUser\f1 +.RS +.PP +The identity with which \fBmongod\f1\f1 binds as, when connecting to or performing queries on an LDAP server. -.sp +.PP Only required if any of the following are true: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -You must use \fI\%\-\-ldapQueryUser\fP with \fI\%\-\-ldapQueryPassword\fP\&. -.sp -If unset, \fBmongod\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryPassword <string> -New in version 3.4: Available in MongoDB Enterprise only. -.sp +.RE +.PP +You must use \fB\-\-ldapQueryUser\f1\f1 with \fB\-\-ldapQueryPassword\f1\f1\&. +.PP +If unset, \fBmongod\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongod \-\-ldapQueryPassword\f1 +.RS +.PP The password used to bind to an LDAP server when using -\fI\%\-\-ldapQueryUser\fP\&. You must use \fI\%\-\-ldapQueryPassword\fP with -\fI\%\-\-ldapQueryUser\fP\&. - -.sp -If unset, \fBmongod\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindWithOSDefaults <bool> -\fIDefault\fP: false -.sp -New in version 3.4: Available in MongoDB Enterprise for the Windows platform only. - -.sp -Allows \fBmongod\fP to authenticate, or bind, using your Windows login +\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with +\fB\-\-ldapQueryUser\f1\f1\&. +.PP +If unset, \fBmongod\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Starting in MongoDB 4.4, the \fBldapQueryPassword\f1 +\fBsetParameter\f1\f1 command accepts either a string or +an array of strings. If set to an array, each password is tried +until one succeeds. This can be used to perform a rollover of the +LDAP account password without downtime for MongoDB. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongod \-\-ldapBindWithOSDefaults\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Available in MongoDB Enterprise for the Windows platform only. +.PP +Allows \fBmongod\f1\f1 to authenticate, or bind, using your Windows login credentials when connecting to the LDAP server. -.sp +.PP Only required if: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -Use \fI\%\-\-ldapBindWithOSDefaults\fP to replace \fI\%\-\-ldapQueryUser\fP and -\fI\%\-\-ldapQueryPassword\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindMethod <string> -\fIDefault\fP: simple -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The method \fBmongod\fP uses to authenticate to an LDAP server. -Use with \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP to +.RE +.PP +Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 and +\fB\-\-ldapQueryPassword\f1\f1\&. +.RE +.PP +\fBmongod \-\-ldapBindMethod\f1 +.RS +.PP +\fIDefault\f1: simple +.PP +The method \fBmongod\f1\f1 uses to authenticate to an LDAP server. +Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to connect to the LDAP server. -.sp -\fI\%\-\-ldapBindMethod\fP supports the following values: -.INDENT 7.0 -.IP \(bu 2 -\fBsimple\fP \- \fBmongod\fP uses simple authentication. -.IP \(bu 2 -\fBsasl\fP \- \fBmongod\fP uses SASL protocol for authentication -.UNINDENT -.sp -If you specify \fBsasl\fP, you can configure the available SASL mechanisms -using \fI\%\-\-ldapBindSaslMechanisms\fP\&. \fBmongod\fP defaults to -using \fBDIGEST\-MD5\fP mechanism. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindSaslMechanisms <string> -\fIDefault\fP: DIGEST\-MD5 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A comma\-separated list of SASL mechanisms \fBmongod\fP can -use when authenticating to the LDAP server. The \fBmongod\fP and the -LDAP server must agree on at least one mechanism. The \fBmongod\fP +.PP +\fB\-\-ldapBindMethod\f1\f1 supports the following values: +.RS +.IP \(bu 2 +\fBsimple\f1 \- \fBmongod\f1\f1 uses simple authentication. +.IP \(bu 2 +\fBsasl\f1 \- \fBmongod\f1\f1 uses SASL protocol for authentication +.RE +.PP +If you specify \fBsasl\f1, you can configure the available SASL mechanisms +using \fB\-\-ldapBindSaslMechanisms\f1\f1\&. \fBmongod\f1\f1 defaults to +using \fBDIGEST\-MD5\f1 mechanism. +.RE +.PP +\fBmongod \-\-ldapBindSaslMechanisms\f1 +.RS +.PP +\fIDefault\f1: DIGEST\-MD5 +.PP +A comma\-separated list of SASL mechanisms \fBmongod\f1\f1 can +use when authenticating to the LDAP server. The \fBmongod\f1\f1 and the +LDAP server must agree on at least one mechanism. The \fBmongod\f1\f1 dynamically loads any SASL mechanism libraries installed on the host machine at runtime. -.sp +.PP Install and configure the appropriate libraries for the selected -SASL mechanism(s) on both the \fBmongod\fP host and the remote +SASL mechanism(s) on both the \fBmongod\f1\f1 host and the remote LDAP server host. Your operating system may include certain SASL libraries by default. Defer to the documentation associated with each SASL mechanism for guidance on installation and configuration. -.sp -If using the \fBGSSAPI\fP SASL mechanism for use with -security\-kerberos, verify the following for the -\fBmongod\fP host machine: -.INDENT 7.0 -.TP -.B \fBLinux\fP -.INDENT 7.0 -.IP \(bu 2 -The \fBKRB5_CLIENT_KTNAME\fP environment -variable resolves to the name of the client keytab\-files +.PP +If using the \fBGSSAPI\f1 SASL mechanism for use with +\fBKerberos Authentication\f1, verify the following for the +\fBmongod\f1\f1 host machine: +.PP +\fBLinux\f1\f1 +.RS +.RS +.IP \(bu 2 +The \fBKRB5_CLIENT_KTNAME\f1 environment +variable resolves to the name of the client \fBLinux Keytab Files\f1 for the host machine. For more on Kerberos environment variables, please defer to the -\fI\%Kerberos documentation\fP\&. +Kerberos documentation (https://web.mit.edu/kerberos/krb5\-1.13/doc/admin/env_variables.html)\&. .IP \(bu 2 The client keytab includes a -kerberos\-user\-principal for the \fBmongod\fP to use when +\fBUser Principal\f1 for the \fBmongod\f1\f1 to use when connecting to the LDAP server and execute LDAP queries. -.UNINDENT -.TP -.B \fBWindows\fP +.RE +.RE +.PP +\fBWindows\f1\f1 +.RS +.PP If connecting to an Active Directory server, the Windows Kerberos configuration automatically generates a -\fI\%Ticket\-Granting\-Ticket\fP -when the user logs onto the system. Set \fI\%\-\-ldapBindWithOSDefaults\fP to -\fBtrue\fP to allow \fBmongod\fP to use the generated credentials when +Ticket\-Granting\-Ticket (https://msdn.microsoft.com/en\-us/library/windows/desktop/aa380510(v=vs.85).aspx) +when the user logs onto the system. Set \fB\-\-ldapBindWithOSDefaults\f1\f1 to +\fBtrue\f1 to allow \fBmongod\f1\f1 to use the generated credentials when connecting to the Active Directory server and execute queries. -.UNINDENT -.sp -Set \fI\%\-\-ldapBindMethod\fP to \fBsasl\fP to use this option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.PP +Set \fB\-\-ldapBindMethod\f1\f1 to \fBsasl\f1 to use this option. +.PP For a complete list of SASL mechanisms see the -\fI\%IANA listing\fP\&. +IANA listing (http://www.iana.org/assignments/sasl\-mechanisms/sasl\-mechanisms.xhtml)\&. Defer to the documentation for your LDAP or Active Directory service for identifying the SASL mechanisms compatible with the service. -.sp +.PP MongoDB is not a source of SASL mechanism libraries, nor is the MongoDB documentation a definitive source for installing or configuring any given SASL mechanism. For documentation and support, defer to the SASL mechanism library vendor or owner. -.sp +.PP For more information on SASL, defer to the following resources: -.INDENT 0.0 -.IP \(bu 2 -For Linux, please see the \fI\%Cyrus SASL documentation\fP\&. -.IP \(bu 2 -For Windows, please see the \fI\%Windows SASL documentation\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTransportSecurity <string> -\fIDefault\fP: tls -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -By default, \fBmongod\fP creates a TLS/SSL secured connection to the LDAP +.RS +.IP \(bu 2 +For Linux, please see the Cyrus SASL documentation (https://www.cyrusimap.org/sasl/)\&. +.IP \(bu 2 +For Windows, please see the Windows SASL documentation (https://msdn.microsoft.com/en\-us/library/cc223500.aspx)\&. +.RE +.RE +.PP +\fBmongod \-\-ldapTransportSecurity\f1 +.RS +.PP +\fIDefault\f1: tls +.PP +By default, \fBmongod\f1\f1 creates a TLS/SSL secured connection to the LDAP server. -.sp +.PP For Linux deployments, you must configure the appropriate TLS Options in -\fB/etc/openldap/ldap.conf\fP file. Your operating system\(aqs package manager +\fB/etc/openldap/ldap.conf\f1 file. Your operating system\(aqs package manager creates this file as part of the MongoDB Enterprise installation, via the -\fBlibldap\fP dependency. See the documentation for \fBTLS Options\fP in the -\fI\%ldap.conf OpenLDAP documentation\fP +\fBlibldap\f1 dependency. See the documentation for \fBTLS Options\f1 in the +ldap.conf OpenLDAP documentation (http://www.openldap.org/software/man.cgi?query=ldap.conf&manpath=OpenLDAP+2.4\-Release) for more complete instructions. -.sp +.PP For Windows deployment, you must add the LDAP server CA certificates to the Windows certificate management tool. The exact name and functionality of the tool may vary depending on operating system version. Please see the documentation for your version of Windows for more information on certificate management. -.sp -Set \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP to disable TLS/SSL between \fBmongod\fP and the LDAP +.PP +Set \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 to disable TLS/SSL between \fBmongod\f1\f1 and the LDAP server. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -Setting \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP transmits plaintext information and possibly -credentials between \fBmongod\fP and the LDAP server. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTimeoutMS <long> -\fIDefault\fP: 10000 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The amount of time in milliseconds \fBmongod\fP should wait for an LDAP server +.PP +Setting \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 transmits plaintext information and possibly +credentials between \fBmongod\f1\f1 and the LDAP server. +.RE +.PP +\fBmongod \-\-ldapTimeoutMS\f1 +.RS +.PP +\fIDefault\f1: 10000 +.PP +The amount of time in milliseconds \fBmongod\f1\f1 should wait for an LDAP server to respond to a request. -.sp -Increasing the value of \fI\%\-\-ldapTimeoutMS\fP may prevent connection failure between the +.PP +Increasing the value of \fB\-\-ldapTimeoutMS\f1\f1 may prevent connection failure between the MongoDB server and the LDAP server, if the source of the failure is a -connection timeout. Decreasing the value of \fI\%\-\-ldapTimeoutMS\fP reduces the time +connection timeout. Decreasing the value of \fB\-\-ldapTimeoutMS\f1\f1 reduces the time MongoDB waits for a response from the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapUserToDNMapping <string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -Maps the username provided to \fBmongod\fP for authentication to a LDAP -Distinguished Name (DN). You may need to use \fI\%\-\-ldapUserToDNMapping\fP to transform a +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.RE +.PP +\fBmongod \-\-ldapUserToDNMapping\f1 +.RS +.PP +Maps the username provided to \fBmongod\f1\f1 for authentication to a LDAP +Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a username into an LDAP DN in the following scenarios: -.INDENT 7.0 +.RS .IP \(bu 2 Performing LDAP authentication with simple LDAP binding, where users authenticate to MongoDB with usernames that are not full LDAP DNs. .IP \(bu 2 -Using an \fI\%LDAP authorization query template\fP that requires a DN. +Using an \fBLDAP authorization query template\f1\f1 that requires a DN. .IP \(bu 2 Transforming the usernames of clients authenticating to Mongo DB using different authentication mechanisms (e.g. x.509, kerberos) to a full LDAP DN for authorization. -.UNINDENT -.sp -\fI\%\-\-ldapUserToDNMapping\fP expects a quote\-enclosed JSON\-string representing an ordered array -of documents. Each document contains a regular expression \fBmatch\fP and -either a \fBsubstitution\fP or \fBldapQuery\fP template used for transforming the +.RE +.PP +\fB\-\-ldapUserToDNMapping\f1\f1 expects a quote\-enclosed JSON\-string representing an ordered array +of documents. Each document contains a regular expression \fBmatch\f1 and +either a \fBsubstitution\f1 or \fBldapQuery\f1 template used for transforming the incoming username. -.sp +.PP Each document in the array has the following form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - match: "<regex>" - substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.TS -center; -|l|l|l|. -_ -T{ +.PP +.EX + { + match: "<regex>" + substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" + } +.EE +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Field -T} T{ +.IP \(bu 4 Description -T} T{ +.IP \(bu 4 Example -T} -_ -T{ -\fBmatch\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBmatch\f1 +.IP \(bu 4 An ECMAScript\-formatted regular expression (regex) to match against a provided username. Each parenthesis\-enclosed section represents a -regex capture group used by \fBsubstitution\fP or \fBldapQuery\fP\&. -T} T{ -\fB"(.+)ENGINEERING"\fP -\fB"(.+)DBA"\fP -T} -_ -T{ -\fBsubstitution\fP -T} T{ +regex capture group used by \fBsubstitution\f1 or \fBldapQuery\f1\&. +.IP \(bu 4 +\fB"(.+)ENGINEERING"\f1 +\fB"(.+)DBA"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubstitution\f1 +.IP \(bu 4 An LDAP distinguished name (DN) formatting template that converts the -authentication name matched by the \fBmatch\fP regex into a LDAP DN. +authentication name matched by the \fBmatch\f1 regex into a LDAP DN. Each curly bracket\-enclosed numeric value is replaced by the -corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP regex. -.sp -The result of the substitution must be an \fI\%RFC4514\fP escaped string. -T} T{ +corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 regex. +.IP +The result of the substitution must be an RFC4514 (https://www.ietf.org/rfc/rfc4514.txt) escaped string. +.IP \(bu 4 \fB"cn={0},ou=engineering, -dc=example,dc=com"\fP -T} -_ -T{ -\fBldapQuery\fP -T} T{ +dc=example,dc=com"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBldapQuery\f1 +.IP \(bu 4 A LDAP query formatting template that inserts the authentication -name matched by the \fBmatch\fP regex into an LDAP query URI encoded +name matched by the \fBmatch\f1 regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. Each curly bracket\-enclosed numeric -value is replaced by the corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP expression. -\fBmongod\fP executes the query against the LDAP server to retrieve -the LDAP DN for the authenticated user. \fBmongod\fP requires +value is replaced by the corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 expression. +\fBmongod\f1\f1 executes the query against the LDAP server to retrieve +the LDAP DN for the authenticated user. \fBmongod\f1\f1 requires exactly one returned result for the transformation to be -successful, or \fBmongod\fP skips this transformation. -T} T{ +successful, or \fBmongod\f1\f1 skips this transformation. +.IP \(bu 4 \fB"ou=engineering,dc=example, -dc=com??one?(user={0})"\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4514\fP, -\fI\%RFC4515\fP, -\fI\%RFC4516\fP, or LDAP queries is out +dc=com??one?(user={0})"\f1 +.RE +.RE +.PP +An explanation of RFC4514 (https://www.ietf.org/rfc/rfc4514.txt), +RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516), or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.sp -For each document in the array, you must use either \fBsubstitution\fP or -\fBldapQuery\fP\&. You \fIcannot\fP specify both in the same document. -.sp -When performing authentication or authorization, \fBmongod\fP steps through +.PP +For each document in the array, you must use either \fBsubstitution\f1 or +\fBldapQuery\f1\&. You \fIcannot\f1 specify both in the same document. +.PP +When performing authentication or authorization, \fBmongod\f1\f1 steps through each document in the array in the given order, checking the authentication -username against the \fBmatch\fP filter. If a match is found, -\fBmongod\fP applies the transformation and uses the output for -authenticating the user. \fBmongod\fP does not check the remaining documents +username against the \fBmatch\f1 filter. If a match is found, +\fBmongod\f1\f1 applies the transformation and uses the output for +authenticating the user. \fBmongod\f1\f1 does not check the remaining documents in the array. -.sp +.PP If the given document does not match the provided authentication -name, \fI\%mongod\fP continues through the list of documents +name, \fBmongod\f1\f1 continues through the list of documents to find additional matches. If no matches are found in any document, or the transformation the document describes fails, -\fI\%mongod\fP returns an error. -.sp -Starting in MongoDB 4.4, \fI\%mongod\fP also returns an error +\fBmongod\f1\f1 returns an error. +.PP +Starting in MongoDB 4.4, \fBmongod\f1\f1 also returns an error if one of the transformations cannot be evaluated due to networking -or authentication failures to the LDAP server. \fI\%mongod\fP +or authentication failures to the LDAP server. \fBmongod\f1\f1 rejects the connection request and does not check the remaining documents in the array. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp +.PP +Starting in MongoDB 5.0, \fB\-\-ldapUserToDNMapping\f1\f1 +accepts an empty string \fB""\f1 or empty array \fB[ ]\f1 in place of a +mapping documnent. If providing an empty string or empty array to +\fB\-\-ldapUserToDNMapping\f1\f1, MongoDB will map the +authenticated username as the LDAP DN. Previously, providing an +empty mapping document would cause mapping to fail. +.PP The following shows two transformation documents. The first -document matches against any string ending in \fB@ENGINEERING\fP, placing +document matches against any string ending in \fB@ENGINEERING\f1, placing anything preceeding the suffix into a regex capture group. The -second document matches against any string ending in \fB@DBA\fP, placing +second document matches against any string ending in \fB@DBA\f1, placing anything preceeding the suffix into a regex capture group. -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 -You must pass the array to \fI\%\-\-ldapUserToDNMapping\fP as a string. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"[ - { - match: "(.+)@ENGINEERING.EXAMPLE.COM", - substitution: "cn={0},ou=engineering,dc=example,dc=com" - }, - { - match: "(.+)@DBA.EXAMPLE.COM", - ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" - - } - -]" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A user with username \fBalice@ENGINEERING.EXAMPLE.COM\fP matches the first -document. The regex capture group \fB{0}\fP corresponds to the string -\fBalice\fP\&. The resulting output is the DN -\fB"cn=alice,ou=engineering,dc=example,dc=com"\fP\&. -.sp -A user with username \fBbob@DBA.EXAMPLE.COM\fP matches the second document. -The regex capture group \fB{0}\fP corresponds to the string \fBbob\fP\&. The +.PP +.EX + "[ + { + match: "(.+)@ENGINEERING.EXAMPLE.COM", + substitution: "cn={0},ou=engineering,dc=example,dc=com" + }, + { + match: "(.+)@DBA.EXAMPLE.COM", + ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" + + } + + ]" +.EE +.PP +A user with username \fBalice@ENGINEERING.EXAMPLE.COM\f1 matches the first +document. The regex capture group \fB{0}\f1 corresponds to the string +\fBalice\f1\&. The resulting output is the DN +\fB"cn=alice,ou=engineering,dc=example,dc=com"\f1\&. +.PP +A user with username \fBbob@DBA.EXAMPLE.COM\f1 matches the second document. +The regex capture group \fB{0}\f1 corresponds to the string \fBbob\f1\&. The resulting output is the LDAP query -\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\fP\&. \fBmongod\fP executes this +\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\f1\&. \fBmongod\f1\f1 executes this query against the LDAP server, returning the result -\fB"cn=bob,ou=dba,dc=example,dc=com"\fP\&. -.UNINDENT -.UNINDENT -.sp -If \fI\%\-\-ldapUserToDNMapping\fP is unset, \fBmongod\fP applies no transformations to the username +\fB"cn=bob,ou=dba,dc=example,dc=com"\f1\&. +.PP +If \fB\-\-ldapUserToDNMapping\f1\f1 is unset, \fBmongod\f1\f1 applies no transformations to the username when attempting to authenticate or authorize a user against the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapAuthzQueryTemplate <string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A relative LDAP query URL formatted conforming to \fI\%RFC4515\fP and \fI\%RFC4516\fP that \fBmongod\fP executes to obtain +.PP +This setting can be configured on a running \fBmongod\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBmongod \-\-ldapAuthzQueryTemplate\f1 +.RS +.PP +A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongod\f1\f1 executes to obtain the LDAP groups to which the authenticated user belongs to. The query is -relative to the host or hosts specified in \fI\%\-\-ldapServers\fP\&. -.sp +relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&. +.PP In the URL, you can use the following substituion tokens: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Substitution Token -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB{USER}\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB{USER}\f1 +.IP \(bu 4 Substitutes the authenticated username, or the -\fBtransformed\fP -username if a \fI\%username mapping\fP is specified. -T} -_ -T{ -\fB{PROVIDED_USER}\fP -T} T{ +\fBtransformed\f1\f1 +username if a \fBusername mapping\f1\f1 is specified. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB{PROVIDED_USER}\f1 +.IP \(bu 4 Substitutes the supplied username, i.e. before either -authentication or \fBLDAP transformation\fP\&. -.sp -New in version 4.2. -T} -_ -.TE -.sp +authentication or \fBLDAP transformation\f1\f1\&. +.RE +.RE +.PP When constructing the query URL, ensure that the order of LDAP parameters respects RFC4516: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -[ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If your query includes an attribute, \fBmongod\fP assumes that the query +.PP +.EX + [ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ] +.EE +.PP +If your query includes an attribute, \fBmongod\f1\f1 assumes that the query retrieves a the DNs which this entity is member of. -.sp -If your query does not include an attribute, \fBmongod\fP assumes +.PP +If your query does not include an attribute, \fBmongod\f1\f1 assumes the query retrieves all entities which the user is member of. -.sp -For each LDAP DN returned by the query, \fBmongod\fP assigns the authorized -user a corresponding role on the \fBadmin\fP database. If a role on the on the -\fBadmin\fP database exactly matches the DN, \fBmongod\fP grants the user the +.PP +For each LDAP DN returned by the query, \fBmongod\f1\f1 assigns the authorized +user a corresponding role on the \fBadmin\f1 database. If a role on the on the +\fBadmin\f1 database exactly matches the DN, \fBmongod\f1\f1 grants the user the roles and privileges assigned to that role. See the -\fBdb.createRole()\fP method for more information on creating roles. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp +\fBdb.createRole()\f1\f1 method for more information on creating roles. +.PP This LDAP query returns any groups listed in the LDAP user object\(aqs -\fBmemberOf\fP attribute. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"{USER}?memberOf?base" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Your LDAP configuration may not include the \fBmemberOf\fP attribute as part +\fBmemberOf\f1 attribute. +.PP +.EX + "{USER}?memberOf?base" +.EE +.PP +Your LDAP configuration may not include the \fBmemberOf\f1 attribute as part of the user schema, may possess a different attribute for reporting group membership, or may not track group membership through attributes. Configure your query with respect to your own unique LDAP configuration. -.UNINDENT -.UNINDENT -.sp -If unset, \fBmongod\fP cannot authorize users using LDAP. -.sp -This setting can be configured on a running \fBmongod\fP using the -\fBsetParameter\fP database command. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4515\fP, -\fI\%RFC4516\fP or LDAP queries is out +.PP +If unset, \fBmongod\f1\f1 cannot authorize users using LDAP. +.PP +This setting can be configured on a running \fBmongod\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.PP +An explanation of RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516) or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Storage Options -.INDENT 0.0 -.TP -.B \-\-storageEngine string -\fIDefault\fP: \fBwiredTiger\fP -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.SS STORAGE OPTIONS +.PP +\fBmongod \-\-storageEngine\f1 +.RS +.PP +\fIDefault\f1: \fBwiredTiger\f1 +.PP Starting in version 4.2, MongoDB removes the deprecated MMAPv1 storage engine. -.UNINDENT -.UNINDENT -.sp -Specifies the storage engine for the \fBmongod\fP database. Available +.PP +Specifies the storage engine for the \fBmongod\f1\f1 database. Available values include: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBwiredTiger\fP -T} T{ -To specify the /core/wiredtiger\&. -T} -_ -T{ -\fBinMemory\fP -T} T{ -To specify the /core/inmemory\&. -.sp -New in version 3.2: Available in MongoDB Enterprise only. -T} -_ -.TE -.sp -If you attempt to start a \fBmongod\fP with a -\fI\%\-\-dbpath\fP that contains data files produced by a -storage engine other than the one specified by \fI\%\-\-storageEngine\fP, \fBmongod\fP +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBwiredTiger\f1 +.IP \(bu 4 +To specify the \fBWiredTiger Storage Engine\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBinMemory\f1 +.IP \(bu 4 +To specify the \fBIn\-Memory Storage Engine\f1\&. +.IP +Available in MongoDB Enterprise only. +.RE +.RE +.PP +If you attempt to start a \fBmongod\f1\f1 with a +\fB\-\-dbpath\f1\f1 that contains data files produced by a +storage engine other than the one specified by \fB\-\-storageEngine\f1\f1, \fBmongod\f1\f1 will refuse to start. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath <path> -\fIDefault\fP: \fB/data/db\fP on Linux and macOS, \fB\edata\edb\fP on Windows -.sp -The directory where the \fBmongod\fP instance stores its data. -.sp +.RE +.PP +\fBmongod \-\-dbpath\f1 +.RS +.PP +\fIDefault\f1: \fB/data/db\f1 on Linux and macOS, \fB\data\db\f1 on Windows +.PP +The directory where the \fBmongod\f1\f1 instance stores its data. +.PP If using the default -configuration file +\fBconfiguration file\f1 included with a package manager installation of MongoDB, the -corresponding \fBstorage.dbPath\fP setting uses a different +corresponding \fBstorage.dbPath\f1\f1 setting uses a different default. -.sp -The files in \fI\%\-\-dbpath\fP must correspond to the storage engine -specified in \fI\%\-\-storageEngine\fP\&. If the data files do not -correspond to \fI\%\-\-storageEngine\fP, \fBmongod\fP will refuse to +.PP +The files in \fB\-\-dbpath\f1\f1 must correspond to the storage engine +specified in \fB\-\-storageEngine\f1\f1\&. If the data files do not +correspond to \fB\-\-storageEngine\f1\f1, \fBmongod\f1\f1 will refuse to start. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb +.RE +.PP +\fBmongod \-\-directoryperdb\f1 +.RS +.PP Uses a separate directory to store data for each database. The -directories are under the \fI\%\-\-dbpath\fP directory, and each subdirectory +directories are under the \fB\-\-dbpath\f1\f1 directory, and each subdirectory name corresponds to the database name. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -To change the \fI\%\-\-directoryperdb\fP option for existing +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +Starting in MongoDB 5.0, dropping the final collection in a database +(or dropping the database itself) when \fB\-\-directoryperdb\f1\f1 is +enabled deletes the newly empty subdirectory for that database. +.PP +To change the \fB\-\-directoryperdb\f1\f1 option for existing deployments: -.INDENT 7.0 +.RS .IP \(bu 2 For standalone instances: -.INDENT 2.0 -.IP 1. 3 -Use \fI\%mongodump\fP on the existing -\fI\%mongod\fP instance to generate a backup. -.IP 2. 3 -Stop the \fI\%mongod\fP instance. -.IP 3. 3 -Add the \fI\%\-\-directoryperdb\fP value \fBand\fP +.RS +.IP \(bu 4 +Use \fBmongodump\f1\f1 on the existing +\fBmongod\f1\f1 instance to generate a backup. +.IP \(bu 4 +Stop the \fBmongod\f1\f1 instance. +.IP \(bu 4 +Add the \fB\-\-directoryperdb\f1\f1 value \fBand\f1 configure a new data directory -.IP 4. 3 -Restart the \fI\%mongod\fP instance. -.IP 5. 3 -Use \fI\%mongorestore\fP to populate the new data +.IP \(bu 4 +Restart the \fBmongod\f1\f1 instance. +.IP \(bu 4 +Use \fBmongorestore\f1\f1 to populate the new data directory. -.UNINDENT +.RE .IP \(bu 2 For replica sets: -.INDENT 2.0 -.IP 1. 3 +.RS +.IP \(bu 4 Stop a secondary member. -.IP 2. 3 -Add the \fI\%\-\-directoryperdb\fP value \fBand\fP +.IP \(bu 4 +Add the \fB\-\-directoryperdb\f1\f1 value \fBand\f1 configure a new data directory to that secondary member. -.IP 3. 3 +.IP \(bu 4 Restart that secondary. -.IP 4. 3 -Use initial sync to populate +.IP \(bu 4 +Use \fBinitial sync\f1 to populate the new data directory. -.IP 5. 3 +.IP \(bu 4 Update remaining secondaries in the same fashion. -.IP 6. 3 +.IP \(bu 4 Step down the primary, and update the stepped\-down member in the same fashion. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syncdelay <value> -\fIDefault\fP: 60 -.sp +.RE +.RE +.RE +.PP +\fBmongod \-\-syncdelay\f1 +.RS +.PP +\fIDefault\f1: 60 +.PP Controls how much time can pass before MongoDB flushes data to the data -files via an fsync operation. -.sp +files via an \fBfsync\f1 operation. +.PP \fBDo not set this value on -production systems.\fP In almost every situation, you should use the +production systems.\f1 In almost every situation, you should use the default setting. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -If you set \fI\%\-\-syncdelay\fP to \fB0\fP, MongoDB will not sync the +.PP +If you set \fB\-\-syncdelay\f1\f1 to \fB0\f1, MongoDB will not sync the memory mapped files to disk. -.UNINDENT -.UNINDENT -.sp -The \fBmongod\fP process writes data very quickly to the journal and -lazily to the data files. \fI\%\-\-syncdelay\fP has no effect on the -\fBjournal\fP files or journaling, -but if \fI\%\-\-syncdelay\fP is set to \fB0\fP the journal will eventually consume -all available disk space. If you set \fI\%\-\-syncdelay\fP to \fB0\fP for testing -purposes, you should also set \fI\%\-\-nojournal\fP -to \fBtrue\fP\&. -.sp -The \fBserverStatus\fP command reports the background flush -thread\(aqs status via the \fBbackgroundFlushing\fP field. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-upgrade +.PP +The \fBmongod\f1\f1 process writes data very quickly to the journal and +lazily to the data files. \fB\-\-syncdelay\f1\f1 has no effect on the +\fBjournal\f1\f1 files or \fBjournaling\f1, +but if \fB\-\-syncdelay\f1\f1 is set to \fB0\f1 the journal will eventually consume +all available disk space. If you set \fB\-\-syncdelay\f1\f1 to \fB0\f1 for testing +purposes, you should also set \fB\-\-nojournal\f1\f1 +to \fBtrue\f1\&. +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.RE +.PP +\fBmongod \-\-upgrade\f1 +.RS +.PP Upgrades the on\-disk data format of the files specified by the -\fI\%\-\-dbpath\fP to the latest version, if needed. -.sp -This option only affects the operation of the \fBmongod\fP if the data +\fB\-\-dbpath\f1\f1 to the latest version, if needed. +.PP +This option only affects the operation of the \fBmongod\f1\f1 if the data files are in an old format. -.sp +.PP In most cases you should not set this value, so you can exercise the most control over your upgrade process. See the MongoDB release notes for more information about the upgrade process. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-repair -Changed in version 4.0.3. - -.sp -Runs a repair routine on all databases for a \fI\%mongod\fP -instance. The operation attempts to salvage corrupt data as well as -rebuilds all the indexes. The operation discards any corrupt data -that cannot be salvaged. -.INDENT 7.0 -.INDENT 3.5 -.SS Tip -.sp -If you are running with journaling enabled, there is +.RE +.PP +\fBmongod \-\-repair\f1 +.RS +.PP +Runs a repair routine on all databases for a \fBmongod\f1\f1 +instance. +.PP +Starting in MongoDB 5.0: +.RS +.IP \(bu 2 +The repair operation validates the collections to find any +inconsistencies and fixes them if possible, which avoids +rebuilding the indexes. +.IP \(bu 2 +If a collection\(aqs data file is salvaged or if the collection has +inconsistencies that the validate step is unable to fix, then all +indexes are rebuilt. +.RE +.PP +In MongoDB 4.4 and previous versions, the repair operation attempts +to: +.RS +.IP \(bu 2 +Salvage corrupt data. The operation discards any corrupt +data that cannot be salvaged. +.IP \(bu 2 +Rebuild indexes. The operation validates collections and rebuilds +all indexes for collections with inconsistencies between the +collection data and one or more indexes. The operation also +rebuilds indexes for all salvaged and modified collections. +(\fIChanged in version 4.4.\f1) +.RE +.PP +If you are running with \fBjournaling\f1 enabled, there is almost never any need to run repair since the server can use the journal files to restore the data files to a clean state automatically. However, you may need to run repair in cases where you need to recover from a disk\-level data corruption. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -Only use \fI\%mongod \-\-repair\fP if you have no other options. +.RS +.IP \(bu 2 +Only use \fBmongod \-\-repair\f1\f1 if you have no other options. The operation removes and does not save any corrupt data during the repair process. .IP \(bu 2 -Avoid running \fI\%\-\-repair\fP against +Avoid running \fB\-\-repair\f1\f1 against a replica set member: -.INDENT 2.0 -.IP \(bu 2 -To repair a replica set member, if you have an intact +.RS +.IP \(bu 4 +To repair a \fBreplica set\f1 member, if you have an intact copy of your data available (e.g. a recent backup or an intact -member of the replica set), restore from that intact -copy instead(see /tutorial/resync\-replica\-set\-member). -.IP \(bu 2 -If you do choose to run \fI\%mongod \-\-repair\fP against a +member of the \fBreplica set\f1), restore from that intact +copy instead(see \fBResync a Member of a Replica Set\f1). +.IP \(bu 4 +If you do choose to run \fBmongod \-\-repair\f1\f1 against a replica set member and the operation modifies the data or the metadata, you must still perform a full resync in order for the member to rejoin the replica set. -.UNINDENT +.RE .IP \(bu 2 -Before using \fI\%\-\-repair\fP, make a backup -copy of the \fI\%dbpath\fP directory. +Before using \fB\-\-repair\f1\f1, make a backup +copy of the \fBdbpath\f1\f1 directory. .IP \(bu 2 If repair fails to complete for any reason, you must restart the -instance using the \fI\%\-\-repair\fP option. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journal -Enables the durability journal to ensure data files remain valid +instance using the \fB\-\-repair\f1\f1 option. +.RE +.RE +.PP +\fBmongod \-\-journal\f1 +.RS +.PP +Enables the durability \fBjournal\f1 to ensure data files remain valid and recoverable. This option applies only when you specify the -\fI\%\-\-dbpath\fP option. \fBmongod\fP enables journaling by default. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -If any voting member of a replica set uses the in\-memory -storage engine, you must set -\fBwriteConcernMajorityJournalDefault\fP to \fBfalse\fP\&. -.sp +\fB\-\-dbpath\f1\f1 option. \fBmongod\f1\f1 enables journaling by default. +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +If any voting member of a replica set uses the \fBin\-memory +storage engine\f1, you must set +\fBwriteConcernMajorityJournalDefault\f1\f1 to \fBfalse\f1\&. +.PP Starting in version 4.2 (and 4.0.13 and 3.6.14 ), if a replica set -member uses the in\-memory storage engine +member uses the \fBin\-memory storage engine\f1 (voting or non\-voting) but the replica set has -\fBwriteConcernMajorityJournalDefault\fP set to true, the +\fBwriteConcernMajorityJournalDefault\f1\f1 set to true, the replica set member logs a startup warning. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nojournal -Disables journaling\&. \fBmongod\fP +.RE +.PP +\fBmongod \-\-nojournal\f1 +.RS +.PP +Disables \fBjournaling\f1\&. \fBmongod\f1\f1 enables journaling by default. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -Starting in MongoDB 4.0, you cannot specify \fI\%\-\-nojournal\fP option or \fBstorage.journal.enabled: -false\fP for replica set members that use the +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +Starting in MongoDB 4.0, you cannot specify \fB\-\-nojournal\f1\f1 option or \fBstorage.journal.enabled: +false\f1\f1 for replica set members that use the WiredTiger storage engine. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journalCommitInterval <value> -\fIDefault\fP: 100 -.sp +.RE +.PP +\fBmongod \-\-journalCommitInterval\f1 +.RS +.PP +\fIDefault\f1: 100 +.PP The maximum amount of time in milliseconds that -the \fBmongod\fP process allows between +the \fBmongod\f1\f1 process allows between journal operations. Values can range from 1 to 500 milliseconds. Lower values increase the durability of the journal, at the expense of disk performance. -.sp +.PP On WiredTiger, the default journal commit interval is 100 milliseconds. Additionally, a write that includes or implies -\fBj:true\fP will cause an immediate sync of the journal. For details +\fBj:true\f1 will cause an immediate sync of the journal. For details or additional conditions that affect the frequency of the sync, see -journal\-process\&. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Known Issue in 4.2.0: The \fI\%\-\-journalCommitInterval\fP is missing in 4.2.0. -.UNINDENT -.UNINDENT -.UNINDENT -.SS WiredTiger Options -.INDENT 0.0 -.TP -.B \-\-wiredTigerCacheSizeGB <float> +\fBJournaling Process\f1\&. +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +Known Issue in 4.2.0: The \fB\-\-journalCommitInterval\f1\f1 is missing in 4.2.0. +.RE +.SS WIREDTIGER OPTIONS +.PP +\fBmongod \-\-wiredTigerCacheSizeGB\f1 +.RS +.PP Defines the maximum size of the internal cache that WiredTiger will use for all data. The memory consumed by an index build (see -\fBmaxIndexBuildMemoryUsageMegabytes\fP) is separate from the +\fBmaxIndexBuildMemoryUsageMegabytes\f1\f1) is separate from the WiredTiger cache memory. -.sp -Values can range from \fB0.25\fP GB to \fB10000\fP GB. -.sp +.PP +Values can range from \fB0.25\f1 GB to \fB10000\f1 GB. +.PP Starting in MongoDB 3.4, the default WiredTiger internal cache size is the larger of either: -.INDENT 7.0 +.RS .IP \(bu 2 50% of (RAM \- 1 GB), or .IP \(bu 2 256 MB. -.UNINDENT -.sp +.RE +.PP For example, on a system with a total of 4GB of RAM the WiredTiger -cache will use 1.5GB of RAM (\fB0.5 * (4 GB \- 1 GB) = 1.5 GB\fP). +cache will use 1.5GB of RAM (\fB0.5 * (4 GB \- 1 GB) = 1.5 GB\f1). Conversely, a system with a total of 1.25 GB of RAM will allocate 256 MB to the WiredTiger cache because that is more than half of the -total RAM minus one gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\fP). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +total RAM minus one gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\f1). +.PP In some instances, such as when running in a container, the database can have memory constraints that are lower than the total system memory. In such instances, this memory limit, rather than the total system memory, is used as the maximum RAM available. -.sp -To see the memory limit, see \fBhostInfo.system.memLimitMB\fP\&. -.UNINDENT -.UNINDENT -.sp +.PP +To see the memory limit, see \fBhostInfo.system.memLimitMB\f1\f1\&. +.PP Avoid increasing the WiredTiger internal cache size above its default value. -.sp +.PP With WiredTiger, MongoDB utilizes both the WiredTiger internal cache and the filesystem cache. -.sp +.PP Via the filesystem cache, MongoDB automatically uses all free memory that is not used by the WiredTiger cache or by other processes. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%\-\-wiredTigerCacheSizeGB\fP limits the size of the WiredTiger internal +.PP +The \fB\-\-wiredTigerCacheSizeGB\f1\f1 limits the size of the WiredTiger internal cache. The operating system will use the available free memory for filesystem cache, which allows the compressed MongoDB data files to stay in memory. In addition, the operating system will use any free RAM to buffer file system blocks and file system cache. -.sp +.PP To accommodate the additional consumers of RAM, you may have to decrease WiredTiger internal cache size. -.UNINDENT -.UNINDENT -.sp +.PP The default WiredTiger internal cache size value assumes that there is a -single \fI\%mongod\fP instance per machine. If a single machine +single \fBmongod\f1\f1 instance per machine. If a single machine contains multiple MongoDB instances, then you should decrease the setting to -accommodate the other \fI\%mongod\fP +accommodate the other \fBmongod\f1\f1 instances. -.sp -If you run \fI\%mongod\fP in a container (e.g. \fBlxc\fP, -\fBcgroups\fP, Docker, etc.) that does \fInot\fP have access to all of the -RAM available in a system, you must set \fI\%\-\-wiredTigerCacheSizeGB\fP to a value +.PP +If you run \fBmongod\f1\f1 in a container (e.g. \fBlxc\f1, +\fBcgroups\f1, Docker, etc.) that does \fInot\f1 have access to all of the +RAM available in a system, you must set \fB\-\-wiredTigerCacheSizeGB\f1\f1 to a value less than the amount of RAM available in the container. The exact amount depends on the other processes running in the container. See -\fBmemLimitMB\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerMaxCacheOverflowFileSizeGB <float> -.INDENT 7.0 -.INDENT 3.5 -.IP "Deprecated in MongoDB 4.4" -.sp -MongoDB deprecates the \fB\-\-wiredTigerMaxCacheOverflowFileSizeGB\fP +\fBmemLimitMB\f1\f1\&. +.RE +.PP +\fBmongod \-\-wiredTigerMaxCacheOverflowFileSizeGB\f1 +.RS +.PP +MongoDB deprecates the \fB\-\-wiredTigerMaxCacheOverflowFileSizeGB\f1 option. The option has no effect starting in MongoDB 4.4. -.UNINDENT -.UNINDENT -.sp +.PP Specifies the maximum size (in GB) for the "lookaside (or cache -overflow) table" file \fBWiredTigerLAS.wt\fP for MongoDB +overflow) table" file WiredTigerLAS.wt for MongoDB 4.2.1\-4.2.x and 4.0.12\-4.0.x. The file no longer exists starting in version 4.4. -.sp +.PP The setting can accept the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB0\fP -T} T{ -The default value. If set to \fB0\fP, the file size is +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB0\f1 +.IP \(bu 4 +The default value. If set to \fB0\f1, the file size is unbounded. -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 number >= 0.1 -T} T{ -The maximum size (in GB). If the \fBWiredTigerLAS.wt\fP -file exceeds this size, \fI\%mongod\fP exits with a -fatal assertion. You can clear the \fBWiredTigerLAS.wt\fP -file and restart \fI\%mongod\fP\&. -T} -_ -.TE -.sp +.IP \(bu 4 +The maximum size (in GB). If the WiredTigerLAS.wt +file exceeds this size, \fBmongod\f1\f1 exits with a +fatal assertion. You can clear the WiredTigerLAS.wt +file and restart \fBmongod\f1\f1\&. +.RE +.RE +.PP To change the maximum size during runtime, use the -\fBwiredTigerMaxCacheOverflowSizeGB\fP parameter. -.sp -\fIAvailable starting in MongoDB 4.2.1 (and 4.0.12)\fP -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerJournalCompressor <compressor> -\fIDefault\fP: snappy -.sp +\fBwiredTigerMaxCacheOverflowSizeGB\f1\f1 parameter. +.PP +\fIAvailable starting in MongoDB 4.2.1 (and 4.0.12)\f1 +.RE +.PP +\fBmongod \-\-wiredTigerJournalCompressor\f1 +.RS +.PP +\fIDefault\f1: snappy +.PP Specifies the type of compression to use to compress WiredTiger journal data. -.sp +.PP Available compressors are: -.INDENT 7.0 -.IP \(bu 2 -\fBnone\fP -.IP \(bu 2 -snappy -.IP \(bu 2 -zlib -.IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerDirectoryForIndexes -When you start \fBmongod\fP with \fI\%\-\-wiredTigerDirectoryForIndexes\fP, \fBmongod\fP stores indexes and collections in separate -subdirectories under the data (i.e. \fI\%\-\-dbpath\fP) directory. -Specifically, \fBmongod\fP stores the indexes in a subdirectory named -\fBindex\fP and the collection data in a subdirectory named -\fBcollection\fP\&. -.sp +.RS +.IP \(bu 2 +\fBnone\f1 +.IP \(bu 2 +\fBsnappy\f1 +.IP \(bu 2 +\fBzlib\f1 +.IP \(bu 2 +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.RE +.PP +\fBmongod \-\-wiredTigerDirectoryForIndexes\f1 +.RS +.PP +When you start \fBmongod\f1\f1 with \fB\-\-wiredTigerDirectoryForIndexes\f1\f1, \fBmongod\f1\f1 stores indexes and collections in separate +subdirectories under the data (i.e. \fB\-\-dbpath\f1\f1) directory. +Specifically, \fBmongod\f1\f1 stores the indexes in a subdirectory named +\fBindex\f1 and the collection data in a subdirectory named +\fBcollection\f1\&. +.PP By using a symbolic link, you can specify a different location for -the indexes. Specifically, when \fI\%mongod\fP instance is \fBnot\fP -running, move the \fBindex\fP subdirectory to the destination and -create a symbolic link named \fBindex\fP under the data directory to +the indexes. Specifically, when \fBmongod\f1\f1 instance is \fBnot\f1 +running, move the \fBindex\f1 subdirectory to the destination and +create a symbolic link named \fBindex\f1 under the data directory to the new destination. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerCollectionBlockCompressor <compressor> -\fIDefault\fP: snappy -.sp +.RE +.PP +\fBmongod \-\-wiredTigerCollectionBlockCompressor\f1 +.RS +.PP +\fIDefault\f1: snappy +.PP Specifies the default compression for collection data. You can override this on a per\-collection basis when creating collections. -.sp +.PP Available compressors are: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBnone\fP +\fBnone\f1 .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib +\fBzlib\f1 .IP \(bu 2 -zstd (Available starting MongoDB 4.2) -.UNINDENT -.sp -\fI\%\-\-wiredTigerCollectionBlockCompressor\fP affects all collections created. If you change -the value of \fI\%\-\-wiredTigerCollectionBlockCompressor\fP on an existing MongoDB deployment, all new +\fBzstd\f1 (Available starting MongoDB 4.2) +.RE +.PP +\fB\-\-wiredTigerCollectionBlockCompressor\f1\f1 affects all collections created. If you change +the value of \fB\-\-wiredTigerCollectionBlockCompressor\f1\f1 on an existing MongoDB deployment, all new collections will use the specified compressor. Existing collections will continue to use the compressor specified when they were created, or the default compressor at that time. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerIndexPrefixCompression <boolean> -\fIDefault\fP: true -.sp -Enables or disables prefix compression for index data. -.sp -Specify \fBtrue\fP for \fI\%\-\-wiredTigerIndexPrefixCompression\fP to enable prefix compression for -index data, or \fBfalse\fP to disable prefix compression for index data. -.sp -The \fI\%\-\-wiredTigerIndexPrefixCompression\fP setting affects all indexes created. If you change -the value of \fI\%\-\-wiredTigerIndexPrefixCompression\fP on an existing MongoDB deployment, all new +.RE +.PP +\fBmongod \-\-wiredTigerIndexPrefixCompression\f1 +.RS +.PP +\fIDefault\f1: true +.PP +Enables or disables \fBprefix compression\f1 for index data. +.PP +Specify \fBtrue\f1 for \fB\-\-wiredTigerIndexPrefixCompression\f1\f1 to enable \fBprefix compression\f1 for +index data, or \fBfalse\f1 to disable prefix compression for index data. +.PP +The \fB\-\-wiredTigerIndexPrefixCompression\f1\f1 setting affects all indexes created. If you change +the value of \fB\-\-wiredTigerIndexPrefixCompression\f1\f1 on an existing MongoDB deployment, all new indexes will use prefix compression. Existing indexes are not affected. -.UNINDENT -.SS Replication Options -.INDENT 0.0 -.TP -.B \-\-replSet <setname> +.RE +.SS REPLICATION OPTIONS +.PP +\fBmongod \-\-replSet\f1 +.RS +.PP Configures replication. Specify a replica set name as an argument to this set. All hosts in the replica set must have the same set name. -.sp +.PP Starting in MongoDB 4.0, -.INDENT 7.0 -.IP \(bu 2 -For the WiredTiger storage engine, \fI\%\-\-replSet\fP cannot be used in -conjunction with \fI\%\-\-nojournal\fP\&. -.UNINDENT -.sp -If your application connects to more than one replica set, each set -should have a distinct name. Some drivers group replica set -connections by replica set name. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-oplogSize <value> +.RS +.IP \(bu 2 +For the WiredTiger storage engine, \fB\-\-replSet\f1\f1 cannot be used in +conjunction with \fB\-\-nojournal\f1\f1\&. +.RE +.PP +If your application connects to more than one replica set, each set must +have a distinct name. Some drivers group replica set connections by +replica set name. +.RE +.PP +\fBmongod \-\-oplogSize\f1 +.RS +.PP Specifies a maximum size in megabytes for the replication operation log -(i.e., the oplog). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +(i.e., the \fBoplog\f1). +.PP Starting in MongoDB 4.0, the oplog can grow past its configured size -limit to avoid deleting the \fBmajority commit point\fP\&. -.UNINDENT -.UNINDENT -.sp -By default, the \fBmongod\fP process creates an oplog based on +limit to avoid deleting the \fBmajority commit point\f1\f1\&. +.PP +By default, the \fBmongod\f1\f1 process creates an \fBoplog\f1 based on the maximum amount of space available. For 64\-bit systems, the oplog is typically 5% of available disk space. -.sp -Once the \fBmongod\fP has created the oplog for the first time, -changing the \fI\%\-\-oplogSize\fP option will not affect the size of +.PP +Once the \fBmongod\f1\f1 has created the oplog for the first time, +changing the \fB\-\-oplogSize\f1\f1 option will not affect the size of the oplog. To change the minimum oplog retention period after -starting the \fI\%mongod\fP, use -\fBreplSetResizeOplog\fP\&. \fBreplSetResizeOplog\fP +starting the \fBmongod\f1\f1, use +\fBreplSetResizeOplog\f1\f1\&. \fBreplSetResizeOplog\f1\f1 enables you to resize the oplog dynamically without restarting the -\fI\%mongod\fP process. To persist the changes made using -\fBreplSetResizeOplog\fP through a restart, update the value -of \fI\%\-\-oplogSize\fP\&. -.sp -See replica\-set\-oplog\-sizing for more information. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-oplogMinRetentionHours <value> -New in version 4.4: Specifies the minimum number of hours to preserve an oplog entry, +\fBmongod\f1\f1 process. To persist the changes made using +\fBreplSetResizeOplog\f1\f1 through a restart, update the value +of \fB\-\-oplogSize\f1\f1\&. +.PP +See \fBOplog Size\f1 for more information. +.RE +.PP +\fBmongod \-\-oplogMinRetentionHours\f1 +.RS +.PP +Specifies the minimum number of hours to preserve an oplog entry, where the decimal values represent the fractions of an hour. For -example, a value of \fB1.5\fP represents one hour and thirty +example, a value of \fB1.5\f1 represents one hour and thirty minutes. -.sp -The value must be greater than or equal to \fB0\fP\&. A value of \fB0\fP -indicates that the \fI\%mongod\fP should truncate the oplog +.PP +The value must be greater than or equal to \fB0\f1\&. A value of \fB0\f1 +indicates that the \fBmongod\f1\f1 should truncate the oplog starting with the oldest entries to maintain the configured maximum oplog size. - -.sp -Defaults to \fB0\fP\&. -.sp -A \fI\%mongod\fP started with \fB\-\-oplogMinRetentionHours\fP -only removes an oplog entry \fIif\fP: -.INDENT 7.0 +.PP +Defaults to \fB0\f1\&. +.PP +A \fBmongod\f1\f1 started with \fB\-\-oplogMinRetentionHours\f1 +only removes an oplog entry \fIif\f1: +.RS .IP \(bu 2 -The oplog has reached the maximum configured oplog size \fIand\fP +The oplog has reached the maximum configured oplog size \fIand\f1 .IP \(bu 2 The oplog entry is older than the configured number of hours based on the host system clock. -.UNINDENT -.sp -The \fI\%mongod\fP has the following behavior when configured +.RE +.PP +The \fBmongod\f1\f1 has the following behavior when configured with a minimum oplog retention period: -.INDENT 7.0 +.RS .IP \(bu 2 The oplog can grow without constraint so as to retain oplog entries for the configured number of hours. This may result in reduction or @@ -2250,2138 +1981,1860 @@ exhaustion of system disk space due to a combination of high write volume and large retention period. .IP \(bu 2 If the oplog grows beyond its maximum size, the -\fI\%mongod\fP may continue to hold that disk space even if -the oplog returns to its maximum size \fIor\fP is configured for a -smaller maximum size. See replSetResizeOplog\-cmd\-compact\&. +\fBmongod\f1\f1 may continue to hold that disk space even if +the oplog returns to its maximum size \fIor\f1 is configured for a +smaller maximum size. See \fBReducing Oplog Size Does Not Immediately Return Disk Space\f1\&. .IP \(bu 2 -The \fI\%mongod\fP compares the system wall clock to an +The \fBmongod\f1\f1 compares the system wall clock to an oplog entries creation wall clock time when enforcing oplog entry retention. Clock drift between cluster components may result in unexpected oplog retention behavior. See -production\-notes\-clock\-synchronization for more information on +\fBClock Synchronization\f1 for more information on clock synchronization across cluster members. -.UNINDENT -.sp +.RE +.PP To change the minimum oplog retention period after starting the -\fI\%mongod\fP, use \fBreplSetResizeOplog\fP\&. -\fBreplSetResizeOplog\fP enables you to resize the oplog -dynamically without restarting the \fI\%mongod\fP process. To -persist the changes made using \fBreplSetResizeOplog\fP +\fBmongod\f1\f1, use \fBreplSetResizeOplog\f1\f1\&. +\fBreplSetResizeOplog\f1\f1 enables you to resize the oplog +dynamically without restarting the \fBmongod\f1\f1 process. To +persist the changes made using \fBreplSetResizeOplog\f1\f1 through a restart, update the value of -\fI\%\-\-oplogMinRetentionHours\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-enableMajorityReadConcern -\fIDefault\fP: true -.sp -Starting in MongoDB 3.6, MongoDB enables support for -\fB"majority"\fP read concern by default. -.sp -You can disable read concern \fB"majority"\fP to prevent -the storage cache pressure from immobilizing a deployment with a -three\-member primary\-secondary\-arbiter (PSA) architecture. For more -information about disabling read concern \fB"majority"\fP, -see disable\-read\-concern\-majority\&. -.sp -To disable, set \fI\%\-\-enableMajorityReadConcern\fP to false. \fI\%\-\-enableMajorityReadConcern\fP has no effect for -MongoDB versions: 4.0.0, 4.0.1, 4.0.2, 3.6.0. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -In general, avoid disabling \fB"majority"\fP read concern -unless necessary. However, if you have a three\-member replica set -with a primary\-secondary\-arbiter (PSA) architecture or a sharded -cluster with a three\-member PSA shards, disable to prevent the -storage cache pressure from immobilizing the deployment. -.sp -Disabling \fB"majority"\fP read concern affects support for -transactions on sharded clusters. Specifically: -.INDENT 0.0 -.IP \(bu 2 -A transaction cannot use read concern \fB"snapshot"\fP if -the transaction involves a shard that has disabled read -concern "majority"\&. -.IP \(bu 2 -A transaction that writes to multiple shards errors if any of the -transaction\(aqs read or write operations involves a shard that has -disabled read concern \fB"majority"\fP\&. -.UNINDENT -.sp -However, it does not affect transactions -on replica sets. For transactions on replica sets, you can specify -read concern \fB"majority"\fP (or \fB"snapshot"\fP -or \fB"local"\fP ) for multi\-document transactions even if -read concern \fB"majority"\fP is disabled. -.sp -Disabling \fB"majority"\fP read concern disables support -for /changeStreams for MongoDB 4.0 and earlier. For MongoDB -4.2+, disabling read concern \fB"majority"\fP has no effect on change -streams availability. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Sharded Cluster Options -.INDENT 0.0 -.TP -.B \-\-configsvr -\fIRequired if starting a config server.\fP -.sp -Declares that this \fBmongod\fP instance serves as the config -server of a sharded cluster. When +\fB\-\-oplogMinRetentionHours\f1\f1\&. +.RE +.PP +\fBmongod \-\-enableMajorityReadConcern\f1 +.RS +.PP +\fIDefault\f1: true +.PP +Configures support for \fB"majority"\f1\f1 read concern. +.PP +Starting in MongoDB 5.0, +\fB\-\-enableMajorityReadConcern\f1\f1 cannot be changed +and is always set to \fBtrue\f1\&. In earlier versions of MongoDB, +\fB\-\-enableMajorityReadConcern\f1\f1 was configurable. +.PP +If you are using a three\-member primary\-secondary\-arbiter (PSA) +architecture, the write concern \fB"majority"\f1\f1 can cause +performance issues if a secondary is unavailable or lagging. See +\fBMitigate Performance Issues with PSA Replica Set\f1 for advice on how to mitigate these +issues. +.RE +.SS SHARDED CLUSTER OPTIONS +.PP +\fBmongod \-\-configsvr\f1 +.RS +.PP +\fIRequired if starting a config server.\f1 +.PP +Declares that this \fBmongod\f1\f1 instance serves as the \fBconfig +server\f1 of a sharded cluster. When running with this option, clients (i.e. other cluster components) -cannot write data to any database other than \fBconfig\fP -and \fBadmin\fP\&. The default port for a \fBmongod\fP with this option is -\fB27019\fP and the default \fI\%\-\-dbpath\fP directory is -\fB/data/configdb\fP, unless specified. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in 3.4, you must deploy config servers as a replica set. -The use of the deprecated mirrored \fI\%mongod\fP instances as +cannot write data to any database other than \fBconfig\f1 +and \fBadmin\f1\&. The default port for a \fBmongod\f1\f1 with this option is +\fB27019\f1 and the default \fB\-\-dbpath\f1\f1 directory is +\fB/data/configdb\f1, unless specified. +.PP +When starting a MongoDB server with \fB\-\-configsvr\f1, you must also +specify a \fB\-\-replSet\f1\f1\&. +.PP +The use of the deprecated mirrored \fBmongod\f1\f1 instances as config servers (SCCC) is no longer supported. -.sp +.PP The replica set config servers (CSRS) must run the -WiredTiger storage engine\&. -.UNINDENT -.UNINDENT -.sp -The \fI\%\-\-configsvr\fP option creates a local oplog\&. -.sp -Do not use the \fI\%\-\-configsvr\fP option with \fI\%\-\-shardsvr\fP\&. Config +\fBWiredTiger storage engine\f1\&. +.PP +The \fB\-\-configsvr\f1\f1 option creates a local \fBoplog\f1\&. +.PP +Do not use the \fB\-\-configsvr\f1\f1 option with \fB\-\-shardsvr\f1\f1\&. Config servers cannot be a shard server. -.sp -Do not use the \fI\%\-\-configsvr\fP with the -\fBskipShardingConfigurationChecks\fP parameter. That is, if -you are temporarily starting the \fI\%mongod\fP as a +.PP +Do not use the \fB\-\-configsvr\f1\f1 with the +\fBskipShardingConfigurationChecks\f1\f1 parameter. That is, if +you are temporarily starting the \fBmongod\f1\f1 as a standalone for maintenance operations, include the parameter -\fBskipShardingConfigurationChecks\fP and exclude \fI\%\-\-configsvr\fP\&. +\fBskipShardingConfigurationChecks\f1\f1 and exclude \fB\-\-configsvr\f1\f1\&. Once maintenance has completed, remove the -\fBskipShardingConfigurationChecks\fP parameter and restart -with \fI\%\-\-configsvr\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-configsvrMode <string> -\fBAvailable in MongoDB 3.2 version only\fP -.sp -If set to \fBsccc\fP, indicates that the config servers are deployed -as three mirrored \fI\%mongod\fP instances, even if one or more -config servers is also a member of a replica set. \fBconfigsvrMode\fP -only accepts the value \fBsccc\fP\&. -.sp +\fBskipShardingConfigurationChecks\f1\f1 parameter and restart +with \fB\-\-configsvr\f1\f1\&. +.RE +.PP +\fBmongod \-\-configsvrMode\f1 +.RS +.PP +\fBAvailable in MongoDB 3.2 version only\f1 +.PP +If set to \fBsccc\f1, indicates that the config servers are deployed +as three mirrored \fBmongod\f1\f1 instances, even if one or more +config servers is also a member of a replica set. \fBconfigsvrMode\f1 +only accepts the value \fBsccc\f1\&. +.PP If unset, config servers running as replica sets expect to use the "config server replica set" protocol for writing to config servers, rather than the "mirrored mongod" write protocol. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shardsvr -\fIRequired if starting a shard server.\fP -.sp -Configures this \fBmongod\fP instance as a shard in a +.RE +.PP +\fBmongod \-\-shardsvr\f1 +.RS +.PP +\fIRequired if starting a shard server.\f1 +.PP +Configures this \fBmongod\f1\f1 instance as a shard in a sharded cluster. The default port for these instances is -\fB27018\fP\&. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 3.6, you must deploy shards as replica sets. See the \fI\%\-\-replSet\fP -option to deploy \fBmongod\fP as part of a replica set. -.UNINDENT -.UNINDENT -.sp -Do not use the \fI\%\-\-shardsvr\fP with the -\fBskipShardingConfigurationChecks\fP parameter. That is, if -you are temporarily starting the \fI\%mongod\fP as a +\fB27018\f1\&. +.PP +When starting a MongoDB server with \fB\-\-shardsvr\f1, you must also +specify a \fB\-\-replSet\f1\f1\&. +.PP +Do not use the \fB\-\-shardsvr\f1\f1 with the +\fBskipShardingConfigurationChecks\f1\f1 parameter. That is, if +you are temporarily starting the \fBmongod\f1\f1 as a standalone for maintenance operations, include the parameter -\fBskipShardingConfigurationChecks\fP and exclude \fI\%\-\-shardsvr\fP\&. +\fBskipShardingConfigurationChecks\f1\f1 and exclude \fB\-\-shardsvr\f1\f1\&. Once maintenance has completed, remove the -\fBskipShardingConfigurationChecks\fP parameter and restart -with \fI\%\-\-shardsvr\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-moveParanoia +\fBskipShardingConfigurationChecks\f1\f1 parameter and restart +with \fB\-\-shardsvr\f1\f1\&. +.RE +.PP +\fBmongod \-\-moveParanoia\f1 +.RS +.PP If specified, during chunk migration, a shard saves, -to the \fBmoveChunk\fP directory of the \fB\-\-dbpath\fP, all documents +to the \fBmoveChunk\f1 directory of the \fB\-\-dbpath\f1, all documents migrated from that shard. -.sp +.PP MongoDB does not automatically delete the data saved in the -\fBmoveChunk\fP directory. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noMoveParanoia -Changed in version 3.2: Starting in 3.2, MongoDB uses \fB\-\-noMoveParanoia\fP as the default. - -.sp +\fBmoveChunk\f1 directory. +.RE +.PP +\fBmongod \-\-noMoveParanoia\f1 +.RS +.PP +Starting in 3.2, MongoDB uses \fB\-\-noMoveParanoia\f1 as the default. +.PP During chunk migration, a shard does not save documents migrated from the shard. -.UNINDENT -.SS TLS Options -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full +.RE +.SS TLS OPTIONS +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsMode <mode> -New in version 4.2. - -.sp +.PP +\fBmongod \-\-tlsMode\f1 +.RS +.PP Enables TLS used for all network connections. The -argument to the \fI\%\-\-tlsMode\fP option can be one of the following: -.TS -center; -|l|l|. -_ -T{ +argument to the \fB\-\-tlsMode\f1\f1 option can be one of the following: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBdisabled\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBdisabled\f1 +.IP \(bu 4 The server does not use TLS. -T} -_ -T{ -\fBallowTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBallowTLS\f1 +.IP \(bu 4 Connections between servers do not use TLS. For incoming connections, the server accepts both TLS and non\-TLS. -T} -_ -T{ -\fBpreferTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBpreferTLS\f1 +.IP \(bu 4 Connections between servers use TLS. For incoming connections, the server accepts both TLS and non\-TLS. -T} -_ -T{ -\fBrequireTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrequireTLS\f1 +.IP \(bu 4 The server uses and accepts only TLS encrypted connections. -T} -_ -.TE -.sp -If \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP is not +.RE +.RE +.PP +If \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS\-enabled server. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fI\%\-\-tlsCertificateSelector\fP\&. -.sp +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFile <filename> -New in version 4.2: Specifies the \fB\&.pem\fP file that contains both the TLS +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsCertificateKeyFile\f1 +.RS +.PP +Specifies the \&.pem file that contains both the TLS certificate and key. - -.sp +.PP Starting with MongoDB 4.0 on macOS or Windows, you can use the -\fI\%\-\-tlsCertificateSelector\fP option to specify a +\fB\-\-tlsCertificateSelector\f1\f1 option to specify a certificate from the operating system\(aqs secure certificate store -instead of a PEM key file. \fI\%\-\-tlsCertificateKeyFile\fP and -\fI\%\-\-tlsCertificateSelector\fP options are mutually exclusive. +instead of a PEM key file. \fB\-\-tlsCertificateKeyFile\f1\f1 and +\fB\-\-tlsCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. -.INDENT 7.0 +.RS .IP \(bu 2 -On Linux/BSD, you must specify \fI\%\-\-tlsCertificateKeyFile\fP +On Linux/BSD, you must specify \fB\-\-tlsCertificateKeyFile\f1\f1 when TLS/SSL is enabled. .IP \(bu 2 On Windows or macOS, you must specify either -\fI\%\-\-tlsCertificateKeyFile\fP or -\fI\%\-\-tlsCertificateSelector\fP when TLS/SSL is enabled. -.sp -\fBIMPORTANT:\fP -.INDENT 2.0 -.INDENT 3.5 -For Windows \fBonly\fP, MongoDB 4.0 and later do not support -encrypted PEM files. The \fI\%mongod\fP fails to start if +\fB\-\-tlsCertificateKeyFile\f1\f1 or +\fB\-\-tlsCertificateSelector\f1\f1 when TLS/SSL is enabled. +.IP +For Windows \fBonly\f1, MongoDB 4.0 and later do not support +encrypted PEM files. The \fBmongod\f1\f1 fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with TLS on Windows, -use \fI\%\-\-tlsCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +use \fB\-\-tlsCertificateSelector\f1\f1\&. +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFilePassword <value> -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsCertificateKeyFilePassword\f1 +.RS +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-tlsCertificateKeyFile\fP). Use the -\fI\%\-\-tlsCertificateKeyFilePassword\fP option only if the +\fB\-\-tlsCertificateKeyFile\f1\f1). Use the +\fB\-\-tlsCertificateKeyFilePassword\f1\f1 option only if the certificate\-key file is encrypted. In all cases, the -\fBmongod\fP will redact the password from all logging and +\fBmongod\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the PEM file is encrypted and -you do not specify the \fI\%\-\-tlsCertificateKeyFilePassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS, if the private key in the PEM file is encrypted, you must explicitly specify the -\fI\%\-\-tlsCertificateKeyFilePassword\fP option. Alternatively, +\fB\-\-tlsCertificateKeyFilePassword\f1\f1 option. Alternatively, you can use a certificate from the secure system store (see -\fI\%\-\-tlsCertificateSelector\fP) instead of a PEM file or use an +\fB\-\-tlsCertificateSelector\f1\f1) instead of a PEM file or use an unencrypted PEM file. .IP \(bu 2 On Windows, MongoDB does not support encrypted certificates. -The \fI\%mongod\fP fails if it encounters an encrypted -PEM file. Use \fI\%\-\-tlsCertificateSelector\fP instead. -.UNINDENT -.sp +The \fBmongod\f1\f1 fails if it encounters an encrypted +PEM file. Use \fB\-\-tlsCertificateSelector\f1\f1 instead. +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clusterAuthMode <option> -\fIDefault\fP: keyFile -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-clusterAuthMode\f1 +.RS +.PP +\fIDefault\f1: keyFile +.PP The authentication mode used for cluster authentication. If you use -internal x.509 authentication, +\fBinternal x.509 authentication\f1, specify so here. This option can have one of the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBkeyFile\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBkeyFile\f1 +.IP \(bu 4 Use a keyfile for authentication. Accept only keyfiles. -T} -_ -T{ -\fBsendKeyFile\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsendKeyFile\f1 +.IP \(bu 4 For rolling upgrade purposes. Send a keyfile for authentication but can accept both keyfiles and x.509 certificates. -T} -_ -T{ -\fBsendX509\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsendX509\f1 +.IP \(bu 4 For rolling upgrade purposes. Send the x.509 certificate for authentication but can accept both keyfiles and x.509 certificates. -T} -_ -T{ -\fBx509\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBx509\f1 +.IP \(bu 4 Recommended. Send the x.509 certificate for authentication and accept only x.509 certificates. -T} -_ -.TE -.sp -If \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP is not +.RE +.RE +.PP +If \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS\-enabled server. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fI\%\-\-tlsCertificateSelector\fP\&. -.sp +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterFile <filename> -New in version 4.2: Specifies the \fB\&.pem\fP file that contains the x.509 -certificate\-key file for membership authentication for the cluster or replica set. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsClusterFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the x.509 +certificate\-key file for \fBmembership authentication\f1 for the cluster or replica set. +.PP Starting with MongoDB 4.0 on macOS or Windows, you can use the -\fI\%\-\-tlsClusterCertificateSelector\fP option to specify a +\fB\-\-tlsClusterCertificateSelector\f1\f1 option to specify a certificate from the operating system\(aqs secure certificate store -instead of a PEM key file. \fI\%\-\-tlsClusterFile\fP and -\fI\%\-\-tlsClusterCertificateSelector\fP options are mutually +instead of a PEM key file. \fB\-\-tlsClusterFile\f1\f1 and +\fB\-\-tlsClusterCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. -.sp -If \fI\%\-\-tlsClusterFile\fP does not specify the \fB\&.pem\fP file for +.PP +If \fB\-\-tlsClusterFile\f1\f1 does not specify the \fB\&.pem\f1 file for internal cluster authentication or the alternative -\fI\%\-\-tlsClusterCertificateSelector\fP, the cluster uses the -\fB\&.pem\fP file specified in the \fI\%\-\-tlsCertificateKeyFile\fP +\fB\-\-tlsClusterCertificateSelector\f1\f1, the cluster uses the +\fB\&.pem\f1 file specified in the \fB\-\-tlsCertificateKeyFile\f1\f1 option or the certificate returned by the -\fI\%\-\-tlsCertificateSelector\fP\&. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fI\%\-\-tlsCertificateSelector\fP\&. -.sp -Changed in version 4.4: \fI\%mongod\fP / \fBmongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +\fB\-\-tlsCertificateSelector\f1\f1\&. +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.sp +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -For Windows \fBonly\fP, MongoDB 4.0 and later do not support -encrypted PEM files. The \fI\%mongod\fP fails to start if +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP +For Windows \fBonly\f1, MongoDB 4.0 and later do not support +encrypted PEM files. The \fBmongod\f1\f1 fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with membership authentication on -Windows, use \fI\%\-\-tlsClusterCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateSelector <parameter>=<value> -New in version 4.2: Available on Windows and macOS as an alternative to -\fI\%\-\-tlsCertificateKeyFile\fP\&. In version 4.0, see -\fI\%\-\-sslCertificateSelector\fP\&. - -.sp +Windows, use \fB\-\-tlsClusterCertificateSelector\f1\f1\&. +.RE +.PP +\fBmongod \-\-tlsCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to +\fB\-\-tlsCertificateKeyFile\f1\f1\&. In version 4.0, see +\fB\-\-sslCertificateSelector\f1\f1\&. +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store to use for TLS. -.sp -The \fI\%\-\-tlsCertificateKeyFile\fP and -\fI\%\-\-tlsCertificateSelector\fP options are mutually exclusive. +.PP +The \fB\-\-tlsCertificateKeyFile\f1\f1 and +\fB\-\-tlsCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. -.sp -\fI\%\-\-tlsCertificateSelector\fP accepts an argument of the format -\fB<property>=<value>\fP where the property can be one of the +.PP +\fB\-\-tlsCertificateSelector\f1\f1 accepts an argument of the format +\fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.sp -The \fI\%mongod\fP searches the operating system\(aqs secure +.PP +The \fBmongod\f1\f1 searches the operating system\(aqs secure certificate store for the CA certificates required to validate the full certificate chain of the specified TLS certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full -certificate chain to the TLS certificate. Do \fBnot\fP use -\fI\%\-\-tlsCAFile\fP or \fI\%\-\-tlsClusterCAFile\fP to specify the +certificate chain to the TLS certificate. Do \fBnot\f1 use +\fB\-\-tlsCAFile\f1\f1 or \fB\-\-tlsClusterCAFile\f1\f1 to specify the root and intermediate CA certificate -.sp +.PP For example, if the TLS/SSL certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the TLS/SSL certificate was signed with an intermediate CA certificate, the secure certificate store must -contain the intermedia CA certificate \fIand\fP the root CA certificate. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterCertificateSelector <parameter>=<value> -New in version 4.2: Available on Windows and macOS as an alternative to -\fI\%\-\-tlsClusterFile\fP\&. -.sp +contain the intermedia CA certificate \fIand\f1 the root CA certificate. +.PP +You cannot use the \fBrotateCertificates\f1\f1 command or the +\fBdb.rotateCertificates()\f1\f1 shell method when using +\fBnet.tls.certificateSelector\f1\f1 or +\fB\-\-tlsCertificateSelector\f1\f1 +set to \fBthumbprint\f1 +.RE +.PP +\fBmongod \-\-tlsClusterCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to +\fB\-\-tlsClusterFile\f1\f1\&. +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store to use -for internal x.509 membership authentication\&. -.sp -\fI\%\-\-tlsClusterFile\fP and -\fI\%\-\-tlsClusterCertificateSelector\fP options are mutually +for \fBinternal x.509 membership authentication\f1\&. +.PP +\fB\-\-tlsClusterFile\f1\f1 and +\fB\-\-tlsClusterCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp -\fI\%\-\-tlsClusterCertificateSelector\fP accepts an argument of the -format \fB<property>=<value>\fP where the property can be one of the +.PP +\fB\-\-tlsClusterCertificateSelector\f1\f1 accepts an argument of the +format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp -The \fI\%mongod\fP searches the operating system\(aqs secure +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP +The \fBmongod\f1\f1 searches the operating system\(aqs secure certificate store for the CA certificates required to validate the full certificate chain of the specified cluster certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full -certificate chain to the cluster certificate. Do \fBnot\fP use -\fI\%\-\-tlsCAFile\fP or \fI\%\-\-tlsClusterCAFile\fP to specify the +certificate chain to the cluster certificate. Do \fBnot\f1 use +\fB\-\-tlsCAFile\f1\f1 or \fB\-\-tlsClusterCAFile\f1\f1 to specify the root and intermediate CA certificate. -.sp +.PP For example, if the cluster certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the cluster certificate was signed with an intermediate CA certificate, the secure certificate store must -contain the intermedia CA certificate \fIand\fP the root CA certificate. -.sp -Changed in version 4.4: \fI\%mongod\fP / \fBmongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +contain the intermedia CA certificate \fIand\f1 the root CA certificate. +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterPassword <value> -New in version 4.2: Specifies the password to de\-crypt the x.509 certificate\-key file -specified with \fI\%\-\-tlsClusterFile\fP\&. Use the -\fI\%\-\-tlsClusterPassword\fP option only if the certificate\-key -file is encrypted. In all cases, the \fBmongod\fP will redact +.RE +.PP +\fBmongod \-\-tlsClusterPassword\f1 +.RS +.PP +Specifies the password to de\-crypt the x.509 certificate\-key file +specified with \fB\-\-tlsClusterFile\f1\f1\&. Use the +\fB\-\-tlsClusterPassword\f1\f1 option only if the certificate\-key +file is encrypted. In all cases, the \fBmongod\f1\f1 will redact the password from all logging and reporting output. - -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the x.509 file is encrypted and -you do not specify the \fI\%\-\-tlsClusterPassword\fP option, +you do not specify the \fB\-\-tlsClusterPassword\f1\f1 option, MongoDB will prompt for a passphrase. See -ssl\-certificate\-password\&. +\fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS, if the private key in the x.509 file is encrypted, you must explicitly specify the -\fI\%\-\-tlsClusterPassword\fP option. Alternatively, you can +\fB\-\-tlsClusterPassword\f1\f1 option. Alternatively, you can either use a certificate from the secure system store (see -\fI\%\-\-tlsClusterCertificateSelector\fP) instead of a cluster PEM +\fB\-\-tlsClusterCertificateSelector\f1\f1) instead of a cluster PEM file or use an unencrypted PEM file. .IP \(bu 2 On Windows, MongoDB does not support encrypted certificates. -The \fI\%mongod\fP fails if it encounters an encrypted -PEM file. Use \fI\%\-\-tlsClusterCertificateSelector\fP instead. -.UNINDENT -.sp +The \fBmongod\f1\f1 fails if it encounters an encrypted +PEM file. Use \fB\-\-tlsClusterCertificateSelector\f1\f1 instead. +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCAFile <filename> -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsCAFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the -\fB\&.pem\fP file using relative or absolute paths. -.INDENT 7.0 -.TP -.B Windows/macOS Only -If using \fI\%\-\-tlsCertificateSelector\fP and/or -\fI\%\-\-tlsClusterCertificateSelector\fP, do \fBnot\fP use -\fI\%\-\-tlsCAFile\fP to specify the root and intermediate CA +\&.pem file using relative or absolute paths. +.PP +\fBWindows/macOS Only\f1 +.RS +.PP +If using \fB\-\-tlsCertificateSelector\f1\f1 and/or +\fB\-\-tlsClusterCertificateSelector\f1\f1, do \fBnot\f1 use +\fB\-\-tlsCAFile\f1\f1 to specify the root and intermediate CA certificates. Store all CA certificates required to validate the -full trust chain of the \fI\%\-\-tlsCertificateSelector\fP and/or -\fI\%\-\-tlsClusterCertificateSelector\fP certificates in the +full trust chain of the \fB\-\-tlsCertificateSelector\f1\f1 and/or +\fB\-\-tlsClusterCertificateSelector\f1\f1 certificates in the secure certificate store. -.UNINDENT -.sp +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterCAFile <filename> -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsClusterCAFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate presented by a client establishing a connection. Specify the file -name of the \fB\&.pem\fP file using relative or absolute paths. -\fI\%\-\-tlsClusterCAFile\fP requires that -\fI\%\-\-tlsCAFile\fP is set. -.sp -If \fI\%\-\-tlsClusterCAFile\fP does not specify the \fB\&.pem\fP +name of the \&.pem file using relative or absolute paths. +\fB\-\-tlsClusterCAFile\f1\f1 requires that +\fB\-\-tlsCAFile\f1\f1 is set. +.PP +If \fB\-\-tlsClusterCAFile\f1\f1 does not specify the \&.pem file for validating the certificate from a client establishing a -connection, the cluster uses the \fB\&.pem\fP file specified in the -\fI\%\-\-tlsCAFile\fP option. -.sp -\fI\%\-\-tlsClusterCAFile\fP lets you use separate Certificate +connection, the cluster uses the \&.pem file specified in the +\fB\-\-tlsCAFile\f1\f1 option. +.PP +\fB\-\-tlsClusterCAFile\f1\f1 lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake. -.INDENT 7.0 -.TP -.B Windows/macOS Only -If using \fI\%\-\-tlsCertificateSelector\fP and/or -\fI\%\-\-tlsClusterCertificateSelector\fP, do \fBnot\fP use -\fI\%\-\-tlsClusterCAFile\fP to specify the root and +.PP +\fBWindows/macOS Only\f1 +.RS +.PP +If using \fB\-\-tlsCertificateSelector\f1\f1 and/or +\fB\-\-tlsClusterCertificateSelector\f1\f1, do \fBnot\f1 use +\fB\-\-tlsClusterCAFile\f1\f1 to specify the root and intermediate CA certificates. Store all CA certificates required to validate the full trust chain of the -\fI\%\-\-tlsCertificateSelector\fP and/or -\fI\%\-\-tlsClusterCertificateSelector\fP certificates in the +\fB\-\-tlsCertificateSelector\f1\f1 and/or +\fB\-\-tlsClusterCertificateSelector\f1\f1 certificates in the secure certificate store. -.UNINDENT -.sp +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCRLFile <filename> -New in version 4.2: For MongoDB 4.0 and earlier, see \fI\%\-\-sslCRLFile\fP\&. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsCRLFile\f1 +.RS +.PP +For MongoDB 4.0 and earlier, see \fB\-\-sslCRLFile\f1\f1\&. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +.RS .IP \(bu 2 Starting in MongoDB 4.0, you cannot specify a CRL file on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (Online Certificate Status Protocol) to validate the revocation status of certificates. See -\fI\%\-\-sslCertificateSelector\fP in MongoDB 4.0 and -\fI\%\-\-tlsCertificateSelector\fP in MongoDB 4.2+ to use the +\fB\-\-sslCertificateSelector\f1\f1 in MongoDB 4.0 and +\fB\-\-tlsCertificateSelector\f1\f1 in MongoDB 4.2+ to use the system SSL certificate store. .IP \(bu 2 Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidCertificates -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsAllowInvalidCertificates\f1 +.RS +.PP Bypasses the validation checks for TLS certificates on other servers in the cluster and allows the use of invalid certificates to connect. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP If you specify -\fB\-\-tlsAllowInvalidCertificates\fP or \fBtls.allowInvalidCertificates: -true\fP when using x.509 authentication, an invalid certificate is +\fB\-\-tlsAllowInvalidCertificates\f1 or \fBtls.allowInvalidCertificates: +true\f1 when using x.509 authentication, an invalid certificate is only sufficient to establish a TLS connection but is -\fIinsufficient\fP for authentication. -.UNINDENT -.UNINDENT -.sp +\fIinsufficient\f1 for authentication. +.PP When using -the \fI\%\-\-tlsAllowInvalidCertificates\fP setting, MongoDB +the \fB\-\-tlsAllowInvalidCertificates\f1\f1 setting, MongoDB logs a warning regarding the use of the invalid certificate. -.sp +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidHostnames -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsAllowInvalidHostnames\f1 +.RS +.PP Disables the validation of the hostnames in TLS certificates, when connecting to other members of the replica set or sharded cluster -for inter\-process authentication. This allows \fBmongod\fP to connect +for inter\-process authentication. This allows \fBmongod\f1\f1 to connect to other members if the hostnames in their certificates do not match their configured hostname. -.sp +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowConnectionsWithoutCertificates -New in version 4.2. - -.sp -For clients that do not present certificates, \fBmongod\fP bypasses +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsAllowConnectionsWithoutCertificates\f1 +.RS +.PP +For clients that do not present certificates, \fBmongod\f1\f1 bypasses TLS/SSL certificate validation when establishing the connection. -.sp -For clients that present a certificate, however, \fBmongod\fP performs +.PP +For clients that present a certificate, however, \fBmongod\f1\f1 performs certificate validation using the root certificate chain specified by -\fB\-\-tlsCAFile\fP and reject clients with invalid certificates. -.sp -Use the \fI\%\-\-tlsAllowConnectionsWithoutCertificates\fP option if you have a mixed deployment that includes -clients that do not or cannot present certificates to the \fBmongod\fP\&. -.sp +\fB\-\-tlsCAFile\f1 and reject clients with invalid certificates. +.PP +Use the \fB\-\-tlsAllowConnectionsWithoutCertificates\f1\f1 option if you have a mixed deployment that includes +clients that do not or cannot present certificates to the \fBmongod\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsDisabledProtocols <protocol(s)> -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsDisabledProtocols\f1 +.RS +.PP Prevents a MongoDB server running with TLS from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols. -.sp -\fI\%\-\-tlsDisabledProtocols\fP recognizes the following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, -\fBTLS1_2\fP, and \fBTLS1_3\fP\&. -.INDENT 7.0 +.PP +\fB\-\-tlsDisabledProtocols\f1\f1 recognizes the following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, +\fBTLS1_2\f1, and \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must disable at least one of the other -two, for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must disable at least one of the other +two, for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 Specifying an unrecognized protocol will prevent the server from starting. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, -specify \fBnone\fP to \fI\%\-\-tlsDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.sp +specify \fBnone\f1 to \fB\-\-tlsDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.PP Members of replica sets and sharded clusters must speak at least one protocol in common. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -ssl\-disallow\-protocols -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsFIPSMode -New in version 4.2. - -.sp -Directs the \fBmongod\fP to use the FIPS mode of the TLS +.PP +\fBDisallow Protocols\f1 +.RE +.PP +\fBmongod \-\-tlsFIPSMode\f1 +.RS +.PP +Directs the \fBmongod\f1\f1 to use the FIPS mode of the TLS library. Your system must have a FIPS -compliant library to use the \fI\%\-\-tlsFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +compliant library to use the \fB\-\-tlsFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.SS SSL Options (Deprecated) -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 -All SSL options are deprecated since 4.2. Use the \fI\%TLS counterparts\fP instead, as they have identical functionality to the +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.SS SSL OPTIONS (DEPRECATED) +.PP +All SSL options are deprecated since 4.2. Use the \fBTLS counterparts\f1 instead, as they have identical functionality to the SSL options. The SSL protocol is deprecated and MongoDB supports TLS 1.0 and later. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslOnNormalPorts -Deprecated since version 2.6: Use \fI\%\-\-tlsMode requireTLS\fP instead. - -.sp -Enables TLS/SSL for \fBmongod\fP\&. -.sp -With \fI\%\-\-sslOnNormalPorts\fP, a \fBmongod\fP requires TLS/SSL encryption for all +.PP +\fBmongod \-\-sslOnNormalPorts\f1 +.RS +.PP +Use \fB\-\-tlsMode requireTLS\f1\f1 instead. +.PP +Enables TLS/SSL for \fBmongod\f1\f1\&. +.PP +With \fB\-\-sslOnNormalPorts\f1\f1, a \fBmongod\f1\f1 requires TLS/SSL encryption for all connections on the default MongoDB port, or the port specified by -\fI\%\-\-port\fP\&. By default, \fI\%\-\-sslOnNormalPorts\fP is +\fB\-\-port\f1\f1\&. By default, \fB\-\-sslOnNormalPorts\f1\f1 is disabled. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslMode <mode> -Deprecated since version 4.2: Use \fI\%\-\-tlsMode\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslMode\f1 +.RS +.PP +Use \fB\-\-tlsMode\f1\f1 instead. +.PP Enables TLS/SSL or mixed TLS/SSL used for all network connections. The -argument to the \fI\%\-\-sslMode\fP option can be one of the following: -.TS -center; -|l|l|. -_ -T{ +argument to the \fB\-\-sslMode\f1\f1 option can be one of the following: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBdisabled\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBdisabled\f1 +.IP \(bu 4 The server does not use TLS/SSL. -T} -_ -T{ -\fBallowSSL\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBallowSSL\f1 +.IP \(bu 4 Connections between servers do not use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non\-TLS/non\-SSL. -T} -_ -T{ -\fBpreferSSL\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBpreferSSL\f1 +.IP \(bu 4 Connections between servers use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non\-TLS/non\-SSL. -T} -_ -T{ -\fBrequireSSL\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrequireSSL\f1 +.IP \(bu 4 The server uses and accepts only TLS/SSL encrypted connections. -T} -_ -.TE -.sp -Starting in version 3.4, if \fB\-\-tlsCAFile\fP/\fBnet.tls.CAFile\fP (or -their aliases \fB\-\-sslCAFile\fP/\fBnet.ssl.CAFile\fP) is not specified +.RE +.RE +.PP +Starting in version 3.4, if \fB\-\-tlsCAFile\f1/\fBnet.tls.CAFile\f1 (or +their aliases \fB\-\-sslCAFile\f1/\fBnet.ssl.CAFile\f1) is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateKeyFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS/SSL +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslPEMKeyFile\f1 +.RS +.PP +Use \fB\-\-tlsCertificateKeyFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains both the TLS/SSL certificate and key. -.sp +.PP Starting with MongoDB 4.0 on macOS or Windows, you can use the -\fI\%\-\-sslCertificateSelector\fP option to specify a +\fB\-\-sslCertificateSelector\f1\f1 option to specify a certificate from the operating system\(aqs secure certificate store -instead of a PEM key file. \fI\%\-\-sslPEMKeyFile\fP and -\fI\%\-\-sslCertificateSelector\fP options are mutually exclusive. +instead of a PEM key file. \fB\-\-sslPEMKeyFile\f1\f1 and +\fB\-\-sslCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. -.INDENT 7.0 +.RS .IP \(bu 2 -On Linux/BSD, you must specify \fI\%\-\-sslPEMKeyFile\fP when +On Linux/BSD, you must specify \fB\-\-sslPEMKeyFile\f1\f1 when TLS/SSL is enabled. .IP \(bu 2 On Windows or macOS, you must specify either -\fI\%\-\-sslPEMKeyFile\fP or \fI\%\-\-sslCertificateSelector\fP +\fB\-\-sslPEMKeyFile\f1\f1 or \fB\-\-sslCertificateSelector\f1\f1 when TLS/SSL is enabled. -.sp -\fBIMPORTANT:\fP -.INDENT 2.0 -.INDENT 3.5 -For Windows \fBonly\fP, MongoDB 4.0 and later do not support -encrypted PEM files. The \fI\%mongod\fP fails to start if +.IP +For Windows \fBonly\f1, MongoDB 4.0 and later do not support +encrypted PEM files. The \fBmongod\f1\f1 fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with TLS/SSL on Windows, -use \fI\%\-\-sslCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +use \fB\-\-sslCertificateSelector\f1\f1\&. +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyPassword <value> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateKeyFilePassword\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslPEMKeyPassword\f1 +.RS +.PP +Use \fB\-\-tlsCertificateKeyFilePassword\f1\f1 instead. +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongod\fP will +\fB\-\-sslPEMKeyFile\f1\f1). Use the \fB\-\-sslPEMKeyPassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongod\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the PEM file is encrypted and -you do not specify the \fI\%\-\-sslPEMKeyPassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-sslPEMKeyPassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS, if the private key in the PEM file is encrypted, you must explicitly specify the -\fI\%\-\-sslPEMKeyPassword\fP option. Alternatively, you can use a +\fB\-\-sslPEMKeyPassword\f1\f1 option. Alternatively, you can use a certificate from the secure system store (see -\fI\%\-\-sslCertificateSelector\fP) instead of a PEM key file or +\fB\-\-sslCertificateSelector\f1\f1) instead of a PEM key file or use an unencrypted PEM file. .IP \(bu 2 On Windows, MongoDB does not support encrypted certificates. -The \fI\%mongod\fP fails if it encounters an encrypted -PEM file. Use \fI\%\-\-sslCertificateSelector\fP instead. -.UNINDENT -.sp +The \fBmongod\f1\f1 fails if it encounters an encrypted +PEM file. Use \fB\-\-sslCertificateSelector\f1\f1 instead. +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the x.509 -certificate\-key file for membership authentication for the cluster or replica set. -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslClusterFile\f1 +.RS +.PP +Use \fB\-\-tlsClusterFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the x.509 +certificate\-key file for \fBmembership authentication\f1 for the cluster or replica set. +.PP Starting with MongoDB 4.0 on macOS or Windows, you can use the -\fI\%\-\-sslClusterCertificateSelector\fP option to specify a +\fB\-\-sslClusterCertificateSelector\f1\f1 option to specify a certificate from the operating system\(aqs secure certificate store -instead of a PEM key file. \fI\%\-\-sslClusterFile\fP and -\fI\%\-\-sslClusterCertificateSelector\fP options are mutually +instead of a PEM key file. \fB\-\-sslClusterFile\f1\f1 and +\fB\-\-sslClusterCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. -.sp -If \fI\%\-\-sslClusterFile\fP does not specify the \fB\&.pem\fP file for +.PP +If \fB\-\-sslClusterFile\f1\f1 does not specify the \fB\&.pem\f1 file for internal cluster authentication or the alternative -\fI\%\-\-sslClusterCertificateSelector\fP, the cluster uses the -\fB\&.pem\fP file specified in the \fI\%\-\-sslPEMKeyFile\fP option or -the certificate returned by the \fI\%\-\-sslCertificateSelector\fP\&. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +\fB\-\-sslClusterCertificateSelector\f1\f1, the cluster uses the +\fB\&.pem\f1 file specified in the \fB\-\-sslPEMKeyFile\f1\f1 option or +the certificate returned by the \fB\-\-sslCertificateSelector\f1\f1\&. +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -For Windows \fBonly\fP, MongoDB 4.0 and later do not support -encrypted PEM files. The \fI\%mongod\fP fails to start if +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP +For Windows \fBonly\f1, MongoDB 4.0 and later do not support +encrypted PEM files. The \fBmongod\f1\f1 fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with membership authentication on -Windows, use \fI\%\-\-sslClusterCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCertificateSelector <parameter>=<value> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateSelector\fP instead. - -.sp -New in version 4.0: Available on Windows and macOS as an alternative to -\fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp +Windows, use \fB\-\-sslClusterCertificateSelector\f1\f1\&. +.RE +.PP +\fBmongod \-\-sslCertificateSelector\f1 +.RS +.PP +Use \fB\-\-tlsCertificateSelector\f1\f1 instead. +.PP +Available on Windows and macOS as an alternative to +\fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP Specifies a certificate property to select a matching certificate from the operating system\(aqs secure certificate store to use for TLS/SSL. -.sp -\fI\%\-\-sslPEMKeyFile\fP and \fI\%\-\-sslCertificateSelector\fP +.PP +\fB\-\-sslPEMKeyFile\f1\f1 and \fB\-\-sslCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp -\fI\%\-\-sslCertificateSelector\fP accepts an argument of the format -\fB<property>=<value>\fP where the property can be one of the +.PP +\fB\-\-sslCertificateSelector\f1\f1 accepts an argument of the format +\fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.sp -The \fI\%mongod\fP searches the operating system\(aqs secure +.PP +The \fBmongod\f1\f1 searches the operating system\(aqs secure certificate store for the CA certificates required to validate the full certificate chain of the specified TLS/SSL certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full -certificate chain to the TLS/SSL certificate. Do \fBnot\fP use -\fI\%\-\-sslCAFile\fP or \fI\%\-\-sslClusterCAFile\fP to specify the +certificate chain to the TLS/SSL certificate. Do \fBnot\f1 use +\fB\-\-sslCAFile\f1\f1 or \fB\-\-sslClusterCAFile\f1\f1 to specify the root and intermediate CA certificate -.sp +.PP For example, if the TLS/SSL certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the TLS/SSL certificate was signed with an intermediate CA certificate, the secure certificate store must -contain the intermedia CA certificate \fIand\fP the root CA certificate. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterCertificateSelector <parameter>=<value> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterCertificateSelector\fP instead. - -.sp -New in version 4.0: Available on Windows and macOS as an alternative to -\fI\%\-\-sslClusterFile\fP\&. -.sp +contain the intermedia CA certificate \fIand\f1 the root CA certificate. +.RE +.PP +\fBmongod \-\-sslClusterCertificateSelector\f1 +.RS +.PP +Use \fB\-\-tlsClusterCertificateSelector\f1\f1 instead. +.PP +Available on Windows and macOS as an alternative to +\fB\-\-sslClusterFile\f1\f1\&. +.PP Specifies a certificate property to select a matching certificate from the operating system\(aqs secure certificate store to use for -internal x.509 membership authentication\&. -.sp -\fI\%\-\-sslClusterFile\fP and -\fI\%\-\-sslClusterCertificateSelector\fP options are mutually +\fBinternal x.509 membership authentication\f1\&. +.PP +\fB\-\-sslClusterFile\f1\f1 and +\fB\-\-sslClusterCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp -\fI\%\-\-sslClusterCertificateSelector\fP accepts an argument of the -format \fB<property>=<value>\fP where the property can be one of the +.PP +\fB\-\-sslClusterCertificateSelector\f1\f1 accepts an argument of the +format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp -The \fI\%mongod\fP searches the operating system\(aqs secure +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP +The \fBmongod\f1\f1 searches the operating system\(aqs secure certificate store for the CA certificates required to validate the full certificate chain of the specified cluster certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full -certificate chain to the cluster certificate. Do \fBnot\fP use -\fI\%\-\-sslCAFile\fP or \fI\%\-\-sslClusterCAFile\fP to specify the +certificate chain to the cluster certificate. Do \fBnot\f1 use +\fB\-\-sslCAFile\f1\f1 or \fB\-\-sslClusterCAFile\f1\f1 to specify the root and intermediate CA certificate. -.sp +.PP For example, if the cluster certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the cluster certificate was signed with an intermediate CA certificate, the secure certificate store must -contain the intermedia CA certificate \fIand\fP the root CA certificate. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterPassword <value> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterPassword\fP instead. - -.sp +contain the intermedia CA certificate \fIand\f1 the root CA certificate. +.RE +.PP +\fBmongod \-\-sslClusterPassword\f1 +.RS +.PP +Use \fB\-\-tlsClusterPassword\f1\f1 instead. +.PP Specifies the password to de\-crypt the x.509 certificate\-key file -specified with \fB\-\-sslClusterFile\fP\&. Use the \fI\%\-\-sslClusterPassword\fP option only -if the certificate\-key file is encrypted. In all cases, the \fBmongod\fP +specified with \fB\-\-sslClusterFile\f1\&. Use the \fB\-\-sslClusterPassword\f1\f1 option only +if the certificate\-key file is encrypted. In all cases, the \fBmongod\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the x.509 file is encrypted and -you do not specify the \fI\%\-\-sslClusterPassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-sslClusterPassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS, if the private key in the x.509 file is encrypted, you -must explicitly specify the \fI\%\-\-sslClusterPassword\fP option. +must explicitly specify the \fB\-\-sslClusterPassword\f1\f1 option. Alternatively, you can either use a certificate from the secure -system store (see \fI\%\-\-sslClusterCertificateSelector\fP) +system store (see \fB\-\-sslClusterCertificateSelector\f1\f1) instead of a cluster PEM file or use an unencrypted PEM file. .IP \(bu 2 On Windows, MongoDB does not support encrypted certificates. -The \fI\%mongod\fP fails if it encounters an encrypted -PEM file. Use \fI\%\-\-sslClusterCertificateSelector\fP instead. -.UNINDENT -.sp +The \fBmongod\f1\f1 fails if it encounters an encrypted +PEM file. Use \fB\-\-sslClusterCertificateSelector\f1\f1 instead. +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCAFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCAFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslCAFile\f1 +.RS +.PP +Use \fB\-\-tlsCAFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the -\fB\&.pem\fP file using relative or absolute paths. -.INDENT 7.0 -.TP -.B Windows/macOS Only -If using \fI\%\-\-sslCertificateSelector\fP and/or -\fI\%\-\-sslClusterCertificateSelector\fP, do \fBnot\fP use -\fI\%\-\-sslCAFile\fP to specify the root and intermediate CA +\&.pem file using relative or absolute paths. +.PP +\fBWindows/macOS Only\f1 +.RS +.PP +If using \fB\-\-sslCertificateSelector\f1\f1 and/or +\fB\-\-sslClusterCertificateSelector\f1\f1, do \fBnot\f1 use +\fB\-\-sslCAFile\f1\f1 to specify the root and intermediate CA certificates. Store all CA certificates required to validate the -full trust chain of the \fI\%\-\-sslCertificateSelector\fP and/or -\fI\%\-\-sslClusterCertificateSelector\fP certificates in the +full trust chain of the \fB\-\-sslCertificateSelector\f1\f1 and/or +\fB\-\-sslClusterCertificateSelector\f1\f1 certificates in the secure certificate store. -.UNINDENT -.sp +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterCAFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterCAFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslClusterCAFile\f1 +.RS +.PP +Use \fB\-\-tlsClusterCAFile\f1\f1 +instead. +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate presented by a client establishing a connection. Specify the file -name of the \fB\&.pem\fP file using relative or absolute paths. -\fI\%\-\-sslClusterCAFile\fP requires that -\fI\%\-\-sslCAFile\fP is set. -.sp -If \fI\%\-\-sslClusterCAFile\fP does not specify the \fB\&.pem\fP +name of the \&.pem file using relative or absolute paths. +\fB\-\-sslClusterCAFile\f1\f1 requires that +\fB\-\-sslCAFile\f1\f1 is set. +.PP +If \fB\-\-sslClusterCAFile\f1\f1 does not specify the \&.pem file for validating the certificate from a client establishing a -connection, the cluster uses the \fB\&.pem\fP file specified in the -\fI\%\-\-sslCAFile\fP option. -.sp -\fI\%\-\-sslClusterCAFile\fP lets you use separate Certificate +connection, the cluster uses the \&.pem file specified in the +\fB\-\-sslCAFile\f1\f1 option. +.PP +\fB\-\-sslClusterCAFile\f1\f1 lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake. -.INDENT 7.0 -.TP -.B Windows/macOS Only -If using \fI\%\-\-sslCertificateSelector\fP and/or -\fI\%\-\-sslClusterCertificateSelector\fP, do \fBnot\fP use -\fI\%\-\-sslClusterCAFile\fP to specify the root and +.PP +\fBWindows/macOS Only\f1 +.RS +.PP +If using \fB\-\-sslCertificateSelector\f1\f1 and/or +\fB\-\-sslClusterCertificateSelector\f1\f1, do \fBnot\f1 use +\fB\-\-sslClusterCAFile\f1\f1 to specify the root and intermediate CA certificates. Store all CA certificates required to validate the full trust chain of the -\fI\%\-\-sslCertificateSelector\fP and/or -\fI\%\-\-sslClusterCertificateSelector\fP certificates in the +\fB\-\-sslCertificateSelector\f1\f1 and/or +\fB\-\-sslClusterCertificateSelector\f1\f1 certificates in the secure certificate store. -.UNINDENT -.sp +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCRLFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCRLFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslCRLFile\f1 +.RS +.PP +Use \fB\-\-tlsCRLFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +.RS .IP \(bu 2 Starting in MongoDB 4.0, you cannot specify a CRL file on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (Online Certificate Status Protocol) to validate the revocation status of certificates. See -\fI\%\-\-sslCertificateSelector\fP in MongoDB 4.0 and -\fI\%\-\-tlsCertificateSelector\fP in MongoDB 4.2+ to use the +\fB\-\-sslCertificateSelector\f1\f1 in MongoDB 4.0 and +\fB\-\-tlsCertificateSelector\f1\f1 in MongoDB 4.2+ to use the system SSL certificate store. .IP \(bu 2 Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidCertificates -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidCertificates\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslAllowInvalidCertificates\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidCertificates\f1\f1 instead. +.PP Bypasses the validation checks for TLS/SSL certificates on other servers in the cluster and allows the use of invalid certificates to connect. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.0, if you specify -\fB\-\-sslAllowInvalidCertificates\fP or -\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the -alias \fB\-\-tlsAllowInvalidateCertificates\fP or -\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509 +.PP +Starting in MongoDB 4.2, if you specify +\fB\-\-tlsAllowInvalidateCertificates\f1 or +\fBnet.tls.allowInvalidCertificates: true\f1 when using x.509 authentication, an invalid certificate is only sufficient to -establish a TLS/SSL connection but is \fIinsufficient\fP for +establish a TLS connection but it is \fIinsufficient\f1 for authentication. -.UNINDENT -.UNINDENT -.sp +.PP When using -the \fI\%\-\-sslAllowInvalidCertificates\fP setting, MongoDB +the \fB\-\-sslAllowInvalidCertificates\f1\f1 setting, MongoDB logs a warning regarding the use of the invalid certificate. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidHostnames -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidHostnames\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslAllowInvalidHostnames\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidHostnames\f1\f1 instead. +.PP Disables the validation of the hostnames in TLS/SSL certificates, when connecting to other members of the replica set or sharded cluster -for inter\-process authentication. This allows \fBmongod\fP to connect +for inter\-process authentication. This allows \fBmongod\f1\f1 to connect to other members if the hostnames in their certificates do not match their configured hostname. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowConnectionsWithoutCertificates -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowConnectionsWithoutCertificates\fP instead. - -.sp -For clients that do not present certificates, \fBmongod\fP bypasses +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslAllowConnectionsWithoutCertificates\f1 +.RS +.PP +Use \fB\-\-tlsAllowConnectionsWithoutCertificates\f1\f1 instead. +.PP +For clients that do not present certificates, \fBmongod\f1\f1 bypasses TLS/SSL certificate validation when establishing the connection. -.sp -For clients that present a certificate, however, \fBmongod\fP performs +.PP +For clients that present a certificate, however, \fBmongod\f1\f1 performs certificate validation using the root certificate chain specified by -\fB\-\-sslCAFile\fP and reject clients with invalid certificates. -.sp -Use the \fI\%\-\-sslAllowConnectionsWithoutCertificates\fP option if you have a mixed deployment that includes -clients that do not or cannot present certificates to the \fBmongod\fP\&. -.sp +\fB\-\-sslCAFile\f1 and reject clients with invalid certificates. +.PP +Use the \fB\-\-sslAllowConnectionsWithoutCertificates\f1\f1 option if you have a mixed deployment that includes +clients that do not or cannot present certificates to the \fBmongod\f1\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslDisabledProtocols <protocol(s)> -Deprecated since version 4.2: Use \fI\%\-\-tlsDisabledProtocols\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-sslDisabledProtocols\f1 +.RS +.PP +Use \fB\-\-tlsDisabledProtocols\f1\f1 instead. +.PP Prevents a MongoDB server running with TLS/SSL from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols. -.sp -\fI\%\-\-sslDisabledProtocols\fP recognizes the following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, -\fBTLS1_2\fP, and starting in version 4.0.4 (and 3.6.9 and 3.4.24), \fBTLS1_3\fP\&. -.INDENT 7.0 +.PP +\fB\-\-sslDisabledProtocols\f1\f1 recognizes the following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, +\fBTLS1_2\f1, and starting in version 4.0.4 (and 3.6.9 and 3.4.24), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must disable at least one of the other -two, for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must disable at least one of the other +two, for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 Specifying an unrecognized protocol will prevent the server from starting. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, -specify \fBnone\fP to \fI\%\-\-sslDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.sp +specify \fBnone\f1 to \fB\-\-sslDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.PP Members of replica sets and sharded clusters must speak at least one protocol in common. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -ssl\-disallow\-protocols -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslFIPSMode -Deprecated since version 4.2: Use \fI\%\-\-tlsFIPSMode\fP instead. - -.sp -Directs the \fBmongod\fP to use the FIPS mode of the TLS/SSL +.PP +\fBDisallow Protocols\f1 +.RE +.PP +\fBmongod \-\-sslFIPSMode\f1 +.RS +.PP +Use \fB\-\-tlsFIPSMode\f1\f1 instead. +.PP +Directs the \fBmongod\f1\f1 to use the FIPS mode of the TLS/SSL library. Your system must have a FIPS -compliant library to use the \fI\%\-\-sslFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +compliant library to use the \fB\-\-sslFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Profiler Options -.INDENT 0.0 -.TP -.B \-\-profile <level> -\fIDefault\fP: 0 -.sp -Configures the database profiler level. +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.SS PROFILER OPTIONS +.PP +\fBmongod \-\-profile\f1 +.RS +.PP +\fIDefault\f1: 0 +.PP +Configures the \fBdatabase profiler\f1 level. The following profiler levels are available: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Level -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB0\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB0\f1 +.IP \(bu 4 The profiler is off and does not collect any data. This is the default profiler level. -T} -_ -T{ -\fB1\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB1\f1 +.IP \(bu 4 The profiler collects data for operations that take longer -than the value of \fBslowms\fP\&. -T} -_ -T{ -\fB2\fP -T} T{ +than the value of \fBslowms\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB2\f1 +.IP \(bu 4 The profiler collects data for all operations. -T} -_ -.TE -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.RE +.PP Profiling can impact performance and shares settings with the system log. Carefully consider any performance and security implications before configuring and enabling the profiler on a production deployment. -.sp -See database\-profiling\-overhead for more information on +.PP +See \fBProfiler Overhead\f1 for more information on potential performance degradation. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-slowms <integer> -\fIDefault\fP: 100 -.sp -The \fIslow\fP operation time threshold, in milliseconds. Operations -that run for longer than this threshold are considered \fIslow\fP\&. -.sp -When \fBlogLevel\fP is set to \fB0\fP, MongoDB records \fIslow\fP +.RE +.PP +\fBmongod \-\-slowms\f1 +.RS +.PP +\fIDefault\f1: 100 +.PP +The \fIslow\f1 operation time threshold, in milliseconds. Operations +that run for longer than this threshold are considered \fIslow\f1\&. +.PP +When \fBlogLevel\f1\f1 is set to \fB0\f1, MongoDB records \fIslow\f1 operations to the diagnostic log at a rate determined by -\fBslowOpSampleRate\fP\&. Starting in MongoDB -4.2, the secondaries of replica sets log all oplog entry messages -that take longer than the slow operation threshold to apply regardless of the sample rate. -.sp -At higher \fBlogLevel\fP settings, all operations appear in +\fBslowOpSampleRate\f1\f1\&. Starting in MongoDB +4.2, the secondaries of replica sets log \fBall oplog entry messages +that take longer than the slow operation threshold to apply\f1 regardless of the sample rate. +.PP +At higher \fBlogLevel\f1\f1 settings, all operations appear in the diagnostic log regardless of their latency with the following -exception: the logging of slow oplog entry messages by the -secondaries\&. The secondaries log only the slow oplog -entries; increasing the \fBlogLevel\fP does not log all +exception: the logging of \fBslow oplog entry messages by the +secondaries\f1\&. The secondaries log only the slow oplog +entries; increasing the \fBlogLevel\f1\f1 does not log all oplog entries. -.sp -For \fI\%mongod\fP instances, \fI\%\-\-slowms\fP affects the diagnostic log +.PP +For \fBmongod\f1\f1 instances, \fB\-\-slowms\f1\f1 affects the diagnostic log and, if enabled, the profiler. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -/tutorial/manage\-the\-database\-profiler -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-slowOpSampleRate <double> -\fIDefault\fP: 1.0 -.sp -The fraction of \fIslow\fP operations that should be profiled or logged. -\fI\%\-\-slowOpSampleRate\fP accepts values between 0 and 1, inclusive. -.sp -\fI\%\-\-slowOpSampleRate\fP does not affect the slow oplog entry logging by the secondary members of a replica set. Secondary +.PP +\fBDatabase Profiler\f1 +.RE +.PP +\fBmongod \-\-slowOpSampleRate\f1 +.RS +.PP +\fIDefault\f1: 1.0 +.PP +The fraction of \fIslow\f1 operations that should be profiled or logged. +\fB\-\-slowOpSampleRate\f1\f1 accepts values between 0 and 1, inclusive. +.PP +\fB\-\-slowOpSampleRate\f1\f1 does not affect the \fBslow oplog entry logging\f1 by the secondary members of a replica set. Secondary members log all oplog entries that take longer than the slow -operation threshold regardless of the \fI\%\-\-slowOpSampleRate\fP\&. -.sp -For \fI\%mongod\fP instances, \fI\%\-\-slowOpSampleRate\fP affects the +operation threshold regardless of the \fB\-\-slowOpSampleRate\f1\f1\&. +.PP +For \fBmongod\f1\f1 instances, \fB\-\-slowOpSampleRate\f1\f1 affects the diagnostic log and, if enabled, the profiler. -.UNINDENT -.SS Audit Options -.INDENT 0.0 -.TP -.B \-\-auditDestination -Enables auditing and specifies where -\fBmongod\fP sends all audit events. -.sp -\fI\%\-\-auditDestination\fP can have one of the following values: -.TS -center; -|l|l|. -_ -T{ +.RE +.SS AUDIT OPTIONS +.PP +\fBmongod \-\-auditDestination\f1 +.RS +.PP +Enables \fBauditing\f1 and specifies where +\fBmongod\f1\f1 sends all audit events. +.PP +\fB\-\-auditDestination\f1\f1 can have one of the following values: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsyslog\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsyslog\f1 +.IP \(bu 4 Output the audit events to syslog in JSON format. Not available on -Windows. Audit messages have a syslog severity level of \fBinfo\fP -and a facility level of \fBuser\fP\&. -.sp +Windows. Audit messages have a syslog severity level of \fBinfo\f1 +and a facility level of \fBuser\f1\&. +.IP The syslog message limit can result in the truncation of audit messages. The auditing system will neither detect the truncation nor error upon its occurrence. -T} -_ -T{ -\fBconsole\fP -T} T{ -Output the audit events to \fBstdout\fP in JSON format. -T} -_ -T{ -\fBfile\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBconsole\f1 +.IP \(bu 4 +Output the audit events to \fBstdout\f1 in JSON format. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBfile\f1 +.IP \(bu 4 Output the audit events to the file specified in -\fI\%\-\-auditPath\fP in the format specified in -\fI\%\-\-auditFormat\fP\&. -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auditFormat -Specifies the format of the output file for auditing if \fI\%\-\-auditDestination\fP is \fBfile\fP\&. The -\fI\%\-\-auditFormat\fP option can have one of the following values: -.TS -center; -|l|l|. -_ -T{ +\fB\-\-auditPath\f1\f1 in the format specified in +\fB\-\-auditFormat\f1\f1\&. +.RE +.RE +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.PP +\fBmongod \-\-auditFormat\f1 +.RS +.PP +Specifies the format of the output file for \fBauditing\f1 if \fB\-\-auditDestination\f1\f1 is \fBfile\f1\&. The +\fB\-\-auditFormat\f1\f1 option can have one of the following values: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBJSON\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBJSON\f1 +.IP \(bu 4 Output the audit events in JSON format to the file specified -in \fI\%\-\-auditPath\fP\&. -T} -_ -T{ -\fBBSON\fP -T} T{ +in \fB\-\-auditPath\f1\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBBSON\f1 +.IP \(bu 4 Output the audit events in BSON binary format to the file -specified in \fI\%\-\-auditPath\fP\&. -T} -_ -.TE -.sp +specified in \fB\-\-auditPath\f1\f1\&. +.RE +.RE +.PP Printing audit events to a file in JSON format degrades server performance more than printing to a file in BSON format. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auditPath -Specifies the output file for auditing if -\fI\%\-\-auditDestination\fP has value of \fBfile\fP\&. The \fI\%\-\-auditPath\fP +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.PP +\fBmongod \-\-auditPath\f1 +.RS +.PP +Specifies the output file for \fBauditing\f1 if +\fB\-\-auditDestination\f1\f1 has value of \fBfile\f1\&. The \fB\-\-auditPath\f1\f1 option can take either a full path name or a relative path name. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auditFilter -Specifies the filter to limit the types of operations the audit system records. The option takes a string representation +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.PP +\fBmongod \-\-auditFilter\f1 +.RS +.PP +Specifies the filter to limit the \fBtypes of operations\f1 the \fBaudit system\f1 records. The option takes a string representation of a query document of the form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ <field1>: <expression1>, ... } -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fB<field>\fP can be any field in the audit message, including fields returned in the -param document. The -\fB<expression>\fP is a query condition expression\&. -.sp +.PP +.EX + { <field1>: <expression1>, ... } +.EE +.PP +The \fB<field>\f1 can be \fBany field in the audit message\f1, including fields returned in the +\fBparam\f1 document. The +\fB<expression>\f1 is a \fBquery condition expression\f1\&. +.PP To specify an audit filter, enclose the filter document in single quotes to pass the document as a string. -.sp -To specify the audit filter in a configuration file, you must use the YAML format of +.PP +To specify the audit filter in a \fBconfiguration file\f1, you must use the YAML format of the configuration file. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.SS SNMP Options -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -MongoDB Enterprise on macOS does \fInot\fP include support for SNMP due -to \fI\%SERVER\-29352\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-snmp\-disabled -Disables SNMP access to \fI\%mongod\fP\&. The option is incompatible -with \fI\%\-\-snmp\-subagent\fP and \fI\%\-\-snmp\-master\fP\&. -.sp -New in version 4.0.6. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-snmp\-subagent -Runs SNMP as a subagent. The option is incompatible with \fI\%\-\-snmp\-disabled\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-snmp\-master -Runs SNMP as a master. The option is incompatible with \fI\%\-\-snmp\-disabled\fP\&. -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -/tutorial/monitor\-with\-snmp -.IP \(bu 2 -/tutorial/monitor\-with\-snmp\-on\-windows -.IP \(bu 2 -/tutorial/troubleshoot\-snmp -.UNINDENT -.UNINDENT -.UNINDENT -.SS inMemory Options -.INDENT 0.0 -.TP -.B \-\-inMemorySizeGB <float> -\fIDefault\fP: 50% of physical RAM less 1 GB -.sp -Changed in version 3.4: Values can range from 256MB to 10TB and can be a float. - -.sp -Maximum amount of memory to allocate for in\-memory storage -engine data, including indexes, oplog if the -\fI\%mongod\fP is part of replica set, replica set or sharded +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.SS SNMP OPTIONS +.PP +MongoDB Enterprise on macOS does \fInot\f1 include support for SNMP due +to SERVER\-29352 (https://jira.mongodb.org/browse/SERVER\-29352)\&. +.PP +\fBmongod \-\-snmp\-disabled\f1 +.RS +.PP +Disables SNMP access to \fBmongod\f1\f1\&. The option is incompatible +with \fB\-\-snmp\-subagent\f1\f1 and \fB\-\-snmp\-master\f1\f1\&. +.RE +.PP +\fBmongod \-\-snmp\-subagent\f1 +.RS +.PP +Runs SNMP as a subagent. The option is incompatible with \fB\-\-snmp\-disabled\f1\f1\&. +.RE +.PP +\fBmongod \-\-snmp\-master\f1 +.RS +.PP +Runs SNMP as a master. The option is incompatible with \fB\-\-snmp\-disabled\f1\f1\&. +.RE +.RS +.IP \(bu 2 +\fBMonitor MongoDB With SNMP on Linux\f1 +.IP \(bu 2 +\fBMonitor MongoDB Windows with SNMP\f1 +.IP \(bu 2 +\fBTroubleshoot SNMP\f1 +.RE +.SS INMEMORY OPTIONS +.PP +\fBmongod \-\-inMemorySizeGB\f1 +.RS +.PP +\fIDefault\f1: 50% of physical RAM less 1 GB +.PP +Values can range from 256MB to 10TB and can be a float. +.PP +Maximum amount of memory to allocate for \fBin\-memory storage +engine\f1 data, including indexes, oplog if the +\fBmongod\f1\f1 is part of replica set, replica set or sharded cluster metadata, etc. -.sp +.PP By default, the in\-memory storage engine uses 50% of physical RAM minus 1 GB. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Encryption Key Management Options -.INDENT 0.0 -.TP -.B \-\-enableEncryption <boolean> -\fIDefault\fP: false -.sp -New in version 3.2. - -.sp -Enables encryption for the WiredTiger storage engine. You must set -to \fBtrue\fP to pass in encryption keys and configurations. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.RE +.SS ENCRYPTION KEY MANAGEMENT OPTIONS +.PP +\fBmongod \-\-enableEncryption\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Enables encryption for the WiredTiger storage engine. This option +must be enabled in order to pass in encryption keys and +configurations. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-encryptionCipherMode <string> -\fIDefault\fP: AES256\-CBC -.sp -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-encryptionCipherMode\f1 +.RS +.PP +\fIDefault\f1: AES256\-CBC +.PP The cipher mode to use for encryption at rest: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Mode -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBAES256\-CBC\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBAES256\-CBC\f1 +.IP \(bu 4 256\-bit Advanced Encryption Standard in Cipher Block Chaining Mode -T} -_ -T{ -\fBAES256\-GCM\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBAES256\-GCM\f1 +.IP \(bu 4 256\-bit Advanced Encryption Standard in Galois/Counter Mode -.sp -Changed in version 4.0: MongoDB Enterprise on Windows no longer supports \fBAES256\-GCM\fP\&. This +.IP +MongoDB Enterprise on Windows no longer supports \fBAES256\-GCM\f1\&. This cipher is now available only on Linux. -T} -_ -.TE -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.RE +.RE +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-encryptionKeyFile <string> -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-encryptionKeyFile\f1 +.RS +.PP The path to the local keyfile when managing keys via process \fIother -than\fP KMIP. Only set when managing keys via process other than KMIP. +than\f1 KMIP. Only set when managing keys via process other than KMIP. If data is already encrypted using KMIP, MongoDB will throw an error. -.sp +.PP The keyfile can contain only a single key. The key is either a 16 or 32 character string. -.sp -Requires \fBenableEncryption\fP to be \fBtrue\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP +Requires \fB\-\-enableEncryption\f1\f1\&. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipKeyIdentifier <string> -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-kmipKeyIdentifier\f1 +.RS +.PP Unique KMIP identifier for an existing key within the KMIP server. Include to use the key associated with the identifier as the system key. You can only use the setting the first time you enable -encryption for the \fI\%mongod\fP instance. Requires -\fBenableEncryption\fP to be true. -.sp +encryption for the \fBmongod\f1\f1 instance. Requires +\fB\-\-enableEncryption\f1\f1\&. +.PP If unspecified, MongoDB will request that the KMIP server create a new key to utilize as the system key. -.sp +.PP If the KMIP server cannot locate a key with the specified identifier or the data is already encrypted with a key, MongoDB will throw an error -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipRotateMasterKey <boolean> -\fIDefault\fP: false -.sp -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-kmipRotateMasterKey\f1 +.RS +.PP +\fIDefault\f1: false +.PP If true, rotate the master key and re\-encrypt the internal keystore. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -kmip\-master\-key\-rotation -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipServerName <string> -New in version 3.2. - -.sp +.PP +\fBKMIP Master Key Rotation\f1 +.RE +.PP +\fBmongod \-\-kmipServerName\f1 +.RS +.PP Hostname or IP address of the KMIP server to connect to. Requires -\fI\%\-\-enableEncryption\fP to be true. -.sp +\fB\-\-enableEncryption\f1\f1\&. +.PP Starting in MongoDB 4.2.1 (and 4.0.14), you can specify multiple KMIP servers as a comma\-separated list, e.g. -\fBserver1.example.com,server2.example.com\fP\&. On startup, the -\fI\%mongod\fP will attempt to establish a connection to each +\fBserver1.example.com,server2.example.com\f1\&. On startup, the +\fBmongod\f1\f1 will attempt to establish a connection to each server in the order listed, and will select the first server to which it can successfully establish a connection. KMIP server selection occurs only at startup. -.sp -When connecting to a KMIP server, the \fI\%mongod\fP -verifies that the specified \fI\%\-\-kmipServerName\fP matches the -Subject Alternative Name \fBSAN\fP (or, if \fBSAN\fP is not present, the -Common Name \fBCN\fP) in the certificate presented by the KMIP server. -If \fBSAN\fP is present, \fI\%mongod\fP does not match against -the \fBCN\fP\&. If the hostname does not match the \fBSAN\fP (or \fBCN\fP), -the \fI\%mongod\fP will fail to connect. -.sp +.PP +When connecting to a KMIP server, the \fBmongod\f1\f1 +verifies that the specified \fB\-\-kmipServerName\f1\f1 matches the +Subject Alternative Name \fBSAN\f1 (or, if \fBSAN\f1 is not present, the +Common Name \fBCN\f1) in the certificate presented by the KMIP server. +If \fBSAN\f1 is present, \fBmongod\f1\f1 does not match against +the \fBCN\f1\&. If the hostname does not match the \fBSAN\f1 (or \fBCN\f1), +the \fBmongod\f1\f1 will fail to connect. +.PP Starting in MongoDB 4.2, when performing comparison of SAN, MongoDB supports comparison of DNS names or IP addresses. In previous versions, MongoDB only supports comparisons of DNS names. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipPort <number> -\fIDefault\fP: 5696 -.sp -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-kmipPort\f1 +.RS +.PP +\fIDefault\f1: 5696 +.PP Port number to use to communicate with the KMIP server. -Requires \fI\%\-\-kmipServerName\fP\&. Requires -\fI\%\-\-enableEncryption\fP to be true. -.sp -If specifying multiple KMIP servers with \fI\%\-\-kmipServerName\fP, -the \fI\%mongod\fP will use the port specified with -\fI\%\-\-kmipPort\fP for all provided KMIP servers. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +Requires \fB\-\-kmipServerName\f1\f1\&. Requires +\fB\-\-enableEncryption\f1\f1\&. +.PP +If specifying multiple KMIP servers with \fB\-\-kmipServerName\f1\f1, +the \fBmongod\f1\f1 will use the port specified with +\fB\-\-kmipPort\f1\f1 for all provided KMIP servers. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipConnectRetries <number> -\fIDefault\fP: 0 -.sp -New in version 4.4. - -.sp +.RE +.PP +\fBmongod \-\-kmipConnectRetries\f1 +.RS +.PP +\fIDefault\f1: 0 +.PP How many times to retry the initial connection to the KMIP server. -Use together with \fI\%\-\-kmipConnectTimeoutMS\fP to -control how long the \fI\%mongod\fP waits for a response +Use together with \fB\-\-kmipConnectTimeoutMS\f1\f1 to +control how long the \fBmongod\f1\f1 waits for a response between each retry. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipConnectTimeoutMS <number> -\fIDefault\fP: 5000 -.sp -New in version 4.4. - -.sp +.RE +.PP +\fBmongod \-\-kmipConnectTimeoutMS\f1 +.RS +.PP +\fIDefault\f1: 5000 +.PP Timeout in milliseconds to wait for a response from the KMIP server. -If the \fI\%\-\-kmipConnectRetries\fP setting is specified, -the \fI\%mongod\fP will wait up to the value specified with -\fI\%\-\-kmipConnectTimeoutMS\fP for each retry. -.sp -Value must be \fB1000\fP or greater. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +If the \fB\-\-kmipConnectRetries\f1\f1 setting is specified, +the \fBmongod\f1\f1 will wait up to the value specified with +\fB\-\-kmipConnectTimeoutMS\f1\f1 for each retry. +.PP +Value must be \fB1000\f1 or greater. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipClientCertificateSelector <string> -New in version 4.0: Available on Windows and macOS as an alternative to -\fI\%\-\-kmipClientCertificateFile\fP\&. -.sp -\fI\%\-\-kmipClientCertificateFile\fP and \fI\%\-\-kmipClientCertificateSelector\fP options are mutually exclusive. You can only +.RE +.PP +\fBmongod \-\-kmipClientCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to +\fB\-\-kmipClientCertificateFile\f1\f1\&. +.PP +\fB\-\-kmipClientCertificateFile\f1\f1 and \fB\-\-kmipClientCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store to authenticate MongoDB to the KMIP server. -.sp -\fI\%\-\-kmipClientCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-kmipClientCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipClientCertificateFile <string> -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-kmipClientCertificateFile\f1 +.RS +.PP String containing the path to the client certificate used for authenticating MongoDB to the KMIP server. Requires that a -\fBkmipServerName\fP be provided. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fB\-\-kmipServerName\f1\f1 be provided. +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key -file. See \fI\%\-\-kmipClientCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +file. See \fB\-\-kmipClientCertificateSelector\f1\f1\&. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipClientCertificatePassword <string> -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-kmipClientCertificatePassword\f1 +.RS +.PP The password (if one exists) for the client certificate passed into -\fBkmipClientCertificateFile\fP\&. Is used for +\fB\-\-kmipClientCertificateFile\f1\f1\&. Is used for authenticating MongoDB to the KMIP server. Requires that a -\fBkmipClientCertificateFile\fP be provided. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +\fB\-\-kmipClientCertificateFile\f1\f1 be provided. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-kmipServerCAFile <string> -New in version 3.2. - -.sp +.RE +.PP +\fBmongod \-\-kmipServerCAFile\f1 +.RS +.PP Path to CA File. Used for validating secure client connection to KMIP server. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key -file. See \fI\%\-\-kmipClientCertificateSelector\fP\&. When using the secure store, you do not -need to, but can, also specify the \fI\%\-\-kmipServerCAFile\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-eseDatabaseKeyRollover -New in version 4.2. - -.sp -Roll over the encrypted storage engine database keys configured with -\fBAES256\-GCM\fP cipher. -.sp -When \fI\%mongod\fP instance is started with this option, the +file. See \fB\-\-kmipClientCertificateSelector\f1\f1\&. When using the secure store, you do not +need to, but can, also specify the \fB\-\-kmipServerCAFile\f1\f1\&. +.RE +.PP +\fBmongod \-\-eseDatabaseKeyRollover\f1 +.RS +.PP +Roll over the \fBencrypted storage engine\f1 database keys configured with +\fBAES256\-GCM\f1 cipher. +.PP +When \fBmongod\f1\f1 instance is started with this option, the instance rotates the keys and exits. -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +.RE diff --git a/debian/mongodb-parameters.5 b/debian/mongodb-parameters.5 index 14cc41b7eb3..bc12365dfd0 100644 --- a/debian/mongodb-parameters.5 +++ b/debian/mongodb-parameters.5 @@ -1,1008 +1,921 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGODB-PARAMETERS" "5" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongodb-parameters \- MongoDB setParameter Options -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Parameters\fP -.INDENT 2.0 -.IP \(bu 2 -\fI\%Authentication Parameters\fP -.IP \(bu 2 -\fI\%General Parameters\fP -.IP \(bu 2 -\fI\%Logging Parameters\fP -.IP \(bu 2 -\fI\%Diagnostic Parameters\fP -.IP \(bu 2 -\fI\%Logical Session Parameters\fP -.IP \(bu 2 -\fI\%Replication Parameters\fP -.IP \(bu 2 -\fI\%Sharding Parameters\fP -.IP \(bu 2 -\fI\%Storage Parameters\fP -.IP \(bu 2 -\fI\%WiredTiger Parameters\fP -.IP \(bu 2 -\fI\%Auditing Parameters\fP -.IP \(bu 2 -\fI\%Transaction Parameters\fP -.UNINDENT -.UNINDENT +.TH mongodb-parameters 5 +.SH MONGODB SERVER PARAMETERS .SH SYNOPSIS -.sp MongoDB provides a number of configuration options that you can set using: -.INDENT 0.0 -.IP \(bu 2 -the \fBsetParameter\fP command: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, <parameter>: <value> } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.IP \(bu 2 -the \fBsetParameter\fP configuration setting: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -setParameter: - <parameter1>: <value1> - ... -.ft P -.fi -.UNINDENT -.UNINDENT -.IP \(bu 2 -the \fB\-\-setParameter\fP command\-line option for \fBmongod\fP -and \fBmongos\fP: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter <parameter>=<value> -mongos \-\-setParameter <parameter>=<value> -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.sp +.RS +.IP \(bu 2 +the \fBsetParameter\f1\f1 command: +.IP +.EX + db.adminCommand( { setParameter: 1, <parameter>: <value> } ) +.EE +.IP \(bu 2 +the \fBsetParameter\f1\f1 configuration setting: +.IP +.EX + setParameter: + <parameter1>: <value1> + ... +.EE +.IP \(bu 2 +the \fB\-\-setParameter\f1 command\-line option for \fBmongod\f1\f1 +and \fBmongos\f1\f1: +.IP +.EX + mongod \-\-setParameter <parameter>=<value> + mongos \-\-setParameter <parameter>=<value> +.EE +.RE +.PP For additional configuration options, see -/reference/configuration\-options, \fBmongod\fP and -\fBmongos\fP\&. +\fBConfiguration File Options\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1\&. .SH PARAMETERS -.SS Authentication Parameters -.INDENT 0.0 -.TP -.B authenticationMechanisms -Changed in version 4.0: Remove support for the deprecated \fBMONGODB\-CR\fP authentication mechanism. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.SS AUTHENTICATION PARAMETERS +.PP +\fBauthenticationMechanisms\f1 +.RS +.PP +Remove support for the deprecated \fBMONGODB\-CR\f1 authentication mechanism. +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Specifies the list of authentication mechanisms the server accepts. Set this to one or more of the following values. If you specify multiple values, use a comma\-separated list and no spaces. For descriptions -of the authentication mechanisms, see /core/authentication\&. -.TS -center; -|l|l|. -_ -T{ +of the authentication mechanisms, see \fBAuthentication\f1\&. +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -SCRAM\-SHA\-1 -T} T{ -\fI\%RFC 5802\fP standard +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBSCRAM\-SHA\-1\f1 +.IP \(bu 4 +RFC 5802 (https://tools.ietf.org/html/rfc5802) standard Salted Challenge Response Authentication Mechanism using the SHA\-1 hash function. -T} -_ -T{ -SCRAM\-SHA\-256 -T} T{ -\fI\%RFC 7677\fP standard +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBSCRAM\-SHA\-256\f1 +.IP \(bu 4 +RFC 7677 (https://tools.ietf.org/html/rfc7677) standard Salted Challenge Response Authentication Mechanism using the SHA\-256 hash function. -.sp -Requires featureCompatibilityVersion set to \fB4.0\fP\&. -.sp -New in version 4.0. -T} -_ -T{ -MONGODB\-X509 -T} T{ +.IP +Requires featureCompatibilityVersion set to \fB4.0\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBMONGODB\-X509\f1 +.IP \(bu 4 MongoDB TLS/SSL certificate authentication. -T} -_ -T{ -GSSAPI (Kerberos) -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBGSSAPI\f1 (Kerberos) +.IP \(bu 4 External authentication using Kerberos. This mechanism is -available only in \fI\%MongoDB Enterprise\fP\&. -T} -_ -T{ -PLAIN (LDAP SASL) -T} T{ -External authentication using LDAP. You can also use \fBPLAIN\fP -for authenticating in\-database users. \fBPLAIN\fP transmits +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBPLAIN\f1 (LDAP SASL) +.IP \(bu 4 +External authentication using LDAP. You can also use \fBPLAIN\f1 +for authenticating in\-database users. \fBPLAIN\f1 transmits passwords in plain text. This mechanism is available only in -\fI\%MongoDB Enterprise\fP\&. -T} -_ -.TE -.sp -You can only set \fI\%authenticationMechanisms\fP during +MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. +.RE +.RE +.PP +You can only set \fBauthenticationMechanisms\f1\f1 during start\-up. -.sp -For example, to specify both \fBPLAIN\fP and \fBSCRAM\-SHA\-256\fP as the +.PP +For example, to specify both \fBPLAIN\f1 and \fBSCRAM\-SHA\-256\f1 as the authentication mechanisms, use the following command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter authenticationMechanisms=PLAIN,SCRAM\-SHA\-256 \-\-auth -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B clusterAuthMode -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Set the \fBclusterAuthMode\fP to either \fBsendX509\fP or -\fBx509\fP\&. Useful during rolling upgrade to use x509 for -membership authentication +.PP +.EX + mongod \-\-setParameter authenticationMechanisms=PLAIN,SCRAM\-SHA\-256 \-\-auth +.EE +.RE +.PP +\fBclusterAuthMode\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Set the \fBclusterAuthMode\f1\f1 to either \fBsendX509\f1 or +\fBx509\f1\&. Useful during \fBrolling upgrade to use x509 for +membership authentication\f1 to minimize downtime. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, clusterAuthMode: "sendX509" } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B enableLocalhostAuthBypass -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Specify \fB0\fP or \fBfalse\fP to disable localhost authentication +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP +.EX + db.adminCommand( { setParameter: 1, clusterAuthMode: "sendX509" } ) +.EE +.RE +.PP +\fBenableLocalhostAuthBypass\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Specify \fB0\f1 or \fBfalse\f1 to disable localhost authentication bypass. Enabled by default. -.sp -\fI\%enableLocalhostAuthBypass\fP is not available using -\fBsetParameter\fP database command. Use the -\fBsetParameter\fP option in the configuration file or the -\fB\-\-setParameter\fP option on the +.PP +\fBenableLocalhostAuthBypass\f1\f1 is not available using +\fBsetParameter\f1\f1 database command. Use the +\fBsetParameter\f1\f1 option in the configuration file or the +\fB\-\-setParameter\f1\f1 option on the command line. -.sp -See localhost\-exception for more information. -.UNINDENT -.INDENT 0.0 -.TP -.B KeysRotationIntervalSec -New in version 3.6. - -.sp -\fIDefault\fP: 7776000 seconds (90 days) -.sp -Specifies the number of seconds for which an \fI\%HMAC signing key\fP +.PP +See \fBLocalhost Exception\f1 for more information. +.RE +.PP +\fBKeysRotationIntervalSec\f1 +.RS +.PP +\fIDefault\f1: 7776000 seconds (90 days) +.PP +Specifies the number of seconds for which an HMAC signing key (https://en.wikipedia.org/wiki/Hash\-based_message_authentication_code) is valid before rotating to the next one. This parameter is intended primarily to facilitate authentication testing. -.sp -You can only set \fI\%KeysRotationIntervalSec\fP during +.PP +You can only set \fBKeysRotationIntervalSec\f1\f1 during start\-up, and cannot change this setting with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapUserCacheInvalidationInterval +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapUserCacheInvalidationInterval\f1 +.RS +.PP For use with MongoDB deployments using -security\-ldap\-external\&. Available for \fBmongod\fP +\fBLDAP Authorization\f1\&. Available for \fBmongod\f1\f1 instances only. -.sp -The interval (in seconds) that the \fBmongod\fP instance +.PP +The interval (in seconds) that the \fBmongod\f1\f1 instance waits between external user cache flushes. After MongoDB flushes the external user cache, MongoDB reacquires authorization data from the LDAP server the next time an LDAP\-authorized user issues an operation. -.sp +.PP Increasing the value specified increases the amount of time MongoDB and the LDAP server can be out of sync, but reduces the load on the LDAP server. Conversely, decreasing the value specified decreases the time MongoDB and the LDAP server can be out of sync while increasing the load on the LDAP server. -.sp +.PP Defaults to 30 seconds. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapUseConnectionPool -New in version 4.0.9. - -.sp +.RE +.PP +\fBldapUseConnectionPool\f1 +.RS +.PP Specifies whether MongoDB should use connection pooling when connecting to the LDAP server for authentication/authorization. -.sp -\fBStarting in version 4.2\fP, MongoDB uses the following default values: -.INDENT 7.0 +.PP +\fBStarting in version 4.2\f1, MongoDB uses the following default values: +.RS .IP \(bu 2 true on Windows. .IP \(bu 2 true on Linux where MongoDB Enterprise binaries are linked against -\fBlibldap_r\fP\&. +\fBlibldap_r\f1\&. .IP \(bu 2 false on Linux where MongoDB Enterprise binaries are linked against -\fBlibldap\fP\&. -.UNINDENT -.sp -\fBIn earlier versions (versions 4.0.9+)\fP, the default value is -\fBfalse\fP\&. -.sp -You can only set \fI\%ldapUseConnectionPool\fP during +\fBlibldap\f1\&. +.RE +.PP +\fBIn earlier versions (versions 4.0.9+)\f1, the default value is +\fBfalse\f1\&. +.PP +You can only set \fBldapUseConnectionPool\f1\f1 during start\-up, and cannot change this setting with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapConnectionPoolUseLatencyForHostPriority -\fINew in version 4.2.1 and 4.0.13\fP -.sp -\fIDefault\fP: true -.sp +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapConnectionPoolUseLatencyForHostPriority\f1 +.RS +.PP +\fINew in version 4.2.1 and 4.0.13\f1 +.PP +\fIDefault\f1: true +.PP A boolean that determines whether the LDAP connection pool (see -\fI\%ldapUseConnectionPool\fP) should use latency of the LDAP +\fBldapUseConnectionPool\f1\f1) should use latency of the LDAP servers to determine the connection order (from lowest latency to highest). -.sp +.PP You can only set -\fI\%ldapConnectionPoolUseLatencyForHostPriority\fP during +\fBldapConnectionPoolUseLatencyForHostPriority\f1\f1 during start\-up, and cannot change this setting during runtime with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapConnectionPoolMinimumConnectionsPerHost -\fINew in version 4.2.1 and 4.0.13\fP -.sp -\fIDefault\fP: 1 -.sp +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapConnectionPoolMinimumConnectionsPerHost\f1 +.RS +.PP +\fINew in version 4.2.1 and 4.0.13\f1 +.PP +\fIDefault\f1: 1 +.PP The minimum number of connections to keep open to each LDAP server. -.sp +.PP You can only set -\fI\%ldapConnectionPoolMinimumConnectionsPerHost\fP during +\fBldapConnectionPoolMinimumConnectionsPerHost\f1\f1 during start\-up, and cannot change this setting during runtime with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapConnectionPoolMaximumConnectionsPerHost -\fINew in version 4.2.1 and 4.0.13\fP -.sp -\fIChanged in version 4.4\fP Changed default value to \fB2\fP\&. In previous +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapConnectionPoolMaximumConnectionsPerHost\f1 +.RS +.PP +\fINew in version 4.2.1 and 4.0.13\f1 +.PP +\fIChanged in version 4.4\f1 Changed default value to \fB2\f1\&. In previous versions, the default is unset. -.sp -\fIDefault\fP: 2 -.sp +.PP +\fIDefault\f1: 2 +.PP The maximum number of connections to keep open to each LDAP server. -.sp +.PP You can only set -\fI\%ldapConnectionPoolMaximumConnectionsPerHost\fP during +\fBldapConnectionPoolMaximumConnectionsPerHost\f1\f1 during start\-up, and cannot change this setting during runtime with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapConnectionPoolMaximumConnectionsInProgressPerHost -\fINew in version 4.2.1 and 4.0.13\fP -.sp +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapConnectionPoolMaximumConnectionsInProgressPerHost\f1 +.RS +.PP +\fINew in version 4.2.1 and 4.0.13\f1 +.PP The maximum number of in\-progress connect operations to each LDAP server. -.sp +.PP You can only set -\fI\%ldapConnectionPoolMaximumConnectionsInProgressPerHost\fP +\fBldapConnectionPoolMaximumConnectionsInProgressPerHost\f1\f1 during start\-up, and cannot change this setting with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapConnectionPoolHostRefreshIntervalMillis -\fINew in version 4.2.1 and 4.0.13\fP -.sp -\fIDefault\fP: 60000 -.sp +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapConnectionPoolHostRefreshIntervalMillis\f1 +.RS +.PP +\fINew in version 4.2.1 and 4.0.13\f1 +.PP +\fIDefault\f1: 60000 +.PP The number of milliseconds in\-between health checks of the pooled LDAP connections. -.sp +.PP You can only set -\fI\%ldapConnectionPoolHostRefreshIntervalMillis\fP during +\fBldapConnectionPoolHostRefreshIntervalMillis\f1\f1 during start\-up, and cannot change this setting with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ldapConnectionPoolIdleHostTimeoutSecs -\fINew in version 4.2.1 and 4.0.13\fP -.sp -\fIDefault\fP: 300 -.sp +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBldapConnectionPoolIdleHostTimeoutSecs\f1 +.RS +.PP +\fINew in version 4.2.1 and 4.0.13\f1 +.PP +\fIDefault\f1: 300 +.PP The maximum number of seconds that the pooled connections to an LDAP server can remain idle before being closed. -.sp +.PP You can only set -\fI\%ldapConnectionPoolIdleHostTimeoutSecs\fP during +\fBldapConnectionPoolIdleHostTimeoutSecs\f1\f1 during start\-up, and cannot change this setting with the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B ocspEnabled -New in version 4.4: Available on Linux and macOS. - -.sp -\fIDefault\fP: true -.sp +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBmaxValidateMemoryUsageMB\f1 +.RS +.PP +\fIDefault\f1: 200 +.PP +The maximum memory usage limit in megabytes for the +\fBvalidate\f1\f1 command. If the limit is exceeded, +\fBvalidate\f1\f1 returns as many results as possible and warns +that not all corruption might be reported because of the limit. +.PP +You can set \fBmaxValidateMemoryUsageMB\f1\f1 during startup, and +can change this setting using the \fBsetParameter\f1\f1 database +command. +.RE +.PP +\fBocspEnabled\f1 +.RS +.PP +Available on Linux and macOS. +.PP +\fIDefault\f1: true +.PP The flag that enables or disables OCSP. -.sp -You can only set \fI\%ocspEnabled\fP during startup in the -\fBconfiguration file\fP or with the -\fB\-\-setParameter\fP option on the command line. For example, the +.PP +You can only set \fBocspEnabled\f1\f1 during startup in the +\fBconfiguration file\f1\f1 or with the +\fB\-\-setParameter\f1 option on the command line. For example, the following disables OCSP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter ocspEnabled=false ... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%ocspValidationRefreshPeriodSecs\fP -.IP \(bu 2 -\fI\%tlsOCSPStaplingTimeoutSecs\fP -.IP \(bu 2 -\fI\%tlsOCSPVerifyTimeoutSecs\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ocspValidationRefreshPeriodSecs -New in version 4.4: Available on Linux. - -.sp +.PP +.EX + mongod \-\-setParameter ocspEnabled=false ... +.EE +.RS +.IP \(bu 2 +\fBocspValidationRefreshPeriodSecs\f1\f1 +.IP \(bu 2 +\fBtlsOCSPStaplingTimeoutSecs\f1\f1 +.IP \(bu 2 +\fBtlsOCSPVerifyTimeoutSecs\f1\f1 +.RE +.RE +.PP +\fBocspValidationRefreshPeriodSecs\f1 +.RS +.PP +Available on Linux. +.PP The number of seconds to wait before refreshing the stapled OCSP status response. Specify a number greater than or equal to 1. -.sp -You can only set \fI\%ocspValidationRefreshPeriodSecs\fP during -startup in the \fBconfiguration file\fP or with -the \fB\-\-setParameter\fP option on the command line. For example, the +.PP +You can only set \fBocspValidationRefreshPeriodSecs\f1\f1 during +startup in the \fBconfiguration file\f1\f1 or with +the \fB\-\-setParameter\f1 option on the command line. For example, the following sets the parameter to 3600 seconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter ocspValidationRefreshPeriodSecs=3600 ... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%ocspEnabled\fP -.IP \(bu 2 -\fI\%tlsOCSPStaplingTimeoutSecs\fP -.IP \(bu 2 -\fI\%tlsOCSPVerifyTimeoutSecs\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B opensslCipherConfig -New in version 3.6. - -.sp -Changed in version 4.0: With the use of native TLS/SSL libraries, the parameter -\fI\%opensslCipherConfig\fP is supported for Linux/BSD and -no longer supported in Windows and macOS. See MongoDB 4.0 -TLS/SSL\&. - -.sp +.PP +.EX + mongod \-\-setParameter ocspValidationRefreshPeriodSecs=3600 ... +.EE +.PP +Starting in MongoDB 5.0, the \fBrotateCertificates\f1\f1 command +and \fBdb.rotateCertificates()\f1\f1 method will also refresh any +stapled OCSP responses. +.RS +.IP \(bu 2 +\fBocspEnabled\f1\f1 +.IP \(bu 2 +\fBtlsOCSPStaplingTimeoutSecs\f1\f1 +.IP \(bu 2 +\fBtlsOCSPVerifyTimeoutSecs\f1\f1 +.RE +.RE +.PP +\fBopensslCipherConfig\f1 +.RS +.PP +\fIAvailable on Linux only\f1 +.PP +With the use of native TLS/SSL libraries, the parameter +\fBopensslCipherConfig\f1\f1 is supported for Linux/BSD and +no longer supported in Windows and macOS. See \fBMongoDB 4.0 +TLS/SSL\f1\&. +.PP Specify the cipher string for OpenSSL when using TLS/SSL encryption. For a list of cipher strings, see -\fI\%https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER\-STRINGS\fP -.sp -You can only set \fI\%opensslCipherConfig\fP during start\-up, and -cannot change this setting using the \fBsetParameter\fP +https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER\-STRINGS (https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER\-STRINGS)\&. +Multiple cipher strings can be provided as a colon\-separated list. +.PP +This parameter is only for use with TLS 1.2 or earlier. To specify +cipher suites for use with TLS 1.3, use the +\fBopensslCipherSuiteConfig\f1\f1 parameter. +.PP +You can only set \fBopensslCipherConfig\f1\f1 during start\-up, +and cannot change this setting using the \fBsetParameter\f1\f1 database command. -.sp -For version 4.2 and greater, the use of \fBTLS\fP options is preferred -over \fBSSL\fP options. The TLS options have the same functionality as -the \fBSSL\fP options. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter opensslCipherConfig=\(aqHIGH:!EXPORT:!aNULL@STRENGTH\(aq \-\-tlsMode requireTLS \-\-tlsCertificateKeyFile Certs/server.pem -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +For version 4.2 and greater, the use of \fBTLS\f1 options is preferred +over \fBSSL\f1 options. The TLS options have the same functionality as +the \fBSSL\f1 options. For example, the following configures a +\fBmongod\f1\f1 with a \fBopensslCipherConfig\f1\f1 +cipher string of \fB\(aqHIGH:!EXPORT:!aNULL@STRENGTH\(aq\f1 in MongoDB 4.2: +.PP +.EX + mongod \-\-setParameter opensslCipherConfig=\(aqHIGH:!EXPORT:!aNULL@STRENGTH\(aq \-\-tlsMode requireTLS \-\-tlsCertificateKeyFile Certs/server.pem +.EE +.PP For versions 4.0 and earlier: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter opensslCipherConfig=\(aqHIGH:!EXPORT:!aNULL@STRENGTH\(aq \-\-sslMode requireSSL \-\-sslPEMKeyFile Certs/server.pem -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B opensslDiffieHellmanParameters -New in version 3.6. - -.sp -\fIAvailable on Linux only\fP -.sp +.PP +.EX + mongod \-\-setParameter opensslCipherConfig=\(aqHIGH:!EXPORT:!aNULL@STRENGTH\(aq \-\-sslMode requireSSL \-\-sslPEMKeyFile Certs/server.pem +.EE +.RE +.PP +\fBopensslCipherSuiteConfig\f1 +.RS +.PP +\fIAvailable on Linux only\f1 +.PP +Specify the list of supported cipher suites OpenSSL should permit +when using TLS 1.3 encryption. +.PP +For a list of cipher suites for use with TLS 1.3, see +https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_cipher_list.html (https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_cipher_list.html)\&. +Multiple cipher suites can be provided as a colon\-separated list. +.PP +This parameter is only for use with TLS 1.3. To specify cipher +strings for use with TLS 1.2 or earlier, use the +\fBopensslCipherConfig\f1\f1 parameter. +.PP +You can only set \fBopensslCipherSuiteConfig\f1\f1 during +start\-up, and cannot change this setting using the +\fBsetParameter\f1\f1 database command. For example, the +following configures a \fBmongod\f1\f1 with a +\fBopensslCipherSuiteConfig\f1\f1 cipher suite of +\fB\(aqTLS_AES_256_GCM_SHA384\(aq\f1 for use with TLS 1.3: +.PP +.EX + mongod \-\-setParameter opensslCipherSuiteConfig=\(aqTLS_AES_256_GCM_SHA384\(aq \-\-tlsMode requireTLS \-\-tlsCertificateKeyFile Certs/server.pem +.EE +.RE +.PP +\fBopensslDiffieHellmanParameters\f1 +.RS +.PP +\fIAvailable on Linux only\f1 +.PP Specify the path to the PEM file that contains the OpenSSL -Diffie\-Hellman parameters. Specifying the OpenSSL Diffie\-Hellman -parameters enables support for dhe cipher suites during -TLS/SSL encryption. -.sp +Diffie\-Hellman parameters when using TLS 1.2 or previous. Specifying +the OpenSSL Diffie\-Hellman parameters enables support for \fBEphemeral Diffie\-Hellman (DHE)\f1 +cipher suites during TLS/SSL encryption. +.PP +This parameter is not supported for use with TLS 1.3. +.PP Ephemeral Diffie\-Hellman (DHE) cipher suites (and Ephemeral Elliptic Curve Diffie\-Hellman (ECDHE) cipher suites) provide -tls\-forward\-secrecy\&. tls\-forward\-secrecy cipher suites +\fBForward Secrecy\f1\&. \fBForward Secrecy\f1 cipher suites create an ephemeral session key that is protected by the server\(aqs private key but never transmitted. This ensures that even if a server\(aqs private key is compromised, you cannot decrypt past sessions with the compromised key. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Starting in MongoDB 4.2, if -\fI\%opensslDiffieHellmanParameters\fP is unset but -ECDHE is enabled, MongoDB enables DHE using -\fBffdhe3072\fP Diffie\-Hellman parameter, as defined in -\fI\%RFC 7919#appendix\-A.2\fP\&. The \fBffdhe3072\fP is a strong parameter -(i.e. size is greater than 1024). Strong parameters are not -supported with Java 6 and 7 unless extended support has been +\fBopensslDiffieHellmanParameters\f1\f1 is unset but +\fBECDHE\f1 is enabled, MongoDB enables DHE using the +\fBffdhe3072\f1 Diffie\-Hellman parameter, as defined in +RFC\-7919#appendix\-A.2 (https://tools.ietf.org/html/7919#appendix\-A.2)\&. The \fBffdhe3072\f1 is a strong parameter +(specifically, size is greater than 1024). Strong parameters are +not supported with Java 6 and 7 unless extended support has been purchased from Oracle. -.UNINDENT -.UNINDENT -.sp -You can only set \fI\%opensslDiffieHellmanParameters\fP during +.PP +You can only set \fBopensslDiffieHellmanParameters\f1\f1 during startup, and cannot change this setting using the -\fBsetParameter\fP database command. -.sp +\fBsetParameter\f1\f1 database command. +.PP If for performance reasons, you need to disable support for DHE -cipher suites, use the \fI\%opensslCipherConfig\fP parameter: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter opensslCipherConfig=\(aqHIGH:!EXPORT:!aNULL:!DHE:!kDHE@STRENGTH\(aq ... -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B saslauthdPath -. -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in MongoDB Enterprise (except MongoDB Enterprise for Windows). -.UNINDENT -.UNINDENT -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Specify the path to the Unix Domain Socket of the \fBsaslauthd\fP +cipher suites, use the \fBopensslCipherConfig\f1\f1 parameter: +.PP +.EX + mongod \-\-setParameter opensslCipherConfig=\(aqHIGH:!EXPORT:!aNULL:!DHE:!kDHE@STRENGTH\(aq ... +.EE +.RE +.PP +\fBsaslauthdPath\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Specify the path to the Unix Domain Socket of the \fBsaslauthd\f1 instance to use for proxy authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B saslHostName -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fI\%saslHostName\fP overrides MongoDB\(aqs default hostname +.RE +.PP +\fBsaslHostName\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fBsaslHostName\f1\f1 overrides MongoDB\(aqs default hostname detection for the purpose of configuring SASL and Kerberos authentication. -.sp -\fI\%saslHostName\fP does not affect the hostname of the -\fBmongod\fP or \fBmongos\fP instance for any purpose +.PP +\fBsaslHostName\f1\f1 does not affect the hostname of the +\fBmongod\f1\f1 or \fBmongos\f1\f1 instance for any purpose beyond the configuration of SASL and Kerberos. -.sp -You can only set \fI\%saslHostName\fP during start\-up, and -cannot change this setting using the \fBsetParameter\fP +.PP +You can only set \fBsaslHostName\f1\f1 during start\-up, and +cannot change this setting using the \fBsetParameter\f1\f1 database command. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%saslHostName\fP supports Kerberos authentication and is +.PP +\fBsaslHostName\f1\f1 supports Kerberos authentication and is only included in MongoDB Enterprise. For more information, see the following: -.INDENT 0.0 +.RS .IP \(bu 2 Linux: -/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +\fBConfigure MongoDB with Kerberos Authentication on Linux\f1 .IP \(bu 2 Windows: -/tutorial/control\-access\-to\-mongodb\-windows\-with\-kerberos\-authentication -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B saslServiceName -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Allows users to override the default Kerberos -service name component of the Kerberos +\fBConfigure MongoDB with Kerberos Authentication on Windows\f1 +.RE +.RE +.PP +\fBsaslServiceName\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Allows users to override the default \fBKerberos\f1 +service name component of the \fBKerberos\f1 principal name, on a per\-instance basis. If unspecified, the -default value is \fBmongodb\fP\&. -.sp -MongoDB only permits setting \fI\%saslServiceName\fP at -startup. The \fBsetParameter\fP command can not change +default value is \fBmongodb\f1\&. +.PP +MongoDB only permits setting \fBsaslServiceName\f1\f1 at +startup. The \fBsetParameter\f1\f1 command can not change this setting. -.sp -\fI\%saslServiceName\fP is only available in MongoDB +.PP +\fBsaslServiceName\f1\f1 is only available in MongoDB Enterprise. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Ensure that your driver supports alternate service names. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B scramIterationCount -\fIDefault\fP: \fB10000\fP -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.RE +.PP +\fBscramIterationCount\f1 +.RS +.PP +\fIDefault\f1: \fB10000\f1 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Changes the number of hashing iterations used for all new -\fBSCRAM\-SHA\-1\fP passwords. More iterations increase the amount of +\fBSCRAM\-SHA\-1\f1 passwords. More iterations increase the amount of time required for clients to authenticate to MongoDB, but makes passwords less susceptible to brute\-force attempts. The default value is ideal for most common use cases and requirements. -.sp +.PP If you modify this value, it does not change the iteration count for -existing passwords. The \fI\%scramIterationCount\fP value must -be \fB5000\fP or greater. -.sp -For example, the following sets the \fI\%scramIterationCount\fP -to \fB12000\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter scramIterationCount=12000 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Or, if using the \fBsetParameter\fP command within the -\fBmongo\fP shell: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, scramIterationCount: 12000 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fBdb.changeUserPassword()\fP -.IP \(bu 2 -\fBdb.createUser()\fP -.IP \(bu 2 -\fBdb.updateUser()\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B scramSHA256IterationCount -New in version 4.0. - -.sp -\fIDefault\fP: \fB15000\fP -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +existing passwords. The \fBscramIterationCount\f1\f1 value must +be \fB5000\f1 or greater. +.PP +For example, the following sets the \fBscramIterationCount\f1\f1 +to \fB12000\f1\&. +.PP +.EX + mongod \-\-setParameter scramIterationCount=12000 +.EE +.PP +Or, if using the \fBsetParameter\f1\f1 command within +\fBmongosh\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, scramIterationCount: 12000 } ) +.EE +.RS +.IP \(bu 2 +\fBdb.changeUserPassword()\f1\f1 +.IP \(bu 2 +\fBdb.createUser()\f1\f1 +.IP \(bu 2 +\fBdb.updateUser()\f1\f1 +.RE +.RE +.PP +\fBscramSHA256IterationCount\f1 +.RS +.PP +\fIDefault\f1: \fB15000\f1 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Changes the number of hashing iterations used for all new -\fBSCRAM\-SHA\-256\fP passwords. More iterations increase the amount of +\fBSCRAM\-SHA\-256\f1 passwords. More iterations increase the amount of time required for clients to authenticate to MongoDB, but makes passwords less susceptible to brute\-force attempts. The default value is ideal for most common use cases and requirements. -.sp +.PP If you modify this value, it does not change iteration count for -existing passwords. The \fI\%scramSHA256IterationCount\fP value -must be \fB5000\fP or greater. -.sp -For example, the following sets the \fI\%scramSHA256IterationCount\fP -to \fB20000\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter scramSHA256IterationCount=20000 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Or, if using the \fBsetParameter\fP command within the -\fBmongo\fP shell: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, scramSHA256IterationCount: 20000 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fBdb.changeUserPassword()\fP -.IP \(bu 2 -\fBdb.createUser()\fP -.IP \(bu 2 -\fBdb.updateUser()\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B sslMode -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Set the \fBnet.ssl.mode\fP to either \fBpreferSSL\fP or -\fBrequireSSL\fP\&. Useful during rolling upgrade to TLS/SSL to minimize downtime. -.sp +existing passwords. The \fBscramSHA256IterationCount\f1\f1 value +must be \fB5000\f1 or greater. +.PP +For example, the following sets the \fBscramSHA256IterationCount\f1\f1 +to \fB20000\f1\&. +.PP +.EX + mongod \-\-setParameter scramSHA256IterationCount=20000 +.EE +.PP +Or, if using the \fBsetParameter\f1\f1 command within +\fBmongosh\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, scramSHA256IterationCount: 20000 } ) +.EE +.RS +.IP \(bu 2 +\fBdb.changeUserPassword()\f1\f1 +.IP \(bu 2 +\fBdb.createUser()\f1\f1 +.IP \(bu 2 +\fBdb.updateUser()\f1\f1 +.RE +.RE +.PP +\fBsslMode\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Set the \fBnet.ssl.mode\f1\f1 to either \fBpreferSSL\f1 or +\fBrequireSSL\f1\&. Useful during \fBrolling upgrade to TLS/SSL\f1 to minimize downtime. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, sslMode: "preferSSL" } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%tlsMode\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tlsMode -New in version 4.2. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP +.EX + db.adminCommand( { setParameter: 1, sslMode: "preferSSL" } ) +.EE +.PP +\fBtlsMode\f1\f1 +.RE +.PP +\fBtlsMode\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Set to either: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBpreferTLS\fP +\fBpreferTLS\f1 .IP \(bu 2 -\fBrequireTLS\fP -.UNINDENT -.sp -The \fI\%tlsMode\fP parameter is useful during rolling -upgrade to TLS/SSL to minimize +\fBrequireTLS\f1 +.RE +.PP +The \fBtlsMode\f1\f1 parameter is useful during \fBrolling +upgrade to TLS/SSL\f1 to minimize downtime. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, tlsMode: "preferTLS" } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, tlsMode: "preferTLS" } ) +.EE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%sslMode\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tlsOCSPStaplingTimeoutSecs -New in version 4.4: Available for Linux. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP +\fBsslMode\f1\f1 +.RE +.PP +\fBtlsOCSPStaplingTimeoutSecs\f1 +.RS +.PP +Available for Linux. +.PP The maximum number of seconds the -\fBmongod\fP/\fBmongos\fP instance should wait to +\fBmongod\f1\f1/\fBmongos\f1\f1 instance should wait to receive the OCSP status response for its certificates. -.sp -Specify an integer greater than or equal to (\fB>=\fP) 1. If unset, -\fI\%tlsOCSPStaplingTimeoutSecs\fP uses the -\fI\%tlsOCSPVerifyTimeoutSecs\fP value. -.sp -You can only set \fI\%tlsOCSPStaplingTimeoutSecs\fP during -startup in the \fBconfiguration file\fP or with -the \fB\-\-setParameter\fP option on the command line. For example, the -following sets the \fI\%tlsOCSPStaplingTimeoutSecs\fP to 20 +.PP +Specify an integer greater than or equal to (\fB>=\f1) 1. If unset, +\fBtlsOCSPStaplingTimeoutSecs\f1\f1 uses the +\fBtlsOCSPVerifyTimeoutSecs\f1\f1 value. +.PP +You can only set \fBtlsOCSPStaplingTimeoutSecs\f1\f1 during +startup in the \fBconfiguration file\f1\f1 or with +the \fB\-\-setParameter\f1 option on the command line. For example, the +following sets the \fBtlsOCSPStaplingTimeoutSecs\f1\f1 to 20 seconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter tlsOCSPStaplingTimeoutSecs=20 ... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%ocspEnabled\fP -.IP \(bu 2 -\fI\%ocspValidationRefreshPeriodSecs\fP -.IP \(bu 2 -\fI\%tlsOCSPVerifyTimeoutSecs\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tlsOCSPVerifyTimeoutSecs -New in version 4.4: Available for Linux and Windows. - -.sp -\fIDefault\fP: 5 -.sp +.PP +.EX + mongod \-\-setParameter tlsOCSPStaplingTimeoutSecs=20 ... +.EE +.RS +.IP \(bu 2 +\fBocspEnabled\f1\f1 +.IP \(bu 2 +\fBocspValidationRefreshPeriodSecs\f1\f1 +.IP \(bu 2 +\fBtlsOCSPVerifyTimeoutSecs\f1\f1 +.RE +.RE +.PP +\fBtlsOCSPVerifyTimeoutSecs\f1 +.RS +.PP +Available for Linux and Windows. +.PP +\fIDefault\f1: 5 +.PP The maximum number of seconds that the -\fBmongod\fP/\fBmongos\fP should wait for the OCSP +\fBmongod\f1\f1/\fBmongos\f1\f1 should wait for the OCSP response when verifying client certificates. -.sp -Specify an integer greater than or equal to (\fB>=\fP) 1. Default is -unlimited. -.sp -You can only set \fI\%tlsOCSPVerifyTimeoutSecs\fP during -startup in the \fBconfiguration file\fP or with -the \fB\-\-setParameter\fP option on the command line. For example, the -following sets the \fI\%tlsOCSPVerifyTimeoutSecs\fP to 20 +.PP +Specify an integer greater than or equal to (\fB>=\f1) 1. +.PP +You can only set \fBtlsOCSPVerifyTimeoutSecs\f1\f1 during +startup in the \fBconfiguration file\f1\f1 or with +the \fB\-\-setParameter\f1 option on the command line. For example, the +following sets the \fBtlsOCSPVerifyTimeoutSecs\f1\f1 to 20 seconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter tlsOCSPVerifyTimeoutSecs=20 ... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%ocspEnabled\fP -.IP \(bu 2 -\fI\%ocspValidationRefreshPeriodSecs\fP -.IP \(bu 2 -\fI\%tlsOCSPStaplingTimeoutSecs\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tlsWithholdClientCertificate -\fIDefault\fP: false -.sp -New in version 4.2. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -A TLS certificate is set for a \fBmongod\fP or -\fBmongos\fP either by the -\fB\-\-tlsClusterFile\fP option or by the -\fB\-\-tlsCertificateKeyFile\fP option when -\fB\-\-tlsClusterFile\fP is not set. If the TLS +.PP +.EX + mongod \-\-setParameter tlsOCSPVerifyTimeoutSecs=20 ... +.EE +.RS +.IP \(bu 2 +\fBocspEnabled\f1\f1 +.IP \(bu 2 +\fBocspValidationRefreshPeriodSecs\f1\f1 +.IP \(bu 2 +\fBtlsOCSPStaplingTimeoutSecs\f1\f1 +.RE +.RE +.PP +\fBtlsWithholdClientCertificate\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +A TLS certificate is set for a \fBmongod\f1\f1 or +\fBmongos\f1\f1 either by the +\fB\-\-tlsClusterFile\f1\f1 option or by the +\fB\-\-tlsCertificateKeyFile\f1\f1 option when +\fB\-\-tlsClusterFile\f1\f1 is not set. If the TLS certificate is set, by default, the instance sends the certificate when initiating intra\-cluster communications with other -\fBmongod\fP or \fBmongos\fP instances in -the deployment. Set \fBtlsWithholdClientCertificate\fP to \fB1\fP or \fBtrue\fP to +\fBmongod\f1\f1 or \fBmongos\f1\f1 instances in +the deployment. Set \fBtlsWithholdClientCertificate\f1 to \fB1\f1 or \fBtrue\f1 to direct the instance to withhold sending its TLS certificate during these communications. Use this option with -\fB\-\-tlsAllowConnectionsWithoutCertificates\fP +\fB\-\-tlsAllowConnectionsWithoutCertificates\f1\f1 (to allow inbound connections without certificates) on all members of the -deployment. \fBtlsWithholdClientCertificate\fP is mutually exclusive with -\fB\-\-clusterAuthMode x509\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B tlsX509ClusterAuthDNOverride -New in version 4.2. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +deployment. \fBtlsWithholdClientCertificate\f1 is mutually exclusive with +\fB\-\-clusterAuthMode x509\f1\f1\&. +.RE +.PP +\fBtlsX509ClusterAuthDNOverride\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP An alternative Distinguished Name (DN) that the instance can also use to identify members of the deployment. -.sp +.PP For a MongoDB deployment that uses x.509 certificates for -\fBclusterAuthMode\fP, deployment members identify +\fBclusterAuthMode\f1\f1, deployment members identify each other using x.509 certificates ( -\fBnet.tls.clusterFile\fP, if specified, and -\fBnet.tls.certificateKeyFile\fP) during intra\-cluster -communications. For members of the same deployment, the \fBDN\fP from +\fBnet.tls.clusterFile\f1\f1, if specified, and +\fBnet.tls.certificateKeyFile\f1\f1) during intra\-cluster +communications. For members of the same deployment, the \fBDN\f1 from their certificates must have the same Organization attributes -(\fBO\fP\(aqs), the Organizational Unit attributes (\fBOU\fP\(aqs), and the -Domain Components (\fBDC\fP\(aqs). -.sp -If \fI\%tlsX509ClusterAuthDNOverride\fP is set for a member, -the member can also use the override value when comparing the \fBDN\fP -components (\fBO\fP\(aqs, \fBOU\fP\(aqs, and \fBDC\fP\(aqs) of the presented +(\fBO\f1\(aqs), the Organizational Unit attributes (\fBOU\f1\(aqs), and the +Domain Components (\fBDC\f1\(aqs). +.PP +If \fBtlsX509ClusterAuthDNOverride\f1\f1 is set for a member, +the member can also use the override value when comparing the \fBDN\f1 +components (\fBO\f1\(aqs, \fBOU\f1\(aqs, and \fBDC\f1\(aqs) of the presented certificates. That is the member checks the presented certificates against its -\fBnet.tls.clusterFile\fP/\fBnet.tls.certificateKeyFile\fP\&. +\fBnet.tls.clusterFile\f1\f1/\fBnet.tls.certificateKeyFile\f1\f1\&. If the DN does not match, the member checks the presented -certificate against the \fI\%tlsX509ClusterAuthDNOverride\fP +certificate against the \fBtlsX509ClusterAuthDNOverride\f1\f1 value. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP If set, you must set this parameter on all members of the deployment. -.UNINDENT -.UNINDENT -.sp +.PP You can use this parameter for a rolling update of certificates to -new certificates that contain a new \fBDN\fP value. See -/tutorial/rotate\-x509\-membership\-certificates\&. -.sp +new certificates that contain a new \fBDN\f1 value. See +\fBRolling Update of x.509 Cluster Certificates that Contain New DN\f1\&. +.PP For more information about membership certificate requirements, see -x509\-member\-certificate\-requirements for details. -.UNINDENT -.INDENT 0.0 -.TP -.B tlsX509ExpirationWarningThresholdDays -New in version 4.4. - -.sp -\fIDefault\fP : 30 -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Starting in MongoDB 4.4, \fBmongod\fP/\fBmongos\fP +\fBMember Certificate Requirements\f1 for details. +.RE +.PP +\fBtlsX509ExpirationWarningThresholdDays\f1 +.RS +.PP +\fIDefault\f1 : 30 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Starting in MongoDB 4.4, \fBmongod\f1\f1/\fBmongos\f1\f1 logs a warning on connection if the presented x.509 certificate -expires within \fB30\fP days of the \fBmongod/mongos\fP system clock. -Use the \fI\%tlsX509ExpirationWarningThresholdDays\fP parameter +expires within \fB30\f1 days of the \fBmongod/mongos\f1 system clock. +Use the \fBtlsX509ExpirationWarningThresholdDays\f1\f1 parameter to control the certificate expiration warning threshold: -.INDENT 7.0 +.RS .IP \(bu 2 Increase the parameter value to trigger warnings farther ahead of the certificate expiration date. @@ -1010,636 +923,630 @@ the certificate expiration date. Decrease the parameter value to trigger warnings closer to the certificate expiration date. .IP \(bu 2 -Set the parameter to \fB0\fP to disable the warning. -.UNINDENT -.sp -This parameter has a minimum value of \fB0\fP\&. -.sp -You can only set \fI\%tlsX509ExpirationWarningThresholdDays\fP -during \fBmongod/mongos\fP startup using either: -.INDENT 7.0 +Set the parameter to \fB0\f1 to disable the warning. +.RE +.PP +This parameter has a minimum value of \fB0\f1\&. +.PP +You can only set \fBtlsX509ExpirationWarningThresholdDays\f1\f1 +during \fBmongod/mongos\f1 startup using either: +.RS .IP \(bu 2 -The \fBsetParameter\fP configuration setting, \fIor\fP +The \fBsetParameter\f1\f1 configuration setting, \fIor\f1 .IP \(bu 2 -The \fBmongod \-\-setParameter\fP / -\fBmongos \-\-setParameter\fP command +The \fBmongod \-\-setParameter\f1\f1 / +\fBmongos \-\-setParameter\f1\f1 command line option. -.UNINDENT -.sp -See 4.4\-rel\-notes\-certificate\-expiration\-warning for more +.RE +.PP +See \fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information on x.509 expiration warnings in MongoDB 4.4. -.sp -For more information on x.509 certificate validity, see \fI\%RFC 5280 -4.1.2.5\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B sslWithholdClientCertificate -\fIDefault\fP: false -.sp -Deprecated since version 4.2: Use \fI\%tlsWithholdClientCertificate\fP instead. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -A TLS certificate is set for a \fBmongod\fP or -\fBmongos\fP either by the -\fB\-\-tlsClusterFile\fP option or by the -\fB\-\-tlsCertificateKeyFile\fP option when -\fB\-\-tlsClusterFile\fP is not set. If the TLS +.PP +For more information on x.509 certificate validity, see RFC 5280 +4.1.2.5 (https://tools.ietf.org/html/rfc5280#section\-4.1.2.5)\&. +.RE +.PP +\fBsslWithholdClientCertificate\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Use \fBtlsWithholdClientCertificate\f1\f1 instead. +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +A TLS certificate is set for a \fBmongod\f1\f1 or +\fBmongos\f1\f1 either by the +\fB\-\-tlsClusterFile\f1\f1 option or by the +\fB\-\-tlsCertificateKeyFile\f1\f1 option when +\fB\-\-tlsClusterFile\f1\f1 is not set. If the TLS certificate is set, by default, the instance sends the certificate when initiating intra\-cluster communications with other -\fBmongod\fP or \fBmongos\fP instances in -the deployment. Set \fBsslWithholdClientCertificate\fP to \fB1\fP or \fBtrue\fP to +\fBmongod\f1\f1 or \fBmongos\f1\f1 instances in +the deployment. Set \fBsslWithholdClientCertificate\f1 to \fB1\f1 or \fBtrue\f1 to direct the instance to withhold sending its TLS certificate during these communications. Use this option with -\fB\-\-tlsAllowConnectionsWithoutCertificates\fP +\fB\-\-tlsAllowConnectionsWithoutCertificates\f1\f1 (to allow inbound connections without certificates) on all members of the -deployment. \fBsslWithholdClientCertificate\fP is mutually exclusive with -\fB\-\-clusterAuthMode x509\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B userCacheInvalidationIntervalSecs -\fIDefault\fP: 30 -.sp -Available for \fBmongos\fP only. -.sp -On a \fBmongos\fP instance, specifies the interval (in seconds) -at which the \fBmongos\fP instance checks to determine whether -the in\-memory cache of user objects has stale data, and if so, +deployment. \fBsslWithholdClientCertificate\f1 is mutually exclusive with +\fB\-\-clusterAuthMode x509\f1\f1\&. +.RE +.PP +\fBuserCacheInvalidationIntervalSecs\f1 +.RS +.PP +\fIDefault\f1: 30 +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP +On a \fBmongos\f1\f1 instance, specifies the interval (in seconds) +at which the \fBmongos\f1\f1 instance checks to determine whether +the in\-memory cache of \fBuser objects\f1 has stale data, and if so, clears the cache. If there are no changes to user objects, -\fBmongos\fP will not clear the cache. -.sp -This parameter has a minimum value of \fB1\fP second and a maximum -value of \fB86400\fP seconds (24 hours). -.UNINDENT -.INDENT 0.0 -.TP -.B authFailedDelayMs -\fIDefault\fP: 0 -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -New in version 3.4. - -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +\fBmongos\f1\f1 will not clear the cache. +.PP +This parameter has a minimum value of \fB1\f1 second and a maximum +value of \fB86400\f1 seconds (24 hours). +.RE +.PP +\fBauthFailedDelayMs\f1 +.RS +.PP +\fIDefault\f1: 0 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.sp +.PP The number of milliseconds to wait before informing clients that their authentication attempt has failed. This parameter may be in the range -\fB0\fP to \fB5000\fP, inclusive. -.sp +\fB0\f1 to \fB5000\f1, inclusive. +.PP Setting this parameter makes brute\-force login attacks on a database more time\-consuming. However, clients waiting for a response from the MongoDB server still consume server resources, and this may adversely impact benign login attempts if the server is denying access to many other clients simultaneously. -.UNINDENT -.INDENT 0.0 -.TP -.B allowRolesFromX509Certificates -\fIDefault\fP: true -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIAvailable starting in MongoDB 4.0.11 (and 3.6.14 and 3.4.22)\fP -.sp +.RE +.PP +\fBallowRolesFromX509Certificates\f1 +.RS +.PP +\fIDefault\f1: true +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIAvailable starting in MongoDB 4.0.11 (and 3.6.14 and 3.4.22)\f1 +.PP A boolean flag that allows or disallows the retrieval of authorization roles from client x.509 certificates. -.sp -You can only set \fI\%allowRolesFromX509Certificates\fP during +.PP +You can only set \fBallowRolesFromX509Certificates\f1\f1 during startup in the config file or on the command line. -.UNINDENT -.SS General Parameters -.INDENT 0.0 -.TP -.B connPoolMaxShardedConnsPerHost -\fIDefault\fP: 200 -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.RE +.SS GENERAL PARAMETERS +.PP +\fBconnPoolMaxShardedConnsPerHost\f1 +.RS +.PP +\fIDefault\f1: 200 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets the maximum size of the legacy connection pools for communication to the shards. The size of a pool does not prevent the creation of -additional connections, but \fIdoes\fP prevent the connection pools from +additional connections, but \fIdoes\f1 prevent the connection pools from retaining connections above this limit. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP The parameter is separate from the connections in TaskExecutor -pools. See \fI\%ShardingTaskExecutorPoolMaxSize\fP\&. -.UNINDENT -.UNINDENT -.sp -Increase the \fI\%connPoolMaxShardedConnsPerHost\fP value -\fBonly\fP if the number of connections in a connection pool has a +pools. See \fBShardingTaskExecutorPoolMaxSize\f1\f1\&. +.PP +Increase the \fBconnPoolMaxShardedConnsPerHost\f1\f1 value +\fBonly\f1 if the number of connections in a connection pool has a high level of churn or if the total number of created connections increase. -.sp -You can only set \fI\%connPoolMaxShardedConnsPerHost\fP during +.PP +You can only set \fBconnPoolMaxShardedConnsPerHost\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter connPoolMaxShardedConnsPerHost=250 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B connPoolMaxShardedInUseConnsPerHost -New in version 3.6.3. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +.EX + mongos \-\-setParameter connPoolMaxShardedConnsPerHost=250 +.EE +.RE +.PP +\fBconnPoolMaxShardedInUseConnsPerHost\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets the maximum number of in\-use connections at any given time for the legacy sharded cluster connection pools. -.sp +.PP By default, the parameter is unset. -.sp -You can only set \fI\%connPoolMaxShardedConnsPerHost\fP during +.PP +You can only set \fBconnPoolMaxShardedConnsPerHost\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter connPoolMaxShardedInUseConnsPerHost=100 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%connPoolMaxShardedConnsPerHost\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B shardedConnPoolIdleTimeoutMinutes -New in version 3.6.3. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +.EX + mongos \-\-setParameter connPoolMaxShardedInUseConnsPerHost=100 +.EE +.PP +\fBconnPoolMaxShardedConnsPerHost\f1\f1 +.RE +.PP +\fBshardedConnPoolIdleTimeoutMinutes\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets the time limit that a connection in the legacy sharded cluster connection pool can remain idle before being closed. -.sp +.PP By default, the parameter is unset. -.sp -You can only set \fI\%shardedConnPoolIdleTimeoutMinutes\fP during +.PP +You can only set \fBshardedConnPoolIdleTimeoutMinutes\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter shardedConnPoolIdleTimeoutMinutes=10 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%connPoolMaxShardedConnsPerHost\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B connPoolMaxConnsPerHost -\fIDefault\fP: 200 -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +.EX + mongos \-\-setParameter shardedConnPoolIdleTimeoutMinutes=10 +.EE +.PP +\fBconnPoolMaxShardedConnsPerHost\f1\f1 +.RE +.PP +\fBconnPoolMaxConnsPerHost\f1 +.RS +.PP +\fIDefault\f1: 200 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets the maximum size of the legacy connection pools for outgoing connections -to other \fBmongod\fP instances in the global connection pool. The size +to other \fBmongod\f1\f1 instances in the global connection pool. The size of a pool does not prevent the creation of additional connections, -but \fIdoes\fP prevent a connection pool from retaining connections in -excess of the value of \fI\%connPoolMaxConnsPerHost\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +but \fIdoes\f1 prevent a connection pool from retaining connections in +excess of the value of \fBconnPoolMaxConnsPerHost\f1\f1\&. +.PP The parameter is separate from the connections in TaskExecutor -pools. See \fI\%ShardingTaskExecutorPoolMaxSize\fP\&. -.UNINDENT -.UNINDENT -.sp -\fBOnly\fP adjust this setting if your driver does \fInot\fP pool +pools. See \fBShardingTaskExecutorPoolMaxSize\f1\f1\&. +.PP +\fBOnly\f1 adjust this setting if your driver does \fInot\f1 pool connections and you\(aqre using authentication in the context of a sharded cluster. -.sp -You can only set \fI\%connPoolMaxConnsPerHost\fP during startup +.PP +You can only set \fBconnPoolMaxConnsPerHost\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter connPoolMaxConnsPerHost=250 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B connPoolMaxInUseConnsPerHost -New in version 3.6.3. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +.EX + mongod \-\-setParameter connPoolMaxConnsPerHost=250 +.EE +.RE +.PP +\fBconnPoolMaxInUseConnsPerHost\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets the maximum number of in\-use connections at any given time for -for outgoing connections to other \fBmongod\fP instances in +for outgoing connections to other \fBmongod\f1\f1 instances in the legacy global connection pool. -.sp +.PP By default, the parameter is unset. -.sp -You can only set \fI\%connPoolMaxInUseConnsPerHost\fP during +.PP +You can only set \fBconnPoolMaxInUseConnsPerHost\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter connPoolMaxInUseConnsPerHost=100 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%connPoolMaxConnsPerHost\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B globalConnPoolIdleTimeoutMinutes -New in version 3.6.3. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +.EX + mongod \-\-setParameter connPoolMaxInUseConnsPerHost=100 +.EE +.PP +\fBconnPoolMaxConnsPerHost\f1\f1 +.RE +.PP +\fBglobalConnPoolIdleTimeoutMinutes\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets the time limit that connection in the legacy global connection pool can remain idle before being closed. -.sp +.PP By default, the parameter is unset. -.sp -You can only set \fI\%globalConnPoolIdleTimeoutMinutes\fP +.PP +You can only set \fBglobalConnPoolIdleTimeoutMinutes\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter globalConnPoolIdleTimeoutMinutes=10 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%connPoolMaxShardedConnsPerHost\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B cursorTimeoutMillis -\fIDefault\fP: 600000 (i.e. 10 minutes) -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Sets the expiration threshold in milliseconds for idle cursors -before MongoDB removes them; i.e. MongoDB removes cursors that have -been idle for the specified \fI\%cursorTimeoutMillis\fP\&. -.sp -For example, the following sets the \fI\%cursorTimeoutMillis\fP -to \fB300000\fP milliseconds (i.e. 5 minutes). -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter cursorTimeoutMillis=300000 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Or, if using the \fBsetParameter\fP command within the -\fBmongo\fP shell: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, cursorTimeoutMillis: 300000 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Setting \fI\%cursorTimeoutMillis\fP to less than or equal -to \fB0\fP results in all cursors being immediately eligible for timeout. +.PP +.EX + mongos \-\-setParameter globalConnPoolIdleTimeoutMinutes=10 +.EE +.PP +\fBconnPoolMaxShardedConnsPerHost\f1\f1 +.RE +.PP +\fBcursorTimeoutMillis\f1 +.RS +.PP +\fIDefault\f1: 600000 (10 minutes) +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Sets the expiration threshold in milliseconds for idle cursors before +MongoDB removes them; specifically, MongoDB removes cursors that have +been idle for the specified \fBcursorTimeoutMillis\f1\f1\&. +.PP +For example, the following sets the \fBcursorTimeoutMillis\f1\f1 +to \fB300000\f1 milliseconds (5 minutes). +.PP +.EX + mongod \-\-setParameter cursorTimeoutMillis=300000 +.EE +.PP +Or, if using the \fBsetParameter\f1\f1 command within +\fBmongosh\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, cursorTimeoutMillis: 300000 } ) +.EE +.PP +Setting \fBcursorTimeoutMillis\f1\f1 to less than or equal +to \fB0\f1 results in all cursors being immediately eligible for timeout. Generally, the timeout value should be greater than the average amount of -time for a query to return results. Use tools like the \fBcursor.explain()\fP +time for a query to return results. Use tools like the \fBcursor.explain()\f1\f1 cursor modifier to analyze the average query time and select an appropriate timeout period. -.UNINDENT -.INDENT 0.0 -.TP -.B failIndexKeyTooLong -\fIRemoved in 4.4\fP -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fBMongoDB 4.4\fP \fIremoves\fP the deprecated -\fI\%failIndexKeyTooLong\fP parameter. Attempting to use +.RE +.PP +\fBfailIndexKeyTooLong\f1 +.RS +.PP +\fIRemoved in 4.4\f1 +.RS +.IP \(bu 2 +\fBMongoDB 4.4\f1 \fIremoves\f1 the deprecated +\fBfailIndexKeyTooLong\f1\f1 parameter. Attempting to use this parameter with MongoDB 4.4 will result in an error. .IP \(bu 2 -\fBMongoDB 4.2\fP \fIdeprecates\fP the -\fI\%failIndexKeyTooLong\fP parameter and \fIremoves\fP the -\fBIndex Key Length Limit\fP for -featureCompatibilityVersion (fCV) set to -\fB"4.2"\fP or greater. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +\fBMongoDB 4.2\f1 \fIdeprecates\f1 the +\fBfailIndexKeyTooLong\f1\f1 parameter and \fIremoves\f1 the +\fBIndex Key Length Limit\f1 for +\fBfeatureCompatibilityVersion\f1 (fCV) set to +\fB"4.2"\f1 or greater. +.RE +.PP For MongoDB 2.6 through MongoDB versions with -featureCompatibilityVersion (fCV) set to \fB"4.0"\fP or earlier, -\fBIndex Key Length Limit\fP applies. If you +\fBfeatureCompatibilityVersion\f1 (fCV) set to \fB"4.0"\f1 or earlier, +\fBIndex Key Length Limit\f1 applies. If you attempt to insert or update a document whose index field exceeds -the \fBIndex Key Length Limit\fP, the operation +the \fBIndex Key Length Limit\f1, the operation will fail and return an error to the client. -.sp -To avoid this issue, consider using hashed indexes or indexing a computed value. If you have an +.PP +To avoid this issue, consider using \fBhashed indexes\f1 or indexing a computed value. If you have an existing data set and want to disable this behavior so you can upgrade and then gradually resolve these indexing issues, you can -use \fI\%failIndexKeyTooLong\fP to disable this behavior. -.sp -Setting \fI\%failIndexKeyTooLong\fP to \fBfalse\fP is +use \fBfailIndexKeyTooLong\f1\f1 to disable this behavior. +.PP +Setting \fBfailIndexKeyTooLong\f1\f1 to \fBfalse\f1 is a temporary workaround, not a permanent solution to the problem of oversized index keys. With -\fI\%failIndexKeyTooLong\fP set to \fBfalse\fP, queries can +\fBfailIndexKeyTooLong\f1\f1 set to \fBfalse\f1, queries can return incomplete results if they use indexes that skip over documents whose indexed fields exceed the -\fBIndex Key Length Limit\fP\&. -.sp -\fI\%failIndexKeyTooLong\fP defaults to \fBtrue\fP\&. -.sp +\fBIndex Key Length Limit\f1\&. +.PP +\fBfailIndexKeyTooLong\f1\f1 defaults to \fBtrue\f1\&. +.PP Issue the following command to disable the index key length validation: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, failIndexKeyTooLong: false } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -You can also set \fI\%failIndexKeyTooLong\fP at -startup time with the following option: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter failIndexKeyTooLong=false -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B notablescan -Available for \fBmongod\fP only. -.sp -Specify whether \fBall\fP queries must use indexes. If \fB1\fP, MongoDB +.PP +.EX + db.adminCommand( { setParameter: 1, failIndexKeyTooLong: false } ) +.EE +.PP +You can also set \fBfailIndexKeyTooLong\f1\f1 at startup with the +following option: +.PP +.EX + mongod \-\-setParameter failIndexKeyTooLong=false +.EE +.RE +.PP +\fBnotablescan\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Specify whether \fBall\f1 queries must use indexes. If \fB1\f1, MongoDB will not execute queries that require a collection scan and will return an error. -.sp -Consider the following example which sets \fI\%notablescan\fP to \fB1\fP +.PP +Consider the following example which sets \fBnotablescan\f1\f1 to \fB1\f1 or true: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, notablescan: 1 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Setting \fI\%notablescan\fP to \fB1\fP can be useful for testing +.PP +.EX + db.adminCommand( { setParameter: 1, notablescan: 1 } ) +.EE +.PP +Setting \fBnotablescan\f1\f1 to \fB1\f1 can be useful for testing application queries, for example, to identify queries that scan an entire collection and cannot use an index. -.sp -To detect unindexed queries without \fBnotablescan\fP, consider reading -the /tutorial/evaluate\-operation\-performance and -/tutorial/optimize\-query\-performance\-with\-indexes\-and\-projections -sections and using the \fI\%logLevel\fP parameter, -/reference/program/mongostat and profiling\&. -.sp -Don\(aqt run production \fBmongod\fP instances with -\fI\%notablescan\fP because preventing collection scans can potentially +.PP +To detect unindexed queries without \fBnotablescan\f1, consider reading +the \fBEvaluate Performance of Current Operations\f1 and +\fBOptimize Query Performance\f1 +sections and using the \fBlogLevel\f1\f1 parameter, +\fBmongostat\f1\f1 and \fBprofiling\f1\&. +.PP +Don\(aqt run production \fBmongod\f1\f1 instances with +\fBnotablescan\f1\f1 because preventing collection scans can potentially affect queries in all databases, including administrative queries. -.UNINDENT -.INDENT 0.0 -.TP -.B ttlMonitorEnabled -Available for \fBmongod\fP only. -.sp -To support TTL Indexes, \fBmongod\fP +.RE +.PP +\fBttlMonitorEnabled\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIDefault\f1: \fBtrue\f1 +.PP +To support \fBTTL Indexes\f1, \fBmongod\f1\f1 instances have a background thread that is responsible for deleting documents from collections with TTL indexes. -.sp -To disable this worker thread for a \fBmongod\fP, set -\fI\%ttlMonitorEnabled\fP to \fBfalse\fP, as in the following +.PP +To disable this worker thread for a \fBmongod\f1\f1, set +\fBttlMonitorEnabled\f1\f1 to \fBfalse\f1, as in the following operations: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, ttlMonitorEnabled: false } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, ttlMonitorEnabled: false } ) +.EE +.PP Alternately, you may disable the thread at startup time by starting the -\fBmongod\fP instance with the following option: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter ttlMonitorEnabled=false -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tcpFastOpenServer -New in version 4.4. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIDefault\fP: \fBtrue\fP -.sp +\fBmongod\f1\f1 instance with the following option: +.PP +.EX + mongod \-\-setParameter ttlMonitorEnabled=false +.EE +.PP +Do not run production \fBmongod\f1\f1 instances with +\fBttlMonitorEnabled\f1 disabled, except under guidance from MongoDB +support. Preventing TTL document removal can negatively impact +MongoDB internal system operations that depend on +\fBTTL Indexes\f1\&. +.RE +.PP +\fBtcpFastOpenServer\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIDefault\f1: \fBtrue\f1 +.PP Enables support for accepting inbound TCP Fast Open (TFO) connections -to the \fBmongod/mongos\fP from a client. TFO requires both the -client and \fBmongod/mongos\fP host machine support and enable +to the \fBmongod/mongos\f1 from a client. TFO requires both the +client and \fBmongod/mongos\f1 host machine support and enable TFO: -.INDENT 7.0 -.TP -.B Windows +.PP +\fBWindows\f1 +.RS +.PP The following Windows operating systems support TFO: -.INDENT 7.0 +.RS .IP \(bu 2 Microsoft Windows Server 2016 and later. .IP \(bu 2 Microsoft Windows 10 Update 1607 and later. -.UNINDENT -.TP -.B macOS +.RE +.RE +.PP +\fBmacOS\f1 +.RS +.PP macOS 10.11 (El Capitan) and later support TFO. -.TP -.B Linux +.RE +.PP +\fBLinux\f1 +.RS +.PP Linux operating systems running Linux Kernel 3.7 or later can support inbound TFO. -.sp -Set the value of \fB/proc/sys/net/ipv4/tcp_fastopen\fP to +.PP +Set the value of \fB/proc/sys/net/ipv4/tcp_fastopen\f1 to enable inbound TFO connections: -.INDENT 7.0 +.RS .IP \(bu 2 -Set to \fB2\fP to enable only inbound TFO connections. +Set to \fB2\f1 to enable only inbound TFO connections. .IP \(bu 2 -Set to \fB3\fP to enable inbound and outbound TFO connections. -.UNINDENT -.UNINDENT -.sp +Set to \fB3\f1 to enable inbound and outbound TFO connections. +.RE +.RE +.PP This parameter has no effect if the host operating system does not -support \fIor\fP is not configured to support TFO connections. -.sp +support \fIor\f1 is not configured to support TFO connections. +.PP You can only set this parameter on startup, using either the -\fBsetParameter\fP configuration file setting or the -\fB\-\-setParameter\fP command line option. -.sp -See 4.4\-rel\-notes\-tcp\-fast\-open for more information on +\fBsetParameter\f1\f1 configuration file setting or the +\fB\-\-setParameter\f1\f1 command line option. +.PP +See \fBSupport for TCP Fast Open\f1 for more information on MongoDB TFO support. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%RFC7413\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tcpFastOpenClient -New in version 4.4. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIDefault\fP: \fBtrue\fP -.sp -\fILinux Operating System Only\fP -.sp +.PP +RFC7413 (https://tools.ietf.org/html/rfc7413)\&. +.RE +.PP +\fBtcpFastOpenClient\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIDefault\f1: \fBtrue\f1 +.PP +\fILinux Operating System Only\f1 +.PP Enables support for outbound TCP Fast Open (TFO) connections from the -\fBmongod/mongos\fP to a client. TFO requires both the client -and the \fBmongod/mongos\fP host machine support and enable TFO. -.sp +\fBmongod/mongos\f1 to a client. TFO requires both the client +and the \fBmongod/mongos\f1 host machine support and enable TFO. +.PP Linux operating systems running Linux Kernel 4.11 or later can support outbound TFO. -.sp -Set the value of \fB/proc/sys/net/ipv4/tcp_fastopen\fP to enable +.PP +Set the value of \fB/proc/sys/net/ipv4/tcp_fastopen\f1 to enable outbound TFO connections: -.INDENT 7.0 +.RS .IP \(bu 2 -\fB1\fP to enable only outbound TFO connections. +\fB1\f1 to enable only outbound TFO connections. .IP \(bu 2 -\fB3\fP to enable inbound and outbound TFO connections. -.UNINDENT -.sp +\fB3\f1 to enable inbound and outbound TFO connections. +.RE +.PP This parameter has no effect if the host operating system does not -support \fIor\fP is not configured to support TFO connections. -.sp +support \fIor\f1 is not configured to support TFO connections. +.PP You can only set this parameter on startup, using either the -\fBsetParameter\fP configuration file setting or the -\fB\-\-setParameter\fP command line option. -.sp -See 4.4\-rel\-notes\-tcp\-fast\-open for more information on +\fBsetParameter\f1\f1 configuration file setting or the +\fB\-\-setParameter\f1\f1 command line option. +.PP +See \fBSupport for TCP Fast Open\f1 for more information on MongoDB TFO support. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%RFC7413\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tcpFastOpenQueueSize -New in version 4.4. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIDefault\fP: \fB1024\fP -.sp +.PP +RFC7413 (https://tools.ietf.org/html/rfc7413)\&. +.RE +.PP +\fBtcpFastOpenQueueSize\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIDefault\f1: \fB1024\f1 +.PP As part of establishing a TCP Fast Open (TFO) connection, the client -submits a valid TFO cookie to the \fBmongod/mongos\fP \fIbefore\fP +submits a valid TFO cookie to the \fBmongod/mongos\f1 \fIbefore\f1 completion of the standard TCP 3\-way handshake. The -\fBmongod/mongos\fP keeps a queue of all such pending TFO connections. -.sp -The \fBtcpFastOpenQueueSize\fP parameter sets the size of the queue of +\fBmongod/mongos\f1 keeps a queue of all such pending TFO connections. +.PP +The \fBtcpFastOpenQueueSize\f1 parameter sets the size of the queue of pending TFO connections. While the queue is full, the -\fBmongod/mongos\fP falls back to the normal three\-way handshake for +\fBmongod/mongos\f1 falls back to the normal three\-way handshake for incoming client requests and ignores the presence of TFO cookies. -Once the queue size falls back below the limit, the \fBmongod/mongos\fP +Once the queue size falls back below the limit, the \fBmongod/mongos\f1 begins accepting new TFO cookies. -.INDENT 7.0 +.RS .IP \(bu 2 Increasing the default queue size may improve the effect of TFO on network performance. However, large queue sizes also @@ -1650,3166 +1557,3482 @@ Decreasing the default queue size may reduce the risk of resource server resource exhaustion due to excessive incoming TFO requests. However, small queue sizes may also reduce the effect of TFO on network performance. -.sp -The minimum queue size is \fB0\fP\&. A queue of \fB0\fP effectively +.IP +The minimum queue size is \fB0\f1\&. A queue of \fB0\f1 effectively disables TFO. -.UNINDENT -.sp +.RE +.PP This parameter has no effect on host operating systems that do not support or are not configured for TFO connections. See -4.4\-rel\-notes\-tcp\-fast\-open for more information on +\fBSupport for TCP Fast Open\f1 for more information on MongoDB TFO support. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%RFC7413 TCP Fast Open Section 5: Security Considerations\fP -.IP \(bu 2 -\fI\%RFC7413 TCP Fast Open Section 6: TFO Applicability\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B disableJavaScriptJIT -Changed in version 4.0: The JavaScript engine\(aqs JIT compiler is now disabled by default. - -.sp -Available for \fBmongod\fP only. -.sp +.RS +.IP \(bu 2 +RFC7413 TCP Fast Open Section 5: Security Considerations (https://tools.ietf.org/html/rfc7413#section\-5) +.IP \(bu 2 +RFC7413 TCP Fast Open Section 6: TFO Applicability (https://tools.ietf.org/html/rfc7413#section\-6) +.RE +.RE +.PP +\fBdisableJavaScriptJIT\f1 +.RS +.PP +The JavaScript engine\(aqs JIT compiler is now disabled by default. +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP The MongoDB JavaScript engine uses SpiderMonkey, which implements Just\-in\-Time (JIT) compilation for improved performance when running scripts. -.sp -To enable the JIT, set \fI\%disableJavaScriptJIT\fP to \fBfalse\fP, as in +.PP +To enable the JIT, set \fBdisableJavaScriptJIT\f1\f1 to \fBfalse\f1, as in the following example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, disableJavaScriptJIT: false } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fB$where\fP will reuse existing JavaScript interpreter -contexts, so changes to \fI\%disableJavaScriptJIT\fP may not +.PP +.EX + db.adminCommand( { setParameter: 1, disableJavaScriptJIT: false } ) +.EE +.PP +\fB$where\f1\f1 will reuse existing JavaScript interpreter +contexts, so changes to \fBdisableJavaScriptJIT\f1\f1 may not take effect immediately for these operations. -.UNINDENT -.UNINDENT -.sp +.PP Alternately, you may enable the JIT at startup time by starting the -\fBmongod\fP instance with the following option: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter disableJavaScriptJIT=false -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B maxIndexBuildMemoryUsageMegabytes -New in version 3.4. - -.sp -\fIDefault\fP: -.INDENT 7.0 +\fBmongod\f1\f1 instance with the following option: +.PP +.EX + mongod \-\-setParameter disableJavaScriptJIT=false +.EE +.RE +.PP +\fBmaxIndexBuildMemoryUsageMegabytes\f1 +.RS +.PP +\fIDefault\f1: +.RS .IP \(bu 2 200 (For versions 4.2.3 and later) .IP \(bu 2 500 (For versions 4.2.2 and earlier) -.UNINDENT -.sp +.RE +.PP Limits the amount of memory that simultaneous index builds on one collection may consume for the duration of the builds. The specified amount of memory is shared between all indexes built using a single -\fBcreateIndexes\fP command or its shell helper -\fBdb.collection.createIndexes()\fP\&. -.sp +\fBcreateIndexes\f1\f1 command or its shell helper +\fBdb.collection.createIndexes()\f1\f1\&. +.PP The memory consumed by an index build is separate from the WiredTiger cache memory (see -\fBcacheSizeGB\fP). -.sp +\fBcacheSizeGB\f1\f1). +.PP Index builds may be initiated either by a user command -such as Create Index +such as \fBCreate Index\f1 or by an administrative process such as an -initial sync\&. +\fBinitial sync\f1\&. Both are subject to the limit set by -\fI\%maxIndexBuildMemoryUsageMegabytes\fP\&. -.sp -An initial sync operation populates +\fBmaxIndexBuildMemoryUsageMegabytes\f1\f1\&. +.PP +An \fBinitial sync operation\f1 populates only one collection at a time and has no risk of exceeding the memory limit. However, it is possible for a user to start index builds on multiple collections in multiple databases simultaneously and potentially consume an amount of memory greater than the limit -set in \fI\%maxIndexBuildMemoryUsageMegabytes\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.SS Tip -.sp +set in \fBmaxIndexBuildMemoryUsageMegabytes\f1\f1\&. +.PP To minimize the impact of building an index on replica sets and sharded clusters with replica set shards, use a rolling index build procedure as described on -/tutorial/build\-indexes\-on\-replica\-sets\&. -.UNINDENT -.UNINDENT -.sp -Changed in version 4.2. - -.INDENT 7.0 -.IP \(bu 2 -For feature compatibility version (fcv) \fB"4.2"\fP, +\fBRolling Index Builds on Replica Sets\f1\&. +.RS +.IP \(bu 2 +For \fBfeature compatibility version (fcv)\f1 \fB"4.2"\f1, the index build memory limit applies to all index builds. .IP \(bu 2 -For feature compatibility version (fcv) \fB"4.0"\fP, +For \fBfeature compatibility version (fcv)\f1 \fB"4.0"\f1, the index build memory limit only applies to foreground index builds. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B reportOpWriteConcernCountersInServerStatus -New in version 4.0.6. - -.sp -\fIDefault\fP: false -.sp +.RE +.RE +.PP +\fBreportOpWriteConcernCountersInServerStatus\f1 +.RS +.PP +\fIDefault\f1: false +.PP A boolean flag that determines whether the -\fBdb.serverStatus()\fP method and \fBserverStatus\fP -command return \fBopWriteConcernCounters\fP information. [1] -.sp +\fBdb.serverStatus()\f1\f1 method and \fBserverStatus\f1\f1 +command return \fBopWriteConcernCounters\f1\f1 information. +.PP You can only set -\fI\%reportOpWriteConcernCountersInServerStatus\fP during +\fBreportOpWriteConcernCountersInServerStatus\f1\f1 during startup in the config file or on the command line. For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter reportOpWriteConcernCountersInServerStatus=true -.ft P -.fi -.UNINDENT -.UNINDENT -.IP [1] 5 -Enabling \fI\%reportOpWriteConcernCountersInServerStatus\fP -can have a negative performance impact; specificaly, when running -\fIwithout\fP TLS. -.UNINDENT -.INDENT 0.0 -.TP -.B watchdogPeriodSeconds -Available for \fBmongod\fP only. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: \-1 (disabled) -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -Starting in MongoDB 4.2, the Storage Node Watchdog is available in both the Community and +.PP +.EX + mongod \-\-setParameter reportOpWriteConcernCountersInServerStatus=true +.EE +.RE +.PP +\fBwatchdogPeriodSeconds\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: \-1 (disabled) +.RS +.IP \(bu 2 +Starting in MongoDB 4.2, the \fBStorage Node Watchdog\f1 is available in both the Community and MongoDB Enterprise editions. .IP \(bu 2 In earlier versions (3.2.16+, 3.4.7+, 3.6.0+, 4.0.0+), the -Storage Node Watchdog is only +\fBStorage Node Watchdog\f1 is only available in MongoDB Enterprise edition. -.UNINDENT -.UNINDENT -.UNINDENT -.sp -Determines how frequent the Storage Node Watchdog checks the status of the monitored +.RE +.PP +Determines how frequent the \fBStorage Node Watchdog\f1 checks the status of the monitored filesystems: -.INDENT 7.0 +.RS .IP \(bu 2 -The \fB\-\-dbpath\fP directory +The \fB\-\-dbpath\f1\f1 directory .IP \(bu 2 -The \fBjournal\fP directory inside the \fB\-\-dbpath\fP directory if -\fBjournaling\fP is enabled +The \fBjournal\f1 directory inside the \fB\-\-dbpath\f1\f1 directory if +\fBjournaling\f1\f1 is enabled .IP \(bu 2 -The directory of \fB\-\-logpath\fP file +The directory of \fB\-\-logpath\f1\f1 file .IP \(bu 2 -The directory of \fB\-\-auditPath\fP file -.UNINDENT -.sp -Valid values for \fI\%watchdogPeriodSeconds\fP are: -.INDENT 7.0 +The directory of \fB\-\-auditPath\f1\f1 file +.RE +.PP +Valid values for \fBwatchdogPeriodSeconds\f1\f1 are: +.RS .IP \(bu 2 -\fB\-1\fP (the default), to disable/pause Storage Node Watchdog, or +\fB\-1\f1 (the default), to disable/pause \fBStorage Node Watchdog\f1, or .IP \(bu 2 An integer greater than or equal to 60. -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +.RE +.RS .IP \(bu 2 If a filesystem on a monitored directory becomes unresponsive, -it can take a maximum of nearly \fItwice\fP the value of -\fI\%watchdogPeriodSeconds\fP to terminate the -\fBmongod\fP\&. +it can take a maximum of nearly \fItwice\f1 the value of +\fBwatchdogPeriodSeconds\f1\f1 to terminate the +\fBmongod\f1\f1\&. .IP \(bu 2 If any of its monitored directory is a symlink to other volumes, the Storage Node Watchdog does not monitor the symlink -target. For example, if the \fBmongod\fP uses -\fBstorage.directoryPerDB: true\fP (or \fB\-\-directoryperdb\fP) and symlinks a database directory to +target. For example, if the \fBmongod\f1\f1 uses +\fBstorage.directoryPerDB: true\f1\f1 (or \fB\-\-directoryperdb\f1\f1) and symlinks a database directory to another volume, the Storage Node Watchdog does not follow the symlink to monitor the target. -.UNINDENT -.UNINDENT -.UNINDENT -.sp -To enable Storage Node Watchdog, -\fI\%watchdogPeriodSeconds\fP must be set during startup. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter watchdogPeriodSeconds=60 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -You can only enable the Storage Node Watchdog at startup. However, once enabled, you can -pause the Storage Node Watchdog or -change the \fI\%watchdogPeriodSeconds\fP during runtime. -.sp +.RE +.PP +To enable \fBStorage Node Watchdog\f1, +\fBwatchdogPeriodSeconds\f1\f1 must be set during startup. +.PP +.EX + mongod \-\-setParameter watchdogPeriodSeconds=60 +.EE +.PP +You can only enable the \fBStorage Node Watchdog\f1 at startup. However, once enabled, you can +pause the \fBStorage Node Watchdog\f1 or +change the \fBwatchdogPeriodSeconds\f1\f1 during runtime. +.PP Once enabled, -.INDENT 7.0 -.IP \(bu 2 -To pause the Storage Node Watchdog -during runtime, set \fI\%watchdogPeriodSeconds\fP to \-1. -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, watchdogPeriodSeconds: \-1 } ) -.ft P -.fi -.UNINDENT -.UNINDENT +.RS +.IP \(bu 2 +To pause the \fBStorage Node Watchdog\f1 +during runtime, set \fBwatchdogPeriodSeconds\f1\f1 to \-1. +.IP +.EX + db.adminCommand( { setParameter: 1, watchdogPeriodSeconds: \-1 } ) +.EE .IP \(bu 2 To resume or change the period during runtime, set -\fI\%watchdogPeriodSeconds\fP to a number greater than or +\fBwatchdogPeriodSeconds\f1\f1 to a number greater than or equal to 60. -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, watchdogPeriodSeconds: 120 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -It is an error to set \fI\%watchdogPeriodSeconds\fP at runtime if the -Storage Node Watchdog was not enabled at +.IP +.EX + db.adminCommand( { setParameter: 1, watchdogPeriodSeconds: 120 } ) +.EE +.RE +.PP +It is an error to set \fBwatchdogPeriodSeconds\f1\f1 at runtime if the +\fBStorage Node Watchdog\f1 was not enabled at startup time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B tcmallocReleaseRate -New in version 4.2.3: \fIAlso available in 3.6.17+ and 4.0.14+\fP - -.sp +.RE +.PP +\fBtcmallocReleaseRate\f1 +.RS +.PP Default: 1.0 -.sp -Specifies the tcmalloc release rate (\fI\%TCMALLOC_RELEASE_RATE\fP). -Per \fI\%https://gperftools.github.io/gperftools/tcmalloc.html#runtime\fP -TCMALLOC_RELEASE_RATE is described as: -.INDENT 7.0 -.INDENT 3.5 -Rate at which we release unused memory to the system, via +.PP +Specifies the tcmalloc release rate (TCMALLOC_RELEASE_RATE (https://gperftools.github.io/gperftools/tcmalloc.html#runtime)). +Per https://gperftools.github.io/gperftools/tcmalloc.html#runtime (https://gperftools.github.io/gperftools/tcmalloc.html#runtime) +TCMALLOC_RELEASE_RATE is described as the "Rate at which we release +unused memory to the system, via madvise(MADV_DONTNEED), on systems that support it. Zero means we never release memory back to the system. Increase this flag to return memory faster; decrease it to return memory slower. -Reasonable rates are in the range [0,10]. -\(em \fI\%https://gperftools.github.io/gperftools/tcmalloc.html#runtime\fP -.UNINDENT -.UNINDENT -.sp +Reasonable rates are in the range [0,10]." +.PP To modify the release rate during runtime, you can use the -\fBsetParameter\fP command; for example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, tcmallocReleaseRate: 5.0 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -You can also set \fI\%tcmallocReleaseRate\fP at startup time; +\fBsetParameter\f1\f1 command; for example: +.PP +.EX + db.adminCommand( { setParameter: 1, tcmallocReleaseRate: 5.0 } ) +.EE +.PP +You can also set \fBtcmallocReleaseRate\f1\f1 at startup time; for example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter "tcmallocReleaseRate=5.0" -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.SS Logging Parameters -.INDENT 0.0 -.TP -.B logLevel -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Specify an integer between \fB0\fP and \fB5\fP signifying the verbosity -of the logging, where \fB5\fP is the -most verbose. [2] -.sp -The default \fI\%logLevel\fP is \fB0\fP (Informational). -.sp -The following example sets the \fI\%logLevel\fP to \fB2\fP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, logLevel: 2 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%logComponentVerbosity\fP -.IP \(bu 2 -\fBsystemLog.verbosity\fP -.UNINDENT -.UNINDENT -.UNINDENT -.IP [2] 5 -Starting in version 4.2, MongoDB includes the Debug verbosity level -(1\-5) in the log messages\&. For example, -if the verbosity level is 2, MongoDB logs \fBD2\fP\&. In previous -versions, MongoDB log messages only specified \fBD\fP for Debug level. -.UNINDENT -.INDENT 0.0 -.TP -.B logComponentVerbosity -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Sets the verbosity levels of various components for log messages\&. The verbosity level determines the -amount of Informational and Debug -messages MongoDB outputs. [3] -.sp -The verbosity level can range from \fB0\fP to \fB5\fP: -.INDENT 7.0 -.IP \(bu 2 -\fB0\fP is the MongoDB\(aqs default log verbosity level, to include -Informational messages. -.IP \(bu 2 -\fB1\fP to \fB5\fP increases the verbosity level to include -Debug messages. -.UNINDENT -.sp -For a component, you can also specify \fB\-1\fP to inherit the parent\(aqs +.PP +.EX + mongod \-\-setParameter "tcmallocReleaseRate=5.0" +.EE +.RE +.SS LOGGING PARAMETERS +.PP +\fBlogLevel\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Specify an integer between \fB0\f1 and \fB5\f1 signifying the verbosity +of the \fBlogging\f1, where \fB5\f1 is the +most verbose. +.PP +The default \fBlogLevel\f1\f1 is \fB0\f1 (Informational). +.PP +The following example sets the \fBlogLevel\f1\f1 to \fB2\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, logLevel: 2 } ) +.EE +.RS +.IP \(bu 2 +\fBlogComponentVerbosity\f1\f1 +.IP \(bu 2 +\fBsystemLog.verbosity\f1\f1 +.RE +.RE +.PP +\fBlogComponentVerbosity\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Sets the verbosity levels of various \fBcomponents\f1 for \fBlog messages\f1\&. The verbosity level determines the +amount of \fBInformational and Debug\f1 +messages MongoDB outputs. +.PP +The verbosity level can range from \fB0\f1 to \fB5\f1: +.RS +.IP \(bu 2 +\fB0\f1 is the MongoDB\(aqs default log verbosity level, to include +\fBInformational\f1 messages. +.IP \(bu 2 +\fB1\f1 to \fB5\f1 increases the verbosity level to include +\fBDebug\f1 messages. +.RE +.PP +For a component, you can also specify \fB\-1\f1 to inherit the parent\(aqs verbosity level. -.sp +.PP To specify the verbosity level, use a document similar to the following: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - verbosity: <int>, - <component1>: { verbosity: <int> }, - <component2>: { - verbosity: <int>, - <component3>: { verbosity: <int> } - }, - ... -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -For the components, you can specify just the \fB<component>: <int>\fP +.PP +.EX + { + verbosity: <int>, + <component1>: { verbosity: <int> }, + <component2>: { + verbosity: <int>, + <component3>: { verbosity: <int> } + }, + ... + } +.EE +.PP +For the components, you can specify just the \fB<component>: <int>\f1 in the document, unless you are setting both the parent verbosity level and that of the child component(s) as well: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - verbosity: <int>, - <component1>: <int> , - <component2>: { - verbosity: <int>, - <component3>: <int> +.PP +.EX + { + verbosity: <int>, + <component1>: <int> , + <component2>: { + verbosity: <int>, + <component3>: <int> + } + ... } - ... -} -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The top\-level \fBverbosity\fP field corresponds to -\fBsystemLog.verbosity\fP which sets the default level for all -components. The default value of \fBsystemLog.verbosity\fP is -\fB0\fP\&. -.sp +.EE +.PP +The top\-level \fBverbosity\f1 field corresponds to +\fBsystemLog.verbosity\f1\f1 which sets the default level for all +components. The default value of \fBsystemLog.verbosity\f1\f1 is +\fB0\f1\&. +.PP The components correspond to the following settings: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBaccessControl\fP +\fBaccessControl\f1\f1 .IP \(bu 2 -\fBcommand\fP +\fBcommand\f1\f1 .IP \(bu 2 -\fBcontrol\fP +\fBcontrol\f1\f1 .IP \(bu 2 -\fBftdc\fP +\fBftdc\f1\f1 .IP \(bu 2 -\fBgeo\fP +\fBgeo\f1\f1 .IP \(bu 2 -\fBindex\fP +\fBindex\f1\f1 .IP \(bu 2 -\fBnetwork\fP +\fBnetwork\f1\f1 .IP \(bu 2 -\fBquery\fP +\fBquery\f1\f1 .IP \(bu 2 -\fBreplication\fP +\fBreplication\f1\f1 .IP \(bu 2 -\fBreplication.election\fP +\fBreplication.election\f1\f1 .IP \(bu 2 -\fBreplication.heartbeats\fP +\fBreplication.heartbeats\f1\f1 .IP \(bu 2 -\fBreplication.initialSync\fP +\fBreplication.initialSync\f1\f1 .IP \(bu 2 -\fBreplication.rollback\fP +\fBreplication.rollback\f1\f1 .IP \(bu 2 -\fBrecovery\fP +\fBrecovery\f1\f1 .IP \(bu 2 -\fBsharding\fP +\fBsharding\f1\f1 .IP \(bu 2 -\fBstorage\fP +\fBstorage\f1\f1 .IP \(bu 2 -\fBstorage.journal\fP +\fBstorage.journal\f1\f1 .IP \(bu 2 -\fBtransaction\fP +\fBtransaction\f1\f1 .IP \(bu 2 -\fBwrite\fP -.UNINDENT -.sp +\fBwrite\f1\f1 +.RE +.PP Unless explicitly set, the component has the verbosity level of its -parent. For example, \fBstorage\fP is the parent of -\fBstorage.journal\fP\&. That is, if you specify a \fBstorage\fP verbosity level, this level +parent. For example, \fBstorage\f1 is the parent of +\fBstorage.journal\f1\&. That is, if you specify a \fBstorage\f1\f1 verbosity level, this level also applies to: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBstorage.journal\fP components -\fIunless\fP you specify the verbosity level for -\fBstorage.journal\fP\&. +\fBstorage.journal\f1\f1 components +\fIunless\f1 you specify the verbosity level for +\fBstorage.journal\f1\f1\&. .IP \(bu 2 -\fBstorage.recovery\fP components -\fIunless\fP you specify the verbosity level for -\fBstorage.recovery\fP\&. -.UNINDENT -.sp +\fBstorage.recovery\f1\f1 components +\fIunless\f1 you specify the verbosity level for +\fBstorage.recovery\f1\f1\&. +.RE +.PP For example, the following sets the \fBdefault verbosity -level\fP to \fB1\fP, the \fBquery\fP to \fB2\fP, the -\fBstorage\fP to \fB2\fP, -and the \fBstorage.journal\fP to \fB1\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { - setParameter: 1, - logComponentVerbosity: { - verbosity: 1, - query: { verbosity: 2 }, - storage: { - verbosity: 2, - journal: { - verbosity: 1 - } - } - } -} ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -You can also set parameter \fI\%logComponentVerbosity\fP at +level\f1\f1 to \fB1\f1, the \fBquery\f1\f1 to \fB2\f1, the +\fBstorage\f1\f1 to \fB2\f1, +and the \fBstorage.journal\f1\f1 to \fB1\f1\&. +.PP +.EX + db.adminCommand( { + setParameter: 1, + logComponentVerbosity: { + verbosity: 1, + query: { verbosity: 2 }, + storage: { + verbosity: 2, + journal: { + verbosity: 1 + } + } + } + } ) +.EE +.PP +You can also set parameter \fBlogComponentVerbosity\f1\f1 at startup time, passing the verbosity level document as a string. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter "logComponentVerbosity={command: 3}" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fBmongo\fP shell also provides the \fBdb.setLogLevel()\fP +.PP +.EX + mongod \-\-setParameter "logComponentVerbosity={command: 3}" +.EE +.PP +\fBmongosh\f1\f1 also provides the \fBdb.setLogLevel()\f1\f1 to set the log level for a single component. For various ways to set -the log verbosity level, see log\-messages\-configure\-verbosity\&. -.IP [3] 5 -Starting in version 4.2, MongoDB includes the Debug verbosity level -(1\-5) in the log messages\&. For example, -if the verbosity level is 2, MongoDB logs \fBD2\fP\&. In previous -versions, MongoDB log messages only specified \fBD\fP for Debug level. -.UNINDENT -.INDENT 0.0 -.TP -.B maxLogSizeKB -New in version 3.4. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: non\-negative integer -.sp -\fIDefault\fP: 10 -.sp +the log verbosity level, see \fBConfigure Log Verbosity Levels\f1\&. +.RE +.PP +\fBmaxLogSizeKB\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: non\-negative integer +.PP +\fIDefault\f1: 10 +.PP Specifies the maxium size, in kilobytes, for an individual attribute field in a log entry; attributes exceeding this limit are truncated. -.sp +.PP Truncated attribute fields print field content up to the -\fI\%maxLogSizeKB\fP limit and excise field content past that +\fBmaxLogSizeKB\f1\f1 limit and excise field content past that limit, retaining valid JSON formating. Log entires that contain -truncated attributes append a \fBtruncated\fP object to the end of the +truncated attributes append a \fBtruncated\f1 object to the end of the log entry. -.sp -See log message truncation for more +.PP +See \fBlog message truncation\f1 for more information. -.sp -A value of \fB0\fP disables truncation entirely. Negative values for +.PP +A value of \fB0\f1 disables truncation entirely. Negative values for this parameter are not valid. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Using a large value, or disabling truncation with a value of -\fB0\fP, may adversely affect system performance and negatively +\fB0\f1, may adversely affect system performance and negatively impact database operations. -.UNINDENT -.UNINDENT -.sp -The following example sets the maximum log line size to \fB20\fP +.PP +The following example sets the maximum log line size to \fB20\f1 kilobytes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter maxLogSizeKB=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B quiet -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +.EX + mongod \-\-setParameter maxLogSizeKB=20 +.EE +.RE +.PP +\fBquiet\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Sets quiet logging mode. If -\fB1\fP, \fBmongod\fP will go into a quiet logging +\fB1\f1, \fBmongod\f1\f1 will go into a quiet logging mode which will not log the following events/activities: -.INDENT 7.0 +.RS .IP \(bu 2 connection events; .IP \(bu 2 -the \fBdrop\fP command, the -\fBdropIndexes\fP command, the -\fBdiagLogging\fP command, the -\fBvalidate\fP command, and the -\fBclean\fP command; and +the \fBdrop\f1\f1 command, the +\fBdropIndexes\f1\f1 command, the +\fBdiagLogging\f1\f1 command, the +\fBvalidate\f1\f1 command; and .IP \(bu 2 replication synchronization activities. -.UNINDENT -.sp +.RE +.PP Consider the following example which sets the -\fBquiet\fP to \fB1\fP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, quiet: 1 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBsystemLog.quiet\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B redactClientLogData -New in version 3.4. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: boolean -.INDENT 7.0 -.INDENT 3.5 -.IP "Enterprise Feature" -.sp +\fBquiet\f1 parameter to \fB1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, quiet: 1 } ) +.EE +.PP +\fBsystemLog.quiet\f1\f1 +.RE +.PP +\fBredactClientLogData\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: boolean +.PP Available in MongoDB Enterprise only. -.UNINDENT -.UNINDENT -.sp -Configure the \fBmongod\fP or \fBmongos\fP to +.PP +Configure the \fBmongod\f1\f1 or \fBmongos\f1\f1 to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. -.sp -Use \fI\%redactClientLogData\fP in conjunction with -/core/security\-encryption\-at\-rest and -/core/security\-transport\-encryption to assist compliance with +.PP +Use \fBredactClientLogData\f1\f1 in conjunction with +\fBEncryption at Rest\f1 and +\fBTLS/SSL (Transport Encryption)\f1 to assist compliance with regulatory requirements. -.sp -To enable log redaction on a running \fBmongod\fP or -\fBmongos\fP, use the following command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, redactClientLogData : true } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBsecurity.redactClientLogData\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B traceExceptions -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Configures \fBmongod\fP to log full source code stack traces +.PP +To enable log redaction on a running \fBmongod\f1 or +\fBmongos\f1, use the following command: +.PP +.EX + db.adminCommand( { setParameter: 1, redactClientLogData : true } ) +.EE +.PP +\fBsecurity.redactClientLogData\f1\f1 +.RE +.PP +\fBtraceExceptions\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Configures \fBmongod\f1\f1 to log full source code stack traces for every database and socket C++ exception, for use with debugging. -If \fBtrue\fP, \fBmongod\fP will log full stack traces. -.sp +If \fBtrue\f1, \fBmongod\f1\f1 will log full stack traces. +.PP Consider the following example which sets the -\fBtraceExceptions\fP to \fBtrue\fP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, traceExceptions: true } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBsystemLog.traceAllExceptions\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B suppressNoTLSPeerCertificateWarning -New in version 4.0.1. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: boolean -.sp -\fIDefault\fP: false -.sp -By default, a \fBmongod\fP or \fBmongos\fP with -TLS/SSL enabled and -\fBnet.ssl.allowConnectionsWithoutCertificates\fP : \fBtrue\fP +\fBtraceExceptions\f1 to \fBtrue\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, traceExceptions: true } ) +.EE +.PP +\fBsystemLog.traceAllExceptions\f1\f1 +.RE +.PP +\fBsuppressNoTLSPeerCertificateWarning\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: false +.PP +By default, a \fBmongod\f1\f1 or \fBmongos\f1\f1 with +\fBTLS/SSL enabled\f1 and +\fBnet.ssl.allowConnectionsWithoutCertificates\f1\f1 : \fBtrue\f1 lets clients connect without providing a certificate for validation while logging an warning. Set -\fBsuppressNoTLSPeerCertificateWarning\fP to \fB1\fP or \fBtrue\fP to +\fBsuppressNoTLSPeerCertificateWarning\f1 to \fB1\f1 or \fBtrue\f1 to suppress those warnings. -.sp -The following operation sets \fBsuppressNoTLSPeerCertificateWarning\fP -to \fBtrue\fP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, suppressNoTLSPeerCertificateWarning: true} ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.SS Diagnostic Parameters -.sp +.PP +The following operation sets \fBsuppressNoTLSPeerCertificateWarning\f1 +to \fBtrue\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, suppressNoTLSPeerCertificateWarning: true} ) +.EE +.RE +.SS DIAGNOSTIC PARAMETERS +.PP To facilitate analysis of the MongoDB server behavior by MongoDB engineers, MongoDB logs server statistics to diagnostic files at periodic intervals. -.sp -For \fBmongod\fP, the diagnostic data files are stored in the -\fBdiagnostic.data\fP directory under the \fBmongod\fP instance\(aqs -\fB\-\-dbpath\fP or \fBstorage.dbPath\fP\&. -.sp -For \fBmongos\fP, the diagnostic data files, by default, are -stored in a directory under the \fBmongos\fP instance\(aqs -\fB\-\-logpath\fP or \fBsystemLog.path\fP directory. The diagnostic +.PP +For \fBmongod\f1\f1, the diagnostic data files are stored in the +\fBdiagnostic.data\f1 directory under the \fBmongod\f1\f1 instance\(aqs +\fB\-\-dbpath\f1 or \fBstorage.dbPath\f1\f1\&. +.PP +For \fBmongos\f1\f1, the diagnostic data files, by default, are +stored in a directory under the \fBmongos\f1\f1 instance\(aqs +\fB\-\-logpath\f1 or \fBsystemLog.path\f1\f1 directory. The diagnostic data directory is computed by truncating the logpath\(aqs file -extension(s) and concatenating \fBdiagnostic.data\fP to the remaining +extension(s) and concatenating \fBdiagnostic.data\f1 to the remaining name. -.sp -For example, if \fBmongos\fP has \fB\-\-logpath -/var/log/mongodb/mongos.log.201708015\fP, then the diagnostic data -directory is \fB/var/log/mongodb/mongos.diagnostic.data/\fP directory. To -specify a different diagnostic data directory for \fBmongos\fP, -set the \fI\%diagnosticDataCollectionDirectoryPath\fP parameter. -.sp +.PP +For example, if \fBmongos\f1\f1 has \fB\-\-logpath +/var/log/mongodb/mongos.log.201708015\f1, then the diagnostic data +directory is \fB/var/log/mongodb/mongos.diagnostic.data/\f1 directory. To +specify a different diagnostic data directory for \fBmongos\f1\f1, +set the \fBdiagnosticDataCollectionDirectoryPath\f1\f1 parameter. +.PP The following parameters support diagnostic data capture (FTDC): -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 +.PP The default values for the diagnostic data capture interval and the maximum sizes are chosen to provide useful data to MongoDB engineers with minimal impact on performance and storage size. Typically, these values will only need modifications as requested by MongoDB engineers for specific diagnostic purposes. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B diagnosticDataCollectionEnabled -New in version 3.2. - -.sp -Changed in version 3.4.14: Available for both \fBmongod\fP and \fBmongos\fP\&. - -.sp -\fIType\fP: boolean -.sp -\fIDefault\fP: true -.sp +.PP +\fBdiagnosticDataCollectionEnabled\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP Determines whether to enable the collecting and logging of data for diagnostic purposes. Diagnostic logging is enabled by default. -.sp +.PP For example, the following disables the diagnostic collection: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter diagnosticDataCollectionEnabled=false -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B diagnosticDataCollectionDirectoryPath -New in version 3.4.14. - -.sp -\fIType\fP: String -.sp -Available for \fBmongos\fP only. -.sp +.PP +.EX + mongod \-\-setParameter diagnosticDataCollectionEnabled=false +.EE +.RE +.PP +\fBdiagnosticDataCollectionDirectoryPath\f1 +.RS +.PP +\fIType\f1: String +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP Specify the directory for the diagnostic directory for -\fBmongos\fP\&. If the directory does not exist, -\fBmongos\fP creates the directory. -.sp +\fBmongos\f1\f1\&. If the directory does not exist, +\fBmongos\f1\f1 creates the directory. +.PP If unspecified, the diagnostic data directory is computed by -truncating the \fBmongos\fP instance\(aqs \fB\-\-logpath\fP or -\fBsystemLog.path\fP file extension(s) and concatenating -\fBdiagnostic.data\fP\&. -.sp -For example, if \fBmongos\fP has \fB\-\-logpath -/var/log/mongodb/mongos.log.201708015\fP, then the diagnostic data -directory is \fB/var/log/mongodb/mongos.diagnostic.data/\fP\&. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -If \fBmongos\fP cannot create the specified directory, e.g. -a file exists with the same name in the path or the process does -not have permissions to create the directory, the diagnostic data -capture will be disabled for that instance. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B diagnosticDataCollectionDirectorySizeMB -New in version 3.2. - -.sp -Changed in version 3.4: Increased default size to 200 megabytes. - -.sp -Changed in version 3.4.14: Available for both \fBmongod\fP and \fBmongos\fP\&. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 200 -.sp -Specifies the maximum size, in megabytes, of the \fBdiagnostic.data\fP +truncating the \fBmongos\f1\f1 instance\(aqs \fB\-\-logpath\f1 or +\fBsystemLog.path\f1\f1 file extension(s) and concatenating +\fBdiagnostic.data\f1\&. +.PP +For example, if \fBmongos\f1\f1 has \fB\-\-logpath +/var/log/mongodb/mongos.log.201708015\f1, then the diagnostic data +directory is \fB/var/log/mongodb/mongos.diagnostic.data/\f1\&. +.PP +If the \fBmongos\f1\f1 cannot create the specified +directory, the diagnostic data capture is disabled for that +instance. This is often caused by: +.RS +.IP \(bu 2 +a file with the same name already exists in the path, or +.IP \(bu 2 +the process does not have permissions to create the directory. +.RE +.RE +.PP +\fBdiagnosticDataCollectionDirectorySizeMB\f1 +.RS +.PP +Increased default size to 200 megabytes. +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 200 +.PP +Specifies the maximum size, in megabytes, of the \fBdiagnostic.data\f1 directory. If directory size exceeds this number, the oldest -diagnostic files in the directory are automatically deleted based on +\fBdiagnostic files in the directory\f1 are automatically deleted based on the timestamp in the file name. -.sp +.PP For example, the following sets the maximum size of the directory to -\fB250\fP megabytes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter diagnosticDataCollectionDirectorySizeMB=250 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fB250\f1 megabytes: +.PP +.EX + mongod \-\-setParameter diagnosticDataCollectionDirectorySizeMB=250 +.EE +.PP The minimum value for -\fI\%diagnosticDataCollectionDirectorySizeMB\fP is \fB10\fP -megabytes. \fI\%diagnosticDataCollectionDirectorySizeMB\fP must +\fBdiagnosticDataCollectionDirectorySizeMB\f1\f1 is \fB10\f1 +megabytes. \fBdiagnosticDataCollectionDirectorySizeMB\f1\f1 must be greater than maximum diagnostic file size -\fI\%diagnosticDataCollectionFileSizeMB\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B diagnosticDataCollectionFileSizeMB -New in version 3.2. - -.sp -Changed in version 3.4.14: Available for both \fBmongod\fP and \fBmongos\fP\&. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 10 -.sp -Specifies the maximum size, in megabytes, of each diagnostic -file\&. If the file exceeds the maximum +\fBdiagnosticDataCollectionFileSizeMB\f1\f1\&. +.RE +.PP +\fBdiagnosticDataCollectionFileSizeMB\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 10 +.PP +Specifies the maximum size, in megabytes, of each \fBdiagnostic +file\f1\&. If the file exceeds the maximum file size, MongoDB creates a new file. -.sp +.PP For example, the following sets the maximum size of each diagnostic -file to \fB20\fP megabytes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter diagnosticDataCollectionFileSizeMB=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +file to \fB20\f1 megabytes: +.PP +.EX + mongod \-\-setParameter diagnosticDataCollectionFileSizeMB=20 +.EE +.PP The minimum value for -\fI\%diagnosticDataCollectionFileSizeMB\fP is \fB1\fP megabyte. -.UNINDENT -.INDENT 0.0 -.TP -.B diagnosticDataCollectionPeriodMillis -New in version 3.2. - -.sp -Changed in version 3.4.14: Available for both \fBmongod\fP and \fBmongos\fP\&. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 1000 -.sp +\fBdiagnosticDataCollectionFileSizeMB\f1\f1 is \fB1\f1 megabyte. +.RE +.PP +\fBdiagnosticDataCollectionPeriodMillis\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 1000 +.PP Specifies the interval, in milliseconds, at which to collect diagnostic data. -.sp +.PP For example, the following sets the interval to -\fB5000\fP milliseconds or 5 seconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter diagnosticDataCollectionPeriodMillis=5000 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fB5000\f1 milliseconds or 5 seconds: +.PP +.EX + mongod \-\-setParameter diagnosticDataCollectionPeriodMillis=5000 +.EE +.PP The minimum value for -\fI\%diagnosticDataCollectionPeriodMillis\fP is \fB100\fP +\fBdiagnosticDataCollectionPeriodMillis\f1\f1 is \fB100\f1 milliseconds. -.UNINDENT -.SS Logical Session Parameters -.INDENT 0.0 -.TP -.B logicalSessionRefreshMillis -.INDENT 7.0 -.INDENT 3.5 -.IP "Availability" -.sp +.RE +.SS REPLICATION AND CONSISTENCY +.PP +\fBenableOverrideClusterChainingSetting\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: false +.PP +If \fBenableOverrideClusterChainingSetting\f1\f1 is \fBtrue\f1, +replica set \fBsecondary\f1 members can replicate data from +other secondary members even if \fBsettings.chainingAllowed\f1\f1 is +\fBfalse\f1\&. +.PP +You can only set \fBenableOverrideClusterChainingSetting\f1\f1 at +startup and cannot change this setting with the +\fBsetParameter\f1\f1 command. +.PP +For example, to set the +\fBenableOverrideClusterChainingSetting\f1\f1 for a +\fBmongod\f1\f1 instance to \fBtrue\f1: +.PP +.EX + mongod \-\-setParameter enableOverrideClusterChainingSetting=true +.EE +.RE +.PP +\fBlogicalSessionRefreshMillis\f1 +.RS +.PP New in version 4.0.4 (and version 3.6.9). -.UNINDENT -.UNINDENT -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 300000 (i.e. 5 minutes) -.sp +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 300000 (5 minutes) +.PP The interval (in milliseconds) at which the cache refreshes its logical session records against the main session store. -.sp -You can only set \fI\%logicalSessionRefreshMillis\fP at +.PP +You can only set \fBlogicalSessionRefreshMillis\f1\f1 at startup and cannot change this setting with the -\fBsetParameter\fP command. -.sp -For example, to set the \fI\%logicalSessionRefreshMillis\fP -for a \fBmongod\fP instance to 10 minutes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter logicalSessionRefreshMillis=600000 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B localLogicalSessionTimeoutMinutes -New in version 3.6. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 30 -.INDENT 7.0 -.INDENT 3.5 -.IP "For testing purposes only" -.sp +\fBsetParameter\f1\f1 command. +.PP +For example, to set the \fBlogicalSessionRefreshMillis\f1\f1 +for a \fBmongod\f1\f1 instance to 10 minutes: +.PP +.EX + mongod \-\-setParameter logicalSessionRefreshMillis=600000 +.EE +.RE +.PP +\fBlocalLogicalSessionTimeoutMinutes\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 30 +.PP This parameter is intended for testing purposes only and not for production use. -.UNINDENT -.UNINDENT -.sp -The time in minutes that a session remains active +.PP +The time in minutes that a \fBsession\f1 remains active after its most recent use. Sessions that have not received a new read/write operation from the client or been refreshed with -\fBrefreshSessions\fP within this threshold are cleared from the +\fBrefreshSessions\f1\f1 within this threshold are cleared from the cache. State associated with an expired session may be cleaned up by the server at any time. -.sp +.PP This parameter applies only to the instance on which it is set. To set this parameter on replica sets and sharded clusters, you must specify the same value on every member; otherwise, sessions will not function properly. -.sp -You can only set \fI\%localLogicalSessionTimeoutMinutes\fP at +.PP +You can only set \fBlocalLogicalSessionTimeoutMinutes\f1\f1 at startup and cannot change this setting with the -\fBsetParameter\fP command. -.sp -For example, to set the \fI\%localLogicalSessionTimeoutMinutes\fP -for a test \fBmongod\fP instance to 20 minutes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter localLogicalSessionTimeoutMinutes=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B maxAcceptableLogicalClockDriftSecs -New in version 3.6. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 31536000 (1 year) -.sp +\fBsetParameter\f1\f1 command. +.PP +For example, to set the \fBlocalLogicalSessionTimeoutMinutes\f1\f1 +for a test \fBmongod\f1\f1 instance to 20 minutes: +.PP +.EX + mongod \-\-setParameter localLogicalSessionTimeoutMinutes=20 +.EE +.RE +.PP +\fBmaxAcceptableLogicalClockDriftSecs\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 31536000 (1 year) +.PP The maximum amount by which the current cluster time can be advanced; -i.e., \fI\%maxAcceptableLogicalClockDriftSecs\fP is the maximum -difference between the new value of the cluster time and the current -cluster time. Cluster time is a logical time used for ordering of -operations. -.sp +specifically, \fBmaxAcceptableLogicalClockDriftSecs\f1\f1 is the +maximum difference between the new value of the cluster time and the +current cluster time. Cluster time is a logical time used for +ordering of operations. +.PP You cannot advance the cluster time to a new value if the new cluster time differs from the current cluster time by more than -\fI\%maxAcceptableLogicalClockDriftSecs\fP, -.sp -You can only set \fI\%maxAcceptableLogicalClockDriftSecs\fP at +\fBmaxAcceptableLogicalClockDriftSecs\f1\f1\&. +.PP +You can only set \fBmaxAcceptableLogicalClockDriftSecs\f1\f1 at startup and cannot change this setting with the -\fBsetParameter\fP command. -.sp -For example, to set the \fI\%maxAcceptableLogicalClockDriftSecs\fP -for a \fBmongod\fP instance to 15 minutes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter maxAcceptableLogicalClockDriftSecs=900 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B maxSessions -New in version 4.0.1. - -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 1000000 -.sp +\fBsetParameter\f1\f1 command. +.PP +For example, to set the \fBmaxAcceptableLogicalClockDriftSecs\f1\f1 +for a \fBmongod\f1\f1 instance to 15 minutes: +.PP +.EX + mongod \-\-setParameter maxAcceptableLogicalClockDriftSecs=900 +.EE +.RE +.PP +\fBmaxSessions\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 1000000 +.PP The maximum number of sessions that can be cached. -.sp -You can only set \fI\%maxSessions\fP during start\-up. -.sp -For example, to set the \fI\%maxSessions\fP -for a \fBmongod\fP instance to 1000: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter maxSessions=1000 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B TransactionRecordMinimumLifetimeMinutes -New in version 3.6. - -.sp -Available for \fBmongod\fP only. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 30 -.sp +.PP +You can only set \fBmaxSessions\f1\f1 during start\-up. +.PP +For example, to set the \fBmaxSessions\f1\f1 +for a \fBmongod\f1\f1 instance to 1000: +.PP +.EX + mongod \-\-setParameter maxSessions=1000 +.EE +.RE +.PP +\fBstoreFindAndModifyImagesInSideCollection\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Determines whether the temporary documents required for +\fBretryable\f1 \fBfindAndModify\f1\f1 +commands are stored in the \fIside\f1 collection +(\fBconfig.image_collection\f1). +.PP +If \fBstoreFindAndModifyImagesInSideCollection\f1\f1 is: +.RS +.IP \(bu 2 +\fBtrue\f1, the temporary documents are stored in the side +collection. +.IP \(bu 2 +\fBfalse\f1, the temporary documents are stored in the \fBreplica +set oplog\f1\&. +.RE +.PP +Keep \fBstoreFindAndModifyImagesInSideCollection\f1\f1 set to +\fBtrue\f1 if you: +.RS +.IP \(bu 2 +Have a large \fBretryable\f1 +\fBfindAndModify\f1\f1 workload. +.IP \(bu 2 +Require more temporary document space for \fBretryable\f1 \fBfindAndModify\f1\f1 commands than is +available in the \fBreplica set oplog\f1\&. +.RE +.PP +\fBSecondaries\f1 may experience increased CPU +usage when \fBstoreFindAndModifyImagesInSideCollection\f1\f1 +is \fBtrue\f1\&. +.PP +For example, to set +\fBstoreFindAndModifyImagesInSideCollection\f1\f1 to \fBfalse\f1 +during startup: +.PP +.EX + mongod \-\-setParameter storeFindAndModifyImagesInSideCollection=false +.EE +.PP +During runtime, you can also set the parameter with the +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, storeFindAndModifyImagesInSideCollection: false } ) +.EE +.RE +.PP +\fBTransactionRecordMinimumLifetimeMinutes\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 30 +.PP The minimum lifetime a transaction record exists in the -\fBtransactions\fP collection before the record becomes +\fBtransactions\f1\f1 collection before the record becomes eligible for cleanup. -.sp -You can only set \fI\%TransactionRecordMinimumLifetimeMinutes\fP at +.PP +You can only set \fBTransactionRecordMinimumLifetimeMinutes\f1\f1 at startup and cannot change this setting with the -\fBsetParameter\fP command. -.sp -For example, to set the \fI\%TransactionRecordMinimumLifetimeMinutes\fP -for a \fBmongod\fP instance to 20 minutes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter TransactionRecordMinimumLifetimeMinutes=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%localLogicalSessionTimeoutMinutes\fP -.UNINDENT -.UNINDENT -.UNINDENT -.SS Replication Parameters -.INDENT 0.0 -.TP -.B enableFlowControl -New in version 4.2. - -.sp -\fIType\fP: boolean -.sp -\fIDefault\fP: true -.sp +\fBsetParameter\f1\f1 command. +.PP +For example, to set the \fBTransactionRecordMinimumLifetimeMinutes\f1\f1 +for a \fBmongod\f1\f1 instance to 20 minutes: +.PP +.EX + mongod \-\-setParameter TransactionRecordMinimumLifetimeMinutes=20 +.EE +.PP +\fBlocalLogicalSessionTimeoutMinutes\f1\f1 +.RE +.PP +\fBenableFlowControl\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP Enables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members\(aq -\fBmajority committed\fP lag under a +\fBmajority committed\f1\f1 lag under a configurable maximum value. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP For flow control to engage, the replica set/sharded cluster must -have: featureCompatibilityVersion (FCV) of -\fB4.2\fP and read concern \fBmajority enabled\fP\&. That is, enabled flow -control has no effect if FCV is not \fB4.2\fP or if read concern +have: \fBfeatureCompatibilityVersion (FCV)\f1 of +\fB4.2\f1 and read concern \fBmajority enabled\f1\f1\&. That is, enabled flow +control has no effect if FCV is not \fB4.2\f1 or if read concern majority is disabled. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B flowControlTargetLagSeconds -New in version 4.2. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 10 -.sp -The target maximum \fBmajority committed\fP lag when running +.RE +.PP +\fBflowControlTargetLagSeconds\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 10 +.PP +The target maximum \fBmajority committed\f1\f1 lag when running with flow control. When flow control is enabled, the mechanism -attempts to keep the \fBmajority committed\fP lag under +attempts to keep the \fBmajority committed\f1\f1 lag under the specified seconds. The parameter has no effect if flow control is disabled. -.sp +.PP The specified value must be greater than 0. -.sp +.PP In general, the default settings should suffice; however, if modifying from the default value, decreasing, rather than increasing, the value may prove to be more useful. -.UNINDENT -.INDENT 0.0 -.TP -.B flowControlWarnThresholdSeconds -New in version 4.2. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 10 -.sp +.RE +.PP +\fBflowControlWarnThresholdSeconds\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 10 +.PP The amount of time to wait to log a warning once the flow control mechanism detects the majority commit point has not moved. -.sp +.PP The specified value must be greater than or equal to 0, with 0 to disable warnings. -.UNINDENT -.INDENT 0.0 -.TP -.B initialSyncTransientErrorRetryPeriodSeconds -New in version 4.4. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 86400 -.sp +.RE +.PP +\fBinitialSyncTransientErrorRetryPeriodSeconds\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 86400 +.PP The amount of time in seconds a secondary performing initial sync attempts to resume the process if interrupted by a transient network error. The default value is equivalent to 24 hours. -.UNINDENT -.INDENT 0.0 -.TP -.B initialSyncSourceReadPreference -New in version 4.4. - -.sp -\fIType\fP: String -.sp -Available for \fBmongod\fP only. -.sp -The preferred source for performing initial sync\&. Specify one of the following read +.RE +.PP +\fBinitialSyncSourceReadPreference\f1 +.RS +.PP +\fIType\f1: String +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +The preferred source for performing \fBinitial sync\f1\&. Specify one of the following read preference modes: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBprimary\fP +\fBprimary\f1\f1 .IP \(bu 2 -\fBprimaryPreferred\fP (Default for voting replica set members) +\fBprimaryPreferred\f1\f1 (Default for voting replica set members) .IP \(bu 2 -\fBsecondary\fP +\fBsecondary\f1\f1 .IP \(bu 2 -\fBsecondaryPreferred\fP +\fBsecondaryPreferred\f1\f1 .IP \(bu 2 -\fBnearest\fP (Default for newly added \fIor\fP non\-voting replica set members) -.UNINDENT -.sp -If the replica set has disabled \fBchaining\fP, the default -\fI\%initialSyncSourceReadPreference\fP read preference mode -is \fBprimary\fP\&. -.sp -You cannot specify a tag set or \fBmaxStalenessSeconds\fP to -\fI\%initialSyncSourceReadPreference\fP\&. -.sp -If the \fBmongod\fP cannot find a sync source based on the +\fBnearest\f1\f1 (Default for newly added \fIor\f1 non\-voting replica set members) +.RE +.PP +If the replica set has disabled \fBchaining\f1\f1, the default +\fBinitialSyncSourceReadPreference\f1\f1 read preference mode +is \fBprimary\f1\f1\&. +.PP +You cannot specify a tag set or \fBmaxStalenessSeconds\f1 to +\fBinitialSyncSourceReadPreference\f1\f1\&. +.PP +If the \fBmongod\f1\f1 cannot find a sync source based on the specified read preference, it logs an error and restarts the initial -sync process. The \fBmongod\fP exits with an error if it -cannot complete the initial sync process after \fB10\fP attempts. For +sync process. The \fBmongod\f1\f1 exits with an error if it +cannot complete the initial sync process after \fB10\f1 attempts. For more information on sync source selection, see -replica\-set\-initial\-sync\-source\-selection\&. -.sp -\fI\%initialSyncSourceReadPreference\fP takes precedence over -the replica set\(aqs \fBsettings.chainingAllowed\fP setting when +\fBInitial Sync Source Selection\f1\&. +.PP +\fBinitialSyncSourceReadPreference\f1\f1 takes precedence over +the replica set\(aqs \fBsettings.chainingAllowed\f1\f1 setting when selecting an initial sync source. After a replica set member successfully completes initial sync, it defers to the value of -\fBchainingAllowed\fP when selecting a replication sync +\fBchainingAllowed\f1\f1 when selecting a replication sync source. -.sp +.PP You can only set this parameter on startup, using either the -\fBsetParameter\fP +\fBsetParameter\f1\f1 configuration file setting or the -\fB\-\-setParameter\fP command line option. -.UNINDENT -.INDENT 0.0 -.TP -.B oplogInitialFindMaxSeconds -New in version 3.6. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 60 -.sp -Available for \fBmongod\fP only. -.sp -Maximum time in seconds for a member of a replica set to wait -for the \fBfind\fP command to finish during -data synchronization\&. -.UNINDENT -.INDENT 0.0 -.TP -.B replWriterThreadCount -New in version 3.2. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 16 -.sp -Available for \fBmongod\fP only. -.sp -Number of threads to use to apply replicated operations in parallel. -Values can range from 1 to 256 inclusive. You can only set -\fI\%replWriterThreadCount\fP at startup and cannot change this -setting with the \fBsetParameter\fP command. -.UNINDENT -.INDENT 0.0 -.TP -.B rollbackTimeLimitSecs -\fIType\fP: 64\-bit integer -.sp -\fIDefault\fP: 86400 (1 day) -.sp +\fB\-\-setParameter\f1\f1 command line option. +.RE +.PP +\fBmaxNumSyncSourceChangesPerHour\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 3 +.PP +\fBSync sources\f1 +are evaluated each time a sync source is updated and each time a +node fetches a batch of oplog entries. If there are more than +\fBmaxNumSyncSourceChangesPerHour\f1 source changes in an hour, the +node temporarily stops re\-evaluating that sync source. If this +parameter is set with a high value, the node may make unnecessary +source changes. +.PP +This parameter will not prevent a node from starting to sync from +another node if it doesn\(aqt have a sync source. The node will +re\-evaluate if a sync source becomes invalid. Similarly, if the +primary changes and chaining is disabled, the node will update to +sync from the new primary. +.RE +.PP +\fBoplogFetcherUsesExhaust\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Enables or disables \fBstreaming replication\f1\&. Set the value to \fBtrue\f1 to enable +streaming replication. +.PP +Set the value to \fBfalse\f1 to disable streaming replication. If +disabled, secondaries fetch batches of \fBoplog\f1 +entries by issuing a request to their \fIsync from\f1 source and waiting for a +response. This requires a network roundtrip for each batch of \fBoplog\f1 entries. +.PP +You can only set this parameter on startup, using either the +\fBsetParameter\f1\f1 configuration file setting or the +\fB\-\-setParameter\f1\f1 command line option. +.RE +.PP +\fBoplogInitialFindMaxSeconds\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 60 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Maximum time in seconds for a member of a \fBreplica set\f1 to wait +for the \fBfind\f1\f1 command to finish during +\fBdata synchronization\f1\&. +.RE +.PP +\fBreplWriterThreadCount\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 16 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Maximum number of threads to use to apply replicated operations in +parallel. Values can range from 1 to 256 inclusive. You can only set +\fBreplWriterThreadCount\f1\f1 at startup and cannot change this +setting with the \fBsetParameter\f1\f1 command. +.PP +\fBreplWriterMinThreadCount\f1\f1 +.RE +.PP +\fBreplWriterMinThreadCount\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 0 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Minimum number of threads to use to apply replicated operations in +parallel. Values can range from 0 to 256 inclusive. You can only set +\fBreplWriterMinThreadCount\f1\f1 at startup and cannot change +this setting with the \fBsetParameter\f1\f1 command. +.PP +Parallel application of replication operations uses up to +\fBreplWriterThreadCount\f1\f1 threads. If +\fBreplWriterMinThreadCount\f1\f1 is configured with a value +less than \fBreplWriterThreadCount\f1\f1, the thread pool will +timeout idle threads until the total count of threads in the thread +pool is equal to \fBreplWriterMinThreadCount\f1\f1\&. +.PP +\fBreplWriterMinThreadCount\f1\f1 must be configured with a value +that is less than or equal to \fBreplWriterThreadCount\f1\f1\&. +.RE +.PP +\fBrollbackTimeLimitSecs\f1 +.RS +.PP +\fIType\f1: 64\-bit integer +.PP +\fIDefault\f1: 86400 (1 day) +.PP Maximum age of data that can be rolled back. Negative values for this parameter are not valid. -.sp +.PP Starting in MongoDB 4.2+ and 4.0.13+, if the time between the end of the to\-be\-rolledback instance\(aqs oplog and the first operation after the common point (the last point where the source node and the to\-be\-rolledback node had the same data) exceeds this value, the rollback will fail. -.sp +.PP In MongoDB 4.0.0\-4.0.12, if the time between the end of the to\-be\-rolledback instance\(aqs oplog and the common point (the last point where the source node and the to\-be\-rolledback node had the same data) exceeds this value, the rollback will fail. -.sp +.PP To effectively have an unlimited rollback period, set the value to -\fB2147483647\fP which is the maximum value allowed and equivalent to +\fB2147483647\f1 which is the maximum value allowed and equivalent to roughly 68 years. -.sp -New in version 4.0. - -.UNINDENT -.INDENT 0.0 -.TP -.B waitForSecondaryBeforeNoopWriteMS -New in version 3.6. - -.sp -Available for \fBmongod\fP only. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 10 -.sp +.RE +.PP +\fBwaitForSecondaryBeforeNoopWriteMS\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 10 +.PP The length of time (in milliseconds) that a secondary must wait if -the \fBafterClusterTime\fP is greater than the last applied time from -the oplog. After the \fBwaitForSecondaryBeforeNoopWriteMS\fP passes, -if the \fBafterClusterTime\fP is still greater than the last applied +the \fBafterClusterTime\f1 is greater than the last applied time from +the oplog. After the \fBwaitForSecondaryBeforeNoopWriteMS\f1 passes, +if the \fBafterClusterTime\f1 is still greater than the last applied time, the secondary makes a no\-op write to advance the last applied time. -.sp +.PP The following example sets the -\fI\%waitForSecondaryBeforeNoopWriteMS\fP to 20 milliseconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter waitForSecondaryBeforeNoopWriteMS=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBwaitForSecondaryBeforeNoopWriteMS\f1\f1 to 20 milliseconds: +.PP +.EX + mongod \-\-setParameter waitForSecondaryBeforeNoopWriteMS=20 +.EE +.PP During runtime, you can also set the parameter with the -\fBsetParameter\fP command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, waitForSecondaryBeforeNoopWriteMS: 20 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B createRollbackDataFiles -Available for \fBmongod\fP only. -.sp -\fIType\fP: boolean -.sp -\fIDefault\fP: true -.sp -New in version 4.0. - -.sp -Flag that determines whether MongoDB creates rollback files that contains documents affected during a +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, waitForSecondaryBeforeNoopWriteMS: 20 } ) +.EE +.RE +.PP +\fBcreateRollbackDataFiles\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Flag that determines whether MongoDB creates \fBrollback files\f1 that contains documents affected during a rollback. -.sp -By default, \fI\%createRollbackDataFiles\fP is \fBtrue\fP and +.PP +By default, \fBcreateRollbackDataFiles\f1\f1 is \fBtrue\f1 and MongoDB creates the rollback files. -.sp -The following example sets \fI\%createRollbackDataFiles\fP +.PP +The following example sets \fBcreateRollbackDataFiles\f1\f1 to false so that the rollback files are not created: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter createRollbackDataFiles=false -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongod \-\-setParameter createRollbackDataFiles=false +.EE +.PP During runtime, you can also set the parameter with the -\fBsetParameter\fP command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, createRollbackDataFiles: false } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -For more information, see rollback\-data\-files\&. -.UNINDENT -.INDENT 0.0 -.TP -.B enableElectionHandoff -New in version 4.0.2. - -.sp -\fIType\fP: boolean -.sp -\fIDefault\fP: true -.sp -A flag that can reduce the downtime after the primary steps down -from either the \fBrs.stepDown()\fP method or the -\fBreplSetStepDown\fP command. Specifically, if true, when a -primary steps down after \fBrs.stepDown()\fP (or the -\fBreplSetStepDown\fP command without the \fBforce: true\fP), -it nominates an eligible secondary to call an election immediately. -If false, after the step down, secondaries can wait up to -\fBsettings.electionTimeoutMillis\fP before calling an election. -.sp +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, createRollbackDataFiles: false } ) +.EE +.PP +For more information, see \fBCollect Rollback Data\f1\&. +.RE +.PP +\fBenableElectionHandoff\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +A flag that can reduce the downtime after the primary steps down from +either the \fBrs.stepDown()\f1\f1 method or the +\fBreplSetStepDown\f1\f1 command. +.PP +If the flag is true, when a primary steps down after +\fBrs.stepDown()\f1\f1 (or the \fBreplSetStepDown\f1\f1 command +without the \fBforce: true\f1), the primary nominates an eligible +secondary to call an election immediately. +.PP +If the flag is false, after the step down, secondaries can wait up to +\fBsettings.electionTimeoutMillis\f1\f1 before calling an election. +.PP An eligible secondary must be caught up with the stepped down -primary and have \fBpriority\fP greater than 0. If +primary and have \fBpriority\f1\f1 greater than 0. If multiple secondary members meet this criteria, the stepped down primary selects the eligible secondary with the highest -\fBpriority\fP\&. If the more than one eligible -secondary members have the same \fBpriority\fP, the +\fBpriority\f1\f1\&. If the more than one eligible +secondary members have the same \fBpriority\f1\f1, the stepped down primary selects the secondary with the lowest -\fB_id\fP\&. The stepped down primary does not wait +\fB_id\f1\f1\&. The stepped down primary does not wait for the effects of the handoff. -.sp +.PP The parameter has no impact if the primary steps down for reasons -other than \fBrs.stepDown()\fP (or the -\fBreplSetStepDown\fP command without the \fBforce: true\fP). -.UNINDENT -.INDENT 0.0 -.TP -.B replBatchLimitBytes -\fIDefault\fP: 104857600 (100MB) -.sp +other than \fBrs.stepDown()\f1\f1 (or the +\fBreplSetStepDown\f1\f1 command without the \fBforce: true\f1). +.RE +.PP +\fBreplBatchLimitBytes\f1 +.RS +.PP +\fIDefault\f1: 104857600 (100MB) +.PP Sets the maximum oplog application batch size in bytes. -.sp +.PP Values can range from 16777216 (16MB) to 104857600 (100MB) inclusive. -.sp -The following example sets \fI\%replBatchLimitBytes\fP +.PP +The following example sets \fBreplBatchLimitBytes\f1\f1 to 64 MB so that the rollback files are not created: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter replBatchLimitBytes=67108864 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongod \-\-setParameter replBatchLimitBytes=67108864 +.EE +.PP During runtime, you can also set the parameter with the -\fBsetParameter\fP command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, replBatchLimitBytes: 64 * 1024 * 1024 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -New in version 4.0.10. - -.UNINDENT -.INDENT 0.0 -.TP -.B mirrorReads -Available for \fBmongod\fP only. -.sp -\fINew in version 4.4\fP -.sp -\fIType\fP: Document -.sp -\fIDefault\fP: \fB{ samplingRate: 0.01, maxTimeMS: 1000 }\fP -.sp -Specifies the settings for mirrored reads -for the \fBmongod\fP instance. The settings only take +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, replBatchLimitBytes: 64 * 1024 * 1024 } ) +.EE +.RE +.PP +\fBmirrorReads\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fINew in version 4.4\f1 +.PP +\fIType\f1: Document +.PP +\fIDefault\f1: \fB{ samplingRate: 0.01, maxTimeMS: 1000 }\f1 +.PP +Specifies the settings for \fBmirrored reads\f1 +for the \fBmongod\f1\f1 instance. The settings only take effect when the member is a primary. -.sp -The parameter \fI\%mirrorReads\fP takes a JSON document with +.PP +The parameter \fBmirrorReads\f1\f1 takes a JSON document with the following fields: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Field -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsamplingRate\fP -T} T{ -The sampling rate used to mirror a subset of operations -that support mirroring -to a subset of electable (i.e. \fBpriority greater than -0\fP) secondaries. That is, the primary -mirrors reads to each electable secondary at the specified -sampling rate. -.sp -Valid values are greater than or equal to \fB0.0\fP and less -than or equal to \fB1.0\fP\&. Value of \fB0.0\fP turns off mirroring. -.sp +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsamplingRate\f1 +.IP \(bu 4 +The sampling rate used to mirror a subset of \fBoperations +that support mirroring\f1 +to a subset of electable (specifically, \fBpriority +greater than 0\f1\f1) secondaries. That is, +the primary mirrors reads to each electable secondary at the +specified sampling rate. +.IP +Valid values are: +.RS +.IP \(bu 6 +.RS +.IP \(bu 8 +\fB0.0\f1 +.IP \(bu 8 +Turns off mirroring. +.RE +.IP \(bu 6 +.RS +.IP \(bu 8 +\fB1.0\f1 +.IP \(bu 8 +The primary mirrors all \fBoperations that supports +mirroring\f1 to +each electable secondary. +.RE +.IP \(bu 6 +.RS +.IP \(bu 8 +Number between \fB0.0\f1 and \fB1.0\f1 (exclusive) +.IP \(bu 8 +The primary randomly samples each electable secondary +at the specified rate to be sent mirrored reads. +.RE +.RE +.IP For example, given a replica set with a primary and two -electable secondaries and a sampling rate of \fB0.10\fP, the +electable secondaries and a sampling rate of \fB0.10\f1, the primary mirrors reads to each electable secondary at the sampling rate of 10 percent such that one read may be mirrored to one secondary and not to the other or to both or -to neither. That is, if the primary receives \fB100\fP +to neither. That is, if the primary receives \fB100\f1 operations that can be mirrored, the sampling rate of -\fB0.10\fP may result in \fB8\fP reads being mirrored to one -secondary and \fB13\fP reads to the other or \fB10\fP to each, +\fB0.10\f1 may result in \fB8\f1 reads being mirrored to one +secondary and \fB13\f1 reads to the other or \fB10\f1 to each, etc. -.sp -The default value is \fB0.01\fP\&. -T} -_ -T{ -\fBmaxTimeMS\fP -T} T{ +.IP +The default value is \fB0.01\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBmaxTimeMS\f1 +.IP \(bu 4 The maximum time in milliseconds for the mirrored reads. The -default value is \fB1000\fP\&. -.sp -The \fBmaxTimeMS\fP for the mirrored reads is separate from the -\fBmaxTimeMS\fP of the original read being mirrored. -T} -_ -.TE -.sp -You can set \fI\%mirrorReads\fP during startup in the -\fBconfiguration file\fP or with the -\fB\-\-setParameter\fP option on the command line. If specifying from -the configuration file or on the command line, \fBenclose the\fP -\fBmirrorReads\fP \fBdocument in quotes\fP\&. -.sp +default value is \fB1000\f1\&. +.IP +The \fBmaxTimeMS\f1 for the mirrored reads is separate from the +\fBmaxTimeMS\f1 of the original read being mirrored. +.RE +.RE +.PP +You can set \fBmirrorReads\f1\f1 during startup in the +\fBconfiguration file\f1\f1 or with the +\fB\-\-setParameter\f1 option on the command line. If specifying from +the configuration file or on the command line, \fBenclose the\f1 +\fBmirrorReads\f1 \fBdocument in quotes\f1\&. +.PP For example, the following sets the mirror reads sampling rate to -\fB0.10\fP from the command line: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter mirrorReads=\(aq{ samplingRate: 0.10 }\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fB0.10\f1 from the command line: +.PP +.EX + mongod \-\-setParameter mirrorReads=\(aq{ samplingRate: 0.10 }\(aq +.EE +.PP Or, to specify in a configuration file: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -setParameter: - mirrorReads: \(aq{samplingRate: 0.10}\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Or if using the \fBsetParameter\fP command in a -\fBmongo\fP shell connected to a running -\fBmongod\fP, do \fBnot\fP enclose the document in quotes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, mirrorReads: { samplingRate: 0.10 } } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.SS Sharding Parameters -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 +.PP +.EX + setParameter: + mirrorReads: \(aq{samplingRate: 0.10}\(aq +.EE +.PP +Or if using the \fBsetParameter\f1\f1 command in a +\fBmongosh\f1\f1 session that is connected to a running +\fBmongod\f1\f1, do \fBnot\f1 enclose the document in quotes: +.PP +.EX + db.adminCommand( { setParameter: 1, mirrorReads: { samplingRate: 0.10 } } ) +.EE +.RE +.SS SHARDING PARAMETERS +.PP Starting in version 4.2, MongoDB removes the parameter -\fBAsyncRequestsSenderUseBaton\fP and always enables the performance +\fBAsyncRequestsSenderUseBaton\f1 and always enables the performance enhancement controlled by the parameter. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B enableShardedIndexConsistencyCheck -\fINew in version 4.4 (and 4.2.6).\fP -.sp -\fIType\fP: boolean -.sp -\fIDefault\fP: true -.sp -Available for \fBmongod\fP only. -.sp +.PP +\fBdisableResumableRangeDeleter\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: false +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +If set on a shard\(aqs primary, specifies if range deletion is paused on +the shard. If set to \fBtrue\f1, cleanup of \fBchunk\(garanges +containing :term:\(gaorphaned documents\f1 is paused. +The shard can continue to donate chunks to other shards, but the +donated documents will not be removed from this shard until you set +this parameter to \fBfalse\f1\&. This shard can continue to receive +chunks from other shards as long as it does not have a pending range +deletion task in the \fBconfig.rangeDeletions\f1\f1 collection that +overlaps with the incoming chunk\(aqs range. +.PP +When \fBdisableResumableRangeDeleter\f1\f1 is \fBtrue\f1, chunk +migrations fail if \fBorphaned documents\f1 +exist on the recipient shard\(aqs primary in the same range as the +incoming chunks. +.PP +The parameter has no effect on the \fBmongod\f1\f1 if it is not +the shard\(aqs primary. +.PP +If you set \fBdisableResumableRangeDeleter\f1\f1 parameter to +\fBtrue\f1, ensure that you apply it consistently for all members in +the shard\(aqs replica set. In the event of a failover, this +setting\(aqs value on the new primary dictates the behavior of the +range deleter. +.PP +You can only set this parameter during start\-up and cannot change +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongod \-\-setParameter disableResumableRangeDeleter=false +.EE +.RE +.PP +\fBenableShardedIndexConsistencyCheck\f1 +.RS +.PP +\fINew in version 4.4 (and 4.2.6).\f1 +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP If set on the config server\(aqs primary, enables or disables the index consistency check for sharded collections. The parameter has no -effect on the \fBmongod\fP if it is not the config server\(aqs +effect on the \fBmongod\f1\f1 if it is not the config server\(aqs primary. -.sp +.PP The following example sets -\fI\%enableShardedIndexConsistencyCheck\fP to \fBfalse\fP for a +\fBenableShardedIndexConsistencyCheck\f1\f1 to \fBfalse\f1 for a config server primary: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter enableShardedIndexConsistencyCheck=false -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongod \-\-setParameter enableShardedIndexConsistencyCheck=false +.EE +.PP During runtime, you can also set the parameter with the -\fBsetParameter\fP command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, enableShardedIndexConsistencyCheck: false } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%shardedIndexConsistencyCheckIntervalMS\fP parameter -.IP \(bu 2 -\fBshardedIndexConsistency\fP metrics returned by the -\fBserverStatus\fP command. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B shardedIndexConsistencyCheckIntervalMS -\fINew in version 4.4 (and 4.2.6).\fP -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 600000 -.sp -Available for \fBmongod\fP only. -.sp +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, enableShardedIndexConsistencyCheck: false } ) +.EE +.RS +.IP \(bu 2 +\fBshardedIndexConsistencyCheckIntervalMS\f1\f1 parameter +.IP \(bu 2 +\fBshardedIndexConsistency\f1\f1 metrics returned by the +\fBserverStatus\f1\f1 command. +.RE +.RE +.PP +\fBshardedIndexConsistencyCheckIntervalMS\f1 +.RS +.PP +\fINew in version 4.4 (and 4.2.6).\f1 +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 600000 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP If set on the config server\(aqs primary, the interval, in milliseconds, at which the config server\(aqs primary checks the index consistency of sharded collections. The parameter has no effect on -the \fBmongod\fP if it is not the config server\(aqs primary. -.sp +the \fBmongod\f1\f1 if it is not the config server\(aqs primary. +.PP You can only set the parameter during startup, and cannot change -this setting using the \fBsetParameter\fP database command. -.sp +this setting using the \fBsetParameter\f1\f1 database command. +.PP For example, the following sets the interval at 300000 milliseconds -(i.e. 5 minutes) at startup: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter shardedIndexConsistencyCheckIntervalMS=300000 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%enableShardedIndexConsistencyCheck\fP parameter -.IP \(bu 2 -\fBshardedIndexConsistency\fP metrics returned by the -\fBserverStatus\fP commandq -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B maxTimeMSForHedgedReads -New in version 4.4. - -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 150 -.sp -Available for \fBmongos\fP only. -.sp +(5 minutes) at startup: +.PP +.EX + mongod \-\-setParameter shardedIndexConsistencyCheckIntervalMS=300000 +.EE +.RS +.IP \(bu 2 +\fBenableShardedIndexConsistencyCheck\f1\f1 parameter +.IP \(bu 2 +\fBshardedIndexConsistency\f1\f1 metrics returned by the +\fBserverStatus\f1\f1 commandq +.RE +.RE +.PP +\fBenableFinerGrainedCatalogCacheRefresh\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +This parameter allows the catalog cache to be refreshed only if the +shard needs to be refreshed. If disabled, any stale chunk will cause +the entire chunk distribution for a collection to be considered stale +and force all \fBrouters\f1 who +contact the shard to refresh their shard catalog cache. +.PP +You can only set this parameter during start\-up and cannot change +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongod \-\-setParameter enableFinerGrainedCatalogCacheRefresh=true + mongos \-\-setParameter enableFinerGrainedCatalogCacheRefresh=true +.EE +.RS +.IP \(bu 2 +\fBSharding\f1 +.IP \(bu 2 +\fBshardingStatistics.catalogCache\f1\f1 +.RE +.RE +.PP +\fBmaxTimeMSForHedgedReads\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 150 +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP Specifies the maximimum time limit (in milliseconds) for the -hedged read\&. That is, the additional -read sent to hedge the read operation uses the \fBmaxTimeMS\fP value -of \fI\%maxTimeMSForHedgedReads\fP while the read operation -that is being hedged uses the \fBmaxTimeMS\fP value specified for the +\fBhedged read\f1\&. That is, the additional +read sent to hedge the read operation uses the \fBmaxTimeMS\f1 value +of \fBmaxTimeMSForHedgedReads\f1\f1 while the read operation +that is being hedged uses the \fBmaxTimeMS\f1 value specified for the operation. -.sp +.PP For example, to set the limit to 200 milliseconds, you can issue the following during startup: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter maxTimeMSForHedgedReads=200 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Or if using the \fBsetParameter\fP command in a -\fBmongo\fP shell connected to a running -\fBmongos\fP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, maxTimeMSForHedgedReads: 200 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%readHedgingMode\fP -.IP \(bu 2 -mongos\-hedged\-reads -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B readHedgingMode -New in version 4.4. - -.sp -\fIType\fP: string -.sp -\fIDefault\fP: on -.sp -Available for \fBmongos\fP only. -.sp -Specifies whether \fBmongos\fP supports hedged reads for -those read operations whose read preference have enabled the hedged read option. -.sp +.PP +.EX + mongos \-\-setParameter maxTimeMSForHedgedReads=200 +.EE +.PP +Or if using the \fBsetParameter\f1\f1 command in a +\fBmongosh\f1\f1 session that is connected to a running +\fBmongos\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, maxTimeMSForHedgedReads: 200 } ) +.EE +.RS +.IP \(bu 2 +\fBreadHedgingMode\f1\f1 +.IP \(bu 2 +\fBHedged Reads\f1 +.RE +.RE +.PP +\fBmaxCatchUpPercentageBeforeBlockingWrites\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 10 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +For \fBmoveChunk\f1\f1 operations, specifies the maximum +percentage of untrasferred data allowed by the migration protocol +(expressed in percentage of the total chunk size) to +transition from the \fBcatchup\f1 phase to the \fBcommit\f1 phase. +.PP +Setting a higher catchup percentage can decrease the amount of time +it takes for the migration to complete at the cost of increased +latency during concurrent \fBupsert\f1\f1 +and \fBdelete\f1\f1 operations. +.PP +For example, to set the maximum percentage to 20, you can issue the +followingduring startup: +.PP +.EX + mongod \-\-setParameter maxCatchUpPercentageBeforeBlockingWrites=20 +.EE +.PP +You cannot change +\fBmaxCatchUpPercentageBeforeBlockingWrites\f1\f1 during runtime. +.PP +Live Migration Protocol (https://github.com/mongodb/mongo/blob/master/src/mongo/db/s/README.md#the\-live\-migration\-protocol) +.RE +.PP +\fBreadHedgingMode\f1 +.RS +.PP +\fIType\f1: string +.PP +\fIDefault\f1: on +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP +Specifies whether \fBmongos\f1\f1 supports hedged reads for +those read operations whose \fBread preference\f1 have enabled the hedged read option. +.PP Available values are: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBon\fP -T} T{ -The \fBmongos\fP instance supports hedged reads for -read operations whose read preference have enabled the hedged read option. -T} -_ -T{ -\fBoff\fP -T} T{ -The \fBmongos\fP instance does not support hedged +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBon\f1 +.IP \(bu 4 +The \fBmongos\f1\f1 instance supports hedged reads for +read operations whose \fBread preference\f1 have enabled the hedged read option. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBoff\f1 +.IP \(bu 4 +The \fBmongos\f1\f1 instance does not support hedged reads. That is, hedged reads are unavailable, even for read operations whose read preference have enabled the hedged read option. -T} -_ -.TE -.sp +.RE +.RE +.PP For example, to turn off hedged read support for a -\fBmongos\fP instance, you can issue the following during +\fBmongos\f1\f1 instance, you can issue the following during startup: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter readHedgingMode=off -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Or if using the \fBsetParameter\fP command in a -\fBmongo\fP shell connected to a running -\fBmongos\fP: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, readHedgingMode: "off" } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -mongos\-hedged\-reads -.IP \(bu 2 -\fI\%maxTimeMSForHedgedReads\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B replMonitorMaxFailedChecks -\fIAvailable in MongoDB 3.2 only\fP -.sp +.PP +.EX + mongos \-\-setParameter readHedgingMode=off +.EE +.PP +Or if using the \fBsetParameter\f1\f1 command in a +\fBmongosh\f1\f1 session that is connected to a running +\fBmongos\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, readHedgingMode: "off" } ) +.EE +.RS +.IP \(bu 2 +\fBHedged Reads\f1 +.IP \(bu 2 +\fBmaxTimeMSForHedgedReads\f1\f1 +.RE +.RE +.PP +\fBshutdownTimeoutMillisForSignaledShutdown\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 15000 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Specifies the time (in milliseconds) to wait for any ongoing database +operations to complete before initiating a shutdown of +\fBmongod\f1\f1 in response to a \fBSIGTERM\f1 signal. +.PP +For example, to set the time to 250 milliseconds, you can issue the +following during startup: +.PP +.EX + mongod \-\-setParameter shutdownTimeoutMillisForSignaledShutdown=250 +.EE +.PP +Or if using the \fBsetParameter\f1\f1 command in a +\fBmongosh\f1\f1 session that is connected to a running +\fBmongod\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, shutdownTimeoutMillisForSignaledShutdown: 250 } ) +.EE +.RE +.PP +\fBmongosShutdownTimeoutMillisForSignaledShutdown\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 15000 +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP +Specifies the time (in milliseconds) to wait for any ongoing database +operations to complete before initiating a shutdown of +\fBmongos\f1\f1 in response to a \fBSIGTERM\f1 signal. +.PP +For example, to set the time to 250 milliseconds, you can issue the +following during startup: +.PP +.EX + mongos \-\-setParameter mongosShutdownTimeoutMillisForSignaledShutdown=250 +.EE +.PP +Or if using the \fBsetParameter\f1\f1 command in a +\fBmongosh\f1\f1 session that is connected to a running +\fBmongos\f1\f1: +.PP +.EX + db.adminCommand( { setParameter: 1, mongosShutdownTimeoutMillisForSignaledShutdown: 250 } ) +.EE +.RE +.PP +\fBreplMonitorMaxFailedChecks\f1 +.RS +.PP +\fIAvailable in MongoDB 3.2 only\f1 +.PP Type: integer -.sp +.PP Default: 30 -.sp -The number of times the \fBmongod\fP or \fBmongos\fP -instance tries to reach the replica sets in the sharded cluster -(e.g. shard replica sets, config server replica set) to monitor the -replica set status and topology. -.sp +.PP +The number of times the \fBmongod\f1\f1 or +\fBmongos\f1\f1 instance tries to reach the replica sets in the +sharded cluster (for example, shard replica sets, config server +replica set) to monitor the replica set status and topology. +.PP When the number of consecutive unsuccessful attempts exceeds this -parameter value, the \fBmongod\fP or \fBmongos\fP instance +parameter value, the \fBmongod\f1\f1 or \fBmongos\f1\f1 instance denotes the monitored replica set as unavailable. If the monitored replica set is the config server replica set: -.INDENT 7.0 +.RS .IP \(bu 2 -For MongoDB 3.2.0\-3.2.9, the monitoring \fBmongod\fP or -\fBmongos\fP instance will become unusable and needs to be -restarted. See the \fI\%v3.2 troubleshooting guide\fP +For MongoDB 3.2.0\-3.2.9, the monitoring \fBmongod\f1\f1 or +\fBmongos\f1\f1 instance will become unusable and needs to be +restarted. See the v3.2 troubleshooting guide (https://docs.mongodb.com/v3.2/tutorial/troubleshoot\-sharded\-clusters/#a\-config\-server\-replica\-set\-member\-become\-unavailable) for more details. .IP \(bu 2 For MongoDB 3.2.10 and later 3.2\-series, see also -\fI\%timeOutMonitoringReplicaSets\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B timeOutMonitoringReplicaSets -\fIAvailable in MongoDB 3.2.10 and later 3.2\-series only\fP -.sp +\fBtimeOutMonitoringReplicaSets\f1\f1\&. +.RE +.RE +.PP +\fBtimeOutMonitoringReplicaSets\f1 +.RS +.PP +\fIAvailable in MongoDB 3.2.10 and later 3.2\-series only\f1 +.PP Type: integer -.sp +.PP Default: false -.sp -The flag that determines whether the \fBmongod\fP or -\fBmongos\fP instance should stop its attempt to reach the +.PP +The flag that determines whether the \fBmongod\f1\f1 or +\fBmongos\f1\f1 instance should stop its attempt to reach the monitored replica set after unsuccessfully trying -\fI\%replMonitorMaxFailedChecks\fP number of times. -.sp +\fBreplMonitorMaxFailedChecks\f1\f1 number of times. +.PP If the monitored replica set is the config server replica set and -\fI\%timeOutMonitoringReplicaSets\fP is set to \fBtrue\fP, you -must restart \fBmongod\fP or \fBmongos\fP if the -\fBmongod\fP or \fBmongos\fP instance cannot reach any of +\fBtimeOutMonitoringReplicaSets\f1\f1 is set to \fBtrue\f1, you +must restart \fBmongod\f1\f1 or \fBmongos\f1\f1 if the +\fBmongod\f1\f1 or \fBmongos\f1\f1 instance cannot reach any of the config servers for the specified number of times. See the -\fI\%v3.2 troubleshooting guide\fP +v3.2 troubleshooting guide (https://docs.mongodb.com/v3.2/tutorial/troubleshoot\-sharded\-clusters/#a\-config\-server\-replica\-set\-member\-become\-unavailable) for more details. -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolHostTimeoutMS +.RE +.PP +\fBShardingTaskExecutorPoolHostTimeoutMS\f1 +.RS +.PP Type: integer -.sp -Default: 300000 (i.e. 5 minutes) -.sp -Available for \fBmongos\fP only. -.sp -Maximum time that \fBmongos\fP goes without communication to a -host before \fBmongos\fP drops all connections to the host. -.sp +.PP +Default: 300000 (5 minutes) +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Maximum time that \fBmongos\f1\f1 goes without communication to a +host before \fBmongos\f1\f1 drops all connections to the host. +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.sp -If set, \fI\%ShardingTaskExecutorPoolHostTimeoutMS\fP should be +this setting using the \fBsetParameter\f1\f1 database command. +.PP +If set, \fBShardingTaskExecutorPoolHostTimeoutMS\f1\f1 should be greater than the sum of -\fI\%ShardingTaskExecutorPoolRefreshRequirementMS\fP and -\fI\%ShardingTaskExecutorPoolRefreshTimeoutMS\fP\&. Otherwise, -\fBmongos\fP adjusts the value of -\fI\%ShardingTaskExecutorPoolHostTimeoutMS\fP to be greater than the +\fBShardingTaskExecutorPoolRefreshRequirementMS\f1\f1 and +\fBShardingTaskExecutorPoolRefreshTimeoutMS\f1\f1\&. Otherwise, +\fBmongos\f1\f1 adjusts the value of +\fBShardingTaskExecutorPoolHostTimeoutMS\f1\f1 to be greater than the sum. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter ShardingTaskExecutorPoolHostTimeoutMS=120000 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolMaxConnecting -New in version 3.6. - -.sp +.PP +.EX + mongos \-\-setParameter ShardingTaskExecutorPoolHostTimeoutMS=120000 +.EE +.RE +.PP +\fBShardingTaskExecutorPoolMaxConnecting\f1 +.RS +.PP Type: integer -.sp +.PP Default: 2 -.sp -Available for \fBmongos\fP only. -.sp +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Maximum number of simultaneous initiating connections (including pending connections in setup/refresh state) each TaskExecutor -connection pool can have to a \fBmongod\fP instance. You can -set this parameter to control the rate at which \fBmongos\fP -adds connections to a \fBmongod\fP instance. -.sp -If set, \fI\%ShardingTaskExecutorPoolMaxConnecting\fP should be -less than or equal to \fI\%ShardingTaskExecutorPoolMaxSize\fP\&. -If it is greater, \fBmongos\fP ignores the -\fI\%ShardingTaskExecutorPoolMaxConnecting\fP value. -.sp +connection pool can have to a \fBmongod\f1\f1 instance. You can +set this parameter to control the rate at which \fBmongos\f1\f1 +adds connections to a \fBmongod\f1\f1 instance. +.PP +If set, \fBShardingTaskExecutorPoolMaxConnecting\f1\f1 should be +less than or equal to \fBShardingTaskExecutorPoolMaxSize\f1\f1\&. +If it is greater, \fBmongos\f1\f1 ignores the +\fBShardingTaskExecutorPoolMaxConnecting\f1\f1 value. +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter ShardingTaskExecutorPoolMaxConnecting=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolMaxSize +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongos \-\-setParameter ShardingTaskExecutorPoolMaxConnecting=20 +.EE +.RE +.PP +\fBShardingTaskExecutorPoolMaxSize\f1 +.RS +.PP Type: integer -.sp -Default: 2\s-2\u64\d\s0 \- 1 -.sp -Available for \fBmongos\fP only. -.sp +.PP +Default: 2 64 \- 1 +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Maximum number of outbound connections each TaskExecutor connection -pool can open to any given \fBmongod\fP instance. The maximum +pool can open to any given \fBmongod\f1\f1 instance. The maximum possible connections to any given host across all TaskExecutor pools is: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -ShardingTaskExecutorPoolMaxSize * taskExecutorPoolSize -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + ShardingTaskExecutorPoolMaxSize * taskExecutorPoolSize +.EE +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter ShardingTaskExecutorPoolMaxSize=4 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBmongos\fP can have up to \fBn\fP TaskExecutor connection -pools, where \fBn\fP is the number of cores. See -\fI\%taskExecutorPoolSize\fP\&. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%ShardingTaskExecutorPoolMinSize\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolMinSize +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongos \-\-setParameter ShardingTaskExecutorPoolMaxSize=4 +.EE +.PP +\fBmongos\f1\f1 can have up to \fBn\f1 TaskExecutor connection +pools, where \fBn\f1 is the number of cores. See +\fBtaskExecutorPoolSize\f1\f1\&. +.PP +\fBShardingTaskExecutorPoolMinSize\f1\f1 +.RE +.PP +\fBShardingTaskExecutorPoolMinSize\f1 +.RS +.PP Type: integer -.sp +.PP Default: 1 -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP Minimum number of outbound connections each TaskExecutor connection -pool can open to any given \fBmongod\fP instance. -.sp -\fBShardingTaskExecutorPoolMinSize\fP connections are created the +pool can open to any given \fBmongod\f1\f1 instance. +.PP +\fBShardingTaskExecutorPoolMinSize\f1 connections are created the first time a connection to a new host is requested from the pool. While the pool is idle, the pool maintains this number of -connections until \fI\%ShardingTaskExecutorPoolHostTimeoutMS\fP +connections until \fBShardingTaskExecutorPoolHostTimeoutMS\f1\f1 milliseconds pass without any application using that pool. -.sp -For a \fBmongos\fP using the -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartup\fP -parameter, the \fBShardingTaskExecutorPoolMinSize\fP parameter also +.PP +For a \fBmongos\f1\f1 using the +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1\f1 +parameter, the \fBShardingTaskExecutorPoolMinSize\f1 parameter also controls how many connections to each shard host are established on -startup of the \fBmongos\fP instance before it begins +startup of the \fBmongos\f1\f1 instance before it begins accepting incoming client connections. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP In MongoDB 4.4, the -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartup\fP -parameter is enabled by default for the \fBmongos\fP\&. -.UNINDENT -.UNINDENT -.sp +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1\f1 +parameter is enabled by default for the \fBmongos\f1\f1\&. +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter ShardingTaskExecutorPoolMinSize=2 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBmongos\fP can have up to \fBn\fP TaskExecutor connection -pools, where \fBn\fP is the number of cores. See -\fI\%taskExecutorPoolSize\fP\&. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%ShardingTaskExecutorPoolMaxSize\fP -.IP \(bu 2 -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartup\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolRefreshRequirementMS +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongos \-\-setParameter ShardingTaskExecutorPoolMinSize=2 +.EE +.PP +\fBmongos\f1\f1 can have up to \fBn\f1 TaskExecutor connection +pools, where \fBn\f1 is the number of cores. See +\fBtaskExecutorPoolSize\f1\f1\&. +.RS +.IP \(bu 2 +\fBShardingTaskExecutorPoolMaxSize\f1\f1 +.IP \(bu 2 +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1\f1 +.RE +.RE +.PP +\fBShardingTaskExecutorPoolRefreshRequirementMS\f1 +.RS +.PP Type: integer -.sp +.PP Default: 60000 (1 minute) -.sp -Available for \fBmongos\fP only. -.sp -Maximum time the \fBmongos\fP waits before attempting to +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Maximum time the \fBmongos\f1\f1 waits before attempting to heartbeat a resting connection in the pool. -.sp +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.sp -If set, \fI\%ShardingTaskExecutorPoolRefreshRequirementMS\fP should be -greater than \fI\%ShardingTaskExecutorPoolRefreshTimeoutMS\fP\&. -Otherwise, \fBmongos\fP adjusts the value of -\fI\%ShardingTaskExecutorPoolRefreshTimeoutMS\fP to be less than -\fI\%ShardingTaskExecutorPoolRefreshRequirementMS\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter ShardingTaskExecutorPoolRefreshRequirementMS=90000 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolRefreshTimeoutMS +this setting using the \fBsetParameter\f1\f1 database command. +.PP +If set, \fBShardingTaskExecutorPoolRefreshRequirementMS\f1\f1 should be +greater than \fBShardingTaskExecutorPoolRefreshTimeoutMS\f1\f1\&. +Otherwise, \fBmongos\f1\f1 adjusts the value of +\fBShardingTaskExecutorPoolRefreshTimeoutMS\f1\f1 to be less than +\fBShardingTaskExecutorPoolRefreshRequirementMS\f1\f1\&. +.PP +.EX + mongos \-\-setParameter ShardingTaskExecutorPoolRefreshRequirementMS=90000 +.EE +.RE +.PP +\fBShardingTaskExecutorPoolRefreshTimeoutMS\f1 +.RS +.PP Type: integer -.sp +.PP Default: 20000 (20 seconds) -.sp -Available for \fBmongos\fP only. -.sp -Maximum time the \fBmongos\fP waits for a heartbeat before +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Maximum time the \fBmongos\f1\f1 waits for a heartbeat before timing out the heartbeat. -.sp +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.sp -If set, \fI\%ShardingTaskExecutorPoolRefreshTimeoutMS\fP should be -less than \fI\%ShardingTaskExecutorPoolRefreshRequirementMS\fP\&. -Otherwise, \fBmongos\fP adjusts the value of -\fI\%ShardingTaskExecutorPoolRefreshTimeoutMS\fP to be less than -\fI\%ShardingTaskExecutorPoolRefreshRequirementMS\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter ShardingTaskExecutorPoolRefreshTimeoutMS=30000 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B ShardingTaskExecutorPoolReplicaSetMatching -New in version 4.2. - -.sp +this setting using the \fBsetParameter\f1\f1 database command. +.PP +If set, \fBShardingTaskExecutorPoolRefreshTimeoutMS\f1\f1 should be +less than \fBShardingTaskExecutorPoolRefreshRequirementMS\f1\f1\&. +Otherwise, \fBmongos\f1\f1 adjusts the value of +\fBShardingTaskExecutorPoolRefreshTimeoutMS\f1\f1 to be less than +\fBShardingTaskExecutorPoolRefreshRequirementMS\f1\f1\&. +.PP +.EX + mongos \-\-setParameter ShardingTaskExecutorPoolRefreshTimeoutMS=30000 +.EE +.RE +.PP +\fBShardingTaskExecutorPoolReplicaSetMatching\f1 +.RS +.PP Type: string -.sp -Default: "matchPrimaryNode" -.sp -Available for \fBmongos\fP only. -.sp -The policy that determines the minimum size limit of the -\fBmongos\fP instance\(aqs connection pools to the sharded -cluster\(aqs replica set secondaries. -.sp +.PP +Default: "automatic" +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +On a \fBmongos\f1\f1 instance, this parameter sets the policy +that determines the minimum size limit of its connection pools to +nodes within replica sets. +.PP +On a \fBmongod\f1\f1 instance, this parameter sets the policy +that determines the minimum size limit of its connection pools to +nodes within \fIother\f1 replica sets. +.PP +Note that this parameter only manages connections for operations that +are directly related to user requests and CRUD operations. +.PP Available values are: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Matching Policy -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB"matchPrimaryNode"\fP (Default) -T} T{ -For each replica set in the sharded cluster (i.e. shard -replica set and config servers), the minimum size limit of -the \fBmongos\fP instance\(aqs connection pool to each -secondary of that replica set is equal to the size of its -connection pool to the primary. -.sp -In case of primary stepdown, \fBmatchPrimaryNode\fP ensures +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB"automatic"\f1 (Default) +.IP \(bu 4 +Starting in 5.0 (and 4.4.5 and 4.2.13), \fB"automatic"\f1 is the +new default value. +.IP +When set for a \fBmongos\f1\f1, the instance follows the +behavior specified for the \fB"matchPrimaryNode"\f1 option. +.IP +When set for a \fBmongod\f1\f1, the instance follows the +behavior specified for the \fB"disabled"\f1 option. +.IP +If the +\fBShardingTaskExecutorPoolReplicaSetMatching\f1\f1 is +set to \fB"automatic"\f1, the +\fBreplicaSetMatchingStrategy\f1\f1 still +describes the actual policy being used, not +\fB"automatic"\f1\&. To find the value of the +\fBShardingTaskExecutorPoolReplicaSetMatching\f1\f1, +use \fBgetParameter\f1\f1 which returns the value of +the server parameter. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB"matchPrimaryNode"\f1 +.IP \(bu 4 +When set for a \fBmongos\f1\f1, the minimum size limit +of the instance\(aqs connection pool to each secondary of a +replica set in the sharded cluster (specifically, shard +replica set and config servers) is equal to the size of its +connection pool to that replica set\(aqs primary. +.IP +When set for a \fBmongod\f1\f1, the minimum size limit +of the instance\(aqs connection pool to each secondary of +another replica set in the sharded cluster (specifically, +shard replica set and config servers) is equal to the size of +its connection pool to that replica set\(aqs primary. +.IP +If multiple shard servers in your topology can experience a +rapid influx of cross\-shard operations, do not set this +option on your \fBmongod\f1\f1 instances. +.IP +In case of a primary stepdown, \fBmatchPrimaryNode\f1 ensures that any secondary that becomes the primary can handle the current level of primary reads and writes. -T} -_ -T{ -\fB"matchBusiestNode"\fP -T} T{ -For each replica set in the sharded cluster (i.e. shard -replica set and config servers), the minimum size limit of -the \fBmongos\fP instance\(aqs connection pool to each -member of that replica set is equal to the largest among -the active connections counts to the primary and each -secondary members. -.sp -With \fB"matchBusiestNode"\fP, \fBmongos\fP maintains +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB"matchBusiestNode"\f1 +.IP \(bu 4 +When set for a \fBmongos\f1\f1, the instance\(aqs minimum +size limit of the connection pool to each member of a replica +set in the sharded cluster (specifically, shard replica set +and config servers) is equal to the largest among the active +connection counts to the primary and each secondary member of +that replica set. +.IP +When set for a \fBmongod\f1\f1, the instance\(aqs minimum +size limit of the connection pool to each member of another +replica set in the sharded cluster (specifically, shard +replica set and config servers) is equal to the largest among +the active connection counts to the primary and each +secondary member of that replica set. +.IP +With \fB"matchBusiestNode"\f1, \fBmongos\f1\f1 maintains enough connections to each secondary to handle the current level of primary and secondary reads and writes. The number of connections to maintain in the pool decreases as the number of active connections decreases. -T} -_ -T{ -\fB"disabled"\fP -T} T{ -For each replica set in the sharded cluster (i.e. shard -replica set and config servers), the minimum number of -connections in the \fBmongos\fP instance\(aqs -connection pool to each secondary is equal to the -\fI\%ShardingTaskExecutorPoolMinSize\fP\&. -T} -_ -.TE -.sp +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB"disabled"\f1 +.IP \(bu 4 +When set for a \fBmongos\f1\f1, the instance\(aqs minimum +number of connections in the instance\(aqs connection pool to +each node of a replica set in the sharded clusterv +(specifically, shard replica set and config servers) is equal +to the \fBShardingTaskExecutorPoolMinSize\f1\f1\&. +.IP +When set for a \fBmongod\f1\f1, the instance\(aqs minimum +number of connections in the instance\(aqs connection pool to +each node of another replica set in the sharded cluster +(specifically, shard replica set and config servers) is equal +to the \fBShardingTaskExecutorPoolMinSize\f1\f1\&. +.RE +.RE +.PP The following example sets the -\fI\%ShardingTaskExecutorPoolReplicaSetMatching\fP to -\fB"matchBusiestNode"\fP during startup: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter ShardingTaskExecutorPoolReplicaSetMatching="matchBusiestNode" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBShardingTaskExecutorPoolReplicaSetMatching\f1\f1 to +\fB"automatic"\f1 during startup: +.PP +.EX + mongod \-\-setParameter ShardingTaskExecutorPoolReplicaSetMatching="automatic" +.EE +.PP During runtime, you can also set the parameter with the -\fBsetParameter\fP command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, ShardingTaskExecutorPoolReplicaSetMatching: "matchBusiestNode" } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B taskExecutorPoolSize -Changed in version 4.0. - -.sp +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, ShardingTaskExecutorPoolReplicaSetMatching: "automatic" } ) +.EE +.RE +.PP +\fBtaskExecutorPoolSize\f1 +.RS +.PP Type: integer -.sp +.PP Default: 1 -.sp -Available for \fBmongos\fP only. -.sp +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP The number of Task Executor connection pools to use for a given -\fBmongos\fP\&. -.sp -If the parameter value is \fB0\fP or less, the number of Task Executor +\fBmongos\f1\f1\&. +.PP +If the parameter value is \fB0\f1 or less, the number of Task Executor connection pools is the number of cores with the following exceptions: -.INDENT 7.0 +.RS .IP \(bu 2 If the number of cores is less than 4, the number of Task Executor connection pools is 4. .IP \(bu 2 If the number of cores is greater than 64, the number of Task Executor connection pools is 64. -.UNINDENT -.sp +.RE +.PP Starting in MongoDB 4.0, the default value of -\fI\%taskExecutorPoolSize\fP is \fB1\fP: -.INDENT 7.0 +\fBtaskExecutorPoolSize\f1\f1 is \fB1\f1: +.RS .IP \(bu 2 In MongoDB 4.0 deployment, you can set -\fI\%taskExecutorPoolSize\fP to \fB0\fP and, on Linux, set -\fI\%AsyncRequestsSenderUseBaton\fP to -\fBfalse\fP for the previous behavior. +\fBtaskExecutorPoolSize\f1\f1 to \fB0\f1 and, on Linux, set +AsyncRequestsSenderUseBaton (https://docs.mongodb.com/v4.0/reference/parameters/#param.AsyncRequestsSenderUseBaton) to +\fBfalse\f1 for the previous behavior. .IP \(bu 2 In MongoDB 4.2+ deployment, MongoDB removes the -\fBAsyncRequestsSenderUseBaton\fP parameter and always enables the +\fBAsyncRequestsSenderUseBaton\f1 parameter and always enables the performance enhancement controlled by the parameter. -.UNINDENT -.sp +.RE +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongos \-\-setParameter taskExecutorPoolSize=6 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%ShardingTaskExecutorPoolMaxSize\fP -.IP \(bu 2 -\fI\%ShardingTaskExecutorPoolMinSize\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B loadRoutingTableOnStartup -New in version 4.4. - -.sp +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongos \-\-setParameter taskExecutorPoolSize=6 +.EE +.RS +.IP \(bu 2 +\fBShardingTaskExecutorPoolMaxSize\f1\f1 +.IP \(bu 2 +\fBShardingTaskExecutorPoolMinSize\f1\f1 +.RE +.RE +.PP +\fBloadRoutingTableOnStartup\f1 +.RS +.PP Type: boolean -.sp -\fIDefault\fP: true -.sp -Available for \fBmongos\fP only. -.sp -Configures a \fBmongos\fP instance to preload the routing +.PP +\fIDefault\f1: true +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP +Configures a \fBmongos\f1\f1 instance to preload the routing table for a sharded cluster on startup. With this setting -enabled, the \fBmongos\fP caches the cluster\-wide routing +enabled, the \fBmongos\f1\f1 caches the cluster\-wide routing table for each sharded collection as part of its startup procedure, before it begins accepting client connections. -.sp -Without this setting enabled, the \fBmongos\fP only loads +.PP +Without this setting enabled, the \fBmongos\f1\f1 only loads a routing table as needed for incoming client connections, and only loads the specific routing table for the namespace of a given request. -.sp -A \fBmongos\fP instance with the -\fI\%loadRoutingTableOnStartup\fP parameter enabled may +.PP +A \fBmongos\f1\f1 instance with the +\fBloadRoutingTableOnStartup\f1\f1 parameter enabled may experience longer startup times, but will result in faster servicing of initial client connections once started. -.sp -\fI\%loadRoutingTableOnStartup\fP is enabled by default. -.sp +.PP +\fBloadRoutingTableOnStartup\f1\f1 is enabled by default. +.PP You can only set this parameter on startup, using either the -\fBsetParameter\fP configuration file setting or the -\fB\-\-setParameter\fP command line option. -.UNINDENT -.INDENT 0.0 -.TP -.B warmMinConnectionsInShardingTaskExecutorPoolOnStartup -New in version 4.4. - -.sp +\fBsetParameter\f1\f1 configuration file setting or the +\fB\-\-setParameter\f1\f1 command line option. +.RE +.PP +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1 +.RS +.PP Type: boolean -.sp -\fIDefault\fP: true -.sp -Available for \fBmongos\fP only. -.sp -Configures a \fBmongos\fP instance to prewarm its connection +.PP +\fIDefault\f1: true +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP +Configures a \fBmongos\f1\f1 instance to prewarm its connection pool on startup. With this parameter enabled, the -\fBmongos\fP attempts to establish -\fI\%ShardingTaskExecutorPoolMinSize\fP network +\fBmongos\f1\f1 attempts to establish +\fBShardingTaskExecutorPoolMinSize\f1\f1 network connections to each shard server as part of its startup procedure, before it begins accepting client connections. -.sp +.PP A timeout for this behavior can be configured with the -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS\fP -parameter. If this timeout is reached, the \fBmongos\fP will +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS\f1\f1 +parameter. If this timeout is reached, the \fBmongos\f1\f1 will begin accepting client connections regardless of the size of its connection pool. -.sp -A \fBmongos\fP instance with this parameter enabled may +.PP +A \fBmongos\f1\f1 instance with this parameter enabled may experience longer startup times, but will result in faster servicing of initial client connections once started. -.sp -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartup\fP is +.PP +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1\f1 is enabled by default. -.sp +.PP You can only set this parameter on startup, using either the -\fBsetParameter\fP configuration file setting or the -\fB\-\-setParameter\fP command line option. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS\fP -.IP \(bu 2 -\fI\%ShardingTaskExecutorPoolMinSize\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B warmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS -New in version 4.4. - -.sp +\fBsetParameter\f1\f1 configuration file setting or the +\fB\-\-setParameter\f1\f1 command line option. +.RS +.IP \(bu 2 +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS\f1\f1 +.IP \(bu 2 +\fBShardingTaskExecutorPoolMinSize\f1\f1 +.RE +.RE +.PP +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMS\f1 +.RS +.PP Type: integer -.sp -\fIDefault\fP: 2000 (i.e. 2 seconds) -.sp -Available for \fBmongos\fP only. -.sp +.PP +\fIDefault\f1: 2000 (2 seconds) +.PP +Available for +.PP +\fBmongos\f1\f1 +.PP + only. +.PP Sets the timeout threshold in milliseconds for a -\fBmongos\fP to wait for \fI\%ShardingTaskExecutorPoolMinSize\fP +\fBmongos\f1\f1 to wait for \fBShardingTaskExecutorPoolMinSize\f1\f1 connections to be established per shard host when using the -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartup\fP -parameter. If this timeout is reached, the \fBmongos\fP will +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1\f1 +parameter. If this timeout is reached, the \fBmongos\f1\f1 will begin accepting client connections regardless of the size of its connection pool. -.sp +.PP You can only set this parameter on startup, using either the -\fBsetParameter\fP configuration file setting or the -\fB\-\-setParameter\fP command line option. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%warmMinConnectionsInShardingTaskExecutorPoolOnStartup\fP -.IP \(bu 2 -\fI\%ShardingTaskExecutorPoolMinSize\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B migrateCloneInsertionBatchDelayMS -New in version 4.0.5: The parameter is also available starting in 3.4.18 and 3.6.10 - -.sp -Available for \fBmongod\fP only. -.sp +\fBsetParameter\f1\f1 configuration file setting or the +\fB\-\-setParameter\f1\f1 command line option. +.RS +.IP \(bu 2 +\fBwarmMinConnectionsInShardingTaskExecutorPoolOnStartup\f1\f1 +.IP \(bu 2 +\fBShardingTaskExecutorPoolMinSize\f1\f1 +.RE +.RE +.PP +\fBmigrateCloneInsertionBatchDelayMS\f1 +.RS +.PP +The parameter is also available starting in 3.4.18 and 3.6.10 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Type: Non\-negative integer -.sp +.PP Default: 0 -.sp +.PP Time in milliseconds to wait between batches of insertions during cloning step of the migration process. This wait is in addition to -the \fBsecondaryThrottle\fP\&. -.sp -The default value of \fB0\fP indicates no additional wait. -.sp -The following sets the \fI\%migrateCloneInsertionBatchDelayMS\fP to 200 +the \fBsecondaryThrottle\f1\&. +.PP +The default value of \fB0\f1 indicates no additional wait. +.PP +The following sets the \fBmigrateCloneInsertionBatchDelayMS\f1\f1 to 200 milliseconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter migrateCloneInsertionBatchDelayMS=200 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The parameter may also be set using the \fBsetParameter\fP +.PP +.EX + mongod \-\-setParameter migrateCloneInsertionBatchDelayMS=200 +.EE +.PP +The parameter may also be set using the \fBsetParameter\f1\f1 command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, migrateCloneInsertionBatchDelayMS: 200 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B migrateCloneInsertionBatchSize -New in version 4.0.5: The parameter is also available starting in 3.4.18 and 3.6.10 - -.sp -Available for \fBmongod\fP only. -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, migrateCloneInsertionBatchDelayMS: 200 } ) +.EE +.RE +.PP +\fBmigrateCloneInsertionBatchSize\f1 +.RS +.PP +The parameter is also available starting in 3.4.18 and 3.6.10 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Type: Non\-negative integer -.sp +.PP Default: 0 -.sp +.PP The maximum number of documents to insert in a single batch during the cloning step of the migration process. -.sp -The default value of \fB0\fP indicates no maximum number of documents +.PP +The default value of \fB0\f1 indicates no maximum number of documents per batch. However, in practice, this results in batches that contain up to 16 MB of documents. -.sp -The following sets the \fI\%migrateCloneInsertionBatchSize\fP to 100 +.PP +The following sets the \fBmigrateCloneInsertionBatchSize\f1\f1 to 100 documents: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter migrateCloneInsertionBatchSize=100 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The parameter may also be set using the \fBsetParameter\fP +.PP +.EX + mongod \-\-setParameter migrateCloneInsertionBatchSize=100 +.EE +.PP +The parameter may also be set using the \fBsetParameter\f1\f1 command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, migrateCloneInsertionBatchSize: 100 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B orphanCleanupDelaySecs -New in version 3.6. - -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, migrateCloneInsertionBatchSize: 100 } ) +.EE +.RE +.PP +\fBorphanCleanupDelaySecs\f1 +.RS +.PP Default: 900 (15 minutes) -.sp -Available for \fBmongod\fP only. -.sp -Minimum delay before a migrated chunk is deleted from the source +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Minimum delay before a migrated \fBchunk\f1 is deleted from the source shard. -.sp +.PP Before deleting the chunk during chunk migration, MongoDB waits for -\fI\%orphanCleanupDelaySecs\fP or for in\-progress queries involving +\fBorphanCleanupDelaySecs\f1\f1 or for in\-progress queries involving the chunk to complete on the shard primary, whichever is longer. -.sp +.PP However, because the shard primary has no knowledge of in\-progress queries run on the shard secondaries, queries that use the chunk but are run on secondaries may see documents disappear if these queries take longer than the time to complete the shard primary queries and the -\fI\%orphanCleanupDelaySecs\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBorphanCleanupDelaySecs\f1\f1\&. +.PP This behavior only affects in\-progress queries that start before the chunk migration. Queries that start after the chunk migration starts will not use the migrating chunk. -.UNINDENT -.UNINDENT -.sp +.PP If a shard has storage constraints, consider reducing this value temporarily. If running queries that exceed 15 minutes on shard secondaries, consider increasing this value. -.sp -The following sets the \fI\%orphanCleanupDelaySecs\fP to 20 minutes: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter orphanCleanupDelaySecs=1200 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -This may also be set using the \fBsetParameter\fP command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, orphanCleanupDelaySecs: 1200 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B rangeDeleterBatchDelayMS -New in version 4.0.1: The parameter is also available starting in 3.4.17 and 3.6.7. - -.sp -Available for \fBmongod\fP only. -.sp +.PP +The following sets the \fBorphanCleanupDelaySecs\f1\f1 to 20 minutes: +.PP +.EX + mongod \-\-setParameter orphanCleanupDelaySecs=1200 +.EE +.PP +This may also be set using the \fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, orphanCleanupDelaySecs: 1200 } ) +.EE +.RE +.PP +\fBrangeDeleterBatchDelayMS\f1 +.RS +.PP +The parameter is also available starting in 3.4.17 and 3.6.7. +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Type: Non\-negative integer -.sp +.PP Default: 20 -.sp +.PP The amount of time in milliseconds to wait before the next batch of -deletion during the cleanup stage of chunk migration (or the \fBcleanupOrphaned\fP +deletion during the cleanup stage of \fBchunk migration\f1 (or the \fBcleanupOrphaned\f1\f1 command). -.sp -In MongoDB 3.4, consider whether _secondaryThrottle is set before modifying the -\fI\%rangeDeleterBatchDelayMS\fP\&. In MongoDB 3.4, the -_secondaryThrottle replication delay occurs after each document deletion +.PP +In MongoDB 3.4, consider whether \fB_secondaryThrottle\f1 is set before modifying the +\fBrangeDeleterBatchDelayMS\f1\f1\&. In MongoDB 3.4, the +\fB_secondaryThrottle replication delay\f1 occurs after each document deletion instead of after the batch deletion. -.sp -In MongoDB 3.6+, the _secondaryThrottle replication delay occurs after each batch deletion. -.sp -The following sets the \fI\%rangeDeleterBatchDelayMS\fP to 200 +.PP +In MongoDB 3.6+, the \fB_secondaryThrottle replication delay\f1 occurs after each batch deletion. +.PP +The following sets the \fBrangeDeleterBatchDelayMS\f1\f1 to 200 milliseconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter rangeDeleterBatchDelayMS=200 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The parameter may also be set using the \fBsetParameter\fP +.PP +.EX + mongod \-\-setParameter rangeDeleterBatchDelayMS=200 +.EE +.PP +The parameter may also be set using the \fBsetParameter\f1\f1 command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, rangeDeleterBatchDelayMS: 200 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B rangeDeleterBatchSize -New in version 4.0.5: The parameter is also available starting in 3.4.19 and 3.6.10 - -.sp -Available for \fBmongod\fP only. -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, rangeDeleterBatchDelayMS: 200 } ) +.EE +.RE +.PP +\fBrangeDeleterBatchSize\f1 +.RS +.PP +The parameter is also available starting in 3.4.19 and 3.6.10 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Type: Non\-negative integer -.sp -Default: 0 -.sp +.PP +Default: 128 +.PP The maximum number of documents in each batch to delete during the -cleanup stage of chunk migration -(or the \fBcleanupOrphaned\fP command). -.sp -The default value of \fB0\fP indicates that the system chooses an -appropriate value, generally 128 documents. -.sp -The following sets the \fI\%rangeDeleterBatchSize\fP to 100 +cleanup stage of \fBchunk migration\f1 +(or the \fBcleanupOrphaned\f1\f1 command). +.PP +A value of \fB0\f1 indicates that the system chooses the default value. +.PP +The following example sets \fBrangeDeleterBatchSize\f1\f1 to 32 documents: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter rangeDeleterBatchSize=100 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The parameter may also be set using the \fBsetParameter\fP +.PP +.EX + mongod \-\-setParameter rangeDeleterBatchSize=32 +.EE +.PP +The parameter may also be set using the \fBsetParameter\f1\f1 command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, rangeDeleterBatchSize: 100 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B skipShardingConfigurationChecks -New in version 3.6.3. - -.sp -Available for \fBmongod\fP only. -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, rangeDeleterBatchSize: 32 } ) +.EE +.RE +.PP +\fBskipShardingConfigurationChecks\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Type: boolean -.sp +.PP Default: false -.sp -When \fBtrue\fP, allows for starting a shard member or config server +.PP +When \fBtrue\f1, allows for starting a shard member or config server member as a standalone for maintenance operations. This parameter is -mutually exclusive with the \fB\-\-configsvr\fP or \fB\-\-shardsvr\fP options. -.sp +mutually exclusive with the \fB\-\-configsvr\f1\f1 or \fB\-\-shardsvr\f1\f1 options. +.PP You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter skipShardingConfigurationChecks=true -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongod \-\-setParameter skipShardingConfigurationChecks=true +.EE +.PP Once maintenance has completed, remove the -\fI\%skipShardingConfigurationChecks\fP parameter when -restarting the \fBmongod\fP\&. -.UNINDENT -.UNINDENT -.sp +\fBskipShardingConfigurationChecks\f1\f1 parameter when +restarting the \fBmongod\f1\f1\&. +.PP The parameter is also available for MongoDB versions: -.INDENT 7.0 +.RS .IP \(bu 2 MongoDB 3.2.19+ .IP \(bu 2 MongoDB 3.4.11+ -.UNINDENT -.UNINDENT -.SS Storage Parameters -.INDENT 0.0 -.TP -.B journalCommitInterval -Available for \fBmongod\fP only. -.sp -Specify an integer between \fB1\fP and \fB500\fP signifying the number +.RE +.RE +.PP +\fBfindChunksOnConfigTimeoutMS\f1 +.RS +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Type: Non\-negative integer +.PP +Default: 900000 +.PP +The timeout in milliseconds for find operations on +\fBchunks\f1\f1\&. +.PP +If there is a large number of chunks in the cluster and chunk loading +fails with the error \fBExceededTimeLimit\f1, increase the parameter +value: +.PP +.EX + mongod \-\-setParameter findChunksOnConfigTimeoutMS=1000000 +.EE +.RE +.SS STORAGE PARAMETERS +.PP +\fBhonorSystemUmask\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIDefault\f1: \fBfalse\f1 +.PP +If \fBhonorSystemUmask\f1\f1 is set to \fBtrue\f1, new files +created by MongoDB have permissions in accordance with the +user\(aqs \fBumask\f1 settings. You cannot set \fBprocessUmask\f1\f1 +if \fBhonorSystemUmask\f1\f1 is set to \fBtrue\f1\&. +.PP +If \fBhonorSystemUmask\f1\f1 is set to \fBfalse\f1, new files +created by MongoDB have permissions set to \fB600\f1, which gives +read and write permissions only to the owner. New directories have +permissions set to \fB700\f1\&. You can use \fBprocessUmask\f1\f1 +to override the default permissions for groups and other users on +all new files created by MongoDB. +.PP +You can only set this parameter during start\-up and cannot change +this setting using the \fBsetParameter\f1\f1 database command. +.PP +.EX + mongod \-\-setParameter honorSystemUmask=true +.EE +.PP +\fBhonorSystemUmask\f1\f1 is not available on Windows systems. +.RE +.PP +\fBjournalCommitInterval\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Specify an integer between \fB1\f1 and \fB500\f1 signifying the number of milliseconds (ms) between journal commits. -.sp +.PP Consider the following example which sets the -\fI\%journalCommitInterval\fP to \fB200\fP ms: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, journalCommitInterval: 200 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBstorage.journal.commitIntervalMs\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B syncdelay -Available for \fBmongod\fP only. -.sp -Specify the interval in seconds between fsync operations -where \fBmongod\fP flushes its working memory to disk. By -default, \fBmongod\fP flushes memory to disk every 60 +\fBjournalCommitInterval\f1\f1 to \fB200\f1 ms: +.PP +.EX + db.adminCommand( { setParameter: 1, journalCommitInterval: 200 } ) +.EE +.PP +\fBstorage.journal.commitIntervalMs\f1\f1 +.RE +.PP +\fBminSnapshotHistoryWindowInSeconds\f1 +.RS +.PP +\fIDefault\f1: \fB300\f1 +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +The minimum time window in seconds for which the storage engine keeps +the snapshot history. If you query data using read concern +:readconcern: snapshot and specify an +\fBatClusterTime\f1 value older than the specified +\fBminSnapshotHistoryWindowInSeconds\f1, \fBmongod\f1\f1 returns +a \fBSnapshotTooOld\f1 error. +.PP +Specify an integer greater than or equal to (\fB>=\f1) 0. +.PP +Consider the following example which sets the +\fBminSnapshotHistoryWindowInSeconds\f1 to \fB600\f1 seconds: +.PP +.EX + db.adminCommand( { setParameter: 1, minSnapshotHistoryWindowInSeconds: 600 } ) +.EE +.RS +.IP \(bu 2 +Read concern \fB"snapshot"\f1\f1 +.IP \(bu 2 +\fBSnapshots and Checkpoints\f1 +.RE +.RE +.PP +\fBprocessUmask\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Overrides the default permissions used for groups and other users +when \fBhonorSystemUmask\f1\f1 is set to \fBfalse\f1\&. By default, +when \fBhonorSystemUmask\f1\f1 is set to \fBfalse\f1, new files +created by MongoDB have permissions set to \fB600\f1\&. Use the +\fBprocessUmask\f1 parameter to override this default with a custom +\fBumask\f1 value. The file owner inherits permissions from the system +\fBumask\f1\&. +.PP +You cannot set this parameter if \fBhonorSystemUmask\f1\f1 is set +to \fBtrue\f1\&. You can only set this parameter during start\-up and cannot +change this setting using the \fBsetParameter\f1\f1 database +command. +.PP +Consider the following example, which sets the permissions for groups +and other users to read/write only and retains the system \fBumask\f1 +settings for the owner: +.PP +.EX + mongod \-\-setParameter processUmask=011 +.EE +.PP +\fBprocessUmask\f1\f1 is not available on Windows systems. +.RE +.PP +\fBsyncdelay\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Specify the interval in seconds between \fBfsync\f1 operations +where \fBmongod\f1\f1 flushes its working memory to disk. By +default, \fBmongod\f1\f1 flushes memory to disk every 60 seconds. In almost every situation you should not set this value and use the default setting. -.sp -Consider the following example which sets the \fBsyncdelay\fP to -\fB60\fP seconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, syncdelay: 60 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fI\%journalCommitInterval\fP -.IP \(bu 2 -\fBstorage.syncPeriodSecs\fP -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B honorSystemUmask -New in version 3.6. - -.sp -\fIDefault\fP: \fBfalse\fP -.sp -If \fI\%honorSystemUmask\fP is set to \fBtrue\fP, new files -created by MongoDB have permissions in accordance with the -user\(aqs \fBumask\fP settings. -.sp -If \fI\%honorSystemUmask\fP is set to \fBfalse\fP, new files -created by MongoDB have permissions set to \fB600\fP, which gives -read and write permissions only to the owner. New directories have -permissions set to \fB700\fP\&. -.sp -You can only set this parameter during start\-up and cannot change -this setting using the \fBsetParameter\fP database command. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter honorSystemUmask=true -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%honorSystemUmask\fP is not available on Windows systems. -.UNINDENT -.UNINDENT -.UNINDENT -.SS WiredTiger Parameters -.INDENT 0.0 -.TP -.B wiredTigerMaxCacheOverflowSizeGB -.INDENT 7.0 -.INDENT 3.5 -.IP "Deprecated in MongoDB 4.4" -.sp -MongoDB deprecates the \fBwiredTigerMaxCacheOverflowSizeGB\fP +.PP +Consider the following example which sets the \fBsyncdelay\f1 to +\fB60\f1 seconds: +.PP +.EX + db.adminCommand( { setParameter: 1, syncdelay: 60 } ) +.EE +.RS +.IP \(bu 2 +\fBjournalCommitInterval\f1\f1 +.IP \(bu 2 +\fBstorage.syncPeriodSecs\f1\f1 +.RE +.RE +.SS WIREDTIGER PARAMETERS +.PP +\fBwiredTigerMaxCacheOverflowSizeGB\f1 +.RS +.PP +MongoDB deprecates the \fBwiredTigerMaxCacheOverflowSizeGB\f1 parameter. The parameter has no effect starting in MongoDB 4.4. -.UNINDENT -.UNINDENT -.sp -\fIDefault\fP: 0 (No specified maximum) -.sp -Available for \fBmongod\fP only. -.sp +.PP +\fIDefault\f1: 0 (No specified maximum) +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Specify the maximum size (in GB) for the "lookaside (or cache -overflow) table" file \fBWiredTigerLAS.wt\fP for MongoDB +overflow) table" file WiredTigerLAS.wt for MongoDB 4.2.1\-4.2.x and 4.0.12\-4.0.x. The file no longer exists starting in version 4.4. -.sp +.PP The parameter can accept the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB0\fP -T} T{ -The default value. If set to \fB0\fP, the file size is +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB0\f1 +.IP \(bu 4 +The default value. If set to \fB0\f1, the file size is unbounded. -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 number >= 0.1 -T} T{ -The maximum size (in GB). If the \fBWiredTigerLAS.wt\fP -file exceeds this size, \fBmongod\fP exits with a -fatal assertion. You can clear the \fBWiredTigerLAS.wt\fP -file and restart \fBmongod\fP\&. -T} -_ -.TE -.sp +.IP \(bu 4 +The maximum size (in GB). If the WiredTigerLAS.wt +file exceeds this size, \fBmongod\f1\f1 exits with a +fatal assertion. You can clear the WiredTigerLAS.wt +file and restart \fBmongod\f1\f1\&. +.RE +.RE +.PP You can only set this parameter during runtime using the -\fBsetParameter\fP database command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, wiredTigerMaxCacheOverflowSizeGB: 100 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBsetParameter\f1\f1 database command: +.PP +.EX + db.adminCommand( { setParameter: 1, wiredTigerMaxCacheOverflowSizeGB: 100 } ) +.EE +.PP To set the maximum size during start up, use the -\fBstorage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB\fP +\fBstorage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB\f1\f1 instead. -.sp -\fIAvailable starting in MongoDB 4.2.1 (and 4.0.12)\fP -.UNINDENT -.INDENT 0.0 -.TP -.B wiredTigerConcurrentReadTransactions -Available for \fBmongod\fP only. -.sp +.PP +\fIAvailable starting in MongoDB 4.2.1 (and 4.0.12)\f1 +.RE +.PP +\fBwiredTigerConcurrentReadTransactions\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Available for the WiredTiger storage engine only. -.sp +.PP Specify the maximum number of concurrent read transactions allowed into the WiredTiger storage engine. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, wiredTigerConcurrentReadTransactions: <num> } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBwiredTiger.concurrentTransactions\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B wiredTigerConcurrentWriteTransactions -Available for \fBmongod\fP only. -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, wiredTigerConcurrentReadTransactions: <num> } ) +.EE +.PP +\fBwiredTiger.concurrentTransactions\f1\f1 +.RE +.PP +\fBwiredTigerConcurrentWriteTransactions\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP Available for the WiredTiger storage engine only. -.sp +.PP Specify the maximum number of concurrent write transactions allowed into the WiredTiger storage engine. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, wiredTigerConcurrentWriteTransactions: <num> } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBwiredTiger.concurrentTransactions\fP -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B wiredTigerEngineRuntimeConfig -Available for \fBmongod\fP only. -.sp -Specify \fBwiredTiger\fP storage engine configuration options for a -running \fBmongod\fP instance. You can \fIonly\fP set this -parameter using the \fBsetParameter\fP command and \fInot\fP +.PP +.EX + db.adminCommand( { setParameter: 1, wiredTigerConcurrentWriteTransactions: <num> } ) +.EE +.PP +\fBwiredTiger.concurrentTransactions\f1\f1 +.RE +.PP +\fBwiredTigerEngineRuntimeConfig\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Specify \fBwiredTiger\f1 storage engine configuration options for a +running \fBmongod\f1\f1 instance. You can \fIonly\f1 set this +parameter using the \fBsetParameter\f1\f1 command and \fInot\f1 using the command line or configuration file option. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -Avoid modifying the \fI\%wiredTigerEngineRuntimeConfig\fP +.PP +Avoid modifying the \fBwiredTigerEngineRuntimeConfig\f1\f1 unless under the direction from MongoDB engineers as this setting has major implication across both WiredTiger and MongoDB. -.UNINDENT -.UNINDENT -.sp +.PP Consider the following operation prototype: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand({ - "setParameter": 1, - "wiredTigerEngineRuntimeConfig": "<option>=<setting>,<option>=<setting>" -}) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -See the WiredTiger documentation for all available \fI\%WiredTiger -configuration options\fP\&. -.UNINDENT -.SS Auditing Parameters -.INDENT 0.0 -.TP -.B auditAuthorizationSuccess -\fIDefault\fP: \fBfalse\fP -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.sp -Available for both \fBmongod\fP and \fBmongos\fP\&. -.sp -Enables the auditing of authorization -successes for the authCheck +.PP +.EX + db.adminCommand({ + "setParameter": 1, + "wiredTigerEngineRuntimeConfig": "<option>=<setting>,<option>=<setting>" + }) +.EE +.PP +See the WiredTiger documentation for all available WiredTiger +configuration options (http://source.wiredtiger.com/mongodb\-3.4/struct_w_t___c_o_n_n_e_c_t_i_o_n.html#)\&. +.RE +.SS AUDITING PARAMETERS +.PP +\fBauditAuthorizationSuccess\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: false +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.PP +Available for both +.PP +\fBmongod\f1\f1 +.PP + and +.PP +\fBmongos\f1\f1 +.PP +\&. +.PP +Enables the \fBauditing\f1 of authorization +successes for the \fBauthCheck\f1 action. -.sp -When \fI\%auditAuthorizationSuccess\fP is \fBfalse\fP, the -audit system only logs the authorization -failures for \fBauthCheck\fP\&. -.sp +.PP +When \fBauditAuthorizationSuccess\f1\f1 is \fBfalse\f1, the +\fBaudit system\f1 only logs the authorization +failures for \fBauthCheck\f1\&. +.PP To enable the audit of authorization successes, issue the following command: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, auditAuthorizationSuccess: true } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Enabling \fI\%auditAuthorizationSuccess\fP degrades performance +.PP +.EX + db.adminCommand( { setParameter: 1, auditAuthorizationSuccess: true } ) +.EE +.PP +Enabling \fBauditAuthorizationSuccess\f1\f1 degrades performance more than logging only the authorization failures. -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -\fBgetParameter\fP -.UNINDENT -.UNINDENT -.SS Transaction Parameters -.INDENT 0.0 -.TP -.B transactionLifetimeLimitSeconds -New in version 4.0. - -.sp -Available for \fBmongod\fP only. -.sp -\fIDefault\fP: 60 -.sp -Specifies the lifetime of multi\-document transactions\&. Transactions that exceeds this limit are +.PP +If \fBruntime audit configuration\f1 +is enabled, the \fBauditAuthorizationSuccess\f1\f1 parameter +should not appear in the \fBmongod\f1 or \fBmongos\f1 configuration +file. The server will fail to start if the parameter is present. +.PP +\fBgetParameter\f1\f1 +.RE +.PP +\fBauditConfigPollingFrequencySecs\f1 +.RS +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 300 +.PP +A sharded cluster may have servers which maintain audit +configuration settings for the cluster. Set the interval, in +seconds, for non\-configured servers to poll a config server for the +current audit generation. If this value returned differs from the +previously known value, the initiating node will request the current +configuration and update its internal state. +.PP +Using the default value of 300 seconds, non\-config nodes may lag up +to 5 minutes behind a setAuditConfig command. +.RE +.SS TRANSACTION PARAMETERS +.PP +\fBcoordinateCommitReturnImmediatelyAfterPersistingDecision\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +If \fBtrue\f1, the \fBshard\f1 +transaction coordinator returns a \fBmulti\-document transaction\f1 commit decision to the client as soon as +the commit is made \fBdurable\f1 with the requested transaction +\fBwrite concern\f1\&. If the client +requested a write concern that is less than +\fB"majority"\f1\f1, the commit may roll back after the +decision is returned to the client. +.PP +If \fBfalse\f1, the \fBshard\f1 +transaction coordinator waits for all members to acknowledge a +\fBmulti\-document transaction\f1 commit +before returning the commit decision to the client. +.PP +The following example sets +\fBcoordinateCommitReturnImmediatelyAfterPersistingDecision\f1\f1 +to \fBfalse\f1: +.PP +.EX + mongod \-\-setParameter coordinateCommitReturnImmediatelyAfterPersistingDecision=false +.EE +.PP +During runtime, you can also set the parameter with the +\fBsetParameter\f1\f1 command: +.PP +.EX + db.adminCommand( { setParameter: 1, coordinateCommitReturnImmediatelyAfterPersistingDecision: false } ) +.EE +.RE +.PP +\fBtransactionLifetimeLimitSeconds\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIDefault\f1: 60 +.PP +Specifies the lifetime of \fBmulti\-document transactions\f1\&. Transactions that exceed this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs every -\fI\%transactionLifetimeLimitSeconds\fP/2 seconds or at least -once per every 60 seconds. -.sp +\fBtransactionLifetimeLimitSeconds\f1\f1/2 seconds or at least +once every 60 seconds. +.PP The cleanup process helps relieve storage cache pressure. -.sp -The minimum value for transactionLifetimeLimitSeconds is \fB1\fP +.PP +The minimum value for transactionLifetimeLimitSeconds is \fB1\f1 second. -.sp +.PP The following sets the -\fI\%transactionLifetimeLimitSeconds\fP to \fB30\fP +\fBtransactionLifetimeLimitSeconds\f1\f1 to \fB30\f1 seconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, transactionLifetimeLimitSeconds: 30 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -You can also set parameter \fI\%transactionLifetimeLimitSeconds\fP at +.PP +.EX + db.adminCommand( { setParameter: 1, transactionLifetimeLimitSeconds: 30 } ) +.EE +.PP +You can also set parameter \fBtransactionLifetimeLimitSeconds\f1\f1 at startup time. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter "transactionLifetimeLimitSeconds=30" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongod \-\-setParameter "transactionLifetimeLimitSeconds=30" +.EE +.PP To set the parameter for a sharded cluster, the parameter must be modified for all shard replica set members. -.UNINDENT -.INDENT 0.0 -.TP -.B maxTransactionLockRequestTimeoutMillis -New in version 4.0. - -.sp -Available for \fBmongod\fP only. -.sp -\fIType\fP: integer -.sp -\fIDefault\fP: 5 -.sp -The maximum amount of time in milliseconds that multi\-document -transactions should wait to acquire locks +.PP +Starting in MongoDB 5.0, if you change the +\fBtransactionLifetimeLimitSeconds\f1\f1 parameter, you must also +change \fBtransactionLifetimeLimitSeconds\f1\f1 to the same value on +all config server replica set members. Keeping this value consistent: +.RS +.IP \(bu 2 +Ensures the routing table history is retained for at least as long as +the transaction lifetime limit on the shard replica set members. +.IP \(bu 2 +Reduces the transaction retry frequency and therefore improves +performance. +.RE +.RE +.PP +\fBmaxTransactionLockRequestTimeoutMillis\f1 +.RS +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +\fIType\f1: integer +.PP +\fIDefault\f1: 5 +.PP +The maximum amount of time in milliseconds that \fBmulti\-document +transactions\f1 should wait to acquire locks required by the operations in the transaction. -.sp +.PP If the transaction cannot acquire the locks after waiting -\fI\%maxTransactionLockRequestTimeoutMillis\fP, the transaction +\fBmaxTransactionLockRequestTimeoutMillis\f1\f1, the transaction aborts. -.sp -By default, multi\-document transactions -wait \fB5\fP milliseconds. That is, if the transaction cannot acquire -the locks within \fB5\fP milliseconds, the transaction aborts. If an +.PP +By default, \fBmulti\-document transactions\f1 +wait \fB5\f1 milliseconds. That is, if the transaction cannot acquire +the locks within \fB5\f1 milliseconds, the transaction aborts. If an operation provides a greater timeout in a lock request, -\fI\%maxTransactionLockRequestTimeoutMillis\fP overrides the +\fBmaxTransactionLockRequestTimeoutMillis\f1\f1 overrides the operation\-specific timeout. -.sp -You can set \fI\%maxTransactionLockRequestTimeoutMillis\fP to: -.INDENT 7.0 +.PP +You can set \fBmaxTransactionLockRequestTimeoutMillis\f1\f1 to: +.RS .IP \(bu 2 -\fB0\fP such that if the transaction cannot acquire the required +\fB0\f1 such that if the transaction cannot acquire the required locks immediately, the transaction aborts. .IP \(bu 2 -A number greater than \fB0\fP to wait the specified time to acquire +A number greater than \fB0\f1 to wait the specified time to acquire the required locks. This can help obviate transaction aborts on momentary concurrent lock acquisitions, like fast\-running metadata operations. However, this could possibly delay the abort of deadlocked transaction operations. .IP \(bu 2 -\fB\-1\fP to use the operation specific timeout. -.UNINDENT -.sp +\fB\-1\f1 to use the operation specific timeout. +.RE +.PP The following sets the -\fI\%maxTransactionLockRequestTimeoutMillis\fP to \fB20\fP +\fBmaxTransactionLockRequestTimeoutMillis\f1\f1 to \fB20\f1 milliseconds: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -db.adminCommand( { setParameter: 1, maxTransactionLockRequestTimeoutMillis: 20 } ) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + db.adminCommand( { setParameter: 1, maxTransactionLockRequestTimeoutMillis: 20 } ) +.EE +.PP You can also set this parameter during start\-up: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-setParameter maxTransactionLockRequestTimeoutMillis=20 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +.PP +.EX + mongod \-\-setParameter maxTransactionLockRequestTimeoutMillis=20 +.EE +.RE +.PP +\fBshouldMultiDocTxnCreateCollectionAndIndexes\f1 +.RS +.PP +\fIRemoved in 5.0\f1 +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +A flag that enables or disables the creation of a collection or an +index inside \fBtransactions\f1\&. Set the +parameter to: +.RS +.IP \(bu 2 +\fBtrue\f1 to enable. (\fIDefault\f1) +.IP \(bu 2 +\fBfalse\f1 to disable. +.RE +.PP +You can set the parameter during startup or runtime. +.PP +When setting the parameter for a sharded cluster, set the +parameter on all shards. +.PP +To set the parameter at startup, specify the parameter in the +\fBconfiguration file\f1\f1 or with the +\fB\-\-setParameter\f1 option on the command line. For example: +.PP +.EX + mongod \-\-setParameter shouldMultiDocTxnCreateCollectionAndIndexes=false +.EE +.PP +To modify during runtime, you can use the \fBsetParameter\f1\f1 +command; for example: +.PP +.EX + db.adminCommand( { setParameter: 1, shouldMultiDocTxnCreateCollectionAndIndexes: false } ) +.EE +.RE +.SS SLOT-BASED EXECUTION PARAMETERS +.PP +\fBinternalQueryEnableSlotBasedExecutionEngine\f1 +.RS +.PP +\fIType\f1: boolean +.PP +\fIDefault\f1: true +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +If \fBinternalQueryEnableSlotBasedExecutionEngine\f1\f1 is +\fBtrue\f1: +.RS +.IP \(bu 2 +Enhanced query execution is used if possible. If used, the document +structure is separated from the document content, and only the +required fields are used in the engine computations. This improves +performance and ensures database resources are efficiently used. +.IP \(bu 2 +If enhanced query execution is used, the query plan \fBexplain +results\f1 have a different +structure and contain additional information about the execution +plan. +.RE +.PP +If \fBinternalQueryEnableSlotBasedExecutionEngine\f1\f1 is +\fBfalse\f1, enhanced query execution is not used. +.PP +The following sets +\fBinternalQueryEnableSlotBasedExecutionEngine\f1\f1 to +\fBfalse\f1: +.PP +.EX + mongod \-\-setParameter internalQueryEnableSlotBasedExecutionEngine=false +.EE +.PP +You can also use the \fBsetParameter\f1\f1 command within the +MongoDB Shell (https://docs.mongodb.com/mongodb\-shell/): +.PP +.EX + db.adminCommand( { setParameter: 1, internalQueryEnableSlotBasedExecutionEngine: false } ) +.EE +.RE +.PP +\fBplanCacheSize\f1 +.RS +.PP +\fIType\f1: string +.PP +\fIDefault\f1: 5% +.PP +Available for +.PP +\fBmongod\f1\f1 +.PP + only. +.PP +Sets the size of the \fBplan cache\f1 for the enhanced query +execution engine. +.PP +You can set the \fBplanCacheSize\f1\f1 value to either: +.RS +.IP \(bu 2 +A percentage of the system\(aqs total physical memory to allocate for +the plan cache. For example, \fB"8.5%"\f1\&. +.IP \(bu 2 +The exact amount of data to allocate for the plan cache in either +\fBMB\f1 or \fBGB\f1\&. For example, \fB"100MB"\f1 or \fB"1GB"\f1\&. +.RE +.PP +Increasing the plan cache size adds more cached query shapes for the +\fBquery planner\f1\&. This can +improve query performance, but increases memory usage. +.PP +The following startup command sets \fBplanCacheSize\f1\f1 to 80 +megabytes: +.PP +.EX + mongod \-\-setParameter planCacheSize="80MB" +.EE +.PP +You can also use the \fBsetParameter\f1\f1 command within the +MongoDB Shell (https://docs.mongodb.com/mongodb\-shell/): +.PP +.EX + db.adminCommand( { setParameter: 1, planCacheSize: "80MB" } ) +.EE +.RE diff --git a/debian/mongokerberos.1 b/debian/mongokerberos.1 index 75165b963c6..54058db7dd2 100644 --- a/debian/mongokerberos.1 +++ b/debian/mongokerberos.1 @@ -1,489 +1,409 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGOKERBEROS" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongokerberos \- MongoDB Kerberos Validation Utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Installation\fP -.IP \(bu 2 -\fI\%Usage\fP -.IP \(bu 2 -\fI\%Options\fP -.UNINDENT -.sp -New in version 4.4: MongoDB Enterprise - +.TH mongokerberos 1 +.SH MONGOKERBEROS .SH SYNOPSIS -.sp Starting in version 4.4, MongoDB Enterprise provides -\fI\%mongokerberos\fP for testing MongoDB\(aqs Kerberos and GSSAPI -configuration options against a -running Kerberos deployment. \fI\%mongokerberos\fP can be used -in one of two modes: \fIserver\fP and \fIclient\fP\&. -.TS -center; -|l|l|. -_ -T{ +\fBmongokerberos\f1\f1 for testing MongoDB\(aqs Kerberos and GSSAPI +\fBconfiguration options\f1 against a +running Kerberos deployment. \fBmongokerberos\f1\f1 can be used +in one of two modes: \fIserver\f1 and \fIclient\f1\&. +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Mode -T} T{ +.IP \(bu 4 Description -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Server -T} T{ -In \fIserver mode\fP, \fI\%mongokerberos\fP analyzes +.IP \(bu 4 +In \fIserver mode\f1, \fBmongokerberos\f1\f1 analyzes Kerberos\-related configurations on the server, and returns a report which includes error messages for any configurations that -are problematic. For usage, see \fI\%Server Mode\fP -T} -_ -T{ +are problematic. For usage, see \fBServer Mode\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Client -T} T{ -In \fIclient mode\fP, \fI\%mongokerberos\fP tests Kerberos +.IP \(bu 4 +In \fIclient mode\f1, \fBmongokerberos\f1\f1 tests Kerberos authentication for a provided username, and returns a report which includes the success or failure of each step in the Kerberos authentication procedure. For usage, see -\fI\%Client Mode\fP -T} -_ -.TE -.sp +\fBClient Mode\f1 +.RE +.RE +.PP Error messages for both modes include information on specific errors encountered and potential advice for resolving the error. -.sp -\fI\%mongokerberos\fP supports the following deployment types, +.PP +\fBmongokerberos\f1\f1 supports the following deployment types, in both server and client modes: -.INDENT 0.0 +.RS .IP \(bu 2 Linux MongoDB clients authenticating to MIT Kerberos deployments on -supported Linux platforms\&. +\fBsupported Linux platforms\f1\&. .IP \(bu 2 Windows MongoDB clients authenticating to Windows Active Directory deployments on -supported Windows platforms\&. +\fBsupported Windows platforms\f1\&. .IP \(bu 2 Linux MongoDB clients authenticating to Windows Active Directory deployments. -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -MongoDB Enterprise and \fI\%mongokerberos\fP only support the -\fI\%MIT implementation\fP +.RE +.PP +MongoDB Enterprise and \fBmongokerberos\f1\f1 only support the +MIT implementation (https://kerberos.org/) of Kerberos. -.UNINDENT -.UNINDENT -.sp +.PP Generally, when configuring options related to -Kerberos authentication, it is good practice -to verify your configuration with \fI\%mongokerberos\fP\&. -.sp -\fI\%mongokerberos\fP is a testing and verification tool; it does not +\fBKerberos authentication\f1, it is good practice +to verify your configuration with \fBmongokerberos\f1\f1\&. +.PP +\fBmongokerberos\f1\f1 is a testing and verification tool; it does not edit any files or configure any services. For configuring Kerberos on -your platform please consult the \fI\%MIT Kerberos documentation\fP, or your platform\(aqs +your platform please consult the MIT Kerberos documentation (https://web.mit.edu/kerberos/krb5\-latest/doc/), or your platform\(aqs documentation. For configuring MongoDB to authenticate using Kerberos, please reference the following tutorials: -.INDENT 0.0 +.RS .IP \(bu 2 -/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +\fBConfigure MongoDB with Kerberos Authentication on Linux\f1 .IP \(bu 2 -/tutorial/control\-access\-to\-mongodb\-windows\-with\-kerberos\-authentication\&. -.UNINDENT -.sp +\fBConfigure MongoDB with Kerberos Authentication on Windows\f1\&. +.RE +.PP This document provides a complete overview of all command line options -for \fI\%mongokerberos\fP\&. +for \fBmongokerberos\f1\f1\&. .SH INSTALLATION -.sp -The \fI\%mongokerberos\fP tool is part of the \fIMongoDB Database Tools Extra\fP -package, and can be \fI\%installed with the MongoDB Server\fP or as a -\fI\%standalone installation\fP\&. -.SS Install with Server -.sp -To install \fI\%mongokerberos\fP as part of a MongoDB Enterprise Server +.PP +The \fBmongokerberos\f1\f1 tool is part of the \fIMongoDB Database Tools Extra\f1 +package, and can be \fBinstalled with the MongoDB Server\f1 or as a +\fBstandalone installation\f1\&. +.SS INSTALL WITH SERVER +.PP +To install \fBmongokerberos\f1\f1 as part of a MongoDB Enterprise Server installation: -.INDENT 0.0 +.RS .IP \(bu 2 Follow the instructions for your platform: -Install MongoDB Enterprise Server +\fBInstall MongoDB Enterprise Server\f1 .IP \(bu 2 -After completing the installation, \fI\%mongokerberos\fP and the other +After completing the installation, \fBmongokerberos\f1\f1 and the other included tools are available in the same location as the Server. -.sp -\fBNOTE:\fP -.INDENT 2.0 -.INDENT 3.5 -For the Windows \fB\&.msi\fP installer wizard, the -Complete installation option includes \fI\%mongokerberos\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Install as Standalone -.sp -To install \fI\%mongokerberos\fP as a standalone installation: -.INDENT 0.0 +.IP +For the Windows \fB\&.msi\f1 installer wizard, the +Complete installation option includes \fBmongokerberos\f1\f1\&. +.RE +.SS INSTALL AS STANDALONE +.PP +To install \fBmongokerberos\f1\f1 as a standalone installation: +.RS .IP \(bu 2 Follow the download link for MongoDB Enterprise Edition: -\fI\%MongoDB Enterprise Download Center\fP +MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise?tck=docs_server) .IP \(bu 2 Select your Platform (operating system) from the dropdown menu, then select the appropriate Package for your platform according to the following chart: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 4 +.RS +.IP \(bu 6 OS -T} T{ +.IP \(bu 6 Package -T} -_ -T{ -\fILinux\fP -T} T{ -\fBtgz\fP package -T} -_ -T{ -\fIWindows\fP -T} T{ -\fBzip\fP package -T} -_ -T{ -\fImacOS\fP -T} T{ -\fBtgz\fP package -T} -_ -.TE +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Linux +.IP \(bu 6 +\fBtgz\f1 package +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Windows +.IP \(bu 6 +\fBzip\f1 package +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +macOS +.IP \(bu 6 +\fBtgz\f1 package +.RE +.RE .IP \(bu 2 -Once downloaded, unpack the archive and copy \fI\%mongokerberos\fP to a +Once downloaded, unpack the archive and copy \fBmongokerberos\f1\f1 to a location on your hard drive. -.INDENT 2.0 -.INDENT 3.5 -.SS Tip -.sp -Linux and macOS users may wish to copy \fI\%mongokerberos\fP to a filesystem -location that is defined in the \fB$PATH\fP environment variable, such -as \fB/usr/bin\fP\&. Doing so allows referencing \fI\%mongokerberos\fP directly +.IP +Linux and macOS users may wish to copy \fBmongokerberos\f1\f1 to a filesystem +location that is defined in the \fB$PATH\f1 environment variable, such +as \fB/usr/bin\f1\&. Doing so allows referencing \fBmongokerberos\f1\f1 directly on the command line by name, without needing to specify its full path, or first navigating to its parent directory. See the -installation guide for your platform +\fBinstallation guide\f1 for your platform for more information. -.UNINDENT -.UNINDENT -.UNINDENT +.RE .SH USAGE -.sp -\fI\%mongokerberos\fP can be run in two modes: \fIserver\fP and -\fIclient\fP\&. -.sp -Run \fI\%mongokerberos\fP from the system command line, not the \fBmongo\fP shell. -.SS Server Mode -.sp -Running \fI\%mongokerberos\fP in server mode performs a series of +.PP +\fBmongokerberos\f1\f1 can be run in two modes: \fIserver\f1 and +\fIclient\f1\&. +.PP +Run \fBmongokerberos\f1\f1 from the system command line, not in the +\fBmongosh\f1\f1\&. +.SS SERVER MODE +.PP +Running \fBmongokerberos\f1\f1 in server mode performs a series of verification steps against your system\(aqs Kerberos configuration, including checking for proper DNS resolution, validation of the Kerberos system keytab file, and testing against the MongoDB service principal -for your \fBmongod\fP or \fBmongos\fP instance. -.sp -Before you can use \fI\%mongokerberos\fP in server mode, you must: -.INDENT 0.0 -.IP 1. 3 +for your \fBmongod\f1\f1 or \fBmongos\f1\f1 instance. +.PP +Before you can use \fBmongokerberos\f1\f1 in server mode, you must: +.RS +.IP \(bu 2 Configure Kerberos on your platform according to your platform\(aqs documentation. -.IP 2. 3 +.IP \(bu 2 Create the MongoDB service principal for use with your -\fBmongod\fP or \fBmongos\fP instance, as described +\fBmongod\f1\f1 or \fBmongos\f1\f1 instance, as described in the following steps: -.INDENT 3.0 -.IP \(bu 2 -Configure Service Principal on Linux -.IP \(bu 2 -Configure Service Principal on Windows -.UNINDENT -.UNINDENT -.sp +.RS +.IP \(bu 4 +\fBConfigure Service Principal on Linux\f1 +.IP \(bu 4 +\fBConfigure Service Principal on Windows\f1 +.RE +.RE +.PP Once you have completed these steps, you can run -\fI\%mongokerberos\fP in server mode using the -\fB\-\-server\fP flag as follows: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongokerberos \-\-server -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBmongokerberos\f1\f1 in server mode using the +\fB\-\-server\f1 flag as follows: +.PP +.EX + mongokerberos \-\-server +.EE +.PP If Kerberos has been configured properly on the server, and the service principal created successfully, the output might resemble the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Resolving kerberos environment... -[OK] Kerberos environment resolved without errors. - -Verifying DNS resolution works with Kerberos service at <hostname>... -[OK] DNS test successful. - -Getting MIT Kerberos KRB5 environment variables... - * KRB5CCNAME: not set. - * KRB5_CLIENT_KTNAME: not set. - * KRB5_CONFIG: not set. - * KRB5_KTNAME: not set. - * KRB5_TRACE: not set. -[OK] - -Verifying existence of KRB5 keytab FILE:/etc/krb5.keytab... -[OK] KRB5 keytab exists and is populated. - -Checking principal(s) in KRB5 keytab... -Found the following principals for MongoDB service mongodb: - * mongodb/server.example.com@SERVER.EXAMPLE.COM -Found the following kvnos in keytab entries for service mongodb: - * 3 -[OK] KRB5 keytab is valid. - -Fetching KRB5 Config... -KRB5 config profile resolved as: - <Your Kerberos profile file will be output here> -[OK] KRB5 config profile resolved without errors. - -Attempting to initiate security context with service credentials... -[OK] Security context initiated successfully. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + Resolving kerberos environment... + [OK] Kerberos environment resolved without errors. + + Verifying DNS resolution works with Kerberos service at <hostname>... + [OK] DNS test successful. + + Getting MIT Kerberos KRB5 environment variables... + * KRB5CCNAME: not set. + * KRB5_CLIENT_KTNAME: not set. + * KRB5_CONFIG: not set. + * KRB5_KTNAME: not set. + * KRB5_TRACE: not set. + [OK] + + Verifying existence of KRB5 keytab FILE:/etc/krb5.keytab... + [OK] KRB5 keytab exists and is populated. + + Checking principal(s) in KRB5 keytab... + Found the following principals for MongoDB service mongodb: + * mongodb/server.example.com@SERVER.EXAMPLE.COM + Found the following kvnos in keytab entries for service mongodb: + * 3 + [OK] KRB5 keytab is valid. + + Fetching KRB5 Config... + KRB5 config profile resolved as: + <Your Kerberos profile file will be output here> + [OK] KRB5 config profile resolved without errors. + + Attempting to initiate security context with service credentials... + [OK] Security context initiated successfully. +.EE +.PP The final message indicates that the system\(aqs Kerberos configuration is ready to be used with MongoDB. If any errors are encountered with the configuration, they will be presented as part of the above output. -.SS Client Mode -.sp -Running \fI\%mongokerberos\fP in client mode tests authentication +.SS CLIENT MODE +.PP +Running \fBmongokerberos\f1\f1 in client mode tests authentication against your system\(aqs Kerberos environment, performing each step in the Kerberos authentication process, including checking for proper DNS resolution, verification of the Kerberos client keytab file, and testing whether a ticket can be successfully granted. Running -\fI\%mongokerberos\fP in client mode simulates the client -authentication procedure of the \fBmongo\fP shell. -.sp -Before you can use \fI\%mongokerberos\fP in client mode, you must +\fBmongokerberos\f1\f1 in client mode simulates the client +authentication procedure of \fBmongosh\f1\f1\&. +.PP +Before you can use \fBmongokerberos\f1\f1 in client mode, you must first have configured Kerberos on your platform according to your platform\(aqs documentation. Optionally, you may also choose to run -\fI\%mongokerberos\fP in -\fI\%server mode\fP first to verify that your +\fBmongokerberos\f1\f1 in +\fBserver mode\f1 first to verify that your platform\(aqs Kerberos configuration is valid before using client mode. -.sp +.PP Once you have completed these steps, you can run -\fI\%mongokerberos\fP in client mode to test user authentication, -using the \fB\-\-client\fP flag as follows: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongokerberos \-\-client \-\-username <username> -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBmongokerberos\f1\f1 in client mode to test user authentication, +using the \fB\-\-client\f1 flag as follows: +.PP +.EX + mongokerberos \-\-client \-\-username <username> +.EE +.PP You must provide a valid username, which is used to request a Kerberos ticket as part of the authentication procedure. Your platform\(aqs Kerberos infrastructure must be aware of this user. -.sp +.PP If the provided credentials are valid, and the Kerberos options in the configuration files are valid, the output might resemble the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C - Resolving kerberos environment... - [OK] Kerberos environment resolved without errors. - - Verifying DNS resolution works with Kerberos service at <hostname>... - [OK] DNS test successful. - - Getting MIT Kerberos KRB5 environment variables... - * KRB5CCNAME: not set. - * KRB5_CLIENT_KTNAME: not set. - * KRB5_CONFIG: not set. - * KRB5_KTNAME: not set. - * KRB5_TRACE: not set. - [OK] - - Verifying existence of KRB5 client keytab FILE:/path/to/client.keytab... - [OK] KRB5 client keytab exists and is populated. - - Checking principal(s) in KRB5 keytab... - [OK] KRB5 keytab is valid. - - Fetching KRB5 Config... - KRB5 config profile resolved as: - <Your Kerberos profile file will be output here> - [OK] KRB5 config profile resolved without errors. - - Attempting client half of GSSAPI conversation... - [OK] Client half of GSSAPI conversation completed successfully. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + Resolving kerberos environment... + [OK] Kerberos environment resolved without errors. + + Verifying DNS resolution works with Kerberos service at <hostname>... + [OK] DNS test successful. + + Getting MIT Kerberos KRB5 environment variables... + * KRB5CCNAME: not set. + * KRB5_CLIENT_KTNAME: not set. + * KRB5_CONFIG: not set. + * KRB5_KTNAME: not set. + * KRB5_TRACE: not set. + [OK] + + Verifying existence of KRB5 client keytab FILE:/path/to/client.keytab... + [OK] KRB5 client keytab exists and is populated. + + Checking principal(s) in KRB5 keytab... + [OK] KRB5 keytab is valid. + + Fetching KRB5 Config... + KRB5 config profile resolved as: + <Your Kerberos profile file will be output here> + [OK] KRB5 config profile resolved without errors. + + Attempting client half of GSSAPI conversation... + [OK] Client half of GSSAPI conversation completed successfully. +.EE +.PP The final message indicates that client authentication completed successfully for the user provided. If any errors are encountered during the authentication steps, they will be presented as part of the above output. .SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-server -Runs \fI\%mongokerberos\fP in server mode to test that your +.PP +\fBmongokerberos \-\-server\f1 +.RS +.PP +Runs \fBmongokerberos\f1\f1 in server mode to test that your platform\(aqs Kerberos configuration is valid for use with MongoDB. -.sp -See \fI\%Server Mode\fP for example usage and expected +.PP +See \fBServer Mode\f1 for example usage and expected output. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-client -Runs \fI\%mongokerberos\fP in client mode to test client +.RE +.PP +\fBmongokerberos \-\-client\f1 +.RS +.PP +Runs \fBmongokerberos\f1\f1 in client mode to test client authentication against your system\(aqs Kerberos environment. Requires -specifying a valid username with \fI\%\-\-username\fP when running in -client mode. \fI\%mongokerberos\fP will request a Kerberos ticket +specifying a valid username with \fB\-\-username\f1\f1 when running in +client mode. \fBmongokerberos\f1\f1 will request a Kerberos ticket for this username as part of the validation procedure. Running -\fI\%mongokerberos\fP in client mode simulates the client -authentication procedure of the \fBmongo\fP shell. -.sp -See \fI\%Client Mode\fP for example usage and expected +\fBmongokerberos\f1\f1 in client mode simulates the client +authentication procedure of \fBmongosh\f1\f1\&. +.PP +See \fBClient Mode\f1 for example usage and expected output. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-config <filename>, \-f <filename> +.RE +.PP +\fBmongokerberos \-\-config\f1, \fBmongokerberos \-f\f1 +.RS +.PP Specifies a configuration file for runtime configuration options. The options are equivalent to the command\-line -configuration options. See /reference/configuration\-options for +configuration options. See \fBConfiguration File Options\f1 for more information. -.sp -\fI\%mongokerberos\fP will read the values for -\fBsaslHostName\fP and \fBsaslServiceName\fP from this +.PP +\fBmongokerberos\f1\f1 will read the values for +\fBsaslHostName\f1\f1 and \fBsaslServiceName\f1\f1 from this file if present. These values can alteratively be specified with the -\fI\%\-\-setParameter\fP option instead. -.sp +\fB\-\-setParameter\f1\f1 option instead. +.PP Ensure the configuration file uses ASCII encoding. The -\fI\%mongokerberos\fP instance does not support configuration +\fBmongokerberos\f1\f1 instance does not support configuration files with non\-ASCII encoding, including UTF\-8. -.sp -Only valid in \fI\%server mode\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-setParameter <options> +.PP +Only valid in \fBserver mode\f1\&. +.RE +.PP +\fBmongokerberos \-\-setParameter\f1 +.RS +.PP Sets a configurable parameter. You can specify multiple -\fBsetParameter\fP fields. -.sp -While you can use any supported parameters with \fBsetParameter\fP, -\fI\%mongokerberos\fP only checks for the value of the following: -.INDENT 7.0 +\fBsetParameter\f1 fields. +.PP +While you can use any supported parameters with \fBsetParameter\f1, +\fBmongokerberos\f1\f1 only checks for the value of the following: +.RS .IP \(bu 2 -\fBsaslHostName\fP +\fBsaslHostName\f1\f1 .IP \(bu 2 -\fBsaslServiceName\fP -.UNINDENT -.sp -If using the \fI\%\-\-config\fP option with a configuration file that -also contains these values, the \fBsetParameter\fP values will +\fBsaslServiceName\f1\f1 +.RE +.PP +If using the \fB\-\-config\f1\f1 option with a configuration file that +also contains these values, the \fBsetParameter\f1 values will override the values from the configuration file. -.sp -Valid in both \fI\%server mode\fP -and \fI\%client mode\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-host <hostname> +.PP +Valid in both \fBserver mode\f1 +and \fBclient mode\f1\&. +.RE +.PP +\fBmongokerberos \-\-host\f1 +.RS +.PP Specify the hostname of the MongoDB server to connect to when testing authentication. -.sp -If \fI\%\-\-host\fP is not specified, \fI\%mongokerberos\fP does +.PP +If \fB\-\-host\f1\f1 is not specified, \fBmongokerberos\f1\f1 does not perform any DNS validation of the hostname (i.e. PTR record verification) -.sp -Only valid in \fI\%client mode\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-username <username>, \-u <username> -Username for \fI\%mongokerberos\fP to use when attempting Kerberos +.PP +Only valid in \fBclient mode\f1\&. +.RE +.PP +\fBmongokerberos \-\-username\f1, \fBmongokerberos \-u\f1 +.RS +.PP +Username for \fBmongokerberos\f1\f1 to use when attempting Kerberos authentication. This value is required when running in -\fI\%client mode\fP\&. -.sp -Only valid in \fI\%client mode\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gssapiServiceName <servicename> -\fIdefault: \(aqmongodb\(aq\fP -.sp +\fBclient mode\f1\&. +.PP +Only valid in \fBclient mode\f1\&. +.RE +.PP +\fBmongokerberos \-\-gssapiServiceName\f1 +.RS +.PP +\fIdefault: \(aqmongodb\(aq\f1 +.PP Service principal name to use when authenticating using GSSAPI/Kerberos. -.sp -Only valid in \fI\%client mode\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gssapiHostName <hostname> +.PP +Only valid in \fBclient mode\f1\&. +.RE +.PP +\fBmongokerberos \-\-gssapiHostName\f1 +.RS +.PP Remote hostname to use for purpose of GSSAPI/Kerberos authentication. -.sp -Only valid in \fI\%client mode\fP\&. -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +.PP +Only valid in \fBclient mode\f1\&. +.RE diff --git a/debian/mongoldap.1 b/debian/mongoldap.1 index 2d45ee37736..9ccc3ebc7a6 100644 --- a/debian/mongoldap.1 +++ b/debian/mongoldap.1 @@ -1,857 +1,698 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGOLDAP" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongoldap \- MongoDB LDAP Configuration Testing Utility -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Installation\fP -.IP \(bu 2 -\fI\%Usage\fP -.IP \(bu 2 -\fI\%Options\fP -.UNINDENT -.sp -New in version 3.4: MongoDB Enterprise - +.TH mongoldap 1 +.SH MONGOLDAP .SH SYNOPSIS -.sp Starting in version 3.4, MongoDB Enterprise provides -\fI\%mongoldap\fP for testing MongoDB\(aqs LDAP configuration -options against a running LDAP server or set +\fBmongoldap\f1\f1 for testing MongoDB\(aqs LDAP \fBconfiguration +options\f1 against a running LDAP server or set of servers. -.sp +.PP To validate the LDAP options in the configuration file, set the -\fI\%mongoldap\fP \fI\%\-\-config\fP option to the configuration file\(aqs +\fBmongoldap\f1\f1 \fB\-\-config\f1\f1 option to the configuration file\(aqs path. -.sp -To test the LDAP configuration options, you must specify a \fI\%\-\-user\fP -and \fB\-\-password\fP\&. \fI\%mongoldap\fP simulates authentication to a +.PP +To test the LDAP configuration options, you must specify a \fB\-\-user\f1\f1 +and \fB\-\-password\f1\&. \fBmongoldap\f1\f1 simulates authentication to a MongoDB server running with the provided configuration options and credentials. -.sp -\fI\%mongoldap\fP returns a report that includes the success or failure of +.PP +\fBmongoldap\f1\f1 returns a report that includes the success or failure of any step in the LDAP authentication or authorization procedure. Error messages include information on specific errors encountered and potential advice for resolving the error. -.sp -When configuring options related to LDAP authorization, \fI\%mongoldap\fP executes an LDAP query +.PP +When configuring options related to \fBLDAP authorization\f1, \fBmongoldap\f1\f1 executes an LDAP query constructed using the provided configuration options and username, and returns -a list of roles on the \fBadmin\fP database which the user is authorized for. -.sp -You can use this information when configuring LDAP authorization roles for user access control. For example, use -\fI\%mongoldap\fP to ensure your configuration allows privileged users to +a list of roles on the \fBadmin\f1 database which the user is authorized for. +.PP +You can use this information when configuring \fBLDAP authorization roles\f1 for user access control. For example, use +\fBmongoldap\f1\f1 to ensure your configuration allows privileged users to gain the necessary roles to perform their expected tasks. Similarly, use -\fI\%mongoldap\fP to ensure your configuration disallows non\-privileged +\fBmongoldap\f1\f1 to ensure your configuration disallows non\-privileged users from gaining roles for accessing the MongoDB server, or performing unauthorized actions. -.sp -When configuring options related to LDAP authentication, use \fI\%mongoldap\fP to ensure that the authentication +.PP +When configuring options related to \fBLDAP authentication\f1, use \fBmongoldap\f1\f1 to ensure that the authentication operation works as expected. -.sp -Run \fI\%mongoldap\fP from the system command line, not the \fBmongo\fP shell. -.sp +.PP +Run \fBmongoldap\f1\f1 from the system command line, not in the +\fBmongosh\f1\f1\&. +.PP This document provides a complete overview of all command line options for -\fI\%mongoldap\fP\&. +\fBmongoldap\f1\f1\&. .SH INSTALLATION -.sp -The \fI\%mongoldap\fP tool is part of the \fIMongoDB Database Tools Extra\fP -package, and can be \fI\%installed with the MongoDB Server\fP or as a -\fI\%standalone installation\fP\&. -.SS Install with Server -.sp -To install \fI\%mongoldap\fP as part of a MongoDB Enterprise Server +.PP +The \fBmongoldap\f1\f1 tool is part of the \fIMongoDB Database Tools Extra\f1 +package, and can be \fBinstalled with the MongoDB Server\f1 or as a +\fBstandalone installation\f1\&. +.SS INSTALL WITH SERVER +.PP +To install \fBmongoldap\f1\f1 as part of a MongoDB Enterprise Server installation: -.INDENT 0.0 +.RS .IP \(bu 2 Follow the instructions for your platform: -Install MongoDB Enterprise Server +\fBInstall MongoDB Enterprise Server\f1 .IP \(bu 2 -After completing the installation, \fI\%mongoldap\fP and the other +After completing the installation, \fBmongoldap\f1\f1 and the other included tools are available in the same location as the Server. -.sp -\fBNOTE:\fP -.INDENT 2.0 -.INDENT 3.5 -For the Windows \fB\&.msi\fP installer wizard, the -Complete installation option includes \fI\%mongoldap\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Install as Standalone -.sp -To install \fI\%mongoldap\fP as a standalone installation: -.INDENT 0.0 +.IP +For the Windows \fB\&.msi\f1 installer wizard, the +Complete installation option includes \fBmongoldap\f1\f1\&. +.RE +.SS INSTALL AS STANDALONE +.PP +To install \fBmongoldap\f1\f1 as a standalone installation: +.RS .IP \(bu 2 Follow the download link for MongoDB Enterprise Edition: -\fI\%MongoDB Enterprise Download Center\fP +MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise?tck=docs_server) .IP \(bu 2 Select your Platform (operating system) from the dropdown menu, then select the appropriate Package for your platform according to the following chart: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 4 +.RS +.IP \(bu 6 OS -T} T{ +.IP \(bu 6 Package -T} -_ -T{ -\fILinux\fP -T} T{ -\fBtgz\fP package -T} -_ -T{ -\fIWindows\fP -T} T{ -\fBzip\fP package -T} -_ -T{ -\fImacOS\fP -T} T{ -\fBtgz\fP package -T} -_ -.TE +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Linux +.IP \(bu 6 +\fBtgz\f1 package +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Windows +.IP \(bu 6 +\fBzip\f1 package +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +macOS +.IP \(bu 6 +\fBtgz\f1 package +.RE +.RE .IP \(bu 2 -Once downloaded, unpack the archive and copy \fI\%mongoldap\fP to a +Once downloaded, unpack the archive and copy \fBmongoldap\f1\f1 to a location on your hard drive. -.INDENT 2.0 -.INDENT 3.5 -.SS Tip -.sp -Linux and macOS users may wish to copy \fI\%mongoldap\fP to a filesystem -location that is defined in the \fB$PATH\fP environment variable, such -as \fB/usr/bin\fP\&. Doing so allows referencing \fI\%mongoldap\fP directly +.IP +Linux and macOS users may wish to copy \fBmongoldap\f1\f1 to a filesystem +location that is defined in the \fB$PATH\f1 environment variable, such +as \fB/usr/bin\f1\&. Doing so allows referencing \fBmongoldap\f1\f1 directly on the command line by name, without needing to specify its full path, or first navigating to its parent directory. See the -installation guide for your platform +\fBinstallation guide\f1 for your platform for more information. -.UNINDENT -.UNINDENT -.UNINDENT +.RE .SH USAGE -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 +.PP A full description of LDAP or Active Directory is beyond the scope of this documentation. -.UNINDENT -.UNINDENT -.sp +.PP Consider the following sample configuration file, designed to support LDAP authentication and authorization via Active Directory: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -security: - authorization: "enabled" - ldap: - servers: "activedirectory.example.net" - bind: - queryUser: "mongodbadmin@dba.example.com" - queryPassword: "secret123" - userToDNMapping: - \(aq[ - { - match : "(.+)", - ldapQuery: "DC=example,DC=com??sub?(userPrincipalName={0})" - } - ]\(aq - authz: - queryTemplate: "DC=example,DC=com??sub?(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={USER}))" -setParameter: - authenticationMechanisms: "PLAIN" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -You can use \fI\%mongoldap\fP to validate the configuration file, which +.PP +.EX + security: + authorization: "enabled" + ldap: + servers: "activedirectory.example.net" + bind: + queryUser: "mongodbadmin@dba.example.com" + queryPassword: "secret123" + userToDNMapping: + \(aq[ + { + match : "(.+)", + ldapQuery: "DC=example,DC=com??sub?(userPrincipalName={0})" + } + ]\(aq + authz: + queryTemplate: "DC=example,DC=com??sub?(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={USER}))" + setParameter: + authenticationMechanisms: "PLAIN" +.EE +.PP +You can use \fBmongoldap\f1\f1 to validate the configuration file, which returns a report of the procedure. You must specify a username and password -for \fI\%mongoldap\fP\&. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongoldap \-\-config=<path\-to\-config> \-\-user="bob@dba.example.com" \-\-password="secret123" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +for \fBmongoldap\f1\f1\&. +.PP +.EX + mongoldap \-\-config=<path\-to\-config> \-\-user="bob@dba.example.com" \-\-password="secret123" +.EE +.PP If the provided credentials are valid, and the LDAP options in the configuration files are valid, the output might be as follows: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Checking that an LDAP server has been specified... -[OK] LDAP server found - -Connecting to LDAP server... -[OK] Connected to LDAP server - -Parsing MongoDB to LDAP DN mappings.. -[OK] MongoDB to LDAP DN mappings appear to be valid - -Attempting to authenticate against the LDAP server... -[OK] Successful authentication performed - -Checking if LDAP authorization has been enabled by configuration... -[OK] LDAP authorization enabled - -Parsing LDAP query template.. -[OK] LDAP query configuration template appears valid - -Executing query against LDAP server... -[OK] Successfully acquired the following roles: -\&... -.ft P -.fi -.UNINDENT -.UNINDENT +.PP +.EX + Checking that an LDAP server has been specified... + [OK] LDAP server found + + Connecting to LDAP server... + [OK] Connected to LDAP server + + Parsing MongoDB to LDAP DN mappings.. + [OK] MongoDB to LDAP DN mappings appear to be valid + + Attempting to authenticate against the LDAP server... + [OK] Successful authentication performed + + Checking if LDAP authorization has been enabled by configuration... + [OK] LDAP authorization enabled + + Parsing LDAP query template.. + [OK] LDAP query configuration template appears valid + + Executing query against LDAP server... + [OK] Successfully acquired the following roles: + ... +.EE .SH OPTIONS -.INDENT 0.0 -.TP -.B \-\-config=<filename>, \-f=<filename> +.PP +\fBmongoldap \-\-config\f1, \fBmongoldap \-f\f1 +.RS +.PP Specifies a configuration file for runtime configuration options. The options are equivalent to the command\-line -configuration options. See /reference/configuration\-options for +configuration options. See \fBConfiguration File Options\f1 for more information. -.sp -\fBmongoldap\fP uses any configuration options related to security\-ldap -or security\-ldap\-external for testing LDAP authentication or +.PP +\fBmongoldap\f1\f1 uses any configuration options related to \fBLDAP Proxy Authentication\f1 +or \fBLDAP Authorization\f1 for testing LDAP authentication or authorization. -.sp -Requires specifying \fI\%\-\-user\fP\&. May accept \fI\%\-\-password\fP for +.PP +Requires specifying \fB\-\-user\f1\f1\&. May accept \fB\-\-password\f1\f1 for testing LDAP authentication. -.sp -Ensure the configuration file uses ASCII encoding. The \fBmongoldap\fP +.PP +Ensure the configuration file uses ASCII encoding. The \fBmongoldap\f1\f1 instance does not support configuration files with non\-ASCII encoding, including UTF\-8. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-user=<string> -Username for \fBmongoldap\fP to use when attempting LDAP authentication or +.RE +.PP +\fBmongoldap \-\-user\f1 +.RS +.PP +Username for \fBmongoldap\f1\f1 to use when attempting LDAP authentication or authorization. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-password=<string> -Password of the \fI\%\-\-user\fP for -\fBmongoldap\fP to use when attempting LDAP authentication. Not +.RE +.PP +\fBmongoldap \-\-password\f1 +.RS +.PP +Password of the \fB\-\-user\f1\f1 for +\fBmongoldap\f1\f1 to use when attempting LDAP authentication. Not required for LDAP authorization. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapServers=<host1>:<port>,<host2>:<port>,...,<hostN>:<port> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The LDAP server against which the \fBmongoldap\fP authenticates users or +.RE +.PP +\fBmongoldap \-\-ldapServers\f1 +.RS +.PP +The LDAP server against which the \fBmongoldap\f1\f1 authenticates users or determines what actions a user is authorized to perform on a given database. If the LDAP server specified has any replicated instances, you may specify the host and port of each replicated server in a comma\-delimited list. -.sp +.PP If your LDAP infrastructure partitions the LDAP directory over multiple LDAP -servers, specify \fIone\fP LDAP server or any of its replicated instances to -\fI\%\-\-ldapServers\fP\&. MongoDB supports following LDAP referrals as defined in \fI\%RFC 4511 -4.1.10\fP\&. Do not use \fI\%\-\-ldapServers\fP +servers, specify \fIone\f1 LDAP server or any of its replicated instances to +\fB\-\-ldapServers\f1\f1\&. MongoDB supports following LDAP referrals as defined in RFC 4511 +4.1.10 (https://www.rfc\-editor.org/rfc/rfc4511.txt)\&. Do not use \fB\-\-ldapServers\f1\f1 for listing every LDAP server in your infrastructure. -.sp -This setting can be configured on a running \fBmongoldap\fP using -\fBsetParameter\fP\&. -.sp -If unset, \fBmongoldap\fP cannot use LDAP authentication or authorization\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryUser=<string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The identity with which \fBmongoldap\fP binds as, when connecting to or +.PP +This setting can be configured on a running \fBmongoldap\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +If unset, \fBmongoldap\f1\f1 cannot use \fBLDAP authentication or authorization\f1\&. +.RE +.PP +\fBmongoldap \-\-ldapQueryUser\f1 +.RS +.PP +The identity with which \fBmongoldap\f1\f1 binds as, when connecting to or performing queries on an LDAP server. -.sp +.PP Only required if any of the following are true: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -You must use \fI\%\-\-ldapQueryUser\fP with \fI\%\-\-ldapQueryPassword\fP\&. -.sp -If unset, \fBmongoldap\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongoldap\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryPassword=<string> -New in version 3.4: Available in MongoDB Enterprise only. -.sp +.RE +.PP +You must use \fB\-\-ldapQueryUser\f1\f1 with \fB\-\-ldapQueryPassword\f1\f1\&. +.PP +If unset, \fBmongoldap\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongoldap\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongoldap \-\-ldapQueryPassword\f1 +.RS +.PP The password used to bind to an LDAP server when using -\fI\%\-\-ldapQueryUser\fP\&. You must use \fI\%\-\-ldapQueryPassword\fP with -\fI\%\-\-ldapQueryUser\fP\&. - -.sp -If unset, \fBmongoldap\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongoldap\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindWithOSDefaults=<bool> -\fIDefault\fP: false -.sp -New in version 3.4: Available in MongoDB Enterprise for the Windows platform only. - -.sp -Allows \fBmongoldap\fP to authenticate, or bind, using your Windows login +\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with +\fB\-\-ldapQueryUser\f1\f1\&. +.PP +If unset, \fBmongoldap\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongoldap\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongoldap \-\-ldapBindWithOSDefaults\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Available in MongoDB Enterprise for the Windows platform only. +.PP +Allows \fBmongoldap\f1\f1 to authenticate, or bind, using your Windows login credentials when connecting to the LDAP server. -.sp +.PP Only required if: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -Use \fI\%\-\-ldapBindWithOSDefaults\fP to replace \fI\%\-\-ldapQueryUser\fP and -\fI\%\-\-ldapQueryPassword\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindMethod=<string> -\fIDefault\fP: simple -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The method \fBmongoldap\fP uses to authenticate to an LDAP -server. Use with \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP to connect to the LDAP server. -.sp -\fI\%\-\-ldapBindMethod\fP supports +.RE +.PP +Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 and +\fB\-\-ldapQueryPassword\f1\f1\&. +.RE +.PP +\fBmongoldap \-\-ldapBindMethod\f1 +.RS +.PP +\fIDefault\f1: simple +.PP +The method \fBmongoldap\f1\f1 uses to authenticate to an LDAP +server. Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to connect to the LDAP server. +.PP +\fB\-\-ldapBindMethod\f1\f1 supports the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsimple\fP -T} T{ -\fBmongoldap\fP uses simple authentication. -T} -_ -T{ -\fBsasl\fP -T} T{ -\fBmongoldap\fP uses SASL protocol for authentication. -T} -_ -.TE -.sp -If you specify \fBsasl\fP, you can configure the available SASL mechanisms -using \fI\%\-\-ldapBindSaslMechanisms\fP\&. \fBmongoldap\fP defaults to -using \fBDIGEST\-MD5\fP mechanism. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindSaslMechanisms=<string> -\fIDefault\fP: DIGEST\-MD5 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A comma\-separated list of SASL mechanisms \fBmongoldap\fP can -use when authenticating to the LDAP server. The \fBmongoldap\fP and the -LDAP server must agree on at least one mechanism. The \fBmongoldap\fP +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsimple\f1 +.IP \(bu 4 +\fBmongoldap\f1\f1 uses simple authentication. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsasl\f1 +.IP \(bu 4 +\fBmongoldap\f1\f1 uses SASL protocol for authentication. +.RE +.RE +.PP +If you specify \fBsasl\f1, you can configure the available SASL mechanisms +using \fB\-\-ldapBindSaslMechanisms\f1\f1\&. \fBmongoldap\f1\f1 defaults to +using \fBDIGEST\-MD5\f1 mechanism. +.RE +.PP +\fBmongoldap \-\-ldapBindSaslMechanisms\f1 +.RS +.PP +\fIDefault\f1: DIGEST\-MD5 +.PP +A comma\-separated list of SASL mechanisms \fBmongoldap\f1\f1 can +use when authenticating to the LDAP server. The \fBmongoldap\f1\f1 and the +LDAP server must agree on at least one mechanism. The \fBmongoldap\f1\f1 dynamically loads any SASL mechanism libraries installed on the host machine at runtime. -.sp +.PP Install and configure the appropriate libraries for the selected -SASL mechanism(s) on both the \fBmongoldap\fP host and the remote +SASL mechanism(s) on both the \fBmongoldap\f1\f1 host and the remote LDAP server host. Your operating system may include certain SASL libraries by default. Defer to the documentation associated with each SASL mechanism for guidance on installation and configuration. -.sp -If using the \fBGSSAPI\fP SASL mechanism for use with -security\-kerberos, verify the following for the -\fBmongoldap\fP host machine: -.INDENT 7.0 -.TP -.B \fBLinux\fP -.INDENT 7.0 +.PP +If using the \fBGSSAPI\f1 SASL mechanism for use with +\fBKerberos Authentication\f1, verify the following for the +\fBmongoldap\f1\f1 host machine: +.PP +\fBLinux\f1\f1 +.RS +.RS .IP \(bu 2 -The \fBKRB5_CLIENT_KTNAME\fP environment -variable resolves to the name of the client keytab\-files +The \fBKRB5_CLIENT_KTNAME\f1 environment +variable resolves to the name of the client \fBLinux Keytab Files\f1 for the host machine. For more on Kerberos environment variables, please defer to the -\fI\%Kerberos documentation\fP\&. +Kerberos documentation (https://web.mit.edu/kerberos/krb5\-1.13/doc/admin/env_variables.html)\&. .IP \(bu 2 The client keytab includes a -kerberos\-user\-principal for the \fBmongoldap\fP to use when +\fBUser Principal\f1 for the \fBmongoldap\f1\f1 to use when connecting to the LDAP server and execute LDAP queries. -.UNINDENT -.TP -.B \fBWindows\fP +.RE +.RE +.PP +\fBWindows\f1\f1 +.RS +.PP If connecting to an Active Directory server, the Windows Kerberos configuration automatically generates a -\fI\%Ticket\-Granting\-Ticket\fP -when the user logs onto the system. Set \fI\%\-\-ldapBindWithOSDefaults\fP to -\fBtrue\fP to allow \fBmongoldap\fP to use the generated credentials when +Ticket\-Granting\-Ticket (https://msdn.microsoft.com/en\-us/library/windows/desktop/aa380510(v=vs.85).aspx) +when the user logs onto the system. Set \fB\-\-ldapBindWithOSDefaults\f1\f1 to +\fBtrue\f1 to allow \fBmongoldap\f1\f1 to use the generated credentials when connecting to the Active Directory server and execute queries. -.UNINDENT -.sp -Set \fI\%\-\-ldapBindMethod\fP to \fBsasl\fP to use this option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.PP +Set \fB\-\-ldapBindMethod\f1\f1 to \fBsasl\f1 to use this option. +.PP For a complete list of SASL mechanisms see the -\fI\%IANA listing\fP\&. +IANA listing (http://www.iana.org/assignments/sasl\-mechanisms/sasl\-mechanisms.xhtml)\&. Defer to the documentation for your LDAP or Active Directory service for identifying the SASL mechanisms compatible with the service. -.sp +.PP MongoDB is not a source of SASL mechanism libraries, nor is the MongoDB documentation a definitive source for installing or configuring any given SASL mechanism. For documentation and support, defer to the SASL mechanism library vendor or owner. -.sp +.PP For more information on SASL, defer to the following resources: -.INDENT 0.0 +.RS .IP \(bu 2 -For Linux, please see the \fI\%Cyrus SASL documentation\fP\&. +For Linux, please see the Cyrus SASL documentation (https://www.cyrusimap.org/sasl/)\&. .IP \(bu 2 -For Windows, please see the \fI\%Windows SASL documentation\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTransportSecurity=<string> -\fIDefault\fP: tls -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -By default, \fBmongoldap\fP creates a TLS/SSL secured connection to the LDAP +For Windows, please see the Windows SASL documentation (https://msdn.microsoft.com/en\-us/library/cc223500.aspx)\&. +.RE +.RE +.PP +\fBmongoldap \-\-ldapTransportSecurity\f1 +.RS +.PP +\fIDefault\f1: tls +.PP +By default, \fBmongoldap\f1\f1 creates a TLS/SSL secured connection to the LDAP server. -.sp +.PP For Linux deployments, you must configure the appropriate TLS Options in -\fB/etc/openldap/ldap.conf\fP file. Your operating system\(aqs package manager +\fB/etc/openldap/ldap.conf\f1 file. Your operating system\(aqs package manager creates this file as part of the MongoDB Enterprise installation, via the -\fBlibldap\fP dependency. See the documentation for \fBTLS Options\fP in the -\fI\%ldap.conf OpenLDAP documentation\fP +\fBlibldap\f1 dependency. See the documentation for \fBTLS Options\f1 in the +ldap.conf OpenLDAP documentation (http://www.openldap.org/software/man.cgi?query=ldap.conf&manpath=OpenLDAP+2.4\-Release) for more complete instructions. -.sp +.PP For Windows deployment, you must add the LDAP server CA certificates to the Windows certificate management tool. The exact name and functionality of the tool may vary depending on operating system version. Please see the documentation for your version of Windows for more information on certificate management. -.sp -Set \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP to disable TLS/SSL between \fBmongoldap\fP and the LDAP +.PP +Set \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 to disable TLS/SSL between \fBmongoldap\f1\f1 and the LDAP server. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -Setting \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP transmits plaintext information and possibly -credentials between \fBmongoldap\fP and the LDAP server. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTimeoutMS=<long> -\fIDefault\fP: 10000 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The amount of time in milliseconds \fBmongoldap\fP should wait for an LDAP server +.PP +Setting \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 transmits plaintext information and possibly +credentials between \fBmongoldap\f1\f1 and the LDAP server. +.RE +.PP +\fBmongoldap \-\-ldapTimeoutMS\f1 +.RS +.PP +\fIDefault\f1: 10000 +.PP +The amount of time in milliseconds \fBmongoldap\f1\f1 should wait for an LDAP server to respond to a request. -.sp -Increasing the value of \fI\%\-\-ldapTimeoutMS\fP may prevent connection failure between the +.PP +Increasing the value of \fB\-\-ldapTimeoutMS\f1\f1 may prevent connection failure between the MongoDB server and the LDAP server, if the source of the failure is a -connection timeout. Decreasing the value of \fI\%\-\-ldapTimeoutMS\fP reduces the time +connection timeout. Decreasing the value of \fB\-\-ldapTimeoutMS\f1\f1 reduces the time MongoDB waits for a response from the LDAP server. -.sp -This setting can be configured on a running \fBmongoldap\fP using -\fBsetParameter\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapUserToDNMapping=<string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -Maps the username provided to \fBmongoldap\fP for authentication to a LDAP -Distinguished Name (DN). You may need to use \fI\%\-\-ldapUserToDNMapping\fP to transform a +.PP +This setting can be configured on a running \fBmongoldap\f1\f1 using +\fBsetParameter\f1\f1\&. +.RE +.PP +\fBmongoldap \-\-ldapUserToDNMapping\f1 +.RS +.PP +Maps the username provided to \fBmongoldap\f1\f1 for authentication to a LDAP +Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a username into an LDAP DN in the following scenarios: -.INDENT 7.0 +.RS .IP \(bu 2 Performing LDAP authentication with simple LDAP binding, where users authenticate to MongoDB with usernames that are not full LDAP DNs. .IP \(bu 2 -Using an \fBLDAP authorization query template\fP that requires a DN. +Using an \fBLDAP authorization query template\f1\f1 that requires a DN. .IP \(bu 2 Transforming the usernames of clients authenticating to Mongo DB using different authentication mechanisms (e.g. x.509, kerberos) to a full LDAP DN for authorization. -.UNINDENT -.sp -\fI\%\-\-ldapUserToDNMapping\fP expects a quote\-enclosed JSON\-string representing an ordered array -of documents. Each document contains a regular expression \fBmatch\fP and -either a \fBsubstitution\fP or \fBldapQuery\fP template used for transforming the +.RE +.PP +\fB\-\-ldapUserToDNMapping\f1\f1 expects a quote\-enclosed JSON\-string representing an ordered array +of documents. Each document contains a regular expression \fBmatch\f1 and +either a \fBsubstitution\f1 or \fBldapQuery\f1 template used for transforming the incoming username. -.sp +.PP Each document in the array has the following form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - match: "<regex>" - substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.TS -center; -|l|l|l|. -_ -T{ +.PP +.EX + { + match: "<regex>" + substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" + } +.EE +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Field -T} T{ +.IP \(bu 4 Description -T} T{ +.IP \(bu 4 Example -T} -_ -T{ -\fBmatch\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBmatch\f1 +.IP \(bu 4 An ECMAScript\-formatted regular expression (regex) to match against a provided username. Each parenthesis\-enclosed section represents a -regex capture group used by \fBsubstitution\fP or \fBldapQuery\fP\&. -T} T{ -\fB"(.+)ENGINEERING"\fP -\fB"(.+)DBA"\fP -T} -_ -T{ -\fBsubstitution\fP -T} T{ +regex capture group used by \fBsubstitution\f1 or \fBldapQuery\f1\&. +.IP \(bu 4 +\fB"(.+)ENGINEERING"\f1 +\fB"(.+)DBA"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubstitution\f1 +.IP \(bu 4 An LDAP distinguished name (DN) formatting template that converts the -authentication name matched by the \fBmatch\fP regex into a LDAP DN. +authentication name matched by the \fBmatch\f1 regex into a LDAP DN. Each curly bracket\-enclosed numeric value is replaced by the -corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP regex. -.sp -The result of the substitution must be an \fI\%RFC4514\fP escaped string. -T} T{ +corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 regex. +.IP +The result of the substitution must be an RFC4514 (https://www.ietf.org/rfc/rfc4514.txt) escaped string. +.IP \(bu 4 \fB"cn={0},ou=engineering, -dc=example,dc=com"\fP -T} -_ -T{ -\fBldapQuery\fP -T} T{ +dc=example,dc=com"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBldapQuery\f1 +.IP \(bu 4 A LDAP query formatting template that inserts the authentication -name matched by the \fBmatch\fP regex into an LDAP query URI encoded +name matched by the \fBmatch\f1 regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. Each curly bracket\-enclosed numeric -value is replaced by the corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP expression. -\fBmongoldap\fP executes the query against the LDAP server to retrieve -the LDAP DN for the authenticated user. \fBmongoldap\fP requires +value is replaced by the corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 expression. +\fBmongoldap\f1\f1 executes the query against the LDAP server to retrieve +the LDAP DN for the authenticated user. \fBmongoldap\f1\f1 requires exactly one returned result for the transformation to be -successful, or \fBmongoldap\fP skips this transformation. -T} T{ +successful, or \fBmongoldap\f1\f1 skips this transformation. +.IP \(bu 4 \fB"ou=engineering,dc=example, -dc=com??one?(user={0})"\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4514\fP, -\fI\%RFC4515\fP, -\fI\%RFC4516\fP, or LDAP queries is out +dc=com??one?(user={0})"\f1 +.RE +.RE +.PP +An explanation of RFC4514 (https://www.ietf.org/rfc/rfc4514.txt), +RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516), or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.sp -For each document in the array, you must use either \fBsubstitution\fP or -\fBldapQuery\fP\&. You \fIcannot\fP specify both in the same document. -.sp -When performing authentication or authorization, \fBmongoldap\fP steps through +.PP +For each document in the array, you must use either \fBsubstitution\f1 or +\fBldapQuery\f1\&. You \fIcannot\f1 specify both in the same document. +.PP +When performing authentication or authorization, \fBmongoldap\f1\f1 steps through each document in the array in the given order, checking the authentication -username against the \fBmatch\fP filter. If a match is found, -\fBmongoldap\fP applies the transformation and uses the output for -authenticating the user. \fBmongoldap\fP does not check the remaining documents +username against the \fBmatch\f1 filter. If a match is found, +\fBmongoldap\f1\f1 applies the transformation and uses the output for +authenticating the user. \fBmongoldap\f1\f1 does not check the remaining documents in the array. -.sp +.PP If the given document does not match the provided authentication -name, \fBmongoldap\fP continues through the list of documents +name, \fBmongoldap\f1\f1 continues through the list of documents to find additional matches. If no matches are found in any document, or the transformation the document describes fails, -\fBmongoldap\fP returns an error. -.sp -Starting in MongoDB 4.4, \fBmongoldap\fP also returns an error +\fBmongoldap\f1\f1 returns an error. +.PP +Starting in MongoDB 4.4, \fBmongoldap\f1\f1 also returns an error if one of the transformations cannot be evaluated due to networking -or authentication failures to the LDAP server. \fBmongoldap\fP +or authentication failures to the LDAP server. \fBmongoldap\f1\f1 rejects the connection request and does not check the remaining documents in the array. -.INDENT 7.0 -.INDENT 3.5 -.SH EXAMPLE -.sp +.PP +Starting in MongoDB 5.0, \fB\-\-ldapUserToDNMapping\f1\f1 +accepts an empty string \fB""\f1 or empty array \fB[ ]\f1 in place of a +mapping documnent. If providing an empty string or empty array to +\fB\-\-ldapUserToDNMapping\f1\f1, MongoDB will map the +authenticated username as the LDAP DN. Previously, providing an +empty mapping document would cause mapping to fail. +.PP The following shows two transformation documents. The first -document matches against any string ending in \fB@ENGINEERING\fP, placing +document matches against any string ending in \fB@ENGINEERING\f1, placing anything preceeding the suffix into a regex capture group. The -second document matches against any string ending in \fB@DBA\fP, placing +second document matches against any string ending in \fB@DBA\f1, placing anything preceeding the suffix into a regex capture group. -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 -You must pass the array to \fI\%\-\-ldapUserToDNMapping\fP as a string. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"[ - { - match: "(.+)@ENGINEERING.EXAMPLE.COM", - substitution: "cn={0},ou=engineering,dc=example,dc=com" - }, - { - match: "(.+)@DBA.EXAMPLE.COM", - ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" - - } - -]" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A user with username \fBalice@ENGINEERING.EXAMPLE.COM\fP matches the first -document. The regex capture group \fB{0}\fP corresponds to the string -\fBalice\fP\&. The resulting output is the DN -\fB"cn=alice,ou=engineering,dc=example,dc=com"\fP\&. -.sp -A user with username \fBbob@DBA.EXAMPLE.COM\fP matches the second document. -The regex capture group \fB{0}\fP corresponds to the string \fBbob\fP\&. The +.PP +.EX + "[ + { + match: "(.+)@ENGINEERING.EXAMPLE.COM", + substitution: "cn={0},ou=engineering,dc=example,dc=com" + }, + { + match: "(.+)@DBA.EXAMPLE.COM", + ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" + + } + + ]" +.EE +.PP +A user with username \fBalice@ENGINEERING.EXAMPLE.COM\f1 matches the first +document. The regex capture group \fB{0}\f1 corresponds to the string +\fBalice\f1\&. The resulting output is the DN +\fB"cn=alice,ou=engineering,dc=example,dc=com"\f1\&. +.PP +A user with username \fBbob@DBA.EXAMPLE.COM\f1 matches the second document. +The regex capture group \fB{0}\f1 corresponds to the string \fBbob\f1\&. The resulting output is the LDAP query -\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\fP\&. \fBmongoldap\fP executes this +\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\f1\&. \fBmongoldap\f1\f1 executes this query against the LDAP server, returning the result -\fB"cn=bob,ou=dba,dc=example,dc=com"\fP\&. -.UNINDENT -.UNINDENT -.sp -If \fI\%\-\-ldapUserToDNMapping\fP is unset, \fBmongoldap\fP applies no transformations to the username +\fB"cn=bob,ou=dba,dc=example,dc=com"\f1\&. +.PP +If \fB\-\-ldapUserToDNMapping\f1\f1 is unset, \fBmongoldap\f1\f1 applies no transformations to the username when attempting to authenticate or authorize a user against the LDAP server. -.sp -This setting can be configured on a running \fBmongoldap\fP using the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapAuthzQueryTemplate=<string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A relative LDAP query URL formatted conforming to \fI\%RFC4515\fP and \fI\%RFC4516\fP that \fBmongoldap\fP executes to obtain +.PP +This setting can be configured on a running \fBmongoldap\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBmongoldap \-\-ldapAuthzQueryTemplate\f1 +.RS +.PP +A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongoldap\f1\f1 executes to obtain the LDAP groups to which the authenticated user belongs to. The query is -relative to the host or hosts specified in \fI\%\-\-ldapServers\fP\&. -.sp +relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&. +.PP In the URL, you can use the following substituion tokens: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Substitution Token -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB{USER}\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB{USER}\f1 +.IP \(bu 4 Substitutes the authenticated username, or the -\fBtransformed\fP -username if a \fI\%username mapping\fP is specified. -T} -_ -T{ -\fB{PROVIDED_USER}\fP -T} T{ +\fBtransformed\f1\f1 +username if a \fBusername mapping\f1\f1 is specified. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB{PROVIDED_USER}\f1 +.IP \(bu 4 Substitutes the supplied username, i.e. before either -authentication or \fBLDAP transformation\fP\&. -.sp -New in version 4.2. -T} -_ -.TE -.sp +authentication or \fBLDAP transformation\f1\f1\&. +.RE +.RE +.PP When constructing the query URL, ensure that the order of LDAP parameters respects RFC4516: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -[ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If your query includes an attribute, \fBmongoldap\fP assumes that the query +.PP +.EX + [ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ] +.EE +.PP +If your query includes an attribute, \fBmongoldap\f1\f1 assumes that the query retrieves a the DNs which this entity is member of. -.sp -If your query does not include an attribute, \fBmongoldap\fP assumes +.PP +If your query does not include an attribute, \fBmongoldap\f1\f1 assumes the query retrieves all entities which the user is member of. -.sp -For each LDAP DN returned by the query, \fBmongoldap\fP assigns the authorized -user a corresponding role on the \fBadmin\fP database. If a role on the on the -\fBadmin\fP database exactly matches the DN, \fBmongoldap\fP grants the user the +.PP +For each LDAP DN returned by the query, \fBmongoldap\f1\f1 assigns the authorized +user a corresponding role on the \fBadmin\f1 database. If a role on the on the +\fBadmin\f1 database exactly matches the DN, \fBmongoldap\f1\f1 grants the user the roles and privileges assigned to that role. See the -\fBdb.createRole()\fP method for more information on creating roles. -.INDENT 7.0 -.INDENT 3.5 -.SH EXAMPLE -.sp +\fBdb.createRole()\f1\f1 method for more information on creating roles. +.PP This LDAP query returns any groups listed in the LDAP user object\(aqs -\fBmemberOf\fP attribute. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"{USER}?memberOf?base" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Your LDAP configuration may not include the \fBmemberOf\fP attribute as part +\fBmemberOf\f1 attribute. +.PP +.EX + "{USER}?memberOf?base" +.EE +.PP +Your LDAP configuration may not include the \fBmemberOf\f1 attribute as part of the user schema, may possess a different attribute for reporting group membership, or may not track group membership through attributes. Configure your query with respect to your own unique LDAP configuration. -.UNINDENT -.UNINDENT -.sp -If unset, \fBmongoldap\fP cannot authorize users using LDAP. -.sp -This setting can be configured on a running \fBmongoldap\fP using the -\fBsetParameter\fP database command. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4515\fP, -\fI\%RFC4516\fP or LDAP queries is out +.PP +If unset, \fBmongoldap\f1\f1 cannot authorize users using LDAP. +.PP +This setting can be configured on a running \fBmongoldap\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.PP +An explanation of RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516) or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +.RE diff --git a/debian/mongos.1 b/debian/mongos.1 index 40a5149e2b3..56f8b808986 100644 --- a/debian/mongos.1 +++ b/debian/mongos.1 @@ -1,2709 +1,2361 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGOS" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongos \- MongoDB Sharded Cluster Query Router -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Considerations\fP -.IP \(bu 2 -\fI\%Options\fP -.UNINDENT +.TH mongos 1 +.SH MONGOS .SH SYNOPSIS -.sp -For a sharded cluster, the \fI\%mongos\fP +For a \fBsharded cluster\f1, the \fBmongos\f1\f1 instances provide the interface between the client applications and the -sharded cluster. The \fI\%mongos\fP instances route queries and +sharded cluster. The \fBmongos\f1\f1 instances route queries and write operations to the shards. From the perspective of the -application, a \fI\%mongos\fP instance behaves identically to +application, a \fBmongos\f1\f1 instance behaves identically to any other MongoDB instance. .SH CONSIDERATIONS -.INDENT 0.0 +.RS .IP \(bu 2 -Never change the name of the \fI\%mongos\fP binary. +Never change the name of the \fBmongos\f1\f1 binary. .IP \(bu 2 -Starting in version 4.4, \fI\%mongos\fP -can support hedged reads to minimize +Starting in version 4.4, \fBmongos\f1\f1 +can support \fBhedged reads\f1 to minimize latencies. .IP \(bu 2 Starting in version 4.0, MongoDB disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.IP \(bu 2 -Starting in MongoDB 4.0, the \fI\%mongos\fP binary will crash when -attempting to connect to \fBmongod\fP instances whose -feature compatibility version (fCV) is greater than -that of the \fI\%mongos\fP\&. For example, you cannot connect -a MongoDB 4.0 version \fI\%mongos\fP to a 4.2 -sharded cluster with fCV set to 4.2\&. You +more details, see \fBDisable TLS 1.0\f1\&. +.IP \(bu 2 +Starting in MongoDB 4.0, the \fBmongos\f1\f1 binary will crash when +attempting to connect to \fBmongod\f1\f1 instances whose +\fBfeature compatibility version (fCV)\f1 is greater than +that of the \fBmongos\f1\f1\&. For example, you cannot connect +a MongoDB 4.0 version \fBmongos\f1\f1 to a 4.2 +sharded cluster with \fBfCV\f1 set to 4.2\&. You can, however, connect a MongoDB 4.0 version -\fI\%mongos\fP to a 4.2 sharded cluster with fCV set to 4.0\&. -.UNINDENT +\fBmongos\f1\f1 to a 4.2 sharded cluster with \fBfCV\f1 set to 4.0\&. +.RE .SH OPTIONS -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -conf\-file\-command\-line\-mapping -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.2" -.INDENT 0.0 -.IP \(bu 2 -MongoDB deprecates the SSL options and insteads adds new +.PP +\fBConfiguration File Settings and Command\-Line Options Mapping\f1 +.RS +.IP \(bu 2 +MongoDB deprecates the SSL options and instead adds new corresponding TLS options. .IP \(bu 2 MongoDB adds -\fI\%\-\-tlsClusterCAFile\fP/\fBnet.tls.clusterCAFile\fP\&. (Also availalbe +\fB\-\-tlsClusterCAFile\f1\f1/\fBnet.tls.clusterCAFile\f1\f1\&. (Also available in 3.4.18+, 3.6.9+, 4.0.3+) -.UNINDENT -.UNINDENT -.UNINDENT -.SS Core Options -.INDENT 0.0 -.TP -.B \-\-help, \-h -Returns information on the options and use of \fBmongos\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-version -Returns the \fBmongos\fP release number. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-config <filename>, \-f <filename> +.RE +.RS +.IP \(bu 2 +MongoDB 5.0 removes the \fB\-\-serviceExecutor\f1 command\-line option and the +corresponding \fBnet.serviceExecutor\f1 configuration option. +.RE +.SS CORE OPTIONS +.PP +\fBmongos \-\-help\f1, \fBmongos \-h\f1 +.RS +.PP +Returns information on the options and use of \fBmongos\f1\f1\&. +.RE +.PP +\fBmongos \-\-version\f1 +.RS +.PP +Returns the \fBmongos\f1\f1 release number. +.RE +.PP +\fBmongos \-\-config\f1, \fBmongos \-f\f1 +.RS +.PP Specifies a configuration file for runtime configuration options. The configuration file is the preferred method for runtime configuration of -\fBmongos\fP\&. The options are equivalent to the command\-line -configuration options. See /reference/configuration\-options for +\fBmongos\f1\f1\&. The options are equivalent to the command\-line +configuration options. See \fBConfiguration File Options\f1 for more information. -.sp -Ensure the configuration file uses ASCII encoding. The \fBmongos\fP +.PP +Ensure the configuration file uses ASCII encoding. The \fBmongos\f1\f1 instance does not support configuration files with non\-ASCII encoding, including UTF\-8. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-configExpand <none|rest|exec> -\fIDefault\fP: none -.sp -New in version 4.2. - -.sp -Enables using Expansion Directives +.RE +.PP +\fBmongos \-\-configExpand\f1 +.RS +.PP +\fIDefault\f1: none +.PP +Enables using \fBExpansion Directives\f1 in configuration files. Expansion directives allow you to set externally sourced values for configuration file options. -.sp -\fI\%\-\-configExpand\fP supports the following expansion directives: -.TS -center; -|l|l|. -_ -T{ +.PP +\fB\-\-configExpand\f1\f1 supports the following expansion directives: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBnone\fP -T} T{ -Default. \fBmongos\fP does not expand expansion directives. -\fBmongos\fP fails to start if any configuration file settings +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBnone\f1 +.IP \(bu 4 +Default. \fBmongos\f1\f1 does not expand expansion directives. +\fBmongos\f1\f1 fails to start if any configuration file settings use expansion directives. -T} -_ -T{ -\fBrest\fP -T} T{ -\fBmongos\fP expands \fB__rest\fP expansion directives when +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrest\f1 +.IP \(bu 4 +\fBmongos\f1\f1 expands \fB__rest\f1 expansion directives when parsing the configuration file. -T} -_ -T{ -\fBexec\fP -T} T{ -\fBmongos\fP expands \fB__exec\fP expansion directives when +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBexec\f1 +.IP \(bu 4 +\fBmongos\f1\f1 expands \fB__exec\f1 expansion directives when parsing the configuration file. -T} -_ -.TE -.sp +.RE +.RE +.PP You can specify multiple expansion directives as a comma\-separated -list, e.g. \fBrest, exec\fP\&. If the configuration file contains -expansion directives not specified to \fI\%\-\-configExpand\fP, the \fBmongos\fP +list, e.g. \fBrest, exec\f1\&. If the configuration file contains +expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongos\f1\f1 returns an error and terminates. -.sp -See externally\-sourced\-values for configuration files +.PP +See \fBExternally Sourced Configuration File Values\f1 for configuration files for more information on expansion directives. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-verbose, \-v +.RE +.PP +\fBmongos \-\-verbose\f1, \fBmongos \-v\f1 +.RS +.PP Increases the amount of internal reporting returned on standard output -or in log files. Increase the verbosity with the \fB\-v\fP form by -including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quiet -Runs \fBmongos\fP in a quiet mode that attempts to limit the amount +or in log files. Increase the verbosity with the \fB\-v\f1 form by +including the option multiple times, (e.g. \fB\-vvvvv\f1\&.) +.RE +.PP +\fBmongos \-\-quiet\f1 +.RS +.PP +Runs \fBmongos\f1\f1 in a quiet mode that attempts to limit the amount of output. -.sp +.PP This option suppresses: -.INDENT 7.0 +.RS .IP \(bu 2 -output from database commands +output from \fBdatabase commands\f1 .IP \(bu 2 replication activity .IP \(bu 2 connection accepted events .IP \(bu 2 connection closed events -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-port <port> -\fIDefault\fP: 27017 -.sp -The TCP port on which the \fI\%mongos\fP instance listens for +.RE +.RE +.PP +\fBmongos \-\-port\f1 +.RS +.PP +\fIDefault\f1: 27017 +.PP +The TCP port on which the \fBmongos\f1\f1 instance listens for client connections. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bind_ip <hostnames|ipaddresses|Unix domain socket paths> -\fIDefault\fP: localhost -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 3.6, \fBmongos\fP bind to localhost -by default. See 3.6\-bind\-to\-localhost\&. -.UNINDENT -.UNINDENT -.sp +.RE +.PP +\fBmongos \-\-bind_ip\f1 +.RS +.PP +\fIDefault\f1: localhost +.PP +Starting in MongoDB 3.6, \fBmongos\f1\f1 bind to localhost +by default. See \fBDefault Bind to Localhost\f1\&. +.PP The hostnames and/or IP addresses and/or full Unix domain socket -paths on which \fBmongos\fP should listen for client connections. You -may attach \fBmongos\fP to any interface. To bind to multiple +paths on which \fBmongos\f1\f1 should listen for client connections. You +may attach \fBmongos\f1\f1 to any interface. To bind to multiple addresses, enter a list of comma\-separated values. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost,/tmp/mongod.sock\fP -.UNINDENT -.UNINDENT -.sp +.PP You can specify both IPv4 and IPv6 addresses, or hostnames that resolve to an IPv4 or IPv6 address. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost, 2001:0DB8:e132:ba26:0d5c:2774:e7f9:d513\fP -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -If specifying an IPv6 address \fIor\fP a hostname that resolves to an -IPv6 address to \fI\%\-\-bind_ip\fP, you must start \fBmongos\fP with -\fI\%\-\-ipv6\fP to enable IPv6 support. Specifying an IPv6 address -to \fI\%\-\-bind_ip\fP does not enable IPv6 support. -.UNINDENT -.UNINDENT -.sp +.PP +If specifying an IPv6 address \fIor\f1 a hostname that resolves to an +IPv6 address to \fB\-\-bind_ip\f1\f1, you must start \fBmongos\f1\f1 with +\fB\-\-ipv6\f1\f1 to enable IPv6 support. Specifying an IPv6 address +to \fB\-\-bind_ip\f1\f1 does not enable IPv6 support. +.PP If specifying a -\fI\%link\-local IPv6 address\fP -(\fBfe80::/10\fP), you must append the -\fI\%zone index\fP -to that address (i.e. \fBfe80::<address>%<adapter\-name>\fP). -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost,fe80::a00:27ff:fee0:1fcf%enp0s3\fP -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.SS Tip -.sp +link\-local IPv6 address (https://en.wikipedia.org/wiki/Link\-local_address#IPv6) +(\fBfe80::/10\f1), you must append the +zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index)) +to that address (i.e. \fBfe80::<address>%<adapter\-name>\f1). +.PP When possible, use a logical DNS hostname instead of an ip address, particularly when configuring replica set members or sharded cluster members. The use of logical DNS hostnames avoids configuration changes due to ip address changes. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Before binding to a non\-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see -/administration/security\-checklist\&. At minimum, consider -enabling authentication and -hardening network infrastructure\&. -.UNINDENT -.UNINDENT -.sp +\fBSecurity Checklist\f1\&. At minimum, consider +\fBenabling authentication\f1 and +\fBhardening network infrastructure\f1\&. +.PP For more information about IP Binding, refer to the -/core/security\-mongodb\-configuration documentation. -.sp -To bind to all IPv4 addresses, enter \fB0.0.0.0\fP\&. -.sp -To bind to all IPv4 and IPv6 addresses, enter \fB::,0.0.0.0\fP or -starting in MongoDB 4.2, an asterisk \fB"*"\fP (enclose the asterisk in +\fBIP Binding\f1 documentation. +.PP +To bind to all IPv4 addresses, enter \fB0.0.0.0\f1\&. +.PP +To bind to all IPv4 and IPv6 addresses, enter \fB::,0.0.0.0\f1 or +starting in MongoDB 4.2, an asterisk \fB"*"\f1 (enclose the asterisk in quotes to avoid filename pattern expansion). Alternatively, use the -\fBnet.bindIpAll\fP setting. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fB\-\-bind_ip\fP and \fB\-\-bind_ip_all\fP are mutually exclusive. -Specifying both options causes \fBmongos\fP to throw an error and +\fBnet.bindIpAll\f1\f1 setting. +.RS +.IP \(bu 2 +\fB\-\-bind_ip\f1 and \fB\-\-bind_ip_all\f1 are mutually exclusive. +Specifying both options causes \fBmongos\f1\f1 to throw an error and terminate. .IP \(bu 2 -The command\-line option \fB\-\-bind\fP overrides the configuration -file setting \fBnet.bindIp\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bind_ip_all -New in version 3.6. - -.sp -If specified, the \fBmongos\fP instance binds to all IPv4 -addresses (i.e. \fB0.0.0.0\fP). If \fBmongos\fP starts with -\fI\%\-\-ipv6\fP, \fI\%\-\-bind_ip_all\fP also binds to all IPv6 addresses -(i.e. \fB::\fP). -.sp -\fBmongos\fP only supports IPv6 if started with \fI\%\-\-ipv6\fP\&. Specifying -\fI\%\-\-bind_ip_all\fP alone does not enable IPv6 support. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +The command\-line option \fB\-\-bind\f1 overrides the configuration +file setting \fBnet.bindIp\f1\f1\&. +.RE +.RE +.PP +\fBmongos \-\-bind_ip_all\f1 +.RS +.PP +If specified, the \fBmongos\f1\f1 instance binds to all IPv4 +addresses (i.e. \fB0.0.0.0\f1). If \fBmongos\f1\f1 starts with +\fB\-\-ipv6\f1\f1, \fB\-\-bind_ip_all\f1\f1 also binds to all IPv6 addresses +(i.e. \fB::\f1). +.PP +\fBmongos\f1\f1 only supports IPv6 if started with \fB\-\-ipv6\f1\f1\&. Specifying +\fB\-\-bind_ip_all\f1\f1 alone does not enable IPv6 support. +.PP Before binding to a non\-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see -/administration/security\-checklist\&. At minimum, consider -enabling authentication and -hardening network infrastructure\&. -.UNINDENT -.UNINDENT -.sp +\fBSecurity Checklist\f1\&. At minimum, consider +\fBenabling authentication\f1 and +\fBhardening network infrastructure\f1\&. +.PP For more information about IP Binding, refer to the -/core/security\-mongodb\-configuration documentation. -.sp -Alternatively, you can set the \fB\-\-bind_ip\fP option to \fB::,0.0.0.0\fP -or, starting in MongoDB 4.2, to an asterisk \fB"*"\fP (enclose the +\fBIP Binding\f1 documentation. +.PP +Alternatively, you can set the \fB\-\-bind_ip\f1 option to \fB::,0.0.0.0\f1 +or, starting in MongoDB 4.2, to an asterisk \fB"*"\f1 (enclose the asterisk in quotes to avoid filename pattern expansion). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fB\-\-bind_ip\fP and \fB\-\-bind_ip_all\fP are mutually exclusive. That +.PP +\fB\-\-bind_ip\f1 and \fB\-\-bind_ip_all\f1 are mutually exclusive. That is, you can specify one or the other, but not both. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-maxConns <number> -The maximum number of simultaneous connections that \fBmongos\fP will +.RE +.PP +\fBmongos \-\-maxConns\f1 +.RS +.PP +The maximum number of simultaneous connections that \fBmongos\f1\f1 will accept. This setting has no effect if it is higher than your operating system\(aqs configured maximum connection tracking threshold. -.sp +.PP Do not assign too low of a value to this option, or you will encounter errors during normal application operation. -.sp -This is particularly useful for a \fI\%mongos\fP if you have a client +.PP +This is particularly useful for a \fBmongos\f1\f1 if you have a client that creates multiple connections and allows them to timeout rather than closing them. -.sp -In this case, set \fBmaxIncomingConnections\fP to a value slightly +.PP +In this case, set \fBmaxIncomingConnections\f1\f1 to a value slightly higher than the maximum number of connections that the client creates, or the maximum size of the connection pool. -.sp -This setting prevents the \fI\%mongos\fP from causing connection spikes on -the individual shards\&. Spikes like these may disrupt the -operation and memory allocation of the sharded cluster\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logpath <path> +.PP +This setting prevents the \fBmongos\f1\f1 from causing connection spikes on +the individual \fBshards\f1\&. Spikes like these may disrupt the +operation and memory allocation of the \fBsharded cluster\f1\&. +.RE +.PP +\fBmongos \-\-logpath\f1 +.RS +.PP Sends all diagnostic logging information to a log file instead of to -standard output or to the host\(aqs syslog system. MongoDB creates +standard output or to the host\(aqs \fBsyslog\f1 system. MongoDB creates the log file at the path you specify. -.sp +.PP By default, MongoDB will move any existing log file rather than overwrite -it. To instead append to the log file, set the \fI\%\-\-logappend\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syslog -Sends all logging output to the host\(aqs syslog system rather -than to standard output or to a log file (\fI\%\-\-logpath\fP). -.sp -The \fI\%\-\-syslog\fP option is not supported on Windows. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fBsyslog\fP daemon generates timestamps when it logs a message, not +it. To instead append to the log file, set the \fB\-\-logappend\f1\f1 option. +.RE +.PP +\fBmongos \-\-syslog\f1 +.RS +.PP +Sends all logging output to the host\(aqs \fBsyslog\f1 system rather +than to standard output or to a log file (\fB\-\-logpath\f1\f1). +.PP +The \fB\-\-syslog\f1\f1 option is not supported on Windows. +.PP +The \fBsyslog\f1 daemon generates timestamps when it logs a message, not when MongoDB issues the message. This can lead to misleading timestamps for log entries, especially when the system is under heavy load. We -recommend using the \fI\%\-\-logpath\fP option for production systems to +recommend using the \fB\-\-logpath\f1\f1 option for production systems to ensure accurate timestamps. -.UNINDENT -.UNINDENT -.sp -Starting in version 4.2, MongoDB includes the component in its log messages to \fBsyslog\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -\&... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syslogFacility <string> -\fIDefault\fP: user -.sp +.PP +Starting in version 4.2, MongoDB includes the \fBcomponent\f1 in its log messages to \fBsyslog\f1\&. +.PP +.EX + ... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... +.EE +.RE +.PP +\fBmongos \-\-syslogFacility\f1 +.RS +.PP +\fIDefault\f1: user +.PP Specifies the facility level used when logging messages to syslog. The value you specify must be supported by your operating system\(aqs implementation of syslog. To use this option, you -must enable the \fI\%\-\-syslog\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logappend -Appends new entries to the end of the existing log file when the \fBmongos\fP -instance restarts. Without this option, \fBmongod\fP will back up the +must enable the \fB\-\-syslog\f1\f1 option. +.RE +.PP +\fBmongos \-\-logappend\f1 +.RS +.PP +Appends new entries to the end of the existing log file when the \fBmongos\f1\f1 +instance restarts. Without this option, \fBmongod\f1\f1 will back up the existing log and create a new file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logRotate <string> -\fIDefault\fP: rename -.sp -Determines the behavior for the \fBlogRotate\fP command. -Specify either \fBrename\fP or \fBreopen\fP: -.INDENT 7.0 -.IP \(bu 2 -\fBrename\fP renames the log file. -.IP \(bu 2 -\fBreopen\fP closes and reopens the log file following the typical -Linux/Unix log rotate behavior. Use \fBreopen\fP when using the +.RE +.PP +\fBmongos \-\-logRotate\f1 +.RS +.PP +\fIDefault\f1: rename +.PP +Determines the behavior for the \fBlogRotate\f1\f1 command when +rotating the server log and/or the audit log. Specify either +\fBrename\f1 or \fBreopen\f1: +.RS +.IP \(bu 2 +\fBrename\f1 renames the log file. +.IP \(bu 2 +\fBreopen\f1 closes and reopens the log file following the typical +Linux/Unix log rotate behavior. Use \fBreopen\f1 when using the Linux/Unix logrotate utility to avoid log loss. -.sp -If you specify \fBreopen\fP, you must also use \fI\%\-\-logappend\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-redactClientLogData -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A \fBmongos\fP running with \fI\%\-\-redactClientLogData\fP redacts any message accompanying a given -log event before logging. This prevents the \fBmongos\fP from writing +.IP +If you specify \fBreopen\f1, you must also use \fB\-\-logappend\f1\f1\&. +.RE +.RE +.PP +\fBmongos \-\-redactClientLogData\f1 +.RS +.PP +A \fBmongos\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given +log event before logging. This prevents the \fBmongos\f1\f1 from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. -.sp -Use \fI\%\-\-redactClientLogData\fP in conjunction with -/core/security\-encryption\-at\-rest and -/core/security\-transport\-encryption to assist compliance with +.PP +Use \fB\-\-redactClientLogData\f1\f1 in conjunction with +\fBEncryption at Rest\f1 and +\fBTLS/SSL (Transport Encryption)\f1 to assist compliance with regulatory requirements. -.sp +.PP For example, a MongoDB deployment might store Personally Identifiable -Information (PII) in one or more collections. The \fBmongos\fP logs events +Information (PII) in one or more collections. The \fBmongos\f1\f1 logs events such as those related to CRUD operations, sharding metadata, etc. It is -possible that the \fBmongos\fP may expose PII as a part of these logging -operations. A \fBmongos\fP running with \fI\%\-\-redactClientLogData\fP removes any message +possible that the \fBmongos\f1\f1 may expose PII as a part of these logging +operations. A \fBmongos\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 removes any message accompanying these events before being output to the log, effectively removing the PII. -.sp -Diagnostics on a \fBmongos\fP running with \fI\%\-\-redactClientLogData\fP may be more difficult +.PP +Diagnostics on a \fBmongos\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 may be more difficult due to the lack of data related to a log event. See the -process logging manual page for an -example of the effect of \fI\%\-\-redactClientLogData\fP on log output. -.sp -On a running \fBmongos\fP, use \fBsetParameter\fP with the -\fBredactClientLogData\fP parameter to configure this setting. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-timeStampFormat <string> -\fIDefault\fP: iso8601\-local -.sp +\fBprocess logging\f1 manual page for an +example of the effect of \fB\-\-redactClientLogData\f1\f1 on log output. +.PP +On a running \fBmongos\f1\f1, use \fBsetParameter\f1\f1 with the +\fBredactClientLogData\f1\f1 parameter to configure this setting. +.RE +.PP +\fBmongos \-\-timeStampFormat\f1 +.RS +.PP +\fIDefault\f1: iso8601\-local +.PP The time format for timestamps in log messages. Specify one of the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBiso8601\-utc\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBiso8601\-utc\f1 +.IP \(bu 4 Displays timestamps in Coordinated Universal Time (UTC) in the ISO\-8601 format. For example, for New York at the start of the -Epoch: \fB1970\-01\-01T00:00:00.000Z\fP -T} -_ -T{ -\fBiso8601\-local\fP -T} T{ +Epoch: \fB1970\-01\-01T00:00:00.000Z\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBiso8601\-local\f1 +.IP \(bu 4 Displays timestamps in local time in the ISO\-8601 format. For example, for New York at the start of the Epoch: -\fB1969\-12\-31T19:00:00.000\-05:00\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.4, \fI\%\-\-timeStampFormat\fP no longer supports \fBctime\fP\&. -An example of \fBctime\fP formatted date is: \fBWed Dec 31 -18:17:54.811\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-pidfilepath <path> -Specifies a file location to store the process ID (PID) of the \fBmongos\fP -process. The user running the \fBmongod\fP or \fBmongos\fP -process must be able to write to this path. If the \fI\%\-\-pidfilepath\fP option is not +\fB1969\-12\-31T19:00:00.000\-05:00\f1 +.RE +.RE +.PP +Starting in MongoDB 4.4, \fB\-\-timeStampFormat\f1\f1 no longer supports \fBctime\f1\&. +An example of \fBctime\f1 formatted date is: \fBWed Dec 31 +18:17:54.811\f1\&. +.RE +.PP +\fBmongos \-\-pidfilepath\f1 +.RS +.PP +Specifies a file location to store the process ID (PID) of the \fBmongos\f1\f1 +process. The user running the \fBmongod\f1 or \fBmongos\f1 +process must be able to write to this path. If the \fB\-\-pidfilepath\f1\f1 option is not specified, the process does not create a PID file. This option is generally -only useful in combination with the \fI\%\-\-fork\fP option. -.INDENT 7.0 -.INDENT 3.5 -.IP "Linux" -.sp +only useful in combination with the \fB\-\-fork\f1\f1 option. +.PP On Linux, PID file management is generally the responsibility of -your distro\(aqs init system: usually a service file in the \fB/etc/init.d\fP -directory, or a systemd unit file registered with \fBsystemctl\fP\&. Only -use the \fI\%\-\-pidfilepath\fP option if you are not using one of these init +your distro\(aqs init system: usually a service file in the \fB/etc/init.d\f1 +directory, or a systemd unit file registered with \fBsystemctl\f1\&. Only +use the \fB\-\-pidfilepath\f1\f1 option if you are not using one of these init systems. For more information, please see the respective -Installation Guide for your operating system. -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.IP "macOS" -.sp -On macOS, PID file management is generally handled by \fBbrew\fP\&. Only use -the \fI\%\-\-pidfilepath\fP option if you are not using \fBbrew\fP on your macOS system. +\fBInstallation Guide\f1 for your operating system. +.PP +On macOS, PID file management is generally handled by \fBbrew\f1\&. Only use +the \fB\-\-pidfilepath\f1\f1 option if you are not using \fBbrew\f1 on your macOS system. For more information, please see the respective -Installation Guide for your operating system. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyFile <file> +\fBInstallation Guide\f1 for your operating system. +.RE +.PP +\fBmongos \-\-keyFile\f1 +.RS +.PP Specifies the path to a key file that stores the shared secret that MongoDB instances use to authenticate to each other in a -sharded cluster or replica set\&. \fI\%\-\-keyFile\fP implies -\fBclient authorization\fP\&. See inter\-process\-auth for more +\fBsharded cluster\f1 or \fBreplica set\f1\&. \fB\-\-keyFile\f1\f1 implies +\fBclient authorization\f1\&. See \fBInternal/Membership Authentication\f1 for more information. -.sp -Starting in MongoDB 4.2, keyfiles for internal membership -authentication use YAML format to allow for +.PP +Starting in MongoDB 4.2, \fBkeyfiles for internal membership +authentication\f1 use YAML format to allow for multiple keys in a keyfile. The YAML format accepts content of: -.INDENT 7.0 +.RS .IP \(bu 2 a single key string (same as in earlier versions), .IP \(bu 2 multiple key strings (each string must be enclosed in quotes), or .IP \(bu 2 sequence of key strings. -.UNINDENT -.sp +.RE +.PP The YAML format is compatible with the existing single\-key keyfiles that use the text file format. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-setParameter <options> +.RE +.PP +\fBmongos \-\-setParameter\f1 +.RS +.PP Specifies one of the MongoDB parameters described in -/reference/parameters\&. You can specify multiple \fBsetParameter\fP +\fBMongoDB Server Parameters\f1\&. You can specify multiple \fBsetParameter\f1 fields. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noscripting +.RE +.PP +\fBmongos \-\-noscripting\f1 +.RS +.PP Disables the scripting engine. When disabled, you cannot use operations that perform server\-side execution of JavaScript code, -such as the \fB$where\fP query operator, \fBmapReduce\fP -command, \fB$accumulator\fP, and \fB$function\fP\&. -.sp +such as the \fB$where\f1\f1 query operator, \fBmapReduce\f1\f1 +command, \fB$accumulator\f1\f1, and \fB$function\f1\f1\&. +.PP If you do not use these operations, disable server\-side scripting. -.sp -New in version 4.4. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nounixsocket -Disables listening on the UNIX domain socket. \fI\%\-\-nounixsocket\fP applies only +.RE +.PP +\fBmongos \-\-nounixsocket\f1 +.RS +.PP +Disables listening on the UNIX domain socket. \fB\-\-nounixsocket\f1\f1 applies only to Unix\-based systems. -.sp -The \fBmongos\fP process +.PP +The \fBmongos\f1\f1 process always listens on the UNIX socket unless one of the following is true: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-nounixsocket\fP is set +\fB\-\-nounixsocket\f1\f1 is set .IP \(bu 2 -\fBnet.bindIp\fP is not set +\fBnet.bindIp\f1\f1 is not set .IP \(bu 2 -\fBnet.bindIp\fP does not specify \fBlocalhost\fP or its associated IP address -.UNINDENT -.sp -\fBmongos\fP installed from official \&.deb and \&.rpm packages -have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by +\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address +.RE +.PP +\fBmongos\f1\f1 installed from official \fB\&.deb\f1 and \fB\&.rpm\f1 packages +have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by default. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-unixSocketPrefix <path> -\fIDefault\fP: /tmp -.sp -The path for the UNIX socket. \fI\%\-\-unixSocketPrefix\fP applies only +.RE +.PP +\fBmongos \-\-unixSocketPrefix\f1 +.RS +.PP +\fIDefault\f1: /tmp +.PP +The path for the UNIX socket. \fB\-\-unixSocketPrefix\f1\f1 applies only to Unix\-based systems. -.sp +.PP If this option has no value, the -\fBmongos\fP process creates a socket with \fB/tmp\fP as a prefix. MongoDB +\fBmongos\f1\f1 process creates a socket with \fB/tmp\f1 as a prefix. MongoDB creates and listens on a UNIX socket unless one of the following is true: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBnet.unixDomainSocket.enabled\fP is \fBfalse\fP +\fBnet.unixDomainSocket.enabled\f1\f1 is \fBfalse\f1 .IP \(bu 2 -\fI\%\-\-nounixsocket\fP is set +\fB\-\-nounixsocket\f1\f1 is set .IP \(bu 2 -\fBnet.bindIp\fP is not set +\fBnet.bindIp\f1\f1 is not set .IP \(bu 2 -\fBnet.bindIp\fP does not specify \fBlocalhost\fP or its associated IP address -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-filePermissions <path> -\fIDefault\fP: \fB0700\fP -.sp +\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address +.RE +.RE +.PP +\fBmongos \-\-filePermissions\f1 +.RS +.PP +\fIDefault\f1: \fB0700\f1 +.PP Sets the permission for the UNIX domain socket file. -.sp -\fI\%\-\-filePermissions\fP applies only to Unix\-based systems. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fork -Enables a daemon mode that runs the \fBmongos\fP process in the -background. By default \fBmongos\fP does not run as a daemon: -typically you will run \fBmongos\fP as a daemon, either by using -\fI\%\-\-fork\fP or by using a controlling process that handles the -daemonization process (e.g. as with \fBupstart\fP and \fBsystemd\fP). -.sp -The \fI\%\-\-fork\fP option is not supported on Windows. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-transitionToAuth -New in version 3.4: Allows the \fBmongos\fP to accept and create authenticated and -non\-authenticated connections to and from other \fBmongod\fP -and \fI\%mongos\fP instances in the deployment. Used for +.PP +\fB\-\-filePermissions\f1\f1 applies only to Unix\-based systems. +.RE +.PP +\fBmongos \-\-fork\f1 +.RS +.PP +Enables a \fBdaemon\f1 mode that runs the \fBmongos\f1\f1 process in the +background. By default \fBmongos\f1\f1 does not run as a daemon: +typically you will run \fBmongos\f1\f1 as a daemon, either by using +\fB\-\-fork\f1\f1 or by using a controlling process that handles the +daemonization process (e.g. as with \fBupstart\f1 and \fBsystemd\f1). +.PP +Using the \fB\-\-fork\f1\f1 option requires that you configure log +output for the \fBmongos\f1\f1 with one of the following: +.RS +.IP \(bu 2 +\fB\-\-logpath\f1\f1 +.IP \(bu 2 +\fB\-\-syslog\f1\f1 +.RE +.PP +The \fB\-\-fork\f1\f1 option is not supported on Windows. +.RE +.PP +\fBmongos \-\-transitionToAuth\f1 +.RS +.PP +Allows the \fBmongos\f1\f1 to accept and create authenticated and +non\-authenticated connections to and from other \fBmongod\f1\f1 +and \fBmongos\f1\f1 instances in the deployment. Used for performing rolling transition of replica sets or sharded clusters -from a no\-auth configuration to internal authentication\&. Requires specifying a internal -authentication mechanism such as -\fI\%\-\-keyFile\fP\&. - -.sp -For example, if using keyfiles for -internal authentication, the \fBmongos\fP creates -an authenticated connection with any \fBmongod\fP or \fI\%mongos\fP +from a no\-auth configuration to \fBinternal authentication\f1\&. Requires specifying a \fBinternal +authentication\f1 mechanism such as +\fB\-\-keyFile\f1\f1\&. +.PP +For example, if using \fBkeyfiles\f1 for +\fBinternal authentication\f1, the \fBmongos\f1\f1 creates +an authenticated connection with any \fBmongod\f1\f1 or \fBmongos\f1\f1 in the deployment using a matching keyfile. If the security mechanisms do -not match, the \fBmongos\fP utilizes a non\-authenticated connection instead. -.sp -A \fBmongos\fP running with \fI\%\-\-transitionToAuth\fP does not enforce user access -controls\&. Users may connect to your deployment without any +not match, the \fBmongos\f1\f1 utilizes a non\-authenticated connection instead. +.PP +A \fBmongos\f1\f1 running with \fB\-\-transitionToAuth\f1\f1 does not enforce \fBuser access +controls\f1\&. Users may connect to your deployment without any access control checks and perform read, write, and administrative operations. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -A \fBmongos\fP running with internal authentication and \fIwithout\fP \fI\%\-\-transitionToAuth\fP requires clients to connect -using user access controls\&. Update clients to -connect to the \fBmongos\fP using the appropriate user -prior to restarting \fBmongos\fP without \fI\%\-\-transitionToAuth\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-networkMessageCompressors <string> -\fIDefault\fP: snappy,zstd,zlib -.sp -New in version 3.4. - -.sp +.PP +A \fBmongos\f1\f1 running with \fBinternal authentication\f1 and \fIwithout\f1 \fB\-\-transitionToAuth\f1\f1 requires clients to connect +using \fBuser access controls\f1\&. Update clients to +connect to the \fBmongos\f1\f1 using the appropriate \fBuser\f1 +prior to restarting \fBmongos\f1\f1 without \fB\-\-transitionToAuth\f1\f1\&. +.RE +.PP +\fBmongos \-\-networkMessageCompressors\f1 +.RS +.PP +\fIDefault\f1: snappy,zstd,zlib +.PP Specifies the default compressor(s) to use for -communication between this \fBmongos\fP instance and: -.INDENT 7.0 +communication between this \fBmongos\f1\f1 instance and: +.RS .IP \(bu 2 other members of the sharded cluster .IP \(bu 2 -a \fBmongo\fP shell +\fBmongosh\f1\f1 .IP \(bu 2 -drivers that support the \fBOP_COMPRESSED\fP message format. -.UNINDENT -.sp +drivers that support the \fBOP_COMPRESSED\f1 message format. +.RE +.PP MongoDB supports the following compressors: -.INDENT 7.0 +.RS .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib (Available starting in MongoDB 3.6) +\fBzlib\f1 (Available starting in MongoDB 3.6) .IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.sp -\fBIn versions 3.6 and 4.0\fP, \fBmongod\fP and -\fI\%mongos\fP enable network compression by default with -\fBsnappy\fP as the compressor. -.sp -\fBStarting in version 4.2\fP, \fBmongod\fP and -\fI\%mongos\fP instances default to both \fBsnappy,zstd,zlib\fP +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.PP +\fBIn versions 3.6 and 4.0\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1 enable network compression by default with +\fBsnappy\f1 as the compressor. +.PP +\fBStarting in version 4.2\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1 instances default to both \fBsnappy,zstd,zlib\f1 compressors, in that order. -.sp -To disable network compression, set the value to \fBdisabled\fP\&. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP +To disable network compression, set the value to \fBdisabled\f1\&. +.PP Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed. -.UNINDENT -.UNINDENT -.sp +.PP If you specify multiple compressors, then the order in which you list the compressors matter as well as the communication initiator. For -example, if a \fBmongo\fP shell specifies the following network -compressors \fBzlib,snappy\fP and the \fBmongod\fP specifies -\fBsnappy,zlib\fP, messages between \fBmongo\fP shell and -\fBmongod\fP uses \fBzlib\fP\&. -.sp +example, if \fBmongosh\f1\f1 specifies the following network +compressors \fBzlib,snappy\f1 and the \fBmongod\f1\f1 specifies +\fBsnappy,zlib\f1, messages between \fBmongosh\f1\f1 and +\fBmongod\f1\f1 uses \fBzlib\f1\&. +.PP If the parties do not share at least one common compressor, messages -between the parties are uncompressed. For example, if a -\fBmongo\fP shell specifies the network compressor -\fBzlib\fP and \fBmongod\fP specifies \fBsnappy\fP, messages -between \fBmongo\fP shell and \fBmongod\fP are not compressed. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-serviceExecutor <string> -\fIDefault\fP: synchronous -.sp -New in version 3.6. - -.sp -Determines the threading and execution model \fBmongos\fP uses to -execute client requests. The \fB\-\-serviceExecutor\fP option accepts one -of the following values: -.TS -center; -|l|l|. -_ -T{ -Value -T} T{ -Description -T} -_ -T{ -\fBsynchronous\fP -T} T{ -The \fBmongos\fP uses synchronous networking and manages its -networking thread pool on a per connection basis. Previous -versions of MongoDB managed threads in this way. -T} -_ -T{ -\fBadaptive\fP -T} T{ -The \fBmongos\fP uses the new experimental asynchronous -networking mode with an adaptive thread pool which manages -threads on a per request basis. This mode should have more -consistent performance and use less resources when there are -more inactive connections than database requests. -T} -_ -.TE -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-timeZoneInfo <path> +between the parties are uncompressed. For example, if +\fBmongosh\f1\f1 specifies the network compressor +\fBzlib\f1 and \fBmongod\f1\f1 specifies \fBsnappy\f1, messages +between \fBmongosh\f1\f1 and \fBmongod\f1\f1 are not +compressed. +.RE +.PP +\fBmongos \-\-timeZoneInfo\f1 +.RS +.PP The full path from which to load the time zone database. If this option is not provided, then MongoDB will use its built\-in time zone database. -.sp -The configuration file included with Linux and macOS packages sets the time -zone database path to \fB/usr/share/zoneinfo\fP by default. -.sp -The built\-in time zone database is a copy of the \fI\%Olson/IANA time zone -database\fP\&. It is updated along with MongoDB -releases, but the release cycle of the time zone database differs from the -release cycle of MongoDB. A copy of the most recent release of the time zone -database can be downloaded from -\fI\%https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -wget https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip -unzip timezonedb\-latest.zip -mongos \-\-timeZoneInfo timezonedb\-2017b/ -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-outputConfig -New in version 4.2. - -.sp -Outputs the \fBmongos\fP instance\(aqs configuration options, formatted -in YAML, to \fBstdout\fP and exits the \fBmongos\fP instance. For -configuration options that uses externally\-sourced\-values, -\fI\%\-\-outputConfig\fP returns the resolved value for those options. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP +The configuration file included with Linux and macOS packages sets the +time zone database path to \fB/usr/share/zoneinfo\f1 by default. +.PP +The built\-in time zone database is a copy of the Olson/IANA time zone +database (https://www.iana.org/time\-zones)\&. It is updated along with +MongoDB releases, but the time zone database release cycle +differs from the MongoDB release cycle. The most recent release of +the time zone database is available on our download site (https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip)\&. +.PP +.EX + wget https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip + unzip timezonedb\-latest.zip + mongos \-\-timeZoneInfo timezonedb\-2017b/ +.EE +.PP +MongoDB uses the third party timelib (https://github.com/derickr/timelib) library to provide accurate +conversions between timezones. Due to a recent update, \fBtimelib\f1 +could create inaccurate time zone conversions in older versions of +MongoDB. +.PP +To explicitly link to the time zone database in versions of MongoDB +prior to 5.0, 4.4.7, 4.2.14, and 4.0.25, download the time zone +database (https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip)\&. +and use the \fBtimeZoneInfo\f1\f1 parameter. +.RE +.PP +\fBmongos \-\-outputConfig\f1 +.RS +.PP +Outputs the \fBmongos\f1\f1 instance\(aqs configuration options, formatted +in YAML, to \fBstdout\f1 and exits the \fBmongos\f1\f1 instance. For +configuration options that uses \fBExternally Sourced Configuration File Values\f1, +\fB\-\-outputConfig\f1\f1 returns the resolved value for those options. +.PP This may include any configured passwords or secrets previously obfuscated through the external source. -.UNINDENT -.UNINDENT -.sp +.PP For usage examples, see: -.INDENT 7.0 -.IP \(bu 2 -expansion\-directive\-output -.IP \(bu 2 -/tutorial/convert\-command\-line\-options\-to\-yaml -.UNINDENT -.UNINDENT -.SS Sharded Cluster Options -.INDENT 0.0 -.TP -.B \-\-configdb <replicasetName>/<config1>,<config2>... -Changed in version 3.2. - -.sp -Specifies the configuration servers for the -sharded cluster\&. -.sp +.RS +.IP \(bu 2 +\fBOutput the Configuration File with Resolved Expansion Directive Values\f1 +.IP \(bu 2 +\fBConvert Command\-Line Options to YAML\f1 +.RE +.RE +.SS SHARDED CLUSTER OPTIONS +.PP +\fBmongos \-\-configdb\f1 +.RS +.PP +Specifies the \fBconfiguration servers\f1 for the +\fBsharded cluster\f1\&. +.PP Starting in MongoDB 3.2, config servers for sharded clusters can be -deployed as a replica set\&. The -replica set config servers must run the WiredTiger storage engine\&. MongoDB 3.2 deprecates the use of three mirrored -\fBmongod\fP instances for config servers. -.sp +deployed as a \fBreplica set\f1\&. The +replica set config servers must run the \fBWiredTiger storage engine\f1\&. MongoDB 3.2 deprecates the use of three mirrored +\fBmongod\f1\f1 instances for config servers. +.PP Specify the config server replica set name and the hostname and port of at least one of the members of the config server replica set. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -sharding: - configDB: <configReplSetName>/cfg1.example.net:27019, cfg2.example.net:27019,... -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fI\%mongos\fP instances for the sharded cluster must specify +.PP +.EX + sharding: + configDB: <configReplSetName>/cfg1.example.net:27019, cfg2.example.net:27019,... +.EE +.PP +The \fBmongos\f1\f1 instances for the sharded cluster must specify the same config server replica set name but can specify hostname and port of different members of the replica set. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-localThreshold -\fIDefault\fP: 15 -.sp -Specifies the ping time, in milliseconds, that \fI\%mongos\fP uses +.RE +.PP +\fBmongos \-\-localThreshold\f1 +.RS +.PP +\fIDefault\f1: 15 +.PP +Specifies the ping time, in milliseconds, that \fBmongos\f1\f1 uses to determine which secondary replica set members to pass read -operations from clients. The default value of \fB15\fP corresponds to -the default value in all of the client \fI\%drivers\fP\&. -.sp -When \fI\%mongos\fP receives a request that permits reads to -secondary members, the \fI\%mongos\fP will: -.INDENT 7.0 +operations from clients. The default value of \fB15\f1 corresponds to +the default value in all of the client drivers (https://docs.mongodb.com/drivers/)\&. +.PP +When \fBmongos\f1\f1 receives a request that permits reads to +\fBsecondary\f1 members, the \fBmongos\f1\f1 will: +.RS .IP \(bu 2 Find the member of the set with the lowest ping time. .IP \(bu 2 Construct a list of replica set members that is within a ping time of 15 milliseconds of the nearest suitable member of the set. -.sp -If you specify a value for the \fI\%\-\-localThreshold\fP option, \fI\%mongos\fP will +.IP +If you specify a value for the \fB\-\-localThreshold\f1\f1 option, \fBmongos\f1\f1 will construct the list of replica members that are within the latency allowed by this value. .IP \(bu 2 Select a member to read from at random from this list. -.UNINDENT -.sp -The ping time used for a member compared by the \fI\%\-\-localThreshold\fP setting is a +.RE +.PP +The ping time used for a member compared by the \fB\-\-localThreshold\f1\f1 setting is a moving average of recent ping times, calculated at most every 10 seconds. As a result, some queries may reach members above the threshold -until the \fI\%mongos\fP recalculates the average. -.sp -See the replica\-set\-read\-preference\-behavior\-member\-selection -section of the read preference +until the \fBmongos\f1\f1 recalculates the average. +.PP +See the \fBRead Preference for Replica Sets\f1 +section of the \fBread preference\f1 documentation for more information. -.UNINDENT -.SS TLS Options -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full -documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsMode <mode> -New in version 4.2. - -.sp +.RE +.SS TLS OPTIONS +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs +support. +.PP +\fBmongos \-\-tlsMode\f1 +.RS +.PP Enables TLS used for all network connections. The -argument to the \fI\%\-\-tlsMode\fP option can be one of the following: -.TS -center; -|l|l|. -_ -T{ +argument to the \fB\-\-tlsMode\f1\f1 option can be one of the following: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBdisabled\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBdisabled\f1 +.IP \(bu 4 The server does not use TLS. -T} -_ -T{ -\fBallowTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBallowTLS\f1 +.IP \(bu 4 Connections between servers do not use TLS. For incoming connections, the server accepts both TLS and non\-TLS. -T} -_ -T{ -\fBpreferTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBpreferTLS\f1 +.IP \(bu 4 Connections between servers use TLS. For incoming connections, the server accepts both TLS and non\-TLS. -T} -_ -T{ -\fBrequireTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrequireTLS\f1 +.IP \(bu 4 The server uses and accepts only TLS encrypted connections. -T} -_ -.TE -.sp -If \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP is not +.RE +.RE +.PP +If \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS\-enabled server. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP\&. -.sp +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFile <filename> -New in version 4.2. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsCertificateKeyFile\f1 +.RS +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of specifying a PEM file. See -\fI\%\-\-tlsCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS certificate +\fB\-\-tlsCertificateSelector\f1\f1\&. +.PP +Specifies the \&.pem file that contains both the TLS certificate and key. -.INDENT 7.0 +.RS .IP \(bu 2 -On Linux/BSD, you must specify \fI\%\-\-tlsCertificateKeyFile\fP when TLS is enabled. +On Linux/BSD, you must specify \fB\-\-tlsCertificateKeyFile\f1\f1 when TLS is enabled. .IP \(bu 2 -On Windows or macOS, you must specify either \fI\%\-\-tlsCertificateKeyFile\fP or -\fI\%\-\-tlsCertificateSelector\fP when TLS is enabled. -.UNINDENT -.sp +On Windows or macOS, you must specify either \fB\-\-tlsCertificateKeyFile\f1\f1 or +\fB\-\-tlsCertificateSelector\f1\f1 when TLS is enabled. +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFilePassword <value> -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsCertificateKeyFilePassword\f1 +.RS +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-tlsCertificateKeyFile\fP). Use the \fI\%\-\-tlsCertificateKeyFilePassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongos\fP will +\fB\-\-tlsCertificateKeyFile\f1\f1). Use the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongos\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the PEM file is encrypted and -you do not specify the \fI\%\-\-tlsCertificateKeyFilePassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS or Windows, if the private key in the PEM file is -encrypted, you must explicitly specify the \fI\%\-\-tlsCertificateKeyFilePassword\fP option. +encrypted, you must explicitly specify the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option. Alternatively, you can use a certificate from the secure system -store (see \fI\%\-\-tlsCertificateSelector\fP) instead of a PEM file or use an +store (see \fB\-\-tlsCertificateSelector\f1\f1) instead of a PEM file or use an unencrypted PEM file. -.UNINDENT -.sp +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clusterAuthMode <option> -\fIDefault\fP: keyFile -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-clusterAuthMode\f1 +.RS +.PP +\fIDefault\f1: keyFile +.PP The authentication mode used for cluster authentication. If you use -internal x.509 authentication, +\fBinternal x.509 authentication\f1, specify so here. This option can have one of the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBkeyFile\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBkeyFile\f1 +.IP \(bu 4 Use a keyfile for authentication. Accept only keyfiles. -T} -_ -T{ -\fBsendKeyFile\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsendKeyFile\f1 +.IP \(bu 4 For rolling upgrade purposes. Send a keyfile for authentication but can accept both keyfiles and x.509 certificates. -T} -_ -T{ -\fBsendX509\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsendX509\f1 +.IP \(bu 4 For rolling upgrade purposes. Send the x.509 certificate for authentication but can accept both keyfiles and x.509 certificates. -T} -_ -T{ -\fBx509\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBx509\f1 +.IP \(bu 4 Recommended. Send the x.509 certificate for authentication and accept only x.509 certificates. -T} -_ -.TE -.sp -If \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP is not +.RE +.RE +.PP +If \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS\-enabled server. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP\&. -.sp +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterFile <filename> -New in version 4.2. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsClusterFile\f1 +.RS +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM -file. See \fI\%\-\-tlsClusterCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.sp -Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key -file for membership authentication +file. See \fB\-\-tlsClusterCertificateSelector\f1\f1\&. +.PP +Specifies the \&.pem file that contains the x.509 certificate\-key +file for \fBmembership authentication\f1 for the cluster or replica set. -.sp -If \fI\%\-\-tlsClusterFile\fP does not specify the \fB\&.pem\fP file for internal cluster +.PP +If \fB\-\-tlsClusterFile\f1\f1 does not specify the \fB\&.pem\f1 file for internal cluster authentication or the alternative -\fI\%\-\-tlsClusterCertificateSelector\fP, the cluster uses the -\fB\&.pem\fP file specified in the \fI\%\-\-tlsCertificateKeyFile\fP option or -the certificate returned by the \fI\%\-\-tlsCertificateSelector\fP\&. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP\&. -.sp -Changed in version 4.4: \fBmongod\fP / \fI\%mongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +\fB\-\-tlsClusterCertificateSelector\f1\f1, the cluster uses the +\fB\&.pem\f1 file specified in the \fB\-\-tlsCertificateKeyFile\f1\f1 option or +the certificate returned by the \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.sp +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterPassword <value> -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsClusterPassword\f1 +.RS +.PP Specifies the password to de\-crypt the x.509 certificate\-key file -specified with \fB\-\-tlsClusterFile\fP\&. Use the \fI\%\-\-tlsClusterPassword\fP option only -if the certificate\-key file is encrypted. In all cases, the \fBmongos\fP +specified with \fB\-\-tlsClusterFile\f1\&. Use the \fB\-\-tlsClusterPassword\f1\f1 option only +if the certificate\-key file is encrypted. In all cases, the \fBmongos\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the x.509 file is encrypted and -you do not specify the \fI\%\-\-tlsClusterPassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-tlsClusterPassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS or Windows, if the private key in the x.509 file is -encrypted, you must explicitly specify the \fI\%\-\-tlsClusterPassword\fP option. +encrypted, you must explicitly specify the \fB\-\-tlsClusterPassword\f1\f1 option. Alternatively, you can either use a certificate from the secure -system store (see \fI\%\-\-tlsClusterCertificateSelector\fP) instead of a cluster PEM file or +system store (see \fB\-\-tlsClusterCertificateSelector\f1\f1) instead of a cluster PEM file or use an unencrypted PEM file. -.UNINDENT -.sp +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCAFile <filename> -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate chain +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsCAFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the -\fB\&.pem\fP file using relative or absolute paths. -.sp +\&.pem file using relative or absolute paths. +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key file. See -\fI\%\-\-tlsCertificateSelector\fP\&. When using the secure store, you -do not need to, but can, also specify the \fI\%\-\-tlsCAFile\fP\&. -.sp +\fB\-\-tlsCertificateSelector\f1\f1\&. When using the secure store, you +do not need to, but can, also specify the \fB\-\-tlsCAFile\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterCAFile <filename> -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate chain +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsClusterCAFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate presented by a client establishing a connection. Specify the file -name of the \fB\&.pem\fP file using relative or absolute paths. -.sp -If \fI\%\-\-tlsClusterCAFile\fP does not specify the \fB\&.pem\fP file for validating the +name of the \&.pem file using relative or absolute paths. +.PP +If \fB\-\-tlsClusterCAFile\f1\f1 does not specify the \&.pem file for validating the certificate from a client establishing a connection, the cluster uses -the \fB\&.pem\fP file specified in the \fI\%\-\-tlsCAFile\fP option. -.sp -\fI\%\-\-tlsClusterCAFile\fP lets you use separate Certificate Authorities to verify the +the \&.pem file specified in the \fB\-\-tlsCAFile\f1\f1 option. +.PP +\fB\-\-tlsClusterCAFile\f1\f1 lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake. -.sp +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key file. See -\fI\%\-\-tlsClusterCertificateSelector\fP\&. When using the secure store, you -do not need to, but can, also specify the \fI\%\-\-tlsClusterCAFile\fP\&. -.sp -Requires that \fI\%\-\-tlsCAFile\fP is set. -.sp +\fB\-\-tlsClusterCertificateSelector\f1\f1\&. When using the secure store, you +do not need to, but can, also specify the \fB\-\-tlsClusterCAFile\f1\f1\&. +.PP +Requires that \fB\-\-tlsCAFile\f1\f1 is set. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateSelector <parameter>=<value> -New in version 4.2: Available on Windows and macOS as an alternative to \fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp -The \fI\%\-\-tlsCertificateKeyFile\fP and \fI\%\-\-tlsCertificateSelector\fP options are mutually exclusive. You can only +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to \fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP +The \fB\-\-tlsCertificateKeyFile\f1\f1 and \fB\-\-tlsCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store. -.sp -\fI\%\-\-tlsCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-tlsCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsClusterCertificateSelector <parameter>=<value> -New in version 4.2: Available on Windows and macOS as an alternative to -\fI\%\-\-tlsClusterFile\fP\&. -.sp -\fI\%\-\-tlsClusterFile\fP and \fI\%\-\-tlsClusterCertificateSelector\fP options are mutually exclusive. You can only +.PP +You cannot use the \fBrotateCertificates\f1\f1 command or the +\fBdb.rotateCertificates()\f1\f1 shell method when using +\fBnet.tls.certificateSelector\f1\f1 or +\fB\-\-tlsCertificateSelector\f1\f1 +set to \fBthumbprint\f1 +.RE +.PP +\fBmongos \-\-tlsClusterCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to +\fB\-\-tlsClusterFile\f1\f1\&. +.PP +\fB\-\-tlsClusterFile\f1\f1 and \fB\-\-tlsClusterCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store to use for internal authentication. -.sp -\fI\%\-\-tlsClusterCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-tlsClusterCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp -Changed in version 4.4: \fBmongod\fP / \fI\%mongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCRLFile <filename> -New in version 4.2: For MongoDB 4.0 and earlier, see \fI\%\-\-sslCRLFile\fP\&. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +.RE +.PP +\fBmongos \-\-tlsCRLFile\f1 +.RS +.PP +For MongoDB 4.0 and earlier, see \fB\-\-sslCRLFile\f1\f1\&. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +.RS .IP \(bu 2 Starting in MongoDB 4.0, you cannot specify a CRL file on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (Online Certificate Status Protocol) to validate the revocation status of certificates. See -\fI\%\-\-sslCertificateSelector\fP in MongoDB 4.0 and -\fI\%\-\-tlsCertificateSelector\fP in MongoDB 4.2+ to use the +\fB\-\-sslCertificateSelector\f1\f1 in MongoDB 4.0 and +\fB\-\-tlsCertificateSelector\f1\f1 in MongoDB 4.2+ to use the system SSL certificate store. .IP \(bu 2 Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowConnectionsWithoutCertificates -New in version 4.2. - -.sp -For clients that do not present certificates, \fBmongos\fP bypasses +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsAllowConnectionsWithoutCertificates\f1 +.RS +.PP +For clients that do not present certificates, \fBmongos\f1\f1 bypasses TLS/SSL certificate validation when establishing the connection. -.sp -For clients that present a certificate, however, \fBmongos\fP performs +.PP +For clients that present a certificate, however, \fBmongos\f1\f1 performs certificate validation using the root certificate chain specified by -\fB\-\-tlsCAFile\fP and reject clients with invalid certificates. -.sp -Use the \fI\%\-\-tlsAllowConnectionsWithoutCertificates\fP option if you have a mixed deployment that includes -clients that do not or cannot present certificates to the \fBmongos\fP\&. -.sp +\fB\-\-tlsCAFile\f1 and reject clients with invalid certificates. +.PP +Use the \fB\-\-tlsAllowConnectionsWithoutCertificates\f1\f1 option if you have a mixed deployment that includes +clients that do not or cannot present certificates to the \fBmongos\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidCertificates -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsAllowInvalidCertificates\f1 +.RS +.PP Bypasses the validation checks for TLS certificates on other servers in the cluster and allows the use of invalid certificates to connect. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP If you specify -\fB\-\-tlsAllowInvalidCertificates\fP or \fBtls.allowInvalidCertificates: -true\fP when using x.509 authentication, an invalid certificate is +\fB\-\-tlsAllowInvalidCertificates\f1 or \fBtls.allowInvalidCertificates: +true\f1 when using x.509 authentication, an invalid certificate is only sufficient to establish a TLS connection but is -\fIinsufficient\fP for authentication. -.UNINDENT -.UNINDENT -.sp +\fIinsufficient\f1 for authentication. +.PP When using -the \fI\%\-\-tlsAllowInvalidCertificates\fP setting, MongoDB +the \fB\-\-tlsAllowInvalidCertificates\f1\f1 setting, MongoDB logs a warning regarding the use of the invalid certificate. -.sp +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidHostnames -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsAllowInvalidHostnames\f1 +.RS +.PP Disables the validation of the hostnames in TLS certificates, when connecting to other members of the replica set or sharded cluster -for inter\-process authentication. This allows \fBmongos\fP to connect +for inter\-process authentication. This allows \fBmongos\f1\f1 to connect to other members if the hostnames in their certificates do not match their configured hostname. -.sp +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsDisabledProtocols <protocol(s)> -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-tlsDisabledProtocols\f1 +.RS +.PP Prevents a MongoDB server running with TLS from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols. -.sp -\fI\%\-\-tlsDisabledProtocols\fP recognizes the following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, -\fBTLS1_2\fP, and starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\fP\&. -.INDENT 7.0 +.PP +\fB\-\-tlsDisabledProtocols\f1\f1 recognizes the following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, +\fBTLS1_2\f1, and starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must disable at least one of the other -two, for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must disable at least one of the other +two, for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 Specifying an unrecognized protocol will prevent the server from starting. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, -specify \fBnone\fP to \fI\%\-\-tlsDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.sp +specify \fBnone\f1 to \fB\-\-tlsDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.PP Members of replica sets and sharded clusters must speak at least one protocol in common. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -ssl\-disallow\-protocols -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsFIPSMode -New in version 4.2. - -.sp -Directs the \fBmongos\fP to use the FIPS mode of the TLS +.PP +\fBDisallow Protocols\f1 +.RE +.PP +\fBmongos \-\-tlsFIPSMode\f1 +.RS +.PP +Directs the \fBmongos\f1\f1 to use the FIPS mode of the TLS library. Your system must have a FIPS -compliant library to use the \fI\%\-\-tlsFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +compliant library to use the \fB\-\-tlsFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.SS SSL Options (Deprecated) -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.SS SSL OPTIONS (DEPRECATED) +.PP All SSL options are deprecated since 4.2. Use the TLS counterparts instead, as they have identical functionality to the SSL options. The SSL protocol is deprecated and MongoDB supports TLS 1.0 and later. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslOnNormalPorts -Deprecated since version 2.6: Use \fI\%\-\-tlsMode requireTLS\fP instead. - -.sp -Enables TLS/SSL for \fBmongos\fP\&. -.sp -With \fI\%\-\-sslOnNormalPorts\fP, a \fBmongos\fP requires TLS/SSL encryption for all +.PP +\fBmongos \-\-sslOnNormalPorts\f1 +.RS +.PP +Use \fB\-\-tlsMode requireTLS\f1\f1 instead. +.PP +Enables TLS/SSL for \fBmongos\f1\f1\&. +.PP +With \fB\-\-sslOnNormalPorts\f1\f1, a \fBmongos\f1\f1 requires TLS/SSL encryption for all connections on the default MongoDB port, or the port specified by -\fI\%\-\-port\fP\&. By default, \fI\%\-\-sslOnNormalPorts\fP is +\fB\-\-port\f1\f1\&. By default, \fB\-\-sslOnNormalPorts\f1\f1 is disabled. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslMode <mode> -Deprecated since version 4.2: Use \fI\%\-\-tlsMode\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslMode\f1 +.RS +.PP +Use \fB\-\-tlsMode\f1\f1 instead. +.PP Enables TLS/SSL or mixed TLS/SSL used for all network connections. The -argument to the \fI\%\-\-sslMode\fP option can be one of the following: -.TS -center; -|l|l|. -_ -T{ +argument to the \fB\-\-sslMode\f1\f1 option can be one of the following: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBdisabled\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBdisabled\f1 +.IP \(bu 4 The server does not use TLS/SSL. -T} -_ -T{ -\fBallowSSL\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBallowSSL\f1 +.IP \(bu 4 Connections between servers do not use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non\-TLS/non\-SSL. -T} -_ -T{ -\fBpreferSSL\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBpreferSSL\f1 +.IP \(bu 4 Connections between servers use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non\-TLS/non\-SSL. -T} -_ -T{ -\fBrequireSSL\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrequireSSL\f1 +.IP \(bu 4 The server uses and accepts only TLS/SSL encrypted connections. -T} -_ -.TE -.sp -Starting in version 3.4, if \fB\-\-tlsCAFile\fP/\fBnet.tls.CAFile\fP (or -their aliases \fB\-\-sslCAFile\fP/\fBnet.ssl.CAFile\fP) is not specified +.RE +.RE +.PP +Starting in version 3.4, if \fB\-\-tlsCAFile\f1/\fBnet.tls.CAFile\f1 (or +their aliases \fB\-\-sslCAFile\f1/\fBnet.ssl.CAFile\f1) is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsPEMKeyFile\fP instead. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslPEMKeyFile\f1 +.RS +.PP +Use \fB\-\-tlsPEMKeyFile\f1\f1 +instead. +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM file. See -\fI\%\-\-sslCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS/SSL certificate +\fB\-\-sslCertificateSelector\f1\f1\&. +.PP +Specifies the \&.pem file that contains both the TLS/SSL certificate and key. -.INDENT 7.0 +.RS .IP \(bu 2 -On Linux/BSD, you must specify \fI\%\-\-sslPEMKeyFile\fP when TLS/SSL is enabled. +On Linux/BSD, you must specify \fB\-\-sslPEMKeyFile\f1\f1 when TLS/SSL is enabled. .IP \(bu 2 -On Windows or macOS, you must specify either \fI\%\-\-sslPEMKeyFile\fP or -\fI\%\-\-sslCertificateSelector\fP when TLS/SSL is enabled. -.UNINDENT -.sp +On Windows or macOS, you must specify either \fB\-\-sslPEMKeyFile\f1\f1 or +\fB\-\-sslCertificateSelector\f1\f1 when TLS/SSL is enabled. +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyPassword <value> -Deprecated since version 4.2: Use \fI\%\-\-tlsPEMKeyPassword\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslPEMKeyPassword\f1 +.RS +.PP +Use \fB\-\-tlsPEMKeyPassword\f1\f1 instead. +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongos\fP will +\fB\-\-sslPEMKeyFile\f1\f1). Use the \fB\-\-sslPEMKeyPassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongos\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the PEM file is encrypted and -you do not specify the \fI\%\-\-sslPEMKeyPassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-sslPEMKeyPassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS or Windows, if the private key in the PEM file is -encrypted, you must explicitly specify the \fI\%\-\-sslPEMKeyPassword\fP option. +encrypted, you must explicitly specify the \fB\-\-sslPEMKeyPassword\f1\f1 option. Alternatively, you can use a certificate from the secure system -store (see \fI\%\-\-sslCertificateSelector\fP) instead of a PEM key file or use an +store (see \fB\-\-sslCertificateSelector\f1\f1) instead of a PEM key file or use an unencrypted PEM file. -.UNINDENT -.sp +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterFile\fP instead. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslClusterFile\f1 +.RS +.PP +Use \fB\-\-tlsClusterFile\f1\f1 instead. +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key -file. See \fI\%\-\-sslClusterCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.sp -Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key -file for membership authentication +file. See \fB\-\-sslClusterCertificateSelector\f1\f1\&. +.PP +Specifies the \&.pem file that contains the x.509 certificate\-key +file for \fBmembership authentication\f1 for the cluster or replica set. -.sp -If \fI\%\-\-sslClusterFile\fP does not specify the \fB\&.pem\fP file for internal cluster +.PP +If \fB\-\-sslClusterFile\f1\f1 does not specify the \fB\&.pem\f1 file for internal cluster authentication or the alternative -\fI\%\-\-sslClusterCertificateSelector\fP, the cluster uses the -\fB\&.pem\fP file specified in the \fI\%\-\-sslPEMKeyFile\fP option or -the certificate returned by the \fI\%\-\-sslCertificateSelector\fP\&. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +\fB\-\-sslClusterCertificateSelector\f1\f1, the cluster uses the +\fB\&.pem\f1 file specified in the \fB\-\-sslPEMKeyFile\f1\f1 option or +the certificate returned by the \fB\-\-sslCertificateSelector\f1\f1\&. +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterPassword <value> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterPassword\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslClusterPassword\f1 +.RS +.PP +Use \fB\-\-tlsClusterPassword\f1\f1 instead. +.PP Specifies the password to de\-crypt the x.509 certificate\-key file -specified with \fB\-\-sslClusterFile\fP\&. Use the \fI\%\-\-sslClusterPassword\fP option only -if the certificate\-key file is encrypted. In all cases, the \fBmongos\fP +specified with \fB\-\-sslClusterFile\f1\&. Use the \fB\-\-sslClusterPassword\f1\f1 option only +if the certificate\-key file is encrypted. In all cases, the \fBmongos\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the x.509 file is encrypted and -you do not specify the \fI\%\-\-sslClusterPassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-sslClusterPassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS or Windows, if the private key in the x.509 file is -encrypted, you must explicitly specify the \fI\%\-\-sslClusterPassword\fP option. +encrypted, you must explicitly specify the \fB\-\-sslClusterPassword\f1\f1 option. Alternatively, you can either use a certificate from the secure -system store (see \fI\%\-\-sslClusterCertificateSelector\fP) instead of a cluster PEM file or +system store (see \fB\-\-sslClusterCertificateSelector\f1\f1) instead of a cluster PEM file or use an unencrypted PEM file. -.UNINDENT -.sp +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCAFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCAFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate chain +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslCAFile\f1 +.RS +.PP +Use \fB\-\-tlsCAFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the -\fB\&.pem\fP file using relative or absolute paths. -.sp +\&.pem file using relative or absolute paths. +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key file. See -\fI\%\-\-sslCertificateSelector\fP\&. When using the secure store, you -do not need to, but can, also specify the \fI\%\-\-sslCAFile\fP\&. -.sp +\fB\-\-sslCertificateSelector\f1\f1\&. When using the secure store, you +do not need to, but can, also specify the \fB\-\-sslCAFile\f1\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterCAFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterCAFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate chain +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslClusterCAFile\f1 +.RS +.PP +Use \fB\-\-tlsClusterCAFile\f1\f1 +instead. +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate presented by a client establishing a connection. Specify the file -name of the \fB\&.pem\fP file using relative or absolute paths. -.sp -If \fI\%\-\-sslClusterCAFile\fP does not specify the \fB\&.pem\fP file for validating the +name of the \&.pem file using relative or absolute paths. +.PP +If \fB\-\-sslClusterCAFile\f1\f1 does not specify the \&.pem file for validating the certificate from a client establishing a connection, the cluster uses -the \fB\&.pem\fP file specified in the \fI\%\-\-sslCAFile\fP option. -.sp -\fI\%\-\-sslClusterCAFile\fP lets you use separate Certificate Authorities to verify the +the \&.pem file specified in the \fB\-\-sslCAFile\f1\f1 option. +.PP +\fB\-\-sslClusterCAFile\f1\f1 lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake. -.sp +.PP Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system\(aqs secure store instead of a PEM key file. See -\fI\%\-\-sslClusterCertificateSelector\fP\&. When using the secure store, you -do not need to, but can, also specify the \fI\%\-\-sslClusterCAFile\fP\&. -.sp -Requires that \fI\%\-\-sslCAFile\fP is set. -.sp +\fB\-\-sslClusterCertificateSelector\f1\f1\&. When using the secure store, you +do not need to, but can, also specify the \fB\-\-sslClusterCAFile\f1\f1\&. +.PP +Requires that \fB\-\-sslCAFile\f1\f1 is set. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCertificateSelector <parameter>=<value> -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateSelector\fP instead. - -.sp -New in version 4.0: Available on Windows and macOS as an alternative to \fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp -\fI\%\-\-tlsCertificateKeyFile\fP and \fI\%\-\-sslCertificateSelector\fP options are mutually exclusive. You can only +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslCertificateSelector\f1 +.RS +.PP +Use \fB\-\-tlsCertificateSelector\f1\f1 instead. +.PP +Available on Windows and macOS as an alternative to \fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP +\fB\-\-tlsCertificateKeyFile\f1\f1 and \fB\-\-sslCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store. -.sp -\fI\%\-\-sslCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-sslCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslClusterCertificateSelector <parameter>=<value> -Deprecated since version 4.2: Use \fI\%\-\-tlsClusterCertificateSelector\fP instead. - -.sp -New in version 4.0: Available on Windows and macOS as an alternative to -\fI\%\-\-sslClusterFile\fP\&. -.sp -\fI\%\-\-sslClusterFile\fP and \fI\%\-\-sslClusterCertificateSelector\fP options are mutually exclusive. You can only +.RE +.PP +\fBmongos \-\-sslClusterCertificateSelector\f1 +.RS +.PP +Use \fB\-\-tlsClusterCertificateSelector\f1\f1 instead. +.PP +Available on Windows and macOS as an alternative to +\fB\-\-sslClusterFile\f1\f1\&. +.PP +\fB\-\-sslClusterFile\f1\f1 and \fB\-\-sslClusterCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store to use for internal authentication. -.sp -\fI\%\-\-sslClusterCertificateSelector\fP accepts an argument of the format \fB<property>=<value>\fP +.PP +\fB\-\-sslClusterCertificateSelector\f1\f1 accepts an argument of the format \fB<property>=<value>\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCRLFile <filename> -Deprecated since version 4.2: Use \fI\%\-\-tlsCRLFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.RE +.PP +\fBmongos \-\-sslCRLFile\f1 +.RS +.PP +Use \fB\-\-tlsCRLFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +.RS .IP \(bu 2 Starting in MongoDB 4.0, you cannot specify a CRL file on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (Online Certificate Status Protocol) to validate the revocation status of certificates. See -\fI\%\-\-sslCertificateSelector\fP in MongoDB 4.0 and -\fI\%\-\-tlsCertificateSelector\fP in MongoDB 4.2+ to use the +\fB\-\-sslCertificateSelector\f1\f1 in MongoDB 4.0 and +\fB\-\-tlsCertificateSelector\f1\f1 in MongoDB 4.2+ to use the system SSL certificate store. .IP \(bu 2 Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +.RE +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowConnectionsWithoutCertificates -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowConnectionsWithoutCertificates\fP instead. - -.sp -For clients that do not present certificates, \fBmongos\fP bypasses +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslAllowConnectionsWithoutCertificates\f1 +.RS +.PP +Use \fB\-\-tlsAllowConnectionsWithoutCertificates\f1\f1 instead. +.PP +For clients that do not present certificates, \fBmongos\f1\f1 bypasses TLS/SSL certificate validation when establishing the connection. -.sp -For clients that present a certificate, however, \fBmongos\fP performs +.PP +For clients that present a certificate, however, \fBmongos\f1\f1 performs certificate validation using the root certificate chain specified by -\fB\-\-sslCAFile\fP and reject clients with invalid certificates. -.sp -Use the \fI\%\-\-sslAllowConnectionsWithoutCertificates\fP option if you have a mixed deployment that includes -clients that do not or cannot present certificates to the \fBmongos\fP\&. -.sp +\fB\-\-sslCAFile\f1 and reject clients with invalid certificates. +.PP +Use the \fB\-\-sslAllowConnectionsWithoutCertificates\f1\f1 option if you have a mixed deployment that includes +clients that do not or cannot present certificates to the \fBmongos\f1\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidCertificates -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidCertificates\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslAllowInvalidCertificates\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidCertificates\f1\f1 instead. +.PP Bypasses the validation checks for TLS/SSL certificates on other servers in the cluster and allows the use of invalid certificates to connect. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.0, if you specify -\fB\-\-sslAllowInvalidCertificates\fP or -\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the -alias \fB\-\-tlsAllowInvalidateCertificates\fP or -\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509 +.PP +Starting in MongoDB 4.2, if you specify +\fB\-\-tlsAllowInvalidateCertificates\f1 or +\fBnet.tls.allowInvalidCertificates: true\f1 when using x.509 authentication, an invalid certificate is only sufficient to -establish a TLS/SSL connection but is \fIinsufficient\fP for +establish a TLS connection but it is \fIinsufficient\f1 for authentication. -.UNINDENT -.UNINDENT -.sp +.PP When using -the \fI\%\-\-sslAllowInvalidCertificates\fP setting, MongoDB +the \fB\-\-sslAllowInvalidCertificates\f1\f1 setting, MongoDB logs a warning regarding the use of the invalid certificate. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidHostnames -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidHostnames\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslAllowInvalidHostnames\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidHostnames\f1\f1 instead. +.PP Disables the validation of the hostnames in TLS/SSL certificates, when connecting to other members of the replica set or sharded cluster -for inter\-process authentication. This allows \fBmongos\fP to connect +for inter\-process authentication. This allows \fBmongos\f1\f1 to connect to other members if the hostnames in their certificates do not match their configured hostname. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslDisabledProtocols <protocol(s)> -Deprecated since version 4.2: Use \fI\%\-\-tlsDisabledProtocols\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongos \-\-sslDisabledProtocols\f1 +.RS +.PP +Use \fB\-\-tlsDisabledProtocols\f1\f1 instead. +.PP Prevents a MongoDB server running with TLS/SSL from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols. -.sp -\fI\%\-\-sslDisabledProtocols\fP recognizes the following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, -\fBTLS1_2\fP, and starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\fP\&. -.INDENT 7.0 +.PP +\fB\-\-sslDisabledProtocols\f1\f1 recognizes the following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, +\fBTLS1_2\f1, and starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must disable at least one of the other -two, for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must disable at least one of the other +two, for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 Specifying an unrecognized protocol will prevent the server from starting. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, -specify \fBnone\fP to \fI\%\-\-sslDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.sp +specify \fBnone\f1 to \fB\-\-sslDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.PP Members of replica sets and sharded clusters must speak at least one protocol in common. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -ssl\-disallow\-protocols -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslFIPSMode -Deprecated since version 4.2: Use \fI\%\-\-tlsFIPSMode\fP instead. - -.sp -Directs the \fBmongos\fP to use the FIPS mode of the TLS/SSL +.PP +\fBDisallow Protocols\f1 +.RE +.PP +\fBmongos \-\-sslFIPSMode\f1 +.RS +.PP +Use \fB\-\-tlsFIPSMode\f1\f1 instead. +.PP +Directs the \fBmongos\f1\f1 to use the FIPS mode of the TLS/SSL library. Your system must have a FIPS -compliant library to use the \fI\%\-\-sslFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +compliant library to use the \fB\-\-sslFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Audit Options -.INDENT 0.0 -.TP -.B \-\-auditDestination -Enables auditing and specifies where -\fBmongos\fP sends all audit events. -.sp -\fI\%\-\-auditDestination\fP can have one of the following values: -.TS -center; -|l|l|. -_ -T{ +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.SS AUDIT OPTIONS +.PP +\fBmongos \-\-auditDestination\f1 +.RS +.PP +Enables \fBauditing\f1 and specifies where +\fBmongos\f1\f1 sends all audit events. +.PP +\fB\-\-auditDestination\f1\f1 can have one of the following values: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsyslog\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsyslog\f1 +.IP \(bu 4 Output the audit events to syslog in JSON format. Not available on -Windows. Audit messages have a syslog severity level of \fBinfo\fP -and a facility level of \fBuser\fP\&. -.sp +Windows. Audit messages have a syslog severity level of \fBinfo\f1 +and a facility level of \fBuser\f1\&. +.IP The syslog message limit can result in the truncation of audit messages. The auditing system will neither detect the truncation nor error upon its occurrence. -T} -_ -T{ -\fBconsole\fP -T} T{ -Output the audit events to \fBstdout\fP in JSON format. -T} -_ -T{ -\fBfile\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBconsole\f1 +.IP \(bu 4 +Output the audit events to \fBstdout\f1 in JSON format. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBfile\f1 +.IP \(bu 4 Output the audit events to the file specified in -\fI\%\-\-auditPath\fP in the format specified in -\fI\%\-\-auditFormat\fP\&. -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auditFormat -Specifies the format of the output file for auditing if \fI\%\-\-auditDestination\fP is \fBfile\fP\&. The -\fI\%\-\-auditFormat\fP option can have one of the following values: -.TS -center; -|l|l|. -_ -T{ +\fB\-\-auditPath\f1\f1 in the format specified in +\fB\-\-auditFormat\f1\f1\&. +.RE +.RE +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.PP +\fBmongos \-\-auditFormat\f1 +.RS +.PP +Specifies the format of the output file for \fBauditing\f1 if \fB\-\-auditDestination\f1\f1 is \fBfile\f1\&. The +\fB\-\-auditFormat\f1\f1 option can have one of the following values: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBJSON\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBJSON\f1 +.IP \(bu 4 Output the audit events in JSON format to the file specified -in \fI\%\-\-auditPath\fP\&. -T} -_ -T{ -\fBBSON\fP -T} T{ +in \fB\-\-auditPath\f1\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBBSON\f1 +.IP \(bu 4 Output the audit events in BSON binary format to the file -specified in \fI\%\-\-auditPath\fP\&. -T} -_ -.TE -.sp +specified in \fB\-\-auditPath\f1\f1\&. +.RE +.RE +.PP Printing audit events to a file in JSON format degrades server performance more than printing to a file in BSON format. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auditPath -Specifies the output file for auditing if -\fI\%\-\-auditDestination\fP has value of \fBfile\fP\&. The \fI\%\-\-auditPath\fP +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.PP +\fBmongos \-\-auditPath\f1 +.RS +.PP +Specifies the output file for \fBauditing\f1 if +\fB\-\-auditDestination\f1\f1 has value of \fBfile\f1\&. The \fB\-\-auditPath\f1\f1 option can take either a full path name or a relative path name. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auditFilter -Specifies the filter to limit the types of operations the audit system records. The option takes a string representation +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.PP +\fBmongos \-\-auditFilter\f1 +.RS +.PP +Specifies the filter to limit the \fBtypes of operations\f1 the \fBaudit system\f1 records. The option takes a string representation of a query document of the form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ <field1>: <expression1>, ... } -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fB<field>\fP can be any field in the audit message, including fields returned in the -param document. The -\fB<expression>\fP is a query condition expression\&. -.sp +.PP +.EX + { <field1>: <expression1>, ... } +.EE +.PP +The \fB<field>\f1 can be \fBany field in the audit message\f1, including fields returned in the +\fBparam\f1 document. The +\fB<expression>\f1 is a \fBquery condition expression\f1\&. +.PP To specify an audit filter, enclose the filter document in single quotes to pass the document as a string. -.sp -To specify the audit filter in a configuration file, you must use the YAML format of +.PP +To specify the audit filter in a \fBconfiguration file\f1, you must use the YAML format of the configuration file. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Available only in \fI\%MongoDB Enterprise\fP -and \fI\%MongoDB Atlas\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Profiler Options -.sp -New in version 4.0. - -.INDENT 0.0 -.TP -.B \-\-slowms <integer> -\fIDefault\fP: 100 -.sp -The \fIslow\fP operation time threshold, in milliseconds. Operations -that run for longer than this threshold are considered \fIslow\fP\&. -.sp -When \fBlogLevel\fP is set to \fB0\fP, MongoDB records \fIslow\fP +.PP +Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) +and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. +.RE +.SS PROFILER OPTIONS +.PP +\fBmongos \-\-slowms\f1 +.RS +.PP +\fIDefault\f1: 100 +.PP +The \fIslow\f1 operation time threshold, in milliseconds. Operations +that run for longer than this threshold are considered \fIslow\f1\&. +.PP +When \fBlogLevel\f1\f1 is set to \fB0\f1, MongoDB records \fIslow\f1 operations to the diagnostic log at a rate determined by -\fBslowOpSampleRate\fP\&. -.sp -At higher \fBlogLevel\fP settings, all operations appear +\fBslowOpSampleRate\f1\f1\&. +.PP +At higher \fBlogLevel\f1\f1 settings, all operations appear in the diagnostic log regardless of their latency. -.sp -For \fI\%mongos\fP instances, affects the diagnostic +.PP +For \fBmongos\f1\f1 instances, affects the diagnostic log only and not the profiler since profiling is not available on -\fI\%mongos\fP\&. -.sp -New in version 4.0. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-slowOpSampleRate <double> -\fIDefault\fP: 1.0 -.sp -The fraction of \fIslow\fP operations that should be logged. -\fI\%\-\-slowOpSampleRate\fP accepts values between 0 and 1, inclusive. -.sp -For \fI\%mongos\fP instances, \fI\%\-\-slowOpSampleRate\fP affects the diagnostic log +\fBmongos\f1\f1\&. +.RE +.PP +\fBmongos \-\-slowOpSampleRate\f1 +.RS +.PP +\fIDefault\f1: 1.0 +.PP +The fraction of \fIslow\f1 operations that should be logged. +\fB\-\-slowOpSampleRate\f1\f1 accepts values between 0 and 1, inclusive. +.PP +For \fBmongos\f1\f1 instances, \fB\-\-slowOpSampleRate\f1\f1 affects the diagnostic log only and not the profiler since profiling is not available on -\fI\%mongos\fP\&. -.sp -New in version 4.0. - -.UNINDENT -.SS LDAP Authentication and Authorization Options -.INDENT 0.0 -.TP -.B \-\-ldapServers <host1>:<port>,<host2>:<port>,...,<hostN>:<port> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The LDAP server against which the \fBmongos\fP authenticates users or +\fBmongos\f1\f1\&. +.RE +.SS LDAP AUTHENTICATION AND AUTHORIZATION OPTIONS +.PP +\fBmongos \-\-ldapServers\f1 +.RS +.PP +The LDAP server against which the \fBmongos\f1\f1 authenticates users or determines what actions a user is authorized to perform on a given database. If the LDAP server specified has any replicated instances, you may specify the host and port of each replicated server in a comma\-delimited list. -.sp +.PP If your LDAP infrastructure partitions the LDAP directory over multiple LDAP -servers, specify \fIone\fP LDAP server or any of its replicated instances to -\fI\%\-\-ldapServers\fP\&. MongoDB supports following LDAP referrals as defined in \fI\%RFC 4511 -4.1.10\fP\&. Do not use \fI\%\-\-ldapServers\fP +servers, specify \fIone\f1 LDAP server or any of its replicated instances to +\fB\-\-ldapServers\f1\f1\&. MongoDB supports following LDAP referrals as defined in RFC 4511 +4.1.10 (https://www.rfc\-editor.org/rfc/rfc4511.txt)\&. Do not use \fB\-\-ldapServers\f1\f1 for listing every LDAP server in your infrastructure. -.sp -This setting can be configured on a running \fBmongos\fP using -\fBsetParameter\fP\&. -.sp -If unset, \fBmongos\fP cannot use LDAP authentication or authorization\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapValidateLDAPServerConfig <boolean> -\fIAvailable in MongoDB Enterprise\fP -.sp -A flag that determines if the \fI\%mongos\fP instance checks -the availability of the \fI\%LDAP server(s)\fP as part of its startup: -.INDENT 7.0 -.IP \(bu 2 -If \fBtrue\fP, the \fI\%mongos\fP instance performs the +.PP +This setting can be configured on a running \fBmongos\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +If unset, \fBmongos\f1\f1 cannot use \fBLDAP authentication or authorization\f1\&. +.RE +.PP +\fBmongos \-\-ldapValidateLDAPServerConfig\f1 +.RS +.PP +\fIAvailable in MongoDB Enterprise\f1 +.PP +A flag that determines if the \fBmongos\f1\f1 instance checks +the availability of the \fBLDAP server(s)\f1\f1 as part of its startup: +.RS +.IP \(bu 2 +If \fBtrue\f1, the \fBmongos\f1\f1 instance performs the availability check and only continues to start up if the LDAP server is available. .IP \(bu 2 -If \fBfalse\fP, the \fI\%mongos\fP instance skips the +If \fBfalse\f1, the \fBmongos\f1\f1 instance skips the availability check; i.e. the instance starts up even if the LDAP server is unavailable. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryUser <string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The identity with which \fBmongos\fP binds as, when connecting to or +.RE +.RE +.PP +\fBmongos \-\-ldapQueryUser\f1 +.RS +.PP +The identity with which \fBmongos\f1\f1 binds as, when connecting to or performing queries on an LDAP server. -.sp +.PP Only required if any of the following are true: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -You must use \fI\%\-\-ldapQueryUser\fP with \fI\%\-\-ldapQueryPassword\fP\&. -.sp -If unset, \fBmongos\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongos\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryPassword <string> -New in version 3.4: Available in MongoDB Enterprise only. -.sp +.RE +.PP +You must use \fB\-\-ldapQueryUser\f1\f1 with \fB\-\-ldapQueryPassword\f1\f1\&. +.PP +If unset, \fBmongos\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongos\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongos \-\-ldapQueryPassword\f1 +.RS +.PP The password used to bind to an LDAP server when using -\fI\%\-\-ldapQueryUser\fP\&. You must use \fI\%\-\-ldapQueryPassword\fP with -\fI\%\-\-ldapQueryUser\fP\&. - -.sp -If unset, \fBmongos\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongos\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindWithOSDefaults <bool> -\fIDefault\fP: false -.sp -New in version 3.4: Available in MongoDB Enterprise for the Windows platform only. - -.sp -Allows \fBmongos\fP to authenticate, or bind, using your Windows login +\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with +\fB\-\-ldapQueryUser\f1\f1\&. +.PP +If unset, \fBmongos\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongos\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongos \-\-ldapBindWithOSDefaults\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Available in MongoDB Enterprise for the Windows platform only. +.PP +Allows \fBmongos\f1\f1 to authenticate, or bind, using your Windows login credentials when connecting to the LDAP server. -.sp +.PP Only required if: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -Use \fI\%\-\-ldapBindWithOSDefaults\fP to replace \fI\%\-\-ldapQueryUser\fP and -\fI\%\-\-ldapQueryPassword\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindMethod <string> -\fIDefault\fP: simple -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The method \fBmongos\fP uses to authenticate to an LDAP server. -Use with \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP to +.RE +.PP +Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 and +\fB\-\-ldapQueryPassword\f1\f1\&. +.RE +.PP +\fBmongos \-\-ldapBindMethod\f1 +.RS +.PP +\fIDefault\f1: simple +.PP +The method \fBmongos\f1\f1 uses to authenticate to an LDAP server. +Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to connect to the LDAP server. -.sp -\fI\%\-\-ldapBindMethod\fP supports the following values: -.INDENT 7.0 -.IP \(bu 2 -\fBsimple\fP \- \fBmongos\fP uses simple authentication. -.IP \(bu 2 -\fBsasl\fP \- \fBmongos\fP uses SASL protocol for authentication -.UNINDENT -.sp -If you specify \fBsasl\fP, you can configure the available SASL mechanisms -using \fI\%\-\-ldapBindSaslMechanisms\fP\&. \fBmongos\fP defaults to -using \fBDIGEST\-MD5\fP mechanism. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindSaslMechanisms <string> -\fIDefault\fP: DIGEST\-MD5 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A comma\-separated list of SASL mechanisms \fBmongos\fP can -use when authenticating to the LDAP server. The \fBmongos\fP and the -LDAP server must agree on at least one mechanism. The \fBmongos\fP +.PP +\fB\-\-ldapBindMethod\f1\f1 supports the following values: +.RS +.IP \(bu 2 +\fBsimple\f1 \- \fBmongos\f1\f1 uses simple authentication. +.IP \(bu 2 +\fBsasl\f1 \- \fBmongos\f1\f1 uses SASL protocol for authentication +.RE +.PP +If you specify \fBsasl\f1, you can configure the available SASL mechanisms +using \fB\-\-ldapBindSaslMechanisms\f1\f1\&. \fBmongos\f1\f1 defaults to +using \fBDIGEST\-MD5\f1 mechanism. +.RE +.PP +\fBmongos \-\-ldapBindSaslMechanisms\f1 +.RS +.PP +\fIDefault\f1: DIGEST\-MD5 +.PP +A comma\-separated list of SASL mechanisms \fBmongos\f1\f1 can +use when authenticating to the LDAP server. The \fBmongos\f1\f1 and the +LDAP server must agree on at least one mechanism. The \fBmongos\f1\f1 dynamically loads any SASL mechanism libraries installed on the host machine at runtime. -.sp +.PP Install and configure the appropriate libraries for the selected -SASL mechanism(s) on both the \fBmongos\fP host and the remote +SASL mechanism(s) on both the \fBmongos\f1\f1 host and the remote LDAP server host. Your operating system may include certain SASL libraries by default. Defer to the documentation associated with each SASL mechanism for guidance on installation and configuration. -.sp -If using the \fBGSSAPI\fP SASL mechanism for use with -security\-kerberos, verify the following for the -\fBmongos\fP host machine: -.INDENT 7.0 -.TP -.B \fBLinux\fP -.INDENT 7.0 -.IP \(bu 2 -The \fBKRB5_CLIENT_KTNAME\fP environment -variable resolves to the name of the client keytab\-files +.PP +If using the \fBGSSAPI\f1 SASL mechanism for use with +\fBKerberos Authentication\f1, verify the following for the +\fBmongos\f1\f1 host machine: +.PP +\fBLinux\f1\f1 +.RS +.RS +.IP \(bu 2 +The \fBKRB5_CLIENT_KTNAME\f1 environment +variable resolves to the name of the client \fBLinux Keytab Files\f1 for the host machine. For more on Kerberos environment variables, please defer to the -\fI\%Kerberos documentation\fP\&. +Kerberos documentation (https://web.mit.edu/kerberos/krb5\-1.13/doc/admin/env_variables.html)\&. .IP \(bu 2 The client keytab includes a -kerberos\-user\-principal for the \fBmongos\fP to use when +\fBUser Principal\f1 for the \fBmongos\f1\f1 to use when connecting to the LDAP server and execute LDAP queries. -.UNINDENT -.TP -.B \fBWindows\fP +.RE +.RE +.PP +\fBWindows\f1\f1 +.RS +.PP If connecting to an Active Directory server, the Windows Kerberos configuration automatically generates a -\fI\%Ticket\-Granting\-Ticket\fP -when the user logs onto the system. Set \fI\%\-\-ldapBindWithOSDefaults\fP to -\fBtrue\fP to allow \fBmongos\fP to use the generated credentials when +Ticket\-Granting\-Ticket (https://msdn.microsoft.com/en\-us/library/windows/desktop/aa380510(v=vs.85).aspx) +when the user logs onto the system. Set \fB\-\-ldapBindWithOSDefaults\f1\f1 to +\fBtrue\f1 to allow \fBmongos\f1\f1 to use the generated credentials when connecting to the Active Directory server and execute queries. -.UNINDENT -.sp -Set \fI\%\-\-ldapBindMethod\fP to \fBsasl\fP to use this option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.PP +Set \fB\-\-ldapBindMethod\f1\f1 to \fBsasl\f1 to use this option. +.PP For a complete list of SASL mechanisms see the -\fI\%IANA listing\fP\&. +IANA listing (http://www.iana.org/assignments/sasl\-mechanisms/sasl\-mechanisms.xhtml)\&. Defer to the documentation for your LDAP or Active Directory service for identifying the SASL mechanisms compatible with the service. -.sp +.PP MongoDB is not a source of SASL mechanism libraries, nor is the MongoDB documentation a definitive source for installing or configuring any given SASL mechanism. For documentation and support, defer to the SASL mechanism library vendor or owner. -.sp +.PP For more information on SASL, defer to the following resources: -.INDENT 0.0 -.IP \(bu 2 -For Linux, please see the \fI\%Cyrus SASL documentation\fP\&. -.IP \(bu 2 -For Windows, please see the \fI\%Windows SASL documentation\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTransportSecurity <string> -\fIDefault\fP: tls -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -By default, \fBmongos\fP creates a TLS/SSL secured connection to the LDAP +.RS +.IP \(bu 2 +For Linux, please see the Cyrus SASL documentation (https://www.cyrusimap.org/sasl/)\&. +.IP \(bu 2 +For Windows, please see the Windows SASL documentation (https://msdn.microsoft.com/en\-us/library/cc223500.aspx)\&. +.RE +.RE +.PP +\fBmongos \-\-ldapTransportSecurity\f1 +.RS +.PP +\fIDefault\f1: tls +.PP +By default, \fBmongos\f1\f1 creates a TLS/SSL secured connection to the LDAP server. -.sp +.PP For Linux deployments, you must configure the appropriate TLS Options in -\fB/etc/openldap/ldap.conf\fP file. Your operating system\(aqs package manager +\fB/etc/openldap/ldap.conf\f1 file. Your operating system\(aqs package manager creates this file as part of the MongoDB Enterprise installation, via the -\fBlibldap\fP dependency. See the documentation for \fBTLS Options\fP in the -\fI\%ldap.conf OpenLDAP documentation\fP +\fBlibldap\f1 dependency. See the documentation for \fBTLS Options\f1 in the +ldap.conf OpenLDAP documentation (http://www.openldap.org/software/man.cgi?query=ldap.conf&manpath=OpenLDAP+2.4\-Release) for more complete instructions. -.sp +.PP For Windows deployment, you must add the LDAP server CA certificates to the Windows certificate management tool. The exact name and functionality of the tool may vary depending on operating system version. Please see the documentation for your version of Windows for more information on certificate management. -.sp -Set \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP to disable TLS/SSL between \fBmongos\fP and the LDAP +.PP +Set \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 to disable TLS/SSL between \fBmongos\f1\f1 and the LDAP server. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -Setting \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP transmits plaintext information and possibly -credentials between \fBmongos\fP and the LDAP server. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTimeoutMS <long> -\fIDefault\fP: 10000 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The amount of time in milliseconds \fBmongos\fP should wait for an LDAP server +.PP +Setting \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 transmits plaintext information and possibly +credentials between \fBmongos\f1\f1 and the LDAP server. +.RE +.PP +\fBmongos \-\-ldapTimeoutMS\f1 +.RS +.PP +\fIDefault\f1: 10000 +.PP +The amount of time in milliseconds \fBmongos\f1\f1 should wait for an LDAP server to respond to a request. -.sp -Increasing the value of \fI\%\-\-ldapTimeoutMS\fP may prevent connection failure between the +.PP +Increasing the value of \fB\-\-ldapTimeoutMS\f1\f1 may prevent connection failure between the MongoDB server and the LDAP server, if the source of the failure is a -connection timeout. Decreasing the value of \fI\%\-\-ldapTimeoutMS\fP reduces the time +connection timeout. Decreasing the value of \fB\-\-ldapTimeoutMS\f1\f1 reduces the time MongoDB waits for a response from the LDAP server. -.sp -This setting can be configured on a running \fBmongos\fP using -\fBsetParameter\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapUserToDNMapping <string> -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -Maps the username provided to \fBmongos\fP for authentication to a LDAP -Distinguished Name (DN). You may need to use \fI\%\-\-ldapUserToDNMapping\fP to transform a +.PP +This setting can be configured on a running \fBmongos\f1\f1 using +\fBsetParameter\f1\f1\&. +.RE +.PP +\fBmongos \-\-ldapUserToDNMapping\f1 +.RS +.PP +Maps the username provided to \fBmongos\f1\f1 for authentication to a LDAP +Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a username into an LDAP DN in the following scenarios: -.INDENT 7.0 +.RS .IP \(bu 2 Performing LDAP authentication with simple LDAP binding, where users authenticate to MongoDB with usernames that are not full LDAP DNs. .IP \(bu 2 -Using an \fBLDAP authorization query template\fP that requires a DN. +Using an \fBLDAP authorization query template\f1\f1 that requires a DN. .IP \(bu 2 Transforming the usernames of clients authenticating to Mongo DB using different authentication mechanisms (e.g. x.509, kerberos) to a full LDAP DN for authorization. -.UNINDENT -.sp -\fI\%\-\-ldapUserToDNMapping\fP expects a quote\-enclosed JSON\-string representing an ordered array -of documents. Each document contains a regular expression \fBmatch\fP and -either a \fBsubstitution\fP or \fBldapQuery\fP template used for transforming the +.RE +.PP +\fB\-\-ldapUserToDNMapping\f1\f1 expects a quote\-enclosed JSON\-string representing an ordered array +of documents. Each document contains a regular expression \fBmatch\f1 and +either a \fBsubstitution\f1 or \fBldapQuery\f1 template used for transforming the incoming username. -.sp +.PP Each document in the array has the following form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - match: "<regex>" - substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.TS -center; -|l|l|l|. -_ -T{ +.PP +.EX + { + match: "<regex>" + substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>" + } +.EE +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Field -T} T{ +.IP \(bu 4 Description -T} T{ +.IP \(bu 4 Example -T} -_ -T{ -\fBmatch\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBmatch\f1 +.IP \(bu 4 An ECMAScript\-formatted regular expression (regex) to match against a provided username. Each parenthesis\-enclosed section represents a -regex capture group used by \fBsubstitution\fP or \fBldapQuery\fP\&. -T} T{ -\fB"(.+)ENGINEERING"\fP -\fB"(.+)DBA"\fP -T} -_ -T{ -\fBsubstitution\fP -T} T{ +regex capture group used by \fBsubstitution\f1 or \fBldapQuery\f1\&. +.IP \(bu 4 +\fB"(.+)ENGINEERING"\f1 +\fB"(.+)DBA"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubstitution\f1 +.IP \(bu 4 An LDAP distinguished name (DN) formatting template that converts the -authentication name matched by the \fBmatch\fP regex into a LDAP DN. +authentication name matched by the \fBmatch\f1 regex into a LDAP DN. Each curly bracket\-enclosed numeric value is replaced by the -corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP regex. -.sp -The result of the substitution must be an \fI\%RFC4514\fP escaped string. -T} T{ +corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 regex. +.IP +The result of the substitution must be an RFC4514 (https://www.ietf.org/rfc/rfc4514.txt) escaped string. +.IP \(bu 4 \fB"cn={0},ou=engineering, -dc=example,dc=com"\fP -T} -_ -T{ -\fBldapQuery\fP -T} T{ +dc=example,dc=com"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBldapQuery\f1 +.IP \(bu 4 A LDAP query formatting template that inserts the authentication -name matched by the \fBmatch\fP regex into an LDAP query URI encoded +name matched by the \fBmatch\f1 regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. Each curly bracket\-enclosed numeric -value is replaced by the corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP expression. -\fBmongos\fP executes the query against the LDAP server to retrieve -the LDAP DN for the authenticated user. \fBmongos\fP requires +value is replaced by the corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 expression. +\fBmongos\f1\f1 executes the query against the LDAP server to retrieve +the LDAP DN for the authenticated user. \fBmongos\f1\f1 requires exactly one returned result for the transformation to be -successful, or \fBmongos\fP skips this transformation. -T} T{ +successful, or \fBmongos\f1\f1 skips this transformation. +.IP \(bu 4 \fB"ou=engineering,dc=example, -dc=com??one?(user={0})"\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4514\fP, -\fI\%RFC4515\fP, -\fI\%RFC4516\fP, or LDAP queries is out +dc=com??one?(user={0})"\f1 +.RE +.RE +.PP +An explanation of RFC4514 (https://www.ietf.org/rfc/rfc4514.txt), +RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516), or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.sp -For each document in the array, you must use either \fBsubstitution\fP or -\fBldapQuery\fP\&. You \fIcannot\fP specify both in the same document. -.sp -When performing authentication or authorization, \fBmongos\fP steps through +.PP +For each document in the array, you must use either \fBsubstitution\f1 or +\fBldapQuery\f1\&. You \fIcannot\f1 specify both in the same document. +.PP +When performing authentication or authorization, \fBmongos\f1\f1 steps through each document in the array in the given order, checking the authentication -username against the \fBmatch\fP filter. If a match is found, -\fBmongos\fP applies the transformation and uses the output for -authenticating the user. \fBmongos\fP does not check the remaining documents +username against the \fBmatch\f1 filter. If a match is found, +\fBmongos\f1\f1 applies the transformation and uses the output for +authenticating the user. \fBmongos\f1\f1 does not check the remaining documents in the array. -.sp +.PP If the given document does not match the provided authentication -name, \fI\%mongos\fP continues through the list of documents +name, \fBmongos\f1\f1 continues through the list of documents to find additional matches. If no matches are found in any document, or the transformation the document describes fails, -\fI\%mongos\fP returns an error. -.sp -Starting in MongoDB 4.4, \fI\%mongos\fP also returns an error +\fBmongos\f1\f1 returns an error. +.PP +Starting in MongoDB 4.4, \fBmongos\f1\f1 also returns an error if one of the transformations cannot be evaluated due to networking -or authentication failures to the LDAP server. \fI\%mongos\fP +or authentication failures to the LDAP server. \fBmongos\f1\f1 rejects the connection request and does not check the remaining documents in the array. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp +.PP +Starting in MongoDB 5.0, \fB\-\-ldapUserToDNMapping\f1\f1 +accepts an empty string \fB""\f1 or empty array \fB[ ]\f1 in place of a +mapping documnent. If providing an empty string or empty array to +\fB\-\-ldapUserToDNMapping\f1\f1, MongoDB will map the +authenticated username as the LDAP DN. Previously, providing an +empty mapping document would cause mapping to fail. +.PP The following shows two transformation documents. The first -document matches against any string ending in \fB@ENGINEERING\fP, placing +document matches against any string ending in \fB@ENGINEERING\f1, placing anything preceeding the suffix into a regex capture group. The -second document matches against any string ending in \fB@DBA\fP, placing +second document matches against any string ending in \fB@DBA\f1, placing anything preceeding the suffix into a regex capture group. -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 -You must pass the array to \fI\%\-\-ldapUserToDNMapping\fP as a string. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"[ - { - match: "(.+)@ENGINEERING.EXAMPLE.COM", - substitution: "cn={0},ou=engineering,dc=example,dc=com" - }, - { - match: "(.+)@DBA.EXAMPLE.COM", - ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" - - } - -]" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A user with username \fBalice@ENGINEERING.EXAMPLE.COM\fP matches the first -document. The regex capture group \fB{0}\fP corresponds to the string -\fBalice\fP\&. The resulting output is the DN -\fB"cn=alice,ou=engineering,dc=example,dc=com"\fP\&. -.sp -A user with username \fBbob@DBA.EXAMPLE.COM\fP matches the second document. -The regex capture group \fB{0}\fP corresponds to the string \fBbob\fP\&. The +.PP +.EX + "[ + { + match: "(.+)@ENGINEERING.EXAMPLE.COM", + substitution: "cn={0},ou=engineering,dc=example,dc=com" + }, + { + match: "(.+)@DBA.EXAMPLE.COM", + ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" + + } + + ]" +.EE +.PP +A user with username \fBalice@ENGINEERING.EXAMPLE.COM\f1 matches the first +document. The regex capture group \fB{0}\f1 corresponds to the string +\fBalice\f1\&. The resulting output is the DN +\fB"cn=alice,ou=engineering,dc=example,dc=com"\f1\&. +.PP +A user with username \fBbob@DBA.EXAMPLE.COM\f1 matches the second document. +The regex capture group \fB{0}\f1 corresponds to the string \fBbob\f1\&. The resulting output is the LDAP query -\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\fP\&. \fBmongos\fP executes this +\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\f1\&. \fBmongos\f1\f1 executes this query against the LDAP server, returning the result -\fB"cn=bob,ou=dba,dc=example,dc=com"\fP\&. -.UNINDENT -.UNINDENT -.sp -If \fI\%\-\-ldapUserToDNMapping\fP is unset, \fBmongos\fP applies no transformations to the username +\fB"cn=bob,ou=dba,dc=example,dc=com"\f1\&. +.PP +If \fB\-\-ldapUserToDNMapping\f1\f1 is unset, \fBmongos\f1\f1 applies no transformations to the username when attempting to authenticate or authorize a user against the LDAP server. -.sp -This setting can be configured on a running \fBmongos\fP using the -\fBsetParameter\fP database command. -.UNINDENT -.SS Additional Options -.INDENT 0.0 -.TP -.B \-\-ipv6 -Enables IPv6 support. \fBmongos\fP disables IPv6 support by default. -.sp -Setting \fI\%\-\-ipv6\fP does \fInot\fP direct the \fBmongos\fP to listen on any -local IPv6 addresses or interfaces. To configure the \fBmongos\fP to +.PP +This setting can be configured on a running \fBmongos\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.RE +.SS ADDITIONAL OPTIONS +.PP +\fBmongos \-\-ipv6\f1 +.RS +.PP +Enables IPv6 support. \fBmongos\f1\f1 disables IPv6 support by default. +.PP +Setting \fB\-\-ipv6\f1\f1 does \fInot\f1 direct the \fBmongos\f1\f1 to listen on any +local IPv6 addresses or interfaces. To configure the \fBmongos\f1\f1 to listen on an IPv6 interface, you must either: -.INDENT 7.0 -.IP \(bu 2 -Configure \fI\%\-\-bind_ip\fP with one or more IPv6 addresses or -hostnames that resolve to IPv6 addresses, \fBor\fP -.IP \(bu 2 -Set \fI\%\-\-bind_ip_all\fP to \fBtrue\fP\&. -.UNINDENT -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +.RS +.IP \(bu 2 +Configure \fB\-\-bind_ip\f1\f1 with one or more IPv6 addresses or +hostnames that resolve to IPv6 addresses, \fBor\f1 +.IP \(bu 2 +Set \fB\-\-bind_ip_all\f1\f1 to \fBtrue\f1\&. +.RE +.RE diff --git a/rpm/mongodb-enterprise-init.spec b/rpm/mongodb-enterprise-init.spec index 90dc1d2dafd..a1b908f72c5 100644 --- a/rpm/mongodb-enterprise-init.spec +++ b/rpm/mongodb-enterprise-init.spec @@ -283,6 +283,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s,ldap,kerberos}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/init.d cp -v rpm/init.d-mongod $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod chmod a+x $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod @@ -333,6 +335,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_sysconfdir}/init.d/mongod %config(noreplace) %{_sysconfdir}/sysconfig/mongod %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo diff --git a/rpm/mongodb-enterprise-unstable-init.spec b/rpm/mongodb-enterprise-unstable-init.spec index 7192a2fa660..883f998c2e8 100644 --- a/rpm/mongodb-enterprise-unstable-init.spec +++ b/rpm/mongodb-enterprise-unstable-init.spec @@ -272,6 +272,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s,ldap,kerberos}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/init.d cp -v rpm/init.d-mongod $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod chmod a+x $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod @@ -324,6 +326,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_sysconfdir}/init.d/mongod %config(noreplace) %{_sysconfdir}/sysconfig/mongod %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo diff --git a/rpm/mongodb-enterprise-unstable.spec b/rpm/mongodb-enterprise-unstable.spec index 8f60f6b716c..58803bcad15 100644 --- a/rpm/mongodb-enterprise-unstable.spec +++ b/rpm/mongodb-enterprise-unstable.spec @@ -279,6 +279,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s,ldap,kerberos}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir} cp -v rpm/mongod.conf $RPM_BUILD_ROOT%{_sysconfdir}/mongod.conf mkdir -p $RPM_BUILD_ROOT%{_unitdir} @@ -333,6 +335,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_unitdir}/mongod.service %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo %attr(0755,mongod,mongod) %dir %{_localstatedir}/log/mongodb diff --git a/rpm/mongodb-enterprise.spec b/rpm/mongodb-enterprise.spec index 71dffd21840..e48fecf07b4 100644 --- a/rpm/mongodb-enterprise.spec +++ b/rpm/mongodb-enterprise.spec @@ -290,6 +290,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s,ldap,kerberos}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir} cp -v rpm/mongod.conf $RPM_BUILD_ROOT%{_sysconfdir}/mongod.conf mkdir -p $RPM_BUILD_ROOT%{_unitdir} @@ -340,6 +342,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_unitdir}/mongod.service %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo %attr(0755,mongod,mongod) %dir %{_localstatedir}/log/mongodb diff --git a/rpm/mongodb-org-init.spec b/rpm/mongodb-org-init.spec index b6815c5c713..0500d557393 100644 --- a/rpm/mongodb-org-init.spec +++ b/rpm/mongodb-org-init.spec @@ -260,6 +260,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/init.d cp -v rpm/init.d-mongod $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod chmod a+x $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod @@ -310,6 +312,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_sysconfdir}/init.d/mongod %config(noreplace) %{_sysconfdir}/sysconfig/mongod %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo diff --git a/rpm/mongodb-org-unstable-init.spec b/rpm/mongodb-org-unstable-init.spec index 8ad3fe9623b..abd4fb275e8 100644 --- a/rpm/mongodb-org-unstable-init.spec +++ b/rpm/mongodb-org-unstable-init.spec @@ -247,6 +247,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/init.d cp -v rpm/init.d-mongod $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod chmod a+x $RPM_BUILD_ROOT%{_sysconfdir}/init.d/mongod @@ -299,6 +301,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_sysconfdir}/init.d/mongod %config(noreplace) %{_sysconfdir}/sysconfig/mongod %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo diff --git a/rpm/mongodb-org-unstable.spec b/rpm/mongodb-org-unstable.spec index 4ab2a494970..256d0f2f75d 100644 --- a/rpm/mongodb-org-unstable.spec +++ b/rpm/mongodb-org-unstable.spec @@ -254,6 +254,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir} cp -v rpm/mongod.conf $RPM_BUILD_ROOT%{_sysconfdir}/mongod.conf mkdir -p $RPM_BUILD_ROOT%{_unitdir} @@ -305,6 +307,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_unitdir}/mongod.service %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo %attr(0755,mongod,mongod) %dir %{_localstatedir}/log/mongodb diff --git a/rpm/mongodb-org.spec b/rpm/mongodb-org.spec index fb57503f318..21c1c41871c 100644 --- a/rpm/mongodb-org.spec +++ b/rpm/mongodb-org.spec @@ -266,6 +266,8 @@ mkdir -p $RPM_BUILD_ROOT%{_prefix} cp -rv bin $RPM_BUILD_ROOT%{_prefix} mkdir -p $RPM_BUILD_ROOT%{_mandir}/man1 cp debian/mongo{,d,s}.1 $RPM_BUILD_ROOT%{_mandir}/man1/ +mkdir -p $RPM_BUILD_ROOT%{_mandir}/man5 +cp debian/mongodb-parameters.5 $RPM_BUILD_ROOT%{_mandir}/man5/ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir} cp -v rpm/mongod.conf $RPM_BUILD_ROOT%{_sysconfdir}/mongod.conf mkdir -p $RPM_BUILD_ROOT%{_unitdir} @@ -317,6 +319,7 @@ fi %config(noreplace) %{_sysconfdir}/mongod.conf %{_bindir}/mongod %{_mandir}/man1/mongod.1* +%{_mandir}/man5/mongodb-parameters.5* %{_unitdir}/mongod.service %attr(0755,mongod,mongod) %dir %{_sharedstatedir}/mongo %attr(0755,mongod,mongod) %dir %{_localstatedir}/log/mongodb |