forked from mongodb/mongo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mongodb-parameters.5
3555 lines (3485 loc) · 82.8 KB
/
mongodb-parameters.5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
.\" Man page generated from reStructuredText.
.
.TH "MONGODB-PARAMETERS" "5" "Aug 16, 2019" "4.2" "mongodb-manual"
.SH NAME
mongodb-parameters \- MongoDB setParameter Options
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SS On this page
.INDENT 0.0
.IP \(bu 2
\fI\%Synopsis\fP
.IP \(bu 2
\fI\%Parameters\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Authentication Parameters\fP
.IP \(bu 2
\fI\%General Parameters\fP
.IP \(bu 2
\fI\%Logging Parameters\fP
.IP \(bu 2
\fI\%Diagnostic Parameters\fP
.IP \(bu 2
\fI\%Logical Session Parameters\fP
.IP \(bu 2
\fI\%Replication Parameters\fP
.IP \(bu 2
\fI\%Sharding Parameters\fP
.IP \(bu 2
\fI\%Storage Parameters\fP
.IP \(bu 2
\fI\%WiredTiger Parameters\fP
.IP \(bu 2
\fI\%Auditing Parameters\fP
.IP \(bu 2
\fI\%Transaction Parameters\fP
.UNINDENT
.UNINDENT
.SH SYNOPSIS
.sp
MongoDB provides a number of configuration options that you can set
using:
.INDENT 0.0
.IP \(bu 2
the \fBsetParameter\fP command:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, <parameter>: <value> } )
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
the \fBsetParameter\fP configuration setting:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
setParameter:
<parameter1>: <value1>
...
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
the \fB\-\-setParameter\fP command\-line option for \fBmongod\fP
and \fBmongos\fP:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter <parameter>=<value>
mongos \-\-setParameter <parameter>=<value>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For additional configuration options, see
/reference/configuration\-options, \fBmongod\fP and
\fBmongos\fP\&.
.SH PARAMETERS
.SS Authentication Parameters
.INDENT 0.0
.TP
.B authenticationMechanisms
Changed in version 4.0: Remove support for the deprecated \fBMONGODB\-CR\fP authentication mechanism.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Specifies the list of authentication mechanisms the server accepts. Set
this to one or more of the following values. If you specify multiple
values, use a comma\-separated list and no spaces. For descriptions
of the authentication mechanisms, see /core/authentication\&.
.TS
center;
|l|l|.
_
T{
Value
T} T{
Description
T}
_
T{
SCRAM\-SHA\-1
T} T{
\fI\%RFC 5802\fP standard
Salted Challenge Response Authentication Mechanism using the SHA\-1
hash function.
T}
_
T{
SCRAM\-SHA\-256
T} T{
\fI\%RFC 7677\fP standard
Salted Challenge Response Authentication Mechanism using the SHA\-256
hash function.
.sp
Requires featureCompatibilityVersion set to \fB4.0\fP\&.
.sp
New in version 4.0.
T}
_
T{
MONGODB\-X509
T} T{
MongoDB TLS/SSL certificate authentication.
T}
_
T{
GSSAPI (Kerberos)
T} T{
External authentication using Kerberos. This mechanism is
available only in \fI\%MongoDB Enterprise\fP\&.
T}
_
T{
PLAIN (LDAP SASL)
T} T{
External authentication using LDAP. You can also use \fBPLAIN\fP
for authenticating in\-database users. \fBPLAIN\fP transmits
passwords in plain text. This mechanism is available only in
\fI\%MongoDB Enterprise\fP\&.
T}
_
.TE
.sp
You can only set \fI\%authenticationMechanisms\fP during
start\-up.
.sp
For example, to specify both \fBPLAIN\fP and \fBSCRAM\-SHA\-256\fP as the
authentication mechanisms, use the following command:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter authenticationMechanisms=PLAIN,SCRAM\-SHA\-256 \-\-auth
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B clusterAuthMode
New in version 2.6.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Set the \fBclusterAuthMode\fP to either \fBsendX509\fP or
\fBx509\fP\&. Useful during rolling upgrade to use x509 for
membership authentication
to minimize downtime.
.sp
For more information about TLS/SSL and MongoDB, see
/tutorial/configure\-ssl and
/tutorial/configure\-ssl\-clients .
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, clusterAuthMode: "sendX509" } )
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B enableLocalhostAuthBypass
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Specify \fB0\fP or \fBfalse\fP to disable localhost authentication
bypass. Enabled by default.
.sp
\fI\%enableLocalhostAuthBypass\fP is not available using
\fBsetParameter\fP database command. Use the
\fBsetParameter\fP option in the configuration file or the
\fB\-\-setParameter\fP option on the
command line.
.sp
See localhost\-exception for more information.
.UNINDENT
.INDENT 0.0
.TP
.B KeysRotationIntervalSec
New in version 3.6.
.sp
\fIDefault\fP: 7776000 seconds (90 days)
.sp
Specifies the number of seconds for which an \fI\%HMAC signing key\fP
is valid before rotating to the next one. This parameter is intended
primarily to facilitate authentication testing.
.sp
You can only set \fI\%KeysRotationIntervalSec\fP during
start\-up, and cannot change this setting with the
\fBsetParameter\fP database command.
.UNINDENT
.INDENT 0.0
.TP
.B ldapUserCacheInvalidationInterval
For use with MongoDB servers using security\-ldap\-external\&.
.sp
The interval (in seconds) MongoDB waits
between external user cache flushes. After MongoDB flushes the external
user cache, the next operation an LDAP\-authorized user, MongoDB
reacquires authorization data from the LDAP server.
.sp
Increasing the value specified increases the amount of time
MongoDB and the LDAP server can be out of sync, but reduces the load on
the LDAP server. Conversely, decreasing the value specified
decreases the time MongoDB and the LDAP server can be out of sync while
increasing the load on the LDAP server.
.sp
Defaults to 30 seconds.
.UNINDENT
.INDENT 0.0
.TP
.B opensslCipherConfig
New in version 3.6.
.sp
Changed in version 4.0: With the use of native TLS/SSL libraries, the parameter
\fI\%opensslCipherConfig\fP is supported for Linux/BSD and
no longer supported in Windows and macOS. See MongoDB 4.0
TLS/SSL\&.
.sp
Specify the cipher string for OpenSSL when using TLS/SSL encryption.
For a list of cipher strings, see
\fI\%https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER\-STRINGS\fP
.sp
You can only set \fI\%opensslCipherConfig\fP during start\-up, and
cannot change this setting using the \fBsetParameter\fP
database command.
.sp
For version 4.2 and greater, the use of \fBTLS\fP options is preferred
over \fBSSL\fP options. The TLS options have the same functionality as
the \fBSSL\fP options.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter opensslCipherConfig=HIGH:!EXPORT:!aNULL@STRENGTH \-\-tlsMode requireTLS \-\-tlsCertificateKeyFile Certs/server.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For versions 4.0 and earlier:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter opensslCipherConfig=HIGH:!EXPORT:!aNULL@STRENGTH \-\-sslMode requireSSL \-\-sslPEMKeyFile Certs/server.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B saslauthdPath
.
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Available only in MongoDB Enterprise (except MongoDB Enterprise for Windows).
.UNINDENT
.UNINDENT
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Specify the path to the Unix Domain Socket of the \fBsaslauthd\fP
instance to use for proxy authentication.
.UNINDENT
.INDENT 0.0
.TP
.B saslHostName
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
\fI\%saslHostName\fP overrides MongoDB\(aqs default hostname
detection for the purpose of configuring SASL and Kerberos
authentication.
.sp
\fI\%saslHostName\fP does not affect the hostname of the
\fBmongod\fP or \fBmongos\fP instance for any purpose
beyond the configuration of SASL and Kerberos.
.sp
You can only set \fI\%saslHostName\fP during start\-up, and
cannot change this setting using the \fBsetParameter\fP
database command.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%saslHostName\fP supports Kerberos authentication and is
only included in MongoDB Enterprise. For Linux systems, see
/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication
for more information.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B saslServiceName
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Allows users to override the default Kerberos
service name component of the Kerberos
principal name, on a per\-instance basis. If unspecified, the
default value is \fBmongodb\fP\&.
.sp
MongoDB only permits setting \fI\%saslServiceName\fP at
startup. The \fBsetParameter\fP command can not change
this setting.
.sp
\fI\%saslServiceName\fP is only available in MongoDB
Enterprise.
.sp
\fBIMPORTANT:\fP
.INDENT 7.0
.INDENT 3.5
Ensure that your driver supports alternate service names.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B scramIterationCount
New in version 3.0.0.
.sp
\fIDefault\fP: \fB10000\fP
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Changes the number of hashing iterations used for all new
\fBSCRAM\-SHA\-1\fP passwords. More iterations increase the amount of
time required for clients to authenticate to MongoDB, but makes
passwords less susceptible to brute\-force attempts. The default
value is ideal for most common use cases and requirements.
.sp
If you modify this value, it does not change the iteration count for
existing passwords. The \fI\%scramIterationCount\fP value must
be \fB5000\fP or greater.
.sp
For example, the following sets the \fI\%scramIterationCount\fP
to \fB12000\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter scramIterationCount=12000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, if using the \fBsetParameter\fP command within the
\fBmongo\fP shell:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, scramIterationCount: 12000 } )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBdb.changeUserPassword()\fP
.IP \(bu 2
\fBdb.createUser()\fP
.IP \(bu 2
\fBdb.updateUser()\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B scramSHA256IterationCount
New in version 4.0.
.sp
\fIDefault\fP: \fB15000\fP
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Changes the number of hashing iterations used for all new
\fBSCRAM\-SHA\-256\fP passwords. More iterations increase the amount of
time required for clients to authenticate to MongoDB, but makes
passwords less susceptible to brute\-force attempts. The default
value is ideal for most common use cases and requirements.
.sp
If you modify this value, it does not change iteration count for
existing passwords. The \fI\%scramSHA256IterationCount\fP value
must be \fB5000\fP or greater.
.sp
For example, the following sets the \fI\%scramSHA256IterationCount\fP
to \fB20000\fP\&.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter scramSHA256IterationCount=20000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, if using the \fBsetParameter\fP command within the
\fBmongo\fP shell:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, scramSHA256IterationCount: 20000 } )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBdb.changeUserPassword()\fP
.IP \(bu 2
\fBdb.createUser()\fP
.IP \(bu 2
\fBdb.updateUser()\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sslMode
New in version 2.6.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Set the \fBnet.ssl.mode\fP to either \fBpreferSSL\fP or
\fBrequireSSL\fP\&. Useful during rolling upgrade to TLS/SSL to minimize downtime.
.sp
For more information about TLS/SSL and MongoDB, see
/tutorial/configure\-ssl and
/tutorial/configure\-ssl\-clients .
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, sslMode: "preferSSL" } )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%tlsMode\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tlsMode
New in version 4.2.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Set to either:
.INDENT 7.0
.IP \(bu 2
\fBpreferTLS\fP
.IP \(bu 2
\fBrequireTLS\fP
.UNINDENT
.sp
The \fI\%tlsMode\fP parameter is useful during rolling
upgrade to TLS/SSL to minimize
downtime.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, tlsMode: "preferTLS" } )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
For more information about TLS/SSL and MongoDB, see
/tutorial/configure\-ssl and
/tutorial/configure\-ssl\-clients .
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%sslMode\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tlsWithholdClientCertificate
\fIDefault\fP: false
.sp
New in version 4.2.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
A TLS certificate is set for a \fBmongod\fP or
\fBmongos\fP either by the
\fB\-\-tlsClusterFile\fP option or by the
\fB\-\-tlsCertificateKeyFile\fP option when
\fB\-\-tlsClusterFile\fP is not set. If the TLS
certificate is set, by default, the instance sends the certificate when
initiating intra\-cluster communications with other
\fBmongod\fP or \fBmongos\fP instances in
the deployment. Set \fBtlsWithholdClientCertificate\fP to \fB1\fP or \fBtrue\fP to
direct the instance to withhold sending its TLS certificate during these
communications. Use this option with
\fB\-\-tlsAllowConnectionsWithoutCertificates\fP
(to allow inbound connections without certificates) on all members of the
deployment. \fBtlsWithholdClientCertificate\fP is mutually exclusive with
\fB\-\-clusterAuthMode x509\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B tlsX509ClusterAuthDNOverride
New in version 4.2.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
An alternative Distinguished Name (DN) that the instance can also
use to identify members of the deployment.
.sp
For a MongoDB deployment that uses x.509 certificates for
\fBclusterAuthMode\fP, deployment members identify
each other using x.509 certificates (
\fBnet.tls.clusterFile\fP, if specified, and
\fBnet.tls.certificateKeyFile\fP) during intra\-cluster
communications. For members of the same deployment, the \fBDN\fP from
their certificates must have the same Organization attributes
(\fBO\fP\(aqs), the Organizational Unit attributes (\fBOU\fP\(aqs), and the
Domain Components (\fBDC\fP\(aqs).
.sp
If \fI\%tlsX509ClusterAuthDNOverride\fP is set for a member,
the member can also use the override value when comparing the \fBDN\fP
components (\fBO\fP\(aqs, \fBOU\fP\(aqs, and \fBDC\fP\(aqs) of the presented
certificates. That is the member checks the presented certificates
against its
\fBnet.tls.clusterFile\fP/\fBnet.tls.certificateKeyFile\fP\&.
If the DN does not match, the member checks the presented
certifcate against the \fI\%tlsX509ClusterAuthDNOverride\fP
value.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If set, you must set this parameter on all members of the
deployment.
.UNINDENT
.UNINDENT
.sp
You can use this parameter for a rolling update of certificates to
new certificates that contain a new \fBDN\fP value. See
/tutorial/rotate\-x509\-membership\-certificates\&.
.sp
For more information about membership certificate requirements, see
x509\-member\-certificate\-requirements for details.
.UNINDENT
.INDENT 0.0
.TP
.B sslWithholdClientCertificate
\fIDefault\fP: false
.sp
Deprecated since version 4.2: Use \fI\%tlsWithholdClientCertificate\fP instead.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
A TLS certificate is set for a \fBmongod\fP or
\fBmongos\fP either by the
\fB\-\-tlsClusterFile\fP option or by the
\fB\-\-tlsCertificateKeyFile\fP option when
\fB\-\-tlsClusterFile\fP is not set. If the TLS
certificate is set, by default, the instance sends the certificate when
initiating intra\-cluster communications with other
\fBmongod\fP or \fBmongos\fP instances in
the deployment. Set \fBsslWithholdClientCertificate\fP to \fB1\fP or \fBtrue\fP to
direct the instance to withhold sending its TLS certificate during these
communications. Use this option with
\fB\-\-tlsAllowConnectionsWithoutCertificates\fP
(to allow inbound connections without certificates) on all members of the
deployment. \fBsslWithholdClientCertificate\fP is mutually exclusive with
\fB\-\-clusterAuthMode x509\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B userCacheInvalidationIntervalSecs
\fIDefault\fP: 30
.sp
Available for \fBmongos\fP only.
.sp
On a \fBmongos\fP instance, specifies the interval (in seconds)
at which the \fBmongos\fP instance checks to determine whether
the in\-memory cache of user objects has stale data, and if so,
clears the cache. If there are no changes to user objects,
\fBmongos\fP will not clear the cache.
.sp
This parameter has a minimum value of \fB1\fP second and a maximum
value of \fB86400\fP seconds (24 hours).
.sp
Changed in version 3.0: Default value has changed to \fB30\fP seconds, and the minimum
value allowed has changed to \fB1\fP second. \fBmongos\fP
only clears the user cache if there are changes.
.UNINDENT
.INDENT 0.0
.TP
.B authFailedDelayMs
\fIDefault\fP: 0
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
New in version 3.4.
.INDENT 7.0
.INDENT 3.5
.IP "Enterprise Feature"
.sp
Available in MongoDB Enterprise only.
.UNINDENT
.UNINDENT
.sp
The number of milliseconds to wait before informing clients that their
authentication attempt has failed. This parameter may be in the range
\fB0\fP to \fB5000\fP, inclusive.
.sp
Setting this parameter makes brute\-force login attacks on a database
more time\-consuming. However, clients waiting for a response from the
MongoDB server still consume server resources, and this may adversely
impact benign login attempts if the server is denying access to many
other clients simultaneously.
.UNINDENT
.INDENT 0.0
.TP
.B allowRolesFromX509Certificates
\fIDefault\fP: true
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
\fIAvailable starting in MongoDB 4.0.11 (and 3.6.14 and 3.4.22)\fP
.sp
A boolean flag that allows or disallows the retrieval of
authorization roles from client x.509 certificates.
.sp
You can only set \fI\%allowRolesFromX509Certificates\fP during
startup in the config file or on the command line.
.UNINDENT
.SS General Parameters
.INDENT 0.0
.TP
.B connPoolMaxShardedConnsPerHost
New in version 2.6.
.sp
\fIDefault\fP: 200
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the maximum size of the legacy connection pools for communication to the
shards. The size of a pool does not prevent the creation of
additional connections, but \fIdoes\fP prevent the connection pools from
retaining connections above this limit.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The parameter is separate from the connections in TaskExecutor
pools. See \fI\%ShardingTaskExecutorPoolMaxSize\fP\&.
.UNINDENT
.UNINDENT
.sp
Increase the \fI\%connPoolMaxShardedConnsPerHost\fP value
\fBonly\fP if the number of connections in a connection pool has a
high level of churn or if the total number of created connections
increase.
.sp
You can only set \fI\%connPoolMaxShardedConnsPerHost\fP during
startup in the config file or on the command line. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongos \-\-setParameter connPoolMaxShardedConnsPerHost=250
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B connPoolMaxShardedInUseConnsPerHost
New in version 3.6.3.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the maximum number of in\-use connections at any given time for
the legacy sharded cluster connection pools.
.sp
By default, the parameter is unset.
.sp
You can only set \fI\%connPoolMaxShardedConnsPerHost\fP during
startup in the config file or on the command line. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongos \-\-setParameter connPoolMaxShardedInUseConnsPerHost=100
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%connPoolMaxShardedConnsPerHost\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B shardedConnPoolIdleTimeoutMinutes
New in version 3.6.3.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the time limit that a connection in the legacy sharded cluster
connection pool can remain idle before being closed.
.sp
By default, the parameter is unset.
.sp
You can only set \fI\%shardedConnPoolIdleTimeoutMinutes\fP during
startup in the config file or on the command line. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongos \-\-setParameter shardedConnPoolIdleTimeoutMinutes=10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%connPoolMaxShardedConnsPerHost\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B connPoolMaxConnsPerHost
New in version 2.6.
.sp
\fIDefault\fP: 200
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the maximum size of the legacy connection pools for outgoing connections
to other \fBmongod\fP instances in the global connection pool. The size
of a pool does not prevent the creation of additional connections,
but \fIdoes\fP prevent a connection pool from retaining connections in
excess of the value of \fI\%connPoolMaxConnsPerHost\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The parameter is separate from the connections in TaskExecutor
pools. See \fI\%ShardingTaskExecutorPoolMaxSize\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBOnly\fP adjust this setting if your driver does \fInot\fP pool
connections and you\(aqre using authentication in the
context of a sharded cluster.
.sp
You can only set \fI\%connPoolMaxConnsPerHost\fP during startup
in the config file or on the command line. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter connPoolMaxConnsPerHost=250
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B connPoolMaxInUseConnsPerHost
New in version 3.6.3.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the maximum number of in\-use connections at any given time for
for outgoing connections to other \fBmongod\fP instances in
the legacy global connection pool.
.sp
By default, the parameter is unset.
.sp
You can only set \fI\%connPoolMaxInUseConnsPerHost\fP during
startup in the config file or on the command line. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter connPoolMaxInUseConnsPerHost=100
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%connPoolMaxConnsPerHost\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B globalConnPoolIdleTimeoutMinutes
New in version 3.6.3.
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the time limit that connection in the legacy global connection
pool can remain idle before being closed.
.sp
By default, the parameter is unset.
.sp
You can only set \fI\%globalConnPoolIdleTimeoutMinutes\fP
during startup in the config file or on the command line. For
example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongos \-\-setParameter globalConnPoolIdleTimeoutMinutes=10
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSEE ALSO:\fP
.INDENT 7.0
.INDENT 3.5
\fI\%connPoolMaxShardedConnsPerHost\fP
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cursorTimeoutMillis
New in version 3.0.2.
.sp
\fIDefault\fP: 600000 (i.e. 10 minutes)
.sp
Available for both \fBmongod\fP and \fBmongos\fP\&.
.sp
Sets the expiration threshold in milliseconds for idle cursors
before MongoDB removes them; i.e. MongoDB removes cursors that have
been idle for the specified \fI\%cursorTimeoutMillis\fP\&.
.sp
For example, the following sets the \fI\%cursorTimeoutMillis\fP
to \fB300000\fP milliseconds (i.e. 5 minutes).
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mongod \-\-setParameter cursorTimeoutMillis=300000
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, if using the \fBsetParameter\fP command within the
\fBmongo\fP shell:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
db.adminCommand( { setParameter: 1, cursorTimeoutMillis: 300000 } )
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Setting \fI\%cursorTimeoutMillis\fP to less than or equal
to \fB0\fP results in all cursors being immediately eligible for timeout.