1
0
mirror of https://github.com/ansible/awx.git synced 2024-10-31 23:51:09 +03:00
awx/awx_collection/plugins/modules/tower_label.py
2020-03-20 20:09:08 -04:00

113 lines
3.2 KiB
Python

#!/usr/bin/python
# coding: utf-8 -*-
# (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = '''
---
module: tower_label
author: "Wayne Witzel III (@wwitzel3)"
version_added: "2.3"
short_description: create, update, or destroy Ansible Tower labels.
description:
- Create, update, or destroy Ansible Tower labels. See
U(https://www.ansible.com/tower) for an overview.
- Note, labels can only be created via the Tower API, they can not be deleted.
Once they are fully disassociated the API will clean them up on its own.
options:
name:
description:
- Name of this label.
required: True
type: str
new_name:
description:
- Setting this option will change the existing name (looked up via the name field).
type: str
organization:
description:
- Organization this label belongs to.
required: True
type: str
state:
description:
- Desired state of the resource.
default: "present"
choices: ["present"]
type: str
tower_oauthtoken:
description:
- The Tower OAuth token to use.
required: False
type: str
version_added: "3.7"
extends_documentation_fragment: awx.awx.auth
'''
EXAMPLES = '''
- name: Add label to tower organization
tower_label:
name: Custom Label
organization: My Organization
'''
from ..module_utils.tower_api import TowerModule
def main():
# Any additional arguments that are not fields of the item can be added here
argument_spec = dict(
name=dict(required=True, type='str'),
new_name=dict(required=False, type='str'),
organization=dict(required=True, type='str'),
state=dict(choices=['present'], default='present'),
)
# Create a module for ourselves
module = TowerModule(argument_spec=argument_spec, supports_check_mode=True)
# Extract our parameters
name = module.params.get('name')
new_name = module.params.get("new_name")
organization = module.params.get('organization')
# Attempt to look up the related items the user specified (these will fail the module if not found)
organization_id = None
if organization:
organization_id = module.resolve_name_to_id('organizations', organization)
# Attempt to look up an existing item based on the provided data
existing_item = module.get_one('labels', **{
'data': {
'name': name,
'organization': organization_id,
}
})
# Create the data that gets sent for create and update
new_fields = {}
new_fields['name'] = new_name if new_name else name
if organization:
new_fields['organization'] = organization_id
module.create_or_update_if_needed(
existing_item, new_fields,
endpoint='labels', item_type='label',
associations={
}
)
if __name__ == '__main__':
main()