@@ -73,8 +73,7 @@ Authentication Parameters
73
73
74
74
.. include:: /includes/list-table-auth-mechanisms.rst
75
75
76
- You can only set :parameter:`authenticationMechanisms` during
77
- start-up.
76
+ .. include:: /includes/fact-startup-parameter
78
77
79
78
For example, to specify both ``PLAIN`` and ``SCRAM-SHA-256`` as the
80
79
authentication mechanisms, use the following command:
@@ -130,6 +129,8 @@ Authentication Parameters
130
129
131
130
.. include:: /includes/extracts/ssl-facts-see-more.rst
132
131
132
+ .. include:: /includes/fact-runtime-parameter
133
+
133
134
.. code-block:: bash
134
135
135
136
db.adminCommand( { setParameter: 1, clusterAuthMode: "sendX509" } )
@@ -141,11 +142,7 @@ Authentication Parameters
141
142
Specify ``0`` or ``false`` to disable localhost authentication
142
143
bypass. Enabled by default.
143
144
144
- :parameter:`enableLocalhostAuthBypass` is not available using
145
- :dbcommand:`setParameter` database command. Use the
146
- :setting:`setParameter` option in the configuration file or the
147
- :option:`--setParameter <mongod --setParameter>` option on the
148
- command line.
145
+ .. include:: /includes/fact-startup-parameter
149
146
150
147
See :ref:`localhost-exception` for more information.
151
148
@@ -158,9 +155,7 @@ Authentication Parameters
158
155
is valid before rotating to the next one. This parameter is intended
159
156
primarily to facilitate authentication testing.
160
157
161
- You can only set :parameter:`KeysRotationIntervalSec` during
162
- start-up, and cannot change this setting with the
163
- :dbcommand:`setParameter` database command.
158
+ .. include:: /includes/fact-startup-parameter
164
159
165
160
.. parameter:: ldapForceMultiThreadMode
166
161
@@ -489,9 +484,7 @@ Authentication Parameters
489
484
:dbcommand:`validate` returns as many results as possible and warns
490
485
that not all corruption might be reported because of the limit.
491
486
492
- You can set :parameter:`maxValidateMemoryUsageMB` during startup, and
493
- can change this setting using the :dbcommand:`setParameter` database
494
- command.
487
+ .. include:: /includes/fact-runtime-startup-parameter
495
488
496
489
.. parameter:: oidcIdentityProviders
497
490
@@ -511,9 +504,7 @@ Authentication Parameters
511
504
512
505
.. include:: /includes/fact-oidc-providers.rst
513
506
514
- You can only set ``oidcIdentityProviders`` during startup in the
515
- :setting:`configuration file <setParameter>` or with the
516
- ``--setParameter`` option on the command line.
507
+ .. include:: /includes/fact-startup-parameter
517
508
518
509
.. parameter:: ocspEnabled
519
510
@@ -523,10 +514,9 @@ Authentication Parameters
523
514
524
515
The flag that enables or disables OCSP.
525
516
526
- You can only set :parameter:`ocspEnabled` during startup in the
527
- :setting:`configuration file <setParameter>` or with the
528
- ``--setParameter`` option on the command line. For example, the
529
- following disables OCSP:
517
+ .. include:: /includes/fact-startup-parameter
518
+
519
+ For example, the following disables OCSP:
530
520
531
521
.. code-block:: bash
532
522
@@ -585,9 +575,7 @@ Authentication Parameters
585
575
cipher suites for use with TLS 1.3, use the
586
576
:parameter:`opensslCipherSuiteConfig` parameter.
587
577
588
- You can only set :parameter:`opensslCipherConfig` during start-up,
589
- and cannot change this setting using the :dbcommand:`setParameter`
590
- database command.
578
+ .. include:: /includes/fact-startup-parameter
591
579
592
580
For version 4.2 and greater, the use of ``TLS`` options is preferred
593
581
over ``SSL`` options. The TLS options have the same functionality as
@@ -618,11 +606,10 @@ Authentication Parameters
618
606
strings for use with TLS 1.2 or earlier, use the
619
607
:parameter:`opensslCipherConfig` parameter.
620
608
621
- You can only set :parameter:`opensslCipherSuiteConfig` during
622
- start-up, and cannot change this setting using the
623
- :dbcommand:`setParameter` database command. For example, the
624
- following configures a :binary:`~bin.mongod` with a
625
- :parameter:`opensslCipherSuiteConfig` cipher suite of
609
+ .. include:: /includes/fact-startup-parameter
610
+
611
+ For example, the following configures a :binary:`~bin.mongod`
612
+ with a :parameter:`opensslCipherSuiteConfig` cipher suite of
626
613
``'TLS_AES_256_GCM_SHA384'`` for use with TLS 1.3:
627
614
628
615
.. code-block:: bash
@@ -659,9 +646,7 @@ Authentication Parameters
659
646
not supported with Java 6 and 7 unless extended support has been
660
647
purchased from Oracle.
661
648
662
- You can only set :parameter:`opensslDiffieHellmanParameters` during
663
- startup, and cannot change this setting using the
664
- :dbcommand:`setParameter` database command.
649
+ .. include:: /includes/fact-startup-parameter
665
650
666
651
If for performance reasons, you need to disable support for DHE
667
652
cipher suites, use the :parameter:`opensslCipherConfig` parameter:
@@ -679,6 +664,8 @@ Authentication Parameters
679
664
Specify the path to the Unix Domain Socket of the ``saslauthd``
680
665
instance to use for proxy authentication.
681
666
667
+ .. include:: /includes/fact-startup-parameter
668
+
682
669
.. parameter:: saslHostName
683
670
684
671
|both|
@@ -691,9 +678,7 @@ Authentication Parameters
691
678
:binary:`~bin.mongod` or :binary:`~bin.mongos` instance for any purpose
692
679
beyond the configuration of SASL and Kerberos.
693
680
694
- You can only set :parameter:`saslHostName` during start-up, and
695
- cannot change this setting using the :dbcommand:`setParameter`
696
- database command.
681
+ .. include:: /includes/fact-startup-parameter
697
682
698
683
.. note::
699
684
@@ -717,9 +702,7 @@ Authentication Parameters
717
702
principal name, on a per-instance basis. If unspecified, the
718
703
default value is ``mongodb``.
719
704
720
- MongoDB only permits setting :parameter:`saslServiceName` at
721
- startup. The :dbcommand:`setParameter` command can not change
722
- this setting.
705
+ .. include:: /includes/fact-startup-parameter
723
706
724
707
:parameter:`saslServiceName` is only available in MongoDB
725
708
Enterprise.
@@ -744,6 +727,8 @@ Authentication Parameters
744
727
existing passwords. The :parameter:`scramIterationCount` value must
745
728
be ``5000`` or greater.
746
729
730
+ .. include:: /includes/fact-runtime-startup-parameter
731
+
747
732
For example, the following sets the :parameter:`scramIterationCount`
748
733
to ``12000``.
749
734
@@ -780,6 +765,8 @@ Authentication Parameters
780
765
existing passwords. The :parameter:`scramSHA256IterationCount` value
781
766
must be ``5000`` or greater.
782
767
768
+ .. include:: /includes/fact-runtime-startup-parameter
769
+
783
770
For example, the following sets the :parameter:`scramSHA256IterationCount`
784
771
to ``20000``.
785
772
@@ -810,6 +797,8 @@ Authentication Parameters
810
797
811
798
.. include:: /includes/extracts/ssl-facts-see-more.rst
812
799
800
+ .. include:: /includes/fact-runtime-parameter
801
+
813
802
.. code-block:: bash
814
803
815
804
db.adminCommand( { setParameter: 1, sslMode: "preferSSL" } )
@@ -834,6 +823,8 @@ Authentication Parameters
834
823
upgrade to TLS/SSL </tutorial/upgrade-cluster-to-ssl>` to minimize
835
824
downtime.
836
825
826
+ .. include:: /includes/fact-runtime-parameter
827
+
837
828
.. code-block:: bash
838
829
839
830
db.adminCommand( { setParameter: 1, tlsMode: "preferTLS" } )
@@ -862,6 +853,8 @@ Authentication Parameters
862
853
Use this parameter to rotate certificates when the new certificates have
863
854
different attributes or extension values.
864
855
856
+ .. include:: /includes/fact-startup-parameter
857
+
865
858
.. parameter:: tlsOCSPStaplingTimeoutSecs
866
859
867
860
Available for Linux.
@@ -874,11 +867,10 @@ Authentication Parameters
874
867
:parameter:`tlsOCSPStaplingTimeoutSecs` uses the
875
868
:parameter:`tlsOCSPVerifyTimeoutSecs` value.
876
869
877
- You can only set :parameter:`tlsOCSPStaplingTimeoutSecs` during
878
- startup in the :setting:`configuration file <setParameter>` or with
879
- the ``--setParameter`` option on the command line. For example, the
880
- following sets the :parameter:`tlsOCSPStaplingTimeoutSecs` to 20
881
- seconds:
870
+ .. include:: /includes/fact-startup-parameter
871
+
872
+ For example, the following sets the
873
+ :parameter:`tlsOCSPStaplingTimeoutSecs` to 20 seconds:
882
874
883
875
.. code-block:: bash
884
876
@@ -902,11 +894,10 @@ Authentication Parameters
902
894
903
895
Specify an integer greater than or equal to (``>=``) 1.
904
896
905
- You can only set :parameter:`tlsOCSPVerifyTimeoutSecs` during
906
- startup in the :setting:`configuration file <setParameter>` or with
907
- the ``--setParameter`` option on the command line. For example, the
908
- following sets the :parameter:`tlsOCSPVerifyTimeoutSecs` to 20
909
- seconds:
897
+ .. include:: /includes/fact-startup-parameter
898
+
899
+ For example, the following sets the
900
+ :parameter:`tlsOCSPVerifyTimeoutSecs` to 20 seconds:
910
901
911
902
.. code-block:: bash
912
903
@@ -933,10 +924,9 @@ Authentication Parameters
933
924
934
925
.. include:: /includes/fact-ssl-tlsCAFile-tlsUseSystemCA.rst
935
926
936
- You can set ``tlsUseSystemCA`` only during startup in the
937
- :setting:`configuration file <setParameter>` or with the ``--setParameter``
938
- option on the command line. For example, to set ``tlsUseSystemCA`` to
939
- ``true``:
927
+ .. include:: /includes/fact-startup-parameter
928
+
929
+ For example, to set ``tlsUseSystemCA`` to ``true``:
940
930
941
931
.. code-block:: bash
942
932
@@ -968,6 +958,8 @@ Authentication Parameters
968
958
deployment. ``tlsWithholdClientCertificate`` is mutually exclusive with
969
959
:option:`--clusterAuthMode x509 <mongod --clusterAuthMode>`.
970
960
961
+ .. include:: /includes/fact-startup-parameter
962
+
971
963
.. parameter:: tlsX509ClusterAuthDNOverride
972
964
973
965
.. versionadded:: 4.2
@@ -1002,6 +994,8 @@ Authentication Parameters
1002
994
If set, you must set this parameter on all members of the
1003
995
deployment.
1004
996
997
+ .. include:: /includes/fact-runtime-startup-parameter
998
+
1005
999
You can use this parameter for a rolling update of certificates to
1006
1000
new certificates that contain a new ``DN`` value. See
1007
1001
:doc:`/tutorial/rotate-x509-membership-certificates`.
@@ -1031,14 +1025,7 @@ Authentication Parameters
1031
1025
1032
1026
This parameter has a minimum value of ``0``.
1033
1027
1034
- You can only set :parameter:`tlsX509ExpirationWarningThresholdDays`
1035
- during ``mongod/mongos`` startup using either:
1036
-
1037
- - The :setting:`setParameter` configuration setting, *or*
1038
-
1039
- - The :option:`mongod --setParameter <mongod --setParameter>` /
1040
- :option:`mongos --setParameter <mongos --setParameter>` command
1041
- line option.
1028
+ .. include:: /includes/fact-startup-parameter
1042
1029
1043
1030
See :ref:`4.4-rel-notes-certificate-expiration-warning` for more
1044
1031
information on x.509 expiration warnings.
@@ -1088,6 +1075,8 @@ Authentication Parameters
1088
1075
This parameter has a minimum value of ``1`` second and a maximum
1089
1076
value of ``86400`` seconds (24 hours).
1090
1077
1078
+ .. include:: /includes/fact-runtime-startup-parameter
1079
+
1091
1080
.. parameter:: authFailedDelayMs
1092
1081
1093
1082
|both|
@@ -1115,8 +1104,7 @@ Authentication Parameters
1115
1104
A boolean flag that allows or disallows the retrieval of
1116
1105
authorization roles from client x.509 certificates.
1117
1106
1118
- You can only set :parameter:`allowRolesFromX509Certificates` during
1119
- startup in the config file or on the command line.
1107
+ .. include:: /includes/fact-startup-parameter
1120
1108
1121
1109
General Parameters
1122
1110
~~~~~~~~~~~~~~~~~~
0 commit comments