mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
f75ffe46db
the ConfigParser module was renamed to configparser in Python3. Use six.moves to import it so that the modules will function on Python3.
239 lines
7.2 KiB
Python
239 lines
7.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
(c) 2016, Loic Blot <loic.blot@unix-experience.fr>
|
|
Sponsored by Infopro Digital. http://www.infopro-digital.com/
|
|
Sponsored by E.T.A.I. http://www.etai.fr/
|
|
|
|
This file is part of Ansible
|
|
|
|
Ansible is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
Ansible is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
"""
|
|
|
|
ANSIBLE_METADATA = {'status': ['preview'],
|
|
'supported_by': 'community',
|
|
'version': '1.0'}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: mongodb_parameter
|
|
short_description: Change an administrative parameter on a MongoDB server.
|
|
description:
|
|
- Change an administrative parameter on a MongoDB server.
|
|
version_added: "2.1"
|
|
options:
|
|
login_user:
|
|
description:
|
|
- The username used to authenticate with
|
|
required: false
|
|
default: null
|
|
login_password:
|
|
description:
|
|
- The password used to authenticate with
|
|
required: false
|
|
default: null
|
|
login_host:
|
|
description:
|
|
- The host running the database
|
|
required: false
|
|
default: localhost
|
|
login_port:
|
|
description:
|
|
- The port to connect to
|
|
required: false
|
|
default: 27017
|
|
login_database:
|
|
description:
|
|
- The database where login credentials are stored
|
|
required: false
|
|
default: null
|
|
replica_set:
|
|
description:
|
|
- Replica set to connect to (automatically connects to primary for writes)
|
|
required: false
|
|
default: null
|
|
database:
|
|
description:
|
|
- The name of the database to add/remove the user from
|
|
required: true
|
|
ssl:
|
|
description:
|
|
- Whether to use an SSL connection when connecting to the database
|
|
required: false
|
|
default: false
|
|
param:
|
|
description:
|
|
- MongoDB administrative parameter to modify
|
|
required: true
|
|
value:
|
|
description:
|
|
- MongoDB administrative parameter value to set
|
|
required: true
|
|
param_type:
|
|
description:
|
|
- Define the parameter value (str, int)
|
|
required: false
|
|
default: str
|
|
|
|
notes:
|
|
- Requires the pymongo Python package on the remote host, version 2.4.2+. This
|
|
can be installed using pip or the OS package manager. @see http://api.mongodb.org/python/current/installation.html
|
|
requirements: [ "pymongo" ]
|
|
author: "Loic Blot (@nerzhul)"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Set MongoDB syncdelay to 60 (this is an int)
|
|
- mongodb_parameter:
|
|
param: syncdelay
|
|
value: 60
|
|
param_type: int
|
|
'''
|
|
|
|
RETURN = '''
|
|
before:
|
|
description: value before modification
|
|
returned: success
|
|
type: string
|
|
after:
|
|
description: value after modification
|
|
returned: success
|
|
type: string
|
|
'''
|
|
|
|
import os
|
|
|
|
try:
|
|
from pymongo.errors import ConnectionFailure
|
|
from pymongo.errors import OperationFailure
|
|
from pymongo import version as PyMongoVersion
|
|
from pymongo import MongoClient
|
|
except ImportError:
|
|
try: # for older PyMongo 2.2
|
|
from pymongo import Connection as MongoClient
|
|
except ImportError:
|
|
pymongo_found = False
|
|
else:
|
|
pymongo_found = True
|
|
else:
|
|
pymongo_found = True
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.pycompat24 import get_exception
|
|
from ansible.module_utils.six.moves import configparser
|
|
|
|
|
|
# =========================================
|
|
# MongoDB module specific support methods.
|
|
#
|
|
|
|
def load_mongocnf():
|
|
config = configparser.RawConfigParser()
|
|
mongocnf = os.path.expanduser('~/.mongodb.cnf')
|
|
|
|
try:
|
|
config.readfp(open(mongocnf))
|
|
creds = dict(
|
|
user=config.get('client', 'user'),
|
|
password=config.get('client', 'pass')
|
|
)
|
|
except (configparser.NoOptionError, IOError):
|
|
return False
|
|
|
|
return creds
|
|
|
|
|
|
# =========================================
|
|
# Module execution.
|
|
#
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
login_user=dict(default=None),
|
|
login_password=dict(default=None, no_log=True),
|
|
login_host=dict(default='localhost'),
|
|
login_port=dict(default=27017, type='int'),
|
|
login_database=dict(default=None),
|
|
replica_set=dict(default=None),
|
|
param=dict(default=None, required=True),
|
|
value=dict(default=None, required=True),
|
|
param_type=dict(default="str", choices=['str', 'int']),
|
|
ssl=dict(default=False, type='bool'),
|
|
)
|
|
)
|
|
|
|
if not pymongo_found:
|
|
module.fail_json(msg='the python pymongo module is required')
|
|
|
|
login_user = module.params['login_user']
|
|
login_password = module.params['login_password']
|
|
login_host = module.params['login_host']
|
|
login_port = module.params['login_port']
|
|
login_database = module.params['login_database']
|
|
|
|
replica_set = module.params['replica_set']
|
|
ssl = module.params['ssl']
|
|
|
|
param = module.params['param']
|
|
param_type = module.params['param_type']
|
|
value = module.params['value']
|
|
|
|
# Verify parameter is coherent with specified type
|
|
try:
|
|
if param_type == 'int':
|
|
value = int(value)
|
|
except ValueError:
|
|
e = get_exception()
|
|
module.fail_json(msg="value '%s' is not %s" % (value, param_type))
|
|
|
|
try:
|
|
if replica_set:
|
|
client = MongoClient(login_host, int(login_port), replicaset=replica_set, ssl=ssl)
|
|
else:
|
|
client = MongoClient(login_host, int(login_port), ssl=ssl)
|
|
|
|
if login_user is None and login_password is None:
|
|
mongocnf_creds = load_mongocnf()
|
|
if mongocnf_creds is not False:
|
|
login_user = mongocnf_creds['user']
|
|
login_password = mongocnf_creds['password']
|
|
elif login_password is None or login_user is None:
|
|
module.fail_json(msg='when supplying login arguments, both login_user and login_password must be provided')
|
|
|
|
if login_user is not None and login_password is not None:
|
|
client.admin.authenticate(login_user, login_password, source=login_database)
|
|
|
|
except ConnectionFailure:
|
|
e = get_exception()
|
|
module.fail_json(msg='unable to connect to database: %s' % str(e))
|
|
|
|
db = client.admin
|
|
|
|
try:
|
|
after_value = db.command("setParameter", **{param: value})
|
|
except OperationFailure:
|
|
e = get_exception()
|
|
module.fail_json(msg="unable to change parameter: %s" % str(e))
|
|
|
|
if "was" not in after_value:
|
|
module.exit_json(changed=True, msg="Unable to determine old value, assume it changed.")
|
|
else:
|
|
module.exit_json(changed=(value != after_value["was"]), before=after_value["was"],
|
|
after=value)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|