summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/mongodb/plugins/doc_fragments/login_options.py
blob: 5307bca6e2868ed398342e46fdd4c030778527e6 (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
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
'''