Skip to content

Commit 1f5d9c4

Browse files
jason-price-mongodbjason-price-mongodb
andauthored
DOCS-15464 ldap logic (#1992)
* DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic * DOCS-15464-LDAP-logic Co-authored-by: jason-price-mongodb <[email protected]>
1 parent 0b79cae commit 1f5d9c4

File tree

6 files changed

+76
-1
lines changed

6 files changed

+76
-1
lines changed

source/reference/configuration-file-settings-command-line-options-mapping.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,10 @@ and :binary:`~bin.mongos` command-line options.
293293
- | :option:`mongod --ldapBindWithOSDefaults`
294294
| :option:`mongos --ldapBindWithOSDefaults`
295295

296+
* - :setting:`security.ldap.retryCount`
297+
- | :option:`mongod --ldapRetryCount`
298+
| :option:`mongos --ldapRetryCount`
299+
296300
* - :setting:`security.ldap.servers`
297301
- | :option:`mongod --ldapServers`
298302
| :option:`mongos --ldapServers`

source/reference/configuration-options.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3126,6 +3126,7 @@ Key Management Configuration Options
31263126
useOSDefaults: <boolean>
31273127
transportSecurity: <string>
31283128
timeoutMS: <int>
3129+
retryCount: <int>
31293130
userToDNMapping: <string>
31303131
authz:
31313132
queryTemplate: <string>
@@ -3355,6 +3356,21 @@ Key Management Configuration Options
33553356
This setting can be configured on a running :binary:`~bin.mongod` or :binary:`~bin.mongos` using
33563357
:dbcommand:`setParameter`.
33573358

3359+
.. setting:: security.ldap.retryCount
3360+
3361+
.. versionadded:: 6.1
3362+
3363+
*Type*: int
3364+
3365+
*Default*: 0
3366+
3367+
*Available in MongoDB Enterprise only.*
3368+
3369+
Number of operation retries by the server LDAP manager after a
3370+
network error.
3371+
3372+
This setting can be configured on a running :binary:`~bin.mongod` or
3373+
:binary:`~bin.mongos` using :dbcommand:`setParameter`.
33583374

33593375
.. setting:: security.ldap.userToDNMapping
33603376

source/reference/parameters.txt

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,35 @@ Authentication Parameters
150150
If you have any concerns regarding your MongoDB version, OS version or
151151
libldap version, please contact MongoDB Support.
152152

153+
.. parameter:: ldapRetryCount
154+
155+
.. versionadded:: 6.1
156+
157+
|both|
158+
159+
*Type*: integer
160+
161+
*Default*: 0
162+
163+
For MongoDB deployments using :ref:`security-ldap-external`.
164+
165+
Number of operation retries by the server LDAP manager after a
166+
network error.
167+
168+
For example, the following sets :parameter:`ldapRetryCount` to ``3``
169+
seconds:
170+
171+
.. code-block:: bash
172+
173+
mongod --ldapRetryCount=3
174+
175+
Or, if using the :dbcommand:`setParameter` command within
176+
:binary:`~bin.mongosh`:
177+
178+
.. code-block:: javascript
179+
180+
db.adminCommand( { setParameter: 1, ldapRetryCount: 3 } )
181+
153182
.. parameter:: ldapUserCacheInvalidationInterval
154183

155184
.. versionchanged:: 5.2
@@ -4466,7 +4495,7 @@ Storage Parameters
44664495
larger value increases the chance that the cache pressure
44674496
will be reduced before the next retry.
44684497

4469-
To configure number of retires, use
4498+
To configure number of retries, use
44704499
:parameter:`temporarilyUnavailableMaxRetries`.
44714500

44724501
To set a new value, use :method:`db.adminCommand()`:

source/reference/program/mongod.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1137,6 +1137,18 @@ LDAP Authentication or Authorization Options
11371137
:dbcommand:`setParameter`.
11381138

11391139

1140+
.. option:: --ldapRetryCount <int>
1141+
1142+
.. versionadded:: 6.1
1143+
1144+
*Default*: 0
1145+
1146+
*Available in MongoDB Enterprise only.*
1147+
1148+
Number of operation retries by the server LDAP manager after a
1149+
network error.
1150+
1151+
11401152
.. option:: --ldapUserToDNMapping <string>
11411153

11421154
*Available in MongoDB Enterprise only.*

source/reference/program/mongos.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1916,6 +1916,18 @@ LDAP Authentication and Authorization Options
19161916
:dbcommand:`setParameter`.
19171917

19181918

1919+
.. option:: --ldapRetryCount <int>
1920+
1921+
.. versionadded:: 6.1
1922+
1923+
*Default*: 0
1924+
1925+
*Available in MongoDB Enterprise only.*
1926+
1927+
Number of operation retries by the server LDAP manager after a
1928+
network error.
1929+
1930+
19191931
.. option:: --ldapUserToDNMapping <string>
19201932

19211933
*Available in MongoDB Enterprise only.*

source/release-notes/6.1.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,8 @@ Starting in MongoDB 6.1, MongoDB adds the following new parameters:
370370
between retries after a write failure.
371371
- :parameter:`temporarilyUnavailableMaxRetries` limits the number of
372372
retries after a write failure.
373+
- :parameter:`ldapRetryCount` sets the number of operation retries by
374+
the server LDAP manager after a network error.
373375

374376
Report an Issue
375377
---------------

0 commit comments

Comments
 (0)