diff options
Diffstat (limited to 'debian')
| -rw-r--r-- | debian/bsondump.1 | 33 | ||||
| -rw-r--r-- | debian/mongo.1 | 209 | ||||
| -rw-r--r-- | debian/mongod.1 | 1223 | ||||
| -rw-r--r-- | debian/mongodump.1 | 376 | ||||
| -rw-r--r-- | debian/mongoexport.1 | 293 | ||||
| -rw-r--r-- | debian/mongofiles.1 | 216 | ||||
| -rw-r--r-- | debian/mongoimport.1 | 333 | ||||
| -rw-r--r-- | debian/mongooplog.1 | 231 | ||||
| -rw-r--r-- | debian/mongoperf.1 | 14 | ||||
| -rw-r--r-- | debian/mongorestore.1 | 301 | ||||
| -rw-r--r-- | debian/mongos.1 | 585 | ||||
| -rw-r--r-- | debian/mongosniff.1 | 33 | ||||
| -rw-r--r-- | debian/mongostat.1 | 215 | ||||
| -rw-r--r-- | debian/mongotop.1 | 273 |
14 files changed, 2773 insertions, 1562 deletions
diff --git a/debian/bsondump.1 b/debian/bsondump.1 index f91b910787e..892b46c92c2 100644 --- a/debian/bsondump.1 +++ b/debian/bsondump.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "BSONDUMP" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "BSONDUMP" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME bsondump \- MongoDB BSON Utility . @@ -44,6 +44,9 @@ BSON files, not a tool for data ingestion or other application use. .UNINDENT .UNINDENT .SH OPTIONS +.sp +Changed in version 3.0.0: \fBbsondump\fP removed the \fB\-\-filter\fP option. + .INDENT 0.0 .TP .B bsondump @@ -54,8 +57,8 @@ BSON files, not a tool for data ingestion or other application use. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBbsondump\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBbsondump\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -67,8 +70,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBbsondump\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBbsondump\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -110,20 +115,20 @@ incoming BSON documents. .UNINDENT .INDENT 0.0 .TP -.B \-\-filter <JSON> -Limits the documents that \fBbsondump\fP exports to only those -documents that match the \fIJSON document\fP specified as -\fB\(aq<JSON>\(aq\fP\&. Be sure to include the document in single quotes to avoid -interaction with your system\(aqs shell environment. -.UNINDENT -.INDENT 0.0 -.TP .B \-\-type <=json|=debug> Changes the operation of \fBbsondump\fP from outputting "\fIJSON\fP" (the default) to a debugging format. .UNINDENT .INDENT 0.0 .TP +.B \-\-pretty +New in version 3.0.0. + +.sp +Outputs documents in a pretty\-printed format JSON. +.UNINDENT +.INDENT 0.0 +.TP .B <bsonFilename> The final argument to \fBbsondump\fP is a document containing \fIBSON\fP\&. This data is typically generated by @@ -160,6 +165,6 @@ bsondump \-\-type=debug collection.bson .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongo.1 b/debian/mongo.1 index 651c521db64..62ed3d1e5b3 100644 --- a/debian/mongo.1 +++ b/debian/mongo.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGO" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGO" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongo \- MongoDB Shell . @@ -85,6 +85,19 @@ 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 the localhost. +.sp +To connect to a replica set, specify the \fBreplica set name\fP 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 .UNINDENT .INDENT 0.0 .TP @@ -95,22 +108,24 @@ As a result many options of the shell environment are not available. .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database -that uses authentication. Use in conjunction with the \fB\-\-username\fP and -\fB\-\-authenticationDatabase\fP options. +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 +last option and leave out the argument. .UNINDENT .INDENT 0.0 .TP .B \-\-help, \-h -Returns information on \fBmongo\fP options and usage. +Returns information on the options and use of \fBmongo\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -126,9 +141,9 @@ process. .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongo\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongo\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongo\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -163,6 +178,11 @@ mongo 10.8.8.10/test .fi .UNINDENT .UNINDENT +.sp +This syntax is the \fIonly\fP way to connect to a specific database. +.sp +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 @@ -202,28 +222,91 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongo\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. +.sp +If you do not specify a value for \fI\-\-authenticationDatabase\fP, \fBmongo\fP uses the database +specified in the connection string. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongo\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongo\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .SS SSL Options .INDENT 0.0 .TP .B \-\-ssl -New in version 2.6. +New in version 2.2. .sp Enables connection to a \fBmongod\fP or \fBmongos\fP that has @@ -235,17 +318,17 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslPEMKeyFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains both the SSL certificate and key. Specify the file name of the \fB\&.pem\fP file using relative or absolute paths. .sp -This option is required when using the \fI\-\-ssl\fP option to connect +This option is required when using the \fB\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -253,17 +336,18 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslPEMKeyPassword <value> -New in version 2.6. +New in version 2.4. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongo\fP will +\fB\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongo\fP will redact the password from all logging and reporting output. .sp -If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongo\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +Changed in version 2.6: 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 \fIssl\-certificate\-password\fP\&. + .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -271,7 +355,7 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslCAFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains the root certificate chain @@ -280,11 +364,26 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-sslCRLFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains the Certificate Revocation @@ -300,12 +399,18 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 2.6. .sp -Directs \fBmongo\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongo\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -315,12 +420,25 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongo\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.sp +The default distribution of MongoDB does not contain support for SSL. +For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.UNINDENT .SH FILES .INDENT 0.0 .TP @@ -770,9 +888,24 @@ mongo \-\-eval \(aqdb.collection.find().forEach(printjson)\(aq .sp Use single quotes (e.g. \fB\(aq\fP) to enclose the JavaScript, as well as the additional JavaScript required to generate this output. +.SH ADDITIONAL INFORMATION +.INDENT 0.0 +.IP \(bu 2 +http://docs.mongodb.org/manual/reference/mongo\-shell +.IP \(bu 2 +http://docs.mongodb.org/manual/reference/method +.IP \(bu 2 +http://docs.mongodb.org/manual/tutorial/access\-mongo\-shell\-help +.IP \(bu 2 +http://docs.mongodb.org/manual/tutorial/getting\-started\-with\-the\-mongo\-shell +.IP \(bu 2 +http://docs.mongodb.org/manual/core/shell\-types +.IP \(bu 2 +http://docs.mongodb.org/manual/tutorial/write\-scripts\-for\-the\-mongo\-shell +.UNINDENT .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongod.1 b/debian/mongod.1 index 4213ebd171b..b775b7004d5 100644 --- a/debian/mongod.1 +++ b/debian/mongod.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOD" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOD" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongod \- MongoDB Server . @@ -33,15 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBmongod\fP is the primary daemon process for the MongoDB -system. It handles data requests, manages data format, and performs +system. It handles data requests, manages data access, and performs background management operations. .sp This document provides a complete overview of all command line options -for \fBmongod\fP\&. These options are primarily useful for testing -purposes. In common operation, use the \fBconfiguration file +for \fBmongod\fP\&. These command line options are primarily useful +for testing: In common operation, use the \fBconfiguration file options\fP to control the behavior of -your database, which is fully capable of all operations described -below. +your database. .SH OPTIONS .SS Core Options .INDENT 0.0 @@ -51,7 +50,7 @@ below. .INDENT 0.0 .TP .B \-\-help, \-h -Returns information on \fBmongod\fP options and usage. +Returns information on the options and use of \fBmongod\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -60,15 +59,16 @@ Returns the \fBmongod\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-config <filename>, \-f +.B \-\-config <filename>, \-f <filename> 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 http://docs.mongodb.org/manual/reference/configuration\-options for more information. .sp -Ensure the configuration file uses ASCII encoding. \fBmongod\fP does not -support configuration files with non\-ASCII encoding, including UTF\-8. +Ensure the configuration file uses ASCII encoding. The \fBmongod\fP +instance does not support configuration files with non\-ASCII encoding, +including UTF\-8. .UNINDENT .INDENT 0.0 .TP @@ -80,8 +80,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongod\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongod\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -96,16 +98,22 @@ connection closed events .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-bind_ip <ip address> -Specifies the IP address that the \fBmongod\fP process binds to and -listens for connections on. By default \fBmongod\fP listens for -connections for all interfaces. You may attach \fBmongod\fP to any +\fIDefault\fP: All interfaces. +.sp +Changed in version 2.6.0: The \fBdeb\fP and \fBrpm\fP packages include a default +configuration file that sets \fI\-\-bind_ip\fP to \fB127.0.0.1\fP\&. + +.sp +Specifies the IP address that \fBmongod\fP binds to in order to listen +for connections from applications. You may attach \fBmongod\fP to any interface. When attaching \fBmongod\fP to a publicly accessible interface, ensure that you have implemented proper authentication and firewall restrictions to protect the integrity of your database. @@ -113,60 +121,80 @@ firewall restrictions to protect the integrity of your database. .INDENT 0.0 .TP .B \-\-maxConns <number> -Specifies the maximum number of simultaneous connections that -\fBmongod\fP will accept. This setting has no effect if it is -higher than your operating system\(aqs configured maximum connection -tracking threshold. +The maximum number of simultaneous connections that \fBmongod\fP will +accept. This setting has no effect if it is higher than your operating +system\(aqs configured maximum connection tracking threshold. .sp -Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxConns\fP setting. +Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxIncomingConnections\fP setting. .UNINDENT .INDENT 0.0 .TP .B \-\-syslog Sends all logging output to the host\(aqs \fIsyslog\fP system rather -than to standard output or a log file as with \fI\-\-logpath\fP\&. +than to standard output or to a log file. , as with \fI\-\-logpath\fP\&. .sp -\fI\-\-syslog\fP is not supported on Windows. +The \fI\-\-syslog\fP option is not supported on Windows. .UNINDENT .INDENT 0.0 .TP .B \-\-syslogFacility <string> -Specifies the facility level used when logging messages to syslog. The -default is \fBuser\fP\&. The value you specify must be supported by your +\fIDefault\fP: user +.sp +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 \-\-logpath <path> -Specifies the path for the log file that holds all diagnostic -logging information. +Sends all diagnostic logging information to a log file instead of to +standard output or to the host\(aqs \fIsyslog\fP system. MongoDB creates +the log file at the path you specify. .sp -Unless specified, \fBmongod\fP will output all log information -to the standard output. Additionally, unless you also specify -\fI\-\-logappend\fP, the logfile will be overwritten when the -process restarts. +By default, MongoDB overwrites the log file when the process restarts. +To instead append to the log file, set the \fI\-\-logappend\fP option. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-logappend +Appends new entries to the end of the log file rather than overwriting +the content of the log when the \fBmongod\fP instance restarts. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-logRotate <string> +\fIDefault\fP: rename .sp -\fBNOTE:\fP +New in version 3.0.0: Specifies the \fBlogRotate\fP behavior. + +.sp +Specify either \fBrename\fP or \fBreopen\fP\&. +.sp +\fBrename\fP renames the log file. +.sp +\fBreopen\fP closes and reopens the log file following the typical +Linux/Unix log rotate behavior. +Use \fBreopen\fP when using the Linux/Unix +logrotate utility to avoid log loss. +.sp +If you specify \fBreopen\fP, you must also use \fI\-\-logappend\fP\&. +.sp +\fBSEE ALSO:\fP .INDENT 7.0 .INDENT 3.5 -The behavior of the logging system may change in the near -future in response to the \fI\%SERVER\-4499\fP case. +http://docs.mongodb.org/manual/reference/command/logRotate\&. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-logappend -Appends new entries to the end of the logfile when the \fBmongod\fP restarts -instead of overwriting the content of the log. -.UNINDENT -.INDENT 0.0 -.TP .B \-\-timeStampFormat <string> -Specifies the time format for timestamps in log messages. Specify one of -the following values: +\fIDefault\fP: iso8601\-local +.sp +The time format for timestamps in log messages. Specify one of the +following values: .TS center; |l|l|. @@ -195,7 +223,7 @@ _ T{ \fBiso8601\-local\fP T} T{ -Default value. Displays timestamps in local time in the ISO\-8601 +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+0500\fP T} @@ -205,33 +233,34 @@ _ .INDENT 0.0 .TP .B \-\-diaglog <value> +\fIDefault\fP: 0 +.sp Deprecated since version 2.6. .sp \fI\%\-\-diaglog\fP is for internal use and not intended for most users. .sp -Creates a very verbose, \fIdiagnostic log\fP for troubleshooting and +Creates a very verbose \fIdiagnostic log\fP for troubleshooting and recording various errors. MongoDB writes these log files in the -\fBdbpath\fP directory in a series of files that begin with the +\fBdbPath\fP directory in a series of files that begin with the string \fBdiaglog\fP and end with the initiation time of the logging as a hex string. .sp -The specified value configures the level of verbosity. Possible values, -and their impact are as follows. +The specified value configures the level of verbosity: .TS center; |l|l|. _ T{ -\fBValue\fP +Value T} T{ -\fBSetting\fP +Setting T} _ T{ 0 T} T{ -off. No logging. +Off. No logging. T} _ T{ @@ -261,7 +290,7 @@ _ .TE .sp You can use the \fBmongosniff\fP tool to replay this output for -investigation. Given a typical diaglog file, located at +investigation. Given a typical diaglog file located at \fB/data/db/diaglog.4f76a58c\fP, you might use a command in the following form to read these files: .INDENT 7.0 @@ -281,7 +310,7 @@ mongosniff \-\-source DIAGLOG /data/db/diaglog.4f76a58c Setting the diagnostic level to \fB0\fP will cause \fBmongod\fP to stop writing data to the \fIdiagnostic log\fP file. However, the \fBmongod\fP instance will continue to keep the file open, -even if it is no longer writing data to the file. If you want to +even if it is no longer writing data to the file. If you want to rename, move, or delete the diagnostic log you must cleanly shut down the \fBmongod\fP instance before doing so. .UNINDENT @@ -295,69 +324,27 @@ For internal diagnostic use only. .INDENT 0.0 .TP .B \-\-pidfilepath <path> -Specifies a file location to hold the "\fIPID\fP" or process ID of the -\fBmongod\fP process. Useful for tracking the \fBmongod\fP process in -combination with the \fI\-\-fork\fP option. -.sp -Without a specified \fI\-\-pidfilepath\fP option, \fBmongod\fP -creates no PID file. +Specifies a file location to hold the process ID of the \fBmongod\fP +process where \fBmongod\fP will write its PID. This is useful for +tracking the \fBmongod\fP process in combination with the +\fI\-\-fork\fP option. Without a specified \fI\-\-pidfilepath\fP option, the +process creates no PID file. .UNINDENT .INDENT 0.0 .TP .B \-\-keyFile <file> -Specifies the path to a key file to store authentication -information. This option is used for interprocess authentication among -the \fBmongos\fP and \fBmongod\fP instances of a -\fIsharded cluster\fP or \fIreplica set\fP\&. +Specifies the path to a key file that stores the shared secret +that MongoDB instances use to authenticate to each other in a +\fIsharded cluster\fP or \fIreplica set\fP\&. \fI\-\-keyFile\fP implies +\fI\%\-\-auth\fP\&. See \fIinter\-process\-auth\fP for more +information. .UNINDENT .INDENT 0.0 .TP .B \-\-setParameter <options> -New in version 2.4. - -.sp -Specifies an option to configure on startup. Specify multiple options -with multiple \fI\-\-setParameter\fP options. See -http://docs.mongodb.org/manual/reference/parameters for full documentation of these parameters. -The \fBsetParameter\fP database command provides access to many -of these parameters. \fI\-\-setParameter\fP supports the following -options: -.INDENT 7.0 -.IP \(bu 2 -\fBenableLocalhostAuthBypass\fP -.IP \(bu 2 -\fBenableTestCommands\fP -.IP \(bu 2 -\fBjournalCommitInterval\fP -.IP \(bu 2 -\fBlogLevel\fP -.IP \(bu 2 -\fBlogUserIds\fP -.IP \(bu 2 -\fBnotablescan\fP -.IP \(bu 2 -\fBquiet\fP -.IP \(bu 2 -\fBreplApplyBatchSize\fP -.IP \(bu 2 -\fBreplIndexPrefetch\fP -.IP \(bu 2 -\fBsupportCompatibilityFormPrivilegeDocuments\fP -.IP \(bu 2 -\fBsyncdelay\fP -.IP \(bu 2 -\fBtextSearchEnabled\fP -.IP \(bu 2 -\fBtraceExceptions\fP -.IP \(bu 2 -\fBsaslauthdPath\fP -.IP \(bu 2 -\fBauthenticationMechanisms\fP -.IP \(bu 2 -\fBsslMode\fP -.IP \(bu 2 -\fBclusterAuthMode\fP -.UNINDENT +Specifies one of the MongoDB parameters described in +http://docs.mongodb.org/manual/reference/parameters\&. You can specify multiple \fBsetParameter\fP +fields. .UNINDENT .INDENT 0.0 .TP @@ -400,64 +387,17 @@ Authentication. .UNINDENT .INDENT 0.0 .TP -.B \-\-clusterAuthMode <option> -New in version 2.6. - -.sp -Enables \fIinternal x.509 authentication\fP for membership to the cluster or replica -set. The \fI\-\-clusterAuthMode\fP option can have one of the -following values: -.TS -center; -|l|l|. -_ -T{ -Value -T} T{ -Description -T} -_ -T{ -\fBkeyFile\fP -T} T{ -Default value. Use keyfile for authentication. -T} -_ -T{ -\fBsendKeyFile\fP -T} T{ -For rolling upgrade purposes. Send the keyfile for -authentication but can accept either keyfile or x.509 -certificate. -T} -_ -T{ -\fBsendX509\fP -T} T{ -For rolling upgrade purposes. Send the x.509 certificate for -authentication but can accept either keyfile or x.509 -certificate. -T} -_ -T{ -\fBx509\fP -T} T{ -Recommended. Send the x.509 certificate for authentication and -accept \fBonly\fP x.509 certificate. -T} -_ -.TE -.sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. -.UNINDENT -.INDENT 0.0 -.TP .B \-\-nounixsocket -Disables listening on the UNIX socket. \fBmongod\fP always -listens on the UNIX socket, unless either: \fI\-\-nounixsocket\fP -is set, \fBbind_ip\fP is not set, or \fBbind_ip\fP -does not specify \fB127.0.0.1\fP\&. +Disables listening on the UNIX domain socket. The \fBmongod\fP process +always listens on the UNIX socket unless one of the following is true: +.INDENT 7.0 +.IP \(bu 2 +\fI\-\-nounixsocket\fP is set +.IP \(bu 2 +\fBbindIp\fP is not set +.IP \(bu 2 +\fBbindIp\fP does not specify \fB127.0.0.1\fP +.UNINDENT .sp New in version 2.6: \fBmongod\fP installed from official \fB\&.deb\fP and \fB\&.rpm\fP packages have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by @@ -467,30 +407,42 @@ default. .INDENT 0.0 .TP .B \-\-unixSocketPrefix <path> -Specifies a path for the UNIX socket. If this option has no -value, \fBmongod\fP creates a socket with \fB/tmp\fP as a prefix. +\fIDefault\fP: /tmp .sp -MongoDB will always create and listen on a UNIX socket, unless -\fI\-\-nounixsocket\fP is set, \fBbind_ip\fP is not set, -or \fBbind_ip\fP does not specify \fB127.0.0.1\fP\&. +The path for the UNIX socket. If this option has no value, the +\fBmongod\fP process creates a socket with \fB/tmp\fP as a prefix. MongoDB +creates and listens on a UNIX socket unless one of the following is true: +.INDENT 7.0 +.IP \(bu 2 +\fI\-\-nounixsocket\fP is set +.IP \(bu 2 +\fBbindIp\fP is not set +.IP \(bu 2 +\fBbindIp\fP does not specify \fB127.0.0.1\fP +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-fork -Enables a \fIdaemon\fP mode for \fBmongod\fP that runs the -process in the background. This is the normal mode of operation in -production and production\-like environments but may not be -desirable for testing. +Enables a \fIdaemon\fP 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). .UNINDENT .INDENT 0.0 .TP .B \-\-auth -Enables database authentication for users connecting from remote -hosts. Configure users via the \fBmongo shell\fP\&. If no users exist, the localhost interface -will continue to have access to the database until the you create +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 \fBmongo shell\fP\&. If no users exist, the localhost interface +will continue to have access to the database until you create the first user. .sp -See \fBSecurity and Authentication\fP +See \fBSecurity\fP for more information. .UNINDENT .INDENT 0.0 @@ -502,65 +454,52 @@ compatibility and clarity. .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongod\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongod\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongod\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP .B \-\-jsonp -Permits \fIJSONP\fP access via an HTTP interface. Consider the -security implications of allowing this activity before enabling this -option. If the HTTP interface is disabled, the \fI\-\-jsonp\fP also -enables the HTTP interface. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\-\-httpinterface\fP -.UNINDENT -.UNINDENT +Permits \fIJSONP\fP access via an HTTP interface. Enabling the +interface can increase network exposure. The \fI\-\-jsonp\fP option enables the +HTTP interface, even if the \fBHTTP interface\fP +option is disabled. .UNINDENT .INDENT 0.0 .TP .B \-\-rest -Enables the simple \fIREST\fP API. Consider the security -implications of allowing this activity before enabling this option. -.sp -If the HTTP interface is disabled, the \fI\%\-\-rest\fP setting -also enables the HTTP interface. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\-\-httpinterface\fP to enable the HTTP interface. -.UNINDENT -.UNINDENT +Enables the simple \fIREST\fP API. Enabling the \fIREST\fP API +enables the HTTP interface, even if the \fBHTTP interface\fP option is disabled, and as a result can increase +network exposure. .UNINDENT .INDENT 0.0 .TP -.B \-\-slowms <value> -Defines the value of "slow," for the \fI\%\-\-profile\fP -option. The database logs all slow queries to the log, even when -the profiler is not turned on. When the database profiler is on, -\fBmongod\fP the profiler writes to the \fBsystem.profile\fP -collection. See the \fBprofile\fP command for more information on the -database profiler. +.B \-\-slowms <integer> +\fIDefault\fP: 100 +.sp +The threshold in milliseconds at which the database profiler considers a +query slow. MongoDB records all slow queries to the log, even when the +database profiler is off. When the profiler is on, it writes to the +\fBsystem.profile\fP collection. See the \fBprofile\fP command for +more information on the database profiler. .UNINDENT .INDENT 0.0 .TP .B \-\-profile <level> -Changes the level of database profiling, which inserts information -about operation performance into output of \fBmongod\fP or the log -file. The following levels are available: +\fIDefault\fP: 0 +.sp +Changes the level of database profiling, which inserts information about +operation performance into standard output or a log file. Specify one +of the following levels: .TS center; |l|l|. _ T{ -\fBLevel\fP +Level T} T{ -\fBSetting\fP +Setting T} _ T{ @@ -583,16 +522,14 @@ T} _ .TE .sp -Profiling is off by default. Database profiling can impact database +Database profiling can impact database performance. Enable this option only after careful consideration. .UNINDENT .INDENT 0.0 .TP .B \-\-cpu -Forces \fBmongod\fP to report the percentage of CPU time in -write lock. \fBmongod\fP generates output every four -seconds. MongoDB writes this data to standard output or the logfile -if using the \fBlogpath\fP option. +Forces the \fBmongod\fP process to report the percentage of CPU time in +write lock, every four seconds. .UNINDENT .INDENT 0.0 .TP @@ -603,23 +540,197 @@ and the number of available physical pages. .UNINDENT .INDENT 0.0 .TP +.B \-\-objcheck +Forces the \fBmongod\fP to validate all requests from clients upon +receipt to ensure that clients never insert invalid documents into the +database. For objects with a high degree of sub\-document nesting, the +\fI\-\-objcheck\fP option can have a small impact on performance. You can set +\fI\-\-noobjcheck\fP to disable object checking at runtime. +.sp +Changed in version 2.4: MongoDB enables the \fI\-\-objcheck\fP option by default in order to prevent +any client from inserting malformed or invalid BSON into a MongoDB +database. + +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-noobjcheck +New in version 2.4. + +.sp +Disables the default document validation that MongoDB performs on all +incoming BSON documents. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-noscripting +Disables the scripting engine. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-notablescan +Forbids operations that require a table 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 +\fBconfiguration file\fP and the +\fI\-\-config\fP option. +.sp +The \fI\%\-\-shutdown\fP option is available only on Linux systems. +.UNINDENT +.SS Storage Options +.INDENT 0.0 +.TP .B \-\-dbpath <path> -Specifies the directory where the \fBmongod\fP instance stores its -data. Typical locations include: \fB/srv/mongodb\fP, \fB/var/lib/mongodb\fP -or \fB/opt/mongodb\fP +\fIDefault\fP: \fB/data/db\fP on Linux and OS X, \fB\edata\edb\fP on Windows +.sp +The directory where the \fBmongod\fP instance stores its data. +.sp +If you +installed MongoDB using a package management system, check the +\fB/etc/mongodb.conf\fP file provided by your packages to see the +directory is specified. +.sp +Changed in version 3.0: 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 +start. + +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-storageEngine string +\fIDefault\fP: \fBmmapv1\fP +.sp +New in version 3.0.0. + +.sp +Specifies the storage engine for the \fBmongod\fP database. Valid +options include \fBmmapv1\fP and \fBwiredTiger\fP\&. +.sp +If you attempt to start a \fBmongod\fP with a +\fIstorage.dbPath\fP that contains data files produced by a +storage engine other than the one specified by \fI\%\-\-storageEngine\fP, \fBmongod\fP +will refuse to start. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerDirectoryForIndexes +\fIType\fP: boolean +.sp +\fIDefault\fP: false +.sp +New in version 3.0.0. + +.sp +When you start \fBmongod\fP with \fI\%\-\-wiredTigerDirectoryForIndexes\fP, \fBmongod\fP stores indexes +and collections in separate directories. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerCacheSizeGB number +\fIDefault\fP: the maximum of half of physical RAM or 1 gigabyte +.sp +New in version 3.0.0. + +.sp +Defines the maximum size of the cache that WiredTiger will use for +all data. Ensure that \fI\%\-\-wiredTigerCacheSizeGB\fP is sufficient to hold the entire +working set for the \fBmongod\fP instance. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerCheckpointDelaySecs <seconds> +\fIDefault\fP: 60 +.sp +New in version 3.0.0. + +.sp +Defines the interval between checkpoints when WiredTiger writes all +modified data to the data files in \fBdbPath\fP\&. If +the \fBmongod\fP exits between checkpoints and you do not have +\fBstorage.journal.enabled\fP set to \fBtrue\fP, any data +modified since the last checkpoint will not persist. The data files +are \fIalways\fP valid even if \fBmongod\fP exits between or during a +checkpoint. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerStatisticsLogDelaySecs <seconds> +\fIDefault\fP: 0 +.sp +New in version 3.0.0. + +.sp +When \fB0\fP WiredTiger will not log statistics. Otherwise WiredTiger +will log statistics to a file in the \fBdbPath\fP +on the interval defined by \fI\%\-\-wiredTigerStatisticsLogDelaySecs\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerJournalCompressor <compressor> +\fIDefault\fP: snappy +.sp +New in version 3.0.0. + +.sp +Specifies the type of compression to use to compress the journal +data (i.e. \fBstorage.journal\fP\&.) +.sp +Available compressors are: +.INDENT 7.0 +.IP \(bu 2 +\fBnone\fP +.IP \(bu 2 +\fIsnappy\fP +.IP \(bu 2 +\fIzlib\fP +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerCollectionBlockCompressor <compressor> +\fIDefault\fP: none +.sp +New in version 3.0.0. + +.sp +Specifies the default type of compression to use to compress index +data. You can override this on a per\-index basis when creating +indexes. +.sp +Available compressors are: +.INDENT 7.0 +.IP \(bu 2 +\fBnone\fP +.IP \(bu 2 +\fIsnappy\fP +.IP \(bu 2 +\fIzlib\fP +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-wiredTigerIndexPrefixCompression <boolean> +\fIDefault\fP: true +.sp +New in version 3.0.0. + .sp -Unless specified, \fBmongod\fP will look for data files in the default -\fB/data/db\fP directory. (Windows systems use the \fB\edata\edb\fP -directory.) If you installed using a package management system. Check -the \fB/etc/mongodb.conf\fP file provided by your packages to see the -configuration of the \fI\-\-dbpath\fP\&. +Specify \fBtrue\fP for \fI\%\-\-wiredTigerIndexPrefixCompression\fP to enable \fIprefix compression\fP for +index data. .UNINDENT .INDENT 0.0 .TP .B \-\-directoryperdb -Alters the storage pattern of the data directory to store each -database\(aqs files in a distinct folder. This option will create -directories within the \fI\-\-dbpath\fP named for each directory. +Stores each database\(aqs files in its own folder in the \fIdata +directory\fP\&. When applied to an existing system, the +\fI\%\-\-directoryperdb\fP option alters the storage pattern of the data +directory. .sp Use this option in conjunction with your file system and device configuration so that MongoDB will store data on a number of distinct @@ -628,16 +739,12 @@ disk devices to increase write throughput or disk capacity. \fBWARNING:\fP .INDENT 7.0 .INDENT 3.5 -If you have an existing \fBmongod\fP instance and -\fBdbpath\fP, and you want to enable -\fI\-\-directoryperdb\fP, you \fBmust\fP migrate your existing -databases to directories before setting \fI\-\-directoryperdb\fP -to access those databases. -.INDENT 0.0 -.INDENT 3.5 -.SS Example -.sp -Given a \fBdbpath\fP directory with the following items: +To enable this option for an \fBexisting\fP system, migrate the +database\-specific data files to the new directory structure before +enabling \fI\%\-\-directoryperdb\fP\&. Database\-specific data files +begin with the name of an existing database and end with either +"\fBns\fP" or a number. For example, the following data directory +includes files for the \fBlocal\fP and \fBtest\fP databases: .INDENT 0.0 .INDENT 3.5 .sp @@ -656,8 +763,7 @@ test.ns .UNINDENT .UNINDENT .sp -To enable \fI\-\-directoryperdb\fP you would need to modify the -\fBdbpath\fP to resemble the following: +After migration, the data directory would have the following structure: .INDENT 0.0 .INDENT 3.5 .sp @@ -678,68 +784,76 @@ test/test.ns .UNINDENT .UNINDENT .UNINDENT -.UNINDENT -.UNINDENT .INDENT 0.0 .TP .B \-\-noIndexBuildRetry -Stops \fBmongod\fP from rebuilding indexes on the next start\-up after the -program had shut down or stopped in the middle of an index build. +Stops the \fBmongod\fP from rebuilding incomplete indexes on the next +start up. This applies in cases where the \fBmongod\fP restarts after it +has shut down or stopped in the middle of an index build. In such cases, +the \fBmongod\fP always removes any incomplete indexes, and then also, by +default, attempts to rebuild them. To stop the \fBmongod\fP from +rebuilding incomplete indexes on start up, include this option on the +command\-line. .UNINDENT .INDENT 0.0 .TP .B \-\-noprealloc -Disables the preallocation of data files. This shortens the -start up time in some cases and can cause significant performance -penalties during normal operations. +Deprecated since version 2.6. + +.sp +Disables the preallocation of data files. Currently the default. +Exists for future compatibility and clarity. .UNINDENT .INDENT 0.0 .TP .B \-\-nssize <value> -Specifies the default size for namespace files (i.e \fB\&.ns\fP). This -option has no impact on the size of existing namespace files. The -maximum size is 2047 megabytes. +\fIDefault\fP: 16 +.sp +Specifies the default size for namespace files, which are files that end +in \fB\&.ns\fP\&. Each collection and index counts as a namespace. .sp -The default value is 16 megabytes, which provides for approximately -24,000 namespaces. Each collection, as well as each index, counts as -a namespace. +Use this setting to control size for newly created namespace files. This +option has no impact on existing files. The maximum size for a namespace +file is 2047 megabytes. The default value of 16 megabytes provides for +approximately 24,000 namespaces. .UNINDENT .INDENT 0.0 .TP .B \-\-quota Enables a maximum limit for the number data files each database can -have. When running with \fI\%\-\-quota\fP, there are a maximum of -8 data files per database. Adjust the quota with the -\fI\%\-\-quotaFiles\fP option. +have. When running with the \fI\%\-\-quota\fP option, MongoDB has a maximum of 8 +data files per database. Adjust the quota with +\fI\%\-\-quotaFiles\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-quotaFiles <number> -Modifies the limit on the number of data files per database. This -option requires the \fI\%\-\-quota\fP setting. The default value -for \fI\%\-\-quotaFiles\fP is 8. +\fIDefault\fP: 8 +.sp +Modifies the limit on the number of data files per database. \fI\%\-\-quotaFiles\fP +option requires that you set \fI\%\-\-quota\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-smallfiles -Enables a mode where MongoDB uses a smaller default file -size. Specifically, \fI\%\-\-smallfiles\fP reduces the initial -size for data files and limits them to 512 -megabytes. \fI\%\-\-smallfiles\fP also reduces the size of each -\fIjournal\fP files from 1 gigabyte to 128 megabytes. +Sets MongoDB to use a smaller default file size. The \fI\%\-\-smallfiles\fP option +reduces the initial size for data files and limits the maximum size to +512 megabytes. \fI\%\-\-smallfiles\fP also reduces the size of each \fIjournal\fP +file from 1 gigabyte to 128 megabytes. Use \fI\%\-\-smallfiles\fP if you have a large +number of databases that each holds a small quantity of data. .sp -Use \fI\%\-\-smallfiles\fP if you have a large number of databases -that each holds a small quantity of data. \fI\%\-\-smallfiles\fP can -lead your \fBmongod\fP to create a large number of files, -which may affect performance for larger databases. +The \fI\%\-\-smallfiles\fP option can lead the \fBmongod\fP instance to create a large +number of files, which can affect performance for larger databases. .UNINDENT .INDENT 0.0 .TP .B \-\-syncdelay <value> +\fIDefault\fP: 60 +.sp Controls how much time can pass before MongoDB flushes data to the data files via an \fIfsync\fP operation. \fBDo not set this value on -production systems.\fP In almost every situation you should not set this -value and use the default setting. +production systems.\fP In almost every situation, you should use the +default setting. .sp \fBWARNING:\fP .INDENT 7.0 @@ -749,10 +863,9 @@ memory mapped files to disk. .UNINDENT .UNINDENT .sp -\fBmongod\fP writes data very quickly to the journal and lazily to the -data files. The default \fBsyncdelay\fP setting is 60 seconds. -\fBsyncdelay\fP has no effect on the \fBjournal\fP files or -\fBjournaling\fP\&. +The \fBmongod\fP process writes data very quickly to the journal and +lazily to the data files. \fBsyncPeriodSecs\fP has no effect on the +\fBjournal\fP files or \fBjournaling\fP\&. .sp The \fBserverStatus\fP command reports the background flush thread\(aqs status via the \fBbackgroundFlushing\fP field. @@ -761,12 +874,12 @@ thread\(aqs status via the \fBbackgroundFlushing\fP field. .TP .B \-\-upgrade Upgrades the on\-disk data format of the files specified by the -\fI\-\-dbpath\fP to the latest version, if needed. +\fI\%\-\-dbpath\fP to the latest version, if needed. .sp -This option only affects the operation of \fBmongod\fP if the data files -are in an old format. +This option only affects the operation of the \fBmongod\fP if the data +files are in an old format. .sp -In most cases you should \fBnot\fP set this value, so you can exercise the +In most cases you should not set this value, so you can exercise the most control over your upgrade process. See the MongoDB \fI\%release notes\fP (on the download page) for more information about the upgrade process. .UNINDENT @@ -787,88 +900,61 @@ database files and/or reclaim disk space. Be aware that these operations remove and do not save any corrupt data during the repair process. .sp -If you are trying to repair a \fIreplica set\fP member, and you -have access to an intact copy of your data (e.g. a recent backup or -an intact member of the \fIreplica set\fP), you should restore -from that intact copy, and \fBnot\fP use \fBrepairDatabase\fP\&. +If you are trying to repair a \fIreplica set\fP member, and you have +access to an intact copy of your data (e.g. a recent backup or an +intact member of the \fIreplica set\fP), you should restore from that +intact copy, and \fBnot\fP use \fBrepairDatabase\fP\&. .UNINDENT .UNINDENT .sp When using \fIjournaling\fP, there is almost never any need to run \fBrepairDatabase\fP\&. In the event of an -unclean shutdown, the server will be able restore the data files +unclean shutdown, the server will be able to restore the data files to a pristine state automatically. .sp Changed in version 2.1.2. .sp -If you run the repair option \fIand\fP have data in a journal file, -\fBmongod\fP refuses to start. In these cases you should start -\fBmongod\fP without the \fI\-\-repair\fP option to allow \fBmongod\fP -to recover data from the journal. This completes more quickly and is -more likely to produce valid data files. To continue the repair -operation despite the journal files, shut down \fBmongod\fP cleanly and -restart with the \fI\-\-repair\fP option. +If you run the repair option \fIand\fP have data in a journal file, the +\fBmongod\fP instance refuses to start. In these cases you should start +the \fBmongod\fP without the \fI\-\-repair\fP option, which allows the +\fBmongod\fP to recover data from the journal. This completes more +quickly and is more likely to produce valid data files. To continue the +repair operation despite the journal files, shut down the \fBmongod\fP +cleanly and restart with the \fI\-\-repair\fP option. .sp -\fI\-\-repair\fP copies data from the source data files into new data -files in the \fBrepairpath\fP, and then replaces the original data -files with the repaired data files. \fIIf\fP \fBrepairpath\fP is on the -same device as \fBdbpath\fP, you \fImay\fP interrupt a \fBmongod\fP -running \fI\-\-repair\fP without affecting the integrity of the data -set. +The \fI\-\-repair\fP option copies data from the source data files into new data +files in the \fBrepairPath\fP and then replaces the original data +files with the repaired data files. .UNINDENT .INDENT 0.0 .TP .B \-\-repairpath <path> -Specifies the root directory containing MongoDB data files to use -for the \fI\-\-repair\fP operation. Defaults to a \fB_tmp\fP -directory within the \fBdbpath\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-objcheck -Forces the \fBmongod\fP to validate all requests from clients upon -receipt to ensure that clients never insert invalid documents into the -database. For objects with a high degree of sub\-document nesting, -\fI\-\-objcheck\fP can have a small impact on performance. You can set -\fI\-\-noobjcheck\fP to disable object checking at runtime. +\fIDefault\fP: A \fB_tmp\fP directory within the path specified by the +\fBdbPath\fP option. .sp -Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any -client from inserting malformed or invalid BSON into a MongoDB -database. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noobjcheck -New in version 2.4. - +Specifies a working directory that MongoDB will use during the +\fI\-\-repair\fP operation. After \fI\-\-repair\fP completes, +the data files in \fBdbPath\fP and the \fI\%\-\-repairpath\fP +directory is empty. .sp -Disables the default document validation that MongoDB performs on all -incoming BSON documents. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noscripting -Disables the scripting engine. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-notablescan -Forbids operations that require a table scan. +The \fI\%\-\-repairpath\fP must be within the \fBdbPath\fP\&. You can +specify a symlink to \fI\%\-\-repairpath\fP to use a path on a different file +system. .UNINDENT .INDENT 0.0 .TP .B \-\-journal -Enables operation journaling to ensure write durability and data file -validity. \fBmongod\fP enables journaling by default on -64\-bit builds of versions after 2.0. +Enables the durability \fIjournal\fP to ensure data files remain valid +and recoverable. This option applies only when you specify the +\fI\%\-\-dbpath\fP option. The \fBmongod\fP enables journaling by default +on 64\-bit builds of versions after 2.0. .UNINDENT .INDENT 0.0 .TP .B \-\-nojournal -Disables the durability journaling. By default, \fBmongod\fP -enables journaling in 64\-bit versions after v2.0. +Disables the durability journaling. The \fBmongod\fP instance +enables journaling by default in 64\-bit versions after v2.0. .UNINDENT .INDENT 0.0 .TP @@ -879,34 +965,24 @@ file integrity in the case of abnormal system shutdown. .INDENT 0.0 .TP .B \-\-journalCommitInterval <value> -Specifies the maximum amount of time for \fBmongod\fP to allow -between journal operations. Possible values are between 2 and 300 -milliseconds. Lower values increase the durability of the journal, -at the expense of disk performance. +\fIDefault\fP: 100 or 30 +.sp +The maximum amount of time the \fBmongod\fP process allows between +journal operations. Values can range from 2 to 300 milliseconds. Lower +values increase the durability of the journal, at the expense of disk +performance. .sp The default journal commit interval is 100 milliseconds if a single -block device (e.g. physical volume, RAID device, or LVM volume) -contains both the journal and the data files. +block device (e.g. physical volume, RAID device, or LVM volume) contains +both the journal and the data files. .sp If the journal is on a different block device than the data files the default journal commit interval is 30 milliseconds. .sp -To force \fBmongod\fP to commit to the journal more frequently, -you can specify \fBj:true\fP\&. When a write operation with \fBj:true\fP -is pending, \fBmongod\fP will reduce -\fBjournalCommitInterval\fP to a third of the set value. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shutdown -Used in \fIcontrol scripts\fP, the -\fI\%\-\-shutdown\fP 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 -\fBconfiguration file\fP and the -\fI\-\-config\fP option. -.sp -The \fI\%\-\-shutdown\fP option is available only on Linux systems. +To force \fBmongod\fP to commit to the journal more frequently, you +can specify \fBj:true\fP\&. When a write operation with \fBj:true\fP is +pending, \fBmongod\fP will reduce \fBcommitIntervalMs\fP +to a third of the set value. .UNINDENT .SS Replication Options .INDENT 0.0 @@ -915,49 +991,73 @@ The \fI\%\-\-shutdown\fP option is available only on Linux systems. 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 -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 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 -.UNINDENT -.UNINDENT .INDENT 0.0 .TP .B \-\-oplogSize <value> Specifies a maximum size in megabytes for the replication operation log -(e.g. \fIoplog\fP\&.) By \fBmongod\fP creates an \fIoplog\fP based on -the maximum amount of space available. For 64\-bit systems, the op log is -typically 5% of available disk space. Once the \fBmongod\fP has created -the oplog for the first time, changing \fI\%\-\-oplogSize\fP will not -affect the size of the oplog. +(i.e., the \fIoplog\fP). The \fBmongod\fP process creates an +\fIoplog\fP based on the maximum amount of space available. For 64\-bit +systems, the oplog is typically 5% of available disk space. Once the +\fBmongod\fP has created the oplog for the first time, changing the +\fI\%\-\-oplogSize\fP option will not affect the size of the oplog. +.sp +See \fIreplica\-set\-oplog\-sizing\fP for more information. .UNINDENT .INDENT 0.0 .TP .B \-\-replIndexPrefetch +\fIDefault\fP: all +.sp New in version 2.2. -.sp -You must use \fI\%\-\-replIndexPrefetch\fP in conjunction with -\fBreplSet\fP\&. The default value is \fBall\fP and available -options are: .INDENT 7.0 -.IP \(bu 2 +.INDENT 3.5 +.IP "Storage Engine Specific Feature" +.sp +\fI\%\-\-replIndexPrefetch\fP is only available with the \fBmmapv1\fP +storage engine. +.UNINDENT +.UNINDENT +.sp +Determines which indexes \fIsecondary\fP members of a \fIreplica +set\fP load into memory before applying operations from the oplog. By +default secondaries load all indexes related to an operation into memory +before applying operations from the oplog. This option can have one of +the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ \fBnone\fP -.IP \(bu 2 +T} T{ +Secondaries do not load indexes into memory. +T} +_ +T{ \fBall\fP -.IP \(bu 2 +T} T{ +Secondaries load all indexes related to an operation. +T} +_ +T{ \fB_id_only\fP -.UNINDENT -.sp -By default \fIsecondary\fP members of a \fIreplica set\fP will load -all indexes related to an operation into memory before applying -operations from the oplog. You can modify this behavior so that the -secondaries will only load the \fB_id\fP index. Specify \fB_id_only\fP or -\fBnone\fP to prevent the \fBmongod\fP from loading \fIany\fP index into -memory. +T} T{ +Secondaries load no additional indexes into memory beyond the +already existing \fB_id\fP index. +T} +_ +.TE .UNINDENT .SS Master\-Slave Replication .sp @@ -967,12 +1067,12 @@ replica sets are the preferred configuration for database replication. .INDENT 0.0 .TP .B \-\-master -Configures \fBmongod\fP to run as a replication \fImaster\fP\&. +Configures the \fBmongod\fP to run as a replication \fImaster\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-slave -Configures \fBmongod\fP to run as a replication \fIslave\fP\&. +Configures the \fBmongod\fP to run as a replication \fIslave\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -989,7 +1089,7 @@ specifies only a single \fIdatabase\fP to replicate. .INDENT 0.0 .TP .B \-\-slavedelay <value> -For use with the \fI\%\-\-slave\fP option, the \fB\-\-slavedelay\fP +For use with the \fI\%\-\-slave\fP option, the \fI\%\-\-slavedelay\fP option configures a "delay" in seconds, for this slave to wait to apply operations from the \fImaster\fP node. .UNINDENT @@ -997,30 +1097,23 @@ apply operations from the \fImaster\fP node. .TP .B \-\-autoresync For use with the \fI\%\-\-slave\fP option. When set, -\fI\%\-\-autoresync\fP option allows this slave to automatically +the \fI\%\-\-autoresync\fP option allows this slave to automatically resync if it is more than 10 seconds behind the master. This setting may be problematic if the \fI\%\-\-oplogSize\fP specifies a too small oplog. .sp If the \fIoplog\fP is not large enough to store the difference in -changes between the master\(aqs current state and the state of the -slave, this instance will forcibly resync itself -unnecessarily. When you set the \fBautoresync\fP option to -\fBfalse\fP, the slave will not attempt an automatic resync more than -once in a ten minute period. +changes between the master\(aqs current state and the state of the slave, +this instance will forcibly resync itself unnecessarily. If you don\(aqt +specify \fI\%\-\-autoresync\fP, the slave will not attempt an automatic resync more +than once in a ten minute period. .UNINDENT .INDENT 0.0 .TP .B \-\-fastsync In the context of \fIreplica set\fP replication, set this option -if you have seeded this member with a snapshot of the -\fIdbpath\fP of another member of the set. Otherwise the -\fBmongod\fP will attempt to perform an initial sync, -as though the member were a new member. -.sp -In the context of \fIreplica set\fP replication, set this option -if you have seeded this member with a snapshot of the -\fIdbpath\fP of another member of the set. Otherwise the +if you have seeded this member with an up\-to\-date copy of the entire +\fBdbPath\fP of another member of the set. Otherwise the \fBmongod\fP will attempt to perform an initial sync, as though the member were a new member. .sp @@ -1028,7 +1121,7 @@ as though the member were a new member. .INDENT 7.0 .INDENT 3.5 If the data is not perfectly synchronized \fIand\fP -\fBmongod\fP starts with \fBfastsync\fP, then the +the \fBmongod\fP starts with \fIfastsync\fP, then the secondary or slave will be permanently out of sync with the primary, which may cause significant consistency problems. .UNINDENT @@ -1040,19 +1133,19 @@ primary, which may cause significant consistency problems. .B \-\-configsvr Declares that this \fBmongod\fP instance serves as the \fIconfig database\fP of a sharded cluster. When running with -this option, clients will not be able to 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. +this option, clients (i.e. other cluster components) will not be +able to 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 -Changed in version 2.2: \fI\%\-\-configsvr\fP also sets \fI\%\-\-smallfiles\fP\&. +Changed in version 2.2: The \fI\%\-\-configsvr\fP option also sets \fI\%\-\-smallfiles\fP\&. .sp -Changed in version 2.4: \fI\%\-\-configsvr\fP creates a local \fIoplog\fP\&. +Changed in version 2.4: The \fI\%\-\-configsvr\fP option creates a local \fIoplog\fP\&. .sp -Do not use \fI\%\-\-configsvr\fP with \fI\%\-\-replSet\fP or +Do not use the \fI\%\-\-configsvr\fP option with \fI\%\-\-replSet\fP or \fI\%\-\-shardsvr\fP\&. Config servers cannot be a shard server or part of a \fIreplica set\fP\&. .UNINDENT @@ -1064,20 +1157,6 @@ partitioned cluster. The default port for these instances is \fB27018\fP\&. The only effect of \fI\%\-\-shardsvr\fP is to change the port number. .UNINDENT -.INDENT 0.0 -.TP -.B \-\-moveParanoia -New in version 2.4. - -.sp -During chunk migrations, \fI\%\-\-moveParanoia\fP forces the -\fBmongod\fP instances to save all documents migrated from this -shard in the \fBmoveChunk\fP directory of the \fBdbpath\fP\&. MongoDB -does not delete data from this directory. -.sp -Prior to 2.4, \fI\%\-\-moveParanoia\fP was the default behavior of -MongoDB. -.UNINDENT .SS SSL Options .INDENT 0.0 .INDENT 3.5 @@ -1089,12 +1168,16 @@ documentation of MongoDB\(aqs support. .UNINDENT .INDENT 0.0 .TP -.B \-\-ssl -New in version 2.6. +.B \-\-sslOnNormalPorts +Deprecated since version 2.6. .sp -Enables connection to a \fBmongod\fP or \fBmongos\fP that has -SSL support enabled. +Enables SSL for \fBmongod\fP\&. +.sp +With \fI\-\-sslOnNormalPorts\fP, a \fBmongod\fP requires SSL encryption for all +connections on the default MongoDB port, or the port specified by +\fI\-\-port\fP\&. By default, \fI\-\-sslOnNormalPorts\fP is +disabled. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -1105,8 +1188,8 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 2.6. .sp -Enables SSL or mixed SSL on a port. The argument to the -\fI\-\-sslMode\fP option can be one of the following: +Enables SSL or mixed SSL used for all network connections. The +argument to the \fI\-\-sslMode\fP option can be one of the following: .TS center; |l|l|. @@ -1151,17 +1234,14 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslPEMKeyFile <filename> -New in version 2.6. +New in version 2.2. .sp Specifies the \fB\&.pem\fP file that contains both the SSL certificate and key. Specify the file name of the \fB\&.pem\fP file using relative or absolute paths. .sp -This option is required when using the \fI\-\-ssl\fP option to connect -to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +When SSL is enabled, you must specify \fI\-\-sslPEMKeyFile\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -1169,17 +1249,74 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslPEMKeyPassword <value> -New in version 2.6. +New in version 2.2. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongod\fP will +\fB\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongod\fP will redact the password from all logging and reporting output. .sp -If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongod\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +Changed in version 2.6: If the private key in the PEM file is encrypted and you do not +specify the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongod\fP will prompt for a +passphrase. See \fIssl\-certificate\-password\fP\&. + +.sp +The default distribution of MongoDB does not contain support for SSL. +For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-clusterAuthMode <option> +\fIDefault\fP: keyFile +.sp +New in version 2.6. + +.sp +The authentication mode used for cluster authentication. If you use +\fIinternal x.509 authentication\fP, +specify so here. This option can have one of the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBkeyFile\fP +T} T{ +Use a keyfile for authentication. +Accept only keyfiles. +T} +_ +T{ +\fBsendKeyFile\fP +T} T{ +For rolling upgrade purposes. Send a keyfile for +authentication but can accept both keyfiles and x.509 +certificates. +T} +_ +T{ +\fBsendX509\fP +T} T{ +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{ +Recommended. Send the x.509 certificate for authentication and +accept only x.509 certificates. +T} +_ +.TE .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -1194,8 +1331,13 @@ Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key file for \fImembership authentication\fP for the cluster or replica set. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +If \fI\-\-sslClusterFile\fP does not specify the \fB\&.pem\fP file for internal cluster +authentication, the cluster uses the \fB\&.pem\fP file specified in the +\fI\-\-sslPEMKeyFile\fP option. +.sp +The default distribution of MongoDB does not contain support for +SSL. For more information on MongoDB and SSL, see +http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. .UNINDENT .INDENT 0.0 .TP @@ -1204,15 +1346,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the x.509 certificate\-key file -specified with \fI\-\-sslClusterFile\fP\&. Use -\fI\-\-sslClusterPassword\fP only if the certificate\-key file is -encrypted. In all cases, \fBmongod\fP will redact the password from all -logging and reporting output. -.sp -Changed in version 2.6: If the x.509 key file is encrypted and you do -not specify \fI\-\-sslClusterPassword\fP, \fBmongod\fP will prompt -for a passphrase. See \fIssl\-certificate\-password\fP\&. - +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 +will redact the password from all logging and reporting output. +.sp +If the x.509 key file is encrypted and you do not specify the +\fI\-\-sslClusterPassword\fP option, the \fBmongod\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -1220,7 +1360,7 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslCAFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains the root certificate chain @@ -1229,11 +1369,26 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fI\-\-sslCAFile\fP option and its target +file are not specified, x.509 client and member authentication will not +function. \fBmongod\fP, and \fBmongos\fP in sharded systems, +will not be able to verify the certificates of processes connecting to it +against the trusted certificate authority (CA) that issued them, breaking +the certificate chain. +.sp +As of version 2.6.4, \fBmongod\fP will not start with x.509 +authentication enabled if the CA file is not specified. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-sslCRLFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains the Certificate Revocation @@ -1249,34 +1404,53 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 2.6. .sp -Bypasses the validation checks for server certificates and allows -the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a -warning the use of the invalid certificate. +Bypasses the validation checks for SSL certificates on other servers +in the cluster and allows the use of invalid certificates. When using +the \fBallowInvalidCertificates\fP setting, MongoDB +logs as a warning the use of the invalid certificate. +.sp +The default distribution of MongoDB does not contain support for SSL. +For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates, when +connecting to other \fBmongod\fP instances for inter\-process +authentication. This allows \fBmongod\fP to connect to other +\fBmongod\fP instances if the hostnames in their certificates do not +match their configured hostname. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-sslWeakCertificateValidation +.B \-\-sslAllowConnectionsWithoutCertificates New in version 2.4. .sp +Changed in version 3.0.0: \fB\-\-sslAllowConnectionsWithoutCertificates\fP became \fI\%\-\-sslAllowConnectionsWithoutCertificates\fP\&. For +compatibility, MongoDB processes continue to accept +\fB\-\-sslAllowConnectionsWithoutCertificates\fP, but all users should +update their configuration files. + +.sp Disables the requirement for SSL certificate validation that -\fI\-\-sslCAFile\fP enables. With -\fI\-\-sslWeakCertificateValidation\fP, \fBmongod\fP will accept -connections when the client does not present a certificate when -establishing the connection. +\fB\-\-sslCAFile\fP enables. With the \fI\%\-\-sslAllowConnectionsWithoutCertificates\fP option, the \fBmongod\fP +will accept connections when the client does not present a certificate +when establishing the connection. .sp -If the client presents a certificate and \fBmongod\fP has -\fI\-\-sslWeakCertificateValidation\fP enabled, \fBmongod\fP will -validate the certificate using the root certificate chain specified by -\fI\-\-sslCAFile\fP and reject clients with invalid certificates. +If the client presents a certificate and the \fBmongod\fP has \fI\%\-\-sslAllowConnectionsWithoutCertificates\fP +enabled, the \fBmongod\fP will validate the certificate using the root +certificate chain specified by \fB\-\-sslCAFile\fP and reject clients +with invalid certificates. .sp -Use \fI\-\-sslWeakCertificateValidation\fP if you have a mixed -deployment that includes clients that do not or cannot present -certificates to \fBmongod\fP\&. +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 The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -1284,22 +1458,31 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslFIPSMode -New in version 2.6. +New in version 2.4. .sp -Directs \fBmongod\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongod\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .SS Audit Options .INDENT 0.0 .TP .B \-\-auditDestination -Enables auditing. The \fI\-\-auditDestination\fP option can have one of -the following values: +New in version 2.6. + +.sp +Enables \fBauditing\fP\&. The \fI\-\-auditDestination\fP option can +have one of the following values: .TS center; |l|l|. @@ -1317,9 +1500,9 @@ 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 -The syslog message limit can result in the truncation of the audit -messages. The auditing system will neither detect the truncation nor -error upon its occurrence. +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{ @@ -1341,17 +1524,18 @@ _ \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-auditFormat -Specifies the format of the output file if -\fI\-\-auditDestination\fP is \fBfile\fP\&. The -\fI\-\-auditFormat\fP can have one of the following values: +New in version 2.6. + +.sp +Specifies the format of the output file for \fBauditing\fP if \fI\-\-auditDestination\fP is \fBfile\fP\&. The +\fI\-\-auditFormat\fP option can have one of the following values: .TS center; |l|l|. @@ -1384,66 +1568,79 @@ performance more than printing to a file in BSON format. \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\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 option can take -either a full path name or a relative path name. +New in version 2.6. + +.sp +Specifies the output file for \fBauditing\fP if +\fI\-\-auditDestination\fP has value of \fBfile\fP\&. The \fI\-\-auditPath\fP +option can take either a full path name or a relative path name. .sp \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-auditFilter -Specifies the filter to limit the \fItypes of operations\fP the audit system records. The option -takes a document of the form: +New in version 2.6. + +.sp +Specifies the filter to limit the \fItypes of operations\fP the \fBaudit system\fP records. The option takes a string representation +of a query document of the form: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -{ atype: <expression> } +{ <field1>: <expression1>, ... } .ft P .fi .UNINDENT .UNINDENT .sp -For authentication operations, the option can also take a document of -the form: -.INDENT 7.0 -.INDENT 3.5 +The \fB<field>\fP can be \fBany field in the audit message\fP, including fields returned in the +\fIparam\fP document. The +\fB<expression>\fP is a \fIquery condition expression\fP\&. .sp -.nf -.ft C -{ atype: <expression>, "param.db": <database> } -.ft P -.fi -.UNINDENT -.UNINDENT +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 \fBconfiguration file\fP, you must use the YAML format of +the configuration file. .sp \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT +.SS SNMP Options +.INDENT 0.0 +.TP +.B \-\-snmp\-subagent +Runs SNMP as a subagent. For more information, see +http://docs.mongodb.org/manual/tutorial/monitor\-with\-snmp\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-snmp\-master +Runs SNMP as a master. For more information, see +http://docs.mongodb.org/manual/tutorial/monitor\-with\-snmp\&. +.UNINDENT .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongodump.1 b/debian/mongodump.1 index 99cdc68abe4..fe94bb83f75 100644 --- a/debian/mongodump.1 +++ b/debian/mongodump.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGODUMP" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGODUMP" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongodump \- MongoDB Data Dump Utility . @@ -33,7 +33,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBmongodump\fP is a utility for creating a binary export of the -contents of a database. Consider using this utility as part an +contents of a database. Consider using this utility as part of an effective \fBbackup strategy\fP\&. Use \fBmongodump\fP in conjunction with \fBmongorestore\fP to restore databases. @@ -64,25 +64,33 @@ where the \fIsharded cluster\fP consists of \fIreplica sets\fP, the \fIread pref from \fIsecondary\fP members of the set. .sp Changed in version 2.2: When used in combination with \fBfsync\fP or -\fBdb.fsyncLock()\fP, \fBmongod\fP may block some +\fBdb.fsyncLock()\fP, \fBmongod\fP will block reads, including those from \fBmongodump\fP, when queued write operation waits behind the \fBfsync\fP -lock. +lock. Do not use \fBmongodump\fP with +\fBdb.fsyncLock()\fP\&. +.sp +\fBmongodump\fP overwrites output files if they exist in the +backup data folder. Before running the \fBmongodump\fP command +multiple times, either ensure that you no longer need the files in the +output folder (the default is the \fBdump/\fP folder) or rename the +folders or files. .SH REQUIRED ACCESS .SS Backup Collections .sp To backup all the databases in a cluster via \fBmongodump\fP, you should have the \fBbackup\fP role. The \fBbackup\fP role provides -all the needed privileges for backing up all database. The role confers no +the required privileges for backing up all databases. The role confers no additional access, in keeping with the policy of \fIleast privilege\fP\&. .sp To backup a given database, you must have \fBread\fP access on the database. Several roles provide this access, including the \fBbackup\fP role. .sp -To backup the \fBsystem.profile\fP collection in a database, you must have -\fBread\fP access on certain system collections in the database. Several roles -provide this access, including the \fBclusterAdmin\fP and +To backup the \fBsystem.profile\fP +collection, which is created when you activate \fIdatabase profiling\fP, you must have \fBadditional\fP +\fBread\fP access on this collection. Several +roles provide this access, including the \fBclusterAdmin\fP and \fBdbAdmin\fP roles. .SS Backup Users .sp @@ -104,6 +112,11 @@ To backup the user\-defined roles on a database, you must have the \fBadmin.system.roles\fP collection. Both the \fBbackup\fP and \fBuserAdminAnyDatabase\fP roles provide this privilege. .SH OPTIONS +.sp +Changed in version 3.0.0: \fBmongodump\fP removed the \fB\-\-dbpath\fP as well as related +\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use +\fBmongodump\fP while connected to a \fBmongod\fP instance. + .INDENT 0.0 .TP .B mongodump @@ -114,8 +127,8 @@ To backup the user\-defined roles on a database, you must have the .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongodump\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongodump\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -127,8 +140,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongodump\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongodump\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -147,19 +162,22 @@ Returns the \fBmongodump\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> +\fIDefault\fP: localhost:27017 +.sp Specifies a resolvable hostname for the \fBmongod\fP to which to -connect. By default \fBmongodump\fP attempts to connect to a MongoDB instance -running on the localhost on port number \fB27017\fP\&. +connect. By default, the \fBmongodump\fP attempts to connect to a MongoDB +instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the +\fBreplSetName\fP and a seed list of set members, as in +the following: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -167,20 +185,26 @@ seed list of set members. Use the following format: .sp You can always connect directly to a single MongoDB instance by specifying the host and port number directly. +.sp +Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must +enclose the portion of an address and port combination in +brackets (e.g. \fB[<address>]\fP). + .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongodump\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongodump\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongodump\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -206,6 +230,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -219,8 +258,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -232,13 +271,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongodump\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongodump\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongodump\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongodump\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -264,7 +303,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -272,100 +311,191 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongodump\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongodump\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongodump\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongodump\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationDatabase <dbname> -New in version 2.4. - -.sp -Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongodump\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongodump\fP +assumes that the database specified to export holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongodump\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath <path> -Specifies the directory of the MongoDB data files. If used, the -\fI\-\-dbpath\fP option enables \fBmongodump\fP to attach directly to local data -files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, -\fBmongodump\fP locks access to the data directory. No \fBmongod\fP can -access the same path while the process runs. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongodump\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE .UNINDENT .INDENT 0.0 .TP -.B \-\-directoryperdb -When used in conjunction with the corresponding option in -\fBmongod\fP, allows \fBmongodump\fP to access data from MongoDB -instances that use an on\-disk format where every database has a distinct -directory. This option is only relevant when specifying the -\fI\-\-dbpath\fP option. +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Allows \fBmongodump\fP operations to use the durability \fIjournal\fP to -ensure data files remain valid and recoverable. This option is only -relevant when specifying the \fI\-\-dbpath\fP option. +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-db <database>, \-d +.B \-\-db <database>, \-d <database> Specifies a database to backup. If you do not specify a database, \fBmongodump\fP copies all databases in this instance into the dump files. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c +.B \-\-collection <collection>, \-c <collection> Specifies a collection to backup. If you do not specify a collection, this option copies all collections in the specified database or instance to the dump files. .UNINDENT .INDENT 0.0 .TP -.B \-\-out <path>, \-o -Specifies the directory where \fBmongodump\fP saves the output of -the database dump. By default, \fBmongodump\fP saves output files -in a directory named \fBdump\fP in the current working directory. +.B \-\-query <json>, \-q <json> +Provides a \fIJSON document\fP as a query that optionally limits the +documents included in the output of \fBmongodump\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-forceTableScan +Forces \fBmongodump\fP to scan the data store directly: typically, +\fBmongodump\fP saves entries as they appear in the index of +the \fB_id\fP field. If you specify a query \fI\-\-query\fP, +\fBmongodump\fP will use the most appropriate index to support that query. +.sp +Use \fI\-\-forceTableScan\fP to skip the index and scan the data directly. Typically +there are two cases where this behavior is preferable to the +default: +.INDENT 7.0 +.IP 1. 3 +If you have key sizes over 800 bytes that would not be present in the +\fB_id\fP index. +.IP 2. 3 +Your database uses a custom \fB_id\fP field. +.UNINDENT +.sp +When you run with \fI\-\-forceTableScan\fP, \fBmongodump\fP does +not use \fB$snapshot\fP\&. As a result, the dump produced by +\fBmongodump\fP can reflect the state of the database at many +different points in time. +.sp +\fBIMPORTANT:\fP +.INDENT 7.0 +.INDENT 3.5 +Use \fI\-\-forceTableScan\fP with extreme caution and +consideration. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-out <path>, \-o <path> +Specifies the directory where \fBmongodump\fP will write +\fIBSON\fP files for the dumped databases. By default, +\fBmongodump\fP saves output files in a directory named +\fBdump\fP in the current working directory. .sp To send the database dump to standard output, specify "\fB\-\fP" instead of a path. Write to standard output if you want process the output before @@ -376,9 +506,22 @@ directly. .UNINDENT .INDENT 0.0 .TP -.B \-\-query <json>, \-q -Provides a \fIJSON document\fP as a query that optionally limits the -documents included in the output of \fBmongodump\fP\&. +.B \-\-repair +Runs a repair option in addition to dumping the +database. The repair option changes the behavior of \fBmongodump\fP to +only write valid data and exclude data that may be in +an invalid state as a result of an improper shutdown or +\fBmongod\fP crash. +.sp +The \fI\%\-\-repair\fP option uses aggressive data\-recovery algorithms +that may produce a large amount of duplication. +.sp +\fI\%\-\-repair\fP is only available for use with \fBmongod\fP +instances using the \fBmmapv1\fP storage engine. You cannot run +\fI\%\-\-repair\fP with \fBmongos\fP or with \fBmongod\fP instances +that use the \fBwiredTiger\fP storage engine. To repair data in a +\fBmongod\fP instance using \fBwiredTiger\fP use +\fImongod \-\-repair\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -409,52 +552,28 @@ individual shards. .UNINDENT .INDENT 0.0 .TP -.B \-\-repair -Runs a repair option in addition to dumping the -database. The repair option attempts to repair a database that may be in -an invalid state as a result of an improper shutdown or -\fBmongod\fP crash. -.sp -The \fI\%\-\-repair\fP option uses aggressive data\-recovery algorithms -that may produce a large amount of duplication. +.B \-\-dumpDbUsersAndRoles +Includes user and role definitions when performing \fBmongodump\fP +on a specific database. This option applies only when you specify a +database in the \fI\-\-db\fP option. MongoDB always includes user and +role definitions when \fBmongodump\fP applies to an entire instance +and not just a specific database. .UNINDENT .INDENT 0.0 .TP -.B \-\-forceTableScan -Forces \fBmongodump\fP to scan the data store directly: typically, -\fBmongodump\fP saves entries as they appear in the index of the -\fB_id\fP field. Use \fI\-\-forceTableScan\fP to skip the index and scan -the data directly. Typically there are two cases where this behavior is -preferable to the default: -.INDENT 7.0 -.IP 1. 3 -If you have key sizes over 800 bytes that would not be present in the -\fB_id\fP index. -.IP 2. 3 -Your database uses a custom \fB_id\fP field. -.UNINDENT -.sp -When you run with \fI\-\-forceTableScan\fP, \fBmongodump\fP does -not use \fB$snapshot\fP\&. As a result, the dump produced by -\fBmongodump\fP can reflect the state of the database at many -different points in time. +.B \-\-excludeCollection array of strings +New in version 3.0.0. + .sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Use \fI\-\-forceTableScan\fP with extreme caution and -consideration. -.UNINDENT -.UNINDENT +Specifies collections to exclude from the output of \fBmongodump\fP output. .UNINDENT .INDENT 0.0 .TP -.B \-\-dumpDbUsersAndRoles -Includes user and role definitions when performing \fBmongodump\fP -on a specific database. This option applies only when you specify a -database in the \fI\-\-db\fP option. MongoDB always includes user and -role definitions when \fBmongodump\fP applies to an entire instance -and not just a specific database. +.B \-\-excludeCollectionsWithPrefix array of strings +New in version 3.0.0. + +.sp +Excludes all collections from the output of \fBmongodump\fP with a specified prefix. .UNINDENT .SH USE .sp @@ -473,28 +592,13 @@ this case the database is running on the local interface on port .sp .nf .ft C -mongodump \-\-collection collection \-\-db test -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -In the next example, \fBmongodump\fP creates a backup of the -database instance stored in the \fB/srv/mongodb\fP directory on the -local machine. This requires that no \fBmongod\fP instance is -using the \fB/srv/mongodb\fP directory. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongodump \-\-dbpath /srv/mongodb +mongodump \-\-db test \-\-collection collection .ft P .fi .UNINDENT .UNINDENT .sp -In the final example, \fBmongodump\fP creates a database dump +In the next example, \fBmongodump\fP creates a database dump located at \fB/opt/backup/mongodump\-2011\-10\-24\fP, from a database running on port \fB37017\fP on the host \fBmongodb1.example.net\fP and authenticating using the username \fBuser\fP and the password @@ -512,6 +616,6 @@ mongodump \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-pas .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongoexport.1 b/debian/mongoexport.1 index 5fc8182310a..e74a5124d4b 100644 --- a/debian/mongoexport.1 +++ b/debian/mongoexport.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOEXPORT" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOEXPORT" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongoexport \- MongoDB Export Utility . @@ -46,6 +46,15 @@ data type information. Use \fBmongodump\fP and \fBmongorestore\fP as described in http://docs.mongodb.org/manual/core/backups for this kind of functionality. .SH OPTIONS +.sp +Changed in version 3.0.0: \fBmongoexport\fP removed the \fB\-\-dbpath\fP as well as related +\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use +\fBmongoexport\fP while connected to a \fBmongod\fP instance. + +.sp +Changed in version 3.0.0: \fBmongoexport\fP also removed support for writing data to +\fBtsv\fP files with the \fB\-\-tsv\fP option. + .INDENT 0.0 .TP .B mongoexport @@ -56,8 +65,8 @@ kind of functionality. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongoexport\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongoexport\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -69,8 +78,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongoexport\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongoexport\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -89,19 +100,22 @@ Returns the \fBmongoexport\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> +\fIDefault\fP: localhost:27017 +.sp Specifies a resolvable hostname for the \fBmongod\fP to which to -connect. By default \fBmongoexport\fP attempts to connect to a MongoDB instance -running on the localhost on port number \fB27017\fP\&. +connect. By default, the \fBmongoexport\fP attempts to connect to a MongoDB +instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the +\fBreplSetName\fP and a seed list of set members, as in +the following: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -109,20 +123,26 @@ seed list of set members. Use the following format: .sp You can always connect directly to a single MongoDB instance by specifying the host and port number directly. +.sp +Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must +enclose the portion of an address and port combination in +brackets (e.g. \fB[<address>]\fP). + .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongoexport\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongoexport\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongoexport\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -148,6 +168,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -161,8 +196,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -174,13 +209,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongoexport\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongoexport\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongoexport\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongoexport\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -206,7 +241,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -214,97 +249,149 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongoexport\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongoexport\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongoexport\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongoexport\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationDatabase <dbname> -New in version 2.4. - -.sp -Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongoexport\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongoexport\fP +assumes that the database specified to export holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongoexport\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath <path> -Specifies the directory of the MongoDB data files. If used, the -\fI\-\-dbpath\fP option enables \fBmongoexport\fP to attach directly to local data -files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, -\fBmongoexport\fP locks access to the data directory. No \fBmongod\fP can -access the same path while the process runs. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb -When used in conjunction with the corresponding option in -\fBmongod\fP, allows \fBmongoexport\fP to export data from -MongoDB instances that have every database\(aqs files saved in discrete -directories on the disk. This option is only relevant when specifying -the \fI\-\-dbpath\fP option. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongoexport\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Allows \fBmongoexport\fP operations to use the durability \fIjournal\fP to -ensure data files remain valid and recoverable. This option is only -relevant when specifying the \fI\-\-dbpath\fP option. +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-db <database>, \-d -Specifies the name of the database on which to run \fBmongoexport\fP\&. +.B \-\-db <database>, \-d <database> +Specifies the name of the database on which to run the \fBmongoexport\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c +.B \-\-collection <collection>, \-c <collection> Specifies the collection to export. .UNINDENT .INDENT 0.0 .TP -.B \-\-fields <field1[,field2]>, \-f +.B \-\-fields <field1[,field2]>, \-f <field1[,field2]> Specifies a field or fields to \fIinclude\fP in the export. Use a comma separated list of fields to specify multiple fields. .sp -For \fI\-\-csv\fP output formats, +For \fIcsv\fP output formats, \fBmongoexport\fP includes only the specified field(s), and the specified field(s) can be a field within a sub\-document. .sp @@ -317,10 +404,11 @@ its fields, not just the specified field within the document. .INDENT 0.0 .TP .B \-\-fieldFile <filename> -As an alternative to \fI\-\-fields\fP, the +An alternative to \fI\-\-fields\fP\&. The \fI\-\-fieldFile\fP option allows you to specify in a file the field or fields to \fIinclude\fP in the export and is -\fBonly valid\fP with the \fI\-\-csv\fP option. The +\fBonly valid\fP with the \fI\-\-type\fP option +with value \fBcsv\fP\&. The file must have only one field per line, and the line(s) must end with the LF character (\fB0x0A\fP). .sp @@ -329,7 +417,7 @@ specified field(s) can be a field within a sub\-document. .UNINDENT .INDENT 0.0 .TP -.B \-\-query <JSON>, \-q +.B \-\-query <JSON>, \-q <JSON> Provides a \fIJSON document\fP as a query that optionally limits the documents returned in the export. Specify JSON in \fBstrict format\fP\&. @@ -359,7 +447,7 @@ export only the documents with the field \fBa\fP greater than or equal to .sp .nf .ft C -mongoexport \-d test \-c records \-q "{ a: { \e$gte: 3 } } }" \-\-out exportdir/myRecords.json +mongoexport \-d test \-c records \-q "{ a: { \e$gte: 3 } }" \-\-out exportdir/myRecords.json .ft P .fi .UNINDENT @@ -383,18 +471,22 @@ You can sort the results with the \fI\%\-\-sort\fP option to .UNINDENT .INDENT 0.0 .TP -.B \-\-csv -Changes the export format to a comma\-separated\-values (CSV) -format. By default \fBmongoexport\fP writes data using one -\fIJSON\fP document for every MongoDB document. +.B \-\-type <string> +\fIDefault\fP: json +.sp +New in version 3.0.0. + +.sp +Specifies the file type to export. The default format is \fIJSON\fP, +bit it is possible to export \fIcsv\fP files. .sp -If you specify \fI\%\-\-csv\fP, then you must also use either +If you specify \fBcsv\fP, then you must also use either the \fI\-\-fields\fP or the \fI\-\-fieldFile\fP option to declare the fields to export from the collection. .UNINDENT .INDENT 0.0 .TP -.B \-\-out <file>, \-o +.B \-\-out <file>, \-o <file> Specifies a file to write the export to. If you do not specify a file name, the \fBmongoexport\fP writes data to standard output (e.g. \fBstdout\fP). @@ -409,6 +501,14 @@ for every MongoDB document. .UNINDENT .INDENT 0.0 .TP +.B \-\-pretty +New in version 3.0.0. + +.sp +Outputs documents in a pretty\-printed format JSON. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-slaveOk, \-k Allows \fBmongoexport\fP to read data from secondary or slave nodes when using \fBmongoexport\fP with a replica set. This @@ -525,31 +625,6 @@ mongoexport \-\-db sales \-\-collection contacts \-\-out contacts.json \-\-journ .fi .UNINDENT .UNINDENT -.SS Export Collection Directly From Data Files -.sp -The following example exports the collection \fBcontacts\fP from the -\fBsales\fP database located in the MongoDB data files located at -\fB/srv/mongodb/\fP\&. This operation writes the export to standard output -in \fIJSON\fP format. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongoexport \-\-db sales \-\-collection contacts \-\-dbpath /srv/mongodb/ -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 0.0 -.INDENT 3.5 -The above example will only succeed if there is no \fBmongod\fP -connected to the data files located in the \fB/srv/mongodb/\fP -directory. -.UNINDENT -.UNINDENT .SS Export from Remote Host Running with Authentication .sp The following example exports the collection \fBcontacts\fP from the @@ -575,8 +650,8 @@ mongoexport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-p preserve all rich \fIBSON\fP data types because \fIJSON\fP can only represent a subset of the types supported by BSON. As a result, data exported or imported with these tools may lose some measure of -fidelity. See http://docs.mongodb.org/manual/reference/mongodb\-extended\-json for more -information. +fidelity. See the \fBExtended JSON\fP +reference for more information. .UNINDENT .UNINDENT .sp @@ -629,6 +704,6 @@ these types and the representations used. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongofiles.1 b/debian/mongofiles.1 index 9cb2b31dafd..5ef1a35d9d9 100644 --- a/debian/mongofiles.1 +++ b/debian/mongofiles.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOFILES" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOFILES" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongofiles \- MongoDB GridFS Utility . @@ -76,14 +76,19 @@ For \fIreplica sets\fP, .UNINDENT .UNINDENT .SH OPTIONS +.sp +Changed in version 3.0.0: \fBmongofiles\fP removed the \fB\-\-dbpath\fP as well as related +\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use +\fBmongofiles\fP while connected to a \fBmongod\fP instance. + .INDENT 0.0 .TP .B mongofiles .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongofiles\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongofiles\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -95,8 +100,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongofiles\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongofiles\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -126,16 +133,17 @@ on a port other than 27017. .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongofiles\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongofiles\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongofiles\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -161,6 +169,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -174,8 +197,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -187,13 +210,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongofiles\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongofiles\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongofiles\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongofiles\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -219,7 +242,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -227,30 +250,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongofiles\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongofiles\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongofiles\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongofiles\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP @@ -259,62 +301,97 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongofiles\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongofiles\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath <path> -Specifies the directory of the MongoDB data files. If used, the -\fI\-\-dbpath\fP option enables \fBmongofiles\fP to attach directly to local data -files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, -\fBmongofiles\fP locks access to the data directory. No \fBmongod\fP can -access the same path while the process runs. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb -When used in conjunction with the corresponding option in -\fBmongod\fP, allows \fBmongofiles\fP to access data from MongoDB -instances that use an on\-disk format where every database has a distinct -directory. This option is only relevant when specifying the -\fI\-\-dbpath\fP option. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongofiles\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Allows \fBmongofiles\fP operations to use the durability \fIjournal\fP to -ensure data files remain valid and recoverable. This option is only -relevant when specifying the \fI\-\-dbpath\fP option. +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-db <database>, \-d -Specifies the name of the database on which to run \fBmongofiles\fP\&. +.B \-\-db <database>, \-d <database> +Specifies the name of the database on which to run the \fBmongofiles\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c +.B \-\-collection <collection>, \-c <collection> This option has no use in this context and a future release may remove it. See \fI\%SERVER\-4931\fP for more information. .UNINDENT .INDENT 0.0 .TP -.B \-\-local <filename>, \-l +.B \-\-local <filename>, \-l <filename> Specifies the local filesystem name of a file for get and put operations. .sp @@ -343,6 +420,23 @@ additional object with the same name. In the default operation, files will not be overwritten by a \fBmongofiles put\fP option. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-prefix string +\fIDefault\fP: fs +.sp +GridFS prefix to use. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-writeConcern <document> +\fIDefault\fP: majority +.sp +Specifies the \fIwrite concern\fP for each write operation that \fBmongofiles\fP +writes to the target database. +.sp +Specify the write concern as a document with \fIw options\fP\&. +.UNINDENT .SH COMMANDS .INDENT 0.0 .TP @@ -487,6 +581,6 @@ mongofiles \-d records get 32\-corinth.lp .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongoimport.1 b/debian/mongoimport.1 index 95e9e6f80da..3f2113dd286 100644 --- a/debian/mongoimport.1 +++ b/debian/mongoimport.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOIMPORT" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOIMPORT" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongoimport \- MongoDB Import Utility . @@ -46,7 +46,16 @@ full instance, production backups because they will not reliably capture data ty information. Use \fBmongodump\fP and \fBmongorestore\fP as described in http://docs.mongodb.org/manual/core/backups for this kind of functionality. +.sp +\fBmongoimport\fP is single\-threaded and inserts one document at +a time into MongoDB. Custom import tools for data ingestion may have +better performance for specific workloads. .SH OPTIONS +.sp +Changed in version 3.0.0: \fBmongoimport\fP removed the \fB\-\-dbpath\fP as well as related +\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use +\fBmongoimport\fP while connected to a \fBmongod\fP instance. + .INDENT 0.0 .TP .B mongoimport @@ -57,8 +66,8 @@ functionality. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongoimport\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongoimport\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -70,8 +79,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongoimport\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongoimport\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -90,19 +101,22 @@ Returns the \fBmongoimport\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> +\fIDefault\fP: localhost:27017 +.sp Specifies a resolvable hostname for the \fBmongod\fP to which to -connect. By default \fBmongoimport\fP attempts to connect to a MongoDB instance -running on the localhost on port number \fB27017\fP\&. +connect. By default, the \fBmongoimport\fP attempts to connect to a MongoDB +instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the +\fBreplSetName\fP and a seed list of set members, as in +the following: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -110,20 +124,26 @@ seed list of set members. Use the following format: .sp You can always connect directly to a single MongoDB instance by specifying the host and port number directly. +.sp +Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must +enclose the portion of an address and port combination in +brackets (e.g. \fB[<address>]\fP). + .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongoimport\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongoimport\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongoimport\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -149,6 +169,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -162,8 +197,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -175,13 +210,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongoimport\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongoimport\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongoimport\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongoimport\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -207,7 +242,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -215,30 +250,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongoimport\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongoimport\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongoimport\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongoimport\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP @@ -247,56 +301,91 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongoimport\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongoimport\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath <path> -Specifies the directory of the MongoDB data files. If used, the -\fI\-\-dbpath\fP option enables \fBmongoimport\fP to attach directly to local data -files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, -\fBmongoimport\fP locks access to the data directory. No \fBmongod\fP can -access the same path while the process runs. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb -When used in conjunction with the corresponding option in -\fBmongod\fP, allows \fBmongoimport\fP to access data from MongoDB -instances that use an on\-disk format where every database has a distinct -directory. This option is only relevant when specifying the -\fI\-\-dbpath\fP option. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongoimport\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Allows \fBmongoimport\fP operations to use the durability \fIjournal\fP to -ensure data files remain valid and recoverable. This option is only -relevant when specifying the \fI\-\-dbpath\fP option. +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-db <database>, \-d -Specifies the name of the database on which to run \fBmongoimport\fP\&. +.B \-\-db <database>, \-d <database> +Specifies the name of the database on which to run the \fBmongoimport\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c +.B \-\-collection <collection>, \-c <collection> Specifies the collection to import. .sp New in version 2.6: If you do not specify \fI\-\-collection\fP, @@ -307,10 +396,14 @@ collection name, if the input file has an extension. .UNINDENT .INDENT 0.0 .TP -.B \-\-fields <field1[,field2]>, \-f +.B \-\-fields <field1[,field2]>, \-f <field1[,field2]> Specify a comma separated list of field names when importing \fIcsv\fP or \fItsv\fP files that do not have field names in the first (i.e. header) line of the file. +.sp +If you attempt to include \fI\%\-\-fields\fP when importing JSON data, +\fBmongoimport\fP will return an error. \fI\%\-\-fields\fP is only for \fIcsv\fP +or \fItsv\fP imports. .UNINDENT .INDENT 0.0 .TP @@ -319,6 +412,10 @@ As an alternative to \fI\%\-\-fields\fP, the \fI\%\-\-fieldFile\fP option allows you to specify a file that holds a list of field names if your \fIcsv\fP or \fItsv\fP file does not include field names in the first line of the file (i.e. header). Place one field per line. +.sp +If you attempt to include \fI\%\-\-fieldFile\fP when importing JSON data, +\fBmongoimport\fP will return an error. \fI\%\-\-fieldFile\fP is only for \fIcsv\fP +or \fItsv\fP imports. .UNINDENT .INDENT 0.0 .TP @@ -326,12 +423,22 @@ first line of the file (i.e. header). Place one field per line. Ignores empty fields in \fIcsv\fP and \fItsv\fP exports. If not specified, \fBmongoimport\fP creates fields without values in imported documents. +.sp +If you attempt to include \fI\%\-\-ignoreBlanks\fP when importing JSON data, +\fBmongoimport\fP will return an error. \fI\%\-\-ignoreBlanks\fP is only for \fIcsv\fP +or \fItsv\fP imports. .UNINDENT .INDENT 0.0 .TP .B \-\-type <json|csv|tsv> Specifies the file type to import. The default format is \fIJSON\fP, but it\(aqs possible to import \fIcsv\fP and \fItsv\fP files. +.sp +The \fBcsv\fP parser accepts that data that complies with RFC +\fI\%RFC 4180\fP\&. As a result, backslashes are \fInot\fP a valid escape +character. If you use double\-quotes to enclose fields in the CSV +data, you must escape internal double\-quote marks by prepending +another double\-quote. .UNINDENT .INDENT 0.0 .TP @@ -344,7 +451,7 @@ standard input (e.g. "stdin"). .TP .B \-\-drop Modifies the import process so that the target instance drops -every collection before importing the collection from the input. +the collection before importing the data from the input. .UNINDENT .INDENT 0.0 .TP @@ -353,6 +460,10 @@ If using \fI\-\-type csv\fP or \fI\-\-type tsv\fP, uses the first line as field names. Otherwise, \fBmongoimport\fP will import the first line as a distinct document. +.sp +If you attempt to include \fI\%\-\-headerline\fP when importing JSON data, +\fBmongoimport\fP will return an error. \fI\%\-\-headerline\fP is only for \fIcsv\fP +or \fItsv\fP imports. .UNINDENT .INDENT 0.0 .TP @@ -364,6 +475,12 @@ other objects. If you do not specify a field or fields using the \fI\%\-\-upsertFields\fP \fBmongoimport\fP will upsert on the basis of the \fB_id\fP field. +.INDENT 7.0 +.TP +.B \&..versionchanged:: 3.0.0 +\fI\%\-\-upsert\fP is no longer needed when specifying upserts. Use +\fI\%\-\-upsertFields\fP, which produces the same behavior. +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -373,6 +490,16 @@ Specifies a list of fields for the query portion of the existing documents don\(aqt match the field in the document, but another field or field combination can uniquely identify documents as a basis for performing upsert operations. +.INDENT 7.0 +.TP +.B \&..versionchanged:: 3.0.0 +Modifies the import process to update existing objects in the +database if they match based on the specified fields, while +inserting all other objects. +.sp +If you do not specify a field, \fI\%\-\-upsertFields\fP will upsert on the basis of +the \fB_id\fP field. +.UNINDENT .sp To ensure adequate performance, indexes should exist for this field or fields. @@ -385,44 +512,68 @@ New in version 2.2. .sp Forces \fBmongoimport\fP to halt the import operation at the first error rather than continuing the operation despite errors. +.sp +Changed in version 3.0.0: \fI\%\-\-stopOnError\fP interrupts the import operation when \fBmongoimport\fP encounters +an insert or upsert error. Other error types will not stop +the import. + .UNINDENT .INDENT 0.0 .TP .B \-\-jsonArray Accepts the import of data expressed with multiple MongoDB documents -within a single \fIJSON\fP array. -.sp -Used in conjunction with \fImongoexport \-\-jsonArray\fP to -import data written as a single \fIJSON\fP array. Limited to +within a single \fIJSON\fP array. Limited to imports of 16 MB or smaller. +.sp +Use \fI\%\-\-jsonArray\fP in conjunction with \fImongoexport \-\-jsonArray\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-maintainInsertionOrder +\fIDefault\fP: False +.sp +If specified, \fBmongoimport\fP inserts the documents in the order of +their appearance in the input source, otherwise \fBmongoimport\fP may +perform the insertions in an arbitrary order. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-writeConcern <document> +\fIDefault\fP: majority +.sp +Specifies the \fIwrite concern\fP for each write operation that \fBmongoimport\fP +writes to the target database. +.sp +Specify the write concern as a document with \fIw options\fP\&. .UNINDENT .SH USE .sp In this example, \fBmongoimport\fP imports the \fIcsv\fP formatted data in the \fB/opt/backups/contacts.csv\fP into the collection \fBcontacts\fP in the \fBusers\fP database on the MongoDB -instance running on the localhost port numbered \fB27017\fP\&. +instance running on the localhost port numbered +\fB27017\fP\&. \fBmongoimport\fP determines the name of files using +the first line in the CSV file, because of the \fI\-\-headerline\fP: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongoimport \-\-db users \-\-collection contacts \-\-type csv \-\-file /opt/backups/contacts.csv +mongoimport \-\-db users \-\-collection contacts \-\-type csv \-\-headerline \-\-file /opt/backups/contacts.csv .ft P .fi .UNINDENT .UNINDENT .sp -Since \fBmongoimport\fP uses the input file name (minus the -extension) as the collection name if \fB\-c\fP or \fB\-\-collection\fP is -unspecified, the following example is equivalent to the previous -example: +Since \fBmongoimport\fP uses the input file name, without the +extension, as the collection name if \fB\-c\fP or \fB\-\-collection\fP is +unspecified. The following example is equivalent: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongoimport \-\-db users \-\-type csv \-\-file /opt/backups/contacts.csv +mongoimport \-\-db users \-\-type csv \-\-headerline \-\-file /opt/backups/contacts.csv .ft P .fi .UNINDENT @@ -437,29 +588,13 @@ number 27017. .sp .nf .ft C -mongoimport \-\-collection contacts \-\-file contacts.json -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -In the next example, \fBmongoimport\fP takes data passed to it on -standard input (i.e. with a \fB|\fP pipe.) and imports it into the -MongoDB datafiles located at \fB/srv/mongodb/\fP\&. if the import process -encounters an error, the \fBmongoimport\fP will halt because of -the \fI\-\-stopOnError\fP option. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongoimport \-\-db sales \-\-collection contacts \-\-stopOnError \-\-dbpath /srv/mongodb/ +mongoimport \-\-db users \-\-collection contacts \-\-file contacts.json .ft P .fi .UNINDENT .UNINDENT .sp -In the final example, \fBmongoimport\fP imports data from the +In the next example, \fBmongoimport\fP imports data from the file \fB/opt/backups/mdb1\-examplenet.json\fP into the collection \fBcontacts\fP within the database \fBmarketing\fP on a remote MongoDB database. This \fBmongoimport\fP accesses the \fBmongod\fP @@ -485,8 +620,8 @@ mongoimport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-p preserve all rich \fIBSON\fP data types because \fIJSON\fP can only represent a subset of the types supported by BSON. As a result, data exported or imported with these tools may lose some measure of -fidelity. See http://docs.mongodb.org/manual/reference/mongodb\-extended\-json for more -information. +fidelity. See the \fBExtended JSON\fP +reference for more information. .UNINDENT .UNINDENT .sp @@ -518,6 +653,6 @@ these types and the representations used. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongooplog.1 b/debian/mongooplog.1 index a3ef4d79eb7..92077a20cb1 100644 --- a/debian/mongooplog.1 +++ b/debian/mongooplog.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOOPLOG" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOOPLOG" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongooplog \- MongoDB Oplog Utility . @@ -78,6 +78,11 @@ http://docs.mongodb.org/manual/core/backups, http://docs.mongodb.org/manual/core .UNINDENT .UNINDENT .SH OPTIONS +.sp +Changed in version 3.0.0: \fBmongooplog\fP removed the \fB\-\-dbpath\fP as well as related +\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use +\fBmongooplog\fP while connected to a \fBmongod\fP instance. + .INDENT 0.0 .TP .B mongooplog @@ -88,8 +93,8 @@ http://docs.mongodb.org/manual/core/backups, http://docs.mongodb.org/manual/core .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongooplog\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongooplog\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -101,14 +106,12 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongooplog\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongooplog\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 -output from \fIdatabase commands\fP -.IP \(bu 2 -replication activity -.IP \(bu 2 connection accepted events .IP \(bu 2 connection closed events @@ -121,7 +124,7 @@ Returns the \fBmongooplog\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> Specifies a resolvable hostname for the \fBmongod\fP instance to which \fBmongooplog\fP will apply \fIoplog\fP operations retrieved from the server specified by the \fI\-\-from\fP option. @@ -129,14 +132,14 @@ retrieved from the server specified by the \fI\-\-from\fP option. By default \fBmongooplog\fP attempts to connect to a MongoDB instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the \fBreplica set name\fP and a seed list of set members. Use the +following form: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -157,9 +160,9 @@ port number using the \fI\-\-host\fP command. .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongooplog\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongooplog\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongooplog\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -185,6 +188,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -198,8 +216,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -211,13 +229,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongooplog\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongooplog\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongooplog\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongooplog\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -243,7 +261,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -251,30 +269,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongooplog\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongooplog\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongooplog\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongooplog\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP @@ -283,68 +320,96 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongooplog\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongooplog\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongooplog\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE .UNINDENT .INDENT 0.0 .TP -.B \-\-dbpath <path> -Specifies a directory, containing MongoDB data files, to which -\fBmongooplog\fP will apply operations from the \fIoplog\fP of -the database specified with the \fI\-\-from\fP -option. +.B \-\-gssapiServiceName +New in version 2.6. + .sp -When used, the \fI\-\-dbpath\fP option enables \fBmongo\fP to -attach directly to local data files and write data without a running -\fBmongod\fP instance. +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. .sp -To run with \fI\-\-dbpath\fP, \fBmongooplog\fP needs to restrict -access to the data directory: as a result, no \fBmongod\fP can be -access the same path while the process runs. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb -When used in conjunction with the corresponding option in -\fBmongod\fP, allows \fBmongooplog\fP to access data from MongoDB -instances that use an on\-disk format where every database has a distinct -directory. This option is only relevant when specifying the -\fI\-\-dbpath\fP option. +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Allows \fBmongooplog\fP operations to use the durability \fIjournal\fP to -ensure data files remain valid and recoverable. This option is only -relevant when specifying the \fI\-\-dbpath\fP option. +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-db <database>, \-d -Specifies the name of the database on which to run \fBmongooplog\fP\&. +.B \-\-db <database>, \-d <database> +Specifies the name of the database on which to run the \fBmongooplog\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c +.B \-\-collection <collection>, \-c <collection> Specifies the collection to export. .UNINDENT .INDENT 0.0 .TP -.B \-\-seconds <number>, \-s +.B \-\-seconds <number>, \-s <number> Specify a number of seconds of operations for \fBmongooplog\fP to pull from the \fIremote host\fP\&. Unless specified the default value is \fB86400\fP seconds, or 24 hours. @@ -366,9 +431,11 @@ localhost interface connected to port \fB27017\fP\&. Specify a namespace in the \fI\-\-from\fP host where the oplog resides. The default value is \fBlocal.oplog.rs\fP, which is the where \fIreplica set\fP members store their operation log. -However, if you\(aqve copied \fIoplog\fP entries into another database or -collection, use this option to copy oplog entries stored in another -location. Namespaces take the form of \fB[database].[collection]\fP\&. +However, if you\(aqve copied \fIoplog\fP entries into another +database or collection or are pulling oplog entries from a +\fBmaster\-slave\fP deployment, use \fI\%\-\-oplogns\fP to +apply oplog entries stored in another location. Namespaces take the +form of \fB[database].[collection]\fP\&. .UNINDENT .SH USE .sp @@ -413,31 +480,9 @@ mongooplog \-\-from mongodb0.example.net \-\-seconds 43200 .fi .UNINDENT .UNINDENT -.sp -For the previous two examples, \fBmongooplog\fP migrates entries -to the \fBmongod\fP process running on the localhost interface -connected to the \fB27017\fP port. \fBmongooplog\fP can also -operate directly on MongoDB\(aqs data files if no \fBmongod\fP is -running on the \fItarget\fP host. Consider the following example: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongooplog \-\-from mongodb0.example.net \-\-dbpath /srv/mongodb \-\-journal -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Here, \fBmongooplog\fP imports \fIoplog\fP operations from the -\fBmongod\fP host connected to port \fB27017\fP\&. This migrates -operations to the MongoDB data files stored in the \fB/srv/mongodb\fP -directory. Additionally \fBmongooplog\fP will use the durability -\fIjournal\fP to ensure that the data files remain valid. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongoperf.1 b/debian/mongoperf.1 index 140b5ac744d..c4ee2bc20f8 100644 --- a/debian/mongoperf.1 +++ b/debian/mongoperf.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOPERF" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOPERF" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongoperf \- MongoDB Performance Utility . @@ -70,7 +70,7 @@ Specify options to \fBmongoperf\fP using a JavaScript document. .INDENT 0.0 .TP .B \-\-help, \-h -Returns information on \fBmongoperf\fP options and usage. +Returns information on the options and use of \fBmongoperf\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -248,7 +248,7 @@ following form: .sp .nf .ft C -echo "{nThreads:16,fileSizeMB:1000,r:true}" | ./mongoperf +echo "{nThreads:16,fileSizeMB:10000,r:true,w:true}" | mongoperf .ft P .fi .UNINDENT @@ -257,10 +257,10 @@ echo "{nThreads:16,fileSizeMB:1000,r:true}" | ./mongoperf In this operation: .INDENT 0.0 .IP \(bu 2 -\fBmongoperf\fP tests direct physical random read io\(aqs, using +\fBmongoperf\fP tests direct physical random read and write io\(aqs, using 16 concurrent reader threads. .IP \(bu 2 -\fBmongoperf\fP uses a 1 gigabyte test file. +\fBmongoperf\fP uses a 10 gigabyte test file. .UNINDENT .sp Consider using \fBiostat\fP, as invoked in the following example to @@ -270,7 +270,7 @@ monitor I/O performance during the test. .sp .nf .ft C -iostat \-xm 2 +iostat \-xtm 1 .ft P .fi .UNINDENT @@ -278,6 +278,6 @@ iostat \-xm 2 .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongorestore.1 b/debian/mongorestore.1 index 6444fb63e49..7d891f15021 100644 --- a/debian/mongorestore.1 +++ b/debian/mongorestore.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGORESTORE" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGORESTORE" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongorestore \- MongoDB Data Restoration Tool . @@ -69,6 +69,9 @@ The data format used by \fBmongodump\fP from version 2.2 or later is \fIincompatible\fP with earlier versions of \fBmongod\fP\&. Do not use recent versions of \fBmongodump\fP to back up older data stores. +.sp +New in version 3.0.0: \fBmongorestore\fP also accepts input via standard input. + .SH REQUIRED ACCESS TO RESTORE USER DATA .sp Changed in version 2.6. @@ -99,8 +102,8 @@ provides this privilege. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongorestore\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongorestore\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -112,8 +115,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongorestore\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongorestore\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -132,19 +137,22 @@ Returns the \fBmongorestore\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> +\fIDefault\fP: localhost:27017 +.sp Specifies a resolvable hostname for the \fBmongod\fP to which to -connect. By default \fBmongorestore\fP attempts to connect to a MongoDB instance -running on the localhost on port number \fB27017\fP\&. +connect. By default, the \fBmongorestore\fP attempts to connect to a MongoDB +instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the +\fBreplSetName\fP and a seed list of set members, as in +the following: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -152,20 +160,26 @@ seed list of set members. Use the following format: .sp You can always connect directly to a single MongoDB instance by specifying the host and port number directly. +.sp +Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must +enclose the portion of an address and port combination in +brackets (e.g. \fB[<address>]\fP). + .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongorestore\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongorestore\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongorestore\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -191,6 +205,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -204,8 +233,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -217,13 +246,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongorestore\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongorestore\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongorestore\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongorestore\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -249,7 +278,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -257,30 +286,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongorestore\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongorestore\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongorestore\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongorestore\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP @@ -289,51 +337,86 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongorestore\fP assumes -that the database specified as the argument to the \fI\%\-\-db\fP option -holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongorestore\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath <path> -Specifies the directory of the MongoDB data files. If used, the -\fI\%\-\-dbpath\fP option enables \fBmongorestore\fP to attach directly to local data -files without a running \fBmongod\fP\&. When run with \fI\%\-\-dbpath\fP, -\fBmongorestore\fP locks access to the data directory. No \fBmongod\fP can -access the same path while the process runs. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb -When used in conjunction with the corresponding option in -\fBmongod\fP, allows \fBmongorestore\fP to access data from MongoDB -instances that use an on\-disk format where every database has a distinct -directory. This option is only relevant when specifying the -\fI\%\-\-dbpath\fP option. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongorestore\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Allows \fBmongorestore\fP operations to use the durability \fIjournal\fP to -ensure data files remain valid and recoverable. This option is only -relevant when specifying the \fI\%\-\-dbpath\fP option. +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP -.B \-\-db <database>, \-d +.B \-\-db <database>, \-d <database> Specifies a database for \fBmongorestore\fP to restore data \fIinto\fP\&. If the database does not exist, \fBmongorestore\fP creates the database. If you do not specify a \fB<db>\fP, \fBmongorestore\fP @@ -348,7 +431,7 @@ limit that restored data. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c +.B \-\-collection <collection>, \-c <collection> Specifies a single collection for \fBmongorestore\fP to restore. If you do not specify \fI\%\-\-collection\fP, \fBmongorestore\fP takes the collection name from the input filename. If the input file has an @@ -380,18 +463,17 @@ incoming BSON documents. .UNINDENT .INDENT 0.0 .TP -.B \-\-filter <JSON> -Limits the documents that \fBmongorestore\fP imports to only those -documents that match the JSON document specified as \fB\(aq<JSON>\(aq\fP\&. Be -sure to include the document in single quotes to avoid interaction with -your system\(aqs shell environment. For an example of \fI\%\-\-filter\fP, -see \fIbackup\-restore\-filter\fP\&. -.UNINDENT -.INDENT 0.0 -.TP .B \-\-drop Modifies the restoration procedure to drop every collection from the target database before restoring the collection from the dumped backup. +.sp +With \fI\%\-\-drop\fP specified, \fBmongorestore\fP removes all user +credentials and replaces them with users defined in the dump +file. Therefore, in systems with \fBauthorization\fP +enabled, \fBmongorestore\fP must be able to authenticate to an existing +user \fIand\fP to a user defined in the dump file. If \fBmongorestore\fP can\(aqt +authenticate to a user defined in the dump file, the restoration +process will fail, leaving an empty database. .UNINDENT .INDENT 0.0 .TP @@ -408,10 +490,11 @@ New in version 2.2. .sp Prevents \fBmongorestore\fP from applying \fIoplog\fP entries -newer than the \fB<timestamp>\fP\&. Specify \fB<timestamp>\fP values in the -form of \fB<time_t>:<ordinal>\fP, where \fB<time_t>\fP is the seconds since -the UNIX epoch, and \fB<ordinal>\fP represents a counter of operations in -the oplog that occurred in the specified second. +with timestamp newer than or equal to \fB<timestamp>\fP\&. Specify +\fB<timestamp>\fP values in the form of \fB<time_t>:<ordinal>\fP, where +\fB<time_t>\fP is the seconds since the UNIX epoch, and \fB<ordinal>\fP +represents a counter of operations in the oplog that occurred in the +specified second. .sp You must use \fI\%\-\-oplogLimit\fP in conjunction with the \fI\%\-\-oplogReplay\fP option. @@ -443,6 +526,13 @@ command\fP, on restored collections. .UNINDENT .INDENT 0.0 .TP +.B \-\-restoreDbUsersAndRoles +Restore user and role definitions for the given database. See +http://docs.mongodb.org/manual/reference/system\-roles\-collection and +http://docs.mongodb.org/manual/reference/system\-users\-collection for more information. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-w <number of replicas per write> New in version 2.2. @@ -454,11 +544,43 @@ acknowledgment\fP\&. .UNINDENT .INDENT 0.0 .TP +.B \-\-writeConcern <document> +\fIDefault\fP: majority +.sp +Specifies the \fIwrite concern\fP for each write operation that \fBmongorestore\fP +writes to the target database. +.sp +Specify the write concern as a document with \fIw options\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-maintainInsertionOrder +\fIDefault\fP: False +.sp +If specified, \fBmongorestore\fP inserts the documents in the order of +their appearance in the input source, otherwise \fBmongorestore\fP may +perform the insertions in an arbitrary order. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-numParallelCollections int, \-j int +\fIDefault\fP: 4 +.sp +Number of collections \fBmongorestore\fP should restore +in parallel. +.UNINDENT +.INDENT 0.0 +.TP .B <path> The final argument of the \fBmongorestore\fP command is a directory path. This argument specifies the location of the database dump from which to restore. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-dir string +Specifies the dump directory. +.UNINDENT .SH USE .sp See http://docs.mongodb.org/manual/tutorial/backup\-with\-mongodump @@ -485,34 +607,31 @@ documents in the collection named \fBpeople\fP from the database named \fBaccounts\fP\&. \fBmongorestore\fP restores data to the instance running on the localhost interface on port \fB27017\fP\&. .sp -In the next example, \fBmongorestore\fP restores a backup of the -database instance located in \fBdump\fP to a database instance stored -in the \fB/srv/mongodb\fP on the local machine. This requires that there -are no active \fBmongod\fP instances attached to \fB/srv/mongodb\fP -data directory. +In the final example, \fBmongorestore\fP restores a database +dump located at \fB/opt/backup/mongodump\-2011\-10\-24\fP, to a database +running on port \fB37017\fP on the host +\fBmongodb1.example.net\fP\&. The \fBmongorestore\fP command authenticates to +the MongoDB instance using the username \fBuser\fP and the +password \fBpass\fP, as follows: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongorestore \-\-dbpath /srv/mongodb +mongorestore \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-password pass /opt/backup/mongodump\-2011\-10\-24 .ft P .fi .UNINDENT .UNINDENT .sp -In the final example, \fBmongorestore\fP restores a database -dump located at \fB/opt/backup/mongodump\-2011\-10\-24\fP, to a database -running on port \fB37017\fP on the host -\fBmongodb1.example.net\fP\&. The \fBmongorestore\fP command authenticates to -the MongoDB instance using the username \fBuser\fP and the -password \fBpass\fP, as follows: +You can also \fIpipe\fP data directly into to \fBmongorestore\fP +through standard input, as in the following example: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongorestore \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-password pass /opt/backup/mongodump\-2011\-10\-24 +zcat /opt/backup/mongodump\-2014\-12\-03/accounts.people.bson.gz | mongorestore \-\-collection people \-\-db accounts .ft P .fi .UNINDENT @@ -520,6 +639,6 @@ mongorestore \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\- .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongos.1 b/debian/mongos.1 index 3b35f05f021..6284a666473 100644 --- a/debian/mongos.1 +++ b/debian/mongos.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOS" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOS" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongos \- MongoDB Sharded Cluster Query Router . @@ -39,6 +39,9 @@ application layer, and determines the location of this data in the From the perspective of the application, a \fBmongos\fP instance behaves identically to any other MongoDB instance. +.SH CONSIDERATIONS +.sp +Never change the name of the \fBmongos\fP binary. .SH OPTIONS .SS Core Options .INDENT 0.0 @@ -48,7 +51,7 @@ instance. .INDENT 0.0 .TP .B \-\-help, \-h -Returns information on \fBmongos\fP options and usage. +Returns information on the options and use of \fBmongos\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -57,15 +60,16 @@ Returns the \fBmongos\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-config <filename>, \-f +.B \-\-config <filename>, \-f <filename> 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 http://docs.mongodb.org/manual/reference/configuration\-options for more information. .sp -Ensure the configuration file uses ASCII encoding. \fBmongos\fP does not -support configuration files with non\-ASCII encoding, including UTF\-8. +Ensure the configuration file uses ASCII encoding. The \fBmongos\fP +instance does not support configuration files with non\-ASCII encoding, +including UTF\-8. .UNINDENT .INDENT 0.0 .TP @@ -77,8 +81,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongos\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongos\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -93,16 +99,22 @@ connection closed events .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-bind_ip <ip address> -Specifies the IP address that the \fBmongos\fP process binds to and -listens for connections on. By default \fBmongos\fP listens for -connections for all interfaces. You may attach \fBmongos\fP to any +\fIDefault\fP: All interfaces. +.sp +Changed in version 2.6.0: The \fBdeb\fP and \fBrpm\fP packages include a default +configuration file that sets \fI\%\-\-bind_ip\fP to \fB127.0.0.1\fP\&. + +.sp +Specifies the IP address that \fBmongos\fP binds to in order to listen +for connections from applications. You may attach \fBmongos\fP to any interface. When attaching \fBmongos\fP to a publicly accessible interface, ensure that you have implemented proper authentication and firewall restrictions to protect the integrity of your database. @@ -115,62 +127,58 @@ Specifies the maximum number of simultaneous connections that value of this setting is higher than your operating system\(aqs configured maximum connection tracking threshold. .sp -This setting is particularly useful for \fBmongos\fP if you have a -client that creates a number of collections but allows them to timeout -rather than close the collections. When you set \fBmaxConns\fP, -ensure the value is slightly higher than the size of the connection pool -or the total number of connections to prevent erroneous connection -spikes from propagating to the members of a \fIsharded cluster\fP\&. +This setting is particularly useful for \fBmongos\fP if you +have a client that creates a number of connections but allows them +to timeout rather than close the connections. When you set +\fBmaxIncomingConnections\fP, ensure the value is slightly +higher than the size of the connection pool or the total number of +connections to prevent erroneous connection spikes from propagating +to the members of a \fIsharded cluster\fP\&. .sp -Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxConns\fP setting. +Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxIncomingConnections\fP setting. .UNINDENT .INDENT 0.0 .TP .B \-\-syslog Sends all logging output to the host\(aqs \fIsyslog\fP system rather -than to standard output or a log file as with \fI\%\-\-logpath\fP\&. +than to standard output or to a log file. , as with \fI\%\-\-logpath\fP\&. .sp -\fI\%\-\-syslog\fP is not supported on Windows. +The \fI\%\-\-syslog\fP option is not supported on Windows. .UNINDENT .INDENT 0.0 .TP .B \-\-syslogFacility <string> -Specifies the facility level used when logging messages to syslog. The -default is \fBuser\fP\&. The value you specify must be supported by your +\fIDefault\fP: user +.sp +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 \-\-logpath <path> -Specifies the path for the log file that holds all diagnostic -logging information. +Sends all diagnostic logging information to a log file instead of to +standard output or to the host\(aqs \fIsyslog\fP system. MongoDB creates +the log file at the path you specify. .sp -Unless specified, \fBmongos\fP will output all log information -to the standard output. Additionally, unless you also specify -\fI\%\-\-logappend\fP, the logfile will be overwritten when the -process restarts. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The behavior of the logging system may change in the near -future in response to the \fI\%SERVER\-4499\fP case. -.UNINDENT -.UNINDENT +By default, MongoDB overwrites the log file when the process restarts. +To instead append to the log file, set the \fI\%\-\-logappend\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-logappend -Appends new entries to the end of the logfile when the \fBmongos\fP restarts -instead of overwriting the content of the log. +Appends new entries to the end of the log file rather than overwriting +the content of the log when the \fBmongos\fP instance restarts. .UNINDENT .INDENT 0.0 .TP .B \-\-timeStampFormat <string> -Specifies the time format for timestamps in log messages. Specify one of -the following values: +\fIDefault\fP: iso8601\-local +.sp +The time format for timestamps in log messages. Specify one of the +following values: .TS center; |l|l|. @@ -199,7 +207,7 @@ _ T{ \fBiso8601\-local\fP T} T{ -Default value. Displays timestamps in local time in the ISO\-8601 +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+0500\fP T} @@ -209,55 +217,27 @@ _ .INDENT 0.0 .TP .B \-\-pidfilepath <path> -Specifies a file location to hold the "\fIPID\fP" or process ID of the -\fBmongos\fP process. Useful for tracking the \fBmongos\fP process in -combination with the \fI\%\-\-fork\fP option. -.sp -Without a specified \fI\%\-\-pidfilepath\fP option, \fBmongos\fP -creates no PID file. +Specifies a file location to hold the process ID of the \fBmongos\fP +process where \fBmongos\fP will write its PID. This is useful for +tracking the \fBmongos\fP process in combination with the +\fI\%\-\-fork\fP option. Without a specified \fI\%\-\-pidfilepath\fP option, the +process creates no PID file. .UNINDENT .INDENT 0.0 .TP .B \-\-keyFile <file> -Specifies the path to a key file to store authentication -information. This option is used for interprocess authentication among -the \fBmongos\fP and \fBmongod\fP instances of a -\fIsharded cluster\fP or \fIreplica set\fP\&. +Specifies the path to a key file that stores the shared secret +that MongoDB instances use to authenticate to each other in a +\fIsharded cluster\fP or \fIreplica set\fP\&. \fI\%\-\-keyFile\fP implies +\fI\-\-auth\fP\&. See \fIinter\-process\-auth\fP for more +information. .UNINDENT .INDENT 0.0 .TP .B \-\-setParameter <options> -New in version 2.4. - -.sp -Specifies an option to configure on startup. Specify multiple options -with multiple \fI\%\-\-setParameter\fP options. See -http://docs.mongodb.org/manual/reference/parameters for full documentation of these parameters. -The \fBsetParameter\fP database command provides access to many -of these parameters. \fI\%\-\-setParameter\fP supports the following -options: -.INDENT 7.0 -.IP \(bu 2 -\fBenableLocalhostAuthBypass\fP -.IP \(bu 2 -\fBenableTestCommands\fP -.IP \(bu 2 -\fBlogLevel\fP -.IP \(bu 2 -\fBlogUserIds\fP -.IP \(bu 2 -\fBnotablescan\fP -.IP \(bu 2 -\fBquiet\fP -.IP \(bu 2 -\fBsupportCompatibilityFormPrivilegeDocuments\fP -.IP \(bu 2 -\fBsyncdelay\fP -.IP \(bu 2 -\fBtextSearchEnabled\fP -.IP \(bu 2 -\fBuserCacheInvalidationIntervalSecs\fP -.UNINDENT +Specifies one of the MongoDB parameters described in +http://docs.mongodb.org/manual/reference/parameters\&. You can specify multiple \fBsetParameter\fP +fields. .UNINDENT .INDENT 0.0 .TP @@ -282,64 +262,17 @@ Authentication. .UNINDENT .INDENT 0.0 .TP -.B \-\-clusterAuthMode <option> -New in version 2.6. - -.sp -Enables \fIinternal x.509 authentication\fP for membership to the cluster or replica -set. The \fI\%\-\-clusterAuthMode\fP option can have one of the -following values: -.TS -center; -|l|l|. -_ -T{ -Value -T} T{ -Description -T} -_ -T{ -\fBkeyFile\fP -T} T{ -Default value. Use keyfile for authentication. -T} -_ -T{ -\fBsendKeyFile\fP -T} T{ -For rolling upgrade purposes. Send the keyfile for -authentication but can accept either keyfile or x.509 -certificate. -T} -_ -T{ -\fBsendX509\fP -T} T{ -For rolling upgrade purposes. Send the x.509 certificate for -authentication but can accept either keyfile or x.509 -certificate. -T} -_ -T{ -\fBx509\fP -T} T{ -Recommended. Send the x.509 certificate for authentication and -accept \fBonly\fP x.509 certificate. -T} -_ -.TE -.sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. -.UNINDENT -.INDENT 0.0 -.TP .B \-\-nounixsocket -Disables listening on the UNIX socket. \fBmongos\fP always -listens on the UNIX socket, unless either: \fI\%\-\-nounixsocket\fP -is set, \fBbind_ip\fP is not set, or \fBbind_ip\fP -does not specify \fB127.0.0.1\fP\&. +Disables listening on the UNIX domain socket. The \fBmongos\fP process +always listens on the UNIX socket unless one of the following is true: +.INDENT 7.0 +.IP \(bu 2 +\fI\%\-\-nounixsocket\fP is set +.IP \(bu 2 +\fBbindIp\fP is not set +.IP \(bu 2 +\fBbindIp\fP does not specify \fB127.0.0.1\fP +.UNINDENT .sp New in version 2.6: \fBmongos\fP installed from official \fB\&.deb\fP and \fB\&.rpm\fP packages have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by @@ -349,36 +282,44 @@ default. .INDENT 0.0 .TP .B \-\-unixSocketPrefix <path> -Specifies a path for the UNIX socket. If this option has no -value, \fBmongos\fP creates a socket with \fB/tmp\fP as a prefix. +\fIDefault\fP: /tmp .sp -MongoDB will always create and listen on a UNIX socket, unless -\fI\%\-\-nounixsocket\fP is set, \fBbind_ip\fP is not set, -or \fBbind_ip\fP does not specify \fB127.0.0.1\fP\&. +The path for the UNIX socket. If this option has no value, the +\fBmongos\fP process creates a socket with \fB/tmp\fP as a prefix. MongoDB +creates and listens on a UNIX socket unless one of the following is true: +.INDENT 7.0 +.IP \(bu 2 +\fI\%\-\-nounixsocket\fP is set +.IP \(bu 2 +\fBbindIp\fP is not set +.IP \(bu 2 +\fBbindIp\fP does not specify \fB127.0.0.1\fP +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-fork -Enables a \fIdaemon\fP mode for \fBmongos\fP that runs the -process in the background. This is the normal mode of operation in -production and production\-like environments but may not be -desirable for testing. +Enables a \fIdaemon\fP 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). .UNINDENT .SS Sharded Cluster Options .INDENT 0.0 .TP .B \-\-configdb <config1>,<config2>,<config3> Specifies the \fIconfiguration database\fP for the -\fIsharded cluster\fP\&. You must specify either 1 or 3 configuration -servers, in a comma separated list. +\fIsharded cluster\fP\&. You must specify either 1 or 3 +configuration servers, in a comma separated list. \fBAlways\fP use 3 +config servers in production environments. .sp -All \fBmongos\fP instances \fBmust\fP specify the hosts in the -\fI\%\-\-configdb\fP setting in the in the same order. +All \fBmongos\fP instances \fBmust\fP specify the exact same value for +\fI\%\-\-configdb\fP .sp If your configuration databases reside in more that one data center, -order the hosts so that the config database that is closest to the -majority of your \fBmongos\fP instances is first servers in the -list. +order the hosts so that first config sever in the list is the closest to the +majority of your \fBmongos\fP instances. .sp \fBWARNING:\fP .INDENT 7.0 @@ -391,9 +332,11 @@ server is not available or offline. .INDENT 0.0 .TP .B \-\-localThreshold +\fIDefault\fP: 15 +.sp Affects the logic that \fBmongos\fP uses when selecting -\fIreplica set\fP members to pass read operations to from clients. -Specify a value in milliseconds. The default value is \fB15\fP, which +\fIreplica set\fP members to pass read operations from clients. +Specify a value in milliseconds. The default value of \fB15\fP corresponds to the default value in all of the client \fBdrivers\fP\&. .sp When \fBmongos\fP receives a request that permits reads to @@ -405,18 +348,17 @@ Find the member of the set with the lowest ping time. 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 \fI\%\-\-localThreshold\fP, -\fBmongos\fP will construct the list of replica members that are -within the latency allowed by this value. +If you specify a value for the \fI\%\-\-localThreshold\fP option, \fBmongos\fP 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 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 \fBmongos\fP -recalculates the average. +The ping time used for a member compared by the \fI\%\-\-localThreshold\fP 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 \fBmongos\fP recalculates the average. .sp See the \fIreplica\-set\-read\-preference\-behavior\-member\-selection\fP section of the \fBread preference\fP @@ -430,14 +372,15 @@ Updates the meta data format used by the \fIconfig database\fP\&. .INDENT 0.0 .TP .B \-\-chunkSize <value> +\fIDefault\fP: 64 +.sp Determines the size in megabytes of each \fIchunk\fP in the -\fIsharded cluster\fP\&. The default value is 64 megabytes, which is the -ideal size for chunks in most deployments: larger chunk size can lead to -uneven data distribution; smaller chunk size can lead to inefficient -movement of chunks between nodes. However, in some circumstances it may -be necessary to set a different chunk size. +\fIsharded cluster\fP\&. A size of 64 megabytes is ideal in most +deployments: larger chunk size can lead to uneven data distribution; +smaller chunk size can lead to inefficient movement of chunks between +nodes. .sp -This option \fIonly\fP affects chunk size when you initialize the cluster +This option affects chunk size \fIonly\fP when you initialize the cluster for the first time. If you later modify the option, the new value has no effect. See the http://docs.mongodb.org/manual/tutorial/modify\-chunk\-size\-in\-sharded\-cluster procedure if you need to change the chunk size on an existing sharded @@ -452,8 +395,8 @@ in a \fIsharded collection\fP\&. If set on all chunks as the data in a collection grows. .sp Because any \fBmongos\fP in a cluster can create a split, to -totally disable splitting in a cluster you must set -\fI\%\-\-noAutoSplit\fP on all \fBmongos\fP\&. +totally disable splitting in a cluster you must set \fI\%\-\-noAutoSplit\fP on all +\fBmongos\fP\&. .sp \fBWARNING:\fP .INDENT 7.0 @@ -478,12 +421,12 @@ documentation of MongoDB\(aqs support. Deprecated since version 2.6. .sp -New in version 2.2. - +Enables SSL for \fBmongos\fP\&. .sp -Enables SSL so that \fBmongos\fP requires SSL encryption for all -connections on the default MongoDB port or port specified by -\fI\-\-port\fP\&. +With \fI\%\-\-sslOnNormalPorts\fP, a \fBmongos\fP requires SSL encryption for all +connections on the default MongoDB port, or the port specified by +\fI\-\-port\fP\&. By default, \fI\%\-\-sslOnNormalPorts\fP is +disabled. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -494,8 +437,8 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 2.6. .sp -Enables SSL or mixed SSL on a port. The argument to the -\fI\%\-\-sslMode\fP option can be one of the following: +Enables SSL or mixed SSL used for all network connections. The +argument to the \fI\%\-\-sslMode\fP option can be one of the following: .TS center; |l|l|. @@ -540,17 +483,14 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslPEMKeyFile <filename> -New in version 2.6. +New in version 2.2. .sp Specifies the \fB\&.pem\fP file that contains both the SSL certificate and key. Specify the file name of the \fB\&.pem\fP file using relative or absolute paths. .sp -This option is required when using the \fI\-\-ssl\fP option to connect -to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +When SSL is enabled, you must specify \fI\-\-sslPEMKeyFile\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -558,17 +498,74 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslPEMKeyPassword <value> -New in version 2.6. +New in version 2.2. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongos\fP will +\fB\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongos\fP will redact the password from all logging and reporting output. .sp -If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongos\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +Changed in version 2.6: If the private key in the PEM file is encrypted and you do not +specify the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongos\fP will prompt for a +passphrase. See \fIssl\-certificate\-password\fP\&. + +.sp +The default distribution of MongoDB does not contain support for SSL. +For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-clusterAuthMode <option> +\fIDefault\fP: keyFile +.sp +New in version 2.6. + +.sp +The authentication mode used for cluster authentication. If you use +\fIinternal x.509 authentication\fP, +specify so here. This option can have one of the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBkeyFile\fP +T} T{ +Use a keyfile for authentication. +Accept only keyfiles. +T} +_ +T{ +\fBsendKeyFile\fP +T} T{ +For rolling upgrade purposes. Send a keyfile for +authentication but can accept both keyfiles and x.509 +certificates. +T} +_ +T{ +\fBsendX509\fP +T} T{ +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{ +Recommended. Send the x.509 certificate for authentication and +accept only x.509 certificates. +T} +_ +.TE .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -583,8 +580,13 @@ Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key file for \fImembership authentication\fP for the cluster or replica set. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +If \fI\%\-\-sslClusterFile\fP does not specify the \fB\&.pem\fP file for internal cluster +authentication, the cluster uses the \fB\&.pem\fP file specified in the +\fI\-\-sslPEMKeyFile\fP option. +.sp +The default distribution of MongoDB does not contain support for +SSL. For more information on MongoDB and SSL, see +http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. .UNINDENT .INDENT 0.0 .TP @@ -593,15 +595,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the x.509 certificate\-key file -specified with \fI\%\-\-sslClusterFile\fP\&. Use -\fI\%\-\-sslClusterPassword\fP only if the certificate\-key file is -encrypted. In all cases, \fBmongos\fP will redact the password from all -logging and reporting output. -.sp -Changed in version 2.6: If the x.509 key file is encrypted and you do -not specify \fI\%\-\-sslClusterPassword\fP, \fBmongos\fP will prompt -for a passphrase. See \fIssl\-certificate\-password\fP\&. - +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 +will redact the password from all logging and reporting output. +.sp +If the x.509 key file is encrypted and you do not specify the +\fI\%\-\-sslClusterPassword\fP option, the \fBmongos\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -609,7 +609,7 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .INDENT 0.0 .TP .B \-\-sslCAFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains the root certificate chain @@ -618,11 +618,26 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fI\-\-sslCAFile\fP option and its target +file are not specified, x.509 client and member authentication will not +function. \fBmongod\fP, and \fBmongos\fP in sharded systems, +will not be able to verify the certificates of processes connecting to it +against the trusted certificate authority (CA) that issued them, breaking +the certificate chain. +.sp +As of version 2.6.4, \fBmongod\fP will not start with x.509 +authentication enabled if the CA file is not specified. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-sslCRLFile <filename> -New in version 2.6. +New in version 2.4. .sp Specifies the \fB\&.pem\fP file that contains the Certificate Revocation @@ -638,20 +653,24 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 2.4. .sp +Changed in version 3.0.0: \fB\-\-sslAllowConnectionsWithoutCertificates\fP became \fI\%\-\-sslWeakCertificateValidation\fP\&. For +compatibility, MongoDB processes continue to accept +\fB\-\-sslAllowConnectionsWithoutCertificates\fP, but all users should +update their configuration files. + +.sp Disables the requirement for SSL certificate validation that -\fI\-\-sslCAFile\fP enables. With -\fI\%\-\-sslWeakCertificateValidation\fP, \fBmongos\fP will accept -connections when the client does not present a certificate when -establishing the connection. +\fB\-\-sslCAFile\fP enables. With the \fI\%\-\-sslWeakCertificateValidation\fP option, the \fBmongos\fP +will accept connections when the client does not present a certificate +when establishing the connection. .sp -If the client presents a certificate and \fBmongos\fP has -\fI\%\-\-sslWeakCertificateValidation\fP enabled, \fBmongos\fP will -validate the certificate using the root certificate chain specified by -\fI\-\-sslCAFile\fP and reject clients with invalid certificates. +If the client presents a certificate and the \fBmongos\fP has \fI\%\-\-sslWeakCertificateValidation\fP +enabled, the \fBmongos\fP will validate the certificate using the root +certificate chain specified by \fB\-\-sslCAFile\fP and reject clients +with invalid certificates. .sp -Use \fI\%\-\-sslWeakCertificateValidation\fP if you have a mixed -deployment that includes clients that do not or cannot present -certificates to \fBmongos\fP\&. +Use the \fI\%\-\-sslWeakCertificateValidation\fP option if you have a mixed deployment that includes +clients that do not or cannot present certificates to the \fBmongos\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -662,33 +681,57 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 2.6. .sp -Bypasses the validation checks for server certificates and allows -the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a -warning the use of the invalid certificate. +Bypasses the validation checks for SSL certificates on other servers +in the cluster and allows the use of invalid certificates. When using +the \fBallowInvalidCertificates\fP setting, MongoDB +logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-sslFIPSMode -New in version 2.6. +.B \-\-sslAllowInvalidHostnames +New in version 3.0. .sp -Directs \fBmongos\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Disables the validation of the hostnames in SSL certificates, when +connecting to other \fBmongos\fP instances for inter\-process +authentication. This allows \fBmongos\fP to connect to other +\fBmongos\fP instances if the hostnames in their certificates do not +match their configured hostname. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-sslFIPSMode +New in version 2.4. + +.sp +Directs the \fBmongos\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT +.UNINDENT .SS Audit Options .INDENT 0.0 .TP .B \-\-auditDestination -Enables auditing. The \fI\%\-\-auditDestination\fP option can have one of -the following values: +New in version 2.6. + +.sp +Enables \fBauditing\fP\&. The \fI\%\-\-auditDestination\fP option can +have one of the following values: .TS center; |l|l|. @@ -706,9 +749,9 @@ 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 -The syslog message limit can result in the truncation of the audit -messages. The auditing system will neither detect the truncation nor -error upon its occurrence. +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{ @@ -730,17 +773,18 @@ _ \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-auditFormat -Specifies the format of the output file if -\fI\%\-\-auditDestination\fP is \fBfile\fP\&. The -\fI\%\-\-auditFormat\fP can have one of the following values: +New in version 2.6. + +.sp +Specifies the format of the output file for \fBauditing\fP if \fI\%\-\-auditDestination\fP is \fBfile\fP\&. The +\fI\%\-\-auditFormat\fP option can have one of the following values: .TS center; |l|l|. @@ -773,60 +817,60 @@ performance more than printing to a file in BSON format. \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\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 option can take -either a full path name or a relative path name. +New in version 2.6. + +.sp +Specifies the output file for \fBauditing\fP if +\fI\%\-\-auditDestination\fP has value of \fBfile\fP\&. The \fI\%\-\-auditPath\fP +option can take either a full path name or a relative path name. .sp \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-auditFilter -Specifies the filter to limit the \fItypes of operations\fP the audit system records. The option -takes a document of the form: +New in version 2.6. + +.sp +Specifies the filter to limit the \fItypes of operations\fP the \fBaudit system\fP records. The option takes a string representation +of a query document of the form: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -{ atype: <expression> } +{ <field1>: <expression1>, ... } .ft P .fi .UNINDENT .UNINDENT .sp -For authentication operations, the option can also take a document of -the form: -.INDENT 7.0 -.INDENT 3.5 +The \fB<field>\fP can be \fBany field in the audit message\fP, including fields returned in the +\fIparam\fP document. The +\fB<expression>\fP is a \fIquery condition expression\fP\&. .sp -.nf -.ft C -{ atype: <expression>, "param.db": <database> } -.ft P -.fi -.UNINDENT -.UNINDENT +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 \fBconfiguration file\fP, you must use the YAML format of +the configuration file. .sp \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fBaudit system\fP is -available only in \fI\%MongoDB Enterprise\fP\&. +Available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT @@ -834,24 +878,17 @@ available only in \fI\%MongoDB Enterprise\fP\&. .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongos\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongos\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongos\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP .B \-\-jsonp -Permits \fIJSONP\fP access via an HTTP interface. Consider the -security implications of allowing this activity before enabling this -option. If the HTTP interface is disabled, the \fI\%\-\-jsonp\fP also -enables the HTTP interface. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%\-\-httpinterface\fP -.UNINDENT -.UNINDENT +Permits \fIJSONP\fP access via an HTTP interface. Enabling the +interface can increase network exposure. The \fI\%\-\-jsonp\fP option enables the +HTTP interface, even if the \fBHTTP interface\fP +option is disabled. .UNINDENT .INDENT 0.0 .TP @@ -861,6 +898,6 @@ Disables the scripting engine. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongosniff.1 b/debian/mongosniff.1 index 2f9b72e4e5a..600a792c3df 100644 --- a/debian/mongosniff.1 +++ b/debian/mongosniff.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOSNIFF" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOSNIFF" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongosniff \- MongoDB Protocol Introspection Utility . @@ -42,24 +42,7 @@ development. .INDENT 0.0 .INDENT 3.5 \fBmongosniff\fP requires \fBlibpcap\fP and is only available for -Unix\-like systems. Furthermore, the version distributed with the -MongoDB binaries is dynamically linked against aversion 0.9 of -\fBlibpcap\fP\&. If your system has a different version of \fBlibpcap\fP, you -will need to compile \fBmongosniff\fP yourself or create a -symbolic link pointing to \fBlibpcap.so.0.9\fP to your local version -of \fBlibpcap\fP\&. Use an operation that resembles the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -ln \-s /usr/lib/libpcap.so.1.1.1 /usr/lib/libpcap.so.0.9 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Change the path\(aqs and name of the shared library as needed. +Unix\-like systems. .UNINDENT .UNINDENT .sp @@ -77,8 +60,8 @@ wire protocol. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongosniff\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongosniff\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -89,14 +72,14 @@ and issue those operations on that database instance. .sp Specify the target host name and port in the \fB<host><:port>\fP format. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the \fBreplica set name\fP and a seed list of set members. Use the +following form: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -212,6 +195,6 @@ must run \fBscons clean\fP before you can build \fBmongosniff\fP\&. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongostat.1 b/debian/mongostat.1 index d4a4616b386..8a8a3629de2 100644 --- a/debian/mongostat.1 +++ b/debian/mongostat.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOSTAT" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOSTAT" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongostat \- MongoDB Use Statistics . @@ -61,11 +61,16 @@ For an additional utility that provides MongoDB metrics see \fBmongotop\fP\&. .UNINDENT .UNINDENT +.SH ACCESS CONTROL REQUIREMENTS .sp -\fBmongostat\fP connects to the \fBmongod\fP instance running -on the local host interface on TCP port \fB27017\fP; however, -\fBmongostat\fP can connect to any accessible remote \fBmongod\fP -instance. +In order to connect to a \fBmongod\fP that enforces authorization +with the \fI\-\-auth\fP option, specify the +\fI\-\-username\fP and \fI\-\-password\fP options, and the user specified must have the +\fBserverStatus\fP privilege action on the cluster resources. +.sp +The built\-in role \fBclusterMonitor\fP provides this privilege as +well as other privileges. To create a role with just the privilege to +run \fBmongostat\fP, see \fIcreate\-role\-for\-mongostat\fP\&. .SH OPTIONS .INDENT 0.0 .TP @@ -77,8 +82,8 @@ instance. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongostat\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongostat\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -94,19 +99,22 @@ Returns the \fBmongostat\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> +\fIDefault\fP: localhost:27017 +.sp Specifies a resolvable hostname for the \fBmongod\fP to which to -connect. By default \fBmongostat\fP attempts to connect to a MongoDB instance -running on the localhost on port number \fB27017\fP\&. +connect. By default, the \fBmongostat\fP attempts to connect to a MongoDB +instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the +\fBreplSetName\fP and a seed list of set members, as in +the following: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -114,20 +122,26 @@ seed list of set members. Use the following format: .sp You can always connect directly to a single MongoDB instance by specifying the host and port number directly. +.sp +Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must +enclose the portion of an address and port combination in +brackets (e.g. \fB[<address>]\fP). + .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongostat\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongostat\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongostat\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -153,6 +167,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -166,8 +195,8 @@ or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -179,13 +208,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongostat\fP will +\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongostat\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\-\-sslPEMKeyPassword\fP, \fBmongostat\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongostat\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -211,7 +240,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -219,30 +248,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongostat\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongostat\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. +Directs the \fBmongostat\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\-\-password\fP, \fBmongostat\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP @@ -251,22 +299,85 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongostat\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. +.sp +\fI\-\-authenticationDatabase\fP is required for \fBmongod\fP +and \fBmongos\fP instances that use \fIauthentication\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongostat\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongostat\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP @@ -275,12 +386,12 @@ Disables the output of column or field names. .UNINDENT .INDENT 0.0 .TP -.B \-\-rowcount <number>, \-n +.B \-\-rowcount <number>, \-n <number> Controls the number of rows to output. Use in conjunction with the \fBsleeptime\fP argument to control the duration of a \fBmongostat\fP operation. .sp -Unless \fI\%\-\-rowcount\fP is specified, \fBmongostat\fP +Unless \fI\-\-rowcount\fP is specified, \fBmongostat\fP will return an infinite number of rows (e.g. value of \fB0\fP\&.) .UNINDENT .INDENT 0.0 @@ -314,6 +425,14 @@ Configures \fBmongostat\fP to return all optional \fI\%fields\fP\&. .UNINDENT .INDENT 0.0 .TP +.B \-\-json +New in version 3.0.0. + +.sp +Returns output for \fBmongostat\fP in \fIJSON\fP format. +.UNINDENT +.INDENT 0.0 +.TP .B <sleeptime> The final argument is the length of time, in seconds, that \fBmongostat\fP waits in between calls. By default \fBmongostat\fP @@ -529,6 +648,12 @@ T} T{ \fIslave\fP T} _ +T{ +RTR +T} T{ +mongos process ("router") +T} +_ .TE .UNINDENT .SH USAGE @@ -606,6 +731,6 @@ mongostat \-\-discover .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . diff --git a/debian/mongotop.1 b/debian/mongotop.1 index d6646d51470..ec868094a84 100644 --- a/debian/mongotop.1 +++ b/debian/mongotop.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOTOP" "1" "March 18, 2014" "2.6" "mongodb-manual" +.TH "MONGOTOP" "1" "January 30, 2015" "3.0" "mongodb-manual" .SH NAME mongotop \- MongoDB Activity Monitor . @@ -37,6 +37,21 @@ MongoDB instance spends reading and writing data. \fBmongotop\fP provides statistics on a per\-collection level. By default, \fBmongotop\fP returns values every second. .sp +\fBIMPORTANT:\fP +.INDENT 0.0 +.INDENT 3.5 +In order to connect to a \fBmongod\fP that enforces +authorization with the \fI\-\-auth\fP option, the +\fI\-\-username\fP and +\fI\-\-password\fP options must be used, and the +user specified must have the \fBserverStatus\fP and +\fBtop\fP privileges. +.sp +The most appropriate built\-in role that has these privileges is +\fBclusterMonitor\fP\&. +.UNINDENT +.UNINDENT +.sp \fBSEE ALSO:\fP .INDENT 0.0 .INDENT 3.5 @@ -71,8 +86,8 @@ see \fBmongostat\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-help, \-h -Returns information on \fBmongotop\fP options and usage. +.B \-\-help +Returns information on the options and use of \fBmongotop\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -84,8 +99,10 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs \fBmongotop\fP in a quiet mode that attempts to limit the amount of -output. This option suppresses: +Runs the \fBmongotop\fP in a quiet mode that attempts to limit the amount +of output. +.sp +This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP @@ -104,19 +121,22 @@ Returns the \fBmongotop\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port>, \-h +.B \-\-host <hostname><:port>, \-h <hostname><:port> +\fIDefault\fP: localhost:27017 +.sp Specifies a resolvable hostname for the \fBmongod\fP to which to -connect. By default \fBmongotop\fP attempts to connect to a MongoDB instance -running on the localhost on port number \fB27017\fP\&. +connect. By default, the \fBmongotop\fP attempts to connect to a MongoDB +instance running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, specify the replica set seed name and the -seed list of set members. Use the following format: +To connect to a replica set, specify the +\fBreplSetName\fP and a seed list of set members, as in +the following: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... +<replSetName>/<hostname1><:port>,<hostname2><:port>,<...> .ft P .fi .UNINDENT @@ -124,20 +144,29 @@ seed list of set members. Use the following format: .sp You can always connect directly to a single MongoDB instance by specifying the host and port number directly. +.sp +Changed in version 3.0.0: If you use IPv6 and use the \fB<address>:<port>\fP format, you must +enclose the portion of an address and port combination in +brackets (e.g. \fB[<address>]\fP). + +.sp +If connected to a replica set where the \fIprimary\fP is not +reachable, \fBmongotop\fP returns an error message. .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies the port number when the MongoDB instance is not running on the -standard port of \fB27017\fP\&. You may also specify the port number -using the \fB\-\-host\fP option. +\fIDefault\fP: 27017 +.sp +Specifies the TCP port on which the MongoDB instance listens for +client connections. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support, which allows \fBmongotop\fP to connect to the MongoDB -instance using an IPv6 network. All MongoDB programs and processes, -including \fBmongotop\fP, disable IPv6 support by default. +Enables IPv6 support and allows the \fBmongotop\fP to connect to the +MongoDB instance using an IPv6 network. All MongoDB programs and +processes disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -163,6 +192,21 @@ from the Certificate Authority. Specify the file name of the .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the \fBmongo\fP shell or any other tool that connects to +\fBmongos\fP or \fBmongod\fP is run without +\fI\-\-sslCAFile\fP, it will not attempt to validate +server certificates. This results in vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as well as to foreign +processes posing as valid \fBmongod\fP or \fBmongos\fP +instances. Ensure that you \fIalways\fP specify the CA file against which +server certificates should be validated in cases where intrusion is a +possibility. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -176,8 +220,8 @@ or absolute paths. .sp This option is required when using the \fI\%\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has -\fBsslCAFile\fP enabled \fIwithout\fP -\fBsslWeakCertificateValidation\fP\&. +\fBCAFile\fP enabled \fIwithout\fP +\fBallowConnectionsWithoutCertificates\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -189,13 +233,13 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-sslPEMKeyFile\fP). Use \fI\%\-\-sslPEMKeyPassword\fP only if -the certificate\-key file is encrypted. In all cases, \fBmongotop\fP will +\fI\%\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the +certificate\-key file is encrypted. In all cases, the \fBmongotop\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify -\fI\%\-\-sslPEMKeyPassword\fP, \fBmongotop\fP will prompt for a passphrase. -See \fIssl\-certificate\-password\fP\&. +the \fI\%\-\-sslPEMKeyPassword\fP option, the \fBmongotop\fP will prompt for a passphrase. See +\fIssl\-certificate\-password\fP\&. .sp The default distribution of MongoDB does not contain support for SSL. For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. @@ -221,7 +265,7 @@ New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the -\fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a +\fBallowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp The default distribution of MongoDB does not contain support for SSL. @@ -229,30 +273,49 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto .UNINDENT .INDENT 0.0 .TP +.B \-\-sslAllowInvalidHostnames +New in version 3.0. + +.sp +Disables the validation of the hostnames in SSL certificates. Allows +\fBmongotop\fP to connect to MongoDB instances if the hostname their +certificates do not match the specified hostname. +.UNINDENT +.INDENT 0.0 +.TP .B \-\-sslFIPSMode New in version 2.6. .sp -Directs \fBmongotop\fP to use the FIPS mode of the installed OpenSSL -library. Your system must -have a FIPS compliant OpenSSL library to use \fI\%\-\-sslFIPSMode\fP\&. +Directs the \fBmongotop\fP to use the FIPS mode of the installed OpenSSL +library. Your system must have a FIPS compliant OpenSSL library to use +the \fI\%\-\-sslFIPSMode\fP option. .sp -The default distribution of MongoDB does not contain support for SSL. -For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tutorial/configure\-ssl\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +FIPS Compatible SSL is +available only in \fI\%MongoDB Enterprise\fP\&. See +http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u +.B \-\-username <username>, \-u <username> Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP -.B \-\-password <password>, \-p +.B \-\-password <password>, \-p <password> Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. +.sp +If you do not specify an argument for \fI\%\-\-password\fP, \fBmongotop\fP will +prompt interactively for a password on the console. .UNINDENT .INDENT 0.0 .TP @@ -261,22 +324,86 @@ New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. -If you do not specify an authentication database, \fBmongotop\fP assumes -that the database specified as the argument to the \fI\-\-db\fP option -holds the user\(aqs credentials. +.sp +Changed in version 3.0.0: \fI\%\-\-authenticationDatabase\fP is required for \fBmongod\fP +and \fBmongos\fP instances that use \fIauthentication\fP\&. + .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> +\fIDefault\fP: MONGODB\-CR +.sp New in version 2.4. .sp -Specifies the authentication mechanism. By default, the authentication -mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response -authentication mechanism. In MongoDB Enterprise, \fBmongotop\fP also includes -support for \fBGSSAPI\fP to handle Kerberos authentication. See -http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. +Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication +mechanisms. + +.sp +Specifies the authentication mechanism the \fBmongotop\fP instance uses to +authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +MONGODB\-CR +T} T{ +MongoDB challenge/response authentication. +T} +_ +T{ +MONGODB\-X509 +T} T{ +MongoDB SSL certificate authentication. +T} +_ +T{ +PLAIN +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ +T{ +GSSAPI +T} T{ +External authentication using Kerberos. This mechanism is +available only in \fI\%MongoDB Enterprise\fP\&. +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiServiceName +New in version 2.6. + +.sp +Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +default name of \fBmongodb\fP\&. +.sp +This option is available only in MongoDB Enterprise. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-gssapiHostName +New in version 2.6. + +.sp +Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +not match the hostname resolved by DNS. +.sp +This option is available only in MongoDB Enterprise. .UNINDENT .INDENT 0.0 .TP @@ -284,6 +411,22 @@ for more information about Kerberos authentication. Toggles the mode of \fBmongotop\fP to report on use of per\-database \fIlocks\fP\&. These data are useful for measuring concurrent operations and lock percentage. +.sp +\fI\%\-\-locks\fP returns an error when called against a \fBmongod\fP instance +that does not report lock usage. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-rowcount int, \-n int +Number of lines of data that \fBmongotop\fP should print. "0 for indefinite" +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-json +New in version 3.0.0. + +.sp +Returns output for \fBmongotop\fP in \fIJSON\fP format. .UNINDENT .INDENT 0.0 .TP @@ -308,7 +451,7 @@ affect the output of \fBmongotop\fP\&. Contains the database namespace, which combines the database name and collection. .sp -Changed in version 2.2: If you use the \fI\%\-\-locks\fP, the \fBns\fP field does not +Changed in version 2.2: If you use the \fImongotop \-\-locks\fP, the \fBns\fP field does not appear in the \fBmongotop\fP output. .UNINDENT @@ -375,26 +518,37 @@ This command produces the following output: .sp .nf .ft C -connected to: 127.0.0.1 - - ns total read write 2012\-08\-13T15:45:40 -test.system.namespaces 0ms 0ms 0ms - local.system.replset 0ms 0ms 0ms - local.system.indexes 0ms 0ms 0ms - admin.system.indexes 0ms 0ms 0ms - admin. 0ms 0ms 0ms + ns total read write 2014\-12\-19T15:32:01\-05:00 + admin.system.roles 0ms 0ms 0ms + admin.system.version 0ms 0ms 0ms + local.me 0ms 0ms 0ms + local.oplog.rs 0ms 0ms 0ms + local.replset.minvalid 0ms 0ms 0ms + local.startup_log 0ms 0ms 0ms + local.system.indexes 0ms 0ms 0ms +local.system.namespaces 0ms 0ms 0ms + local.system.replset 0ms 0ms 0ms - ns total read write 2012\-08\-13T15:45:55 -test.system.namespaces 0ms 0ms 0ms - local.system.replset 0ms 0ms 0ms - local.system.indexes 0ms 0ms 0ms - admin.system.indexes 0ms 0ms 0ms - admin. 0ms 0ms 0ms + ns total read write 2014\-12\-19T15:47:01\-05:00 + admin.system.roles 0ms 0ms 0ms + admin.system.version 0ms 0ms 0ms + local.me 0ms 0ms 0ms + local.oplog.rs 0ms 0ms 0ms + local.replset.minvalid 0ms 0ms 0ms + local.startup_log 0ms 0ms 0ms + local.system.indexes 0ms 0ms 0ms +local.system.namespaces 0ms 0ms 0ms + local.system.replset 0ms 0ms 0ms .ft P .fi .UNINDENT .UNINDENT .sp +The output varies depending on your MongoDB setup. For example, +\fBlocal.system.indexes\fP and \fBlocal.system.namespaces\fP only appear +for \fBmongod\fP instances using the \fIMMAPv1\fP +storage engine. +.sp To return a \fBmongotop\fP report every 5 minutes, use the following command: .INDENT 0.0 @@ -408,7 +562,7 @@ mongotop 300 .UNINDENT .UNINDENT .sp -To report the use of per\-database locks, use \fImongotop \-\-locks\fP, +To report the use of per\-database locks, use \fI\%\-\-locks\fP, which produces the following output: .INDENT 0.0 .INDENT 3.5 @@ -426,9 +580,14 @@ connected to: 127.0.0.1 .fi .UNINDENT .UNINDENT +.sp +Changed in version 3.0.0: When called against a \fBmongod\fP that does not report lock +usage, \fI\%\-\-locks\fP will return a \fBFailed: Server does not +support reporting locking information\fP error. + .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2014, MongoDB, Inc. +2011-2015 .\" Generated by docutils manpage writer. . |