mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
add Ansible Tower role module (#21592)
* add Ansible Tower role module * remove owner as choice from role paramenter
This commit is contained in:
Wayne Witzel III
Brian Coca
parent
96772719ba
commit
4632b65086
1 changed files with 226 additions and 0 deletions
|
|
@ -0,0 +1,226 @@
|
|||
#!/usr/bin/python
|
||||
#coding: utf-8 -*-
|
||||
|
||||
# (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
|
||||
#
|
||||
# This module 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.
|
||||
#
|
||||
# This software 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 this software. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
ANSIBLE_METADATA = {'status': ['preview'],
|
||||
'supported_by': 'community',
|
||||
'version': '1.0'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_role
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower role.
|
||||
description:
|
||||
- Create, update, or destroy Ansible Tower roles. See
|
||||
U(https://www.ansible.com/tower) for an overview.
|
||||
options:
|
||||
user:
|
||||
description:
|
||||
- User that receives the permissions specified by the role.
|
||||
required: False
|
||||
default: null
|
||||
team:
|
||||
description:
|
||||
- Team that receives the permissions specified by the role.
|
||||
required: False
|
||||
default: null
|
||||
role:
|
||||
description:
|
||||
- The role type to grant/revoke.
|
||||
required: True
|
||||
choices: ["admin", "read", "member", "execute", "adhoc", "update", "use", "auditor"]
|
||||
target_team:
|
||||
description:
|
||||
- Team that the role acts on.
|
||||
required: False
|
||||
default: null
|
||||
inventory:
|
||||
description:
|
||||
- Inventory the role acts on.
|
||||
required: False
|
||||
default: null
|
||||
job_template:
|
||||
description:
|
||||
- The job_template the role acts on.
|
||||
required: False
|
||||
default: null
|
||||
credential:
|
||||
description:
|
||||
- Credential the role acts on.
|
||||
required: False
|
||||
default: null
|
||||
organization:
|
||||
description:
|
||||
- Organiation the role acts on.
|
||||
required: False
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Project the role acts on.
|
||||
required: False
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Desired state of the resource.
|
||||
required: False
|
||||
default: "present"
|
||||
choices: ["present", "absent"]
|
||||
tower_host:
|
||||
description:
|
||||
- URL to your Tower instance.
|
||||
required: False
|
||||
default: null
|
||||
tower_username:
|
||||
description:
|
||||
- Username for your Tower instance.
|
||||
required: False
|
||||
default: null
|
||||
tower_password:
|
||||
description:
|
||||
- Password for your Tower instance.
|
||||
required: False
|
||||
default: null
|
||||
tower_verify_ssl:
|
||||
description:
|
||||
- Dis/allow insecure connections to Tower. If C(no), SSL certificates will not be validated.
|
||||
This should only be used on personally controlled sites using self-signed certificates.
|
||||
required: False
|
||||
default: True
|
||||
tower_config_file:
|
||||
description:
|
||||
- Path to the Tower config file. See notes.
|
||||
required: False
|
||||
default: null
|
||||
|
||||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "ansible-tower-cli >= 3.0.3"
|
||||
|
||||
notes:
|
||||
- If no I(config_file) is provided we will attempt to use the tower-cli library
|
||||
defaults to find your Tower host information.
|
||||
- I(config_file) should contain Tower configuration in the following format
|
||||
host=hostname
|
||||
username=username
|
||||
password=password
|
||||
'''
|
||||
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Add jdoe to the member role of My Team
|
||||
tower_role:
|
||||
user: jdoe
|
||||
target_team: "My Team"
|
||||
role: member
|
||||
state: present
|
||||
tower_config_file: "~/tower_cli.cfg"
|
||||
'''
|
||||
|
||||
try:
|
||||
import tower_cli
|
||||
import tower_cli.utils.exceptions as exc
|
||||
|
||||
from tower_cli.conf import settings
|
||||
from ansible.module_utils.ansible_tower import tower_auth_config, tower_check_mode
|
||||
|
||||
HAS_TOWER_CLI = True
|
||||
except ImportError:
|
||||
HAS_TOWER_CLI = False
|
||||
|
||||
|
||||
def update_resources(module, p):
|
||||
'''update_resources attempts to fetch any of the resources given
|
||||
by name using their unique field (identity)
|
||||
'''
|
||||
params = p.copy()
|
||||
identity_map = {
|
||||
'user':'username',
|
||||
'team':'name',
|
||||
'target_team':'name',
|
||||
'inventory':'name',
|
||||
'job_template':'name',
|
||||
'credential':'name',
|
||||
'organization':'name',
|
||||
'project':'name',
|
||||
}
|
||||
for k,v in identity_map.items():
|
||||
try:
|
||||
if params[k]:
|
||||
key = 'team' if k == 'target_team' else k
|
||||
result = tower_cli.get_resource(key).get(**{v:params[k]})
|
||||
params[k] = result['id']
|
||||
except (exc.NotFound) as excinfo:
|
||||
module.fail_json(msg='Failed to update role, {0} not found: {1}'.format(k, excinfo), changed=False)
|
||||
return params
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec = dict(
|
||||
user = dict(),
|
||||
team = dict(),
|
||||
role = dict(choices=["admin", "read", "member", "execute", "adhoc", "update", "use", "auditor"]),
|
||||
target_team = dict(),
|
||||
inventory = dict(),
|
||||
job_template = dict(),
|
||||
credential = dict(),
|
||||
organization = dict(),
|
||||
project = dict(),
|
||||
tower_host = dict(),
|
||||
tower_username = dict(),
|
||||
tower_password = dict(no_log=True),
|
||||
tower_verify_ssl = dict(type='bool', default=True),
|
||||
tower_config_file = dict(type='path'),
|
||||
state = dict(choices=['present', 'absent'], default='present'),
|
||||
),
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not HAS_TOWER_CLI:
|
||||
module.fail_json(msg='ansible-tower-cli required for this module')
|
||||
|
||||
role_type = module.params.pop('role')
|
||||
state = module.params.get('state')
|
||||
|
||||
json_output = {'role': role_type, 'state': state}
|
||||
|
||||
tower_auth = tower_auth_config(module)
|
||||
with settings.runtime_values(**tower_auth):
|
||||
tower_check_mode(module)
|
||||
role = tower_cli.get_resource('role')
|
||||
|
||||
params = update_resources(module, module.params)
|
||||
params['type'] = role_type
|
||||
|
||||
try:
|
||||
if state == 'present':
|
||||
result = role.grant(**params)
|
||||
json_output['id'] = result['id']
|
||||
elif state == 'absent':
|
||||
result = role.revoke(**params)
|
||||
except (exc.ConnectionError, exc.BadRequest, exc.NotFound) as excinfo:
|
||||
module.fail_json(msg='Failed to update role: {0}'.format(excinfo), changed=False)
|
||||
|
||||
json_output['changed'] = result['changed']
|
||||
module.exit_json(**json_output)
|
||||
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue