Skip to content

Commit cb156b6

Browse files
authored
Add ldapQueryUser and ldapQueryPassword (#5683) (#5709)
* Add ldapQueryUser and ldapQueryPassword * simplify verbiage * fix indentation issue * add facet;
1 parent d9d52ed commit cb156b6

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

source/reference/parameters.txt

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ MongoDB Server Parameters
44

55
.. default-domain:: mongodb
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
711
.. contents:: On this page
812
:local:
913
:backlinks: none
@@ -178,6 +182,61 @@ Authentication Parameters
178182
If you have any concerns regarding your MongoDB version, OS version or
179183
libldap version, please contact MongoDB Support.
180184

185+
.. parameter:: ldapQueryPassword
186+
187+
.. versionadded:: 4.4
188+
189+
|both|
190+
191+
*Type*: string
192+
193+
The password used to bind to an LDAP server. You must use
194+
:parameter:`ldapQueryUser` with this parameter.
195+
196+
If not set, mongod or mongos does not attempt to bind to the LDAP server.
197+
198+
.. parameter:: ldapQueryUser
199+
200+
.. versionadded:: 4.4
201+
202+
|both|
203+
204+
*Type*: string
205+
206+
The user that binds to an LDAP server. You must use
207+
:parameter:`ldapQueryPassword` with this parameter.
208+
209+
If not set, mongod or mongos does not attempt to bind to the LDAP server.
210+
211+
.. parameter:: ldapRetryCount
212+
213+
.. versionadded:: 6.1
214+
215+
|both|
216+
217+
*Type*: integer
218+
219+
*Default*: 0
220+
221+
For MongoDB deployments using :ref:`security-ldap-external`.
222+
223+
Number of operation retries by the server LDAP manager after a
224+
network error.
225+
226+
For example, the following sets :parameter:`ldapRetryCount` to ``3``
227+
seconds:
228+
229+
.. code-block:: bash
230+
231+
mongod --ldapRetryCount=3
232+
233+
Or, if using the :dbcommand:`setParameter` command within
234+
:binary:`~bin.mongosh`:
235+
236+
.. code-block:: javascript
237+
238+
db.adminCommand( { setParameter: 1, ldapRetryCount: 3 } )
239+
181240
.. parameter:: ldapUserCacheInvalidationInterval
182241

183242
For use with MongoDB deployments using

0 commit comments

Comments
 (0)