Skip to content

Commit 30f04a1

Browse files
committed
DOCSP-17535 revert mongosh options links
1 parent 28936fd commit 30f04a1

35 files changed

+140
-140
lines changed

source/appendix/security/appendixC-openssl-client.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ B. Generate the Test PEM File for Client
163163
openssl pkcs12 -export -out test-client.pfx -inkey mongodb-test-client.key -in mongodb-test-client.crt -certfile mongodb-test-ia.crt
164164

165165
Once added to Keychain Access, instead of specifying the Certificate Key
166-
file, you can use the :option:`--tlsCertificateSelector <mongosh
166+
file, you can use the :option:`--tlsCertificateSelector <mongo
167167
--tlsCertificateSelector>` to specify the certificate to use. If
168168
the CA file is also in Keychain Access, you can omit
169169
``--tlsCAFile`` as well as in the following example:
@@ -174,8 +174,8 @@ B. Generate the Test PEM File for Client
174174

175175
mongosh --tls --tlsCertificateSelector subject="<TestClientCertificateCommonName>"
176176

177-
Although still available, :option:`--ssl <mongosh --ssl>` and
178-
:option:`--sslCertificateSelector <mongosh
177+
Although still available, :option:`--ssl <mongo --ssl>` and
178+
:option:`--sslCertificateSelector <mongo
179179
--sslCertificateSelector>` are :ref:`deprecated as of MongoDB 4.2
180180
<4.2-tls>`.
181181

source/core/retryable-writes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ MongoDB Drivers
7575

7676
:mongosh:`mongosh </>`
7777
To enable retryable writes in :mongosh:`mongosh </>`, use
78-
the :option:`--retryWrites <mongosh --retryWrites>` command line option:
78+
the :option:`--retryWrites <mongo --retryWrites>` command line option:
7979

8080
.. code-block:: bash
8181

source/core/security-ldap-external.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -405,9 +405,9 @@ Connecting to a MongoDB server using LDAP Authorization
405405
When using LDAP for authorization, users connecting via
406406
:mongosh:`mongosh </>` must:
407407

408-
- set :option:`--authenticationDatabase <mongosh --authenticationDatabase>` to ``$external``.
408+
- set :option:`--authenticationDatabase <mongo --authenticationDatabase>` to ``$external``.
409409

410-
- set :option:`--authenticationMechanism <mongosh --authenticationMechanism>` to the appropriate authentication
410+
- set :option:`--authenticationMechanism <mongo --authenticationMechanism>` to the appropriate authentication
411411
mechanism.
412412

413413
If using :ref:`LDAP authentication <security-ldap>`, set this to ``PLAIN``.
@@ -417,13 +417,13 @@ When using LDAP for authorization, users connecting via
417417

418418
If using :ref:`x.509 <security-auth-x509>`, set this to ``MONGODB-X.509``.
419419

420-
- set :option:`--username <mongosh --username>` to a username that respects the
420+
- set :option:`--username <mongo --username>` to a username that respects the
421421
:setting:`security.ldap.authz.queryTemplate`, or any configured
422422
:setting:`security.ldap.userToDNMapping` template.
423423

424-
- set :option:`--password <mongosh --password>` to the appropriate password.
424+
- set :option:`--password <mongo --password>` to the appropriate password.
425425

426-
Include the :option:`--host <mongosh --host>` and :option:`--port <mongosh --port>` of the MongoDB server,
426+
Include the :option:`--host <mongo --host>` and :option:`--port <mongo --port>` of the MongoDB server,
427427
along with any other options relevant to your deployment.
428428

429429
For example, the following operation authenticates to a MongoDB server running

source/core/security-x.509.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,36 +65,36 @@ To connect and authenticate using x.509 client certificate:
6565

6666
- For MongoDB 4.2 or greater, include the following options for the client:
6767

68-
- :option:`--tls <mongosh --tls>` (or the deprecated :option:`--ssl
69-
<mongosh --ssl>` option)
68+
- :option:`--tls <mongo --tls>` (or the deprecated :option:`--ssl
69+
<mongo --ssl>` option)
7070

71-
- :option:`--tlsCertificateKeyFile <mongosh --tlsCertificateKeyFile>`
71+
- :option:`--tlsCertificateKeyFile <mongo --tlsCertificateKeyFile>`
7272
(or the deprecated :option:`--sslPEMKeyFile
73-
<mongosh --sslPEMKeyFile>` option)
73+
<mongo --sslPEMKeyFile>` option)
7474

75-
- :option:`--tlsCertificateKeyFilePassword <mongosh --tlsCertificateKeyFile>`
75+
- :option:`--tlsCertificateKeyFilePassword <mongo --tlsCertificateKeyFile>`
7676
(or the deprecated :option:`--sslPEMKeyPassword
77-
<mongosh --sslPEMKeyPassword>` option) if the certificate key file is encrypted
77+
<mongo --sslPEMKeyPassword>` option) if the certificate key file is encrypted
7878

7979
- :option:`--authenticationDatabase '$external'
80-
<mongosh --authenticationDatabase>`
80+
<mongo --authenticationDatabase>`
8181

8282
- :option:`--authenticationMechanism MONGODB-X509
83-
<mongosh --authenticationMechanism>`
83+
<mongo --authenticationMechanism>`
8484

8585
- For MongoDB 4.0 and earlier, include the following options for the client:
8686

87-
- :option:`--ssl <mongosh --ssl>`
87+
- :option:`--ssl <mongo --ssl>`
8888

89-
- :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
89+
- :option:`--sslPEMKeyFile <mongo --sslPEMKeyFile>`
9090

91-
- :option:`--sslPEMKeyPassword <mongosh --sslPEMKeyPassword>` option if
92-
the :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>` is encrypted.
91+
- :option:`--sslPEMKeyPassword <mongo --sslPEMKeyPassword>` option if
92+
the :option:`--sslPEMKeyFile <mongo --sslPEMKeyFile>` is encrypted.
9393

9494
- :option:`--authenticationDatabase '$external'
95-
<mongosh --authenticationDatabase>`
95+
<mongo --authenticationDatabase>`
9696

97-
- :option:`--authenticationMechanism MONGODB-X509 <mongosh --authenticationMechanism>`
97+
- :option:`--authenticationMechanism MONGODB-X509 <mongo --authenticationMechanism>`
9898

9999
You can also make the TLS/SSL connection first, and then use
100100
:method:`db.auth()` in the ``$external`` database to authenticate.

source/core/sharded-cluster-query-router.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,9 @@ server>`, with the :option:`--auth <mongod --auth>` option in order to enforce R
346346
Alternatively, enforcing :doc:`/core/security-internal-authentication` for
347347
inter-cluster security also enables user access controls via RBAC.
348348

349-
With RBAC enforced, clients must specify a :option:`--username <mongosh --username>`,
350-
:option:`--password <mongosh --password>`, and
351-
:option:`--authenticationDatabase <mongosh --authenticationDatabase>` when
349+
With RBAC enforced, clients must specify a :option:`--username <mongo --username>`,
350+
:option:`--password <mongo --password>`, and
351+
:option:`--authenticationDatabase <mongo --authenticationDatabase>` when
352352
connecting to the :binary:`~bin.mongos` in order to access cluster resources.
353353

354354
Each cluster has its own cluster users. These users cannot be used

source/includes/extracts-ssl-facts.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ ref: ssl-facts-mongo-ssl-hostname-verification
8282
content: |
8383
8484
:mongosh:`mongosh </>` verifies that the hostname (specified
85-
in :option:`--host <mongosh --host>` option or the connection string)
85+
in :option:`--host <mongo --host>` option or the connection string)
8686
matches the ``SAN`` (or, if ``SAN`` is not present, the ``CN``) in
8787
the certificate presented by the :binary:`~bin.mongod` or
8888
:binary:`~bin.mongos`. If ``SAN`` is present, :mongosh:`mongosh </>`

source/includes/fact-authenticate.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ associated with that user.
55
To authenticate using :mongosh:`mongosh </>`, either:
66

77
- Use the :mongosh:`mongosh </>` command-line authentication options
8-
(:option:`--username <mongosh --username>`,
9-
:option:`--password <mongosh --password>`, and
10-
:option:`--authenticationDatabase <mongosh --authenticationDatabase>`)
8+
(:option:`--username <mongo --username>`,
9+
:option:`--password <mongo --password>`, and
10+
:option:`--authenticationDatabase <mongo --authenticationDatabase>`)
1111
when connecting to the :binary:`~bin.mongod` or
1212
:binary:`~bin.mongos` instance, or
1313

source/includes/steps-authenticate-as-client.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ action:
55
pre: |
66
When using :mongosh:`mongosh </>` to connect to a :binary:`~bin.mongod` or
77
:binary:`~bin.mongos`, enter your ``username``, ``password``, and
8-
:option:`authenticationDatabase <mongosh --authenticationDatabase>`. For
8+
:option:`authenticationDatabase <mongo --authenticationDatabase>`. For
99
example:
1010
language: javascript
1111
code: |

source/includes/steps-change-own-password-and-custom-data-prereq.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ action:
1111
code: |
1212
mongosh --port 27017 -u myUserAdmin -p --authenticationDatabase 'admin'
1313
post: |
14-
If you do not specify the password to the :option:`-p <mongosh -p>`
14+
If you do not specify the password to the :option:`-p <mongo -p>`
1515
command-line option, :mongosh:`mongosh </>` prompts for the
1616
password.
1717
---

source/includes/steps-change-own-password-and-custom-data.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ action:
1414
mongosh --port 27017 -u user123 --authenticationDatabase 'test' -p
1515
post: |
1616
17-
If you do not specify the password to the :option:`-p <mongosh -p>`
17+
If you do not specify the password to the :option:`-p <mongo -p>`
1818
command-line option, :mongosh:`mongosh </>` prompts for the
1919
password.
2020

0 commit comments

Comments
 (0)