summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/mongodb/plugins/doc_fragments
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/community/mongodb/plugins/doc_fragments')
-rw-r--r--ansible_collections/community/mongodb/plugins/doc_fragments/login_options.py49
-rw-r--r--ansible_collections/community/mongodb/plugins/doc_fragments/ssl_options.py79
2 files changed, 128 insertions, 0 deletions
diff --git a/ansible_collections/community/mongodb/plugins/doc_fragments/login_options.py b/ansible_collections/community/mongodb/plugins/doc_fragments/login_options.py
new file mode 100644
index 000000000..5307bca6e
--- /dev/null
+++ b/ansible_collections/community/mongodb/plugins/doc_fragments/login_options.py
@@ -0,0 +1,49 @@
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+ # Standard documentation
+ DOCUMENTATION = r'''
+options:
+ login_user:
+ description:
+ - The MongoDB user to login with.
+ - Required when I(login_password) is specified.
+ required: no
+ type: str
+ login_password:
+ description:
+ - The password used to authenticate with.
+ - Required when I(login_user) is specified.
+ required: no
+ type: str
+ login_database:
+ description:
+ - The database where login credentials are stored.
+ required: no
+ type: str
+ default: 'admin'
+ login_host:
+ description:
+ - The host running MongoDB instance to login to.
+ required: no
+ type: str
+ default: 'localhost'
+ login_port:
+ description:
+ - The MongoDB server port to login to.
+ required: no
+ type: int
+ default: 27017
+ strict_compatibility:
+ description:
+ - Enforce strict requirements for pymongo and MongoDB software versions
+ type: bool
+ default: True
+ atlas_auth:
+ description:
+ - Authentication path intended for MongoDB Atlas Instances
+ type: bool
+ default: False
+'''
diff --git a/ansible_collections/community/mongodb/plugins/doc_fragments/ssl_options.py b/ansible_collections/community/mongodb/plugins/doc_fragments/ssl_options.py
new file mode 100644
index 000000000..efd330b7d
--- /dev/null
+++ b/ansible_collections/community/mongodb/plugins/doc_fragments/ssl_options.py
@@ -0,0 +1,79 @@
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+ # Standard documentation
+ DOCUMENTATION = r'''
+options:
+ ssl:
+ description:
+ - Whether to use an SSL connection when connecting to the database.
+ required: no
+ type: bool
+ default: no
+ aliases:
+ - tls
+ ssl_cert_reqs:
+ description:
+ - Specifies whether a certificate is required from the other side of the connection,
+ and whether it will be validated if provided.
+ required: no
+ type: str
+ default: 'CERT_REQUIRED'
+ choices:
+ - 'CERT_NONE'
+ - 'CERT_OPTIONAL'
+ - 'CERT_REQUIRED'
+ aliases:
+ - tlsAllowInvalidCertificates
+ ssl_ca_certs:
+ description:
+ - The ssl_ca_certs option takes a path to a CA file.
+ required: no
+ type: str
+ aliases:
+ - tlsCAFile
+ ssl_crlfile:
+ description:
+ - The ssl_crlfile option takes a path to a CRL file.
+ required: no
+ type: str
+ ssl_certfile:
+ description:
+ - Present a client certificate using the ssl_certfile option.
+ required: no
+ type: str
+ aliases:
+ - tlsCertificateKeyFile
+ ssl_keyfile:
+ description:
+ - Private key for the client certificate.
+ required: no
+ type: str
+ ssl_pem_passphrase:
+ description:
+ - Passphrase to decrypt encrypted private keys.
+ required: no
+ type: str
+ aliases:
+ - tlsCertificateKeyFilePassword
+ auth_mechanism:
+ description:
+ - Authentication type.
+ required: no
+ type: str
+ choices:
+ - 'SCRAM-SHA-256'
+ - 'SCRAM-SHA-1'
+ - 'MONGODB-X509'
+ - 'GSSAPI'
+ - 'PLAIN'
+ connection_options:
+ description:
+ - Additional connection options.
+ - Supply as a list of dicts or strings containing key value pairs seperated with '='.
+ required: no
+ type: list
+ elements: raw
+'''