Skip to content

Commit 7cba245

Browse files
authored
Add ldapQueryUser and ldapQueryPassword (#5683) (#5707)
* Add ldapQueryUser and ldapQueryPassword * simplify verbiage * fix indentation issue * add facet;
1 parent 8f1f62a commit 7cba245

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
@@ -6,6 +6,10 @@ MongoDB Server Parameters
66

77
.. default-domain:: mongodb
88

9+
.. facet::
10+
:name: genre
11+
:values: reference
12+
913
.. contents:: On this page
1014
:local:
1115
:backlinks: none
@@ -182,6 +186,61 @@ Authentication Parameters
182186
If you have any concerns regarding your MongoDB version, OS version or
183187
libldap version, please contact MongoDB Support.
184188

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

187246
.. versionchanged:: 5.2

0 commit comments

Comments
 (0)