DOCS-3159 - added mechanism option to db.auth() for 2.6 change.

Signed-off-by: Sam Kleinman <[email protected]>
SpiriLiao · Sep 4, 2014 · 884624b · 884624b
1 parent 5cc630e
commit 884624b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/source/reference/method/db.auth-param.yaml b/source/reference/method/db.auth-param.yaml
@@ -19,4 +19,13 @@ name: password
 type: string
 position: 2
 description: "Specifies the corresponding password."
+---
+field:
+  optional: true
+  type: param
+  default: MONGODB-CR
+name: mechanism
+type: string
+position: 3
+description: "Specifies the authentication mechanism used. Defaults to ``MONGODB-CR``. ``PLAIN`` is used for :doc:`SASL/LDAP authentication </tutorial/configure-ldap-sasl-openldap>`, available only in MongoDB Enterprise."
 ...
diff --git a/source/reference/method/db.auth.txt b/source/reference/method/db.auth.txt
@@ -14,9 +14,13 @@ Definition
 
    .. include:: /reference/method/db.auth-param.rst
 
-   Alternatively, you can use :option:`mongo --username` and
-   :option:`--password <mongo --password>` to specify authentication
-   credentials.
+   Alternatively, you can use :option:`mongo --username`,
+   :option:`--password <mongo --password>`, and
+   :option:`--authenticationMechanism <mongo --authenticationMechanism>`
+   to specify authentication credentials.
+
+   :option:`--authenticationMechanism <mongo --authenticationMechanism>`
+   supports additional mechanisms not available when using :method:`db.auth()`.
 
    .. |operation-name| replace:: :method:`db.auth()`
    .. include:: /includes/note-auth-methods-excluded-from-shell-history.rst