mirror of https://github.com/mongodb/mongo
SERVER-64834 Updating man pages for 6.0
This commit is contained in:
parent
a14ebbf41e
commit
835f3e043c
|
|
@ -19,6 +19,10 @@ more details, see \fBDisable TLS 1.0\f1\&.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.RS
|
.RS
|
||||||
.IP \(bu 2
|
.IP \(bu 2
|
||||||
|
MongoDB removes the \fB\-\-cpu\f1 command\-line option.
|
||||||
|
.RE
|
||||||
|
.RS
|
||||||
|
.IP \(bu 2
|
||||||
MongoDB removes the \fB\-\-serviceExecutor\f1 command\-line option and the
|
MongoDB removes the \fB\-\-serviceExecutor\f1 command\-line option and the
|
||||||
corresponding \fBnet.serviceExecutor\f1 configuration option.
|
corresponding \fBnet.serviceExecutor\f1 configuration option.
|
||||||
.RE
|
.RE
|
||||||
|
|
@ -194,10 +198,15 @@ link\-local IPv6 address (https://en.wikipedia.org/wiki/Link\-local_address#IPv6
|
||||||
zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index))
|
zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index))
|
||||||
to that address (i.e. \fBfe80::<address>%<adapter\-name>\f1).
|
to that address (i.e. \fBfe80::<address>%<adapter\-name>\f1).
|
||||||
.PP
|
.PP
|
||||||
When possible, use a logical DNS hostname instead of an ip address,
|
To avoid configuration updates due to IP address changes, use DNS
|
||||||
particularly when configuring replica set members or sharded cluster
|
hostnames instead of IP addresses. It is particularly important to
|
||||||
members. The use of logical DNS hostnames avoids configuration
|
use a DNS hostname instead of an IP address when configuring replica
|
||||||
changes due to ip address changes.
|
set members or sharded cluster members.
|
||||||
|
.PP
|
||||||
|
Use hostnames instead of IP addresses to configure clusters across a
|
||||||
|
split network horizon. Starting in MongoDB 5.0, nodes that are only
|
||||||
|
configured with an IP address will fail startup validation and will
|
||||||
|
not start.
|
||||||
.PP
|
.PP
|
||||||
Before binding to a non\-localhost (e.g. publicly accessible)
|
Before binding to a non\-localhost (e.g. publicly accessible)
|
||||||
IP address, ensure you have secured your cluster from unauthorized
|
IP address, ensure you have secured your cluster from unauthorized
|
||||||
|
|
@ -677,13 +686,6 @@ connect to the \fBmongod\f1\f1 using the appropriate \fBuser\f1
|
||||||
prior to restarting \fBmongod\f1\f1 without \fB\-\-transitionToAuth\f1\f1\&.
|
prior to restarting \fBmongod\f1\f1 without \fB\-\-transitionToAuth\f1\f1\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
\fBmongod \-\-cpu\f1
|
|
||||||
.RS
|
|
||||||
.PP
|
|
||||||
Forces the \fBmongod\f1\f1 process to report the percentage of CPU time in
|
|
||||||
write lock, every four seconds.
|
|
||||||
.RE
|
|
||||||
.PP
|
|
||||||
\fBmongod \-\-sysinfo\f1
|
\fBmongod \-\-sysinfo\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -721,6 +723,8 @@ For additional ways to shut down, see also \fBStop mongod\f1 Processes\f1\&.
|
||||||
\fBmongod \-\-redactClientLogData\f1
|
\fBmongod \-\-redactClientLogData\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given
|
A \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given
|
||||||
log event before logging. This prevents the \fBmongod\f1\f1 from writing
|
log event before logging. This prevents the \fBmongod\f1\f1 from writing
|
||||||
potentially sensitive data stored on the database to the diagnostic log.
|
potentially sensitive data stored on the database to the diagnostic log.
|
||||||
|
|
@ -935,6 +939,8 @@ For the corresponding configuration file setting, see
|
||||||
\fBmongod \-\-ldapServers\f1
|
\fBmongod \-\-ldapServers\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The LDAP server against which the \fBmongod\f1\f1 authenticates users or
|
The LDAP server against which the \fBmongod\f1\f1 authenticates users or
|
||||||
determines what actions a user is authorized to perform on a given
|
determines what actions a user is authorized to perform on a given
|
||||||
database. If the LDAP server specified has any replicated instances,
|
database. If the LDAP server specified has any replicated instances,
|
||||||
|
|
@ -975,6 +981,8 @@ server is unavailable.
|
||||||
\fBmongod \-\-ldapQueryUser\f1
|
\fBmongod \-\-ldapQueryUser\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The identity with which \fBmongod\f1\f1 binds as, when connecting to or
|
The identity with which \fBmongod\f1\f1 binds as, when connecting to or
|
||||||
performing queries on an LDAP server.
|
performing queries on an LDAP server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -1000,28 +1008,27 @@ instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You
|
||||||
both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
\fBmongod \-\-ldapQueryPassword\f1
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
.RS
|
|
||||||
.PP
|
.PP
|
||||||
The password used to bind to an LDAP server when using
|
The password used to bind to an LDAP server when using
|
||||||
\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with
|
\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with
|
||||||
\fB\-\-ldapQueryUser\f1\f1\&.
|
\fB\-\-ldapQueryUser\f1\f1\&.
|
||||||
.PP
|
.PP
|
||||||
If unset, \fBmongod\f1\f1 will not attempt to bind to the LDAP server.
|
If not set, \fBmongod\f1\f1 does not attempt to bind to the LDAP server.
|
||||||
.PP
|
.PP
|
||||||
This setting can be configured on a running \fBmongod\f1\f1 using
|
You can configure this setting on a running \fBmongod\f1\f1 using
|
||||||
\fBsetParameter\f1\f1\&.
|
\fBsetParameter\f1\f1\&.
|
||||||
.PP
|
.PP
|
||||||
Starting in MongoDB 4.4, the \fBldapQueryPassword\f1
|
Starting in MongoDB 4.4, the \fBldapQueryPassword\f1
|
||||||
\fBsetParameter\f1\f1 command accepts either a string or
|
\fBsetParameter\f1\f1 command accepts either a string or
|
||||||
an array of strings. If set to an array, each password is tried
|
an array of strings. If \fBldapQueryPassword\f1 is set to an array, MongoDB tries
|
||||||
until one succeeds. This can be used to perform a rollover of the
|
each password in order until one succeeds. Use a password array to roll over the
|
||||||
LDAP account password without downtime for MongoDB.
|
LDAP account password without downtime.
|
||||||
.PP
|
.PP
|
||||||
Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1
|
Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1
|
||||||
instead of \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify
|
instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&.
|
||||||
both \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
You cannot specify both \fB\-\-ldapQueryPassword\f1\f1 and
|
||||||
.RE
|
\fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
||||||
.PP
|
.PP
|
||||||
\fBmongod \-\-ldapBindWithOSDefaults\f1
|
\fBmongod \-\-ldapBindWithOSDefaults\f1
|
||||||
.RS
|
.RS
|
||||||
|
|
@ -1052,6 +1059,8 @@ Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 an
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: simple
|
\fIDefault\f1: simple
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The method \fBmongod\f1\f1 uses to authenticate to an LDAP server.
|
The method \fBmongod\f1\f1 uses to authenticate to an LDAP server.
|
||||||
Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to
|
Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to
|
||||||
connect to the LDAP server.
|
connect to the LDAP server.
|
||||||
|
|
@ -1074,6 +1083,8 @@ using \fBDIGEST\-MD5\f1 mechanism.
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: DIGEST\-MD5
|
\fIDefault\f1: DIGEST\-MD5
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A comma\-separated list of SASL mechanisms \fBmongod\f1\f1 can
|
A comma\-separated list of SASL mechanisms \fBmongod\f1\f1 can
|
||||||
use when authenticating to the LDAP server. The \fBmongod\f1\f1 and the
|
use when authenticating to the LDAP server. The \fBmongod\f1\f1 and the
|
||||||
LDAP server must agree on at least one mechanism. The \fBmongod\f1\f1
|
LDAP server must agree on at least one mechanism. The \fBmongod\f1\f1
|
||||||
|
|
@ -1145,6 +1156,8 @@ For Windows, please see the Windows SASL documentation (https://msdn.microsoft.c
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: tls
|
\fIDefault\f1: tls
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
By default, \fBmongod\f1\f1 creates a TLS/SSL secured connection to the LDAP
|
By default, \fBmongod\f1\f1 creates a TLS/SSL secured connection to the LDAP
|
||||||
server.
|
server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -1173,6 +1186,8 @@ credentials between \fBmongod\f1\f1 and the LDAP server.
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: 10000
|
\fIDefault\f1: 10000
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The amount of time in milliseconds \fBmongod\f1\f1 should wait for an LDAP server
|
The amount of time in milliseconds \fBmongod\f1\f1 should wait for an LDAP server
|
||||||
to respond to a request.
|
to respond to a request.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -1188,6 +1203,8 @@ This setting can be configured on a running \fBmongod\f1\f1 using
|
||||||
\fBmongod \-\-ldapUserToDNMapping\f1
|
\fBmongod \-\-ldapUserToDNMapping\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
Maps the username provided to \fBmongod\f1\f1 for authentication to a LDAP
|
Maps the username provided to \fBmongod\f1\f1 for authentication to a LDAP
|
||||||
Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a
|
Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a
|
||||||
username into an LDAP DN in the following scenarios:
|
username into an LDAP DN in the following scenarios:
|
||||||
|
|
@ -1352,6 +1369,8 @@ This setting can be configured on a running \fBmongod\f1\f1 using the
|
||||||
\fBmongod \-\-ldapAuthzQueryTemplate\f1
|
\fBmongod \-\-ldapAuthzQueryTemplate\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongod\f1\f1 executes to obtain
|
A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongod\f1\f1 executes to obtain
|
||||||
the LDAP groups to which the authenticated user belongs to. The query is
|
the LDAP groups to which the authenticated user belongs to. The query is
|
||||||
relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&.
|
relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&.
|
||||||
|
|
@ -1459,7 +1478,7 @@ To specify the \fBWiredTiger Storage Engine\f1\&.
|
||||||
.IP \(bu 4
|
.IP \(bu 4
|
||||||
To specify the \fBIn\-Memory Storage Engine\f1\&.
|
To specify the \fBIn\-Memory Storage Engine\f1\&.
|
||||||
.IP
|
.IP
|
||||||
Available in MongoDB Enterprise only.
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
.RE
|
.RE
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -2015,10 +2034,18 @@ and is always set to \fBtrue\f1\&. In earlier versions of MongoDB,
|
||||||
\fB\-\-enableMajorityReadConcern\f1\f1 was configurable.
|
\fB\-\-enableMajorityReadConcern\f1\f1 was configurable.
|
||||||
.PP
|
.PP
|
||||||
If you are using a three\-member primary\-secondary\-arbiter (PSA)
|
If you are using a three\-member primary\-secondary\-arbiter (PSA)
|
||||||
architecture, the write concern \fB"majority"\f1\f1 can cause
|
architecture, consider the following:
|
||||||
performance issues if a secondary is unavailable or lagging. See
|
.RS
|
||||||
\fBMitigate Performance Issues with PSA Replica Set\f1 for advice on how to mitigate these
|
.IP \(bu 2
|
||||||
issues.
|
The write concern \fB"majority"\f1\f1 can cause
|
||||||
|
performance issues if a secondary is unavailable or lagging. For
|
||||||
|
advice on how to mitigate these issues, see
|
||||||
|
\fBMitigate Performance Issues with PSA Replica Set\f1\&.
|
||||||
|
.IP \(bu 2
|
||||||
|
If you are using a global default \fB"majority"\f1\f1
|
||||||
|
and the write concern is less than the size of the majority,
|
||||||
|
your queries may return stale (not fully replicated) data.
|
||||||
|
.RE
|
||||||
.RE
|
.RE
|
||||||
.SS SHARDED CLUSTER OPTIONS
|
.SS SHARDED CLUSTER OPTIONS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -3331,7 +3358,17 @@ This is the default profiler level.
|
||||||
\fB1\f1
|
\fB1\f1
|
||||||
.IP \(bu 4
|
.IP \(bu 4
|
||||||
The profiler collects data for operations that take longer
|
The profiler collects data for operations that take longer
|
||||||
than the value of \fBslowms\f1\&.
|
than the value of \fBslowms\f1 or that match a \fBfilter\f1\&.
|
||||||
|
.IP
|
||||||
|
When a filter is set:
|
||||||
|
.RS
|
||||||
|
.IP \(bu 6
|
||||||
|
The \fBslowms\f1 and \fBsampleRate\f1 options are not used for
|
||||||
|
profiling.
|
||||||
|
.IP \(bu 6
|
||||||
|
The profiler only captures operations that match the
|
||||||
|
\fBfilter\f1\&.
|
||||||
|
.RE
|
||||||
.RE
|
.RE
|
||||||
.IP \(bu 2
|
.IP \(bu 2
|
||||||
.RS
|
.RS
|
||||||
|
|
@ -3361,9 +3398,7 @@ that run for longer than this threshold are considered \fIslow\f1\&.
|
||||||
.PP
|
.PP
|
||||||
When \fBlogLevel\f1\f1 is set to \fB0\f1, MongoDB records \fIslow\f1
|
When \fBlogLevel\f1\f1 is set to \fB0\f1, MongoDB records \fIslow\f1
|
||||||
operations to the diagnostic log at a rate determined by
|
operations to the diagnostic log at a rate determined by
|
||||||
\fBslowOpSampleRate\f1\f1\&. Starting in MongoDB
|
\fBslowOpSampleRate\f1\f1\&.
|
||||||
4.2, the secondaries of replica sets log \fBall oplog entry messages
|
|
||||||
that take longer than the slow operation threshold to apply\f1 regardless of the sample rate.
|
|
||||||
.PP
|
.PP
|
||||||
At higher \fBlogLevel\f1\f1 settings, all operations appear in
|
At higher \fBlogLevel\f1\f1 settings, all operations appear in
|
||||||
the diagnostic log regardless of their latency with the following
|
the diagnostic log regardless of their latency with the following
|
||||||
|
|
@ -3395,6 +3430,43 @@ diagnostic log and, if enabled, the profiler.
|
||||||
.RE
|
.RE
|
||||||
.SS AUDIT OPTIONS
|
.SS AUDIT OPTIONS
|
||||||
.PP
|
.PP
|
||||||
|
\fBmongod \-\-auditCompressionMode\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Specifies the compression mode for \fBaudit log encryption\f1\&. You must also enable audit log
|
||||||
|
encryption using either \fB\-\-auditEncryptionKeyUID\f1\f1 or
|
||||||
|
\fB\-\-auditLocalKeyFile\f1\f1\&.
|
||||||
|
.PP
|
||||||
|
\fB\-\-auditCompressionMode\f1\f1 can be set to one of these values:
|
||||||
|
.RS
|
||||||
|
.IP \(bu 2
|
||||||
|
.RS
|
||||||
|
.IP \(bu 4
|
||||||
|
Value
|
||||||
|
.IP \(bu 4
|
||||||
|
Description
|
||||||
|
.RE
|
||||||
|
.IP \(bu 2
|
||||||
|
.RS
|
||||||
|
.IP \(bu 4
|
||||||
|
\fBzstd\f1
|
||||||
|
.IP \(bu 4
|
||||||
|
Use the \fBzstd\f1 algorithm to compress the audit log.
|
||||||
|
.RE
|
||||||
|
.IP \(bu 2
|
||||||
|
.RS
|
||||||
|
.IP \(bu 4
|
||||||
|
\fBnone\f1 \fI(default)\f1
|
||||||
|
.IP \(bu 4
|
||||||
|
Do not compress the audit log.
|
||||||
|
.RE
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&.
|
||||||
|
MongoDB Enterprise and Atlas have different configuration
|
||||||
|
requirements.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fBmongod \-\-auditDestination\f1
|
\fBmongod \-\-auditDestination\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -3445,6 +3517,20 @@ Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-e
|
||||||
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
|
\fBmongod \-\-auditEncryptionKeyUID\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Specifies the unique identifier of the Key Management
|
||||||
|
Interoperability Protocol (KMIP) key for \fBaudit log encryption\f1\&.
|
||||||
|
.PP
|
||||||
|
You cannot use \fB\-\-auditEncryptionKeyUID\f1\f1 and
|
||||||
|
\fB\-\-auditLocalKeyFile\f1\f1 together.
|
||||||
|
.PP
|
||||||
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&.
|
||||||
|
MongoDB Enterprise and Atlas have different configuration
|
||||||
|
requirements.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fBmongod \-\-auditFormat\f1
|
\fBmongod \-\-auditFormat\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -3483,6 +3569,25 @@ Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-e
|
||||||
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
|
\fBmongod \-\-auditLocalKeyFile\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Specifies the path and file name for a local audit key file for
|
||||||
|
\fBaudit log encryption\f1\&.
|
||||||
|
.PP
|
||||||
|
Only use \fB\-\-auditLocalKeyFile\f1\f1 for testing because the key is
|
||||||
|
not secured. To secure the key, use
|
||||||
|
\fB\-\-auditEncryptionKeyUID\f1\f1 and an external Key
|
||||||
|
Management Interoperability Protocol (KMIP) server.
|
||||||
|
.PP
|
||||||
|
You cannot use \fB\-\-auditLocalKeyFile\f1\f1 and
|
||||||
|
\fB\-\-auditEncryptionKeyUID\f1\f1 together.
|
||||||
|
.PP
|
||||||
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&.
|
||||||
|
MongoDB Enterprise and Atlas have different configuration
|
||||||
|
requirements.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fBmongod \-\-auditPath\f1
|
\fBmongod \-\-auditPath\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -3517,6 +3622,37 @@ the configuration file.
|
||||||
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)
|
||||||
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
||||||
.RE
|
.RE
|
||||||
|
.SS SNMP OPTIONS
|
||||||
|
.PP
|
||||||
|
MongoDB Enterprise on macOS does \fInot\f1 include support for SNMP due
|
||||||
|
to SERVER\-29352 (https://jira.mongodb.org/browse/SERVER\-29352)\&.
|
||||||
|
.PP
|
||||||
|
\fBmongod \-\-snmp\-disabled\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Disables SNMP access to \fBmongod\f1\f1\&. The option is incompatible
|
||||||
|
with \fB\-\-snmp\-subagent\f1\f1 and \fB\-\-snmp\-master\f1\f1\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBmongod \-\-snmp\-subagent\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Runs SNMP as a subagent. The option is incompatible with \fB\-\-snmp\-disabled\f1\f1\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBmongod \-\-snmp\-master\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Runs SNMP as a master. The option is incompatible with \fB\-\-snmp\-disabled\f1\f1\&.
|
||||||
|
.RE
|
||||||
|
.RS
|
||||||
|
.IP \(bu 2
|
||||||
|
\fBMonitor MongoDB With SNMP on Linux\f1
|
||||||
|
.IP \(bu 2
|
||||||
|
\fBMonitor MongoDB Windows with SNMP\f1
|
||||||
|
.IP \(bu 2
|
||||||
|
\fBTroubleshoot SNMP\f1
|
||||||
|
.RE
|
||||||
.SS INMEMORY OPTIONS
|
.SS INMEMORY OPTIONS
|
||||||
.PP
|
.PP
|
||||||
\fBmongod \-\-inMemorySizeGB\f1
|
\fBmongod \-\-inMemorySizeGB\f1
|
||||||
|
|
@ -3792,8 +3928,36 @@ KMIP server.
|
||||||
.PP
|
.PP
|
||||||
Starting in 4.0, on macOS or Windows, you can use a certificate
|
Starting in 4.0, on macOS or Windows, you can use a certificate
|
||||||
from the operating system\(aqs secure store instead of a PEM key
|
from the operating system\(aqs secure store instead of a PEM key
|
||||||
file. See \fB\-\-kmipClientCertificateSelector\f1\f1\&. When using the secure store, you do not
|
file. See \fB\-\-kmipClientCertificateSelector\f1\f1\&. When using the secure
|
||||||
need to, but can, also specify the \fB\-\-kmipServerCAFile\f1\f1\&.
|
store, you do not need to, but can, also specify the \fB\-\-kmipServerCAFile\f1\f1\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBmongod \-\-kmipActivateKeys\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
\fIDefault\f1: true
|
||||||
|
.PP
|
||||||
|
Activates all newly created KMIP keys upon creation and then periodically
|
||||||
|
checks those keys are in an active state.
|
||||||
|
.PP
|
||||||
|
When \fB\-\-kmipActivateKeys\f1 is \fBtrue\f1 and you have existing keys on a
|
||||||
|
KMIP server, the key must be activated first or the \fBmongod\f1\f1 node
|
||||||
|
will fail to start.
|
||||||
|
.PP
|
||||||
|
If the key being used by the mongod transitions into a non\-active state,
|
||||||
|
the \fBmongod\f1\f1 node will shut down unless \fBkmipActivateKeys\f1 is
|
||||||
|
false. To ensure you have an active key, rotate the KMIP master key by
|
||||||
|
using \fB\-\-kmipRotateMasterKey\f1\f1\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBmongod \-\-kmipKeyStatePollingSeconds\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
\fIDefault\f1: 900 seconds
|
||||||
|
.PP
|
||||||
|
Frequency in seconds at which mongod polls the KMIP server for active keys.
|
||||||
|
.PP
|
||||||
|
To disable disable polling, set the value to \fB\-1\f1\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
\fBmongod \-\-eseDatabaseKeyRollover\f1
|
\fBmongod \-\-eseDatabaseKeyRollover\f1
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,6 +1,8 @@
|
||||||
.TH mongoldap 1
|
.TH mongoldap 1
|
||||||
.SH MONGOLDAP
|
.SH MONGOLDAP
|
||||||
|
\fIMongoDB Enterprise\f1
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
.PP
|
||||||
Starting in version 3.4, MongoDB Enterprise provides
|
Starting in version 3.4, MongoDB Enterprise provides
|
||||||
\fBmongoldap\f1\f1 for testing MongoDB\(aqs LDAP \fBconfiguration
|
\fBmongoldap\f1\f1 for testing MongoDB\(aqs LDAP \fBconfiguration
|
||||||
options\f1 against a running LDAP server or set
|
options\f1 against a running LDAP server or set
|
||||||
|
|
@ -174,6 +176,18 @@ configuration files are valid, the output might be as follows:
|
||||||
[OK] Successfully acquired the following roles:
|
[OK] Successfully acquired the following roles:
|
||||||
...
|
...
|
||||||
.EE
|
.EE
|
||||||
|
.SH BEHAVIOR
|
||||||
|
.PP
|
||||||
|
Starting in MonogoDB 5.1, \fBmongoldap\f1 supports prefixing LDAP
|
||||||
|
server with \fBsrv:\f1 and \fBsrv_raw:\f1\&.
|
||||||
|
.PP
|
||||||
|
If your connection string specifies \fB"srv:<DNS_NAME>"\f1, \fBmongoldap\f1
|
||||||
|
verifies that \fB"_ldap._tcp.gc._msdcs.<DNS_NAME>"\f1 exists for SRV to
|
||||||
|
support Active Directory. If not found, it verifies
|
||||||
|
\fB"_ldap._tcp.<DNS_NAME>"\f1 exists for SRV. If an SRV record cannot be
|
||||||
|
found, \fBmongoldap\f1 warns you to use \fB"srv_raw:<DNS_NAME>"\f1 instead.
|
||||||
|
\fBmongoldap\f1 does the reverse check for \fB"srv_raw:<DNS_NAME>"\f1 by
|
||||||
|
checking for \fB"_ldap._tcp.<DNS NAME>"\f1\&.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.PP
|
.PP
|
||||||
\fBmongoldap \-\-config\f1, \fBmongoldap \-f\f1
|
\fBmongoldap \-\-config\f1, \fBmongoldap \-f\f1
|
||||||
|
|
@ -235,6 +249,8 @@ If unset, \fBmongoldap\f1\f1 cannot use \fBLDAP authentication or authorization\
|
||||||
\fBmongoldap \-\-ldapQueryUser\f1
|
\fBmongoldap \-\-ldapQueryUser\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The identity with which \fBmongoldap\f1\f1 binds as, when connecting to or
|
The identity with which \fBmongoldap\f1\f1 binds as, when connecting to or
|
||||||
performing queries on an LDAP server.
|
performing queries on an LDAP server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -260,22 +276,27 @@ instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You
|
||||||
both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
\fBmongoldap \-\-ldapQueryPassword\f1
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
.RS
|
|
||||||
.PP
|
.PP
|
||||||
The password used to bind to an LDAP server when using
|
The password used to bind to an LDAP server when using
|
||||||
\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with
|
\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with
|
||||||
\fB\-\-ldapQueryUser\f1\f1\&.
|
\fB\-\-ldapQueryUser\f1\f1\&.
|
||||||
.PP
|
.PP
|
||||||
If unset, \fBmongoldap\f1\f1 will not attempt to bind to the LDAP server.
|
If not set, \fBmongoldap\f1\f1 does not attempt to bind to the LDAP server.
|
||||||
.PP
|
.PP
|
||||||
This setting can be configured on a running \fBmongoldap\f1\f1 using
|
You can configure this setting on a running \fBmongoldap\f1\f1 using
|
||||||
\fBsetParameter\f1\f1\&.
|
\fBsetParameter\f1\f1\&.
|
||||||
.PP
|
.PP
|
||||||
|
Starting in MongoDB 4.4, the \fBldapQueryPassword\f1
|
||||||
|
\fBsetParameter\f1\f1 command accepts either a string or
|
||||||
|
an array of strings. If \fBldapQueryPassword\f1 is set to an array, MongoDB tries
|
||||||
|
each password in order until one succeeds. Use a password array to roll over the
|
||||||
|
LDAP account password without downtime.
|
||||||
|
.PP
|
||||||
Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1
|
Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1
|
||||||
instead of \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify
|
instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&.
|
||||||
both \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
You cannot specify both \fB\-\-ldapQueryPassword\f1\f1 and
|
||||||
.RE
|
\fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time.
|
||||||
.PP
|
.PP
|
||||||
\fBmongoldap \-\-ldapBindWithOSDefaults\f1
|
\fBmongoldap \-\-ldapBindWithOSDefaults\f1
|
||||||
.RS
|
.RS
|
||||||
|
|
@ -306,6 +327,8 @@ Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 an
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: simple
|
\fIDefault\f1: simple
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The method \fBmongoldap\f1\f1 uses to authenticate to an LDAP
|
The method \fBmongoldap\f1\f1 uses to authenticate to an LDAP
|
||||||
server. Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to connect to the LDAP server.
|
server. Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to connect to the LDAP server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -345,6 +368,8 @@ using \fBDIGEST\-MD5\f1 mechanism.
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: DIGEST\-MD5
|
\fIDefault\f1: DIGEST\-MD5
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A comma\-separated list of SASL mechanisms \fBmongoldap\f1\f1 can
|
A comma\-separated list of SASL mechanisms \fBmongoldap\f1\f1 can
|
||||||
use when authenticating to the LDAP server. The \fBmongoldap\f1\f1 and the
|
use when authenticating to the LDAP server. The \fBmongoldap\f1\f1 and the
|
||||||
LDAP server must agree on at least one mechanism. The \fBmongoldap\f1\f1
|
LDAP server must agree on at least one mechanism. The \fBmongoldap\f1\f1
|
||||||
|
|
@ -416,6 +441,8 @@ For Windows, please see the Windows SASL documentation (https://msdn.microsoft.c
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: tls
|
\fIDefault\f1: tls
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
By default, \fBmongoldap\f1\f1 creates a TLS/SSL secured connection to the LDAP
|
By default, \fBmongoldap\f1\f1 creates a TLS/SSL secured connection to the LDAP
|
||||||
server.
|
server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -444,6 +471,8 @@ credentials between \fBmongoldap\f1\f1 and the LDAP server.
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: 10000
|
\fIDefault\f1: 10000
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The amount of time in milliseconds \fBmongoldap\f1\f1 should wait for an LDAP server
|
The amount of time in milliseconds \fBmongoldap\f1\f1 should wait for an LDAP server
|
||||||
to respond to a request.
|
to respond to a request.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -459,6 +488,8 @@ This setting can be configured on a running \fBmongoldap\f1\f1 using
|
||||||
\fBmongoldap \-\-ldapUserToDNMapping\f1
|
\fBmongoldap \-\-ldapUserToDNMapping\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
Maps the username provided to \fBmongoldap\f1\f1 for authentication to a LDAP
|
Maps the username provided to \fBmongoldap\f1\f1 for authentication to a LDAP
|
||||||
Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a
|
Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a
|
||||||
username into an LDAP DN in the following scenarios:
|
username into an LDAP DN in the following scenarios:
|
||||||
|
|
@ -623,6 +654,8 @@ This setting can be configured on a running \fBmongoldap\f1\f1 using the
|
||||||
\fBmongoldap \-\-ldapAuthzQueryTemplate\f1
|
\fBmongoldap \-\-ldapAuthzQueryTemplate\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongoldap\f1\f1 executes to obtain
|
A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongoldap\f1\f1 executes to obtain
|
||||||
the LDAP groups to which the authenticated user belongs to. The query is
|
the LDAP groups to which the authenticated user belongs to. The query is
|
||||||
relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&.
|
relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&.
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,8 @@ Starting in version 4.0, MongoDB disables support for TLS 1.0
|
||||||
encryption on systems where TLS 1.1+ is available. For
|
encryption on systems where TLS 1.1+ is available. For
|
||||||
more details, see \fBDisable TLS 1.0\f1\&.
|
more details, see \fBDisable TLS 1.0\f1\&.
|
||||||
.IP \(bu 2
|
.IP \(bu 2
|
||||||
Starting in MongoDB 4.0, the \fBmongos\f1\f1 binary will crash when
|
The \fBmongos\f1\f1 binary will crash when attempting to connect
|
||||||
attempting to connect to \fBmongod\f1\f1 instances whose
|
to \fBmongod\f1\f1 instances whose
|
||||||
\fBfeature compatibility version (fCV)\f1 is greater than
|
\fBfeature compatibility version (fCV)\f1 is greater than
|
||||||
that of the \fBmongos\f1\f1\&. For example, you cannot connect
|
that of the \fBmongos\f1\f1\&. For example, you cannot connect
|
||||||
a MongoDB 4.0 version \fBmongos\f1\f1 to a 4.2
|
a MongoDB 4.0 version \fBmongos\f1\f1 to a 4.2
|
||||||
|
|
@ -191,10 +191,15 @@ link\-local IPv6 address (https://en.wikipedia.org/wiki/Link\-local_address#IPv6
|
||||||
zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index))
|
zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index))
|
||||||
to that address (i.e. \fBfe80::<address>%<adapter\-name>\f1).
|
to that address (i.e. \fBfe80::<address>%<adapter\-name>\f1).
|
||||||
.PP
|
.PP
|
||||||
When possible, use a logical DNS hostname instead of an ip address,
|
To avoid configuration updates due to IP address changes, use DNS
|
||||||
particularly when configuring replica set members or sharded cluster
|
hostnames instead of IP addresses. It is particularly important to
|
||||||
members. The use of logical DNS hostnames avoids configuration
|
use a DNS hostname instead of an IP address when configuring replica
|
||||||
changes due to ip address changes.
|
set members or sharded cluster members.
|
||||||
|
.PP
|
||||||
|
Use hostnames instead of IP addresses to configure clusters across a
|
||||||
|
split network horizon. Starting in MongoDB 5.0, nodes that are only
|
||||||
|
configured with an IP address will fail startup validation and will
|
||||||
|
not start.
|
||||||
.PP
|
.PP
|
||||||
Before binding to a non\-localhost (e.g. publicly accessible)
|
Before binding to a non\-localhost (e.g. publicly accessible)
|
||||||
IP address, ensure you have secured your cluster from unauthorized
|
IP address, ensure you have secured your cluster from unauthorized
|
||||||
|
|
@ -349,6 +354,8 @@ If you specify \fBreopen\f1, you must also use \fB\-\-logappend\f1\f1\&.
|
||||||
\fBmongos \-\-redactClientLogData\f1
|
\fBmongos \-\-redactClientLogData\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A \fBmongos\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given
|
A \fBmongos\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given
|
||||||
log event before logging. This prevents the \fBmongos\f1\f1 from writing
|
log event before logging. This prevents the \fBmongos\f1\f1 from writing
|
||||||
potentially sensitive data stored on the database to the diagnostic log.
|
potentially sensitive data stored on the database to the diagnostic log.
|
||||||
|
|
@ -726,7 +733,7 @@ port of different members of the replica set.
|
||||||
Specifies the ping time, in milliseconds, that \fBmongos\f1\f1 uses
|
Specifies the ping time, in milliseconds, that \fBmongos\f1\f1 uses
|
||||||
to determine which secondary replica set members to pass read
|
to determine which secondary replica set members to pass read
|
||||||
operations from clients. The default value of \fB15\f1 corresponds to
|
operations from clients. The default value of \fB15\f1 corresponds to
|
||||||
the default value in all of the client drivers (https://docs.mongodb.com/drivers/)\&.
|
the default value in all of the client drivers (https://www.mongodb.com/docs/drivers/)\&.
|
||||||
.PP
|
.PP
|
||||||
When \fBmongos\f1\f1 receives a request that permits reads to
|
When \fBmongos\f1\f1 receives a request that permits reads to
|
||||||
\fBsecondary\f1 members, the \fBmongos\f1\f1 will:
|
\fBsecondary\f1 members, the \fBmongos\f1\f1 will:
|
||||||
|
|
@ -1773,6 +1780,43 @@ available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-e
|
||||||
.RE
|
.RE
|
||||||
.SS AUDIT OPTIONS
|
.SS AUDIT OPTIONS
|
||||||
.PP
|
.PP
|
||||||
|
\fBmongos \-\-auditCompressionMode\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Specifies the compression mode for \fBaudit log encryption\f1\&. You must also enable audit log
|
||||||
|
encryption using either \fB\-\-auditEncryptionKeyUID\f1\f1 or
|
||||||
|
\fB\-\-auditLocalKeyFile\f1\f1\&.
|
||||||
|
.PP
|
||||||
|
\fB\-\-auditCompressionMode\f1\f1 can be set to one of these values:
|
||||||
|
.RS
|
||||||
|
.IP \(bu 2
|
||||||
|
.RS
|
||||||
|
.IP \(bu 4
|
||||||
|
Value
|
||||||
|
.IP \(bu 4
|
||||||
|
Description
|
||||||
|
.RE
|
||||||
|
.IP \(bu 2
|
||||||
|
.RS
|
||||||
|
.IP \(bu 4
|
||||||
|
\fBzstd\f1
|
||||||
|
.IP \(bu 4
|
||||||
|
Use the \fBzstd\f1 algorithm to compress the audit log.
|
||||||
|
.RE
|
||||||
|
.IP \(bu 2
|
||||||
|
.RS
|
||||||
|
.IP \(bu 4
|
||||||
|
\fBnone\f1 \fI(default)\f1
|
||||||
|
.IP \(bu 4
|
||||||
|
Do not compress the audit log.
|
||||||
|
.RE
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&.
|
||||||
|
MongoDB Enterprise and Atlas have different configuration
|
||||||
|
requirements.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fBmongos \-\-auditDestination\f1
|
\fBmongos \-\-auditDestination\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -1823,6 +1867,20 @@ Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-e
|
||||||
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
|
\fBmongos \-\-auditEncryptionKeyUID\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Specifies the unique identifier of the Key Management
|
||||||
|
Interoperability Protocol (KMIP) key for \fBaudit log encryption\f1\&.
|
||||||
|
.PP
|
||||||
|
You cannot use \fB\-\-auditEncryptionKeyUID\f1\f1 and
|
||||||
|
\fB\-\-auditLocalKeyFile\f1\f1 together.
|
||||||
|
.PP
|
||||||
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&.
|
||||||
|
MongoDB Enterprise and Atlas have different configuration
|
||||||
|
requirements.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fBmongos \-\-auditFormat\f1
|
\fBmongos \-\-auditFormat\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -1861,6 +1919,25 @@ Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-e
|
||||||
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
|
\fBmongos \-\-auditLocalKeyFile\f1
|
||||||
|
.RS
|
||||||
|
.PP
|
||||||
|
Specifies the path and file name for a local audit key file for
|
||||||
|
\fBaudit log encryption\f1\&.
|
||||||
|
.PP
|
||||||
|
Only use \fB\-\-auditLocalKeyFile\f1\f1 for testing because the key is
|
||||||
|
not secured. To secure the key, use
|
||||||
|
\fB\-\-auditEncryptionKeyUID\f1\f1 and an external Key
|
||||||
|
Management Interoperability Protocol (KMIP) server.
|
||||||
|
.PP
|
||||||
|
You cannot use \fB\-\-auditLocalKeyFile\f1\f1 and
|
||||||
|
\fB\-\-auditEncryptionKeyUID\f1\f1 together.
|
||||||
|
.PP
|
||||||
|
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&.
|
||||||
|
MongoDB Enterprise and Atlas have different configuration
|
||||||
|
requirements.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
\fBmongos \-\-auditPath\f1
|
\fBmongos \-\-auditPath\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -1934,6 +2011,8 @@ only and not the profiler since profiling is not available on
|
||||||
\fBmongos \-\-ldapServers\f1
|
\fBmongos \-\-ldapServers\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The LDAP server against which the \fBmongos\f1\f1 authenticates users or
|
The LDAP server against which the \fBmongos\f1\f1 authenticates users or
|
||||||
determines what actions a user is authorized to perform on a given
|
determines what actions a user is authorized to perform on a given
|
||||||
database. If the LDAP server specified has any replicated instances,
|
database. If the LDAP server specified has any replicated instances,
|
||||||
|
|
@ -1974,6 +2053,8 @@ server is unavailable.
|
||||||
\fBmongos \-\-ldapQueryUser\f1
|
\fBmongos \-\-ldapQueryUser\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The identity with which \fBmongos\f1\f1 binds as, when connecting to or
|
The identity with which \fBmongos\f1\f1 binds as, when connecting to or
|
||||||
performing queries on an LDAP server.
|
performing queries on an LDAP server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -2002,6 +2083,8 @@ both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the s
|
||||||
\fBmongos \-\-ldapQueryPassword\f1
|
\fBmongos \-\-ldapQueryPassword\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The password used to bind to an LDAP server when using
|
The password used to bind to an LDAP server when using
|
||||||
\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with
|
\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with
|
||||||
\fB\-\-ldapQueryUser\f1\f1\&.
|
\fB\-\-ldapQueryUser\f1\f1\&.
|
||||||
|
|
@ -2045,6 +2128,8 @@ Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 an
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: simple
|
\fIDefault\f1: simple
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The method \fBmongos\f1\f1 uses to authenticate to an LDAP server.
|
The method \fBmongos\f1\f1 uses to authenticate to an LDAP server.
|
||||||
Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to
|
Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to
|
||||||
connect to the LDAP server.
|
connect to the LDAP server.
|
||||||
|
|
@ -2067,6 +2152,8 @@ using \fBDIGEST\-MD5\f1 mechanism.
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: DIGEST\-MD5
|
\fIDefault\f1: DIGEST\-MD5
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
A comma\-separated list of SASL mechanisms \fBmongos\f1\f1 can
|
A comma\-separated list of SASL mechanisms \fBmongos\f1\f1 can
|
||||||
use when authenticating to the LDAP server. The \fBmongos\f1\f1 and the
|
use when authenticating to the LDAP server. The \fBmongos\f1\f1 and the
|
||||||
LDAP server must agree on at least one mechanism. The \fBmongos\f1\f1
|
LDAP server must agree on at least one mechanism. The \fBmongos\f1\f1
|
||||||
|
|
@ -2138,6 +2225,8 @@ For Windows, please see the Windows SASL documentation (https://msdn.microsoft.c
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: tls
|
\fIDefault\f1: tls
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
By default, \fBmongos\f1\f1 creates a TLS/SSL secured connection to the LDAP
|
By default, \fBmongos\f1\f1 creates a TLS/SSL secured connection to the LDAP
|
||||||
server.
|
server.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -2166,6 +2255,8 @@ credentials between \fBmongos\f1\f1 and the LDAP server.
|
||||||
.PP
|
.PP
|
||||||
\fIDefault\f1: 10000
|
\fIDefault\f1: 10000
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
The amount of time in milliseconds \fBmongos\f1\f1 should wait for an LDAP server
|
The amount of time in milliseconds \fBmongos\f1\f1 should wait for an LDAP server
|
||||||
to respond to a request.
|
to respond to a request.
|
||||||
.PP
|
.PP
|
||||||
|
|
@ -2181,6 +2272,8 @@ This setting can be configured on a running \fBmongos\f1\f1 using
|
||||||
\fBmongos \-\-ldapUserToDNMapping\f1
|
\fBmongos \-\-ldapUserToDNMapping\f1
|
||||||
.RS
|
.RS
|
||||||
.PP
|
.PP
|
||||||
|
\fIAvailable in MongoDB Enterprise only.\f1
|
||||||
|
.PP
|
||||||
Maps the username provided to \fBmongos\f1\f1 for authentication to a LDAP
|
Maps the username provided to \fBmongos\f1\f1 for authentication to a LDAP
|
||||||
Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a
|
Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a
|
||||||
username into an LDAP DN in the following scenarios:
|
username into an LDAP DN in the following scenarios:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue