Skip to content

Commit 197dedc

Browse files
Isabella Siukay-kim
authored andcommitted
DOCS-12051 add setParameter tlsWithholdClientCertificate
1 parent 4923ee8 commit 197dedc

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

source/reference/parameters.txt

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,53 @@ Authentication Parameters
277277

278278
db.adminCommand( { setParameter: 1, sslMode: "preferSSL" } )
279279

280+
.. parameter:: tlsWithholdClientCertificate
281+
282+
*Default*: false
283+
284+
.. versionadded:: 4.2
285+
286+
|both|
287+
288+
A TLS certificate is set for a :binary:`mongod <bin.mongod>` or
289+
:binary:`mongos <bin.mongos>` either by the
290+
:option:`--tlsClusterFile <mongod --tlsClusterFile>` option or by the
291+
:option:`--tlsPEMKeyFile <mongod --tlsPEMKeyFile>` option when
292+
:option:`--tlsClusterFile <mongod --tlsClusterFile>` is not set. If the TLS
293+
certificate is set, by default, the instance sends the certificate when
294+
initiating intra-cluster communications with other
295+
:binary:`mongod <bin.mongod>` or :binary:`mongos <bin.mongos>` instances in
296+
the deployment. Set ``tlsWithholdClientCertificate`` to ``1`` or ``true`` to
297+
direct the instance to withhold sending its TLS certificate during these
298+
communications. Use this option with
299+
:option:`--tlsAllowConnectionsWithoutCertificates <mongod --tlsAllowConnectionsWithoutCertificates>`
300+
(to allow inbound connections without certificates) on all members of the
301+
deployment. ``tlsWithholdClientCertificate`` is mutually exclusive with
302+
:option:`--clusterAuthMode x509 <mongod --clusterAuthMode>`.
303+
304+
.. parameter:: sslWithholdClientCertificate
305+
306+
*Default*: false
307+
308+
.. deprecated:: 4.2 Use :parameter:`tlsWithholdClientCertificate` instead.
309+
310+
|both|
311+
312+
A TLS certificate is set for a :binary:`mongod <bin.mongod>` or
313+
:binary:`mongos <bin.mongos>` either by the
314+
:option:`--tlsClusterFile <mongod --tlsClusterFile>` option or by the
315+
:option:`--tlsPEMKeyFile <mongod --tlsPEMKeyFile>` option when
316+
:option:`--tlsClusterFile <mongod --tlsClusterFile>` is not set. If the TLS
317+
certificate is set, by default, the instance sends the certificate when
318+
initiating intra-cluster communications with other
319+
:binary:`mongod <bin.mongod>` or :binary:`mongos <bin.mongos>` instances in
320+
the deployment. Set ``sslWithholdClientCertificate`` to ``1`` or ``true`` to
321+
direct the instance to withhold sending its TLS certificate during these
322+
communications. Use this option with
323+
:option:`--tlsAllowConnectionsWithoutCertificates <mongod --tlsAllowConnectionsWithoutCertificates>`
324+
(to allow inbound connections without certificates) on all members of the
325+
deployment. ``sslWithholdClientCertificate`` is mutually exclusive with
326+
:option:`--clusterAuthMode x509 <mongod --clusterAuthMode>`.
280327

281328
.. parameter:: userCacheInvalidationIntervalSecs
282329

0 commit comments

Comments
 (0)