summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/mongodb/plugins/doc_fragments/ssl_options.py
blob: efd330b7db4c2c0af13574e345a7a2bf63a5d43d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
'''